Rari Stable Pool: Smart Contracts

Welcome to rari-stable-pool-contracts, the central repository for the Solidity source code behind the Rari Stable Pool's Ethereum-based smart contracts (with automated tests and documentation).

How it works

The Rari Stable Pool is a decentralized and fully-audited stablecoin lending aggregator optimized for yield based on the Ethereum blockchain. A high-level overview of how the Rari Stable Pool works is available in CONCEPT.md. This information is also available online. Find out more about Rari Capital at rari.capital.

Contract usage

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.

Installation (for development and deployment)

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

Compiling the contracts

npm run compile

Testing the contracts

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.5.0, set UPGRADE_FROM_LAST_VERSION=1 to enable upgrading and configure the following:

UPGRADE_OLD_FUND_CONTROLLER=0x369855b051d1b2dbee88a792dcfc08614ff4e262
UPGRADE_FUND_MANAGER_ADDRESS=0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a
UPGRADE_FUND_OWNER_ADDRESS=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a

Then, copy the OpenZeppelin artifacts for the official deployed v2.5.0 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, 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: truffle migrate --network development --skip-dry-run --reset

To run automated tests on the contracts on your private mainnet fork, run npm test (which runs npm run ganache in the background for you). If you are upgrading from v2.5.0, you must also set the following variables in .env:

UPGRADE_FUND_TOKEN_ADDRESS=0x016bf078ABcaCB987f0589a6d3BEAdD4316922B0
UPGRADE_FUND_PRICE_CONSUMER_ADDRESS=0xFE98A52bCAcC86432E7aa76376751DcFAB202244

If you'd like to test gasless deposits via RariFundProxy.deposit via the Gas Station Network:

• Download https://github.com/OpenZeppelin/openzeppelin-gsn-provider/blob/master/bin/gsn-relay to bin/gsn-relay and set permissions with chmod +x bin/gsn-relay.
• Making sure npx is installed, run npm dev-gsn.
• Fund RariFundProxy using npx @openzeppelin/gsn-helpers fund-recipient --recipient $RARI_FUND_PROXY_ADDRESS -n http://localhost:8546 -f $FROM_ADDRESS or this tool (or manually send ETH to RelayHub(0xD216153c06E857cD7f72665E0aF1d7D82172F494).depositFor(address target)).
• Run rari-gsn-signer with pm2 start ecosystem.config.js after configuring ecosystem.config.js.

Live deployment

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_FUND_OWNER, LIVE_FUND_REBALANCER, LIVE_FUND_INTEREST_FEE_MASTER_BENEFICIARY, LIVE_FUND_WITHDRAWAL_FEE_MASTER_BENEFICIARY, and LIVE_FUND_GSN_TRUSTED_SIGNER to deploy to the mainnet.

If you are upgrading from v2.5.0, set UPGRADE_FROM_LAST_VERSION=1 to enable upgrading and configure the following:

UPGRADE_OLD_FUND_CONTROLLER=0x369855b051d1b2dbee88a792dcfc08614ff4e262
UPGRADE_FUND_MANAGER_ADDRESS=0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a
UPGRADE_FUND_OWNER_ADDRESS=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a

You must also set LIVE_UPGRADE_FUND_OWNER_PRIVATE_KEY.

Then, migrate: truffle migrate --network live

If you'd like to provide gasless deposits via RariFundProxy.deposit via the Gas Station Network:

• Fund RariFundProxy using npx @openzeppelin/gsn-helpers fund-recipient --recipient $RARI_FUND_PROXY_ADDRESS -n $ETHEREUM_NODE_URL -f $FROM_ADDRESS or this tool (or manually send ETH to RelayHub(0xD216153c06E857cD7f72665E0aF1d7D82172F494).depositFor(address target)).
• Run rari-gsn-signer with pm2 start ecosystem.config.js --env production after configuring ecosystem.config.js.

License

See LICENSE.

Credits

Rari Capital's smart contracts are developed by David Lucid. Find out more about Rari Capital at rari.capital.