https://github.com/beauwilliams/Solidity-Hardhat-Starter-Template

A comprehensive starter template for solidity based on hardhat framework. Auditing/Test CI, Tasks, Upgradeable Contract & More
https://github.com/beauwilliams/Solidity-Hardhat-Starter-Template

ethereum hardhat solidity solidity-contracts web3

Last synced: 3 months ago
JSON representation

A comprehensive starter template for solidity based on hardhat framework. Auditing/Test CI, Tasks, Upgradeable Contract & More

• Host: GitHub
• URL: https://github.com/beauwilliams/Solidity-Hardhat-Starter-Template
• Owner: beauwilliams
• Created: 2022-07-08T03:05:21.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-04T20:21:23.000Z (over 1 year ago)
• Last Synced: 2023-03-04T15:29:51.871Z (over 1 year ago)
• Topics: ethereum, hardhat, solidity, solidity-contracts, web3
• Language: TypeScript
• Homepage:
• Size: 135 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-hardhat - Hardhat Starter - A comprehensive starter template for hardhat. Auditing/Test CI, Tasks, Upgradeable Contract & More (Starters)

README

        
#  Hardhat-Starter-Template

## OVERVIEW

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 😏

## GET STARTED

This project uses a [task runner called just, for convenience](https://github.com/casey/just)

```

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

```

### Running tests and audits

- Run the unit tests with `just test`

- Statically analyse code for vulnerabilities with `just audit`

### Starting a new project from this template

- Clean the workspace (to start a new project, removing example code and scripts) using `just clean`

- Create your solidity code in `/contracts`, tests in `/test` and deploy/verify scripts in `/scripts`

## Available Tasks

See `./tasks/index.ts` to view available tasks and enable them.

Some might require a little configuration

## FAQ

### Error compiling contracts on freshly cloned repo

`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

### Performance optimizations

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.

### Husky

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.

### Error running audit task

Ensure [Slither](https://github.com/crytic/slither) is installed and in your $PATH

## Github Code Scanning Integration



## DEMO

![demo](https://i.ibb.co/tY00DR0/Screen-Shot-2022-07-13-at-1-57-15-pm.png)

## TODO

- [ ] Fix prettier plugin sol hint not working nvim (Remove prettier plugin from sol hint.son to fix)