@skalenetwork/upgrade-tools 4.0.0-develop.3 → 4.0.0-develop.5

package/dist/src/contractVerifier.d.ts

@@ -2,6 +2,7 @@ import { ValidationResponse } from "@nomicfoundation/hardhat-verify/internal/uti
 export interface VerificationTarget {
     contractName: string;
     contractAddress: string;
+    constructorArguments?: string;
 }
 export interface VerificationRequestParameters {
     solcInputJson: string;

package/dist/src/contractVerifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"contractVerifier.js","sourceRoot":"","sources":["../../src/contractVerifier.ts"],"names":[],"mappings":";;;;;;AACA,qCAAkC;AAClC,kDAA0B;AAC1B,2NACsJ;AACtJ,kHAAsF;AAEtF,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAajC,MAAsB,gBAAgB;IAAtC;QAEqB,wBAAmB,GAAG,6BAA6B,CAAC;QAE9D,WAAM,GAAG,KAAK,EACjB,kBAAsC,EACtC,WAAmB,sBAAsB,EAC3C,EAAE;YACA,MAAM,KAAK,GAAG,CAAC,CAAC;YAChB,IAAI,QAAQ,GAAG,KAAK,EAAE,CAAC;gBACnB,IAAI,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACtD,MAAM,cAAc,GAAG,CAAC,CAAC;oBACzB,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAChC,QAAQ,GAAG,cAAc,CAC5B,CAAC;gBACN,CAAC;YACL,CAAC;QACL,CAAC,CAAC;IA+EN,CAAC;IA7EU,KAAK,CAAC,mBAAmB,CAAC,kBAAsC;QACnE,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,IAAI,CACN,GAAG,kBAAkB,CAAC,YAAY,2BAA2B,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,cAAc,CAC3F,kBAAkB,CACrB,EAAE,CACN,CACJ,CAAC;YACF,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAC/E,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;YAClF,OAAO,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,MAAM,CACR,4BACI,kBAAkB,CAAC,YACvB,cACI,IAAI,CAAC,IACT,gBACI,KACJ,EAAE,CACL,CACJ,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAQS,KAAK,CAAC,mBAAmB,CAAC,YAAoB;QACpD,IAAI,YAAY,KAAK,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC5C,OAAO;gBACH,eAAe,EAAE,4BAAc,CAAC,eAAe;gBAC/C,gBAAgB,EAAE,GAAG,0CAAa,CAAC,UAAU,IAAI,YAAY,EAAE;gBAC/D,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,4BAAc,CAAC,KAAK,CAAC;aACtD,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAC5D,MAAM,gBAAgB,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,YAAY,EAAE,CAAC;QAClE,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,OAAO;YACH,eAAe,EAAE,SAAS,CAAC,eAAe;YAC1C,gBAAgB;YAChB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;SACjD,CAAC;IACN,CAAC;IAED,UAAU;IAEF,uBAAuB,CAAC,kBAAsC,EAAC,QAA4B;QAC/F,IAAI,QAAQ,CAAC,SAAS,EAAwB,EAAE,CAAC;YAC7C,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,GAAG,CAAC,6BAA6B,kBAAkB,CAAC,YAAY,EAAE,CAAC,CAC5E,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,IAAI,CACN,GAAG,kBAAkB,CAAC,YAAY,gCAAgC,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,cAAc,CAChG,kBAAkB,CACrB,EAAE,CACN,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAhGD,4CAgGC"}
+{"version":3,"file":"contractVerifier.js","sourceRoot":"","sources":["../../src/contractVerifier.ts"],"names":[],"mappings":";;;;;;AACA,qCAAkC;AAClC,kDAA0B;AAC1B,2NACsJ;AACtJ,kHAAsF;AAEtF,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAcjC,MAAsB,gBAAgB;IAAtC;QAEqB,wBAAmB,GAAG,6BAA6B,CAAC;QAE9D,WAAM,GAAG,KAAK,EACjB,kBAAsC,EACtC,WAAmB,sBAAsB,EAC3C,EAAE;YACA,MAAM,KAAK,GAAG,CAAC,CAAC;YAChB,IAAI,QAAQ,GAAG,KAAK,EAAE,CAAC;gBACnB,IAAI,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBACtD,MAAM,cAAc,GAAG,CAAC,CAAC;oBACzB,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAChC,QAAQ,GAAG,cAAc,CAC5B,CAAC;gBACN,CAAC;YACL,CAAC;QACL,CAAC,CAAC;IA+EN,CAAC;IA7EU,KAAK,CAAC,mBAAmB,CAAC,kBAAsC;QACnE,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,IAAI,CACN,GAAG,kBAAkB,CAAC,YAAY,2BAA2B,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,cAAc,CAC3F,kBAAkB,CACrB,EAAE,CACN,CACJ,CAAC;YACF,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAC/E,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;YAClF,OAAO,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,MAAM,CACR,4BACI,kBAAkB,CAAC,YACvB,cACI,IAAI,CAAC,IACT,gBACI,KACJ,EAAE,CACL,CACJ,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAQS,KAAK,CAAC,mBAAmB,CAAC,YAAoB;QACpD,IAAI,YAAY,KAAK,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC5C,OAAO;gBACH,eAAe,EAAE,4BAAc,CAAC,eAAe;gBAC/C,gBAAgB,EAAE,GAAG,0CAAa,CAAC,UAAU,IAAI,YAAY,EAAE;gBAC/D,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,4BAAc,CAAC,KAAK,CAAC;aACtD,CAAC;QACN,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAC5D,MAAM,gBAAgB,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,YAAY,EAAE,CAAC;QAClE,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,OAAO;YACH,eAAe,EAAE,SAAS,CAAC,eAAe;YAC1C,gBAAgB;YAChB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;SACjD,CAAC;IACN,CAAC;IAED,UAAU;IAEF,uBAAuB,CAAC,kBAAsC,EAAC,QAA4B;QAC/F,IAAI,QAAQ,CAAC,SAAS,EAAwB,EAAE,CAAC;YAC7C,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,GAAG,CAAC,6BAA6B,kBAAkB,CAAC,YAAY,EAAE,CAAC,CAC5E,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,IAAI,CACN,GAAG,kBAAkB,CAAC,YAAY,gCAAgC,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,cAAc,CAChG,kBAAkB,CACrB,EAAE,CACN,CACJ,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAhGD,4CAgGC"}

package/dist/src/index.d.ts

@@ -8,3 +8,4 @@ export * from "./version";
 export * from "./upgrader";
 export * from "./upgraders/abstractTransparentProxyUpgrader";
 export * from "./upgraders/beaconUpgrader";
+export * from "./ownership-transfer/instanceAdmin";

package/dist/src/index.js

@@ -24,4 +24,5 @@ __exportStar(require("./version"), exports);
 __exportStar(require("./upgrader"), exports);
 __exportStar(require("./upgraders/abstractTransparentProxyUpgrader"), exports);
 __exportStar(require("./upgraders/beaconUpgrader"), exports);
+__exportStar(require("./ownership-transfer/instanceAdmin"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,2CAAyB;AACzB,gDAA8B;AAC9B,kDAAgC;AAChC,+CAA6B;AAC7B,iDAA+B;AAC/B,4CAA0B;AAC1B,6CAA2B;AAC3B,+EAA6D;AAC7D,6DAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,2CAAyB;AACzB,gDAA8B;AAC9B,kDAAgC;AAChC,+CAA6B;AAC7B,iDAA+B;AAC/B,4CAA0B;AAC1B,6CAA2B;AAC3B,+EAA6D;AAC7D,6DAA0C;AAC1C,qEAAmD"}

package/dist/src/ownership-transfer/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const ERC1967_ADMIN_SLOT = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
+export declare const ERC1967_IMPLEMENTATION_SLOT = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
+export declare const UPGRADEABLE_BEACON_ABI: string[];
+export declare const OWNABLE_ABI: string[];
+export declare const ACCESS_CONTROL_ABI: string[];
+export declare const ACCESS_MANAGER_ABI: string[];
+export declare const ACCESS_MANAGED_ABI: string[];
+export declare const MULTISIG_ABI: string[];

package/dist/src/ownership-transfer/constants.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MULTISIG_ABI = exports.ACCESS_MANAGED_ABI = exports.ACCESS_MANAGER_ABI = exports.ACCESS_CONTROL_ABI = exports.OWNABLE_ABI = exports.UPGRADEABLE_BEACON_ABI = exports.ERC1967_IMPLEMENTATION_SLOT = exports.ERC1967_ADMIN_SLOT = void 0;
+exports.ERC1967_ADMIN_SLOT = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
+exports.ERC1967_IMPLEMENTATION_SLOT = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
+exports.UPGRADEABLE_BEACON_ABI = [
+    "function owner() view returns (address)",
+    "function implementation() view returns (address)",
+    "function upgradeTo(address newImplementation)"
+];
+exports.OWNABLE_ABI = [
+    "function transferOwnership(address newOwner)",
+    "function owner() view returns (address)"
+];
+exports.ACCESS_CONTROL_ABI = [
+    "function hasRole(bytes32 role, address account) view returns (bool)",
+    "function grantRole(bytes32 role, address account)",
+    "function renounceRole(bytes32 role, address account)",
+    "function getRoleMemberCount(bytes32 role) view returns (uint256)"
+];
+exports.ACCESS_MANAGER_ABI = [
+    "function hasRole(uint64 role, address account) view returns (bool)",
+    "function grantRole(uint64 role, address account, uint32 executionDelay)",
+    "function renounceRole(uint64 role, address account)"
+];
+exports.ACCESS_MANAGED_ABI = [
+    "function authority() view returns (address)"
+];
+exports.MULTISIG_ABI = [
+    "function getOwners() view returns (address[])",
+    "function getThreshold() view returns (uint256)"
+];
+//# sourceMappingURL=constants.js.map

package/dist/src/ownership-transfer/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/ownership-transfer/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG,oEAAoE,CAAC;AAC1F,QAAA,2BAA2B,GAAG,oEAAoE,CAAC;AAGnG,QAAA,sBAAsB,GAAG;IAClC,yCAAyC;IACzC,kDAAkD;IAClD,+CAA+C;CAClD,CAAC;AAEW,QAAA,WAAW,GAAG;IACvB,8CAA8C;IAC9C,yCAAyC;CAC5C,CAAC;AAEW,QAAA,kBAAkB,GAAG;IAC9B,qEAAqE;IACrE,mDAAmD;IACnD,sDAAsD;IACtD,kEAAkE;CACrE,CAAC;AAEW,QAAA,kBAAkB,GAAG;IAC9B,oEAAoE;IACpE,yEAAyE;IACzE,qDAAqD;CACxD,CAAC;AAEW,QAAA,kBAAkB,GAAG;IAC9B,6CAA6C;CAChD,CAAC;AAEW,QAAA,YAAY,GAAG;IACxB,+CAA+C;IAC/C,gDAAgD;CACnD,CAAC"}

package/dist/src/ownership-transfer/contractAdmin.d.ts

@@ -0,0 +1,55 @@
+import { Pattern } from "./utils";
+import { PermissionModel } from "./permission-utils";
+import { Transaction } from "ethers";
+export interface BytesRole {
+    name: string;
+    identifier: string;
+}
+export interface UintRole {
+    name: string;
+    identifier: bigint;
+}
+export interface ContractMetadataDetails {
+    name: string;
+    address: string;
+    pattern?: Pattern;
+    permissionModel?: PermissionModel[];
+}
+export interface TransactionData {
+    transaction: Transaction;
+    description?: string;
+}
+export declare class ContractAdmin {
+    contractName: string;
+    pattern?: Pattern;
+    address: string;
+    permissionModel: PermissionModel[];
+    private oldOwner;
+    private newOwner;
+    private grantOwnershipRoleTxs;
+    private renounceOwnershipTxs;
+    constructor(details: ContractMetadataDetails, oldOwner: string, newOwner: string);
+    scanPatternAndPermissionModels(): Promise<void>;
+    createGrantOwnershipTransactions(bytes32RolesToCheck: BytesRole[], managerRolesToCheck: UintRole[]): Promise<void>;
+    createRenounceOwnershipTransactions(bytes32RolesToCheck: BytesRole[], managerRolesToCheck: UintRole[]): Promise<void>;
+    getGrantOwnershipTransactions(): TransactionData[];
+    getRenounceOwnershipTransactions(): TransactionData[];
+    clearRenounceTransactions(): void;
+    clearGrantTransactions(): void;
+    requiresGrantingOwnership(): boolean;
+    requiresRenouncingOwnership(): boolean;
+    displayData(columnWidths: {
+        maxNameWidth: number;
+        maxAddressWidth: number;
+        maxPermissionsWidth: number;
+    }): void;
+    private checkFindings;
+    private createTUPPGrantOwnershipTransaction;
+    private createOwnableOwnershipTransaction;
+    private createAssignUint64RolesTransactions;
+    private handleRenounceOwnershipTransaction;
+    private createRenounceUint64RolesTransactions;
+    private createAssignBytes32RolesTransactions;
+    private createRenounceBytes32RolesTransactions;
+    private isDuplicateTransaction;
+}

package/dist/src/ownership-transfer/contractAdmin.js

@@ -0,0 +1,206 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractAdmin = void 0;
+// Cspell:words TUPP
+const utils_1 = require("./utils");
+const permission_utils_1 = require("./permission-utils");
+const chalk_1 = __importDefault(require("chalk"));
+class ContractAdmin {
+    constructor(details, oldOwner, newOwner) {
+        this.permissionModel = [];
+        this.grantOwnershipRoleTxs = [];
+        this.renounceOwnershipTxs = [];
+        this.contractName = details.name;
+        this.pattern = details.pattern;
+        this.address = details.address;
+        this.permissionModel = details.permissionModel ?? [];
+        this.oldOwner = oldOwner;
+        this.newOwner = newOwner;
+        // Validate manual inputs if any
+        this.checkFindings();
+    }
+    async scanPatternAndPermissionModels() {
+        if (!this.pattern || !this.permissionModel.length) {
+            this.pattern = await (0, utils_1.detectPattern)(this.address);
+            this.permissionModel = await (0, permission_utils_1.getPermissionModels)(this.address);
+            this.checkFindings();
+        }
+    }
+    async createGrantOwnershipTransactions(bytes32RolesToCheck, managerRolesToCheck) {
+        this.clearGrantTransactions();
+        console.log(chalk_1.default.white(`* Creating Transactions to grant Ownership in ${this.contractName}.`));
+        if (this.pattern === utils_1.Pattern.TUPP) {
+            await this.createTUPPGrantOwnershipTransaction();
+        }
+        // UpgradeableBeacon is detected also as OWNABLE
+        if (this.permissionModel.includes(permission_utils_1.PermissionModel.OWNABLE)) {
+            await this.createOwnableOwnershipTransaction();
+        }
+        if (this.permissionModel.includes(permission_utils_1.PermissionModel.ROLE_BASED)) {
+            await this.createAssignBytes32RolesTransactions(bytes32RolesToCheck);
+        }
+        if (this.permissionModel.includes(permission_utils_1.PermissionModel.ACCESS_MANAGER)) {
+            await this.createAssignUint64RolesTransactions(managerRolesToCheck);
+        }
+    }
+    async createRenounceOwnershipTransactions(bytes32RolesToCheck, managerRolesToCheck) {
+        this.clearRenounceTransactions();
+        console.log(chalk_1.default.white(`* Creating Transactions to renounce Ownership in ${this.contractName}.`));
+        if (this.permissionModel.includes(permission_utils_1.PermissionModel.ROLE_BASED)) {
+            await this.createRenounceBytes32RolesTransactions(bytes32RolesToCheck);
+        }
+        if (this.permissionModel.includes(permission_utils_1.PermissionModel.ACCESS_MANAGER)) {
+            await this.createRenounceUint64RolesTransactions(managerRolesToCheck);
+        }
+    }
+    getGrantOwnershipTransactions() {
+        return this.grantOwnershipRoleTxs;
+    }
+    getRenounceOwnershipTransactions() {
+        return this.renounceOwnershipTxs;
+    }
+    clearRenounceTransactions() {
+        this.renounceOwnershipTxs = [];
+    }
+    clearGrantTransactions() {
+        this.grantOwnershipRoleTxs = [];
+    }
+    requiresGrantingOwnership() {
+        return Boolean(this.grantOwnershipRoleTxs.length);
+    }
+    requiresRenouncingOwnership() {
+        return Boolean(this.renounceOwnershipTxs.length);
+    }
+    displayData(columnWidths) {
+        const { maxNameWidth, maxAddressWidth, maxPermissionsWidth } = columnWidths;
+        const name = this.contractName.padEnd(maxNameWidth);
+        const address = this.address.padEnd(maxAddressWidth);
+        const permissions = (this.permissionModel?.join(", ") || "None").padEnd(maxPermissionsWidth);
+        let status = chalk_1.default.green("ALL DONE");
+        if (this.grantOwnershipRoleTxs.length) {
+            status = chalk_1.default.yellow("GRANT OWNERSHIP REQUIRED");
+        }
+        else if (this.renounceOwnershipTxs.length) {
+            status = chalk_1.default.yellow("REVOKE ROLES REQUIRED");
+        }
+        console.log(chalk_1.default.gray(`  ${name}  ${address}  ${permissions}  `) + status);
+    }
+    checkFindings() {
+        const maxPermissionsIfBeacon = 1;
+        if (this.pattern === utils_1.Pattern.BEACON &&
+            !this.permissionModel?.includes(permission_utils_1.PermissionModel.OWNABLE) &&
+            this.permissionModel?.length !== maxPermissionsIfBeacon) {
+            throw new Error(`UpgradeableBeacon at address ${this.address} should ONLY have OWNABLE permission model.`);
+        }
+    }
+    async createTUPPGrantOwnershipTransaction() {
+        const admin = await (0, utils_1.getAdminAddress)(this.address);
+        await this.createOwnableOwnershipTransaction({ address: admin, name: `${this.contractName} Proxy Admin` });
+    }
+    async createOwnableOwnershipTransaction(contractId = { address: this.address, name: this.contractName }) {
+        const tx = await (0, permission_utils_1.transferOwnership)(contractId.address, this.newOwner, this.oldOwner);
+        if (tx) {
+            if (this.isDuplicateTransaction({ transaction: tx })) {
+                throw new Error(`Error: Duplicate transaction to transfer ownership of ${contractId.name} at ${contractId.address} was already created.`);
+            }
+            const description = `-> Tx to change ${contractId.name} Owner at ${contractId.address} to ${this.newOwner}`;
+            console.log(chalk_1.default.yellow(`    ${description} created.`));
+            this.grantOwnershipRoleTxs.push({
+                description,
+                transaction: tx
+            });
+        }
+    }
+    async createAssignUint64RolesTransactions(managerRolesToCheck) {
+        for (const role of managerRolesToCheck) {
+            // Required to process sequentially as it access shared memory state and RPC rate limits
+            // eslint-disable-next-line no-await-in-loop
+            const tx = await (0, permission_utils_1.grantAccessManagerRole)({
+                contractAddress: this.address,
+                newAccount: this.newOwner,
+                oldAccount: this.oldOwner,
+                role: role.identifier,
+            });
+            if (tx) {
+                if (this.isDuplicateTransaction({ transaction: tx })) {
+                    throw new Error(`Error: Transaction to grant manager role ${role.name} in ${this.contractName} was already created.`);
+                }
+                else {
+                    const description = `-> Tx to grant role ${role.name} to ${this.newOwner} in ${this.contractName}`;
+                    console.log(chalk_1.default.yellow(`    ${description} created.`));
+                    this.grantOwnershipRoleTxs.push({ description, transaction: tx });
+                }
+            }
+        }
+    }
+    handleRenounceOwnershipTransaction(tx, roleName) {
+        if (typeof tx !== "boolean" && tx) {
+            if (this.isDuplicateTransaction({ transaction: tx })) {
+                throw new Error(`Error: Transaction to renounce role ${roleName} in ${this.contractName} was already created.`);
+            }
+            else {
+                const description = `-> Tx to renounce role ${roleName} from ${this.oldOwner} in ${this.contractName}`;
+                console.log(chalk_1.default.yellow(`    ${description} created.`));
+                this.renounceOwnershipTxs.push({ description, transaction: tx });
+            }
+        }
+        else if (!tx) {
+            console.log(chalk_1.default.yellow(`    WARNING: Skipping revocation of role ${roleName} in ${this.contractName} as it requires at least 1 member left.`));
+        }
+    }
+    async createRenounceUint64RolesTransactions(managerRolesToCheck) {
+        for (const role of managerRolesToCheck) {
+            // Required to process sequentially as it access shared memory state and RPC rate limits
+            // eslint-disable-next-line no-await-in-loop
+            const tx = await (0, permission_utils_1.renounceAccessManagerRole)({
+                contractAddress: this.address,
+                newAccount: this.newOwner,
+                oldAccount: this.oldOwner,
+                role: role.identifier,
+            });
+            this.handleRenounceOwnershipTransaction(tx, role.name);
+        }
+    }
+    async createAssignBytes32RolesTransactions(bytes32RolesToCheck) {
+        for (const role of bytes32RolesToCheck) {
+            // Required to process sequentially as it access shared memory state and RPC rate limits
+            // eslint-disable-next-line no-await-in-loop
+            const tx = await (0, permission_utils_1.grantRole)({
+                contractAddress: this.address,
+                newAccount: this.newOwner,
+                oldAccount: this.oldOwner,
+                role: role.identifier,
+            });
+            if (tx) {
+                if (this.isDuplicateTransaction({ transaction: tx })) {
+                    throw new Error(`Error: Transaction to grant role ${role.name} in ${this.contractName} was already created.`);
+                }
+                else {
+                    const description = `-> Tx to grant role ${role.name} to ${this.newOwner} in ${this.contractName}`;
+                    console.log(chalk_1.default.yellow(`    ${description} created.`));
+                    this.grantOwnershipRoleTxs.push({ description, transaction: tx });
+                }
+            }
+        }
+    }
+    async createRenounceBytes32RolesTransactions(bytes32RolesToCheck) {
+        for (const role of bytes32RolesToCheck) {
+            // Required to process sequentially as it access shared memory state and due to RPC rate limits
+            // eslint-disable-next-line no-await-in-loop
+            const tx = await (0, permission_utils_1.renounceRole)(this.address, role.identifier, this.oldOwner);
+            this.handleRenounceOwnershipTransaction(tx, role.name);
+        }
+    }
+    isDuplicateTransaction(transaction) {
+        const isGrantDuplicate = this.grantOwnershipRoleTxs.some((existingTx) => existingTx.transaction.to === transaction.transaction.to &&
+            existingTx.transaction.data === transaction.transaction.data);
+        const isRenounceDuplicate = this.renounceOwnershipTxs.some((existingTx) => existingTx.transaction.to === transaction.transaction.to &&
+            existingTx.transaction.data === transaction.transaction.data);
+        return isGrantDuplicate || isRenounceDuplicate;
+    }
+}
+exports.ContractAdmin = ContractAdmin;
+//# sourceMappingURL=contractAdmin.js.map

package/dist/src/ownership-transfer/contractAdmin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractAdmin.js","sourceRoot":"","sources":["../../../src/ownership-transfer/contractAdmin.ts"],"names":[],"mappings":";;;;;;AAAA,oBAAoB;AACpB,mCAAgE;AAChE,yDAQ4B;AAE5B,kDAA0B;AAwB1B,MAAa,aAAa;IAWtB,YAAY,OAAgC,EAAE,QAAgB,EAAE,QAAgB;QAPzE,oBAAe,GAAsB,EAAE,CAAC;QAIvC,0BAAqB,GAAsB,EAAE,CAAC;QAC9C,yBAAoB,GAAsB,EAAE,CAAC;QAGjD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,gCAAgC;QAChC,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,8BAA8B;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;YAChD,IAAI,CAAC,OAAO,GAAG,MAAM,IAAA,qBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjD,IAAI,CAAC,eAAe,GAAG,MAAM,IAAA,sCAAmB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;QACzB,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,gCAAgC,CACzC,mBAAgC,EAChC,mBAA+B;QAE/B,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,iDAAiD,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,OAAO,KAAK,eAAO,CAAC,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,mCAAmC,EAAE,CAAC;QACrD,CAAC;QACD,gDAAgD;QAChD,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,kCAAe,CAAC,OAAO,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,CAAC,iCAAiC,EAAE,CAAC;QACnD,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,kCAAe,CAAC,UAAU,CAAC,EAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,oCAAoC,CAAC,mBAAmB,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,kCAAe,CAAC,cAAc,CAAC,EAAC,CAAC;YAC/D,MAAM,IAAI,CAAC,mCAAmC,CAAC,mBAAmB,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,mCAAmC,CAC5C,mBAAgC,EAChC,mBAA+B;QAE/B,IAAI,CAAC,yBAAyB,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,oDAAoD,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACnG,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,kCAAe,CAAC,UAAU,CAAC,EAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,sCAAsC,CAAC,mBAAmB,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,kCAAe,CAAC,cAAc,CAAC,EAAC,CAAC;YAC/D,MAAM,IAAI,CAAC,qCAAqC,CAAC,mBAAmB,CAAC,CAAC;QAC1E,CAAC;IACL,CAAC;IAEM,6BAA6B;QAChC,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAEM,gCAAgC;QACnC,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAEM,yBAAyB;QAC5B,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;IACnC,CAAC;IAEM,sBAAsB;QACzB,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC;IACpC,CAAC;IAEM,yBAAyB;QAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAEM,2BAA2B;QAC9B,OAAO,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAEM,WAAW,CACd,YAA0F;QAE1F,MAAM,EAAC,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAC,GAAG,YAAY,CAAC;QAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;QAC7F,IAAI,MAAM,GAAG,eAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrC,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAC,CAAC;YACnC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;QACtD,CAAC;aACI,IAAI,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAC,CAAC;YACvC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,OAAO,KAAK,WAAW,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;IAChF,CAAC;IAEO,aAAa;QACjB,MAAM,sBAAsB,GAAG,CAAC,CAAC;QACjC,IAAI,IAAI,CAAC,OAAO,KAAK,eAAO,CAAC,MAAM;YAC/B,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,kCAAe,CAAC,OAAO,CAAC;YACxD,IAAI,CAAC,eAAe,EAAE,MAAM,KAAK,sBAAsB,EACzD,CAAC;YACC,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,OAAO,6CAA6C,CAAC,CAAC;QAC/G,CAAC;IACL,CAAC;IACO,KAAK,CAAC,mCAAmC;QAC7C,MAAM,KAAK,GAAG,MAAM,IAAA,uBAAe,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,IAAI,CAAC,iCAAiC,CACxC,EAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,cAAc,EAAC,CAC7D,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAC3C,aAA8C,EAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAC;QAE9F,MAAM,EAAE,GAAG,MAAM,IAAA,oCAAiB,EAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrF,IAAI,EAAE,EAAE,CAAC;YACL,IAAI,IAAI,CAAC,sBAAsB,CAAC,EAAC,WAAW,EAAE,EAAE,EAAC,CAAC,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,yDAAyD,UAAU,CAAC,IAAI,OAAO,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC;YAC9I,CAAC;YACD,MAAM,WAAW,GAAG,mBAAmB,UAAU,CAAC,IAAI,aAAa,UAAU,CAAC,OAAO,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;YAC3G,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;gBAC5B,WAAW;gBACX,WAAW,EAAE,EAAE;aAClB,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,mCAAmC,CAC7C,mBAA+B;QAE/B,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACrC,wFAAwF;YACxF,4CAA4C;YAC5C,MAAM,EAAE,GAAG,MAAM,IAAA,yCAAsB,EACnC;gBACI,eAAe,EAAE,IAAI,CAAC,OAAO;gBAC7B,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,IAAI,EAAE,IAAI,CAAC,UAAU;aACxB,CACJ,CAAC;YACF,IAAI,EAAE,EAAE,CAAC;gBACL,IAAI,IAAI,CAAC,sBAAsB,CAAC,EAAC,WAAW,EAAE,EAAE,EAAC,CAAC,EAAE,CAAC;oBACjD,MAAM,IAAI,KAAK,CAAC,4CAA4C,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,YAAY,uBAAuB,CAAC,CAAC;gBAC1H,CAAC;qBACI,CAAC;oBACF,MAAM,WAAW,GACb,uBAAuB,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,QAAQ,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;oBACnF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC,CAAC,CAAC;oBACzD,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAC,WAAW,EAAE,WAAW,EAAE,EAAE,EAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAEO,kCAAkC,CACtC,EAAyB,EACzB,QAAgB;QAEhB,IAAI,OAAO,EAAE,KAAK,SAAS,IAAI,EAAE,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,sBAAsB,CAAC,EAAC,WAAW,EAAE,EAAE,EAAC,CAAC,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,OAAO,IAAI,CAAC,YAAY,uBAAuB,CAAC,CAAC;YACpH,CAAC;iBACI,CAAC;gBACF,MAAM,WAAW,GAAG,0BAA0B,QAAQ,SAAS,IAAI,CAAC,QAAQ,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;gBACvG,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC,CAAC,CAAC;gBACzD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAC,WAAW,EAAE,WAAW,EAAE,EAAE,EAAC,CAAC,CAAC;YACnE,CAAC;QACL,CAAC;aACI,IAAI,CAAC,EAAE,EAAE,CAAC;YACX,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CACpB,4CAA4C,QAAQ,OAAO,IAAI,CAAC,YAAY,yCAAyC,CACxH,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,qCAAqC,CAC/C,mBAA+B;QAE/B,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACrC,wFAAwF;YACxF,4CAA4C;YAC5C,MAAM,EAAE,GAAG,MAAM,IAAA,4CAAyB,EACtC;gBACI,eAAe,EAAE,IAAI,CAAC,OAAO;gBAC7B,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,IAAI,EAAE,IAAI,CAAC,UAAU;aACxB,CACJ,CAAC;YACF,IAAI,CAAC,kCAAkC,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,oCAAoC,CAC9C,mBAAgC;QAEhC,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACrC,wFAAwF;YACxF,4CAA4C;YAC5C,MAAM,EAAE,GAAG,MAAM,IAAA,4BAAS,EACtB;gBACI,eAAe,EAAE,IAAI,CAAC,OAAO;gBAC7B,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,IAAI,EAAE,IAAI,CAAC,UAAU;aACxB,CACJ,CAAC;YACF,IAAI,EAAE,EAAE,CAAC;gBACL,IAAI,IAAI,CAAC,sBAAsB,CAAC,EAAC,WAAW,EAAE,EAAE,EAAC,CAAC,EAAE,CAAC;oBACjD,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,YAAY,uBAAuB,CAAC,CAAC;gBAClH,CAAC;qBACI,CAAC;oBACF,MAAM,WAAW,GACb,uBAAuB,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,QAAQ,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;oBACnF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC,CAAC,CAAC;oBACzD,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAC,WAAW,EAAE,WAAW,EAAE,EAAE,EAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,sCAAsC,CAChD,mBAAgC;QAEhC,KAAK,MAAM,IAAI,IAAI,mBAAmB,EAAE,CAAC;YACrC,+FAA+F;YAC/F,4CAA4C;YAC5C,MAAM,EAAE,GAAG,MAAM,IAAA,+BAAY,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5E,IAAI,CAAC,kCAAkC,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,WAA4B;QACvD,MAAM,gBAAgB,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CACpD,CAAC,UAAU,EAAE,EAAE,CACX,UAAU,CAAC,WAAW,CAAC,EAAE,KAAK,WAAW,CAAC,WAAW,CAAC,EAAE;YACxD,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,CAAC,IAAI,CACnE,CAAC;QACF,MAAM,mBAAmB,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CACtD,CAAC,UAAU,EAAE,EAAE,CACX,UAAU,CAAC,WAAW,CAAC,EAAE,KAAK,WAAW,CAAC,WAAW,CAAC,EAAE;YACxD,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,CAAC,IAAI,CACnE,CAAC;QACF,OAAQ,gBAAgB,IAAI,mBAAmB,CAAC;IACpD,CAAC;CACJ;AAlQD,sCAkQC"}

package/dist/src/ownership-transfer/instanceAdmin.d.ts

@@ -0,0 +1,51 @@
+import { EoaSubmitter, SafeSubmitter } from "../submitters";
+import { Instance } from "@skalenetwork/skale-contracts-ethers-v6";
+export interface InstanceAdminOptions {
+    oldOwner: string;
+    submitter: SafeSubmitter | EoaSubmitter;
+    renounceRoles: boolean;
+    newOwner: string;
+    readonly: boolean;
+    testMode: boolean;
+    rolesToCheck?: string[];
+    managerRolesToCheck?: bigint[];
+}
+interface ContractId {
+    name: string;
+    address?: string;
+}
+export declare class InstanceAdmin {
+    private instance?;
+    private contractMetadata;
+    private contractIds;
+    private bytes32RolesToCheck;
+    private managerRolesToCheck;
+    private oldOwner;
+    private newOwner;
+    private readonly;
+    private submitter;
+    private renounceRoles;
+    private testMode;
+    constructor(contractIds: ContractId[], options: InstanceAdminOptions, instance?: Instance);
+    executeOwnershipTransfer(): Promise<void>;
+    private initialize;
+    private processGrantStepIfRequired;
+    private processRenounceStepIfRequired;
+    private submitRenounceRolesTransactions;
+    private confirmAndSubmitTransactions;
+    private submitGrantOwnershipTransactions;
+    private ownershipGrantingRequired;
+    private ownershipRevokingRequired;
+    private resolveContractAddress;
+    private loadContractMetadataAndCreateTransactions;
+    private confirmData;
+    private processOptions;
+    private createRequiredTransactions;
+    private getColumnWidths;
+    private displayPatternGroup;
+    private displayFindings;
+    private handleUserRejection;
+    private groupMetadataByPattern;
+    private promptConfirmation;
+}
+export {};

package/dist/src/ownership-transfer/instanceAdmin.js

@@ -0,0 +1,223 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstanceAdmin = void 0;
+// Cspell:words keccak
+const contractAdmin_1 = require("./contractAdmin");
+const submitters_1 = require("../submitters");
+const utils_1 = require("./utils");
+const chalk_1 = __importDefault(require("chalk"));
+const hardhat_1 = require("hardhat");
+const ZERO = 0;
+class InstanceAdmin {
+    constructor(contractIds, options, instance) {
+        this.contractMetadata = new Map();
+        this.bytes32RolesToCheck = [];
+        this.managerRolesToCheck = [];
+        this.instance = instance;
+        this.contractIds = contractIds;
+        this.readonly = options.readonly;
+        this.newOwner = options.newOwner;
+        this.submitter = options.submitter;
+        this.oldOwner = options.oldOwner;
+        this.renounceRoles = options.renounceRoles;
+        this.testMode = options.testMode;
+        this.processOptions(options);
+    }
+    async executeOwnershipTransfer() {
+        // Confirm data found in initialization
+        await this.initialize();
+        if (this.readonly) {
+            return;
+        }
+        await this.processGrantStepIfRequired();
+        await this.processRenounceStepIfRequired();
+        this.displayFindings();
+        if (this.ownershipGrantingRequired() || (this.ownershipRevokingRequired() && this.renounceRoles)) {
+            console.error(chalk_1.default.red("Unexpected state: There are still actions required."));
+        }
+        else {
+            console.log(chalk_1.default.green("Ownership transfer process completed. - Nothing more to do."));
+        }
+    }
+    async initialize() {
+        await this.loadContractMetadataAndCreateTransactions();
+        await this.confirmData();
+    }
+    async processGrantStepIfRequired() {
+        if (this.ownershipGrantingRequired()) {
+            await this.submitGrantOwnershipTransactions();
+            if (this.renounceRoles) {
+                await this.createRequiredTransactions();
+            }
+            await this.confirmData();
+        }
+    }
+    async processRenounceStepIfRequired() {
+        if (this.renounceRoles && this.ownershipRevokingRequired() === true) {
+            await this.submitRenounceRolesTransactions();
+            await this.createRequiredTransactions();
+        }
+    }
+    async submitRenounceRolesTransactions() {
+        const txsToSubmit = [];
+        for (const contract of this.contractMetadata.values()) {
+            txsToSubmit.push(...contract.getRenounceOwnershipTransactions());
+            contract.clearRenounceTransactions();
+        }
+        console.log(chalk_1.default.green(`Submitting ${txsToSubmit.length} renounce ownership transactions...`));
+        for (const [index, txData] of txsToSubmit.entries()) {
+            console.log(chalk_1.default.grey(`    -> Transaction ${index}: ${txData.description || "No description"}`));
+        }
+        await this.confirmAndSubmitTransactions(txsToSubmit);
+    }
+    async confirmAndSubmitTransactions(txsToSubmit) {
+        const confirmation = await this.promptConfirmation("Do you want to proceed with submitting these transactions?");
+        if (!confirmation) {
+            throw new Error("Transaction submission aborted by user.");
+        }
+        await this.submitter.submit(txsToSubmit.map(tx => tx.transaction));
+        if (this.submitter instanceof submitters_1.SafeSubmitter) {
+            await this.promptConfirmation("Please proceed only AFTER the Safe transactions have been executed on-chain.\n" +
+                "Do you want to proceed?");
+        }
+    }
+    async submitGrantOwnershipTransactions() {
+        const txsToSubmit = [];
+        for (const contract of this.contractMetadata.values()) {
+            txsToSubmit.push(...contract.getGrantOwnershipTransactions());
+            contract.clearGrantTransactions();
+        }
+        // Required for ProxyAdmins shared among multiple contracts
+        const txsToSubmitFiltered = (0, utils_1.removeDuplicateTransactions)(txsToSubmit);
+        console.log(chalk_1.default.green(`Submitting ${txsToSubmitFiltered.length} unique grant ownership transactions...`));
+        for (const [index, txData] of txsToSubmitFiltered.entries()) {
+            console.log(chalk_1.default.grey(`    -> Transaction ${index}: ${txData.description || "No description"}`));
+        }
+        await this.confirmAndSubmitTransactions(txsToSubmit);
+    }
+    ownershipGrantingRequired() {
+        return Array.from(this.contractMetadata.values()).some(contract => contract.requiresGrantingOwnership());
+    }
+    ownershipRevokingRequired() {
+        return Array.from(this.contractMetadata.values()).some(contract => contract.requiresRenouncingOwnership());
+    }
+    async resolveContractAddress(contractName) {
+        if (!this.instance) {
+            throw new Error(`Instance is not defined. Cannot resolve ${contractName} address.`);
+        }
+        return await this.instance.getContractAddress(contractName);
+    }
+    async loadContractMetadataAndCreateTransactions() {
+        /* eslint-disable no-await-in-loop */
+        // Do not parallelize to avoid rate limit issues which CAN produce wrong outputs - sensitive
+        for (const { name: contractName, address } of this.contractIds) {
+            const resolvedAddress = address || await this.resolveContractAddress(contractName);
+            if (!this.contractMetadata.has(resolvedAddress)) {
+                const details = {
+                    address: resolvedAddress,
+                    name: contractName,
+                };
+                const contractAdmin = new contractAdmin_1.ContractAdmin(details, this.oldOwner, this.newOwner);
+                await contractAdmin.scanPatternAndPermissionModels();
+                this.contractMetadata.set(resolvedAddress, contractAdmin);
+            }
+        }
+        /* eslint-enable no-await-in-loop */
+        await this.createRequiredTransactions();
+    }
+    async confirmData() {
+        this.displayFindings();
+        const userConfirmed = await this.promptConfirmation();
+        if (!userConfirmed) {
+            this.handleUserRejection();
+        }
+        console.log(chalk_1.default.green("\nUser confirmed. Proceeding...\n"));
+    }
+    processOptions(options) {
+        this.bytes32RolesToCheck = (options.rolesToCheck ?? []).map(role => ({
+            // Never will include "0x00..." as role - default admin handled separately
+            identifier: hardhat_1.ethers.id(role),
+            name: role
+        }));
+        this.bytes32RolesToCheck.push({ identifier: hardhat_1.ethers.ZeroHash, name: "DEFAULT_ADMIN_ROLE" });
+        if (!this.readonly && this.newOwner === hardhat_1.ethers.ZeroAddress) {
+            throw new Error("New owner address must be provided in options when in write mode.");
+        }
+        this.managerRolesToCheck = (options.managerRolesToCheck ?? []).map(role => {
+            if (typeof role !== "bigint" || role <= ZERO) {
+                throw new Error(`Invalid manager role: ${role}. Must be a non-zero bigint.`);
+            }
+            return { identifier: role, name: `Role ${role}` };
+        });
+        this.managerRolesToCheck.push({ identifier: BigInt(ZERO), name: "ADMIN_ROLE" });
+    }
+    async createRequiredTransactions() {
+        console.log(chalk_1.default.grey("INFO: The next Following steps will NOT submit any transactions to the blockchain."));
+        // Preferred to create sequentially due to rate limits of RPC providers - sensitive
+        /* eslint-disable no-await-in-loop */
+        for (const contract of this.contractMetadata.values()) {
+            await contract.createGrantOwnershipTransactions(this.bytes32RolesToCheck, this.managerRolesToCheck);
+            if (!contract.requiresGrantingOwnership()) {
+                await contract.createRenounceOwnershipTransactions(this.bytes32RolesToCheck, this.managerRolesToCheck);
+            }
+        }
+        /* eslint-enable no-await-in-loop */
+    }
+    getColumnWidths() {
+        let maxNameWidth = 0;
+        let maxAddressWidth = 0;
+        let maxPermissionsWidth = 0;
+        for (const contract of this.contractMetadata.values()) {
+            maxNameWidth = Math.max(maxNameWidth, contract.contractName.length);
+            maxAddressWidth = Math.max(maxAddressWidth, contract.address.length);
+            const permissions = contract.permissionModel?.join(", ") || "None";
+            maxPermissionsWidth = Math.max(maxPermissionsWidth, permissions.length);
+        }
+        return { maxAddressWidth, maxNameWidth, maxPermissionsWidth };
+    }
+    displayPatternGroup(pattern, contracts) {
+        const columnWidths = this.getColumnWidths();
+        console.log(chalk_1.default.bold(`\n${pattern} Pattern (${contracts.length} contracts):`));
+        for (const contract of contracts) {
+            contract.displayData(columnWidths);
+        }
+    }
+    displayFindings() {
+        console.log(chalk_1.default.cyan("\n=== Ownership Status Results ===\n"));
+        const groupedByPattern = this.groupMetadataByPattern();
+        for (const [pattern, contracts] of Object.entries(groupedByPattern)) {
+            if (contracts.length) {
+                this.displayPatternGroup(pattern, contracts);
+            }
+        }
+        console.log(chalk_1.default.cyan("\n==========================================\n"));
+    }
+    handleUserRejection() {
+        console.log(chalk_1.default.red("User did not confirm. Aborting and clearing all data..."));
+        this.contractMetadata.clear();
+        throw new Error("User aborted because some data was inaccurate. Data has been cleared.");
+    }
+    groupMetadataByPattern() {
+        const grouped = Object.values(utils_1.Pattern).
+            reduce((acc, pattern) => {
+            acc[pattern] = [];
+            return acc;
+        }, {});
+        for (const metadata of this.contractMetadata.values()) {
+            // Used only after scan - will be defined if it reaches here
+            grouped[metadata.pattern].push(metadata);
+        }
+        return grouped;
+    }
+    async promptConfirmation(msg) {
+        if (this.testMode) {
+            return true;
+        }
+        return await (0, utils_1.promptUserConfirmation)(msg);
+    }
+}
+exports.InstanceAdmin = InstanceAdmin;
+//# sourceMappingURL=instanceAdmin.js.map