Add scripts to deploy, upgrade and interact with EthErc20FastBridge (…

…#28)

* Add scripts to deploy, upgrade and interact with EthErc20FastBridge.
* Update README.

---------

Co-authored-by: Karim <[email protected]>
Co-authored-by: Olga Kunyavskaya <[email protected]>
Co-authored-by: Kirill <[email protected]>

README.md

@@ -23,3 +23,111 @@ Described in the corresponding [README](eth/README.md)
 
 ### Near
 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.
+1. First copy content of `.env.example` file
+2. Create a new file in `spectere-bridge-protocol` 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`**
+
+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`
+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`
+
+### Deploy and verify
+Running this script will first deploy and then verify bridge.
+To execute this script => run command `yarn run deploy:verify:bridge -- <network-name>`
+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 execute this script => run command `yarn run upgrade:bridge -- <network-name>`
+example : to upgrade on goerli run command `yarn run deploy:verify:bridge -- goerli`
+
+### Whitelisting
+To interact with EthErc20FastBridge whitelisting methods use methods defined in spectre-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.
+
+* To whitelist one token import and use method `addTokenToWhitelist` from above mentioned file with a token address and a signer with `WHITELISTING_TOKENS_ADMIN_ROLE` as parameters.
+
+* To remove one token from whitelist use method `removeTokenFromWhitelist` from above mentioned file with tokens address and signer with `WHITELISTING_TOKENS_ADMIN_ROLE` as parameters.
+
+* To check whether a token is whitelisted or not import and use method `isTokenInWhitelist` from above mentioned file with tokens address and signer with `WHITELISTING_TOKENS_ADMIN_ROLE` as parameters.  
+
+example : If you want whitelist whitelist one token, script would like,
+```
+const { ethers } = require("hardhat");
+const { addTokenToWhitelist } = require("./whitelistTokens");
+
+const WETH = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2";
+
+async function main() {
+    const [signer] = await ethers.getSigners(); // signer must have WHITELISTING_TOKENS_ADMIN_ROLE
+    await addTokenToWhitelist(WETH, signer);
+}
+
+main().catch((error) => {
+    console.error(error);
+    process.exitCode = 1;
+});
+```
+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 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`
+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
+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`)
+
+### 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
+
+ {
+    "signature": "setWhitelistedTokens(address[],bool[])",
+    "argcount": "2",
+    "arguments": {
+        "arg1": [
+            "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+            "0xB8c77482e45F1F44dE1745F52C74426C631bDD52",
+            "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
+        ],
+        "arg2": [
+            true,
+            true,
+            true
+        ]
+    }
+}
+
+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]}}'`

eth/.env.example

@@ -14,4 +14,6 @@ ETHERSCAN_API_KEY =
 ETHERSCAN_URL = 
 
 REPORT_GAS = 
-GAS_REPORT_TO_FILE = 
+GAS_REPORT_TO_FILE = 
+
+BRIDGE_PROXY_ADDRESS =

eth/hardhat.config.js

@@ -1,18 +1,20 @@
 require("dotenv").config();
-
 require("@nomicfoundation/hardhat-toolbox");
-
 require("@nomicfoundation/hardhat-chai-matchers");
 require("@nomiclabs/hardhat-ethers");
 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");
 require('hardhat-storage-layout');
 
+
 const PRIVATE_KEYS = process.env.PRIVATE_KEYS ? process.env.PRIVATE_KEYS.split(",") : [];
-const PRIVATE_KEY = process.env.PRIVATE_KEY || '11'.repeat(32);
+const PRIVATE_KEY = process.env.PRIVATE_KEY || "11".repeat(32);
 
 const ALCHEMY_API_KEY = process.env.ALCHEMY_API_KEY;
 const INFURA_API_KEY = process.env.INFURA_API_KEY;
@@ -21,6 +23,35 @@ const FORKING = true;
 const ENABLED_OPTIMIZER = true;
 const OPTIMIZER_RUNS = 200;
 
+task("method", "Execute Fastbridge methods")
+    .addParam("jsonstring", "JSON string with function signature and arguments")
+    .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 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);
+        // Send the transaction
+        const txdata = iface.encodeFunctionData(functionSignature, functionArguments);
+        const tx = await signer.sendTransaction({
+            to: bridgeAddress,
+            data: txdata,
+            gasLimit: 999999
+        });
+        console.log(tx);
+        await tx.wait();
+
+        console.log("Transaction mined!");
+    });
+
 module.exports = {
     solidity: {
         version: "0.8.11",

eth/package.json

@@ -15,7 +15,9 @@
         "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:bridge": "npm run compile-all && npx hardhat run scripts/deployment/deploy-bridge.js --network goerli",
+        "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",
+        "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",
         "docgen": "npx shx rm -rf docs && npx solidity-docgen --solc-module solc -t docgen -H docgen/helpers.js -o docs/",
@@ -48,7 +50,8 @@
         "@nomicfoundation/hardhat-network-helpers": "^1.0.7",
         "@nomiclabs/hardhat-ethers": "^2.2.1",
         "@openzeppelin/contracts": "4.8.0",
-        "@openzeppelin/contracts-upgradeable": "^4.8.0"
+        "@openzeppelin/contracts-upgradeable": "^4.8.0",
+        "@openzeppelin/upgrades-core": "^1.20.6"
     },
     "devDependencies": {
         "@commitlint/cli": "^17.3.0",

eth/scripts/EthErc20FastBridge/deploy_and_verify_bridge.js

@@ -0,0 +1,36 @@
+const { ethers, upgrades } = require("hardhat");
+const { getAddressSaver, verify } = require("../deployment/utilities/helpers");
+const { getImplementationAddress } = require("@openzeppelin/upgrades-core");
+const path = require("path");
+
+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
+
+    // verify
+    console.log("Verifing Contract");
+    await verify(Bridge.address, [tokensAddresses, whitelistedTokens]);
+    console.log("Verified.");
+};
+
+main().catch((error) => {
+    console.error(error);
+    process.exitCode = 1;
+});