feat(protocol-contracts): add mainnet lz config for governance (#1387)

* feat(protocol-contracts): add mainnet lz config for governance

* chore(protocol-contracts): updated sender contract

* chore(protocol-contracts): update governance env file

Author: jatZama

protocol-contracts/governance/.env.example

@@ -1,6 +1,9 @@
 PRIVATE_KEY=
 SEPOLIA_RPC_URL=
 RPC_URL_ZAMA_GATEWAY_TESTNET=
+MAINNET_RPC_URL=
+RPC_URL_ZAMA_GATEWAY_MAINNET=
 ETHERSCAN_API=TA5XXXXXXXXXXXXXXXXXXXXXXXXXXXGX9
 BLOCKSCOUT_API=https://explorer-xxxx-xxxxxxx.conduit.xyz/api # don't forget the /api suffix at the end
 SAFE_PROXY_ADDRESS=
+DAO_ADDRESS=

protocol-contracts/governance/contracts/GovernanceOAppSender.sol

@@ -57,7 +57,7 @@ contract GovernanceOAppSender is OAppSender, OAppOptionsType3 {
         uint256 chainID = block.chainid;
         if (chainID == 1) {
             // chainID of ethereum-mainnet i.e linked to gateway-mainnet.
-            revert("TODO: to fill with correct value, destEid unknown yet for Zama mainnet");
+            DESTINATION_EID = 30397;
         } else if (chainID == 11155111) {
             // chainID of ethereum-testnet i.e linked to gateway-testnet.
             DESTINATION_EID = 40424;

protocol-contracts/governance/hardhat.config.ts

@@ -66,7 +66,6 @@ const config: HardhatUserConfig = {
             accounts,
         },
         'gateway-mainnet': {
-            // @ts-ignore: TODO: Remove TS ignore once LayerZero endpoint is deployed.
             eid: EndpointId.ZAMA_V2_MAINNET,
             url: process.env.RPC_URL_ZAMA_GATEWAY_MAINNET || '',
             accounts,

protocol-contracts/governance/layerzero.config.mainnet.ts

@@ -0,0 +1,49 @@
+import { EndpointId } from '@layerzerolabs/lz-definitions'
+import { TwoWayConfig, generateConnectionsConfig } from '@layerzerolabs/metadata-tools'
+
+import type { OmniPointHardhat } from '@layerzerolabs/toolbox-hardhat'
+
+const ethereumContract: OmniPointHardhat = {
+    eid: EndpointId.ETHEREUM_V2_MAINNET,
+    contractName: 'GovernanceOAppSender',
+}
+
+const zamaMainnetContract: OmniPointHardhat = {
+    eid: EndpointId.ZAMA_V2_MAINNET,
+    contractName: 'GovernanceOAppReceiver',
+}
+
+// To connect the above chains to each other, we need the following pathway:
+// Ethereum -> ZamaGatewayMainnet
+
+// We don't use enforced executor gas options here, so we should ensure `options` is set to the correct value through profiling the gas usage of calling GovernanceOAppReceiver._lzReceive(...) on the destination chain.
+// To learn more, read https://docs.layerzero.network/v2/concepts/applications/oapp-standard#execution-options-and-enforced-settings
+
+const pathways: TwoWayConfig[] = [
+    [
+        ethereumContract, // Chain A contract
+        zamaMainnetContract, // Chain B contract
+        // TODO: Add custom ZAMA DVN in next line?
+        [['LayerZero Labs', 'Nethermind'], []], // [ requiredDVN[], [ optionalDVN[], threshold ] ]
+        [15, undefined], // [A to B confirmations, B to A confirmations] // NOTE: `undefined` is used here because we want an uniderectional pathway
+        [undefined, undefined], // NOTE: first `undefined` is because we do not enforce gas, since proposals are arbitrary calls. Instead, we will use a gas profiler to calculate the gas needed for proposal execution and adds a relative buffer on top. Second `undefined` is used here because we want an uniderectional pathway.
+    ],
+]
+
+export default async function () {
+    // Generate the connections config based on the pathways
+    const connections = await generateConnectionsConfig(pathways)
+    return {
+        contracts: [
+            {
+                contract: zamaMainnetContract,
+                config: { owner: process.env.SAFE_PROXY_ADDRESS, delegate: process.env.SAFE_PROXY_ADDRESS },
+            },
+            {
+                contract: ethereumContract,
+                config: { owner: process.env.DAO_ADDRESS, delegate: process.env.DAO_ADDRESS },
+            },
+        ],
+        connections,
+    }
+}

protocol-contracts/governance/package.json

@@ -24,9 +24,10 @@
     "@babel/core": "^7.23.9",
     "@layerzerolabs/eslint-config-next": "~2.3.39",
     "@layerzerolabs/io-devtools": "~0.3.0",
-    "@layerzerolabs/lz-definitions": "^3.0.75",
+    "@layerzerolabs/lz-definitions": "^3.0.147",
     "@layerzerolabs/lz-evm-messagelib-v2": "^3.0.75",
     "@layerzerolabs/lz-evm-protocol-v2": "^3.0.75",
+    "@layerzerolabs/lz-evm-sdk-v2": "^3.0.147",
     "@layerzerolabs/lz-evm-v1-0.7": "^3.0.75",
     "@layerzerolabs/lz-v2-utilities": "^3.0.75",
     "@layerzerolabs/metadata-tools": "^3.0.0",

protocol-contracts/governance/pnpm-lock.yaml

@@ -37,7 +37,7 @@ const pathways: TwoWayConfig[] = [
         ethereumContract, // Chain A contract
         zamaMainnetContract, // Chain B contract
         // TODO: Add custom ZAMA DVN in next line?
-        [['LayerZero Labs'], []], // [ requiredDVN[], [ optionalDVN[], threshold ] ]
+        [['LayerZero Labs', 'Nethermind'], []], // [ requiredDVN[], [ optionalDVN[], threshold ] ]
         [15, 20], // [A to B confirmations, B to A confirmations]
         [EVM_ENFORCED_OPTIONS, EVM_ENFORCED_OPTIONS], // Chain B enforcedOptions, Chain A enforcedOptions
     ],