We will see within the definitions in /contracts/Comptroller.sol that these strategies don’t make any adjustments or conditionally revert. We’ll deal with them as lifeless code that must be eliminated. The present cToken contracts name them, so we received’t take away them from the Comptroller at present.

Checks

After saving the modified contract file, we’ll change the check code so it succeeds with the most recent adjustments. If we had been including new contract code, we might add extra assessments to make sure thorough code protection.

To run the entire tasks assessments, use this command on the command line:

yarn check

To run a person check file, strive one thing like:

yarn check assessments/Tokens/borrowAndRepayTest.js

When working all assessments, we’ll see that 6 assessments fail on account of our contract code adjustments. These specific assessments could be commented out or deleted. As soon as the check command yields 0 failed assessments, we are able to proceed with our protocol change.

Pull Request

As soon as the assessments cross, we are able to create a pull request. When a pull request is open, the neighborhood can publicly analyze the code adjustments to make sure integrity and that finest practices are carried out. If the neighborhood approves the adjustments by means of governance with a passing proposal, the pull request will likely be merged into the grasp department.

Subsequent we’ll commit the contract and check code adjustments to the forked repository utilizing Git on the command line.

git add contracts/ assessments/
git commit -m "ctoken adjustments"
git push origin grasp

We’ll return to the forked repository web page on GitHub and refresh it. There ought to now be a pull request button above the file explorer on the correct. We’ll click on it to see the merge comparability web page.

Subsequent we’ll click on the inexperienced “Create pull request” button to open the general public pull request.

Some, however not all protocol adjustments require deploying of recent good contracts. When including a brand new asset to the protocol, deploying a brand new cToken contract is required.

Deploying a cToken contract could be performed utilizing Saddle. The Compound Labs staff created a command line instrument known as Saddle for Ethereum growth. It’s already included within the dependencies of the protocol repository.

Native Atmosphere Contract Deploy

Earlier than we deploy to a public Ethereum community, we’ll first attempt to deploy the contract on a localhost fork. We’ll want a JSON RPC supplier URL for this. One could be acquired totally free from Infura or the same service.

We’ll return to our textual content editor and open saddle.config.js within the venture root folder. We’ll duplicate the growth object throughout the networks object. The duplicate must be named one thing like local_fork.

Within the suppliers array of local_fork, we’ll take away the second object that begins with ganache. As a substitute, we’ll exchange the whole second object with a localhost JSON RPC URL. The local_fork’s suppliers array ought to now appear like the next:

suppliers: [
{env: "PROVIDER"},
{http: "http://127.0.0.1:8545"}
],

Now is an effective time to globally set up Ganache CLI (extra on this instrument within the main information).

In a separate terminal window, we’ll use the next command to make an area fork of the Kovan community blockchain. The mnemonic generates accounts which were utilized in earlier developer guides. Be aware that there’s an setting variable (infuraProjectId) that comprises the Infura venture ID.

ganache-cli 
-f https://kovan.infura.io/v3/$infuraProjectId 
-m "clutch captain shoe salt awake harvest setup main inmate ugly amongst grow to be"

Subsequent we’ll make a brand new community config file for local_fork. This may be performed by copying the Kovan configuration and naming it local_fork.json. From the basis listing of the venture, run the next command.

cp networks/kovan.json networks/local_fork.json

We copied Kovan as a result of the entire addresses would be the similar in our Ganache CLI community fork.

Subsequent we’ll deploy the contract utilizing Saddle. The brand new cToken will likely be Kyber Community Crystal. The underlying token tackle could be discovered within the Kyber documentation.

In a terminal window that’s navigated to the venture listing, we’ll use the next command to deploy the cToken to the native fork.

npx saddle -n local_fork script token:deploy '{
"underlying": "0xad67cB4d63C9da94AcA37fDF2761AaDF780ff4a2",
"comptroller": "$Comptroller",
"interestRateModel": "$Base200bps_Slope3000bps",
"initialExchangeRateMantissa": "2.0e18",
"identify": "Compound Kyber Community Crystal",
"image": "cKNC",
"decimals": "8",
"admin": "$Timelock"
}'

On success, Saddle will log the tackle of the brand new cToken contract.

Contract Deploy & Etherscan Code Verification

Now that we all know the deployment works within the native check setting, we are able to strive it on the general public community.

Earlier than we try this, we’ll get an Etherscan API key so we are able to publicly confirm the supply code. We’ll join a free account at etherscan.io. As soon as now we have an account, we’ll create an API key by clicking the profile dropdown, API Keys, and the “Add” button on the prime of the web page.

Now that now we have an API key, we are able to add it to our command line setting variables. On a Mac, that is in ~/.bash_profile or ~/.zshrc. We’ll add the important thing on a brand new line with export ETHERSCAN_API_KEY="JI4D..." and restart the terminal window.

Subsequent we’ll add a personal key for the Kovan check internet, so Saddle will know who’s deploying the brand new contract. We’ll create a brand new listing utilizing mkdir ~/.ethereum/ after which a brand new file to include the non-public key with contact ~/.ethereum/kovan.

We’ll paste a Kovan non-public key on this file with out the “0x” at the start of the hexadecimal string.

Subsequent, we’ll run the identical deploy command that we ran earlier besides this time we are going to exchange local_fork with kovan. This transformation will deploy the contract to Kovan, for actual. We’ll run the command. Remember to save the contract tackle that’s logged.

Go to kovan.etherscan.io and seek for the newly created contract tackle. Within the contract tab, we’ll see that there at present isn’t any verified supply code.

Subsequent, we’ll return to the command line, and run a command to confirm the supply code with Etherscan. We’ll exchange 0x9aF1962Dadf179e2aAa66F994ef09c65360b958e with our newly created contract tackle.

npx saddle -n kovan script token:confirm 0x9aF1962Dadf179e2aAa66F994ef09c65360b958e '{
"underlying": "0xad67cB4d63C9da94AcA37fDF2761AaDF780ff4a2",
"comptroller": "$Comptroller",
"interestRateModel": "$Base200bps_Slope3000bps",
"initialExchangeRateMantissa": "2.0e18",
"identify": "Compound Kyber Community Crystal",
"image": "cKNC",
"decimals": "8",
"admin": "$Timelock"
}'

As soon as the verification completes, we’ll see that the contract code is now explorable on the contract Etherscan web page.

This similar course of could be adopted to deploy a contract to the Ethereum Mainnet.

The ultimate main step of adjusting the Compound Protocol is to create a Governance proposal that the neighborhood collectively agrees to cross.

Be aware that the brand new cToken on this information is already supported by the on-chain Open Worth Feed. If we had been proposing a brand new asset that’s not but reported within the Open Worth Feed, we would wish to create adjustments for that element too.

Proposal or Autonomous Proposal

There are a number of choices to go about making a Compound Governance Proposal. We’ll overview them right here. In the event that they don’t make sense, take a while to learn up on Governance on the Compound Weblog and on the comp.xyz discussion board.

1. Purchase not less than 100,000 COMP or the equal delegated voting weight and create a proposal utilizing app.compound.finance/suggest.
2. Focus on concepts for change with the better Compound neighborhood on the discussion board or within the #governance channel of the Compound Discord. Discover a person that agrees with the change, has the flexibility, and ask them to create the proposal.
3. Purchase not less than 100 COMP and create a Compound Autonomous Proposal.

Let’s stroll by means of utilizing the app interface to focus on the required “calldatas” for a brand new cToken proposal. Once more, that is just for customers that management not less than 100,000 votes.

Go to app.compound.finance/suggest. Fill within the proposal Title and Overview sections. Be as thorough as doable. Markdown is supported. Remember to embrace a hyperlink to the GitHub pull request created earlier. Evaluate a related previous proposal and use it as a information to write down the Overview. Add the next Actions within the specified order.

1. Comptroller contract, _supportMarket operate, new cToken contract tackle.
2. Comptroller contract, _addCompMarkets operate, new cToken contract tackle.
3. Comptroller contract, _setCollateralFactor operate, new cToken contract tackle and 600000000000000000 for 60% collateral issue.
4. Different contract (new cToken contract tackle and ABI from the Etherscan web page, code tab, towards the underside), _setReserveFactor, 200000000000000000 for 20% reserve issue.

This proposal provides the brand new cToken to the official Comptroller, permits it as a market that participates in COMP Distribution, units the collateral issue to 60%, and units the reserve issue to twenty%. As soon as the Actions are stuffed in, click on the Submit Proposal button and submit the transaction utilizing MetaMask.

For a extra detailed walkthrough of making a proposal, try the Compound Governance information – How To Suggest.

Compound is a dwelling, on-chain protocol, not only a repository of code that may be pulled and run. Proposing adjustments is a severe endeavor that requires the whole neighborhood’s consideration and scrutiny. Not all proposals cross. For extra concepts about tips on how to submit profitable proposals, see the Contributing to the Compound Protocol guide.

Crucial a part of creating Compound Protocol enhancements is collaborating in open discourse. Please be a part of the dialogue within the Compound Neighborhood Discussion board and within the #governance channel of the Compound Discord.

Thanks for studying and remember to subscribe to the Compound Publication. Be happy to touch upon this submit, or get in contact with the staff on the Compound Twitter.