Hardhat Typescript Template - adapted from Patrick Collins
FundMe.sol contains some of the best practice of writing smart contracts according to the layout and structure as defined by the solidity documentation
- Hardhat Template - Typescript Edition
- Getting Started
- Usage
- Deployment to a testnet or mainnet
- Linting
- Thank you!
- git
- You'll know you did it right if you can run
git --version
and you see a response likegit version x.x.x
- You'll know you did it right if you can run
- Nodejs
- You'll know you've installed nodejs right if you can run:
node --version
and get an ouput like:vx.x.x
- You'll know you've installed nodejs right if you can run:
- Yarn instead of
npm
- You'll know you've installed yarn right if you can run:
yarn --version
and get an output like:x.x.x
- You might need to install it with
npm
orcorepack
- You'll know you've installed yarn right if you can run:
git clone https://github.com/mikexd-dev/advanced-hardhat-template.git
cd hardhat-template
yarn
yarn typechain
Deploy:
yarn deploy
yarn test
yarn test:coverage
- Setup environment variables
You'll want to set your MUMBAI_RPC_URL
and PRIVATE_KEY
as environment variables. You can add them to a .env
file, similar to what you see in .env.example
.
PRIVATE_KEY
: The private key of your account (like from metamask). NOTE: FOR DEVELOPMENT, PLEASE USE A KEY THAT DOESN'T HAVE ANY REAL FUNDS ASSOCIATED WITH IT.- You can learn how to export it here.
MUMBAI_RPC_URL
: This is url of the MUMBAI testnet node you're working with. You can get setup with one for free from Alchemy
- Get testnet ETH
Head over to faucets.chain.link and get some tesnet ETH. You should see the ETH show up in your metamask.
- Deploy
yarn deploy --network mumbai
After deploy to a testnet or local net, you can run the scripts, examples: [or you can add the script into package.json
yarn hardhat run scripts/fund.ts
or after putting in package.json
"scripts": {
"fund": "yarn hardhat run scripts/fund.ts",
}
Run
yarn deploy
You can estimate how much gas things cost by running:
yarn test
And you'll see and output file called gas-report.txt
To get a USD estimation of gas cost, you'll need a COINMARKETCAP_API_KEY
environment variable. You can get one for free from CoinMarketCap.
Then, uncomment the line coinmarketcap: COINMARKETCAP_API_KEY,
in hardhat.config.ts
to get the USD estimation. Just note, everytime you run your tests it will use an API call, so it might make sense to have using coinmarketcap disabled until you need it. You can disable it by just commenting the line back out.
If you deploy to a testnet or mainnet, you can verify it if you get an API Key from Etherscan and set it as an environemnt variable named ETHERSCAN_API_KEY
. You can pop it into your .env
file as seen in the .env.example
.
In it's current state, if you have your api key set, it will auto verify kovan contracts!
However, you can manual verify with:
yarn hardhat verify --constructor-args arguments DEPLOYED_CONTRACT_ADDRESS
.js
files are now.ts
- We added a bunch of typescript and typing packages to our
package.json
. They can be installed with:yarn add @typechain/ethers-v5 @typechain/hardhat @types/chai @types/node ts-node typechain typescript
- The biggest one being typechain
- This gives your contracts static typing, meaning you'll always know exactly what functions a contract can call.
- This gives us
factories
that are specific to the contracts they are factories of. See the tests folder for a version of how this is implemented.
- We use
imports
instead ofrequire
. Confusing to you? Watch this video - Add
tsconfig.json
To check linting / code formatting:
yarn lint
or, to fix:
yarn lint:fix