Skip to content

Commit

Permalink
some fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
IliaAzhel committed Jan 24, 2024
1 parent 3dd4a40 commit eec161e
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 63 deletions.
44 changes: 0 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,50 +7,21 @@ Innovative DEX with concentrated liquidity and customizable plugins.
</p>

<p align="center">
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_core.yml"><img alt="Tests status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_core.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_periphery.yml"><img alt="Echidna status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_periphery.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_plugin.yml"><img alt="Tests status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_plugin.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_farmings.yml"><img alt="Tests status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_farmings.yml/badge.svg"></a>
</p>
<p align="center">
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_core.yml"><img alt="Echidna status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_core.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_periphery.yml"><img alt="Echidna status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_periphery.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_plugin.yml"><img alt="Echidna status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_plugin.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_farming.yml"><img alt="Echidna status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_farming.yml/badge.svg"></a>
</p>


- [Docs](#docs)
- [Versions](#versions)
- [Packages](#packages)
- [Build](#build)
- [Tests](#tests)
- [Tests coverage](#tests-coverage)
- [Deploy](#deploy)

## Docs

The documentation page is located at: <a href="https://cryptoalgebra.gitbook.io/algebra-integral/">https://cryptoalgebra.gitbook.io/algebra-integral/</a>

## 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](https://docs.algebra.finance/en/docs/contracts/partners/introduction)

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

[Algebra V1.9](https://github.com/cryptoalgebra/AlgebraV1.9)

[Algebra V1](https://github.com/cryptoalgebra/AlgebraV1)

## Packages

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

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

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

## Build

Expand All @@ -77,18 +48,3 @@ Tests for a specific module are run by the following command in the module folde
$ 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>
```
17 changes: 0 additions & 17 deletions src/README.md

This file was deleted.

3 changes: 1 addition & 2 deletions src/plugin/brevis/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Algebra Plugins
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_plugin.yml"><img alt="Tests status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/tests_plugin.yml/badge.svg"></a>
<a href="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_plugin.yml"><img alt="Echidna status" src="https://github.com/cryptoalgebra/Algebra/actions/workflows/echidna_plugin.yml/badge.svg"></a>

This directory contains the base Algebra protocol plugin, which combines the following functionality:
- TWAP oracle
- volatility oracle
- dynamic fee manager
- farmings adapter


## License

Licenses for smart contracts are specified in SPDX headers. A key part of the Plugins contracts is under BUSL-1.1 (Business Source License 1.1).
Expand Down

0 comments on commit eec161e

Please sign in to comment.