rithik-dev / grants-contracts-upgradeable

Questbook v0

This repository contains the core smart contracts for the Decentralised Grants Orchestrator tool.

Any protocol can visit the tool and create a DAO or Workspace which can then be used to create and list grants on the tool. On the other hand developers can visit the platform and apply for grant of their liking.

There are 4 contracts involved with self explanatory names:

• Workspace Registry - Responsible for workspace related operations
• Grant Factory - Factory contract which is responsible for creating grants as seperate contracts
• Grant - Implementation of grant related operations
• Application Registry - Responsible for application related operations

Sequence diagram:

Product flow:

Scaffolded from - Solidity Template

Usage

Pre Requisites

Before running any command, you need to create a .env file and set a BIP-39 compatible mnemonic as an environment variable. Follow the example in .env.example. If you don't already have a mnemonic, use this website to generate one.

Then, proceed with installing dependencies:

yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

TypeChain

Compile the smart contracts and generate TypeChain artifacts:

$ yarn typechain

Prettify Solidity

Prettify the Solidity code:

$ yarn prettier:sol

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Prettify Typescript

Prettify the Typescript code:

$ yarn prettier:ts

Lint TypeScript

Lint the TypeScript code:

$ yarn lint:ts

Test

Run the Mocha 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.