drikkx / algebra Goto Github PK

Innovative DEX with concentrated liquidity and customizable plugins.

• Docs
• Versions
• Packages
• Build
• Tests
• Tests coverage
• Deploy

The documentation page is located at: https://docs.algebra.finance/

Please note that different DEX-partners of our protocol may use different versions of the protocol. This repo contains the latest version: Algebra Integral.

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

Previous versions of the protocol have been moved to separate repositories:

Algebra V1.9

Algebra V1

Core: https://www.npmjs.com/package/@cryptoalgebra/integral-core

Periphery: https://www.npmjs.com/package/@cryptoalgebra/integral-periphery

Farming: https://www.npmjs.com/package/@cryptoalgebra/integral-farming

Basic plugin: https://www.npmjs.com/package/@cryptoalgebra/integral-base-plugin

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 for a specific module are run by the following command in the module folder:

$ npm run test

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

$ npm run coverage

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>