Merge pull request #260 from celo-org/therealharpaljadeja/remove-hard…

…hat-celo

refactor: remove hardhat-celo and add customChains config to etherscan plugin

packages/hardhat/.gitignore

@@ -3,11 +3,9 @@ node_modules
 coverage
 coverage.json
 typechain
+typechain-types
 
-#Hardhat files
+# Hardhat files
 cache
 artifacts
-deployments
 
-# hardhat typechain generated files
-types/

packages/hardhat/README.md

@@ -1,124 +1,23 @@
-# Hardhat | Celo Composer
+# Celo Composer | Hardhat
 
-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.
+## How to use
 
-## Setup & Installation
+1. Create a copy of `.env.example` and rename it to `.env`.
 
-### Alfajores Testnet Setup
+2. For Deploying you will need `PRIVATE_KEY` set in `.env`.
 
-**Note** This setup is not required when using a local development blockchain (like celo-devchain or Ganache).
+3. For verification you will need [Celoscan API Key](https://celoscan.io/myapikey) `CELOSCAN_API_KEY` set in `.env`.
 
-1. Create a `.env` file similar to `.envexample`.
-2. Paste the private key in `.env`.
-
-Alternatively, you can also run the following command to generate a new account
-
-```sh
-npx hardhat create-account
-```
-
-> **Note** : Depending on how you generate your private key, you may have to prepend `0x` in the private key does not already have it prepended.
-
-3. Faucet your account with the Alfajores testnet faucet [here](https://celo.org/developers/faucet).
-
-## Develop
-
-1. Write your contracts in `./contracts`.
-2. Update contract deployment scripts in `./deploy`.
-3. Deploy contracts with `yarn deploy` from the **root directory**. 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
-
-```bash
-npx hardhat deploy --network [network name]
-```
-
-Network configs are defined in `hardhat.config.js`.
-
-## [Celo devchain](https://github.com/terminal-fi/celo-devchain)
-
-Run a local development Celo chain with `yarn devchain` in the `packages/hardhat` folder. You can print the addresses of the [Celo protocol contracts](https://github.com/celo-org/celo-monorepo/tree/master/packages/protocol) 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
-
-```bash
-npx celo-devchain --port 8545
-```
-
-or
-
-```bash
-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`.
-
-```bash
-npx hardhat typechain
-```
-
-Read more about Typechain [here](https://github.com/dethcrypto/TypeChain) and more about the hardhat plugin [here](https://github.com/dethcrypto/TypeChain/tree/master/packages/hardhat).
-
-### Run sanity tests and print all core contract addresses
-
-```bash
-npx @terminal-fi/celo-devchain --test
-```
-
-## Fork mainnet with [Ganache](https://trufflesuite.com/blog/introducing-ganache-7/index.html#1-zero-config-mainnet-forking)
-
-You can get a local copy of mainnet by forking with Ganache. Learn more about [forking mainnet with Ganache here.](https://trufflesuite.com/blog/introducing-ganache-7/index.html#1-zero-config-mainnet-forking)
-
-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. :shrug: The private keys of the associated test accounts are printed in `account_keys.json`.
-
-## Celo Core Contracts
-
-You can easily import Celo Core contracts to be used by your contracts like so:
-
-```solidity
-import '@celo/contracts/common/Accounts.sol';
-```
-
-## Verify your contracts
-
-### hardhat-celo
-
-You can easily verify your contracts deployed to the associated networks with hardhat-celo.
-
-[Reference](https://docs.celo.org/developer/verify/hardhat)
-
-```bash
-npx hardhat verify smart-contract-address parameter(s) --network alfajores
-```
-
-On Mainnet:
+For Alfajores (Testnet) Verification
 
 ```bash
-npx hardhat verify smart-contract-address parameter(s) --network celo
+npx hardhat verify [CONTRACT_ADDRESS] [...CONSTRUCTOR_ARGS] --network alfajores
 ```
 
-### Sourcify
-
-Additionally, you can easily verify your contracts deployed to the associated networks with the following commands.
-
-[Reference](https://docs.celo.org/blog/hardhat-deploy-verify)
-
-On Alfajores:
+For Mainnet Verification
 
 ```bash
-npx hardhat --network alfajores sourcify
+npx hardhat verify [CONTRACT_ADDRESS] [...CONSTRUCTOR_ARGS] --network celo
 ```
 
-On Mainnet:
-
-```bash
-npx hardhat --network celo sourcify
-```
+Check the file `hardhat.config.js` for Celo specific hardhat configuration.