cryptoalgebra / algebrav1

The first version of Algebra protocol - innovative DEX with concetrated liquidity

Innovative DEX with concentrated liquidity, adaptive fee, build-in farming etc.

• Docs
• Versions
• Packages
• Build
• Tests
• Coverage
• Deploy

Docs

The current short documentation page is located at: API reference

We are currently in the process of creating a more complete and comprehensive version of the documentation.

Versions

Please note that different DEX-partners of our protocol may use different versions of the protocol.

This repository contains smart contracts that belong to the first version of the protocol (Algebra V1.0.0).

A page describing the versions used by partners can be found in the documentation: partners page

Packages

Full packages:

@cryptoalgebra/core v1.0.0

@cryptoalgebra/periphery v1.0.1

@cryptoalgebra/farmings v1.0.1

Only interfaces:

@cryptoalgebra/solidity-interfaces

Build

Requires npm >= 8.0.0

To install dependencies, you need to run the command in the root directory:

$ npm run bootstrap

This will download and install dependencies for all modules and set up husky hooks.

To compile a specific module, you need to run the following command in the module folder:

$ npm run compile

Tests

Tests for a specific module are run by the following command in the module folder:

$ npm run test

Tests coverage

To get a test coverage for specific module, you need to run the following command in the module folder:

$ npm run coverage

Deploy

Firstly you need to create .env file in the root directory of project as in env.example.

To deploy all modules in specific network:

$ node scripts/deployAll.js <network>