hardhat script and readme improvements

README.md

@@ -28,19 +28,19 @@ Described in the corresponding [README](near/README.md)
 ## EthErc20Bridge scripts
 Below given command will help user to deploy and interact with contracts on the network provided as arg to below command, if no arg is provided it will use default network from hardhat-config.
 
-First set up your `.env` file in `spectere-bridge-protocol/.env`, for help `.env.example` is provided in `spectere-bridge-protocol` directory.
+First set up your `.env` file in `fast-bridge-protocol/eth/.env`, for help `.env.example` is provided in `fast-bridge-protocol/eth` directory.
 1. First copy content of `.env.example` file
-2. Create a new file in `spectere-bridge-protocol` directory and name it `.env`
+2. Create a new file in `fast-bridge-protocol/eth` directory and name it `.env`
 3. Paste copied content in `.env` file 
 4. Fill up details as required as per used in `hardhat.config.json` file.
 
-Then, to run below scripts go to `spectere-bridge-protocol/eth` directory, i.e. **run command `cd eth`**
+Then, to run below scripts go to `fast-bridge-protocol/eth` directory, i.e. **run command `cd eth`**
 
 example : to deploy EthErc20FastBridge on <network-name> network (network-name must be defined in hardhat-config.json's networks)
 `npm run deploy:bridge -- <network-name>`
 
 ### Deployment script
-Running ths script will deploy bridge proxy and store proxy and implementation address in `spectre-bridge-protocol/eth/scripts/deployment/deploymentAddresses.json`
+Running this script will deploy the bridge proxy and store the proxy and implementation address in `fast-bridge-protocol/eth/scripts/deployment/deploymentAddresses.json`
 To execute this script => run command `yarn run deploy:bridge -- <network-name>`
 example : to deploy bridge on goerli run command `yarn run deploy:bridge -- goerli`
 
@@ -50,14 +50,14 @@ To execute this script => run command `yarn run deploy:verify:bridge -- <network
 example : to deploy and verify bridge on goerli run command `yarn run deploy:verify:bridge -- goerli`
 
 ### Upgrade script 
-To upgrade bridge contract(using hardhat's upgrades plugin), use `spectre-bridge-protocol/eth/scripts/EthErc20FastBridge/upgrade_bridge.js` script.
-<!-- Before upgrading, go to file `spectre-bridge-protocol/eth/scripts/EthErc20FastBridge/upgrade_bridge.js` and update current bridge proxy address at line 7. -->
+To upgrade bridge contract(using hardhat's upgrades plugin), use `fast-bridge-protocol/eth/scripts/EthErc20FastBridge/upgrade_bridge.js` script.
+<!-- Before upgrading, go to file `fast-bridge-protocol/eth/scripts/EthErc20FastBridge/upgrade_bridge.js` and update current bridge proxy address at line 7. -->
 
 To execute this script => run command `yarn run upgrade:bridge -- <network-name>`
-example : to upgrade on goerli run command `yarn run deploy:verify:bridge -- goerli`
+example : to upgrade on goerli run command `yarn run upgrade:bridge -- goerli`
 
 ### Whitelisting
-To interact with EthErc20FastBridge whitelisting methods use methods defined in spectre-bridge-protocol/eth/scripts/EthErc20FastBridge/whitelistTokens.js
+To interact with EthErc20FastBridge whitelisting methods use methods defined in fast-bridge-protocol/eth/scripts/EthErc20FastBridge/whitelistTokens.js
 
 * To bulk update whitelist status of tokens import and use method `bulkWhitelistStatusUpdate` from above mentioned file with an array of token addresses, an array of their corresponding status and a signer with `WHITELISTING_TOKENS_ADMIN_ROLE` as parameters.
 
@@ -87,32 +87,31 @@ main().catch((error) => {
 And to run above script run `npx hardhat run <path_to_script/script.js> --` from eth folder.
 
 ### Pause/Unpause transfers
-To interact with EthErc20FastBridge pause and unpause methods use methods defined in spectre-bridge-protocol/eth/scripts/EthErc20FastBridge/pause_unPause.js
+To interact with EthErc20FastBridge pause and unpause methods use methods defined in fast-bridge-protocol/eth/scripts/EthErc20FastBridge/pause_unPause.js
 
 * To pause transfers import and use `pauseTransfer` method from above mentioned file with a signer with `PAUSABLE_ADMIN_ROLE` as parameter. 
 
 * To unpause transfers import and use `unpauseTransfer` method from above mentioned file with a signer with `UNPAUSABLE_ADMIN_ROLE` as parameter. 
 
 These methods can be used in similar to above example
 
-### To interact with above methods use script `spectre-bridge-protocol/eth/scripts/EthErc20FastBridge/interact_with_bridge.js`
+### To interact with above methods use script `fast-bridge-protocol/eth/scripts/EthErc20FastBridge/interact_with_bridge.js`
 Follow below steps to execute script and start interacting
 1. First, create your `.env` file(mentioned in `EthErc20Bridge scripts` section's starting)
-2. Go to `spectre-bridge-protocol/eth` directory in terminal
+2. Go to `fast-bridge-protocol/eth` directory in terminal
 3. Run command `npm run interact:bridge -- <network_name_as_defined_in_hardhat_config>` 
 4. Follow guide in terminal
-Note: bridge address will be picked from `deploymentAddress[network].new.bridge` (from `spectre-bridge-protocol/eth/scripts/deployment/deploymentAddresses.json`)
+Note: bridge address will be picked from `deploymentAddress[network].new.bridge` (from `fast-bridge-protocol/eth/scripts/deployment/deploymentAddresses.json`)
 
 ### To interact with FastBridge using hardhat task
 To call any method of EthErc20FastBridge use hardhat task `method` 
 Run command `npx hardhat method --jsonstring <json_string_input>`
 ```
 to create `json_string_input`
-1. create json with `signature` and `arguments` properties in below example format
+1. create json with `methodName` and `arguments` properties in below example format
 
  {
-    "signature": "setWhitelistedTokens(address[],bool[])",
-    "argcount": "2",
+    "methodName": "setWhitelistedTokens",
     "arguments": {
         "arg1": [
             "0xdAC17F958D2ee523a2206206994597C13D831ec7",
@@ -130,4 +129,4 @@ to create `json_string_input`
 2. pass below json to JSON.stringify() and use output as `json_string_input`
 
 ```
-example: to call `setWhitelistedTokens` method run command `npx hardhat method --jsonstring '{"signature":"setWhitelistedTokens","arguments":{"arg1":["0xdAC17F958D2ee523a2206206994597C13D831ec7"],"arg2":[true]}}'`
+example: to call `setWhitelistedTokens` method run command `npx hardhat method --jsonstring '{"methodName":"setWhitelistedTokens","arguments":{"arg1":["0xdAC17F958D2ee523a2206206994597C13D831ec7"],"arg2":[true]}}'`

eth/.env.example

@@ -9,6 +9,7 @@ RINKEBY_URL =
 ROPSTEN_URL = 
 KOVAN_URL = 
 FORKING_URL = 
+TASK_RPC_URL =
 
 ETHERSCAN_API_KEY = 
 ETHERSCAN_URL = 

eth/hardhat.config.js

@@ -6,7 +6,6 @@ require("@nomicfoundation/hardhat-network-helpers");
 require("hardhat-contract-sizer");
 require("hardhat-abi-exporter");
 require("@openzeppelin/hardhat-upgrades");
-const { ethers } = require("ethers");
 const { task } = require("hardhat/config");
 const deploymentAddress = require("./scripts/deployment/deploymentAddresses.json");
 const bridgeArtifacts = require("./artifacts/contracts/EthErc20FastBridge.sol/EthErc20FastBridge.json");
@@ -28,23 +27,23 @@ task("method", "Execute Fastbridge methods")
     .setAction(async (taskArgs) => {
         const network = (await ethers.getDefaultProvider().getNetwork()).name;
         const bridgeAddress = deploymentAddress[network].new.bridge;
-        const provider = new ethers.providers.JsonRpcProvider(process.env.RPC_TASK);
+        const provider = new ethers.providers.JsonRpcProvider(process.env.TASK_RPC_URL);
         const signer = new ethers.Wallet(process.env.PRIVATE_KEY, provider);
 
         const jsonString = taskArgs.jsonstring;
         const json = JSON.parse(jsonString);
         const arg = json.arguments;
-        const functionSignature = json.signature;
-        console.log(arg);
-        const functionArguments = Object.values(arg);
-        console.log(functionSignature, functionArguments);
-        const iface = new ethers.utils.Interface(bridgeArtifacts.abi);
+        const methodName = json.methodName;
+        const gasLimit = json.gasLimit;
+        const methodArguments = Object.values(arg);
+        console.log(`calling method ${methodName} with arguments ${methodArguments}`);
+        const contractInterface = new ethers.utils.Interface(bridgeArtifacts.abi);
         // Send the transaction
-        const txdata = iface.encodeFunctionData(functionSignature, functionArguments);
+        const txdata = contractInterface.encodeFunctionData(methodName, methodArguments);
         const tx = await signer.sendTransaction({
             to: bridgeAddress,
             data: txdata,
-            gasLimit: 999999
+            gasLimit: gasLimit
         });
         console.log(tx);
         await tx.wait();

eth/package.json

@@ -13,10 +13,11 @@
         "test:mainnet-fork": "npx hardhat test --network hardhat",
         "node": "npx hardhat node",
         "dev:size-contracts": "npm run compile-all && npx hardhat size-contracts",
-        "deploy:all": "npx hardhat run scripts/deployment/",
-        "deploy:test-tokens": "npm run compile-all && npx hardhat run scripts/deployment/deploy-test-tokens.js --network goerli",
+        "deploy:all": "npx hardhat run scripts/deployment/deploy_testnet_bridge_with_test_tokens.js --network",
+        "deploy:test-tokens": "npm run compile-all && npx hardhat run scripts/deployment/deploy-test-tokens.js --network",
         "deploy:bridge": "npm run compile-all && npx hardhat run scripts/deployment/deploy-bridge.js --network ",
         "deploy:verify:bridge": "npm run compile-all && npx hardhat run scripts/EthErc20FastBridge/deploy_and_verify_bridge.js --network",
+        "verify:bridge": "npm run compile-all && npx hardhat run scripts/EthErc20FastBridge/verify.js --network",
         "upgrade:bridge": "npm run compile-all && npx hardhat run scripts/EthErc20FastBridge/upgrade_bridge.js --network ",
         "dev:abi": "npx hardhat clear-abi && npx hardhat export-abi",
         "dev:coverage": "npx hardhat coverage",
@@ -72,6 +73,7 @@
         "mocha": "^10.2.0",
         "prettier": "^2.8.1",
         "prettier-plugin-solidity": "^1.1.0",
+        "prompt-sync": "^4.2.0",
         "shx": "^0.3.4",
         "solc": "0.8.17",
         "solhint": "^3.3.7",

eth/scripts/EthErc20FastBridge/deploy_and_verify_bridge.js

@@ -1,33 +1,10 @@
-const { ethers, upgrades } = require("hardhat");
-const { getAddressSaver, verify } = require("../deployment/utilities/helpers");
-const { getImplementationAddress } = require("@openzeppelin/upgrades-core");
-const path = require("path");
+const { deployBridge } = require("../deployment/deploy-bridge");
+const { verifyBridge } = require("./verify");
 
 const main = async () => {
-    const [deployer] = await ethers.getSigners();
-    const network = (await ethers.getDefaultProvider().getNetwork()).name;
-    const addressesPath = path.join(__dirname, "../deployment/deploymentAddresses.json");
-    const saveAddress = getAddressSaver(addressesPath, network, true);
-
-    const tokensAddresses = Object.values(require("../deployment/deploymentAddresses.json").tokens);
-    const whitelistedTokens = Object.values(require("../deployment/deploymentAddresses.json").whitelisted_tokens);
-
-    const bridge = await ethers.getContractFactory("EthErc20FastBridge", deployer);
-    const Bridge = await upgrades.deployProxy(bridge, [tokensAddresses, whitelistedTokens], {
-        unsafeAllow: ["delegatecall"]
-    });
-    await Bridge.deployed();
-
-    saveAddress("bridge_proxy", Bridge.address); // save bridge address
-
-    const currentImplAddress = await getImplementationAddress(ethers.provider, Bridge.address);
-
-    saveAddress("bridge_Implementation", currentImplAddress); // save implementation address
-
+    await deployBridge();
     // verify
-    console.log("Verifing Contract");
-    await verify(Bridge.address, [tokensAddresses, whitelistedTokens]);
-    console.log("Verified.");
+    await verifyBridge();
 };
 
 main().catch((error) => {

eth/scripts/EthErc20FastBridge/interact_with_bridge.js

@@ -4,9 +4,9 @@ const {
     addTokenToWhitelist,
     removeTokenFromWhitelist,
     isTokenInWhitelist
-} = require("./whitelistTokens");
+} = require("./whitelist_tokens");
 const { pauseTransfer, unpauseTransfer } = require("./pause_unpause");
-const { withdrawStuckTokens } = require("./withdraw_Stuck_tokens");
+const { withdrawStuckTokens } = require("./withdraw_stuck_tokens");
 const prompt = require("prompt-sync")();
 
 async function main() {

eth/scripts/EthErc20FastBridge/pause_unpause.js

@@ -1,4 +1,4 @@
-const { getBridgeContract } = require("./whitelistTokens");
+const { getBridgeContract } = require("../utilities/helpers");
 
 async function pauseTransfer(signer) {
     let bridge;

eth/scripts/EthErc20FastBridge/verify.js

@@ -0,0 +1,18 @@
+const { verify } = require("../utilities/helpers");
+
+const main = async () => {
+    const tokensAddresses = Object.values(require("../deployment/deploymentAddresses.json").tokens);
+    const whitelistedTokens = Object.values(require("../deployment/deploymentAddresses.json").whitelisted_tokens);
+    const network = (await ethers.getDefaultProvider().getNetwork());
+    const bridgeAddress = require("../deployment/deploymentAddresses.json")[network.name].new.bridge;
+
+    console.log("Verifing Contract");
+    await verify(bridgeAddress, [tokensAddresses, whitelistedTokens]);
+}
+
+main().catch((error) => {
+    console.error(error);
+    process.exitCode = 1;
+});
+
+exports.verifyBridge = main

eth/scripts/EthErc20FastBridge/whitelistTokens.js → eth/scripts/EthErc20FastBridge/whitelist_tokens.js

@@ -1,14 +1,5 @@
 const { ethers } = require("hardhat");
-const deploymentAddress = require("../deployment/deploymentAddresses.json");
-
-async function getBridgeContract() {
-    console.log("Connecting with bridge...");
-    const network = (await ethers.getDefaultProvider().getNetwork()).name;
-    const bridgeAddress = deploymentAddress[network].new.bridge_proxy;
-    const bridge = ethers.getContractAt("/contracts/EthErc20FastBridge.sol:EthErc20FastBridge", bridgeAddress);
-    console.log("Connected !");
-    return bridge;
-}
+const { getBridgeContract } = require("../utilities/helpers.js")
 
 async function bulkWhitelistStatusUpdate(tokensArray, statusArray, signer) {
     let bridge;

eth/scripts/EthErc20FastBridge/withdraw_Stuck_tokens.js

@@ -1,9 +1,9 @@
-const { getBridge } = require("./whitelistTokens");
+const { getBridgeContract } = require("../utilities/helpers");
 
 async function withdrawStuckTokens(signer) {
     let bridge;
     try {
-        bridge = await getBridge();
+        bridge = await getBridgeContract();
         await bridge.connect(signer).withdrawStuckTokens();
     } catch (error) {
         console.log("Failed to withdraw", error);

eth/scripts/deployment/deploy-bridge.js

@@ -1,13 +1,13 @@
 const { ethers, upgrades } = require("hardhat");
-const { verify, getAddressSaver } = require("./utilities/helpers");
+const { getAddressSaver } = require("../utilities/helpers");
+const { getImplementationAddress } = require("@openzeppelin/upgrades-core");
 const path = require("path");
 
 async function main() {
     const [deployer] = await ethers.getSigners();
     const network = (await ethers.getDefaultProvider().getNetwork()).name;
     const addressesPath = path.join(__dirname, "./deploymentAddresses.json");
     const saveAddress = getAddressSaver(addressesPath, network, true);
-
     const tokensAddresses = Object.values(require("./deploymentAddresses.json").tokens);
     const whitelistedTokens = Object.values(require("./deploymentAddresses.json").whitelisted_tokens);
     const bridge = (await ethers.getContractFactory("EthErc20FastBridge")).connect(deployer);
@@ -17,10 +17,17 @@ async function main() {
     await proxy.deployed();
 
     saveAddress("bridge", proxy.address);
+
+    const currentImplAddress = await getImplementationAddress(ethers.provider, proxy.address);
+
+    saveAddress("bridge_implementation", currentImplAddress); // save implementation address
+
     console.log("Deployment is completed.");
 }
 
 main().catch((error) => {
     console.error(error);
     process.exitCode = 1;
 });
+
+exports.deployBridge = main

eth/scripts/deployment/deploy-test-tokens.js

@@ -1,5 +1,5 @@
 const { ethers, upgrades } = require("hardhat");
-const { verify, getAddressSaver } = require("./utilities/helpers");
+const { getAddressSaver } = require("../utilities/helpers");
 const path = require("path");
 const { test } = require("mocha");
 
@@ -31,3 +31,5 @@ main().catch((error) => {
     console.error(error);
     process.exitCode = 1;
 });
+
+exports.deployTestToken = main

eth/scripts/deployment/deploy_testnet_bridge_with_test_tokens.js

@@ -0,0 +1,20 @@
+const { ethers } = require("hardhat");
+const {deployBridge} = require("./deploy-bridge");
+const {deployTestToken} = require("./deploy-test-tokens");
+
+const main = async () => {
+    const chainID = (await ethers.provider.getNetwork()).chainId;
+    if (chainID == 1){
+        console.log("deploying test tokens only available for testnets!!!");
+        return;
+    }
+    console.log("deploying test tokens");
+    await deployTestToken();
+    console.log("deploying bridge with tokens whitelisted");
+    await deployBridge();
+}
+
+main().catch((error) => {
+    console.error(error);
+    process.exitCode = 1;
+});

eth/scripts/deployment/utilities/helpers.js → eth/scripts/utilities/helpers.js

@@ -1,6 +1,7 @@
 const hre = require("hardhat");
 const fs = require("fs");
 const { ethers } = hre;
+const deploymentAddress = require("../deployment/deploymentAddresses.json");
 
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
@@ -10,18 +11,15 @@ async function verify(address, args) {
     if (hre.network.name !== "hardhat" && hre.network.name !== "localhost") {
         let retry = 20;
         console.log("Sleeping before verification...");
-        while ((await ethers.provider.getCode(address).catch(() => "")).length <= 3 && retry >= 0) {
+        while ((await ethers.provider.getCode(address).catch((err) => console.log("err", err))).length <= 3 && retry >= 0) {
             await sleep(5000);
             --retry;
         }
-        await sleep(30000);
-
-        console.log(address, args);
+        console.log(address);
 
         await hre
             .run("verify:verify", {
                 address,
-                constructorArguments: args
             })
             .catch(() => console.log("Verification failed"));
     }
@@ -51,6 +49,16 @@ function getAddressSaver(path, network, isLog) {
     return saveAddress;
 }
 
+async function getBridgeContract() {
+    console.log("Connecting with bridge...");
+    const network = (await ethers.getDefaultProvider().getNetwork()).name;
+    const bridgeAddress = deploymentAddress[network].new.bridge;
+    const bridge = await ethers.getContractAt("/contracts/EthErc20FastBridge.sol:EthErc20FastBridge", bridgeAddress);
+    console.log("Connected!");
+    return bridge;
+}
+
 exports.sleep = sleep;
 exports.verify = verify;
 exports.getAddressSaver = getAddressSaver;
+exports.getBridgeContract = getBridgeContract;