Skip to content

Commit

Permalink
Update DEPLOYED.md, CHANGELOG.md, and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlucid committed May 6, 2021
1 parent 0df5030 commit 1eb9f2e
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Changelog

## `v2.6.0` (contracts not yet deployed; all code not yet pushed)
## `v2.6.0` (contracts deployed 2021-05-04; all code pushed 2021-05-06)

* Fuse integration!
* Upgrade to mStable mUSD v3.
* Integrate swaps via Uniswap V2 in `RariFundController`.

## `v2.5.0` (contracts deployed 2020-02-09; all code pushed 2020-02-14)
## `v2.5.0` (contracts deployed 2021-02-09; all code pushed 2021-02-14)

* Upgraded mStable SAVE V1 to V2 (and implemented MTA rewards).
* Fixed bug in calculation of `outputFilledAmountUsd` in `RariFundController.marketSell0xOrdersFillOrKill`.
Expand Down
13 changes: 9 additions & 4 deletions DEPLOYED.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ As follows are all deployments of our smart contracts on the Ethereum mainnet. S

`RariFundController` holds supplied funds and is used by the rebalancer to deposit and withdraw from pools and make exchanges.

**v2.5.0**: `0x369855b051d1b2dbee88a792dcfc08614ff4e262`
**v2.6.0**: `0x66f4856f1bbd1eb09e1c8d9d646f5a3a193da569`

Implementation contract: `0xdac4585b741e5b6625cec460d2a255fb3fbe0d47`

### `RariFundManager`

`RariFundManager` is the Rari Stable Pool's main contract: it handles deposits, withdrawals, USD balances, interest, fees, etc.

**v2.2.0**: `0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a`
**v2.6.0**: `0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a`

Implementation contract: `0xfbd8fa4ae1ca58fa6fd4cf683f94e54235266141`
Implementation contract: `0x6C85e8101e52ea7B569230f93bC452f291edCBEC`

### `RariFundToken`

Expand All @@ -38,17 +40,19 @@ Implementation contract: `0xc34D76cBB18a5976e38Fe0f0c580DCEE6D8954ee`

`RariFundProxy` includes wrapper functions built on top of `RariFundManager`: exchange and deposit, withdraw and exchange, deposit without paying gas via the Gas Station Network (GSN).

**v2.4.0**: `0xe4deE94233dd4d7c2504744eE6d34f3875b3B439`
**v2.6.0**: `0x4a785fa6fcd2e0845a24847beb7bddd26f996d4d`

## Older Versions

### `RariFundController`

* **v2.5.0**: `0x369855b051d1b2dbee88a792dcfc08614ff4e262`
* **v2.0.0**: `0xEe7162bB5191E8EC803F7635dE9A920159F1F40C`
* **v1.1.0**: `0x15c4ae284fbb3a6ceb41fa8eb5f3408ac485fabb`

### `RariFundManager`

* **v2.2.0**: `0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a`
* **v2.1.0**: `0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a`
* **v2.0.0**: `0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a`
* **v1.1.0**: `0x6bdaf490c5b6bb58564b3e79c8d18e8dfd270464`
Expand All @@ -65,6 +69,7 @@ Implementation contract: `0xc34D76cBB18a5976e38Fe0f0c580DCEE6D8954ee`

### `RariFundProxy`

* **v2.4.0**: `0xe4deE94233dd4d7c2504744eE6d34f3875b3B439`
* **v2.2.0**: `0xB202cAd3965997f2F5E67B349B2C5df036b9792e`
* **v2.0.0**: `0xD4be7E211680e12c08bbE9054F0dA0D646c45228`
* **v1.2.0**: `0xb6b79D857858004BF475e4A57D4A446DA4884866`
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,22 @@ To install all our dependencies: `npm install`

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.4.0` or `v2.4.1`, set `UPGRADE_FROM_LAST_VERSION=1` to enable upgrading and configure the following:
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=0xEe7162bB5191E8EC803F7635dE9A920159F1F40C
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.4.0`/`v2.4.1` 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`.
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.4.0` or `v2.4.1`, you must also set the following variables in `.env`:
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
UPGRADE_FUND_PROXY_ADDRESS=0xe4deE94233dd4d7c2504744eE6d34f3875b3B439

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

Expand All @@ -57,9 +56,9 @@ If you'd like to test gasless deposits via `RariFundProxy.deposit` via the Gas S

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](https://www.ethgasstation.info/)), `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.4.0` or `v2.4.1`, set `UPGRADE_FROM_LAST_VERSION=1` to enable upgrading and configure the following:
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=0xEe7162bB5191E8EC803F7635dE9A920159F1F40C
UPGRADE_OLD_FUND_CONTROLLER=0x369855b051d1b2dbee88a792dcfc08614ff4e262
UPGRADE_FUND_MANAGER_ADDRESS=0xC6BF8C8A55f77686720E0a88e2Fd1fEEF58ddf4a
UPGRADE_FUND_OWNER_ADDRESS=0x10dB6Bce3F2AE1589ec91A872213DAE59697967a

Expand Down

0 comments on commit 1eb9f2e

Please sign in to comment.