Merkl Contracts

This repository contains the smart contracts of the Merkl product developed by Angle.

It basically contains two contracts:

• DistributionCreator: to which DAOs and individuals can deposit their rewards to incentivize a pool
• Distributor: the contract where users can claim their rewards

Setup

Install packages

You can install all dependencies by running

yarn
forge i

Create .env file

In order to interact with non local networks, you must create an .env that has:

• MNEMONIC
• network key
• ETHERSCAN_API_KEY

For additional keys, you can check the .env.example file.

Warning: always keep your confidential information safe.

Tests

Contracts in this repo rely on Hardhat tests. You can run tests as follows:

yarn hardhat:test ./test/hardhat/distributor/distributor.test.ts

You can also check the coverage of the tests with:

yarn hardhat:coverage

Coverage

yarn hardhat:coverage

Deploying

yarn deploy mainnet

Foundry Installation

curl -L https://foundry.paradigm.xyz | bash

source /root/.zshrc
# or, if you're under bash: source /root/.bashrc

foundryup

To install the standard library:

forge install foundry-rs/forge-std

To update libraries:

forge update

Media

Don't hesitate to reach out on Twitter 🐦