@skalenetwork/upgrade-tools 4.0.0-develop.2 → 4.0.0-ownership-helpers.0

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

@@ -0,0 +1,14 @@
+import { Instance } from "@skalenetwork/skale-contracts-ethers-v6";
+export declare class OwnershipAdmin {
+    private instance;
+    private contractMetadata;
+    private contractNames;
+    private isMetadataLoaded;
+    private readonly;
+    constructor(instance: Instance, contractNames: string[], readonly?: boolean);
+    loadContractMetadata(confirmFindings?: boolean): Promise<void>;
+    private confirmMetadata;
+    private displayFindings;
+    private handleUserRejection;
+    private groupMetadataByPattern;
+}

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

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OwnershipAdmin = void 0;
+const utils_1 = require("./utils");
+const permission_utils_1 = require("./permission-utils");
+const chalk_1 = __importDefault(require("chalk"));
+class OwnershipAdmin {
+    constructor(instance, contractNames, readonly = true) {
+        this.instance = instance;
+        this.contractMetadata = new Map();
+        this.isMetadataLoaded = false;
+        // If true, does not allow to send transactions to blockchain
+        this.readonly = readonly;
+        this.contractNames = contractNames;
+    }
+    async loadContractMetadata(confirmFindings = true) {
+        await Promise.all(this.contractNames.map(async (contractName) => {
+            // Already checks the contractName is in the instance
+            const address = await this.instance.getContractAddress(contractName);
+            if (!this.contractMetadata.has(address)) {
+                const pattern = await (0, utils_1.detectPattern)(address);
+                const details = {
+                    address,
+                    name: contractName,
+                    pattern,
+                    permissionModel: await (0, permission_utils_1.getPermissionModels)(address)
+                };
+                this.contractMetadata.set(address, details);
+            }
+        }));
+        this.isMetadataLoaded = true;
+        if (this.contractMetadata.size !== this.contractNames.length) {
+            throw new Error("Some contract names did not yield metadata. Names duplicated? Aborting...");
+        }
+        if (confirmFindings) {
+            await this.confirmMetadata();
+        }
+    }
+    async confirmMetadata() {
+        this.displayFindings();
+        const userConfirmed = await (0, utils_1.promptUserConfirmation)();
+        if (!userConfirmed) {
+            this.handleUserRejection();
+        }
+        console.log(chalk_1.default.green("\nUser confirmed. Proceeding...\n"));
+    }
+    displayFindings() {
+        console.log(chalk_1.default.cyan("\n=== Contract Pattern Detection Results ===\n"));
+        const groupedByPattern = this.groupMetadataByPattern();
+        for (const [pattern, contracts] of Object.entries(groupedByPattern)) {
+            const minContractsToDisplay = 0;
+            if (contracts.length > minContractsToDisplay) {
+                console.log(chalk_1.default.bold(`\n${pattern} Pattern (${contracts.length} contracts):`));
+                for (const contract of contracts) {
+                    console.log(chalk_1.default.gray(`  - ${contract.name} (${contract.address}) - Permission Models: ${contract.permissionModel?.join(", ") || "None"}`));
+                }
+            }
+        }
+        console.log(chalk_1.default.cyan("\n==========================================\n"));
+    }
+    handleUserRejection() {
+        console.log(chalk_1.default.yellow("\nUser did not confirm. Aborting and clearing metadata..."));
+        this.contractMetadata.clear();
+        this.isMetadataLoaded = false;
+        throw new Error("User aborted the operation. Metadata 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()) {
+            grouped[metadata.pattern].push(metadata);
+        }
+        return grouped;
+    }
+}
+exports.OwnershipAdmin = OwnershipAdmin;
+//# sourceMappingURL=ownershipAdmin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ownershipAdmin.js","sourceRoot":"","sources":["../../../src/ownership-transfer/ownershipAdmin.ts"],"names":[],"mappings":";;;;;;AAAA,mCAIiB;AACjB,yDAAwE;AAExE,kDAA0B;AAS1B,MAAa,cAAc;IAQvB,YAAY,QAAkB,EAAE,aAAuB,EAAE,WAAoB,IAAI;QAC7E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,IAAI,GAAG,EAAmC,CAAC;QAEnE,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAE9B,6DAA6D;QAC7D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,kBAA2B,IAAI;QAC7D,MAAM,OAAO,CAAC,GAAG,CACb,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE;YAC1C,qDAAqD;YACrD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;YAErE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtC,MAAM,OAAO,GAAG,MAAM,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;gBAC7C,MAAM,OAAO,GAA4B;oBACrC,OAAO;oBACP,IAAI,EAAE,YAAY;oBAClB,OAAO;oBACP,eAAe,EAAE,MAAM,IAAA,sCAAmB,EAAC,OAAO,CAAC;iBACtD,CAAC;gBACF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAChD,CAAC;QACL,CAAC,CAAC,CACL,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QACjG,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QACjC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,eAAe;QACzB,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,MAAM,aAAa,GAAG,MAAM,IAAA,8BAAsB,GAAE,CAAC;QAErD,IAAI,CAAC,aAAa,EAAE,CAAC;YACjB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC/B,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC;IAClE,CAAC;IAEO,eAAe;QACnB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC,CAAC;QAC1E,MAAM,gBAAgB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACvD,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAClE,MAAM,qBAAqB,GAAG,CAAC,CAAC;YAChC,IAAI,SAAS,CAAC,MAAM,GAAG,qBAAqB,EAAE,CAAC;gBAC3C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,OAAO,aAAa,SAAS,CAAC,MAAM,cAAc,CAAC,CAAC,CAAC;gBACjF,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,0BAA0B,QAAQ,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC;gBACjJ,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC,CAAC;IAC9E,CAAC;IAEO,mBAAmB;QACvB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,2DAA2D,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC9E,CAAC;IAEO,sBAAsB;QAC1B,MAAM,OAAO,GAA+C,MAAM,CAAC,MAAM,CAAC,eAAO,CAAC;YAC9E,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YACpB,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YAClB,OAAO,GAAG,CAAC;QACf,CAAC,EAAE,EAAgD,CAAC,CAAC;QAEzD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,CAAC;YACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AA9FD,wCA8FC"}

package/dist/src/ownership-transfer/permission-utils.d.ts

@@ -0,0 +1,14 @@
+import { AddressLike } from "ethers";
+export declare enum PermissionModel {
+    OWNABLE = "OWNABLE",
+    ROLE_BASED = "ROLE_BASED",
+    ACCESS_MANAGED = "ACCESS_MANAGED"
+}
+export declare const isOwnable: (contractAddress: AddressLike) => Promise<boolean>;
+export declare const isAccessControl: (contractAddress: AddressLike) => Promise<boolean>;
+export declare const isAccessManaged: (contractAddress: AddressLike) => Promise<boolean>;
+export declare const transferOwnership: (contractAddress: AddressLike, newOwner: AddressLike) => Promise<{
+    to: string;
+    data: string;
+} | boolean>;
+export declare const getPermissionModels: (address: AddressLike) => Promise<PermissionModel[]>;

package/dist/src/ownership-transfer/permission-utils.js

@@ -0,0 +1,176 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPermissionModels = exports.transferOwnership = exports.isAccessManaged = exports.isAccessControl = exports.isOwnable = exports.PermissionModel = void 0;
+const ethers_1 = require("ethers");
+const utils_1 = require("./utils");
+const chalk_1 = __importDefault(require("chalk"));
+const hardhat_1 = require("hardhat");
+var PermissionModel;
+(function (PermissionModel) {
+    // Does not fully complete the process of Ownable2Step
+    PermissionModel["OWNABLE"] = "OWNABLE";
+    // This works also for ACCESS_MANAGER contracts - i.e they are ROLE_BASED
+    PermissionModel["ROLE_BASED"] = "ROLE_BASED";
+    PermissionModel["ACCESS_MANAGED"] = "ACCESS_MANAGED";
+})(PermissionModel || (exports.PermissionModel = PermissionModel = {}));
+/*
+ * ABI for Ownable interface - includes owner() function
+ */
+const OWNABLE_ABI = [
+    "function transferOwnership(address newOwner)",
+    "function owner() view returns (address)"
+];
+/*
+ * ABI for AccessControl interface
+ */
+const ACCESS_CONTROL_ABI = [
+    "function hasRole(bytes32 role, address account) view returns (bool)",
+    "function grantRole(bytes32 role, address account)",
+    "function revokeRole(bytes32 role, address account)"
+];
+/*
+ * ABI for AccessManaged interface - includes authority() function
+ */
+const ACCESS_MANAGED_ABI = [
+    "function authority() view returns (address)"
+];
+const verifyOwnableInterface = async (contract, contractAddress) => {
+    /*
+     * Verify owner() exists and returns non-zero address
+     */
+    const owner = await contract.owner();
+    if (owner === hardhat_1.ethers.ZeroAddress) {
+        return false;
+    }
+    /*
+     * Verify transferOwnership() exists by checking bytecode
+     */
+    return await (0, utils_1.hasFunctionSelector)(contractAddress, "transferOwnership(address)");
+};
+/*
+ * Checks if a contract implements the Ownable interface.
+ * A contract is considered Ownable if it has both owner() and transferOwnership() functions.
+ * We verify this by reading the current owner and doing a static call (dry run) of transferOwnership.
+ *
+ * @param contractAddress - The address of the contract to check
+ * @returns true if the contract is Ownable, false otherwise
+ */
+const isOwnable = async (contractAddress) => {
+    try {
+        const resolvedAddress = await hardhat_1.ethers.resolveAddress(contractAddress);
+        if (!await (0, utils_1.isContractAddress)(resolvedAddress)) {
+            return false;
+        }
+        const contract = new ethers_1.Contract(resolvedAddress, OWNABLE_ABI, hardhat_1.ethers.provider);
+        return await verifyOwnableInterface(contract, resolvedAddress);
+    }
+    catch {
+        return false;
+    }
+};
+exports.isOwnable = isOwnable;
+const verifyAccessControlInterface = async (contract, contractAddress) => {
+    /*
+     * Verify hasRole() view function exists
+     */
+    await contract.hasRole(hardhat_1.ethers.ZeroHash, hardhat_1.ethers.ZeroAddress);
+    /*
+     * Verify grantRole() exists by checking bytecode
+     */
+    return await (0, utils_1.hasFunctionSelector)(contractAddress, "grantRole(bytes32,address)") &&
+        await (0, utils_1.hasFunctionSelector)(contractAddress, "revokeRole(bytes32,address)");
+};
+/*
+ * Checks if a contract implements the AccessControl interface.
+ * A contract is considered AccessControl if it has hasRole() and grantRole() functions.
+ * We verify this by calling hasRole() and doing a static call (dry run) of grantRole().
+ *
+ * @param contractAddress - The address of the contract to check
+ * @returns true if the contract is AccessControl, false otherwise
+ */
+const isAccessControl = async (contractAddress) => {
+    try {
+        const resolvedAddress = await hardhat_1.ethers.resolveAddress(contractAddress);
+        if (!await (0, utils_1.isContractAddress)(resolvedAddress)) {
+            return false;
+        }
+        const contract = new ethers_1.Contract(resolvedAddress, ACCESS_CONTROL_ABI, hardhat_1.ethers.provider);
+        return await verifyAccessControlInterface(contract, resolvedAddress);
+    }
+    catch {
+        return false;
+    }
+};
+exports.isAccessControl = isAccessControl;
+/*
+ * Checks if a contract implements the AccessManaged interface.
+ * A contract is considered AccessManaged if it has an authority() function
+ * that returns a non-zero address pointing to a manager contract.
+ *
+ * @param contractAddress - The address of the contract to check
+ * @returns true if the contract is AccessManaged, false otherwise
+ */
+const isAccessManaged = async (contractAddress) => {
+    try {
+        const resolvedAddress = await hardhat_1.ethers.resolveAddress(contractAddress);
+        const isContract = await (0, utils_1.isContractAddress)(resolvedAddress);
+        if (!isContract) {
+            return false;
+        }
+        const contract = new ethers_1.Contract(resolvedAddress, ACCESS_MANAGED_ABI, hardhat_1.ethers.provider);
+        /*
+         * Try to call authority() - if it succeeds and returns non-zero address,
+         * The contract is AccessManaged
+         */
+        const authorityAddress = await contract.authority();
+        return await (0, exports.isAccessControl)(authorityAddress);
+    }
+    catch {
+        return false;
+    }
+};
+exports.isAccessManaged = isAccessManaged;
+/*
+ * Transfers ownership of an Ownable contract to a new owner.
+ * This function encodes the transferOwnership call data for the transaction.
+ *
+ * @param contractAddress - The address of the Ownable contract
+ * @param newOwner - The address of the new owner
+ * @returns Transaction object with the encoded transferOwnership call or true
+ * if the new owner is already the desired owner
+ *
+ * @dev The address must have already been verified as an Ownable contract before calling this function.
+ */
+const transferOwnership = async (contractAddress, newOwner) => {
+    const resolvedContractAddress = await hardhat_1.ethers.resolveAddress(contractAddress);
+    const resolvedNewOwner = await hardhat_1.ethers.resolveAddress(newOwner);
+    const contract = new ethers_1.Contract(resolvedContractAddress, OWNABLE_ABI, hardhat_1.ethers.provider);
+    if (await contract.owner() === resolvedNewOwner) {
+        return true;
+    }
+    const data = contract.interface.encodeFunctionData("transferOwnership", [resolvedNewOwner]);
+    console.log(chalk_1.default.green(`Prepared transferOwnership transaction for ${resolvedContractAddress} to new owner ${resolvedNewOwner}`));
+    return {
+        data,
+        "to": resolvedContractAddress
+    };
+};
+exports.transferOwnership = transferOwnership;
+const getPermissionModels = async (address) => {
+    const models = [];
+    if (await (0, exports.isOwnable)(address)) {
+        models.push(PermissionModel.OWNABLE);
+    }
+    if (await (0, exports.isAccessControl)(address)) {
+        models.push(PermissionModel.ROLE_BASED);
+    }
+    if (await (0, exports.isAccessManaged)(address)) {
+        models.push(PermissionModel.ACCESS_MANAGED);
+    }
+    return models;
+};
+exports.getPermissionModels = getPermissionModels;
+//# sourceMappingURL=permission-utils.js.map

package/dist/src/ownership-transfer/permission-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission-utils.js","sourceRoot":"","sources":["../../../src/ownership-transfer/permission-utils.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA6C;AAC7C,mCAA+D;AAC/D,kDAA0B;AAC1B,qCAA+B;AAE/B,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,sDAAsD;IACtD,sCAAmB,CAAA;IACnB,yEAAyE;IACzE,4CAAyB,CAAA;IACzB,oDAAiC,CAAA;AACrC,CAAC,EANW,eAAe,+BAAf,eAAe,QAM1B;AAED;;GAEG;AACH,MAAM,WAAW,GAAG;IAChB,8CAA8C;IAC9C,yCAAyC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,kBAAkB,GAAG;IACvB,qEAAqE;IACrE,mDAAmD;IACnD,oDAAoD;CACvD,CAAC;AAEF;;GAEG;AACH,MAAM,kBAAkB,GAAG;IACvB,6CAA6C;CAChD,CAAC;AAGF,MAAM,sBAAsB,GAAG,KAAK,EAChC,QAAkB,EAClB,eAAuB,EACP,EAAE;IAClB;;OAEG;IACH,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IACrC,IAAI,KAAK,KAAK,gBAAM,CAAC,WAAW,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,OAAO,MAAM,IAAA,2BAAmB,EAAC,eAAe,EAAE,4BAA4B,CAAC,CAAC;AACpF,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,SAAS,GAAG,KAAK,EAAE,eAA4B,EAAoB,EAAE;IAC9E,IAAI,CAAC;QACD,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;QAErE,IAAI,CAAC,MAAM,IAAA,yBAAiB,EAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,iBAAQ,CACzB,eAAe,EACf,WAAW,EACX,gBAAM,CAAC,QAAQ,CAClB,CAAC;QAEF,OAAO,MAAM,sBAAsB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACnE,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,SAAS,aAkBpB;AAEF,MAAM,4BAA4B,GAAG,KAAK,EACtC,QAAkB,EAClB,eAAuB,EACP,EAAE;IAClB;;OAEG;IACH,MAAM,QAAQ,CAAC,OAAO,CAAC,gBAAM,CAAC,QAAQ,EAAE,gBAAM,CAAC,WAAW,CAAC,CAAC;IAE5D;;OAEG;IACH,OAAO,MAAM,IAAA,2BAAmB,EAAC,eAAe,EAAE,4BAA4B,CAAC;QAC3E,MAAM,IAAA,2BAAmB,EAAC,eAAe,EAAE,6BAA6B,CAAC,CAAC;AAClF,CAAC,CAAC;AAEF;;;;;;;GAOG;AACI,MAAM,eAAe,GAAG,KAAK,EAAE,eAA4B,EAAoB,EAAE;IACpF,IAAI,CAAC;QACD,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;QAErE,IAAI,CAAC,MAAM,IAAA,yBAAiB,EAAC,eAAe,CAAC,EAAE,CAAC;YAC5C,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,iBAAQ,CACzB,eAAe,EACf,kBAAkB,EAClB,gBAAM,CAAC,QAAQ,CAClB,CAAC;QAEF,OAAO,MAAM,4BAA4B,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,eAAe,mBAkB1B;AAEF;;;;;;;GAOG;AACI,MAAM,eAAe,GAAG,KAAK,EAAE,eAA4B,EAAoB,EAAE;IACpF,IAAI,CAAC;QACD,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;QAErE,MAAM,UAAU,GAAG,MAAM,IAAA,yBAAiB,EAAC,eAAe,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,iBAAQ,CACzB,eAAe,EACf,kBAAkB,EAClB,gBAAM,CAAC,QAAQ,CAClB,CAAC;QAEF;;;WAGG;QACH,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC;QAEpD,OAAO,MAAM,IAAA,uBAAe,EAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAzBW,QAAA,eAAe,mBAyB1B;AAEF;;;;;;;;;;GAUG;AACI,MAAM,iBAAiB,GAAG,KAAK,EAClC,eAA4B,EAC5B,QAAqB,EAC0B,EAAE;IACjD,MAAM,uBAAuB,GAAG,MAAM,gBAAM,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAC7E,MAAM,gBAAgB,GAAG,MAAM,gBAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAE/D,MAAM,QAAQ,GAAG,IAAI,iBAAQ,CACzB,uBAAuB,EACvB,WAAW,EACX,gBAAM,CAAC,QAAQ,CAClB,CAAC;IAEF,IAAI,MAAM,QAAQ,CAAC,KAAK,EAAE,KAAK,gBAAgB,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAC9C,mBAAmB,EACnB,CAAC,gBAAgB,CAAC,CACrB,CAAC;IAEF,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,KAAK,CACP,8CAA8C,uBAAuB,iBAAiB,gBAAgB,EAAE,CAC3G,CACJ,CAAC;IAEF,OAAO;QACH,IAAI;QACJ,IAAI,EAAE,uBAAuB;KAChC,CAAC;AACN,CAAC,CAAC;AAhCW,QAAA,iBAAiB,qBAgC5B;AAGK,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAoB,EAA8B,EAAE;IAC1F,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,IAAI,MAAM,IAAA,iBAAS,EAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,MAAM,IAAA,uBAAe,EAAC,OAAO,CAAC,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,MAAM,IAAA,uBAAe,EAAC,OAAO,CAAC,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAA;AAhBY,QAAA,mBAAmB,uBAgB/B"}

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

@@ -0,0 +1,16 @@
+import { AddressLike } from "ethers";
+export declare enum Pattern {
+    TUPP = "TUPP",
+    BEACON = "BEACON",
+    REGULAR = "REGULAR"
+}
+export declare const isContractAddress: (address: string) => Promise<boolean>;
+export declare const extractAddressFromSlot: (slotValue: string) => string;
+export declare const getAdminAddress: (address: string) => Promise<string>;
+export declare const getImplementationAddress: (address: string) => Promise<string>;
+export declare const isTUPPPattern: (address: string) => Promise<boolean>;
+export declare const isBeaconPattern: (address: string) => Promise<boolean>;
+export declare const identifyProxyPattern: (address: string) => Promise<Pattern>;
+export declare const promptUserConfirmation: () => Promise<boolean>;
+export declare const detectPattern: (address: AddressLike) => Promise<Pattern>;
+export declare const hasFunctionSelector: (address: string, signature: string) => Promise<boolean>;

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

@@ -0,0 +1,178 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasFunctionSelector = exports.detectPattern = exports.promptUserConfirmation = exports.identifyProxyPattern = exports.isBeaconPattern = exports.isTUPPPattern = exports.getImplementationAddress = exports.getAdminAddress = exports.extractAddressFromSlot = exports.isContractAddress = exports.Pattern = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const hardhat_1 = require("hardhat");
+const readline_1 = __importDefault(require("readline"));
+const ERC1967_ADMIN_SLOT = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
+const ERC1967_IMPLEMENTATION_SLOT = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
+const ERC1967_BEACON_SLOT = "0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50";
+const basicBeaconAbi = [
+    "function owner() view returns (address)",
+    "function implementation() view returns (address)"
+];
+/*
+ * Ethereum addresses are 20 bytes = 40 hex characters
+ * Used for extracting addresses from 32-byte storage slots
+ */
+const ADDRESS_HEX_LENGTH = 40;
+var Pattern;
+(function (Pattern) {
+    Pattern["TUPP"] = "TUPP";
+    Pattern["BEACON"] = "BEACON";
+    Pattern["REGULAR"] = "REGULAR";
+})(Pattern || (exports.Pattern = Pattern = {}));
+const isContractAddress = async (address) => {
+    const code = await hardhat_1.ethers.provider.getCode(address);
+    return code !== "0x" && code !== "0x0";
+};
+exports.isContractAddress = isContractAddress;
+const extractAddressFromSlot = (slotValue) => {
+    const addressHex = `0x${slotValue.slice(-ADDRESS_HEX_LENGTH)}`;
+    return hardhat_1.ethers.getAddress(addressHex);
+};
+exports.extractAddressFromSlot = extractAddressFromSlot;
+const getAdminAddress = async (address) => {
+    const adminSlotValue = await hardhat_1.ethers.provider.getStorage(address, ERC1967_ADMIN_SLOT);
+    return (0, exports.extractAddressFromSlot)(adminSlotValue);
+};
+exports.getAdminAddress = getAdminAddress;
+const getImplementationAddress = async (address) => {
+    const implementationSlotValue = await hardhat_1.ethers.provider.getStorage(address, ERC1967_IMPLEMENTATION_SLOT);
+    return (0, exports.extractAddressFromSlot)(implementationSlotValue);
+};
+exports.getImplementationAddress = getImplementationAddress;
+const validateTUPPProxy = async (proxyAddress, adminAddress) => {
+    const isAdminContract = await (0, exports.isContractAddress)(adminAddress);
+    if (!isAdminContract) {
+        return false;
+    }
+    const implementationAddress = await (0, exports.getImplementationAddress)(proxyAddress);
+    return implementationAddress !== hardhat_1.ethers.ZeroAddress && await (0, exports.isContractAddress)(implementationAddress);
+};
+/*
+ * Checks if the contract follows the Transparent Upgradeable Proxy Pattern.
+ * A TUPP proxy has an admin address in the ERC1967 admin slot.
+ */
+const isTUPPPattern = async (address) => {
+    try {
+        const adminAddress = await (0, exports.getAdminAddress)(address);
+        if (adminAddress === hardhat_1.ethers.ZeroAddress) {
+            return false;
+        }
+        return await validateTUPPProxy(address, adminAddress);
+    }
+    catch {
+        return false;
+    }
+};
+exports.isTUPPPattern = isTUPPPattern;
+/*
+ * Checks if the contract follows the Beacon Proxy Pattern.
+ * A Beacon proxy has a beacon address in the ERC1967 beacon slot,
+ * or it might be a beacon contract itself with an owner() function.
+ */
+const isBeaconPattern = async (address) => {
+    try {
+        // Check beacon slot
+        const beaconSlotValue = await hardhat_1.ethers.provider.getStorage(address, ERC1967_BEACON_SLOT);
+        const beaconAddress = (0, exports.extractAddressFromSlot)(beaconSlotValue);
+        if (beaconAddress === hardhat_1.ethers.ZeroAddress) {
+            return false;
+        }
+        const contract = new hardhat_1.ethers.Contract(address, basicBeaconAbi, hardhat_1.ethers.provider);
+        const [owner, implementation] = await Promise.all([
+            contract.owner(),
+            contract.implementation()
+        ]);
+        return owner !== hardhat_1.ethers.ZeroAddress &&
+            implementation === beaconAddress &&
+            await (0, exports.isContractAddress)(implementation);
+    }
+    catch {
+        return false;
+    }
+};
+exports.isBeaconPattern = isBeaconPattern;
+/*
+ * Identifies the proxy pattern for a given address by checking:
+ * 1. TUPP (Transparent Upgradeable Proxy Pattern)
+ * 2. BEACON pattern
+ * 3. REGULAR (non-proxy contract)
+ */
+const identifyProxyPattern = async (address) => {
+    const isTUPP = await (0, exports.isTUPPPattern)(address);
+    if (isTUPP) {
+        return Pattern.TUPP;
+    }
+    const isBeacon = await (0, exports.isBeaconPattern)(address);
+    if (isBeacon) {
+        return Pattern.BEACON;
+    }
+    return Pattern.REGULAR;
+};
+exports.identifyProxyPattern = identifyProxyPattern;
+/*
+ * Prompts the user for confirmation via command line input.
+ * Accepts "yes" or "y" (case-insensitive) as confirmation.
+ * Returns a Promise that resolves to true if confirmed, false otherwise.
+ */
+const promptUserConfirmation = () => {
+    const rl = readline_1.default.createInterface({
+        "input": process.stdin,
+        "output": process.stdout
+    });
+    return new Promise((resolve) => {
+        rl.question(chalk_1.default.yellow("Do you confirm these findings? (yes/y to confirm): "), (answer) => {
+            rl.close();
+            const normalizedAnswer = answer.trim().toLowerCase();
+            resolve(normalizedAnswer === "yes" || normalizedAnswer === "y");
+        });
+    });
+};
+exports.promptUserConfirmation = promptUserConfirmation;
+/*
+ * Detects the proxy pattern used by a contract at the given address.
+ */
+const detectPattern = async (address) => {
+    try {
+        const resolvedAddress = await hardhat_1.ethers.resolveAddress(address);
+        const isContract = await (0, exports.isContractAddress)(resolvedAddress);
+        if (!isContract) {
+            throw new Error(`Address ${address} is not a contract. Stopping...`);
+        }
+        return await (0, exports.identifyProxyPattern)(resolvedAddress);
+    }
+    catch (error) {
+        console.error(`Error detecting pattern for address ${address}:`, error);
+        return Pattern.REGULAR;
+    }
+};
+exports.detectPattern = detectPattern;
+const hasFunctionSelector = async (address, signature) => {
+    const iface = new hardhat_1.ethers.Interface([`function ${signature}`]);
+    const { selector } = iface.getFunction(signature) || {};
+    if (!selector) {
+        throw new Error(`Invalid function signature: ${signature}`);
+    }
+    try {
+        // Empty arguments used — we just want to test if the selector is valid
+        const result = await hardhat_1.ethers.provider.call({
+            data: selector,
+            to: address
+        });
+        if (result === "0x") {
+            return false;
+        }
+        return true;
+    }
+    catch (err) {
+        // Reverted = function exists, but call params invalid
+        return true;
+    }
+};
+exports.hasFunctionSelector = hasFunctionSelector;
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/ownership-transfer/utils.ts"],"names":[],"mappings":";;;;;;AAEA,kDAA0B;AAC1B,qCAA+B;AAC/B,wDAAgC;AAEhC,MAAM,kBAAkB,GAAG,oEAAoE,CAAC;AAChG,MAAM,2BAA2B,GAAG,oEAAoE,CAAC;AACzG,MAAM,mBAAmB,GAAG,oEAAoE,CAAC;AAGjG,MAAM,cAAc,GAAG;IACnB,yCAAyC;IACzC,kDAAkD;CACrD,CAAC;AAEF;;;GAGG;AACH,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,IAAY,OAIX;AAJD,WAAY,OAAO;IACf,wBAAa,CAAA;IACb,4BAAiB,CAAA;IACjB,8BAAmB,CAAA;AACvB,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AAEM,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAAe,EAAoB,EAAE;IACzE,MAAM,IAAI,GAAG,MAAM,gBAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpD,OAAO,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC;AAC3C,CAAC,CAAC;AAHW,QAAA,iBAAiB,qBAG5B;AAEK,MAAM,sBAAsB,GAAG,CAAC,SAAiB,EAAU,EAAE;IAChE,MAAM,UAAU,GAAG,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC/D,OAAO,gBAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AACzC,CAAC,CAAC;AAHW,QAAA,sBAAsB,0BAGjC;AAEK,MAAM,eAAe,GAAG,KAAK,EAAE,OAAe,EAAmB,EAAE;IACtE,MAAM,cAAc,GAAG,MAAM,gBAAM,CAAC,QAAQ,CAAC,UAAU,CACnD,OAAO,EACP,kBAAkB,CACrB,CAAC;IACF,OAAO,IAAA,8BAAsB,EAAC,cAAc,CAAC,CAAC;AAClD,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B;AAEK,MAAM,wBAAwB,GAAG,KAAK,EAAE,OAAe,EAAmB,EAAE;IAC/E,MAAM,uBAAuB,GAAG,MAAM,gBAAM,CAAC,QAAQ,CAAC,UAAU,CAC5D,OAAO,EACP,2BAA2B,CAC9B,CAAC;IACF,OAAO,IAAA,8BAAsB,EAAC,uBAAuB,CAAC,CAAC;AAC3D,CAAC,CAAC;AANW,QAAA,wBAAwB,4BAMnC;AAEF,MAAM,iBAAiB,GAAG,KAAK,EAC3B,YAAoB,EACpB,YAAoB,EACJ,EAAE;IAClB,MAAM,eAAe,GAAG,MAAM,IAAA,yBAAiB,EAAC,YAAY,CAAC,CAAC;IAE9D,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,qBAAqB,GAAG,MAAM,IAAA,gCAAwB,EAAC,YAAY,CAAC,CAAC;IAC3E,OAAO,qBAAqB,KAAK,gBAAM,CAAC,WAAW,IAAI,MAAM,IAAA,yBAAiB,EAAC,qBAAqB,CAAC,CAAC;AAC1G,CAAC,CAAC;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,OAAe,EAAoB,EAAE;IACrE,IAAI,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,IAAA,uBAAe,EAAC,OAAO,CAAC,CAAC;QAEpD,IAAI,YAAY,KAAK,gBAAM,CAAC,WAAW,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,MAAM,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAZW,QAAA,aAAa,iBAYxB;AAEF;;;;GAIG;AACI,MAAM,eAAe,GAAG,KAAK,EAAE,OAAe,EAAoB,EAAE;IACvE,IAAI,CAAC;QACD,oBAAoB;QACpB,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,QAAQ,CAAC,UAAU,CACpD,OAAO,EACP,mBAAmB,CACtB,CAAC;QAEF,MAAM,aAAa,GAAG,IAAA,8BAAsB,EAAC,eAAe,CAAC,CAAC;QAE9D,IAAI,aAAa,KAAK,gBAAM,CAAC,WAAW,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,gBAAM,CAAC,QAAQ,CAChC,OAAO,EACP,cAAc,EACd,gBAAM,CAAC,QAAQ,CAClB,CAAC;QAEF,MAAM,CAAC,KAAK,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC9C,QAAQ,CAAC,KAAK,EAAE;YAChB,QAAQ,CAAC,cAAc,EAAE;SAC5B,CAAC,CAAC;QAEH,OAAO,KAAK,KAAK,gBAAM,CAAC,WAAW;YAC/B,cAAc,KAAK,aAAa;YAChC,MAAM,IAAA,yBAAiB,EAAC,cAAc,CAAC,CAAC;IAChD,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AA/BW,QAAA,eAAe,mBA+B1B;AAEF;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,KAAK,EAAE,OAAe,EAAoB,EAAE;IAC5E,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,MAAM,EAAE,CAAC;QACT,OAAO,OAAO,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAe,EAAC,OAAO,CAAC,CAAC;IAChD,IAAI,QAAQ,EAAE,CAAC;QACX,OAAO,OAAO,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED,OAAO,OAAO,CAAC,OAAO,CAAC;AAC3B,CAAC,CAAC;AAZW,QAAA,oBAAoB,wBAY/B;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,GAAqB,EAAE;IACzD,MAAM,EAAE,GAAG,kBAAQ,CAAC,eAAe,CAAC;QAChC,OAAO,EAAE,OAAO,CAAC,KAAK;QACtB,QAAQ,EAAE,OAAO,CAAC,MAAM;KAC3B,CAAC,CAAC;IAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,EAAE,CAAC,QAAQ,CACP,eAAK,CAAC,MAAM,CAAC,qDAAqD,CAAC,EACnE,CAAC,MAAM,EAAE,EAAE;YACP,EAAE,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACrD,OAAO,CAAC,gBAAgB,KAAK,KAAK,IAAI,gBAAgB,KAAK,GAAG,CAAC,CAAC;QACpE,CAAC,CACJ,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAhBW,QAAA,sBAAsB,0BAgBjC;AAGF;;GAEG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,OAAoB,EAAoB,EAAE;IAC1E,IAAI,CAAC;QACD,MAAM,eAAe,GAAG,MAAM,gBAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,MAAM,IAAA,yBAAiB,EAAC,eAAe,CAAC,CAAC;QAE5D,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,iCAAiC,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,MAAM,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAC;IACvD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,uCAAuC,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;QACxE,OAAO,OAAO,CAAC,OAAO,CAAC;IAC3B,CAAC;AACL,CAAC,CAAA;AAdY,QAAA,aAAa,iBAczB;AAEM,MAAM,mBAAmB,GAAG,KAAK,EAAE,OAAe,EAAE,SAAiB,EAAoB,EAAE;IAC9F,MAAM,KAAK,GAAG,IAAI,gBAAM,CAAC,SAAS,CAAC,CAAC,YAAY,SAAS,EAAE,CAAC,CAAC,CAAC;IAC9D,MAAM,EAAC,QAAQ,EAAC,GAAG,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAEtD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,+BAA+B,SAAS,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,CAAC;QACD,uEAAuE;QACvE,MAAM,MAAM,GAAG,MAAM,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtC,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,OAAO;SACd,CAAC,CAAC;QACH,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,sDAAsD;QACtD,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC,CAAA;AAtBY,QAAA,mBAAmB,uBAsB/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skalenetwork/upgrade-tools",
-  "version": "4.0.0-develop.2",
+  "version": "4.0.0-ownership-helpers.0",
   "description": "Scripts to support upgrades of smart contracts",
   "files": [
     "dist/**/*"
@@ -45,7 +45,7 @@
     "@safe-global/api-kit": "^2.4.1",
     "@safe-global/protocol-kit": "^5.0.1",
     "@safe-global/safe-core-sdk-types": "^5.0.1",
-    "@skalenetwork/skale-contracts-ethers-v6": "^2.0.0-develop.1",
+    "@skalenetwork/skale-contracts-ethers-v6": "^2.0.0-develop.6",
     "@types/mocha": "^9.1.0",
     "axios": "^1.4.0",
     "ethereumjs-util": "^7.1.4",