From 13aa59825422acbb4376d8d512ae6f65d54b61e0 Mon Sep 17 00:00:00 2001 From: Mikhailo Shabodyash Date: Fri, 13 Sep 2024 15:11:45 +0300 Subject: [PATCH 1/5] feat: add migration and update workflow --- .github/workflows/deploy-market.yaml | 2 +- .github/workflows/prepare-migration.yaml | 2 +- .github/workflows/run-scenarios.yaml | 2 +- .github/workflows/run-unit-tests.yaml | 2 +- .../1726228702_add_cbbtc_as_collateral.ts | 112 ++++++++++++++++++ scenario/constraints/ProposalConstraint.ts | 6 +- 6 files changed, 119 insertions(+), 7 deletions(-) create mode 100644 deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts diff --git a/.github/workflows/deploy-market.yaml b/.github/workflows/deploy-market.yaml index 5de6eb684..eb1b1d90b 100644 --- a/.github/workflows/deploy-market.yaml +++ b/.github/workflows/deploy-market.yaml @@ -77,7 +77,7 @@ jobs: NETWORK_PROVIDER: ${{ fromJSON('["", "http://localhost:8585"]')[github.event.inputs.eth_pk == ''] }} REMOTE_ACCOUNTS: ${{ fromJSON('["", "true"]')[github.event.inputs.eth_pk == ''] }} - - uses: actions/upload-artifact@v2 # upload test results + - uses: actions/upload-artifact@v4 # upload test results if: success() || failure() # run this step even if previous step failed with: name: ${{ github.event.inputs.network }}-${{ github.event.inputs.deployment }}-verify-args diff --git a/.github/workflows/prepare-migration.yaml b/.github/workflows/prepare-migration.yaml index c27bc569e..1bbaa6646 100644 --- a/.github/workflows/prepare-migration.yaml +++ b/.github/workflows/prepare-migration.yaml @@ -77,7 +77,7 @@ jobs: NETWORK_PROVIDER: ${{ fromJSON('["", "http://localhost:8585"]')[github.event.inputs.eth_pk == ''] }} REMOTE_ACCOUNTS: ${{ fromJSON('["", "true"]')[github.event.inputs.eth_pk == ''] }} - - uses: actions/upload-artifact@v2 # upload test results + - uses: actions/upload-artifact@v4 # upload test results if: success() || failure() # run this step even if previous step failed with: name: ${{ github.event.inputs.network }}-${{ github.event.inputs.deployment }}-${{ github.event.inputs.migration }} diff --git a/.github/workflows/run-scenarios.yaml b/.github/workflows/run-scenarios.yaml index 0fecdd98c..6ae46e623 100644 --- a/.github/workflows/run-scenarios.yaml +++ b/.github/workflows/run-scenarios.yaml @@ -54,7 +54,7 @@ jobs: - name: Run scenarios run: yarn scenario --bases ${{ matrix.bases }} - - uses: actions/upload-artifact@v2 # upload scenario results + - uses: actions/upload-artifact@v4 # upload scenario results if: success() || failure() # run this step even if previous step failed with: name: scenario-results diff --git a/.github/workflows/run-unit-tests.yaml b/.github/workflows/run-unit-tests.yaml index d198e156e..849ae43b8 100644 --- a/.github/workflows/run-unit-tests.yaml +++ b/.github/workflows/run-unit-tests.yaml @@ -34,7 +34,7 @@ jobs: - name: Run tests run: yarn test - - uses: actions/upload-artifact@v2 # upload test results + - uses: actions/upload-artifact@v4 # upload test results if: success() || failure() # run this step even if previous step failed with: name: test-results diff --git a/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts b/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts new file mode 100644 index 000000000..797ff22d5 --- /dev/null +++ b/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts @@ -0,0 +1,112 @@ +import { expect } from 'chai'; +import { DeploymentManager } from '../../../../plugins/deployment_manager/DeploymentManager'; +import { migration } from '../../../../plugins/deployment_manager/Migration'; +import { exp, proposal } from '../../../../src/deploy'; + +const CBBTC_ADDRESS = '0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf'; + +let priceFeedAddress: string; + +export default migration('1726228702_add_cbbtc_as_collateral', { + async prepare() { + return {}; + }, + + enact: async (deploymentManager: DeploymentManager) => { + const trace = deploymentManager.tracer(); + + const cbBTC = await deploymentManager.existing( + 'cbBTC', + CBBTC_ADDRESS, + 'mainnet', + 'contracts/ERC20.sol:ERC20' + ); + const cbBTCPricefeed = await deploymentManager.fromDep('WBTC:priceFeed', 'mainnet', 'weth'); + priceFeedAddress = cbBTCPricefeed.address; + const { + governor, + comet, + cometAdmin, + configurator + } = await deploymentManager.getContracts(); + + const newAssetConfig = { + asset: cbBTC.address, + priceFeed: cbBTCPricefeed.address, + decimals: await cbBTC.decimals(), + borrowCollateralFactor: exp(0.8, 18), + liquidateCollateralFactor: exp(0.85, 18), + liquidationFactor: exp(0.95, 18), + supplyCap: exp(93, 8), + }; + + const mainnetActions = [ + // 1. Add cbBTC as asset + { + contract: configurator, + signature: 'addAsset(address,(address,address,uint8,uint64,uint64,uint64,uint128))', + args: [comet.address, newAssetConfig], + }, + // 2. Deploy and upgrade to a new version of Comet + { + contract: cometAdmin, + signature: 'deployAndUpgradeTo(address,address)', + args: [configurator.address, comet.address], + }, + ]; + + const description = '# Add cbBTC as collateral into cWETHv3 on Ethereum\n\n## Proposal summary\n\nCompound Growth Program [AlphaGrowth] proposes to add cbBTC into cWETHv3 on Ethereum network. This proposal takes the governance steps recommended and necessary to update a Compound III WETH market on Ethereum. Simulations have confirmed the market’s readiness, as much as possible, using the [Comet scenario suite](https://github.com/compound-finance/comet/tree/main/scenario). The new parameters include setting the risk parameters based off of the [recommendations from Gauntlet](https://www.comp.xyz/t/add-collateral-cbbtc-to-weth-market-on-base-and-mainnet/5689/2).\n\nFurther detailed information can be found on the corresponding [proposal pull request](https://github.com/compound-finance/comet/pull/923) and [forum discussion](https://www.comp.xyz/t/add-collateral-cbbtc-to-weth-market-on-base-and-mainnet/5689).\n\n\n## Proposal Actions\n\nThe first proposal action adds cbBTC asset as collateral with corresponding configurations.\n\nThe second action deploys and upgrades Comet to a new version.'; + const txn = await deploymentManager.retry(async () => + trace( + await governor.propose(...(await proposal(mainnetActions, description))) + ) + ); + + const event = txn.events.find( + (event) => event.event === 'ProposalCreated' + ); + const [proposalId] = event.args; + trace(`Created proposal ${proposalId}.`); + }, + + async enacted(): Promise { + return false; + }, + + async verify(deploymentManager: DeploymentManager) { + const { comet, configurator } = await deploymentManager.getContracts(); + + const cbBTCAssetIndex = Number(await comet.numAssets()) - 1; + + const cbBTCAssetConfig = { + asset: CBBTC_ADDRESS, + priceFeed: priceFeedAddress, + decimals: 8, + borrowCollateralFactor: exp(0.8, 18), + liquidateCollateralFactor: exp(0.85, 18), + liquidationFactor: exp(0.95, 18), + supplyCap: exp(93, 8), + }; + + // 1. Compare proposed asset config with Comet asset info + const cbBTCAssetInfo = await comet.getAssetInfoByAddress(CBBTC_ADDRESS); + expect(cbBTCAssetIndex).to.be.equal(cbBTCAssetInfo.offset); + expect(cbBTCAssetConfig.asset).to.be.equal(cbBTCAssetInfo.asset); + expect(cbBTCAssetConfig.priceFeed).to.be.equal(cbBTCAssetInfo.priceFeed); + expect(exp(1, cbBTCAssetConfig.decimals)).to.be.equal(cbBTCAssetInfo.scale); + expect(cbBTCAssetConfig.borrowCollateralFactor).to.be.equal(cbBTCAssetInfo.borrowCollateralFactor); + expect(cbBTCAssetConfig.liquidateCollateralFactor).to.be.equal(cbBTCAssetInfo.liquidateCollateralFactor); + expect(cbBTCAssetConfig.liquidationFactor).to.be.equal(cbBTCAssetInfo.liquidationFactor); + expect(cbBTCAssetConfig.supplyCap).to.be.equal(cbBTCAssetInfo.supplyCap); + + // 2. Compare proposed asset config with Configurator asset config + const configuratorcbBTCAssetConfig = (await configurator.getConfiguration(comet.address)).assetConfigs[cbBTCAssetIndex]; + expect(cbBTCAssetConfig.asset).to.be.equal(configuratorcbBTCAssetConfig.asset); + expect(cbBTCAssetConfig.priceFeed).to.be.equal(configuratorcbBTCAssetConfig.priceFeed); + expect(cbBTCAssetConfig.decimals).to.be.equal(configuratorcbBTCAssetConfig.decimals); + expect(cbBTCAssetConfig.borrowCollateralFactor).to.be.equal(configuratorcbBTCAssetConfig.borrowCollateralFactor); + expect(cbBTCAssetConfig.liquidateCollateralFactor).to.be.equal(configuratorcbBTCAssetConfig.liquidateCollateralFactor); + expect(cbBTCAssetConfig.liquidationFactor).to.be.equal(configuratorcbBTCAssetConfig.liquidationFactor); + expect(cbBTCAssetConfig.supplyCap).to.be.equal(configuratorcbBTCAssetConfig.supplyCap); + }, +}); diff --git a/scenario/constraints/ProposalConstraint.ts b/scenario/constraints/ProposalConstraint.ts index f1b9fa204..36d792478 100644 --- a/scenario/constraints/ProposalConstraint.ts +++ b/scenario/constraints/ProposalConstraint.ts @@ -62,9 +62,9 @@ export class ProposalConstraint implements StaticConstra ); } - // temporary hack to skip proposal 281 - if (proposal.id.eq(281)) { - console.log('Skipping proposal 281'); + // temporary hack to skip proposal 329 + if (proposal.id.eq(329)) { + console.log('Skipping proposal 329'); continue; } From 22421f3958d9840f19a8e9e86f5ac03e598233f9 Mon Sep 17 00:00:00 2001 From: Mikhailo Shabodyash Date: Fri, 13 Sep 2024 15:39:21 +0300 Subject: [PATCH 2/5] fix: additional workflow update --- .github/workflows/deploy-market.yaml | 4 ++-- .github/workflows/enact-migration.yaml | 4 ++-- .github/workflows/prepare-migration.yaml | 4 ++-- .github/workflows/run-contract-linter.yaml | 4 ++-- .github/workflows/run-coverage.yaml | 4 ++-- .github/workflows/run-eslint.yaml | 4 ++-- .github/workflows/run-forge-tests.yaml | 2 +- .github/workflows/run-gas-profiler.yaml | 4 ++-- .github/workflows/run-scenarios.yaml | 6 +++--- .github/workflows/run-slither.yaml | 4 ++-- .github/workflows/run-unit-tests.yaml | 4 ++-- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/workflows/deploy-market.yaml b/.github/workflows/deploy-market.yaml index eb1b1d90b..fe6e35024 100644 --- a/.github/workflows/deploy-market.yaml +++ b/.github/workflows/deploy-market.yaml @@ -53,9 +53,9 @@ jobs: if: github.event.inputs.eth_pk == '' - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' diff --git a/.github/workflows/enact-migration.yaml b/.github/workflows/enact-migration.yaml index f3a5e4524..b3202dbed 100644 --- a/.github/workflows/enact-migration.yaml +++ b/.github/workflows/enact-migration.yaml @@ -85,9 +85,9 @@ jobs: if: github.event.inputs.eth_pk == '' && env.GOV_NETWORK != '' - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' diff --git a/.github/workflows/prepare-migration.yaml b/.github/workflows/prepare-migration.yaml index 1bbaa6646..9d6206a18 100644 --- a/.github/workflows/prepare-migration.yaml +++ b/.github/workflows/prepare-migration.yaml @@ -53,9 +53,9 @@ jobs: if: github.event.inputs.eth_pk == '' - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' diff --git a/.github/workflows/run-contract-linter.yaml b/.github/workflows/run-contract-linter.yaml index b027b58fb..2513cc18c 100644 --- a/.github/workflows/run-contract-linter.yaml +++ b/.github/workflows/run-contract-linter.yaml @@ -15,11 +15,11 @@ jobs: LINEASCAN_KEY: ${{ secrets.LINEASCAN_KEY }} OPTIMISMSCAN_KEY: ${{ secrets.OPTIMISMSCAN_KEY }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: fetch-depth: 0 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' diff --git a/.github/workflows/run-coverage.yaml b/.github/workflows/run-coverage.yaml index e2272a9d5..b28829b56 100644 --- a/.github/workflows/run-coverage.yaml +++ b/.github/workflows/run-coverage.yaml @@ -18,9 +18,9 @@ jobs: OPTIMISMSCAN_KEY: ${{ secrets.OPTIMISMSCAN_KEY }} steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: cache: 'yarn' node-version: '16' diff --git a/.github/workflows/run-eslint.yaml b/.github/workflows/run-eslint.yaml index 9763d45d4..1961fec4c 100644 --- a/.github/workflows/run-eslint.yaml +++ b/.github/workflows/run-eslint.yaml @@ -16,9 +16,9 @@ jobs: OPTIMISMSCAN_KEY: ${{ secrets.OPTIMISMSCAN_KEY }} steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: cache: 'yarn' node-version: '16' diff --git a/.github/workflows/run-forge-tests.yaml b/.github/workflows/run-forge-tests.yaml index 069a30bdb..6a10f7523 100644 --- a/.github/workflows/run-forge-tests.yaml +++ b/.github/workflows/run-forge-tests.yaml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: submodules: recursive diff --git a/.github/workflows/run-gas-profiler.yaml b/.github/workflows/run-gas-profiler.yaml index d2418ad42..d49ba9152 100644 --- a/.github/workflows/run-gas-profiler.yaml +++ b/.github/workflows/run-gas-profiler.yaml @@ -17,9 +17,9 @@ jobs: OPTIMISMSCAN_KEY: ${{ secrets.OPTIMISMSCAN_KEY }} steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' diff --git a/.github/workflows/run-scenarios.yaml b/.github/workflows/run-scenarios.yaml index 6ae46e623..b651c8880 100644 --- a/.github/workflows/run-scenarios.yaml +++ b/.github/workflows/run-scenarios.yaml @@ -22,17 +22,17 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: fetch-depth: 0 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: cache: 'yarn' node-version: '16' - name: Cache Deployments - uses: actions/cache@v2 + uses: actions/cache@v4 with: path: | deployments/*/.contracts diff --git a/.github/workflows/run-slither.yaml b/.github/workflows/run-slither.yaml index 3c80df49e..2ca5a871d 100644 --- a/.github/workflows/run-slither.yaml +++ b/.github/workflows/run-slither.yaml @@ -8,9 +8,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' diff --git a/.github/workflows/run-unit-tests.yaml b/.github/workflows/run-unit-tests.yaml index 849ae43b8..49779a40f 100644 --- a/.github/workflows/run-unit-tests.yaml +++ b/.github/workflows/run-unit-tests.yaml @@ -16,9 +16,9 @@ jobs: OPTIMISMSCAN_KEY: ${{ secrets.OPTIMISMSCAN_KEY }} steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: node-version: '16' From 23a355b9e9585648c930851e8c461b1651abc26d Mon Sep 17 00:00:00 2001 From: Mikhailo Shabodyash Date: Fri, 13 Sep 2024 16:29:00 +0300 Subject: [PATCH 3/5] fix: final fix to workflow --- .github/workflows/run-scenarios.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/run-scenarios.yaml b/.github/workflows/run-scenarios.yaml index b651c8880..c2b7adcce 100644 --- a/.github/workflows/run-scenarios.yaml +++ b/.github/workflows/run-scenarios.yaml @@ -57,7 +57,7 @@ jobs: - uses: actions/upload-artifact@v4 # upload scenario results if: success() || failure() # run this step even if previous step failed with: - name: scenario-results + name: scenario-results-${{ matrix.bases }} path: scenario-results.json - uses: dorny/test-reporter@v1 From 31cb6f296a4c77e3c84b3e351e39b519cf647fef Mon Sep 17 00:00:00 2001 From: Mikhailo Shabodyash Date: Fri, 13 Sep 2024 17:06:20 +0300 Subject: [PATCH 4/5] fix: relations --- deployments/optimism/weth/relations.ts | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/deployments/optimism/weth/relations.ts b/deployments/optimism/weth/relations.ts index e88708f5d..45457356a 100644 --- a/deployments/optimism/weth/relations.ts +++ b/deployments/optimism/weth/relations.ts @@ -56,14 +56,4 @@ export default { WBTC: { artifact: 'contracts/ERC20.sol:ERC20' }, - - // weETH - TransparentUpgradeableProxy: { - artifact: 'contracts/ERC20.sol:ERC20', - delegates: { - field: { - slot: '0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc' - } - } - }, }; From 1ba20910ecfe6d2c3ed7b1c92e120d58f043529e Mon Sep 17 00:00:00 2001 From: Mikhailo Shabodyash Date: Tue, 17 Sep 2024 22:42:33 +0300 Subject: [PATCH 5/5] feat: change price feed --- .../1726228702_add_cbbtc_as_collateral.ts | 28 +++++++++++++++---- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts b/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts index 797ff22d5..c84bae952 100644 --- a/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts +++ b/deployments/mainnet/weth/migrations/1726228702_add_cbbtc_as_collateral.ts @@ -4,15 +4,27 @@ import { migration } from '../../../../plugins/deployment_manager/Migration'; import { exp, proposal } from '../../../../src/deploy'; const CBBTC_ADDRESS = '0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf'; +const CBBTC_USD_PRICE_FEED = '0x2665701293fCbEB223D11A08D826563EDcCE423A'; +const ETH_USD_PRICE_FEED_ADDRESS = '0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419'; let priceFeedAddress: string; export default migration('1726228702_add_cbbtc_as_collateral', { - async prepare() { - return {}; + async prepare(deploymentManager: DeploymentManager) { + const _cbBTCPriceFeed = await deploymentManager.deploy( + 'cbBTC:priceFeed', + 'pricefeeds/ReverseMultiplicativePriceFeed.sol', + [ + CBBTC_USD_PRICE_FEED, // cbBTC / USD price feed + ETH_USD_PRICE_FEED_ADDRESS, // USD / ETH price feed + 8, // decimals + 'cbBTC / ETH price feed', // description + ] + ); + return { cbBTCPriceFeedAddress: _cbBTCPriceFeed.address }; }, - enact: async (deploymentManager: DeploymentManager) => { + enact: async (deploymentManager: DeploymentManager, _, { cbBTCPriceFeedAddress }) => { const trace = deploymentManager.tracer(); const cbBTC = await deploymentManager.existing( @@ -21,8 +33,12 @@ export default migration('1726228702_add_cbbtc_as_collateral', { 'mainnet', 'contracts/ERC20.sol:ERC20' ); - const cbBTCPricefeed = await deploymentManager.fromDep('WBTC:priceFeed', 'mainnet', 'weth'); - priceFeedAddress = cbBTCPricefeed.address; + const cbBTCPriceFeed = await deploymentManager.existing( + 'cbBTC:priceFeed', + cbBTCPriceFeedAddress, + 'mainnet' + ); + priceFeedAddress = cbBTCPriceFeed.address; const { governor, comet, @@ -32,7 +48,7 @@ export default migration('1726228702_add_cbbtc_as_collateral', { const newAssetConfig = { asset: cbBTC.address, - priceFeed: cbBTCPricefeed.address, + priceFeed: cbBTCPriceFeed.address, decimals: await cbBTC.decimals(), borrowCollateralFactor: exp(0.8, 18), liquidateCollateralFactor: exp(0.85, 18),