@merofinance/protocol

Mero Protocol

This is the official repository for the Mero protocol contracts.

In addition to the code, check out the official Mero documentation as well as the Mero developers documentation, and the list of deployed contracts.

The test suite repository is built with Pytest, which is used by Brownie.

The test suite relies on the following packages:

• eth-brownie: Testing framework for solidity and vyper code written in Python using Pytest
• brownie-token-tester: Custom mint logic for ERC20 tokens in mainnet-fork mode

Getting Started

To get started using this repository, install the requirements (presumably in a virtual enviroment):

pip install -r requirements.txt

To run the full test suite, run:

brownie test

For a more detailed overview of how the Mero protocol can be tested, please read the test suite documentation.

To compile all contracts, run:

brownie compile

For a detailed overview of how to use Brownie, please check out the official docs.

Repository Structure

All Mero contracts are located within the contracts directory.

The tests are located within the tests directory. The different liquidity pools that exist are specified in the tests directory here.

Environment Variables

The required environments variables that need to be set for running the test suite are listed here.

Note: The ETHERSCAN_TOKEN environment variable may need to be specified when running tests in mainnet-fork mode, as Etherscan is used to fetch the latest contract data and the API request limit may be reached.