Arbitrum L1 to L2 messaging proposal

.clabot

@@ -62,7 +62,8 @@
     "0xTxbi",
     "FedericoCaruso",
     "njokuScript",
-    "Calla-Ji"
+    "Calla-Ji",
+    "blahkheart"
   ],
   "message": "Thank you for your pull request and welcome to Unlock! We require contributors to sign our [Contributor License Agreement](https://github.com/unlock-protocol/unlock/blob/master/CLA.txt), and we don't seem to have the users {{usersWithoutCLA}} on file. \nIn order for us to review and merge your code, please open _another_ pull request with a single modification: your github username added to the file `.clabot`.\nThank you! "
 }

governance/.env

@@ -0,0 +1,27 @@
+# private key of the signer that will deploy the contract
+export DEPLOYER_PRIVATE_KEY="0x14e1a3103ce06d0348acf19df3df1965ee55f9cdb16708c0bb8cd3d843ab8805"
+
+# block explorers API keys
+export ETHERSCAN_API_KEY="988a82bfe0a540ad84aa1a5d534c2bc6"
+export POLYGONSCAN_API_KEY=
+export OPTIMISTIC_ETHERSCAN_API_KEY=
+export BSCSCAN_API_KEY=
+export SNOWTRACE_API_KEY=
+export ARBISCAN_API_KEY=
+export CELO_API_KEY=
+export GNOSISSCAN_API_KEY=
+
+# This is a sample .env file for use in local development.
+
+# Duplicate this file as .env
+
+# Your Private key
+DEVNET_PRIVKEY="0x14e1a3103ce06d0348acf19df3df1965ee55f9cdb16708c0bb8cd3d843ab8805"
+
+# Hosted Aggregator Node (JSON-RPC Endpoint). This is Arbitrum Sepolia Testnet, can use any Arbitrum chain
+
+L2RPC="https://arbitrum-mainnet.infura.io/v3/988a82bfe0a540ad84aa1a5d534c2bc6"
+
+# Ethereum RPC; i.e., for Sepolia https://sepolia.infura.io/v3/<your infura key>
+
+L1RPC="https://mainnet.infura.io/v3/988a82bfe0a540ad84aa1a5d534c2bc6"

governance/.env.copy

@@ -9,4 +9,19 @@ export BSCSCAN_API_KEY=
 export SNOWTRACE_API_KEY=
 export ARBISCAN_API_KEY=
 export CELO_API_KEY=
-export GNOSISSCAN_API_KEY=
+export GNOSISSCAN_API_KEY=
+
+# This is a sample .env file for use in local development.
+
+# Duplicate this file as .env
+
+# Your Private key
+DEVNET_PRIVKEY="0x your key here"
+
+# Hosted Aggregator Node (JSON-RPC Endpoint). This is Arbitrum Sepolia Testnet, can use any Arbitrum chain
+
+L2RPC="https://sepolia-rollup.arbitrum.io/rpc"
+
+# Ethereum RPC; i.e., for Sepolia https://sepolia.infura.io/v3/<your infura key>
+
+L1RPC=""

governance/.gitignore

@@ -2,6 +2,7 @@
 cache
 contracts
 artifacts
+.env
 
 # zksync
 zk-artifacts

governance/package.json

@@ -3,6 +3,8 @@
   "description": "Scripts for the management of the Unlock Protocol",
   "private": true,
   "dependencies": {
+    "@arbitrum/nitro-contracts": "v1.0.2",
+    "@arbitrum/sdk": "^v3.1.9",
     "@matterlabs/hardhat-zksync-deploy": "1.1.2",
     "@matterlabs/hardhat-zksync-solc": "1.1.0",
     "@matterlabs/hardhat-zksync-upgradable": "1.2.4",
@@ -21,8 +23,9 @@
     "@unlock-protocol/hardhat-helpers": "workspace:^",
     "@unlock-protocol/hardhat-plugin": "workspace:^",
     "@unlock-protocol/networks": "workspace:./packages/networks",
+    "arb-shared-dependencies": "^1.0.0",
     "eslint": "8.54.0",
-    "ethers": "6.10.0",
+    "ethers": "6.11.1",
     "fs-extra": "11.2.0",
     "hardhat": "2.20.1",
     "solhint": "4.1.1",

governance/proposals/010-arbitrum-l1-l2-messaging.js

@@ -0,0 +1,263 @@
+const ethers = require('ethers')
+const {
+  L1ToL2MessageGasEstimator,
+} = require('@arbitrum/sdk/dist/lib/message/L1ToL2MessageGasEstimator')
+const { arbLog } = require('arb-shared-dependencies')
+const {
+  EthBridger,
+  getL2Network,
+  addDefaultLocalNetwork,
+} = require('@arbitrum/sdk')
+const { getBaseFee } = require('@arbitrum/sdk/dist/lib/utils/lib')
+
+const ERC20_ABI = [
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: 'account',
+        type: 'address',
+      },
+    ],
+    name: 'balanceOf',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: 'to',
+        type: 'address',
+      },
+      {
+        internalType: 'uint256',
+        name: 'amount',
+        type: 'uint256',
+      },
+    ],
+    name: 'transfer',
+    outputs: [
+      {
+        internalType: 'bool',
+        name: '',
+        type: 'bool',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
+]
+const INBOX_ABI = [
+  {
+    inputs: [
+      {
+        internalType: 'address',
+        name: 'to',
+        type: 'address',
+      },
+      {
+        internalType: 'uint256',
+        name: 'l2CallValue',
+        type: 'uint256',
+      },
+      {
+        internalType: 'uint256',
+        name: 'maxSubmissionCost',
+        type: 'uint256',
+      },
+      {
+        internalType: 'address',
+        name: 'excessFeeRefundAddress',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: 'callValueRefundAddress',
+        type: 'address',
+      },
+      {
+        internalType: 'uint256',
+        name: 'gasLimit',
+        type: 'uint256',
+      },
+      {
+        internalType: 'uint256',
+        name: 'maxFeePerGas',
+        type: 'uint256',
+      },
+      {
+        internalType: 'bytes',
+        name: 'data',
+        type: 'bytes',
+      },
+    ],
+    name: 'createRetryableTicket',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'payable',
+    type: 'function',
+  },
+]
+
+/**
+ * Set up: instantiate L1 / L2 wallets connected to providers
+ */
+const walletPrivateKey = process.env.DEVNET_PRIVKEY
+const l1Provider = new ethers.JsonRpcProvider(process.env.L1RPC)
+const l2Provider = new ethers.JsonRpcProvider(process.env.L2RPC)
+// const l1Wallet = new ethers.Wallet(walletPrivateKey, l1Provider)
+const l2Wallet = new ethers.Wallet(walletPrivateKey, l2Provider)
+
+module.exports = async () => {
+  await arbLog('Cross-chain Proposer')
+  addDefaultLocalNetwork()
+
+  const l2Network = await getL2Network(l2Provider)
+  const ethBridger = new EthBridger(l2Network)
+  const inboxAddress = ethBridger.l2Network.ethBridge.inbox
+  const ARBTokenAddressOnL2 = '0x912CE59144191C1204E64559FE8253a0e49E6548' // ARB TOKEN ADDRESS ON ARBITRUM ONE
+  const grantsContractAddress = '0x00D5E0d31d37cc13C645D86410aB4cB7Cb428ccA'
+  const L2Alias = '0x28ffDfB0A6e6E06E95B3A1f928Dc4024240bD87c' // Timelock Alias Address on L2
+  const L1TimelockContract = '0x17EEDFb0a6E6e06E95B3A1F928dc4024240BC76B' // Timelock Address mainnet
+
+  const L2TokenContract = new ethers.Contract(
+    ARBTokenAddressOnL2,
+    ERC20_ABI,
+    l2Wallet
+  ).connect(l2Wallet)
+
+  const balanceOf = await L2TokenContract.balanceOf(L2Alias)
+  console.log('ARB BALANCE::', ethers.formatEther(await balanceOf))
+
+  const tokenAmount = ethers.parseEther('1')
+
+  // Create an instance of the Interface from the ABIs
+  const iface_erc20 = new ethers.Interface(ERC20_ABI)
+  const iface_inbox = new ethers.Interface(INBOX_ABI)
+
+  // Encode the ERC20 Token transfer calldata
+  const transfer_calldata = iface_erc20.encodeFunctionData('transfer', [
+    grantsContractAddress,
+    tokenAmount,
+  ])
+  /**
+   * Now we can query the required gas params using the estimateAll method in Arbitrum SDK
+   */
+  const l1ToL2MessageGasEstimate = new L1ToL2MessageGasEstimator(l2Provider)
+
+  /**
+   * The estimateAll method gives us the following values for sending an L1->L2 message
+   * (1) maxSubmissionCost: The maximum cost to be paid for submitting the transaction
+   * (2) gasLimit: The L2 gas limit
+   * (3) deposit: The total amount to deposit on L1 to cover L2 gas and L2 call value
+   */
+  const L1ToL2MessageGasParams = await l1ToL2MessageGasEstimate.estimateAll(
+    {
+      from: L1TimelockContract,
+      to: ARBTokenAddressOnL2,
+      l2CallValue: 0,
+      excessFeeRefundAddress: l2Wallet.address,
+      callValueRefundAddress: l2Wallet.address,
+      data: transfer_calldata,
+    },
+    await getBaseFee(l1Provider),
+    l1Provider
+  )
+  console.log(':::::::::L1ToL2MessageGasParams::::::::::')
+  console.log(
+    'GasParams::::gasLimit',
+    L1ToL2MessageGasParams.gasLimit.toNumber()
+  )
+  console.log(
+    'GasParams::::maxSubmissionCost',
+    L1ToL2MessageGasParams.maxSubmissionCost.toNumber()
+  )
+  console.log(
+    'GasParams::::maxGas',
+    L1ToL2MessageGasParams.maxFeePerGas.toNumber()
+  )
+  console.log('GasParams::::deposit', L1ToL2MessageGasParams.deposit.toNumber())
+
+  console.log(
+    `Current retryable base submission price is: ${L1ToL2MessageGasParams.maxSubmissionCost.toString()}`
+  )
+
+  const gasPriceBid = await l2Provider.getGasPrice()
+  console.log(`L2 gas price: ${gasPriceBid.toString()}`)
+
+  const inbox_calldata = iface_inbox.encodeFunctionData(
+    'createRetryableTicket',
+    [
+      ARBTokenAddressOnL2,
+      0,
+      L1ToL2MessageGasParams.maxSubmissionCost,
+      l2Wallet.address,
+      l2Wallet.address,
+      L1ToL2MessageGasParams.gasLimit,
+      gasPriceBid,
+      transfer_calldata,
+    ]
+  )
+
+  const proposalName = `# Test Transaction before 7k ARB Transfer To Fund Unlock Protocol’s Ecosystem via Grants Stack  This proposal requests to use 1 ARB from the tokens given to Unlock Protocol DAO by ArbitrumDAO to run a test transaction to de-risk the transfer of 7k ARB tokens to fund the retroQF round on Grants Stack.`
+  console.log(proposalName)
+  // Proposal ARGS i.e Call Governor.propose() directly with these values
+  // targets: Inbox contract
+  // values: depost * 10
+  // calldatas: inbox_calldata
+  // description
+  const targets = [inboxAddress]
+  const values = [L1ToL2MessageGasParams.deposit.toNumber() * 10] // I Multiply by 10 to add extra in case gas changes
+  const calldatas = [inbox_calldata]
+  console.log(
+    '______________________________________________________________________\n'
+  )
+  console.log(
+    'PROPOSAL ARGS - Can Call Propose function on Governor with the following::'
+  )
+  console.log(
+    '______________________________________________________________________\n'
+  )
+
+  console.log('TARGETS:: ', targets)
+  console.log('VALUES:: ', values)
+  console.log('CALLDATAS:: ', calldatas)
+  console.log('DESCRIPTION:: ', proposalName)
+
+  const calls = [
+    {
+      contractNameOrAbi: INBOX_ABI,
+      contractAddress: inboxAddress,
+      functionName: 'createRetryableTicket',
+      functionArgs: [
+        ARBTokenAddressOnL2,
+        0,
+        L1ToL2MessageGasParams.maxSubmissionCost,
+        l2Wallet.address,
+        l2Wallet.address,
+        L1ToL2MessageGasParams.gasLimit,
+        gasPriceBid,
+        transfer_calldata,
+      ],
+      value: L1ToL2MessageGasParams.deposit.toNumber() * 10, // I Multiply by 10 to add extra in case gas changes due to proposal delay
+    },
+  ]
+
+  return {
+    proposalName,
+    calls,
+  }
+}