QuidRaise / Quid-contracts

Smart contracts for the Quid protocol

QuidRaise

Usage

Pre Requisites

Before running any command, you need to create a .env file Follow the example in .env.example.

Then, proceed with installing dependencies:

yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Test

Run the tests:

$ yarn test

Coverage

Generate the code coverage report:

$ yarn coverage

Report Gas

See the gas usage per unit test and average gas per method call:

$ REPORT_GAS=true yarn test

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ yarn clean

Deploy

Deploy the contracts to Hardhat Network:

$ yarn deploy

Syntax Highlighting

If you use VSCode, you can enjoy syntax highlighting for your Solidity code via the vscode-solidity extension. The recommended approach to set the compiler version is to add the following fields to your VSCode user settings:

{
  "solidity.compileUsingRemoteVersion": "v0.8.4+commit.c7e474f2",
  "solidity.defaultCompiler": "remote"
}

Where of course v0.8.4+commit.c7e474f2 can be replaced with any other version.

Running a fork of the binance mainnet in order to test the app

$ ganache-cli --fork https://data-seed-prebsc-1-s1.binance.org:8545 -u 0xEfB826Ab5D566DB9d5Af50e17B0cEc5A60c18AA3