sweatpotato13 / solidity-contract-boilerplate

pre-configured hardhat project to run, debug, test and deploy your next solidity smart contract

🛠️ solidity-contract-boilerplate

TLDR; pre-configured hardhat project to run, debug, test and deploy your next solidity smart contract.

This project should be your personal and always reliable swiss knife available in your pocket when you need to create a new Solidity project to be released on the Ethereum Blockchain.

What is inside?

• Example of well-made Solidity Contract
• Example of a well-made test suite for your Solidity Contract
• Pre-configured Hardhat project
• Automatically generate TypeScript bindings

Hardhat plugins included

• hardhat-ethers: injects ethers.js into the Hardhat Runtime Environment
• hardhat-waffle: adds a Waffle-compatible provider to the Hardhat Runtime Environment and automatically initializes the Waffle Chai matchers
• TypeChain: automatically generate TypeScript bindings for smartcontracts
• hardhat-solhint: easily run solhint to lint your Solidity code
• hardhat-etherscan: automatically verify contracts on Etherscan

How to use it

1. Click the "Use this template" green button
2. yarn install
3. Modify the contract/test case
4. Run the contract locally with yarn chain and yarn deploy (deploy to local hardhat network)
5. Test the contract with yarn test
6. Change .env.example into .env and configure it
7. Deploy your contract where you want!

TODO

• Support to eslint for the typescript testing lib
• Support for hardhat-deploy, an Hardhat Plugin to better manage deployment
• Add support to solidity-coverage plugin
• Add support to hardhat-gas-reporter plugin
• TBD / Create a PR with suggestions!