https://github.com/cowprotocol/cow-amm
An automated market maker running on top of CoW Protocol
https://github.com/cowprotocol/cow-amm
Last synced: about 1 year ago
JSON representation
An automated market maker running on top of CoW Protocol
- Host: GitHub
- URL: https://github.com/cowprotocol/cow-amm
- Owner: cowprotocol
- Created: 2024-01-12T18:14:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T16:00:28.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T23:13:46.249Z (about 1 year ago)
- Language: Solidity
- Size: 730 KB
- Stars: 17
- Watchers: 7
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Audit: audit/2024-05-13-gnosis-come-du-crest.pdf
Awesome Lists containing this project
README
# CoW AMM
> [!WARNING]
> All CoW AMM versions described in this repository have been deprecated in favor of the [Balancer CoW AMM](https://github.com/defi-wonderland/balancer-v1-amm/).
> Support for pools deployed with the code in this repository may be dropped at any time without further notice.
CoW AMM is an automated market maker running on top of CoW Protocol.
## Documentation
You can find detailed documentation on the building blocks of this repo in the following files:
- [amm.md](./docs/amm.md): details on what a CoW AMM is and how to set it up.
## Research
Details on the theory behind CoW AMM can be found on the paper [Arbitrageurs' profits, LVR, and sandwich attacks: batch trading as an AMM design response](https://arxiv.org/pdf/2307.02074.pdf).
## Development
### Dev set up
You can install git hooks to help you catch simple mistakes before running some git actions like committing.
See the [dedicated instructions](./dev/hooks/install.md) for how to install the hooks.
### Build
```shell
$ forge build
```
### Test
```shell
$ forge test
```
### Format
```shell
$ forge fmt
```
### Deploy
All contracts in this repo can be deployed and verified on the block explorer as follows:
```sh
export ETHERSCAN_API_KEY='your API key here'
PK='the private key of the deployer'
ETH_RPC_URL='https://rpc.node.url.here.example.com'
forge script 'script/DeployAllContracts.s.sol:DeployAllContracts' -vvvv --rpc-url "$ETH_RPC_URL" --private-key "$PK" --verify --broadcast
```
### Deployment addresses
The file [`networks.json`](./networks.json) lists all official deployments of the contracts in this repository by chain id.
The deployment address file is generated with:
```sh
bash dev/generate-networks-file.sh > networks.json
```