Includes deployment configurations, testing framework, contract upgrades pattern, gas usage report, security analysys audit, test coverage report.. did I also mention it's blazingly fast 😏
This project uses a task runner called just, for convenience
Available recipes:
default
install *PACKAGES
update
compile
compile-watch
deploy-localhost
deploy-testnet
verify-testnet
test
test-watch
lint
start
format
audit
print-audit
print-gas-usage
print-deployments
clean
- Run the unit tests with
just test - Statically analyse code for vulnerabilities with
just audit
- Clean the workspace (to start a new project, removing example code and scripts) using
just clean - Create your solidity code in
/contracts, tests in/testand deploy/verify scripts in/scripts
See ./tasks/index.ts to view available tasks and enable them.
Some might require a little configuration
Error HH12: Trying to use a non-local installation of Hardhat, which is not supported. Please install Hardhat locally using npm or Yarn, and try again.
Run npm i to fix this error which will install hardhat
For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable TS_NODE_TRANSPILE_ONLY to 1 in hardhat's environment. For more details see the documentation.
ERROR ON COMMIT -> husky > pre-commit hook failed (add --no-verify to bypass)
RESOLUTION -> Remove errors from your smart contracts, found running npm run lint, or commit using --no-amend flag to temporarily bypass.
Ensure Slither is installed and in your $PATH
- Fix prettier plugin sol hint not working nvim (Remove prettier plugin from sol hint.son to fix)