Momentum Smart Contracts

Smart Contracts for Momentum.

Initialize

Make sure to have node >= 18 and npm >= 9, then

npm i

Compile

npx hardhat compile

Test

npx hardhat test

Generate coverage results and Istanbul

npx hardhat coverage

Test with gas usage report

REPORT_GAS=true npx hardhat test

Deploy

npx hardhat deploy

Generate UML Diagrams

Install sol2uml

npm link sol2uml --only=production

then, run from git root folder:

sol2uml class ./contracts -f all -o ./docs/

If you want to generate a specific contract UML class diagram, just run:

sol2uml class <PATH_TO_FILE> -f all -o <OUTPUT_FILE_PATH>

For more info on sol2uml, you can check their repo.