chore: gateways deployment to ArbitrumGoerli and Chiado

Author: jaybuidl

contracts/README.md

@@ -82,6 +82,7 @@ The ones below are optional:
 
 - `ETHERSCAN_API_KEY`: to verify the source of the newly deployed contracts on **Etherscan**.
 - `ARBISCAN_API_KEY`: to verify the source of the newly deployed contracts on **Arbitrum**.
+- `GNOSISSCAN_API_KEY`: to verify the source of the newly deployed contracts on **Gnosis chain**.
 
 #### 1. Update the Constructor Parameters (optional)
 
@@ -100,20 +101,25 @@ yarn hardhat node --tags nothing
 **Shell 2: the deploy script**
 
 ```bash
-yarn deploy --network localhost --tags <Arbitration|VeaMock>
+yarn deploy --network localhost --tags <Arbitration|VeaMock|ForeignGatewayOnEthereum|HomeGateway>
 ```
 
 #### 3. Deploy to Public Testnets
 
 ```bash
+# ArbitrumGoerli to Chiado
+yarn deploy --network arbitrumGoerli --tags Arbitration
+yarn deploy --network chiado --tags ForeignGatewayOnGnosis
+yarn deploy --network chiado --tags KlerosLiquidOnGnosis
+yarn deploy --network arbitrumGoerli --tags HomeGatewayToGnosis
+
 # Goerli
 yarn deploy --network arbitrumGoerli --tags Arbitration
-yarn deploy --network goerli --tags ForeignGateway
-yarn deploy --network arbitrumGoerli --tags HomeGateway
+yarn deploy --network goerli --tags ForeignGatewayOnEthereum
+yarn deploy --network arbitrumGoerli --tags HomeGatewayToEthereum
 ```
 
-The deployed addresses should be output to the screen after the deployment is complete.
-If you miss that, you can always go to the `deployments/<network>` directory and look for the respective file.
+The deployed addresses should be displayed to the screen after the deployment is complete. If you missed them, you can always go to the `deployments/<network>` directory and look for the respective file.
 
 #### Running Test Fixtures
 
@@ -134,7 +140,7 @@ yarn test --network localhost
 This must be done for each network separately.
 
 ```bash
-yarn etherscan-verify --network <arbitrumGoerli|arbitrumRinkeby|arbitrum|goerli|rinkeby|mainnet>
+yarn etherscan-verify --network <arbitrumGoerli|arbitrum|chiado|gnosischain|goerli|mainnet>
 ```
 
 ## Ad-hoc procedures
@@ -153,7 +159,7 @@ done
 
 #### 2/ Import the data to V2 - Local Network
 
-:warning: This script populates only from `*.mainnet.json`, but not from `*.gnosischain.json` at this time.
+:warning: By default this script populates from `*.mainnet.json`. To populate from `*.gnosischain.json`, set the variable `USE_GNOSIS` to true inside [scripts/populateCourts.ts](scripts/populateCourts.ts).
 
 :warning: It is possible to switch to testnet-friendly court parameters by setting the variable `TESTING_PARAMETERS` to true inside [scripts/populateCourts.ts](scripts/populateCourts.ts).
 
@@ -177,6 +183,20 @@ yarn hardhat run scripts/populatePolicyRegistry.ts --network arbitrumGoerli
 yarn hardhat run scripts/populateCourts.ts --network arbitrumGoerli
 ```
 
+### Generate deployment artifacts for existing contracts
+
+#### Usage
+
+```bash
+scripts/generateDeploymentArtifact.sh <network> <address>
+```
+
+#### Example: WETH on Gnosis chain
+
+```bash
+scripts/generateDeploymentArtifact.sh gnosischain 0xf8d1677c8a0c961938bf2f9adc3f3cfda759a9d9 > deployments/gnosischain/WETH.json
+```
+
 ### Push the contracts to a Tenderly project
 
 Ensure that your `$TENDERLY_PROJECT` and `$TENDERLY_USERNAME` is set correctly in `.env`.

contracts/deploy/00-home-chain-arbitration.ts

@@ -111,7 +111,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   });
 };
 
-deployArbitration.tags = ["HomeChain", "Arbitration"];
+deployArbitration.tags = ["Arbitration"];
 deployArbitration.skip = async ({ getChainId }) => {
   const chainId = Number(await getChainId());
   return !HomeChains[chainId];

contracts/deploy/00-rng.ts

@@ -63,7 +63,7 @@ const deployArbitration: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   await disputeKit.changeRandomNumberGenerator(rng.address, RNG_LOOKAHEAD);
 };
 
-deployArbitration.tags = ["HomeChain", "RNG"];
+deployArbitration.tags = ["RNG"];
 deployArbitration.skip = async ({ getChainId }) => {
   const chainId = Number(await getChainId());
   return !HomeChains[chainId];

contracts/deploy/01-foreign-gateway.ts …deploy/01-foreign-gateway-on-ethereum.tscontracts/deploy/01-foreign-gateway.ts renamed to contracts/deploy/01-foreign-gateway-on-ethereum.ts contracts/deploy/01-foreign-gateway.ts renamed to contracts/deploy/01-foreign-gateway-on-ethereum.ts

@@ -19,13 +19,14 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   console.log("deploying to chainId %s with deployer %s", chainId, deployer);
 
   const homeNetworks = {
-    1: config.networks.arbitrum,
-    5: config.networks.arbitrumGoerli,
+    ETHEREUM_MAINNET: config.networks.arbitrum,
+    ETHEREUM_GOERLI: config.networks.arbitrumGoerli,
+    HARDHAT: config.networks.localhost,
   };
 
   // Hack to predict the deployment address on the home chain.
   // TODO: use deterministic deployments
-  const homeChainProvider = new ethers.providers.JsonRpcProvider(homeNetworks[chainId].url);
+  const homeChainProvider = new ethers.providers.JsonRpcProvider(homeNetworks[ForeignChains[chainId]].url);
   let nonce = await homeChainProvider.getTransactionCount(deployer);
   nonce += 2; // HomeGatewayToEthereum deploy tx will the third tx after this on its home network, so we add two to the current nonce.
   const homeChainId = (await homeChainProvider.getNetwork()).chainId;
@@ -60,7 +61,7 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   });
 };
 
-deployForeignGateway.tags = ["ForeignChain", "ForeignGateway"];
+deployForeignGateway.tags = ["ForeignGatewayOnEthereum"];
 deployForeignGateway.skip = async ({ getChainId }) => {
   const chainId = Number(await getChainId());
   return !ForeignChains[chainId];

…acts/deploy/01-foreign-gateway-gnosis.ts …s/deploy/01-foreign-gateway-on-gnosis.tscontracts/deploy/01-foreign-gateway-gnosis.ts renamed to contracts/deploy/01-foreign-gateway-on-gnosis.ts contracts/deploy/01-foreign-gateway-gnosis.ts renamed to contracts/deploy/01-foreign-gateway-on-gnosis.ts

@@ -24,56 +24,67 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   console.log("deploying to chainId %s with deployer %s", chainId, deployer);
 
   const homeNetworks = {
-    1: config.networks.arbitrum,
-    5: config.networks.arbitrumGoerli,
+    GNOSIS_MAINNET: config.networks.arbitrum,
+    GNOSIS_CHIADO: config.networks.arbitrumGoerli,
+    HARDHAT: config.networks.localhost,
   };
 
   // Hack to predict the deployment address on the home chain.
   // TODO: use deterministic deployments
-  const homeChainProvider = new ethers.providers.JsonRpcProvider(homeNetworks[chainId].url);
+  const homeChainProvider = new ethers.providers.JsonRpcProvider(homeNetworks[ForeignChains[chainId]].url);
   let nonce = await homeChainProvider.getTransactionCount(deployer);
-  nonce += 2; // HomeGatewayToEthereum deploy tx will the third tx after this on its home network, so we add two to the current nonce.
-  const homeChainId = (await homeChainProvider.getNetwork()).chainId;
-  const homeChainIdAsBytes32 = hexZeroPad(hexlify(homeChainId), 32);
-  const homeGatewayAddress = getContractAddress(deployer, nonce);
+  const homeGatewayAddress = getContractAddress(deployer, nonce); // HomeGateway deploy tx will be the next tx home network
   console.log("calculated future HomeGatewayToEthereum address for nonce %d: %s", nonce, homeGatewayAddress);
 
   const veaReceiver = await deployments.get("FastBridgeReceiverOnGnosis");
+  console.log("using FastBridgeReceiverOnGnosis at %s", veaReceiver.address);
+
+  const ONE_GWEI = ethers.utils.parseUnits("1", "gwei");
 
   if (!wethByChain.get(chainId)) {
     const weth = await deploy("WETH", {
       from: deployer,
       log: true,
+      maxFeePerGas: ONE_GWEI,
+      maxPriorityFeePerGas: ONE_GWEI,
     });
 
     wethByChain.set(ForeignChains[ForeignChains[chainId]], weth.address);
 
     await deploy("WETHFaucet", {
       from: deployer,
       contract: "Faucet",
-      args: [weth],
+      args: [weth.address],
       log: true,
+      maxFeePerGas: ONE_GWEI,
+      maxPriorityFeePerGas: ONE_GWEI,
     });
   }
 
-  const foreignGateway = await deploy("xForeignGateway", {
+  const wethAddress = wethByChain.get(ForeignChains[ForeignChains[chainId]]);
+  const homeChainId = (await homeChainProvider.getNetwork()).chainId;
+  const homeChainIdAsBytes32 = hexZeroPad(hexlify(homeChainId), 32);
+
+  await deploy("ForeignGatewayOnGnosis", {
     from: deployer,
-    contract: "xForeignGateway",
-    args: [deployer, veaReceiver.address, homeGatewayAddress, homeChainIdAsBytes32, wethByChain[chainId]],
-    gasLimit: 4000000,
+    contract: "ForeignGatewayOnGnosis",
+    args: [deployer, veaReceiver.address, homeGatewayAddress, homeChainIdAsBytes32, wethAddress],
     log: true,
+    maxFeePerGas: ONE_GWEI,
+    maxPriorityFeePerGas: ONE_GWEI,
   });
 
-  await execute(
-    "xForeignGateway",
-    { from: deployer, log: true },
-    "changeCourtJurorFee",
-    0,
-    ethers.utils.parseEther("0.00001") // TODO: fix this from xKlerosLiquid xDAI -> ETH amount
-  );
+  // TODO: disable the gateway until fully initialized with the correct fees OR allow disputeCreators to add funds again if necessary.
+  // await execute(
+  //   "ForeignGatewayOnGnosis",
+  //   { from: deployer, log: true },
+  //   "changeCourtJurorFee",
+  //   0,
+  //   ethers.utils.parseEther("0.00001")
+  // );
 };
 
-deployForeignGateway.tags = ["ForeignChain", "ForeignGatewayOnGnosis"];
+deployForeignGateway.tags = ["ForeignGatewayOnGnosis"];
 deployForeignGateway.skip = async ({ getChainId }) => {
   const chainId = Number(await getChainId());
   return !ForeignChains[chainId];

contracts/deploy/02-home-gateway.ts …ts/deploy/02-home-gateway-to-ethereum.tscontracts/deploy/02-home-gateway.ts renamed to contracts/deploy/02-home-gateway-to-ethereum.ts contracts/deploy/02-home-gateway.ts renamed to contracts/deploy/02-home-gateway-to-ethereum.ts

@@ -18,11 +18,14 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   const chainId = Number(await getChainId());
   console.log("deploying to chainId %s with deployer %s", chainId, deployer);
 
-  const veaSender = await deployments.get("FastBridgeSender");
+  const veaSender = await deployments.get("FastBridgeSenderToEthereum");
   const klerosCore = await deployments.get("KlerosCore");
 
-  const foreignGateway = await hre.companionNetworks.foreign.deployments.get("ForeignGatewayOnEthereum");
-  const foreignChainId = Number(await hre.companionNetworks.foreign.getChainId());
+  const foreignGateway = await hre.companionNetworks.foreignGoerli.deployments.get("ForeignGatewayOnEthereum");
+  const foreignChainId = Number(await hre.companionNetworks.foreignGoerli.getChainId());
+  const foreignChainName = await hre.companionNetworks.foreignGoerli.deployments.getNetworkName();
+  console.log("Using ForeignGateway %s on chainId %s (%s)", foreignGateway.address, foreignChainId, foreignChainName);
+
   await deploy("HomeGatewayToEthereum", {
     from: deployer,
     contract: "HomeGateway",
@@ -31,7 +34,7 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   }); // nonce+0
 };
 
-deployHomeGateway.tags = ["HomeChain", "HomeGateway"];
+deployHomeGateway.tags = ["HomeGatewayToEthereum"];
 deployHomeGateway.skip = async ({ getChainId }) => {
   const chainId = Number(await getChainId());
   return !HomeChains[chainId];

contracts/deploy/02-home-gateway-to-gnosis.ts

@@ -0,0 +1,42 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+import { DeployFunction } from "hardhat-deploy/types";
+
+enum HomeChains {
+  ARBITRUM_ONE = 42161,
+  ARBITRUM_GOERLI = 421613,
+}
+
+// TODO: use deterministic deployments
+
+const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
+  const { deployments, getNamedAccounts, getChainId } = hre;
+  const { deploy } = deployments;
+
+  // fallback to hardhat node signers on local network
+  const deployer = (await getNamedAccounts()).deployer ?? (await hre.ethers.getSigners())[0].address;
+  const chainId = Number(await getChainId());
+  console.log("Deploying to chainId %s with deployer %s", chainId, deployer);
+
+  const veaSender = await deployments.get("FastBridgeSenderToGnosis");
+  const klerosCore = await deployments.get("KlerosCore");
+
+  const foreignGateway = await hre.companionNetworks.foreignChiado.deployments.get("ForeignGatewayOnGnosis");
+  const foreignChainId = Number(await hre.companionNetworks.foreignChiado.getChainId());
+  const foreignChainName = await hre.companionNetworks.foreignChiado.deployments.getNetworkName();
+  console.log("Using ForeignGateway %s on chainId %s (%s)", foreignGateway.address, foreignChainId, foreignChainName);
+
+  await deploy("HomeGatewayToGnosis", {
+    from: deployer,
+    contract: "HomeGateway",
+    args: [deployer, klerosCore.address, veaSender.address, foreignGateway.address, foreignChainId],
+    log: true,
+  }); // nonce+0
+};
+
+deployHomeGateway.tags = ["HomeGatewayToGnosis"];
+deployHomeGateway.skip = async ({ getChainId }) => {
+  const chainId = Number(await getChainId());
+  return !HomeChains[chainId];
+};
+
+export default deployHomeGateway;

contracts/deploy/03-vea-mock.ts

@@ -61,7 +61,7 @@ const deployHomeGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment)
   });
 };
 
-deployHomeGateway.tags = ["HomeChain", "VeaMock"];
+deployHomeGateway.tags = ["VeaMock"];
 deployHomeGateway.skip = async ({ getChainId }) => HARDHAT_NETWORK !== Number(await getChainId());
 
 export default deployHomeGateway;

contracts/deploy/04-klerosliquid-to-v2-gnosis.ts

@@ -25,7 +25,7 @@ const tokenBridgeByChain = new Map<ForeignChains, string>([
   [ForeignChains.GNOSIS_CHIADO, "0xbb3c86f9918C3C1d83668fA84e79E876d147fFf2"],
 ]);
 
-const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
+const deployKlerosLiquid: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { ethers, deployments, getNamedAccounts, getChainId, config } = hre;
   const { deploy, execute } = deployments;
   const { hexZeroPad, hexlify } = ethers.utils;
@@ -78,13 +78,13 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
     tokenBridge
   );
 
-  const xKlerosLiquidToV2 = await deploy("xKlerosLiquidToV2", {
+  const xKlerosLiquidV2 = await deploy("xKlerosLiquidV2", {
     from: deployer,
     log: true,
   });
 
   await execute(
-    "xKlerosLiquidToV2",
+    "xKlerosLiquidV2",
     { from: deployer, log: true },
     "initialize",
     deployer,
@@ -106,10 +106,10 @@ const deployForeignGateway: DeployFunction = async (hre: HardhatRuntimeEnvironme
   });
 };
 
-deployForeignGateway.tags = ["ForeignChain", "KlerosLiquidOnGnosis"];
-deployForeignGateway.skip = async ({ getChainId }) => {
+deployKlerosLiquid.tags = ["KlerosLiquidOnGnosis"];
+deployKlerosLiquid.skip = async ({ getChainId }) => {
   const chainId = Number(await getChainId());
   return !ForeignChains[chainId];
 };
 
-export default deployForeignGateway;
+export default deployKlerosLiquid;