Skip to main content

Solidity Template

项目地址: solidity-template

My favourite setup for writing Solidity smart contracts.

This is a GitHub template, which means you can reuse it as many times as you want. You can do that by clicking the "Use this template" button at the top of the page.


Pre Requisites

Before running any command, make sure to install dependencies:

$ yarn install


Compile the smart contracts with Hardhat:

$ yarn compile


Compile the smart contracts and generate TypeChain artifacts:

$ yarn typechain

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Lint TypeScript

Lint the TypeScript code:

$ yarn lint:ts


Run the Mocha tests:

$ yarn test


Generate the code coverage report:

$ yarn coverage


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

$ yarn clean