Smart contracts boilerplate

Installation

$ npm use

$ npm install

Development

Creating smart contract

Create your smart contract in contracts/ folder

Compilation

Set solidity version in hardhat.config.ts file, solidity -> compilers -> version, then run compilation

$ npx hardhat compile

Running tests

Create your tests in test folder. To set typed test, describe types in test.config.d.ts. Then, use it with Mocha.Context (this)

Run tests with command:

$ npx hardhat test TEST_PATH

Run tests and calculate gasPrice with command:

$ REPORT_GAS=true npx hardhat test

Deploy

Run deploy in hardhat network

$ npx hardhat deploy

Run deploy in ropsten network

$ npm run deploy:ropsten 

Run deploy in ropsten network for new contract

$ npm run deploy:ropsten:new

Verification contract

Run verify in ropsten network

$ npm run verify:ropsten

Useful links

1. Hardhat documentation: https://hardhat.org/getting-started/
2. Style Guide: https://docs.soliditylang.org/en/v0.8.13/style-guide.html#style-guide
3. Common Patterns: https://docs.soliditylang.org/en/v0.8.13/common-patterns.html
4. Security Considerations: https://docs.soliditylang.org/en/v0.8.13/security-considerations.html#security-considerations