Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/curvefi/curve-contract

Vyper contracts used in Curve.fi exchange pools.
https://github.com/curvefi/curve-contract

defi ethereum vyper

Last synced: 14 days ago
JSON representation

Vyper contracts used in Curve.fi exchange pools.

Host: GitHub
URL: https://github.com/curvefi/curve-contract
Owner: curvefi
License: other
Created: 2020-01-15T21:49:06.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-03-20T15:35:33.000Z (8 months ago)
Last Synced: 2024-10-15T17:43:14.461Z (28 days ago)
Topics: defi, ethereum, vyper
Language: Python
Homepage: https://www.curve.fi/
Size: 1.52 MB
Stars: 1,029
Watchers: 56
Forks: 384
Open Issues: 47
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

DeFi-Map - sorce code
awesome-os - curve-contract

README

# curve-contract

Vyper contracts used in [Curve](https://www.curve.fi/) exchange pools.

## Overview

Curve is an exchange liquidity pool on Ethereum designed for extremely efficient stablecoin trading and low risk, supplemental fee income for liquidity providers, without an opportunity cost.

Curve allows users to trade between correlated cryptocurrencies with a bespoke low slippage, low fee algorithm. The liquidity pool is also supplied to lending protocol where it generates additional income for liquidity providers.

## Testing and Development

### Dependencies

* [python3](https://www.python.org/downloads/release/python-368/) from version 3.6 to 3.8, python3-dev
* [brownie](https://github.com/iamdefinitelyahuman/brownie) - tested with version [1.13.2](https://github.com/eth-brownie/brownie/releases/tag/v1.13.2)
* [ganache-cli](https://github.com/trufflesuite/ganache-cli) - tested with version [6.12.1](https://github.com/trufflesuite/ganache-cli/releases/tag/v6.12.1)
* [brownie-token-tester](https://github.com/iamdefinitelyahuman/brownie-token-tester) - tested with version [0.1.0](https://github.com/iamdefinitelyahuman/brownie-token-tester/releases/tag/v0.1.0)

Curve contracts are compiled using [Vyper](https://github.com/vyperlang/vyper), however installation of the required Vyper versions is handled by Brownie.

### Setup

To get started, first create and initialize a Python [virtual environment](https://docs.python.org/3/library/venv.html). Next, clone the repo and install the developer dependencies:

```bash
git clone https://github.com/curvefi/curve-contract.git
cd curve-contract
pip install -r requirements.txt
```

### Organization and Workflow

* New Curve pools are built from the contract templates at [`contracts/pool-templates`](contracts/pool-templates)
* Once deployed, the contracts for a pool are added to [`contracts/pools`](contracts/pools)

See the documentation within [`contracts`](contracts) and it's subdirectories for more detailed information on how to get started developing on Curve.

### Running the Tests

The [test suite](tests) contains common tests for all Curve pools, as well as unique per-pool tests. To run the entire suite:

```bash
brownie test
```

To run tests on a specific pool:

```bash
brownie test tests/ --pool
```

Valid pool names are the names of the subdirectories within [`contracts/pools`](contracts/pools). For templates, prepend `template-` to the subdirectory names within [`contracts/pool-templates`](../contracts/pool-templates). For example, the base template is `template-base`.

You can optionally include the `--coverage` flag to view a coverage report upon completion of the tests.

## Deployment

To deploy a new pool:

1. Ensure the `pooldata.json` for the pool you are deploying contains all the necessary fields.
2. Edit the configuration settings within [`scripts/deploy.py`](scripts/deploy.py).
3. Test the deployment locally against a forked mainnet.

```bash
brownie run deploy --network mainnet-fork -I
```

When the script completes it will open a console. You should call the various getter methods on the deployed contracts to ensure the pool has been configured correctly.

4. Deploy the pool to the mainnet.

```bash
brownie run deploy --network mainnet
```

Be sure to open a pull request that adds the deployment addresses to the pool `README.md`.

## Audits and Security

Curve smart contracts have been audited by Trail of Bits. These audit reports are made available on the [Curve website](https://www.curve.fi/audits).

There is also an active [bug bounty](https://www.curve.fi/bugbounty) for issues which can lead to substantial loss of money, critical bugs such as a broken live-ness condition, or irreversible loss of funds.

## License