Welcome to rari-governance-contracts, the central repository for the Solidity source code behind Rari Governance's Ethereum-based smart contracts (with automated tests) and documentation.
The Rari Governance Token (RGT) represents shares of the voting power for the Rari Stable Pool, Yield Pool, and Ethereum Pool, Rari Capital's three lending aggregators based on the Ethereum blockchain. During the liquidity mining period of 390000 blocks (approximately 60 days), starting on block 11094200 (approximately October 20, 2020 at 10 AM PT), RGT is distributed to Rari Stable Pool, Yield Pool, and Ethereum Pool users (i.e., RSPT, RYPT, and REPT holders) proportionally to their USD balances supplied to the pools (at a rate depending on the block number). Anyone can create a new proposal or vote on existing proposals (using RGT) to modify or update the code behind the Rari Stable Pool, Yield Pool, Ethereum Pool, or the Rari Governance protocol itself at any time at vote.rari.capital. Once the governance protocol is finished, proposals will be created, voted on, and executed completely on-chain. This information, along with information on the Rari pools, is also available online. Find out more about Rari Capital at rari.capital.
Documentation on common usage of the contracts is available in USAGE.md. Detailed API documentation for our smart contracts' public methods is available in API.md. Smart contract ABIs are available in the abi properties of the JSON files in the build folder. For easy implementation, see the Rari JavaScript SDK.
We, as well as others, had success using Truffle on Node.js v12.18.2 with the latest version of NPM.
To install the latest version of Truffle: npm install -g truffle
Though the latest version of Truffle should work, to compile, deploy, and test our contracts, we used Truffle v5.1.45 (which should use solc version 0.5.17+commit.d19bba13.Emscripten.clang and Web3.js v1.2.1).
To install all our dependencies: npm install
npm run compile
Make sure to configure the following .env variables:
DISTRIBUTION_START_BLOCK=11094200
PRIVATE_VESTING_START_TIMESTAMP=1603202400
UNISWAP_DISTRIBUTION_START_BLOCK=11909000
DISTRIBUTION_V2_START_BLOCK=12000000
PRIVATE_VESTING_V2_START_TIMESTAMP=1608793200
LOOPRING_INTERNAL_DISTRIBUTOR=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a
The following .env variables must be configured for liquidity mining via the existing Rari Stable Pool v2.6.0, Yield Pool v1.3.0, and Ethereum Pool v1.2.0:
POOL_OWNER=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a
POOL_STABLE_MANAGER_ADDRESS=0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a
POOL_STABLE_TOKEN_ADDRESS=0x016bf078ABcaCB987f0589a6d3BEAdD4316922B0
POOL_YIELD_MANAGER_ADDRESS=0x59FA438cD0731EBF5F4cDCaf72D4960EFd13FCe6
POOL_YIELD_TOKEN_ADDRESS=0x3baa6B7Af0D72006d3ea770ca29100Eb848559ae
POOL_ETHEREUM_MANAGER_ADDRESS=0xD6e194aF3d9674b62D1b30Ec676030C23961275e
POOL_ETHEREUM_TOKEN_ADDRESS=0xCda4770d65B4211364Cb870aD6bE19E7Ef1D65f4
In .env, set DEVELOPMENT_ADDRESS=0x45D54B22582c79c8Fb8f4c4F2663ef54944f397a to test deployment and also set DEVELOPMENT_ADDRESS_SECONDARY=0x1Eeb75CFad36EDb6C996f7809f30952B0CA0B5B9 to run automated tests.
If you are upgrading from v2.0.2, set UPGRADE_FROM_LAST_VERSION=1 to enable upgrading and configure the following:
UPGRADE_GOVERNANCE_TOKEN_ADDRESS=0xD291E7a03283640FDc51b121aC401383A46cC623
UPGRADE_GOVERNANCE_OWNER_ADDRESS=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a
Then, copy the OpenZeppelin artifacts for the official deployed v2.0.2 contracts from .openzeppelin/mainnet.json to .openzeppelin/unknown-1337.json. If you decide to disable upgrading by setting restoring UPGRADE_FROM_LAST_VERSION=0, make sure to delete .openzeppelin/unknown-1337.json.
To test the contracts, first fork the Ethereum mainnet. Begin by configuring DEVELOPMENT_WEB3_PROVIDER_URL_TO_BE_FORKED in .env (set to any mainnet Web3 HTTP provider JSON-RPC URL; we use a local geth instance, specifically a light client started with geth --syncmode light --rpc --rpcapi eth,web3,debug,net; Infura works too, but beware of latency and rate limiting). To start the fork, run npm run ganache. If you would like to change the port, make sure to configure scripts/ganache.js, scripts/test.sh, scripts/migrate-dev.sh, and the development network in truffle-config.js. Note that you will likely have to regularly restart your fork, especially when forking from a node without archive data or when using live 0x API responses to make currency exchanges.
To deploy the contracts to your private mainnet fork, run truffle migrate --network development --skip-dry-run --reset. Alternatively, npm run migrate-dev will run Ganache and migrate the contracts in the same command.
To run automated tests on the contracts on your private mainnet fork, run npm test (which runs Ganache in the background for you). If you are upgrading from v2.0.2, you must also set the following variables in .env:
UPGRADE_GOVERNANCE_TOKEN_DISTRIBUTOR_ADDRESS=0x9C0CaEb986c003417D21A7Daaf30221d61FC1043
UPGRADE_GOVERNANCE_TOKEN_VESTING_ADDRESS=0xA54B473028f4ba881F1eD6B670af4103e8F9B98a
As an alterative to manually configuring existing pool manager and token addresses, npm test and npm migrate-dev can automatically run Ganache and deploy the Rari Stable Pool, Yield Pool, and/or Ethereum Pool to the development network (and configure the pool manager and token addresses environment variables) before deploying Rari Governance if the following variables in .env are set: DEVELOPMENT_POOL_STABLE_CONTRACTS_DIRECTORY, DEVELOPMENT_POOL_STABLE_CONTRACTS_DIRECTORY, and/or DEVELOPMENT_POOL_STABLE_CONTRACTS_DIRECTORY.
To test Uniswap V2 liquidity rewards on a fresh set of contracts, create a Uniswap V2 pair for RGT/RTH and use the function RariGovernanceTokenUniswapDistributor.setRgtEthUniswapV2Pair(IERC20 _rgtEthUniswapV2Pair) to enable RGT liquidity mining on the pair.
Make sure to configure the following .env variables:
DISTRIBUTION_START_BLOCK=11094200
PRIVATE_VESTING_START_TIMESTAMP=1603202400
UNISWAP_DISTRIBUTION_START_BLOCK=11909000
DISTRIBUTION_V2_START_BLOCK=12000000
PRIVATE_VESTING_V2_START_TIMESTAMP=1608793200
LOOPRING_INTERNAL_DISTRIBUTOR=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a
The following .env variables must be configured for liquidity mining via the existing Rari Stable Pool v2.6.0, Yield Pool v1.3.0, and Ethereum Pool v1.2.0:
POOL_OWNER=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a
POOL_STABLE_MANAGER_ADDRESS=0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a
POOL_STABLE_TOKEN_ADDRESS=0x016bf078ABcaCB987f0589a6d3BEAdD4316922B0
POOL_YIELD_MANAGER_ADDRESS=0x59FA438cD0731EBF5F4cDCaf72D4960EFd13FCe6
POOL_YIELD_TOKEN_ADDRESS=0x3baa6B7Af0D72006d3ea770ca29100Eb848559ae
POOL_ETHEREUM_MANAGER_ADDRESS=0xD6e194aF3d9674b62D1b30Ec676030C23961275e
POOL_ETHEREUM_TOKEN_ADDRESS=0xCda4770d65B4211364Cb870aD6bE19E7Ef1D65f4
In .env, configure LIVE_DEPLOYER_ADDRESS, LIVE_DEPLOYER_PRIVATE_KEY, LIVE_WEB3_PROVIDER_URL, LIVE_GAS_PRICE (ideally, use the "fast" price listed by ETH Gas Station), LIVE_GOVERNANCE_OWNER, and LIVE_POOL_OWNER_PRIVATE_KEY to deploy to the mainnet.
If you are upgrading from v2.0.2, set UPGRADE_FROM_LAST_VERSION=1 to enable upgrading and configure the following:
UPGRADE_GOVERNANCE_TOKEN_ADDRESS=0xD291E7a03283640FDc51b121aC401383A46cC623
UPGRADE_GOVERNANCE_OWNER_ADDRESS=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a
You must also set LIVE_UPGRADE_GOVERNANCE_OWNER_PRIVATE_KEY.
Then, migrate: truffle migrate --network live
To test Uniswap V2 liquidity rewards on a fresh set of contracts, create a Uniswap V2 pair for RGT/ETH and use the function RariGovernanceTokenUniswapDistributor.setRgtEthUniswapV2Pair(IERC20 _rgtEthUniswapV2Pair) to enable RGT liquidity mining on the pair.
See LICENSE.
Rari Capital's smart contracts are developed by David Lucid. Find out more about Rari Capital at rari.capital.