feat(gateway): add deploy scripts

Author: shalzz

contracts/README.md

@@ -88,7 +88,5 @@ This must be done for each network separately.
 For `Mainnet` you can use the `etherscan-verify` command from `hardhat`:
 
 ```bash
-yarn hardhat --network mainnet etherscan-verify
+yarn hardhat --network <arbitrumRinkeby|arbitrum|rinkeby|mainnet> etherscan-verify
 ```
-
-For `Arbitrum` the process currently must be done manually through [Arbiscan](https://arbiscan.io/verifyContract).

contracts/deploy-helpers/getContractAddress.js

@@ -0,0 +1,14 @@
+const { BN, Address, toChecksumAddress } = require("ethereumjs-util");
+
+/**
+ * Gets the address of a soon to be deployed contract.
+ * @param {string} deployer The address of the deployer account.
+ * @param {number|BN} nonce The current nonce for the deployer account.
+ * @return {string} The address of a contract if it is deployed in the next transaction sent by the deployer account.
+ */
+function getContractAddress(deployer, nonce) {
+  const deployAddress = Address.generate(Address.fromString(deployer), new BN(String(nonce)));
+  return toChecksumAddress(deployAddress.toString());
+}
+
+module.exports = getContractAddress;

contracts/deploy/01-foreign-chain.ts

@@ -0,0 +1,65 @@
+import {parseEther} from 'ethers/lib/utils';
+
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DeployFunction} from 'hardhat-deploy/types';
+
+import getContractAddress from "../deploy-helpers/getContractAddress";
+
+const FOREIGN_CHAIN_IDS = [1, 4];
+const paramsByChainId = {
+  1: {
+    claimDeposit: parseEther('0.1'),
+    challengeDuration: 86400, // 1 day
+    homeChainId: 42161,
+  },
+  4: {
+    claimDeposit: parseEther('0.1'),
+    challengeDuration: 3600, // 1 hour
+    homeChainId: 421611,
+  },
+};
+
+const deployForeignGateway: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const {ethers, deployments, getNamedAccounts, getChainId, config} = hre;
+  const {deploy} = deployments;
+  const { providers, constants } = ethers;
+  const { hexZeroPad } = hre.ethers.utils;
+
+  const {deployer } = await getNamedAccounts();
+  const chainId = await getChainId();
+
+  const homeNetworks = {
+    1: config.networks.arbitrum,
+    4: config.networks.arbitrumRinkeby,
+  };
+  const { url } = homeNetworks[chainId];
+  const homeChainProvider = new providers.JsonRpcProvider(url);
+  const nonce = await homeChainProvider.getTransactionCount(deployer);
+
+  const { claimDeposit, challengeDuration, homeChainId} = paramsByChainId[chainId];
+
+  // home Gateway deploy tx will the third tx after this on it's network,
+  // so we add two to the current nonce.
+  const homeGatewayAddress = getContractAddress(deployer, nonce + 2);
+
+  const homeChainIdAsBytes32 = hexZeroPad(homeChainId, 32);
+  console.log(nonce + 2);
+  console.log(homeGatewayAddress);
+
+  let fastBridgeReceiver = await deploy('FastBridgeReceiver', {
+    from: deployer,
+    args: [deployer, claimDeposit, challengeDuration],
+    log: true,
+  });
+
+  let foreignGateway = await deploy('ForeignGateway', {
+    from: deployer,
+    args: [deployer, fastBridgeReceiver.address, ["1000", "10000"], homeGatewayAddress, homeChainIdAsBytes32],
+    log: true,
+  });
+};
+
+deployForeignGateway.tags = ["ForeignChain"];
+deployForeignGateway.skip = async ({ getChainId }) => !FOREIGN_CHAIN_IDS.includes(Number(await getChainId()));
+
+export default deployForeignGateway;

contracts/deploy/02-home-chain.ts

@@ -0,0 +1,73 @@
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+import {DeployFunction} from 'hardhat-deploy/types';
+
+import getContractAddress from "../deploy-helpers/getContractAddress";
+
+const HOME_CHAIN_IDS = [42161, 421611];
+const paramsByChainId = {
+  4: {
+    arbitrator: "0xab96e690f784b305942752a1fda42680e80f37a0", // SimplePermissionlessArbitrator
+    foreignChainId: 77,
+  },
+  42161: {
+    arbitrator: "0x18c8a7ec7897177E4529065a7E7B0878358B3BfF", // SimplePermissionlessArbitrator
+    foreignChainId: 1,
+  },
+  421611: {
+    arbitrator: "0x18c8a7ec7897177E4529065a7E7B0878358B3BfF", // SimplePermissionlessArbitrator
+    foreignChainId: 4,
+  },
+};
+
+const deployHomeGateway: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const {ethers, deployments, getNamedAccounts, getChainId, config} = hre;
+  const {deploy} = deployments;
+  const { providers, constants } = ethers;
+  const { hexZeroPad } = hre.ethers.utils;
+
+  const {deployer } = await getNamedAccounts();
+  const chainId = await getChainId();
+
+  const foreignNetworks = {
+    42161: config.networks.mainnet,
+    421611: config.networks.rinkeby,
+  };
+  const { url } = foreignNetworks[chainId];
+  const foreignChainProvider = new providers.JsonRpcProvider(url);
+  const nonce = await foreignChainProvider.getTransactionCount(deployer);
+
+  const { arbitrator, foreignChainId } = paramsByChainId[chainId];
+
+  // Foreign gateway deploy tx is the last transaction on its network
+  // So we get it's current nonce subtracted by 1.
+  const foreignGatewayAddress = getContractAddress(deployer, nonce - 1 );
+  // And FastBridgeReceiver is the second last tx.
+  const fastBridgeReceiverAddress = getContractAddress(deployer, nonce - 2 );
+
+  const foreignChainIdAsBytes32 = hexZeroPad(foreignChainId, 32);
+  console.log(fastBridgeReceiverAddress);
+  console.log(foreignGatewayAddress);
+
+  let safeBridge = await deploy('SafeArbitrumBridge', {
+    from: deployer,
+    log: true,
+  });
+
+  let fastBridgeSender = await deploy('FastBridgeSender', {
+    from: deployer,
+    args: [safeBridge.address, fastBridgeReceiverAddress],
+    log: true,
+  });
+
+  let homeGateway = await deploy('HomeGateway', {
+    from: deployer,
+    args: [arbitrator, fastBridgeSender.address, foreignGatewayAddress, foreignChainIdAsBytes32],
+    log: true,
+  });
+
+};
+
+deployHomeGateway.tags = ["HomeChain"];
+deployHomeGateway.skip = async ({ getChainId }) => !HOME_CHAIN_IDS.includes(Number(await getChainId()));
+
+export default deployHomeGateway;

contracts/deployments/arbitrumRinkeby/.chainId

@@ -0,0 +1 @@
+421611

contracts/deployments/arbitrumRinkeby/FastBridgeSender.json

@@ -0,0 +1,147 @@
+{
+  "address": "0xefA86cB132B608a959621A657f50173370791634",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "contract ISafeBridge",
+          "name": "_safebridge",
+          "type": "address"
+        },
+        {
+          "internalType": "contract IFastBridgeReceiver",
+          "name": "_fastBridgeReceiver",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "constructor"
+    },
+    {
+      "anonymous": false,
+      "inputs": [
+        {
+          "indexed": false,
+          "internalType": "address",
+          "name": "target",
+          "type": "address"
+        },
+        {
+          "indexed": false,
+          "internalType": "bytes32",
+          "name": "messageHash",
+          "type": "bytes32"
+        },
+        {
+          "indexed": false,
+          "internalType": "bytes",
+          "name": "messagePreImage",
+          "type": "bytes"
+        }
+      ],
+      "name": "OutboxMessage",
+      "type": "event"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "_receiver",
+          "type": "address"
+        },
+        {
+          "internalType": "bytes",
+          "name": "_calldata",
+          "type": "bytes"
+        }
+      ],
+      "name": "sendFast",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    }
+  ],
+  "transactionHash": "0xba45e898056c0f6c1398ed4c41ebd7cbff83b9a9bd2cff11326980d05a8b2d94",
+  "receipt": {
+    "to": null,
+    "from": "0x3b434e0D2a6C7F53d5C556D7BAeE8942c351Cf1a",
+    "contractAddress": "0xefA86cB132B608a959621A657f50173370791634",
+    "transactionIndex": 0,
+    "gasUsed": "2285803",
+    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+    "blockHash": "0xd18059ef07d36d8e57c7dce859c3f4879583b87cb6a39b1576e2b28d8d21258d",
+    "transactionHash": "0xba45e898056c0f6c1398ed4c41ebd7cbff83b9a9bd2cff11326980d05a8b2d94",
+    "logs": [],
+    "blockNumber": 9322964,
+    "cumulativeGasUsed": "115523",
+    "status": 1,
+    "byzantium": true
+  },
+  "args": [
+    "0xa4bdf6D5c291e6c5f3b9b75764cFcaF0EF7e7AB9",
+    "0xB520c1bA7e27723Cb9b96b5ab759269De243a69B"
+  ],
+  "numDeployments": 1,
+  "solcInputHash": "404f378731df3b59bdbdc6b6946fcc1d",
+  "metadata": "{\"compiler\":{\"version\":\"0.8.10+commit.fc410830\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"inputs\":[{\"internalType\":\"contract ISafeBridge\",\"name\":\"_safebridge\",\"type\":\"address\"},{\"internalType\":\"contract IFastBridgeReceiver\",\"name\":\"_fastBridgeReceiver\",\"type\":\"address\"}],\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"internalType\":\"address\",\"name\":\"target\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"bytes32\",\"name\":\"messageHash\",\"type\":\"bytes32\"},{\"indexed\":false,\"internalType\":\"bytes\",\"name\":\"messagePreImage\",\"type\":\"bytes\"}],\"name\":\"OutboxMessage\",\"type\":\"event\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_receiver\",\"type\":\"address\"},{\"internalType\":\"bytes\",\"name\":\"_calldata\",\"type\":\"bytes\"}],\"name\":\"sendFast\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"}],\"devdoc\":{\"kind\":\"dev\",\"methods\":{\"sendFast(address,bytes)\":{\"params\":{\"_calldata\":\"The receiving domain encoded message data.\",\"_receiver\":\"The L1 contract address who will receive the calldata\"}}},\"version\":1},\"userdoc\":{\"events\":{\"OutboxMessage(address,bytes32,bytes)\":{\"notice\":\"The bridgers need to watch for these events and relay the messageHash on the FastBridgeReceiver.\"}},\"kind\":\"user\",\"methods\":{\"sendFast(address,bytes)\":{\"notice\":\"Sends an arbitrary message from one domain to another via the fast bridge mechanism TODO: probably needs some access control either on the sender side or the receiver side\"}},\"version\":1}},\"settings\":{\"compilationTarget\":{\"src/bridge/FastBridgeSender.sol\":\"FastBridgeSender\"},\"evmVersion\":\"london\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\",\"useLiteralContent\":true},\"optimizer\":{\"enabled\":true,\"runs\":200},\"remappings\":[]},\"sources\":{\"src/bridge/FastBridgeSender.sol\":{\"content\":\"// SPDX-License-Identifier: MIT\\n\\n/**\\n *  @authors: [@shalzz]\\n *  @reviewers: []\\n *  @auditors: []\\n *  @bounties: []\\n *  @deployments: []\\n */\\n\\npragma solidity ^0.8.0;\\n\\nimport \\\"./interfaces/ISafeBridge.sol\\\";\\nimport \\\"./interfaces/IFastBridgeSender.sol\\\";\\nimport \\\"./interfaces/IFastBridgeReceiver.sol\\\";\\n\\ncontract FastBridgeSender is IFastBridgeSender {\\n    ISafeBridge safebridge;\\n    IFastBridgeReceiver fastBridgeReceiver;\\n\\n    /**\\n     * The bridgers need to watch for these events and\\n     * relay the messageHash on the FastBridgeReceiver.\\n     */\\n    event OutboxMessage(address target, bytes32 messageHash, bytes messagePreImage);\\n\\n    constructor(ISafeBridge _safebridge, IFastBridgeReceiver _fastBridgeReceiver) {\\n        safebridge = _safebridge;\\n        fastBridgeReceiver = _fastBridgeReceiver;\\n    }\\n\\n    /**\\n     * Sends an arbitrary message from one domain to another\\n     * via the fast bridge mechanism\\n     *\\n     * TODO: probably needs some access control either on the sender side\\n     * or the receiver side\\n     *\\n     * @param _receiver The L1 contract address who will receive the calldata\\n     * @param _calldata The receiving domain encoded message data.\\n     */\\n    function sendFast(address _receiver, bytes memory _calldata) external {\\n        // Encode the receiver address with the function signature + arguments i.e calldata\\n        bytes memory encodedData = abi.encode(_receiver, _calldata);\\n\\n        emit OutboxMessage(_receiver, keccak256(encodedData), encodedData);\\n\\n        // The safe bridge sends the encoded data to the FastBridgeReceiver\\n        // in order for the FastBridgeReceiver to resolve any potential\\n        // challenges and then forwards the message to the actual\\n        // intended recipient encoded in `data`\\n        // TODO: For this encodedData needs to be wrapped into an\\n        // IFastBridgeReceiver function.\\n        // TODO: add access checks for this on the FastBridgeReceiver.\\n        safebridge.sendCrossDomainMessage(address(fastBridgeReceiver), encodedData);\\n    }\\n}\\n\",\"keccak256\":\"0x13fede57f3c5a6940cd98a003ed91592e9c5041b9c636a0c6199ee6136e6e0e1\",\"license\":\"MIT\"},\"src/bridge/interfaces/IFastBridgeReceiver.sol\":{\"content\":\"// SPDX-License-Identifier: MIT\\n\\npragma solidity ^0.8.0;\\n\\ninterface IFastBridgeReceiver {\\n    function claim(bytes32 _messageHash) external payable;\\n\\n    function verifyAndRelay(bytes32 _messageHash, bytes memory _calldata) external;\\n\\n    function withdrawClaimDeposit(bytes32 _messageHash) external;\\n\\n    function claimDeposit() external view returns (uint256 amount);\\n}\\n\",\"keccak256\":\"0x1d7f6a6ed2c2b88f51833cba6091c57a43af2915a265395ad11aad08b1f7285d\",\"license\":\"MIT\"},\"src/bridge/interfaces/IFastBridgeSender.sol\":{\"content\":\"// SPDX-License-Identifier: MIT\\n\\npragma solidity ^0.8.0;\\n\\ninterface IFastBridgeSender {\\n    /**\\n     * Sends an arbitrary message from one domain to another\\n     * via the fast bridge mechanism\\n     *\\n     * TODO: probably needs some access control either on the sender side\\n     * or the receiver side\\n     *\\n     * @param _receiver The L1 contract address who will receive the calldata\\n     * @param _calldata The receiving domain encoded message data.\\n     */\\n    function sendFast(address _receiver, bytes memory _calldata) external;\\n}\\n\",\"keccak256\":\"0xcbf3e9b5e153940b73ab5f09469eaf2fb24a1effac83c3786b27f785c325ff2e\",\"license\":\"MIT\"},\"src/bridge/interfaces/ISafeBridge.sol\":{\"content\":\"// SPDX-License-Identifier: MIT\\n\\npragma solidity ^0.8.0;\\n\\ninterface ISafeBridge {\\n    /**\\n     * Sends an arbitrary message from one domain to another.\\n     *\\n     * @param _receiver The L1 contract address who will receive the calldata\\n     * @param _calldata The L2 encoded message data.\\n     * @return Unique id to track the message request/transaction.\\n     */\\n    function sendCrossDomainMessage(address _receiver, bytes memory _calldata) external virtual returns (uint256);\\n}\\n\",\"keccak256\":\"0x6c9485fb8c7d85a6946f1d4693a44fa4bfc52ce16a504f064b03c9f77a1687c4\",\"license\":\"MIT\"}},\"version\":1}",
+  "bytecode": "0x608060405234801561001057600080fd5b506040516103cb3803806103cb83398101604081905261002f91610078565b600080546001600160a01b039384166001600160a01b031991821617909155600180549290931691161790556100b2565b6001600160a01b038116811461007557600080fd5b50565b6000806040838503121561008b57600080fd5b825161009681610060565b60208401519092506100a781610060565b809150509250929050565b61030a806100c16000396000f3fe608060405234801561001057600080fd5b506004361061002b5760003560e01c806398ec20ec14610030575b600080fd5b61004361003e366004610142565b610045565b005b6000828260405160200161005a92919061025f565b60405160208183030381529060405290507f3e699139e0a8115e8de390569fc57ce0b665e5523f19a6d74007da1eb8681e31838280519060200120836040516100a59392919061028b565b60405180910390a160005460015460405163c249b6c160e01b81526001600160a01b039283169263c249b6c1926100e392911690859060040161025f565b6020604051808303816000875af1158015610102573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061012691906102bb565b50505050565b634e487b7160e01b600052604160045260246000fd5b6000806040838503121561015557600080fd5b82356001600160a01b038116811461016c57600080fd5b9150602083013567ffffffffffffffff8082111561018957600080fd5b818501915085601f83011261019d57600080fd5b8135818111156101af576101af61012c565b604051601f8201601f19908116603f011681019083821181831017156101d7576101d761012c565b816040528281528860208487010111156101f057600080fd5b8260208601602083013760006020848301015280955050505050509250929050565b6000815180845260005b818110156102385760208185018101518683018201520161021c565b8181111561024a576000602083870101525b50601f01601f19169290920160200192915050565b6001600160a01b038316815260406020820181905260009061028390830184610212565b949350505050565b60018060a01b03841681528260208201526060604082015260006102b26060830184610212565b95945050505050565b6000602082840312156102cd57600080fd5b505191905056fea2646970667358221220f36cb7b79fa35133f53c12e670af146d0fe08da199d1101ed29baa56342edace64736f6c634300080a0033",
+  "deployedBytecode": "0x608060405234801561001057600080fd5b506004361061002b5760003560e01c806398ec20ec14610030575b600080fd5b61004361003e366004610142565b610045565b005b6000828260405160200161005a92919061025f565b60405160208183030381529060405290507f3e699139e0a8115e8de390569fc57ce0b665e5523f19a6d74007da1eb8681e31838280519060200120836040516100a59392919061028b565b60405180910390a160005460015460405163c249b6c160e01b81526001600160a01b039283169263c249b6c1926100e392911690859060040161025f565b6020604051808303816000875af1158015610102573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061012691906102bb565b50505050565b634e487b7160e01b600052604160045260246000fd5b6000806040838503121561015557600080fd5b82356001600160a01b038116811461016c57600080fd5b9150602083013567ffffffffffffffff8082111561018957600080fd5b818501915085601f83011261019d57600080fd5b8135818111156101af576101af61012c565b604051601f8201601f19908116603f011681019083821181831017156101d7576101d761012c565b816040528281528860208487010111156101f057600080fd5b8260208601602083013760006020848301015280955050505050509250929050565b6000815180845260005b818110156102385760208185018101518683018201520161021c565b8181111561024a576000602083870101525b50601f01601f19169290920160200192915050565b6001600160a01b038316815260406020820181905260009061028390830184610212565b949350505050565b60018060a01b03841681528260208201526060604082015260006102b26060830184610212565b95945050505050565b6000602082840312156102cd57600080fd5b505191905056fea2646970667358221220f36cb7b79fa35133f53c12e670af146d0fe08da199d1101ed29baa56342edace64736f6c634300080a0033",
+  "devdoc": {
+    "kind": "dev",
+    "methods": {
+      "sendFast(address,bytes)": {
+        "params": {
+          "_calldata": "The receiving domain encoded message data.",
+          "_receiver": "The L1 contract address who will receive the calldata"
+        }
+      }
+    },
+    "version": 1
+  },
+  "userdoc": {
+    "events": {
+      "OutboxMessage(address,bytes32,bytes)": {
+        "notice": "The bridgers need to watch for these events and relay the messageHash on the FastBridgeReceiver."
+      }
+    },
+    "kind": "user",
+    "methods": {
+      "sendFast(address,bytes)": {
+        "notice": "Sends an arbitrary message from one domain to another via the fast bridge mechanism TODO: probably needs some access control either on the sender side or the receiver side"
+      }
+    },
+    "version": 1
+  },
+  "storageLayout": {
+    "storage": [
+      {
+        "astId": 7557,
+        "contract": "src/bridge/FastBridgeSender.sol:FastBridgeSender",
+        "label": "safebridge",
+        "offset": 0,
+        "slot": "0",
+        "type": "t_contract(ISafeBridge)7766"
+      },
+      {
+        "astId": 7560,
+        "contract": "src/bridge/FastBridgeSender.sol:FastBridgeSender",
+        "label": "fastBridgeReceiver",
+        "offset": 0,
+        "slot": "1",
+        "type": "t_contract(IFastBridgeReceiver)7742"
+      }
+    ],
+    "types": {
+      "t_contract(IFastBridgeReceiver)7742": {
+        "encoding": "inplace",
+        "label": "contract IFastBridgeReceiver",
+        "numberOfBytes": "20"
+      },
+      "t_contract(ISafeBridge)7766": {
+        "encoding": "inplace",
+        "label": "contract ISafeBridge",
+        "numberOfBytes": "20"
+      }
+    }
+  }
+}