README.md

TurnUp Contracts

Usage

Clone the repo

git clone [email protected]:TurnUpTeam/turnup-contracts.git

Install the dependencies

npm install

Compile the smart contracts

npm run compile

Run the tests

npm run test

Run the tests and calculate gas usage

npm run test:gas

Run the tests with coverage

npm run coverage

After running the coverage, you can check it opening the file coverage/index.html in your browser.

Check the lint

npm run lint

Get the size of the smart contracts

npm run size

Flatten the smart contracts

After deploying to the blockchain, you can flatten the smart contracts to verify the source code on Etherscan with the following command:

bin/flatten.sh TurnupSharesV4

To export the ABI

bin/export.sh

Notice that the ABI is exported anyway during the pre-commit hook.