AngelBlock contracts

Functional and technical documentation for Solidity:

• fundraising
• nfts
• staking
• tholos

Functional and technical documentation for Ink:

• aleph zero integration

Setup

Fill in secrets:

cp env/.eth.template env/.eth && nano env/.eth
cp env/.azero.template env/.azero && nano env/.azero

Start blockchain:

make up

For first time it might require to install deps on container:

make install
yarn run init-husky
make recreate

Run unit tests

Tests run compilation with all Foundry plugins and all smart contract modules:

make runtest

Unit tests for individual smart contract modules could be invoked by:

make runtest-fundraising
make runtest-staking
make runtest-tholos

Run tests on forked mainnet

Uncomment FORK_MAINNET in env/.hardhat, recreate docker container (make recreate) and run:

make runtest-fork

Generate coverage

Just run following to generate new coverage report:

make gen-coverage

Add documentation

For functional documentation update ./docs that during compilation produce docs together with generated technical documentation.

Run Hardhat scripts

Directly invoke script via docker-compose to pass env and one of package.json run- commands:

docker-compose -e ENV_VAR=abc eth yarn run-hh script-name

Run commands:

• run-hh (runs on local node)
• run-dev (runs on dev environment)
• run-stg (runs on stage environment)
• run-pre (runs on pre-prod environment)
• run-prod (runs on production environment)

For available scripts check scripts folder.
For required and optional env check individual script file.