@skalenetwork/upgrade-tools 4.0.0-update-verify.6 → 4.0.0-update-gnosis-service.1

package/dist/src/contractVerifier.d.ts

@@ -1,14 +1,26 @@
-import { VerificationTarget } from "./verification";
-export declare class ContractVerifier {
-    private readonly contractName;
-    private readonly contractAddress;
-    private readonly apiURL;
-    private readonly browserURL;
-    private readonly isEtherscan;
-    private readonly etherscan;
-    constructor(target: VerificationTarget);
-    private isAlreadyVerified;
-    private submitVerification;
+import { ValidationResponse } from "@nomicfoundation/hardhat-verify/internal/utilities";
+export interface VerificationTarget {
+    contractName: string;
+    contractAddress: string;
+    constructorArguments?: string;
+}
+export interface VerificationRequestParameters {
+    solcInputJson: string;
+    fullContractName: string;
+    compilerVersion: string;
+}
+export declare abstract class ContractVerifier {
+    abstract name: string;
+    private readonly PROXY_CONTRACT_NAME;
+    verify: (verificationTarget: VerificationTarget, attempts?: number) => Promise<void>;
+    attemptVerification(verificationTarget: VerificationTarget): Promise<boolean>;
+    protected abstract isAlreadyVerified(verificationTarget: VerificationTarget): Promise<boolean>;
+    protected abstract submitVerificationRequest(target: VerificationTarget, params: VerificationRequestParameters): Promise<ValidationResponse>;
+    protected abstract getContractUrl(verificationTarget: VerificationTarget): string;
+    protected getVerifyParameters(contractName: string): Promise<{
+        compilerVersion: string;
+        fullContractName: string;
+        solcInputJson: string;
+    }>;
     private checkVerificationStatus;
-    attempt(): Promise<boolean>;
 }

package/dist/src/contractVerifier.js

@@ -4,63 +4,67 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContractVerifier = void 0;
-const verification_1 = require("./verification");
-const etherscan_1 = require("@nomicfoundation/hardhat-verify/etherscan");
+const hardhat_1 = require("hardhat");
 const chalk_1 = __importDefault(require("chalk"));
+const TransparentUpgradeableProxy_json_1 = __importDefault(require("@openzeppelin/upgrades-core/artifacts/@openzeppelin/contracts-v5/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json"));
+const build_info_v5_json_1 = __importDefault(require("@openzeppelin/upgrades-core/artifacts/build-info-v5.json"));
+const DEFAULT_RETRIES_AMOUNT = 5;
 class ContractVerifier {
-    constructor(target) {
-        this.contractName = target.contractName;
-        this.contractAddress = target.contractAddress;
-        this.apiURL = target.explorerUrls.apiURL;
-        this.browserURL = target.explorerUrls.browserURL;
-        this.isEtherscan = Boolean(target.isEtherscan);
-        this.etherscan = new etherscan_1.Etherscan(process.env.ETHERSCAN ?? "", this.apiURL, this.browserURL, target.chainId);
+    constructor() {
+        this.PROXY_CONTRACT_NAME = "TransparentUpgradeableProxy";
+        this.verify = async (verificationTarget, attempts = DEFAULT_RETRIES_AMOUNT) => {
+            const limit = 0;
+            if (attempts > limit) {
+                if (!await this.attemptVerification(verificationTarget)) {
+                    const failedAttempts = 1;
+                    await this.verify(verificationTarget, attempts - failedAttempts);
+                }
+            }
+        };
     }
-    async isAlreadyVerified() {
-        let verified = false;
-        if (this.isEtherscan) {
-            verified = await this.etherscan.isVerified(this.contractAddress);
-        }
-        if (!verified) {
-            verified = await (0, verification_1.isVerifiedOnBlockscout)(this.apiURL, this.contractAddress);
-        }
-        if (verified) {
-            console.log(`${this.contractName} is already verified on: ${this.etherscan.getContractUrl(this.contractAddress)}`);
+    async attemptVerification(verificationTarget) {
+        if (await this.isAlreadyVerified(verificationTarget)) {
+            console.log(chalk_1.default.cyan(`${verificationTarget.contractName} is already verified on ${this.name}:\n${this.getContractUrl(verificationTarget)}`));
+            return true;
         }
-        return verified;
-    }
-    async submitVerification(params) {
+        const params = await this.getVerifyParameters(verificationTarget.contractName);
         try {
-            const res = await this.etherscan.verify(this.contractAddress, params.solcInputJson, params.fullContractName, params.compilerVersion, "");
-            return res.message;
+            const response = await this.submitVerificationRequest(verificationTarget, params);
+            return this.checkVerificationStatus(verificationTarget, response);
         }
         catch (error) {
-            console.log(chalk_1.default.yellow(`Verification attempt for ${this.contractName} failed with error: ${error}`));
-            return null;
-        }
-    }
-    async checkVerificationStatus(guid) {
-        const status = await this.etherscan.getVerificationStatus(guid);
-        if (status.isFailure()) {
-            console.log(chalk_1.default.red(`Failed to verify contract ${this.contractName}`));
+            console.log(chalk_1.default.yellow(`Verification attempt for ${verificationTarget.contractName} failed on ${this.name} with error: ${error}`));
             return false;
         }
-        console.log(`${this.contractName} is successfully verified on: ${this.etherscan.getContractUrl(this.contractAddress)}`);
-        return true;
     }
-    async attempt() {
-        if (await this.isAlreadyVerified()) {
-            return true;
+    async getVerifyParameters(contractName) {
+        if (contractName === this.PROXY_CONTRACT_NAME) {
+            return {
+                compilerVersion: build_info_v5_json_1.default.solcLongVersion,
+                fullContractName: `${TransparentUpgradeableProxy_json_1.default.sourceName}:${contractName}`,
+                solcInputJson: JSON.stringify(build_info_v5_json_1.default.input)
+            };
         }
-        const params = await (0, verification_1.getVerifyParameters)(this.contractName);
-        if (this.isEtherscan) {
-            params.compilerVersion = `v${params.compilerVersion}`;
+        const artifact = await hardhat_1.artifacts.readArtifact(contractName);
+        const fullContractName = `${artifact.sourceName}:${contractName}`;
+        const buildInfo = await hardhat_1.artifacts.getBuildInfo(fullContractName);
+        if (!buildInfo) {
+            throw new Error(`No build-info for ${contractName}`);
         }
-        const guid = await this.submitVerification(params);
-        if (!guid) {
+        return {
+            compilerVersion: buildInfo.solcLongVersion,
+            fullContractName,
+            solcInputJson: JSON.stringify(buildInfo.input)
+        };
+    }
+    // Private
+    checkVerificationStatus(verificationTarget, response) {
+        if (response.isFailure()) {
+            console.log(chalk_1.default.red(`Failed to verify contract ${verificationTarget.contractName}`));
             return false;
         }
-        return this.checkVerificationStatus(guid);
+        console.log(chalk_1.default.cyan(`${verificationTarget.contractName} is successfully verified on ${this.name}:\n${this.getContractUrl(verificationTarget)}`));
+        return true;
     }
 }
 exports.ContractVerifier = ContractVerifier;

package/dist/src/contractVerifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"contractVerifier.js","sourceRoot":"","sources":["../../src/contractVerifier.ts"],"names":[],"mappings":";;;;;;AAAA,iDAIwB;AACxB,yEAAoE;AACpE,kDAA0B;AAE1B,MAAa,gBAAgB;IAQzB,YAAY,MAA0B;QAClC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAC1B,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,EAC3B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,UAAU,EACf,MAAM,CAAC,OAAO,CACjB,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC3B,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrE,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,QAAQ,GAAG,MAAM,IAAA,qCAAsB,EACnC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,eAAe,CACvB,CAAC;QACN,CAAC;QACD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,GAAG,CACP,GAAG,IAAI,CAAC,YAAY,4BAA4B,IAAI,CAAC,SAAS,CAAC,cAAc,CACzE,IAAI,CAAC,eAAe,CACvB,EAAE,CACN,CAAC;QACN,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,MAIhC;QACG,IAAI,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CACnC,IAAI,CAAC,eAAe,EACpB,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,gBAAgB,EACvB,MAAM,CAAC,eAAe,EACtB,EAAE,CACL,CAAC;YACF,OAAO,GAAG,CAAC,OAAO,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,MAAM,CACR,4BAA4B,IAAI,CAAC,YAAY,uBAAuB,KAAK,EAAE,CAC9E,CACJ,CAAC;YACF,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,uBAAuB,CAAC,IAAY;QAC9C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAEhE,IAAI,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,OAAO,CAAC,GAAG,CACP,eAAK,CAAC,GAAG,CAAC,6BAA6B,IAAI,CAAC,YAAY,EAAE,CAAC,CAC9D,CAAC;YACF,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,CAAC,GAAG,CACP,GAAG,IAAI,CAAC,YAAY,iCAAiC,IAAI,CAAC,SAAS,CAAC,cAAc,CAC9E,IAAI,CAAC,eAAe,CACvB,EAAE,CACN,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,OAAO;QAChB,IAAI,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAA,kCAAmB,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,MAAM,CAAC,eAAe,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC1D,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;CACJ;AAtGD,4CAsGC"}
+{"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/gnosis-safe.js

@@ -5,38 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMultiSendTransaction = void 0;
 const safe_core_sdk_types_1 = require("@safe-global/safe-core-sdk-types");
-const ethers_1 = require("ethers");
 const hardhat_1 = require("hardhat");
 const protocol_kit_1 = __importDefault(require("@safe-global/protocol-kit"));
 const api_kit_1 = __importDefault(require("@safe-global/api-kit"));
 // Cspell:words arbitrum celo sepolia xdai holesky
-// Constants
-const URLS = {
-    "safe_transaction": {
-        [ethers_1.Network.from("mainnet").chainId.toString()]: "https://safe-transaction-mainnet.safe.global/api",
-        [ethers_1.Network.from("arbitrum").chainId.toString()]: "https://safe-transaction-arbitrum.safe.global/api",
-        [ethers_1.Network.from("base").chainId.toString()]: "https://safe-transaction-base.safe.global/api",
-        [ethers_1.Network.from("base-sepolia").chainId.toString()]: "https://safe-transaction-base-sepolia.safe.global/api",
-        [ethers_1.Network.from("bnb").chainId.toString()]: "https://safe-transaction-bsc.safe.global/api",
-        [ethers_1.Network.from("xdai").chainId.toString()]: "https://safe-transaction-gnosis-chain.safe.global/api",
-        [ethers_1.Network.from("optimism").chainId.toString()]: "https://safe-transaction-optimism.safe.global/api",
-        [ethers_1.Network.from("matic").chainId.toString()]: "https://safe-transaction-polygon.safe.global/api",
-        [ethers_1.Network.from("sepolia").chainId.toString()]: "https://safe-transaction-sepolia.safe.global/api",
-        [ethers_1.Network.from("holesky").chainId.toString()]: "https://transaction-holesky.holesky-safe.protofire.io/api",
-        // Aurora
-        "0x4e454152": "https://safe-transaction-aurora.safe.global/api",
-        // Polygon zkEVM
-        "1101": "https://safe-transaction-zkevm.safe.global/api",
-        // ZkSync Era Mainnet
-        "324": "https://safe-transaction-zksync.safe.global/api",
-        // Celo
-        "42220": "https://safe-transaction-celo.safe.global/api",
-        // Avalanche
-        "43114": "https://safe-transaction-avalanche.safe.global/api",
-        // Scroll
-        "534352": "https://safe-transaction-scroll.safe.global/api",
-    }
-};
 const defaultOptions = {
     /*
      * Gas costs not related to the transaction execution
@@ -69,17 +41,14 @@ const getSafeTransactionData = (transactions) => {
     }
     return safeTransactionData;
 };
-const getSafeTransactionUrl = (chainId) => {
-    if (Object.keys(URLS.safe_transaction).includes(chainId.toString())) {
-        return URLS.safe_transaction[Number(chainId)];
-    }
-    throw Error("Can't get Safe Transaction Service url" +
-        ` at network with chainId = ${chainId}`);
-};
 const getSafeService = (chainId) => {
+    if (!process.env.GNOSIS_API_KEY) {
+        throw new Error("GNOSIS_API_KEY is not set");
+    }
     const safeService = new api_kit_1.default({
+        apiKey: process.env.GNOSIS_API_KEY,
         chainId,
-        "txServiceUrl": getSafeTransactionUrl(chainId)
+        // Does not need the URL - chainId is enough
     });
     return safeService;
 };
@@ -111,7 +80,7 @@ const createMultiSendTransaction = async (safeAddress, chainId, transactions) =>
              * Transaction cannot be executed until
              * Safe's nonce is not equal to this nonce
              */
-            nonce
+            nonce: parseInt(nonce, 10)
         }
     };
     const safeSdk = await protocol_kit_1.default.init({

package/dist/src/gnosis-safe.js.map

@@ -1 +1 @@
-{"version":3,"file":"gnosis-safe.js","sourceRoot":"","sources":["../../src/gnosis-safe.ts"],"names":[],"mappings":";;;;;;AAAA,0EAI0C;AAC1C,mCAA4C;AAC5C,qCAAwC;AACxC,6EAA6C;AAC7C,mEAA8C;AAE9C,kDAAkD;AAElD,YAAY;AAEZ,MAAM,IAAI,GAAG;IACT,kBAAkB,EAAE;QAChB,CAAC,gBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACxC,kDAAkD;QACtD,CAAC,gBAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACzC,mDAAmD;QACvD,CAAC,gBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACrC,+CAA+C;QACnD,CAAC,gBAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAC7C,uDAAuD;QAC3D,CAAC,gBAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACpC,8CAA8C;QAClD,CAAC,gBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACrC,uDAAuD;QAC3D,CAAC,gBAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACzC,mDAAmD;QACvD,CAAC,gBAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACtC,kDAAkD;QACtD,CAAC,gBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACxC,kDAAkD;QACtD,CAAC,gBAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EACxC,2DAA2D;QAC/D,SAAS;QACT,YAAY,EACR,iDAAiD;QACrD,gBAAgB;QAChB,MAAM,EACF,gDAAgD;QACpD,qBAAqB;QACrB,KAAK,EACD,iDAAiD;QACrD,OAAO;QACP,OAAO,EACH,+CAA+C;QACnD,YAAY;QACZ,OAAO,EACH,oDAAoD;QACxD,SAAS;QACT,QAAQ,EACJ,iDAAiD;KACxD;CACJ,CAAC;AAEF,MAAM,cAAc,GAAG;IAEnB;;;OAGG;IACH,SAAS,EAAE,GAAG;IAEd,4CAA4C;IAC5C,UAAU,EAAE,GAAG;IAEf;;;;OAIG;IACH,UAAU,EAAE,gBAAM,CAAC,WAAW;IAE9B,8DAA8D;IAC9D,gBAAgB,EAAE,gBAAM,CAAC,WAAW;IAEpC,oCAAoC;IACpC,WAAW,EAAE,GAAG;CACnB,CAAC;AAEF,oBAAoB;AAEpB,MAAM,sBAAsB,GAAG,CAAC,YAA2B,EAAE,EAAE;IAC3D,MAAM,mBAAmB,GAA0B,EAAE,CAAC;IACtD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACrC,mBAAmB,CAAC,IAAI,CAAC;YACrB,MAAM,EAAE,WAAW,CAAC,IAAI;YACxB,WAAW,EAAE,mCAAa,CAAC,IAAI;YAC/B,IAAI,EAAE,WAAW,CAAC,EAAE,IAAI,gBAAM,CAAC,WAAW;YAC1C,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE;SACxC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,mBAAmB,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,EAAE;IAC9C,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;QAClE,OAAO,IAAI,CAAC,gBAAgB,CACxB,MAAM,CAAC,OAAO,CAAuC,CACxD,CAAC;IACN,CAAC;IACD,MAAM,KAAK,CAAC,wCAAwC;QAChD,8BAA8B,OAAO,EAAE,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAe,EAAE,EAAE;IACvC,MAAM,WAAW,GAAG,IAAI,iBAAU,CAAC;QAC/B,OAAO;QACP,cAAc,EAAE,qBAAqB,CAAC,OAAO,CAAC;KACjD,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAC5B,WAAmB,EACnB,OAAe,EACf,eAAgC,EAClC,EAAE;IACA,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,gBAAM,CAAC,UAAU,EAAE,CAAC;IAC9C,MAAM,OAAO,GAAG,MAAM,sBAAI,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,iBAAO,CAAC,QAAQ,EAAE,WAAW,EAAC,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACrE,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC3D,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,WAAW,CAAC,kBAAkB,CAAC;QACjC,WAAW;QACX,qBAAqB,EAAE,eAAe,CAAC,IAAI;QAC3C,UAAU;QACV,eAAe,EAAE,SAAS,CAAC,OAAO;QAClC,iBAAiB,EAAE,eAAe,CAAC,IAAI;KAC1C,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,mBAAmB;AAEZ,MAAM,0BAA0B,GAAG,KAAK,EAC3C,WAAmB,EACnB,OAAe,EACf,YAA2B,EAC7B,EAAE;IACA,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;IACjE,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,CACP,mCAAmC,EACnC,KAAK,CACR,CAAC;IAEF,MAAM,OAAO,GAAG;QACZ,GAAG,cAAc;QACjB,GAAG;YAEC;;;;eAIG;YACH,KAAK;SACR;KACJ,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,sBAAI,CAAC,IAAI,CAAC;QAC5B,QAAQ,EAAE,iBAAO,CAAC,QAAQ;QAC1B,WAAW;KACd,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,iBAAiB,CAAC;QACpD,OAAO;QACP,YAAY,EAAE,mBAAmB;KACpC,CAAC,CAAC;IAEH,MAAM,kBAAkB,CACpB,WAAW,EACX,OAAO,EACP,eAAe,CAClB,CAAC;AACN,CAAC,CAAC;AAvCW,QAAA,0BAA0B,8BAuCrC"}
+{"version":3,"file":"gnosis-safe.js","sourceRoot":"","sources":["../../src/gnosis-safe.ts"],"names":[],"mappings":";;;;;;AAAA,0EAI0C;AAC1C,qCAAwC;AACxC,6EAA6C;AAC7C,mEAA8C;AAG9C,kDAAkD;AAElD,MAAM,cAAc,GAAG;IAEnB;;;OAGG;IACH,SAAS,EAAE,GAAG;IAEd,4CAA4C;IAC5C,UAAU,EAAE,GAAG;IAEf;;;;OAIG;IACH,UAAU,EAAE,gBAAM,CAAC,WAAW;IAE9B,8DAA8D;IAC9D,gBAAgB,EAAE,gBAAM,CAAC,WAAW;IAEpC,oCAAoC;IACpC,WAAW,EAAE,GAAG;CACnB,CAAC;AAEF,oBAAoB;AAEpB,MAAM,sBAAsB,GAAG,CAAC,YAA2B,EAAE,EAAE;IAC3D,MAAM,mBAAmB,GAA0B,EAAE,CAAC;IACtD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACrC,mBAAmB,CAAC,IAAI,CAAC;YACrB,MAAM,EAAE,WAAW,CAAC,IAAI;YACxB,WAAW,EAAE,mCAAa,CAAC,IAAI;YAC/B,IAAI,EAAE,WAAW,CAAC,EAAE,IAAI,gBAAM,CAAC,WAAW;YAC1C,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE;SACxC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,mBAAmB,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,OAAe,EAAE,EAAE;IACvC,IAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,WAAW,GAAG,IAAI,iBAAU,CAAC;QAC/B,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;QAClC,OAAO;QACP,4CAA4C;KAC/C,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAC5B,WAAmB,EACnB,OAAe,EACf,eAAgC,EAClC,EAAE;IACA,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,gBAAM,CAAC,UAAU,EAAE,CAAC;IAC9C,MAAM,OAAO,GAAG,MAAM,sBAAI,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,iBAAO,CAAC,QAAQ,EAAE,WAAW,EAAC,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACrE,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC3D,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,WAAW,CAAC,kBAAkB,CAAC;QACjC,WAAW;QACX,qBAAqB,EAAE,eAAe,CAAC,IAAI;QAC3C,UAAU;QACV,eAAe,EAAE,SAAS,CAAC,OAAO;QAClC,iBAAiB,EAAE,eAAe,CAAC,IAAI;KAC1C,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,mBAAmB;AAEZ,MAAM,0BAA0B,GAAG,KAAK,EAC3C,WAAmB,EACnB,OAAe,EACf,YAA2B,EAC7B,EAAE;IACA,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;IACjE,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,CACP,mCAAmC,EACnC,KAAK,CACR,CAAC;IAEF,MAAM,OAAO,GAAG;QACZ,GAAG,cAAc;QACjB,GAAG;YAEC;;;;eAIG;YACH,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;SAC7B;KACJ,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,sBAAI,CAAC,IAAI,CAAC;QAC5B,QAAQ,EAAE,iBAAO,CAAC,QAAQ;QAC1B,WAAW;KACd,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,iBAAiB,CAAC;QACpD,OAAO;QACP,YAAY,EAAE,mBAAmB;KACpC,CAAC,CAAC;IAEH,MAAM,kBAAkB,CACpB,WAAW,EACX,OAAO,EACP,eAAe,CAClB,CAAC;AACN,CAAC,CAAC;AAvCW,QAAA,0BAA0B,8BAuCrC"}

package/dist/src/index.d.ts

@@ -1,7 +1,11 @@
 export * from "./abi";
 export * from "./deploy";
 export * from "./gnosis-safe";
+export * from "./proxyUpgrader";
 export * from "./submitters";
 export * from "./verification";
 export * from "./version";
 export * from "./upgrader";
+export * from "./upgraders/abstractTransparentProxyUpgrader";
+export * from "./upgraders/beaconUpgrader";
+export * from "./ownership-transfer/instanceAdmin";

package/dist/src/index.js

@@ -17,8 +17,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./abi"), exports);
 __exportStar(require("./deploy"), exports);
 __exportStar(require("./gnosis-safe"), exports);
+__exportStar(require("./proxyUpgrader"), exports);
 __exportStar(require("./submitters"), exports);
 __exportStar(require("./verification"), exports);
 __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,+CAA6B;AAC7B,iDAA+B;AAC/B,4CAA0B;AAC1B,6CAA2B"}
+{"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"}