Price Oracle for CoW AMM LP Tokens

Development of a manipulation-resilient price oracle for CoW AMM LP tokens.

Getting Started

$ git clone https://github.com/cowdao-grants/cow-amm-lp-oracle
$ cd cow-amm-lp-oracle
$ bun install

Contract Deployment and Verification

The repository includes pre-configured RPC endpoints for various networks. When deploying contracts using forge script, you can:

1. Specify the network: --rpc-url <network> (e.g., --rpc-url mainnet)
2. Set your block explorer API key: export ETHERSCAN_API_KEY=your_api_key
3. Use the --verify flag for contract verification

Supported networks: mainnet, sepolia, gnosis, arbitrum, base, and localhost.

For detailed information about contract deployment and verification, see the Foundry Book.

VSCode Integration

It is recommended to use VSCode with the Nomic Foundation's Solidity extension.

For guidance on how to integrate a Foundry project in VSCode, please refer to this guide.

GitHub Actions

This project uses GitHub Actions for continuous integration (CI). On every push and pull request made to the main branch, the contracts will be linted, built, and tested.

The CI workflow configuration can be found and modified in .github/workflows/ci.yml.

Acknowledgements

PaulRBerg/foundry-template

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).