feat(protocol-contracts): adminSafeModule task on GovernanceOAppReceiver (#1288)

Author: enitrat

protocol-contracts/deployment-cli/README.md

@@ -36,6 +36,7 @@ Commands:
 ```
 
 Once the deployment configuration is complete, you can run the deployment with the following command:
+
 ```bash
 bun run start deploy --network testnet
 ```

protocol-contracts/deployment-cli/src/steps/step-03-layerzero.ts

@@ -1,5 +1,4 @@
 import path from "node:path";
-import { Contract, ethers } from "ethers";
 import { execa } from "execa";
 import type { PackageName } from "../tasks/hardhat-runner.js";
 import { ValidationError } from "../utils/errors.js";
@@ -156,32 +155,19 @@ export class Step03LayerzeroLink extends BaseStep {
         // Step 3b: Set adminSafeModule in GovernanceOAppReceiver (must be called by current owner)
         // We set it before ownership transfers to ensure we can call as the deployer if needed
         ctx.logger.info("Setting adminSafeModule on GovernanceOAppReceiver...");
-        {
-            const provider = new ethers.JsonRpcProvider(gatewayNetwork.rpcUrl);
-            const signer = new ethers.Wallet(protocolPk, provider);
-            const receiverArtifactPath = path.join(
-                resolveProjectRoot(),
-                this.pkgName,
-                "artifacts",
-                "contracts",
-                "GovernanceOAppReceiver.sol",
-                "GovernanceOAppReceiver.json",
-            );
-            const receiverAbi = (
-                (await import(receiverArtifactPath, {
-                    with: { type: "json" },
-                })) as any
-            ).default.abi;
-            const receiver = new Contract(receiverAddress, receiverAbi, signer);
-            const currentModule: string = await receiver.adminSafeModule();
-            if (
-                currentModule.toLowerCase() !== adminModuleAddress.toLowerCase()
-            ) {
-                const tx =
-                    await receiver.setAdminSafeModule(adminModuleAddress);
-                await tx.wait();
-            }
-        }
+        await ctx.hardhat.runTask({
+            pkg: this.pkgName,
+            task: "task:setAdminSafeModule",
+            args: [
+                "--network",
+                gatewayNetwork.name,
+                "--module",
+                adminModuleAddress,
+                "--receiver",
+                receiverAddress,
+            ],
+            env: baseEnv,
+        });
         ctx.logger.success(
             "adminSafeModule configured on GovernanceOAppReceiver",
         );

protocol-contracts/governance/hardhat.config.ts

@@ -14,6 +14,7 @@ import { HardhatUserConfig, HttpNetworkAccountsUserConfig } from 'hardhat/types'
 import { EndpointId } from '@layerzerolabs/lz-definitions'
 
 import './tasks/sendRemoteProposal'
+import './tasks/setAdminSafeModule'
 
 // Set your preferred authentication method
 //

protocol-contracts/governance/tasks/setAdminSafeModule.ts

@@ -0,0 +1,33 @@
+import { task, types } from 'hardhat/config'
+import { HardhatRuntimeEnvironment } from 'hardhat/types'
+import { createLogger } from '@layerzerolabs/io-devtools'
+const logger = createLogger()
+
+task('task:setAdminSafeModule', 'Sets GovernanceOAppReceiver.adminSafeModule')
+    .addParam('module', 'AdminModule address to authorize', undefined, types.string)
+    .addOptionalParam('receiver', 'GovernanceOAppReceiver address (defaults to deployment)', undefined, types.string)
+    .setAction(async ({ module, receiver }: { module: string, receiver: string }, hre: HardhatRuntimeEnvironment) => {
+        const { deployments, ethers, getNamedAccounts } = hre
+
+        const moduleAddress = ethers.utils.getAddress(module)
+
+        const receiverDeploymentAddress = receiver
+            ? receiver
+            : (await deployments.get('GovernanceOAppReceiver')).address
+        const receiverAddress = ethers.utils.getAddress(receiverDeploymentAddress)
+
+        const { deployer } = await getNamedAccounts()
+        const signer = await ethers.getSigner(deployer)
+        const governanceReceiver = await ethers.getContractAt('GovernanceOAppReceiver', receiverAddress, signer)
+
+        const currentModule: string = await governanceReceiver.adminSafeModule()
+        if (ethers.utils.getAddress(currentModule) === moduleAddress) {
+            logger.info(`adminSafeModule already set to ${moduleAddress} on ${receiverAddress}`)
+            return
+        }
+
+        logger.info(`Setting adminSafeModule on ${receiverAddress} to ${moduleAddress}...`)
+        const tx = await governanceReceiver.setAdminSafeModule(moduleAddress)
+        const receipt = await tx.wait()
+        logger.info(`✔ adminSafeModule updated in tx ${receipt?.hash ?? tx.hash}`)
+    })