README.md

TEMPLATE

Template based on Aura finance' contracts open sourced repo production environment.

Security

Dev

Install

$ yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

TypeChain

Compile the smart contracts and generate TypeChain artifacts:

$ yarn typechain

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Lint TypeScript

Lint the TypeScript code:

$ yarn lint:ts

Test

Run the Mocha tests:

$ yarn test

Run fork tests

$ yarn test:fork:all

Tasks

Running in fork mode

$ NODE_URL=<FORK_URL> yarn task:fork <TASK_NAME>

Running task normally

$ NODE_URL=<NODE_URL> yarn task --network <NETWORK> <TASK_NAME>

Coverage

Generate the code coverage report:

$ yarn coverage

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ yarn clean

Diagrams

Deployments

CHAIN (CHAIN ID)