chore(contracts): add acceptOwnership task for EOA new owner (#1212)

Author: melanciani

gateway-contracts/.env.example

@@ -9,6 +9,7 @@ MNEMONIC="adapt mosquito move limb mobile illegal tree voyage juice mosquito bur
 
 # Private keys
 DEPLOYER_PRIVATE_KEY="0x7136d8dc72f873124f4eded25f3525a20f6cee4296564c76b44f1d582c57640f" # accounts[1], private key (bytes32)
+NEW_OWNER_PRIVATE_KEY="0x7ae52cf0d3011ef7fecbe22d9537aeda1a9e42a0596e8def5d49970eb59e7a40" # accounts[2], private key (bytes32)
 
 # RPC URL
 RPC_URL="http://127.0.0.1:8757" # (string)

gateway-contracts/docs/getting-started/deployment/env_variables.md

@@ -50,6 +50,7 @@ Here's the complete list of environment variables used for deploying the FHEVM g
 | `MNEMONIC`                          | "Mnemonic phrase for address generation | string        | "adapt mosquito move limb mobile illegal tree voyage juice mosquito burger raise father hope layer" | -                                                                                |
 | `RPC_URL`                           | URL of the RPC node                     | string        | "http://127.0.0.1:8757"                                                                             | -                                                                                |
 | `GATEWAY_CONFIG_ADDRESS`            | Address of the GatewayConfig contract   | address       | -                                                                                                   | Only for production settings                                                     |
+| `NEW_OWNER_PRIVATE_KEY`             | Private key for new owner acceptance    | bytes32       | -                                                                                                   | Only used in task that transfers ownership of the gateway to a new EAO owner     |
 
 ## In details
 
@@ -248,3 +249,11 @@ KMS_GENERATION_ADDRESS="0x87A5b1152AA51728258dbc1AA54B6a83DCd1d3dd" # (address)
 ```
 
 This (static) address is needed for generating the FHE key and CRS through the KMSGeneration contract. In a proper production setting, this environment variable needs to be dynamically set after deploying the contracts.
+
+- New owner private key
+
+```bash
+NEW_OWNER_PRIVATE_KEY="0x7136d8dc72f873124f4eded25f3525a20f6cee4296564c76b44f1d582c57640f" # (bytes32)
+```
+
+This is the private key of the targeted new owner EAO, used to accept the ownership of the gateway contracts in case it is not directly transferred to a multisig account.

gateway-contracts/tasks/ownership.ts

@@ -35,3 +35,32 @@ task(
        The new owner needs to send an acceptOwnership transaction to validate the transfer`,
     );
   });
+
+task(
+  "task:acceptGatewayOwnership",
+  "Accepts ownership of the gateway contracts. This can only be used if the account is an EOA.",
+).setAction(async function ({}, { ethers }) {
+  // Get the new owner wallet.
+  const newOwner = new Wallet(getRequiredEnvVar("NEW_OWNER_PRIVATE_KEY")).connect(ethers.provider);
+
+  // Get the GatewayConfig contract: its owner is the owner of all gateway contracts
+  const gatewayConfigSnakeCase = pascalCaseToSnakeCase("GatewayConfig");
+  const gatewayConfigAddressEnvVarName = `${gatewayConfigSnakeCase.toUpperCase()}_ADDRESS`;
+  const gatewayConfigContractAddress = getRequiredEnvVar(gatewayConfigAddressEnvVarName);
+  const gatewayConfigContract = await ethers.getContractAt("GatewayConfig", gatewayConfigContractAddress);
+
+  if ((await gatewayConfigContract.pendingOwner()) !== newOwner.address) {
+    throw new Error(
+      `The new owner account ${newOwner.address} is not the pending owner of the GatewayConfig contract ${gatewayConfigContractAddress}`,
+    );
+  }
+
+  // Transfer ownership of the GatewayConfig contract to the destination address.
+  const tx = await gatewayConfigContract.connect(newOwner).acceptOwnership();
+
+  await tx.wait();
+
+  console.log(
+    `Ownership of GatewayConfig contract ${gatewayConfigContractAddress} has been accepted by account ${newOwner.address}`,
+  );
+});

gateway-contracts/test/tasks/ownership.ts

@@ -3,12 +3,13 @@ import { expect } from "chai";
 import { Wallet } from "ethers";
 import hre from "hardhat";
 
+import { getRequiredEnvVar } from "../../tasks/utils/loadVariables";
 import { GatewayConfig } from "../../typechain-types";
 import { loadTestVariablesFixture } from "../utils";
 
 describe("Ownership tasks", function () {
-  // Define the private key of the new owner (Account 2)
-  const newOwnerPrivateKey = "0x7ae52cf0d3011ef7fecbe22d9537aeda1a9e42a0596e8def5d49970eb59e7a40";
+  // Get the private key of the new owner
+  const newOwnerPrivateKey = getRequiredEnvVar("NEW_OWNER_PRIVATE_KEY");
   const newOwner = new Wallet(newOwnerPrivateKey).connect(hre.ethers.provider);
 
   let gatewayConfig: GatewayConfig;
@@ -23,10 +24,7 @@ describe("Ownership tasks", function () {
   it("Should ask transfer ownership of the GatewayConfig contract", async function () {
     expect(await gatewayConfig.owner()).to.eq(owner.address);
 
-    await hre.run("task:transferGatewayOwnership", {
-      currentOwnerPrivateKey: owner.privateKey,
-      newOwnerAddress: newOwner.address,
-    });
+    await hre.run("task:transferGatewayOwnership", { newOwnerAddress: newOwner.address });
 
     // Check that the ownership has not been transferred as the transfer is only pending since the
     // new owner has not accepted it yet.
@@ -35,4 +33,11 @@ describe("Ownership tasks", function () {
     // Check that the pending owner is the new owner.
     expect(await gatewayConfig.pendingOwner()).to.eq(newOwner.address);
   });
+
+  it("Should accept ownership of the GatewayConfig contract", async function () {
+    await hre.run("task:acceptGatewayOwnership");
+
+    // Check that the ownership has been transferred to the new owner.
+    expect(await gatewayConfig.owner()).to.eq(newOwner.address);
+  });
 });

host-contracts/.env.example

@@ -39,4 +39,8 @@ PAUSER_SET_CONTRACT_ADDRESS="0x44aA028fd264C76BF4A8f8B4d8A5272f6AE25CAc" # (addr
 
 # The first pauser's private key
 # This is required for local tests and running the pausing task. It must correspond to one of the pauser's private key
-PAUSER_PRIVATE_KEY="0x7ae52cf0d3011ef7fecbe22d9537aeda1a9e42a0596e8def5d49970eb59e7a40" # accounts[2], private key (bytes32)
+PAUSER_PRIVATE_KEY="0x7ae52cf0d3011ef7fecbe22d9537aeda1a9e42a0596e8def5d49970eb59e7a40" # accounts[2], private key (bytes32)
+
+# This is the private key of the targeted new owner EAO, used to accept the ownership of the host 
+# contracts in case it is not directly transferred to a multisig account.
+NEW_OWNER_PRIVATE_KEY="0x7ae52cf0d3011ef7fecbe22d9537aeda1a9e42a0596e8def5d49970eb59e7a40" # accounts[2], private key (bytes32)

host-contracts/tasks/ownership.ts

@@ -30,3 +30,29 @@ task('task:transferHostOwnership', "Transfers the deployer's ownership of the ho
        The new owner needs to send an acceptOwnership transaction to validate the transfer`,
     );
   });
+
+task(
+  'task:acceptHostOwnership',
+  'Accepts ownership of the host contracts. This can only be used if the account is an EOA.',
+).setAction(async function ({}, { ethers }) {
+  // Get the new owner wallet.
+  const newOwner = new Wallet(getRequiredEnvVar('NEW_OWNER_PRIVATE_KEY')).connect(ethers.provider);
+
+  // Get the ACL contract: its owner is the owner of all host contracts
+  const contractName = 'ACL';
+  const aclContractAddress = getRequiredEnvVar(`${contractName}_CONTRACT_ADDRESS`);
+  const aclContract = await ethers.getContractAt(contractName, aclContractAddress);
+
+  if ((await aclContract.pendingOwner()) !== newOwner.address) {
+    throw new Error(
+      `The new owner account ${newOwner.address} is not the pending owner of the ACL contract ${aclContractAddress}`,
+    );
+  }
+
+  // Accept ownership of the ACL contract.
+  const tx = await aclContract.connect(newOwner).acceptOwnership();
+
+  await tx.wait();
+
+  console.log(`Ownership of ACL contract ${aclContractAddress} has been accepted by account ${newOwner.address}`);
+});

host-contracts/test/tasks/ownership.ts

@@ -13,8 +13,8 @@ describe('Ownership tasks', function () {
   const deployerPrivateKey = getRequiredEnvVar('DEPLOYER_PRIVATE_KEY');
   const deployer = new ethers.Wallet(deployerPrivateKey).connect(ethers.provider);
 
-  // Define the private key of the new owner (Account 2)
-  const newOwnerPrivateKey = '0x7ae52cf0d3011ef7fecbe22d9537aeda1a9e42a0596e8def5d49970eb59e7a40';
+  // Get the private key of the new owner
+  const newOwnerPrivateKey = getRequiredEnvVar('NEW_OWNER_PRIVATE_KEY');
   const newOwner = new ethers.Wallet(newOwnerPrivateKey).connect(ethers.provider);
 
   before(async function () {
@@ -37,4 +37,31 @@ describe('Ownership tasks', function () {
     // Check that the pending owner is the new owner.
     expect(await acl.pendingOwner()).to.eq(newOwner.address);
   });
+
+  it('Should accept ownership of the ACL contract', async function () {
+    await run('task:acceptHostOwnership');
+
+    // Check that the ownership has been transferred to the new owner.
+    expect(await acl.owner()).to.eq(newOwner.address);
+  });
+
+  // This is to avoid to break other tests
+  it('Should put back ownership of the ACL contract to the deployer', async function () {
+    // Temporarily swap the deployer and the new owner private keys
+    process.env.DEPLOYER_PRIVATE_KEY = newOwnerPrivateKey;
+    process.env.NEW_OWNER_PRIVATE_KEY = deployerPrivateKey;
+
+    // Transfer ownership to the deployer and accept it
+    await run('task:transferHostOwnership', {
+      newOwnerAddress: deployer.address,
+    });
+    await run('task:acceptHostOwnership');
+
+    // Check that the ownership has been transferred back to the deployer.
+    expect(await acl.owner()).to.eq(deployer.address);
+
+    // Restore the original private keys
+    process.env.DEPLOYER_PRIVATE_KEY = deployerPrivateKey;
+    process.env.NEW_OWNER_PRIVATE_KEY = newOwnerPrivateKey;
+  });
 });