Comet Migrator

The Comet Migrator is a Compound v3 Operator and Extension for migrating a position from Compound v2 and other DeFi protocols to Compound v3. The "Operator" is a smart contract which interacts with the Compound v3 Protocol on behalf of a user who approves the migrator. The "Extension" is a front-end integration into the Compound v3 interface. The Operator code is built on Foundry, and the Extension code is built on React using Vite.

Getting Started

First, install Foundry and NodeJS 18+ and yarn.

You can build the Compound Migrator Operator smart contract by running:

yarn forge:build

And you can build the Compound Migrator Extension by running:

yarn web:build

For the development experience, we recommend using the Playground as described below.

Testing

To test your contracts, run:

yarn forge:test

You can also run coverage via:

yarn forge:test --coverage

Note: the test cases use a fork of Ethereum mainnet. You will need access to an archive node to run tests. You may use MAINNET_RPC_URL=https://mainnet-eth.compound.finance for this purpose, but you will be rate-limited. You can set this permanently by running:

echo "MAINNET_RPC_URL=https://mainnet-eth.compound.finance" >> .env.local

The Playground

For development, we will use a fork of mainnet, as opposed to developing on a test-net. You can deploy the Migrator to a fork of mainnet, run that in a stand-alone development experience, and attach MetaMask to that fork to interact with the extension. This requires a small amount of set-up, but it makes it significantly easier to test interactions with third-party protocols like using Uniswap swaps, flash loans, Compound v2 and Compound v3, all in one experience without needing the protocols to exist for the same assets on the same oft deprecated test-nets.

Starting the playground (i.e. running Anvil to fork main-net and deploying the necessary contracts):

Use Mainnet Deployment

yarn playground:mainnet

Migrator v1

yarn playground:v1

Migrator v2

yarn playground:v2

Next, we'll need to make sure MetaMask is set-up to talk to this network. Follow these steps to add a custom network http://localhost:8545.

⚠️ Note: it's possible you already have such a network set-up. If so, you may want to ensure the chain id is 1. Go into MetaMask -> Settings -> Networks -> Localhost 8545 and then you should see a screen that has Chain ID: #. It should be 1, and if it is not, change it to 1 and hit Save.

This should spawn a web server at an address such as http://localhost:5183. Visit that page and you should be running in the playground.

A few notes:

Any changes to web source code should auto-reload.
If you want to change the smart contract code, you'll need to kill and restart yarn forge:playground.
The standalone development experience is not the primary usage of the extension. See Webb3 for details on running as an embedded extension.

To run this in embedded mode (see Embedding below), you should run the following command in Webb3:

# in webb3/
yarn dev --mode playground

Comet Migrator Operator

The Comet Migrator Operator code lives in src/CometMigrator.sol. Note: we use a large amount of vendoring to pull in Uniswap, Compound v2 and Compound v3 source files. We use vendoza to track the diffs.

The Comet Migrator Spec contains the full spec on the specifics of the migrator code.

Note: script/copy-abi.sh is currently used to sync the ABI from the CometMigrator.sol to abis/CometMigrator.ts for use in the Extension. We may want to find a simpler system for this at some point.

Deploying

Build and Deploying Operator

To deploy the operator, first build it:

yarn forge:build

Next, you can deploy it to goerli:

script/goerli/deploy_migrator.sh

or mainnet:

script/mainnet/deploy_migrator.sh

But the recommended way to deploy is through GitHub Actions via Seacrest. Simply run the Deploy Migrator [Goerli] or Deploy Migrator [Mainnet] GitHub actions and connect your WalletConnect wallet in the task.

Build and Deploying Extension

First, build the extension for web:

yarn web:build

Next, make it available on the web, we recommend on IPFS by running:

IPFS_AUTH="..." IPFS_HOST="..." yarn deploy

For example, to deploy to Infura, use IPFS_AUTH="{project_id}:{api_key_secret}" and IPFS_HOST="ipfs.infura.io". You can also deploy from GitHub actions if you set these values into GitHub secrets.

Once the app is deployed to IPFS, get the cid (IPFS hash) and make a pull request in comet-extension including the IPFS hash from this deploy.

Embedding

You can run Webb3 locally with a local version of the extension running. First, run this extension:

# in comet-migrator/
yarn web:dev

Take a note of the port (it should be 5183). Then run Webb3 with the following env var set:

# in webb3/
VITE_COMET_MIGRATOR_SOURCE=http://localhost:5183/embedded.html yarn dev

When the extension loads at http://localhost:5173, it should load this local extension, instead of the production version.

If you are using the playground, you should also make sure Webb3 uses that URL for reading from the chain:

# in webb3/
VITE_WEBB3_MAINNET_URL=http://localhost:8545 VITE_COMET_MIGRATOR_SOURCE=http://localhost:5183/embedded.html yarn dev

Contributing

Please feel free to make a pull request or issue to contribute to this project.

Graysonbarton/comet-migrator