cryptoalgebra / algebra

Algebra AMM main repository

Innovative DEX with concentrated liquidity and customizable plugins.

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

Docs

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

Versions

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

Packages

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

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>

algebra's Issues

Strict pragmas in interfaces

It would be really convenient if interfaces in tokenomics section were having non-strict pragmas (e. g. pragma solidity >=0.8.0 instead of current pragma solidity =0.8.17). Right now it's impossible to load this repo as a foundry lib and use interfaces in contracts for projects using different versions

It would be great if you could update it in other branches too, because as i understand, quickswap runs on 1.1.0 version or lower

Suggesting Spelling change

I think in https://github.com/adityakode/Algebra/blob/master/README.md,
in the tagline Innovative DEX with concentrated liquidity, adaptive fee, build-in farming etc.
build should be replaced by built as it would look more gramatically correct.

This is just a suggestion.

Hard to Integrate

I'm building compounder.fi, a protocol to help liquidity providers earn compound interest (by reinvesting unclaimed fees). I've been trying to integrate with you and your partner's platforms but it is ridiculously hard to do so.

• Docs are almost nonexistent (besides the statically generated ones from hardhat and the minimal ones on the website)
• Implementations are different across protocols (ran into an issue where two globalState functions returned entirely different things)
• protocols don't provide docs either, and don't even provide links to their deployed contracts -> required me to manually dig on chain to find them
• nonfungiblepositionmanager is the same one as uniswap's in this repo but different in the deployed contracts
• quickswap literally deploys the CONTRACT TESTS when they create2 their pools

Algebra is an awesome protocol, but the lack of docs and standards makes it really hard to work with.