Skip to content

Latest commit

 

History

History
138 lines (85 loc) · 5.32 KB

README.md

File metadata and controls

138 lines (85 loc) · 5.32 KB
Raw

Comet Extension Template

The Comet Extension Template is a template for developing a Compound III Operator and/or Extension. The operator is an Ethereum smart contract which interacts with the Compound III Protocol on behalf of a user who approves this extension. The web extension is a front-end integration into the Compound III interface. The operator code is built on Foundry, and the web extension code is built on React using Vite.

Getting Started

First, install Foundry and NodeJS 18+ and yarn.

You can build this Compound Extension's operator by running:

yarn forge:build

And you can build the web extension by running:

yarn web:build

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

The Playground

For development, we will use a fork of mainnet, as opposed to developing on a test-net. You can deploy this extension 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):

yarn forge:playground

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.

Next, start the standalone dev experience by running:

yarn web:dev

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/
VITE_WEBB3_MAINNET_URL=http://localhost:8545 VITE_EXTRA_EXTENSIONS=my_extension VITE_MY_EXTENSION_SOURCE=http://localhost:5183/embedded.html yarn dev

Comet Extension Operator

The Comet Extension Operator code lives in src/MyExtension.sol.

Note: script/copy-abi.sh is currently used to sync the ABI from the MyExtension.sol to abis/MyExtension.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_extension.sh

or mainnet:

script/mainnet/deploy_extension.sh

But the recommended way to deploy is through GitHub Actions via Seacrest. Simply run the Deploy Extension [Goerli] or Deploy Extension [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-extension/
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_EXTRA_EXTENSIONS=my_extension VITE_MY_EXTENSION_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_EXTRA_EXTENSIONS=my_extension VITE_MY_EXTENSION_SOURCE=http://localhost:5183/embedded.html yarn dev

Contributing

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

License

All rights reserved, 2022, Compound Labs, Inc.