Merge pull request #315 from rsksmart/feature/GBI2403-createRskForkForTesting

feat: added hardhat fork and tested the change ownership on a forked …

Author: gsoares85

e2e/multisig-migration.test.ts

@@ -0,0 +1,64 @@
+import { ethers } from "hardhat";
+import * as helpers from "@nomicfoundation/hardhat-toolbox/network-helpers";
+import { changeMultisigOwner } from "../scripts/deployment-utils/change-multisig-owner";
+import { expect } from "chai";
+import { DeploymentConfig, read } from "../scripts/deployment-utils/deploy";
+import multsigInfoJson from "../multisig-owners.json";
+
+type MultisigInfo = Record<
+  string,
+  {
+    address: string;
+    owners?: string[];
+  }
+>;
+
+const { FORK_NETWORK_NAME } = process.env;
+
+const multsigInfo: MultisigInfo = multsigInfoJson;
+
+describe("Should change LBC owner to the multisig", function () {
+  it("Should change the owner", async () => {
+    await checkForkedNetwork();
+
+    const networkName = FORK_NETWORK_NAME ?? "rskTestnet";
+
+    const addresses: Partial<DeploymentConfig> = read();
+    const networkDeployments: Partial<DeploymentConfig[string]> | undefined =
+      addresses[networkName];
+
+    const lbcAddress = networkDeployments?.LiquidityBridgeContract?.address;
+
+    if (!lbcAddress) {
+      throw new Error(
+        "LiquidityBridgeContract proxy deployment info not found"
+      );
+    }
+
+    const lbc = await ethers.getContractAt(
+      "LiquidityBridgeContractV2",
+      lbcAddress
+    );
+
+    const safeAddress = multsigInfo[networkName].address;
+
+    const lbcOwner = await lbc.owner();
+    console.info("LBC owner:", lbcOwner);
+    await helpers.impersonateAccount(lbcOwner);
+    const impersonatedSigner = await ethers.getSigner(lbcOwner);
+
+    await expect(
+      changeMultisigOwner(safeAddress, "rskTestnet", impersonatedSigner)
+    ).to.not.be.reverted;
+    const newLbcOwner = await lbc.owner();
+    console.info("New LBC owner:", newLbcOwner);
+  });
+});
+
+async function checkForkedNetwork() {
+  try {
+    await ethers.provider.send("evm_snapshot", []);
+  } catch (error) {
+    console.error("Not a forked network:", error);
+  }
+}

example.env

@@ -7,3 +7,6 @@ DEV_SIGNER_PRIVATE_KEY=<private_key>
 MAINNET_MNEMONIC=<mnemonic>
 TESTNET_MNEMONIC=<mnemonic>
 DEV_MNEMONIC=<mnemonic>
+FORK_NETWORK_NAME=<network to be forked should have same name as in hardhat.config>
+FORK_NETWORK_URL=https://public-node.testnet.rsk.co
+FORK_NETWORK_BLOCK=<Block to be forked for testnet at least 6020639 to have all information>

hardhat.config.ts

@@ -23,6 +23,8 @@ const {
   DEV_MNEMONIC,
 } = process.env;
 
+const forkEnabled = shouldEnableFork(process.argv);
+
 const rskMainnetDerivationPath = "m/44'/137'/0'/0/0";
 const rskTestnetDerivationPath = "m/44'/37310'/0'/0/0";
 
@@ -52,6 +54,26 @@ const config: HardhatUserConfig = {
       chainId: 30,
       accounts: getAccounts("mainnet"),
     },
+    hardhat: {
+      ...(forkEnabled
+        ? {
+            forking: {
+              url:
+                process.env.FORK_NETWORK_URL ??
+                "https://public-node.testnet.rsk.co",
+              blockNumber: Number(process.env.FORK_NETWORK_BLOCK ?? 6100000),
+            },
+            chains: {
+              31: {
+                hardforkHistory: {
+                  london: 4000000,
+                  berlin: 60000000,
+                },
+              },
+            },
+          }
+        : {}),
+    },
   },
   solidity: {
     version: "0.8.18",
@@ -117,3 +139,10 @@ function getDevAccounts() {
     return undefined;
   }
 }
+
+function shouldEnableFork(argv: string[]) {
+  if (argv.includes("e2e/multisig-migration.test.ts")) {
+    return true;
+  }
+  return false;
+}

multisig-owners.json

@@ -1,7 +1,13 @@
 {
   "rskTestnet": {
-    "address": "",
-    "owners": []
+    "address": "0x14842613f48485e0cb68ca88fd24363d57f34541",
+    "owners": [
+      "0x452a22889229b87472cd77d4f2a8aa33b223d6b5",
+      "0x8e925445bda88c9f980976db098cb1c450bfc719",
+      "0x14157c9d0e45dc6d1e12591317c36df45af54695",
+      "0x9724289766dfbf5039db507128ca967cb84da8ac",
+      "0xe5c7bfd92f3a26fecf5b6e5c9df9ab2adb51c475"
+    ]
   },
   "rskMainnet": {
     "address": "",

package-lock.json

@@ -14,6 +14,7 @@
     "upgrade-rskMainet": "npm run lint:sol && npm run compile && npx hardhat run scripts/deployment/upgrade-lbc.ts --network rskMainnet",
     "contract-size": "npx hardhat size-contracts",
     "test:integration": "npx hardhat test integration-test/*.test.ts --bail --network",
+    "test:e2e": "npx hardhat test e2e/*.test.ts",
     "prepare": "pip3 install pre-commit && pre-commit install"
   },
   "repository": {

package.json

@@ -1,6 +1,7 @@
 import hre, { ethers } from "hardhat";
 import { read } from "./deploy";
 import multisigOwners from "../../multisig-owners.json";
+import { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers";
 
 /**
  * Changes the multisig owner of the `LiquidityBridgeContract` deployed on the current network to the safe wallet
@@ -12,6 +13,8 @@ import multisigOwners from "../../multisig-owners.json";
  *
  * @async
  * @param {string} newOwner - The address of the new multisig owner (Safe contract).
+ * @param {string} network - The network where the script will run, by default will be the environment network.
+ * @param {HardhatEthersSigner} signer - Optional signer for test.
  * @throws {Error} If the proxy contract is not deployed on the current network.
  * @throws {Error} If the provided `newOwner` address is not a valid multisig Safe contract.
  * @throws {Error} If the configuration of owners on the Safe does not match the expected configuration.
@@ -23,8 +26,12 @@ import multisigOwners from "../../multisig-owners.json";
  * await changeMultisigOwner(newMultisigAddress);
  */
 
-export const changeMultisigOwner = async (newOwner: string) => {
-  const network = hre.network.name;
+export const changeMultisigOwner = async (
+  newOwner: string,
+  network = "",
+  signer?: HardhatEthersSigner
+) => {
+  network = network === "" ? hre.network.name : network;
   console.info(`Changing multisig owner to: ${newOwner} - ${network}`);
 
   const currentNetworkData =
@@ -49,7 +56,7 @@ export const changeMultisigOwner = async (newOwner: string) => {
   validateOwners(safeOwners, owners);
 
   console.info("Starting ownership transfer process...");
-  await transferOwnership(proxyAddress, newOwner);
+  await transferOwnership(proxyAddress, newOwner, signer);
   console.info("Ownership transfer process complete!");
 };
 
@@ -93,7 +100,8 @@ function validateOwners(safeOwners: string[], expectedOwners: string[]): void {
 
 async function transferOwnership(
   proxyAddress: string,
-  newOwnerAddress: string
+  newOwnerAddress: string,
+  signer?: HardhatEthersSigner
 ): Promise<void> {
   try {
     const contract = await ethers.getContractAt(
@@ -116,15 +124,18 @@ async function transferOwnership(
     console.info(
       `Transferring ownership of contract at ${proxyAddress} to ${newOwnerAddress}...`
     );
-    await contract.transferOwnership(newOwnerAddress);
+    const connectedContract = signer ? contract.connect(signer) : contract;
+
+    await connectedContract.transferOwnership(newOwnerAddress);
 
     console.info(
       `Ownership of contract at ${proxyAddress} successfully transferred to ${newOwnerAddress}!`
     );
 
     await hre.upgrades.admin.transferProxyAdminOwnership(
       proxyAddress,
-      newOwnerAddress
+      newOwnerAddress,
+      signer
     );
   } catch (error) {
     console.error(