- 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/PatrickAlphaC/hardhat-fund-me-fcc
cd hardhat-fund-me-fcc
yarn
Deploy:
yarn hardhat deploy
yarn hardhat test
yarn hardhat coverage
- Setup environment variables
You'll want to set your GOERLI_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.
GOERLI_RPC_URL
: This is url of the goerli 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 hardhat deploy --network goerli
After deploy to a testnet or local net, you can run the scripts.
yarn hardhat run scripts/fund.js
or
yarn hardhat run scripts/withdraw.js
You can estimate how much gas things cost by running:
yarn hardhat 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.
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 goerli contracts!
However, you can manual verify with:
yarn hardhat verify --constructor-args arguments.js DEPLOYED_CONTRACT_ADDRESS
solhint
installation: Documentation
To check linting / code formatting:
yarn lint
or, to fix:
yarn lint:fix
yarn format