@primitivefi/rmm-ethers

rmm-ethers

Inspired by Liquity Ethers.

Overview

1. User (frontend, connected user, etc.) calls a function in EthersRmm.ts
2. EthersRmm calls into the SendableEthersRmm
3. SendableEthersRmm calls into PopulatableEthersRmm
4. PopulatableEthersRmm builds the transaction and packages it, sends it back to sendable
5. Sendable broadcasts the transaction to the network, returning a SentEthersRmmTransaction to EthersRmm
6. EthersRmm resolves the SentEthersRmmTransaction receipt, once a receipt exists
7. EthersRmm returns the details of the receipt to the original user.

Usage

Pre Requisites

Before running any command, make sure to install dependencies:

$ yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

Test

Run the Mocha tests:

$ yarn test

Deployments

RMM Protocol

Deploy the protocol to a network:

$ yarn deploy --network nameOfNetwork

RMM Pools

Deploy pools in the config of the deploy-pools.ts script:

$ yarn deploy:pools --network nameOfNetwork