Important
This repository is in the process of being migrated to the Foundry Ethereum application development environment. Developers wishing to integrate and/or develop on the CoW Protocol smart contracts with hardhat should refer to tag v1.6.0 Browse files.
This repository contains the Solidity smart contract code for the CoW Protocol (formerly known as Gnosis Protocol).
Extensive documentation is available detailing how the protocol works on a smart contract level.
yarn
yarn buildyarn testThe tests can be run in "debug mode" as follows:
DEBUG=* yarn testGas consumption can be reported by setting the REPORT_GAS flag when running tests as
REPORT_GAS=1 yarn testThis repository additionally includes tools for gas benchmarking and tracing.
In order to run a gas benchmark on a whole bunch of settlement scenarios:
yarn benchThese gas benchmarks can be compared against any other git reference and will default to the merge-base if omitted:
yarn bench:compare [<ref>]In order to get a detailed trace of a settlement to identify how much gas is being spent where:
yarn bench:traceChoose the network and gas price in wei for the deployment. After replacing these values, run:
NETWORK='rinkeby'
GAS_PRICE_WEI='1000000000'
yarn deploy --network $NETWORK --gasprice $GAS_PRICE_WEINew files containing details of this deployment will be created in the deployment folder.
These files should be committed to this repository.
For verifying all deployed contracts:
export ETHERSCAN_API_KEY=<Your Key>
yarn verify:etherscan --network $NETWORKSingle contracts can be verified as well, but the constructor arguments must be explicitly given to the command. A common example is the vault relayer contract, which is not automatically verified with the command above since it is only deployed indirectly during initialization. This contract can be manually verified with:
npx hardhat verify --network $NETWORK 0xC92E8bdf79f0507f65a392b0ab4667716BFE0110 0xBA12222222228d8Ba445958a75a0704d566BF2C8The first address is the vault relayer address, the second is the deployment input (usually, the Balancer vault).
For verifying all deployed contracts:
yarn verify:tenderly --network $NETWORKFor a single contract, named GPv2Contract and located at address 0xFeDbc87123caF3925145e1bD1Be844c03b36722f in the example:
npx hardhat tenderly:verify --network $NETWORK GPv2Contract=0xFeDbc87123caF3925145e1bD1Be844c03b36722fThis package additionally contains a networks.json file at the root with the address of each deployed contract as well the hash of the Ethereum transaction used to create the contract.
Test coverage can be checked with the command
yarn coverageA summary of coverage results are printed out to console. More detailed information is presented in the generated file coverage/index.html.
If a user creates an order with:
- zero sell amount
- zero buy amount
- partially fillable set to false
then this order could be executed an arbitrary amount of times instead of just a single time. This means that any solver could drain the fee amount from the user until not enough funds are available anymore.
We recommend to never sign orders of this form and, if developing a contract that creates orders on behalf of other users, make sure at a contract level that such orders cannot be created.
There is a dedicated script to change the owner of the authenticator proxy.
Usage and parameters can be seen by running:
yarn hardhat transfer-ownership --helpThe content of this repo is published on NPM as @cowprotocol/contracts.
Maintainers this repository can manually trigger a new release. The steps are as follows:
-
Update the package version number in
./package.jsonon branchmain. -
On GitHub, visit the "Actions" tab, "Publish package to NPM", "Run workflow" with
mainas the target branch.
Once the workflow has been executed successfully, a new NPM package version should be available as well as a new git tag named after the released version.