Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 4.22 KB

README.md

File metadata and controls

99 lines (61 loc) · 4.22 KB
Raw

Basic Sample Hardhat Project on Celo

Hardhat Documentation

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.

Try running some of the following tasks:

npx hardhat accounts
npx hardhat devchain-keys  # print devchain keys
npx hardhat create-account # print new key + account

Alfajores Testnet Setup

Note This setup is not required when using a local development blockchain (like celo-devchain or Ganache).

  1. Create a .env file similar to .envexample.
  2. Add a private key. Generate a new one with npx hardhat create-account. Paste the private key in .env.
  3. Faucet your account with the Alfajores testnet faucet here.

Develop

  1. Write your contracts in ./contracts.
  2. Update contract deployment scripts in ./deploy.
  3. Deploy contracts with yarn deploy. Optionally add the reset flag (yarn deploy --reset) to overwrite previous deployment info. The default deployment network is specified in hardhat.config.js and is set to alfajores initially. You can also overwrite previous deployments and redeploy when there are changes to the deployment script or contracts automatically by running yarn deploy-reset-watch. You can specify a specific network deployment directly with
npx hardhat --network [network] deploy
  1. Auto deploy any contract updates by running yarn watch.

Network configs are defined in hardhat.config.js.

Celo devchain

Run a local development Celo chain with yarn devchain. You can print the addresses of the Celo protocol contracts with npx @terminal-fi/celo-devchain --test.

This is a version of Ganache (@celo/ganache-cli) that deploys the Celo core protocol contracts when it starts.

NOTE: @celo/ganache-cli works only with Node 10 or Node 12 versions. Using Node 14 or later will result in errors.

NOTE: @celo/ganache-cli currently doesn't support locally signed transactions. If you send a locally signed transaction it will throw: Error: Number can only safely store up to 53 bits error and crash. Thus you have to make sure your ContractKit doesn't actually have the private keys for test addresses and send transactions to be signed by ganache-cli itself.

Start

npx celo-devchain --port 8545

or

yarn devchain

Generate Typescript bindings

This setting defaults to the web3 v1 bindings because that is what is used by use-contractkit in packages/react-app.

You can change the output directory and target in hardhat.config.js.

npx hardhat typechain

Read more about Typechain here and more about the hardhat plugin here.

Run sanity tests and print all core contract addresses:

npx @terminal-fi/celo-devchain --test

Fork mainnet with Ganache

You can get a local copy of mainnet by forking with Ganache. Learn more about forking mainnet with Ganache here.

There is a script provided (yarn fork-mainnet) to fork mainnet and fund the same test accounts that come with Celo devchain. Sometimes sending transactions from the first account (which defaults to 0x5409ED021D9299bf6814279A6A1411A7e866A631) is delayed and sending test transactions from the other accounts works better for some reason. 🤷 The private keys of the associated test accounts are printed in account_keys.json.

Verify your contracts

You can easily verify your contracts deployed to the associated networks with the following commands.

Reference

On Alfajores:

npx hardhat --network alfajores sourcify

On Mainnet:

npx hardhat --network celo sourcify