tolga-coplu/aurora-staking-contracts

Aurora staking contracts

Aurora Staking smart contracts.

This repository contains the Aurora's staking and community treasury contracts.

Install

Prerequisites:

• Node 14+
• Yarn

Then install the dependencies as follows:

yarn install

Compile

Before you compile the contracts, you should set the env vars:

cp .env.example .env

Update the enviroment variables which will be used in the hardhat-config.js.

Then compile the contracts as follows:

yarn compile

Test

To run the test:

yarn test

To get the test coverage:

yarn coverage

Deployment

For more details about the deployments and the supported networks, check out this doc.

Generate docs

Execute the following command to regenerate the contracts documentation:

yarn generate:doc

Then check out the index.html.

Docs

• High level Architecture