Merge pull request #19 from marc-aurele-besner/dev

multiple changes

Author: marc-aurele-besner

README.md

@@ -1,7 +1,7 @@
 [![license](https://img.shields.io/github/license/jamesisaac/react-native-background-task.svg)](https://opensource.org/licenses/MIT)
 
 # 👷 hardhat-awesome-cli
- Hardhat made awesome with a flexible CLI to help run test, deploy and more.
+ Hardhat made awesome with a flexible CLI to help run tests, deploy and more.
 
 ## How to install this package
 ### 1. Install this package
@@ -37,33 +37,35 @@ cd hardhat-awesome-cli
 npm link
 ```
 
-in the hardhat project you want to use this plugin
+in the hardhat project, you want to use this plugin
 
 ```
 npm link hardhat-awesome-cli
 ```
 </details>
 
 ## CLI features
-- Run tests (Allow you yo run test on all files or specific files in test/)
-- Run scripts (Allow you yo run script on specific files in scripts/)
-- Select scripts and tests to run (Allow you to select a script to execure and all or one test to perform afterward)
+- Run tests (Allow you you to run tests on all files or specific files in test/)
+- Run scripts (Allow you you to run scripts on specific files in scripts/)
+- Select scripts and tests to run (Allow you to select a script to execute and all or one test to perform afterward)
 - Run coverage tests (Available only if solidity-coverage is installed and available as a task)
 - Setup chains, RPC and accounts 
     - Add/Remove chains from the chain selection
     - Set RPC Url, private key or mnemonic for all or one chain
-    - Add a custom chain to the current chain selection)
+    - Add a custom chain to the current chain selection (currently these custom chains are not getting injected into hardhat networks)
 - More settings
-    - Exclude test file from the tests selection list
-    - Exclude script file from the scripts selection list
+    - Exclude the test file from the tests selection list
+    - Exclude the script file from the scripts selection list
     - Install/Uninstall other Hardhat plugins (Still not very stable)
-- Create Mock contracts + (Deployment scripts and tests scripts (currently only for MockERC20))
+- Create Mock contracts + (Deployment scripts and tests scripts (Missing test for MockProxyAdmin and MockTransparentUpgradeableProxy))
     - MockERC20
     - MockERC721
     - MockERC1155
     - MockERC20Upgradeable
     - MockERC721Upgradeable
     - MockERC1155Upgradeable
+    - MockProxyAdmin
+    - MockTransparentUpgradeableProxy
 - Get account balance
 
 ### Current chain support
@@ -75,18 +77,24 @@ npm link hardhat-awesome-cli
 - Polygon - Mainnet (chainId 137)
 - Polygon - Mumbai (chainId 80001)
 
-In 'More settings' you can also add custom chain, or create a issue or pull request to add other chains.
+In 'More settings' you can also add a custom chain, create an issue or pull request to add other chains.
 
 ## Helper tools
 Tools that you can use in your scripts and tests to make your life easier
 
 ### Address Book
 
+Create (if it does not exist) contractsAddressDeployed.json and contractsAddressDeployedHistory.json to store all the contracts you deployed, with the name of the contract, the contract address, the network name, the deployer address and the deployment date. The first file (contractsAddressDeployed.json) stores only the last contract for a given contract name and network name, while the second file (contractsAddressDeployedHistory.json) keeps a log of all the contracts deployed.
+
+You can then retrieve your contract address in your tests scripts to run test on deployed contracts on live chains for example.
+
 Import:
-js```
+javascript
+```
 const { addressBook } = require('hardhat')
 ```
-typescript```
+typescript
+```
 import { addressBook } from 'hardhat'
 ```
 
@@ -99,41 +107,49 @@ addressBook.retrieveContract(contractName: string, deployedNetwork: string)
 
 Example:
 ```
-await addressBook.saveContract('MockERC20', MockERC20.address, 'ethereum', deployer.address)
+await addressBook.saveContract('MockERC20', mockERC20.address, 'ethereum', deployer.address)
 
 await addressBook.retrieveContract('MockERC20', 'ethereum')
 ```
 
 ## 💪 Done
 - Run test on all or single test file (from all your file in test/)
 - Run scripts  on all or single scripts file (from all your file in scripts/)
+- Inject chain activated in settings, rpc and accounts in hardhat.config
 - Setup chains, RPC and accounts:
     - Activate/Disable chain to show on test/scripts options
     - Build .env file with rpc url and private key (or mnemonic)
     - Add ".env.hardhat-awesome-cli" to .gitignore amd .npmignore (create .gitignore if do detected)
 - More settings
     - Exclude files from, tests and scripts selection (useful for config and share helper file)
     - Add other hardhat plugins
-- Create Mock contracts (ERC20, ERC721, ERC1155 + Upgradeable version) + (Deployment scripts and tests scripts (currently only for MockERC20))
+- Create Mock contracts (ERC20, ERC721, ERC1155 + Upgradeable version, AdminProxy and TransparentUpgradeableProxy) 
     - Add @openzeppelin/contracts || @openzeppelin/contracts-upgradeable if not already installed
+    - Offer to create deployment scripts (use addressBook.saveContract() to save the deployed contract in contractsAddressDeployed.json and contractsAddressDeployedHistory.json)
+    - Offer to create test scripts
 - Tool to log all contracts deploy on each chain (1 unique contractName/chain + full log) and retrieve them (not tested yet)
     - hre.addressBook.{ saveContract, retrieveContract }
 
 
 ## 🏗️ To do:
 - Start working on documentation
-- Inject chain settings, rpc and accounts in hardhat.config
-- Create deployment and test scripts for all Mock contracts
 - Deployment contract generator
-- Make 'Run coverage tests' available only if task is exported by hardhat
+- Make 'Run coverage tests' available only if the task is exported by hardhat
+- Inject custom chain in hardhat networks
 - Setup chains, RPC and accounts:
-    - See list of .env config and chains setup in a table
+    - See the list of .env config and chains setup in a table
 - More Settings:
-    - Create github workflows file to run test and coverage test
+    - Create Github workflows file to run test and coverage test
     - Setup slack API or email report to receive a copy of test result and contracts list deployed
     - Add/Remove other hardhat plugins (need to add/remove in hardhat.config)
-        - Need to import plugin added in hardhat.config
-        - Need to list plugin installed to mark them as "check" in the plugin list
-        - Need to allow to remove plugin, uninstall package via npm/yarn and remove them in hardhat config
-    - Create custom command
-- Add option to create Admin Proxy and Transparent proxy w/ appropriate deployment scripts
+        - Need to import the plugin added in hardhat.config
+        - Need to list plugins installed to mark them as "check" in the plugin list
+        - Need to allow to remove a plugin, uninstall package via npm/yarn and remove them in hardhat config
+    - Create a custom command
+- Improve all the tests, to test transfer, mint, burn (all basic ERC20, ERC721, ERC1155 functions)
+- Add test for AdminProxy and TransparentUpgradeableProxy
+- Offer to rename the Mock contract and set all constructor input (or initialize input) via cli
+    - Verify that the input name does not conflict with inheritance
+    - Rename the Mock file, contract name, deployment script, test scripts (and the test values)
+- Add a flatten options (All contracts, or specific contracts) save in contractsFlatten/
+- Write some test on the package using mocha

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hardhat-awesome-cli",
-  "version": "1.0.7",
+  "version": "0.0.2",
   "description": "Hardhat made awesome with a flexible CLI to help run test, deploy and more.",
   "repository": "https://github.com/marc-aurele-besner/hardhat-awesome-cli.git",
   "author": "Marc-Aurele Besner <82244926+marc-aurele-besner@users.noreply.github.com>",

src/config.ts

@@ -5,45 +5,110 @@ export const DefaultChainList: IChain[] = [
         name: 'Hardhat local',
         chainName: 'hardhat',
         chainId: 31337,
-        gas: 'auto'
+        gas: 'auto',
+        currency: 'ETH'
     },
     {
         name: 'Ethereum - Mainnet',
         chainName: 'ethereum',
         chainId: 1,
-        gas: 'auto'
+        gas: 'auto',
+        currency: 'ETH',
+        defaultBlockExplorer: 'https://etherscan.io/'
     },
     {
         name: 'Ethereum - Ropstein',
         chainName: 'ropsten',
         chainId: 3,
-        gas: 'auto'
+        gas: 'auto',
+        currency: 'ETH',
+        defaultBlockExplorer: 'https://ropsten.etherscan.io/'
     },
     {
         name: 'Ethereum - Rinkeby',
         chainName: 'rinkeby',
         chainId: 4,
-        gas: 'auto'
+        gas: 'auto',
+        currency: 'ETH',
+        defaultBlockExplorer: 'https://rinkeby.etherscan.io/'
     },
     {
         name: 'Ethereum - Kovan',
         chainName: 'kovan',
         chainId: 42,
-        gas: 'auto'
+        gas: 'auto',
+        currency: 'ETH',
+        defaultBlockExplorer: 'https://kovan.etherscan.io/'
+    },
+    {
+        name: 'Ethereum - Goerli',
+        chainName: 'goerli',
+        chainId: 5,
+        gas: 'auto',
+        currency: 'ETH',
+        defaultBlockExplorer: 'https://goerli.etherscan.io/'
     },
     {
         name: 'Polygon - Mainnet',
         chainName: 'polygon',
         chainId: 137,
         gas: 'auto',
-        defaultRpcUrl: 'https://polygon-rpc.com'
+        currency: 'MATIC',
+        defaultRpcUrl: 'https://polygon-rpc.com',
+        defaultBlockExplorer: 'https://polygonscan.com/'
     },
     {
         name: 'Polygon - Mumbai',
         chainName: 'mumbai',
         chainId: 80001,
         gas: 'auto',
-        defaultRpcUrl: 'https://rpc-mumbai.maticvigil.com'
+        currency: 'MATIC',
+        defaultRpcUrl: 'https://rpc-mumbai.maticvigil.com',
+        defaultBlockExplorer: 'https://mumbai.polygonscan.com/'
+    },
+    {
+        name: 'Binance Smart Chain - Mainnet',
+        chainName: 'binance',
+        chainId: 56,
+        gas: 'auto',
+        currency: 'BNB',
+        defaultRpcUrl: 'https://bsc-dataseed.binance.org',
+        defaultBlockExplorer: 'https://bscscan.com'
+    },
+    {
+        name: 'Binance Smart Chain - Tesnet',
+        chainName: 'binanceTestnet',
+        chainId: 97,
+        gas: 'auto',
+        currency: 'BNB',
+        defaultRpcUrl: 'https://rpc-mainnet.matic.network',
+        defaultBlockExplorer: 'https://explorer.binance.org/smart-testnet'
+    },
+    {
+        name: 'Optimism - Mainnet',
+        chainName: 'optimism',
+        chainId: 10,
+        gas: 'auto',
+        currency: 'ETH',
+        defaultRpcUrl: 'https://mainnet.optimism.io',
+        defaultBlockExplorer: 'https://optimistic.etherscan.io/'
+    },
+    {
+        name: 'Optimism - Testnet Kovan',
+        chainName: 'optimismTestnetKovan',
+        chainId: 56,
+        gas: 'auto',
+        currency: 'ETH',
+        defaultRpcUrl: 'https://bsc-dataseed1.binance.org'
+    },
+    {
+        name: 'Avalanche - Mainnet',
+        chainName: 'optimismTestnetKovan',
+        chainId: 43114,
+        gas: 'auto',
+        currency: 'AVAX',
+        defaultRpcUrl: 'https://api.avax.network/ext/bc/C/rpc',
+        defaultBlockExplorer: 'https://snowtrace.io/'
     }
 ]
 

src/index.ts

@@ -2,13 +2,12 @@
 
 import { spawn } from 'child_process'
 import fs from 'fs'
-import { TASK_TEST_RUN_MOCHA_TESTS } from 'hardhat/builtin-tasks/task-names'
-import { extendConfig, extendEnvironment, subtask, task } from 'hardhat/config'
+import { extendConfig, extendEnvironment, task } from 'hardhat/config'
 import { lazyObject } from 'hardhat/plugins'
-import { HardhatConfig, HardhatUserConfig, HttpNetworkConfig } from 'hardhat/types'
+import { HardhatConfig, HardhatUserConfig, NetworksUserConfig } from 'hardhat/types'
 import inquirer from 'inquirer'
 import path from 'path'
-import { exit, hrtime } from 'process'
+import { exit } from 'process'
 
 import { AwesomeAddressBook } from './AwesomeAddressBook'
 import { DefaultChainList, DefaultHardhatPluginsList } from './config'
@@ -87,7 +86,7 @@ const buildFullChainList = async () => {
     return chainList
 }
 
-const buildActivatedChainNetworkConfig = async () => {
+const buildActivatedChainNetworkConfig = () => {
     let chainConfig: string = ''
     let fileSetting: any = []
     if (fs.existsSync(fileHardhatAwesomeCLI)) {
@@ -96,10 +95,10 @@ const buildActivatedChainNetworkConfig = async () => {
     }
     if (fileSetting && fileSetting.activatedChain) {
         if (fileSetting.activatedChain.length > 0) {
-            await fileSetting.activatedChain.forEach(async (chain: IChain) => {
-                const defaultRpcUrl = await getEnvValue('rpcUrl'.toUpperCase() + '_' + chain.chainName.toUpperCase())
-                const defaultPrivateKey = await getEnvValue('privateKey'.toUpperCase() + '_' + chain.chainName.toUpperCase())
-                const defaultMnemonic = await getEnvValue('mnemonic'.toUpperCase() + '_' + chain.chainName.toUpperCase())
+            fileSetting.activatedChain.forEach((chain: IChain) => {
+                const defaultRpcUrl = getEnvValue('rpcUrl'.toUpperCase() + '_' + chain.chainName.toUpperCase())
+                const defaultPrivateKey = getEnvValue('privateKey'.toUpperCase() + '_' + chain.chainName.toUpperCase())
+                const defaultMnemonic = getEnvValue('mnemonic'.toUpperCase() + '_' + chain.chainName.toUpperCase())
                 let buildAccounts = ''
                 if (defaultPrivateKey) {
                     buildAccounts = `"accounts": ["${defaultPrivateKey}"]`
@@ -171,7 +170,7 @@ const buildActivatedChainNetworkConfig = async () => {
                 }
                 return chainConfig
             })
-            await sleep(100)
+            // await sleep(100)
             const fihainConfig = `${chainConfig.slice(0, -1)}`
             return fihainConfig
         }
@@ -663,7 +662,7 @@ import '${packageName}'`
     }
 }
 
-const getEnvValue = async (envName: string) => {
+const getEnvValue = (envName: string) => {
     if (fs.existsSync(fileEnvHardhatAwesomeCLI)) {
         const allEnv = require('dotenv').config({ path: fileEnvHardhatAwesomeCLI })
         const oldEnv = Object.entries(allEnv.parsed)
@@ -1342,6 +1341,30 @@ extendConfig(async (config: HardhatConfig, userConfig: HardhatUserConfig) => {
         }
     }
     config.paths.cli = cli
+
+    const getNetworkConfig = buildActivatedChainNetworkConfig()
+    let buildNetworkConfig: any = {}
+    if (getNetworkConfig) {
+        buildNetworkConfig = `{
+                "networks": [
+                    {${getNetworkConfig}}
+                ]
+            }`
+        buildNetworkConfig = JSON.parse(buildNetworkConfig)
+    }
+    if (buildNetworkConfig.networks !== undefined) {
+        if (buildNetworkConfig.networks[0] !== undefined) {
+            if (buildNetworkConfig.networks[0].ethereum !== undefined) config.networks.ethereum = buildNetworkConfig.networks[0].ethereum
+            if (buildNetworkConfig.networks[0].ropsten !== undefined) config.networks.ropsten = buildNetworkConfig.networks[0].ropsten
+            if (buildNetworkConfig.networks[0].rinkeby !== undefined) config.networks.rinkeby = buildNetworkConfig.networks[0].rinkeby
+            if (buildNetworkConfig.networks[0].kovan !== undefined) config.networks.kovan = buildNetworkConfig.networks[0].kovan
+            if (buildNetworkConfig.networks[0].polygon !== undefined) config.networks.polygon = buildNetworkConfig.networks[0].polygon
+            if (buildNetworkConfig.networks[0].mumbai !== undefined) config.networks.mumbai = buildNetworkConfig.networks[0].mumbai
+            if (buildNetworkConfig.networks[0].optimism !== undefined) config.networks.optimism = buildNetworkConfig.networks[0].optimism
+            if (buildNetworkConfig.networks[0].optimismTestnetKovan !== undefined)
+                config.networks.optimismTestnetKovan = buildNetworkConfig.networks[0].optimismTestnetKovan
+        }
+    }
 })
 
 extendEnvironment(async (hre: any) => {

src/mockContracts/MockERC1155.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.13;
+pragma solidity ^0.8.0;
 
 /**
  * @title MockERC1155
@@ -8,9 +8,20 @@ pragma solidity ^0.8.13;
 import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";
 
 contract MockERC1155 is ERC1155 {
+    
+    string internal _name = "MockERC1155";
+    string internal _symbol = "MOCK";
     constructor () ERC1155("https://google.com") {
 
     }
+
+    function name() public view returns (string memory) {
+        return _name;
+    }
+
+    function symbol() public view returns (string memory) {
+        return _symbol;
+    }
 
     function mint(address _to, uint256 _tokenId, uint256 _amount) public {
         require(_to != address(0));
@@ -22,6 +33,4 @@ contract MockERC1155 is ERC1155 {
     function burn(uint256 _tokenId, uint256 _amount) public {
         _burn(_msgSender(), _tokenId, _amount);
     }
-    
-    uint256[50] private __gap;
 }