Reservoir AMM-core

Setup

Install global dependencies

This repo uses foundry as the main tool for compiling and testing smart contracts. You can install foundry via:

curl -L https://foundry.paradigm.xyz | bash

For alternative installation options & more details see the foundry repo.

Install project dependencies

git submodule update --init --recursive
nvm use
npm ci
npm run install

Building

forge build

Testing

To run unit tests:

forge test

To run integration tests:

npm run test:integration

To run differential fuzz tests:

npm run test:differential

To run legacy tests:

npm run test:uniswap

Audits

You can find all audit reports under the audits folder.

V1.0

• ABDK

Contributing

Are you interested in helping us build the future of Reservoir? Contribute in these ways:

• For SECURITY related or sensitive bugs, please get in touch with the team at [email protected] or on discord instead of opening an issue on github.

• If you find bugs or code errors, you can open a new issue ticket here.

• If you find an issue and would like to submit a fix for said issue, follow these steps:

  • Start by forking the amm-core repository to your local environment.
  • Make the changes you find necessary to your local repository.
  • Submit your pull request.

• Have questions, or want to interact with the team and the community? Join our discord!