Skip to content

Combines Hardhat, TypeChain, Ethers, Waffle, Solhint, Solcover and Prettier

Notifications You must be signed in to change notification settings

Ngiannakoylis/solidity-template

This branch is 151 commits behind PaulRBerg/hardhat-template:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2186ed4 · Feb 21, 2022
Sep 8, 2021
Sep 1, 2021
Oct 26, 2021
Jun 15, 2021
Jan 30, 2022
Nov 11, 2021
Nov 16, 2021
Sep 1, 2021
Feb 19, 2021
Jul 6, 2020
Feb 21, 2022
Oct 19, 2021
Sep 3, 2021
Nov 28, 2021
Sep 22, 2021
Oct 19, 2021
Aug 6, 2021
Oct 19, 2021
Jun 27, 2021
Sep 24, 2021
Oct 26, 2021
Oct 30, 2021
Feb 21, 2022
Feb 21, 2022
Oct 19, 2021
Feb 21, 2022

Repository files navigation

Solidity Template

My favorite setup for writing Solidity smart contracts.

  • Hardhat: compile and run the smart contracts on a local development network
  • TypeChain: generate TypeScript types for smart contracts
  • Ethers: renowned Ethereum library and wallet implementation
  • Waffle: tooling for writing comprehensive smart contract tests
  • Solhint: linter
  • Solcover: code coverage
  • Prettier Plugin Solidity: code formatter

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.

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

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

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 --greeting "Bonjour, le monde!"

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.

About

Combines Hardhat, TypeChain, Ethers, Waffle, Solhint, Solcover and Prettier

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.8%
  • Solidity 3.3%
  • Shell 3.0%
  • JavaScript 0.9%