@web3-citizen/periphery-sol v0.0.0-beta.0

 _    _      _      _____   _____ _ _   _
| |  | |    | |    |____ | /  __ (_) | (_)
| |  | | ___| |__      / / | /  \/_| |_ _ _______ _ __
| |/\| |/ _ \ '_ \     \ \ | |   | | __| |_  / _ \ '_ \
\  /\  /  __/ |_) |.___/ / | \__/\ | |_| |/ /  __/ | | |
 \/  \/ \___|_.__/ \____/   \____/_|\__|_/___\___|_| |_|

Core Smart Contracts

cp .envrc.example .envrc

Installation

Install the repo and dependencies by running: yarn

Deployment

These contracts can be deployed to a network by running: yarn deploy <networkName>

Verification

These contracts can be verified on Etherscan, or an Etherscan clone, for example (Polygonscan) by running: yarn etherscan-verify <ethereum network name> or yarn etherscan-verify-polygon matic

Testing

Run the unit tests locally with: yarn test

Coverage

Generate the test coverage report with: yarn coverage