Skip to content

0xTobias/solidity-boilerplate

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hardhat Boilerplate

Why ?

Thought to have a fast way of bootstraping projects with best practice's in mind. Having linters, prettiers, standards on how to commit, and changelog creation & maintenance.


How ?

This is achieved using several hardhat plugins, and external known packages.


Tools

This boilerplate includes:


Commands

Coverage

yarn coverage

Runs solidity code coverage

Fork

yarn fork

Runs a mainnet fork via hardhat's node forking util.

yarn fork:script {path}

Runs the script in mainnet's fork.

yarn fork:test

Runs tests that should be run in mainnet's fork.

Lint

yarn lint

Runs solhint.

Prettier (lint fix)

yarn lint:fix

Runs prettier

Release

yarn release

Runs standard changelog, changes package.json version and modifies CHANGELOG.md accordingly.

Test

yarn test

Runs all solidity tests.

yarn test:unit

Runs all solidity tests in folder unit

yarn test:e2e

Runs all solidity tests in folder e2e

Gas report

yarn test:gas

Runs all tests and report gas usage.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 88.8%
  • Solidity 7.0%
  • Shell 3.0%
  • JavaScript 1.2%