@maci-protocol/contracts 0.0.0-ci.2653bc0

package/build/tasks/helpers/ContractStorage.js

@@ -0,0 +1,240 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractStorage = void 0;
+/* eslint-disable import/no-extraneous-dependencies, no-console */
+const lowdb_1 = __importDefault(require("lowdb"));
+const FileSync_1 = __importDefault(require("lowdb/adapters/FileSync"));
+const LocalStorage_1 = __importDefault(require("lowdb/adapters/LocalStorage"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("../../ts/logger");
+/**
+ * @notice Contract storage keeps all deployed contracts with addresses, arguments in the json file.
+ * This class is using for incremental deployment and verification.
+ */
+class ContractStorage {
+    /**
+     * Initialize class properties only once
+     */
+    constructor(storagePath) {
+        /**
+         * Set contract verification in the json file
+         *
+         * @param address - contract address
+         * @param network - selected network
+         * @param verified - verified or not
+         */
+        this.setVerified = (address, network, verified) => {
+            this.db.set(`${network}.verified.${address}`, verified).write();
+        };
+        this.db = (0, lowdb_1.default)(typeof window !== "undefined"
+            ? new LocalStorage_1.default("deployed-contracts")
+            : new FileSync_1.default(storagePath ?? path_1.default.resolve(process.cwd(), "./deployed-contracts.json")));
+    }
+    /**
+     * Get singleton object
+     *
+     * @param storagePath - path to the storage file
+     * @returns {ContractStorage} singleton object
+     */
+    static getInstance(storagePath) {
+        if (!ContractStorage.INSTANCE) {
+            ContractStorage.INSTANCE = new ContractStorage(storagePath);
+        }
+        return ContractStorage.INSTANCE;
+    }
+    /**
+     * Register contract and save contract address, constructor args in the json file
+     *
+     * @param {IRegisterContract} args - register arguments
+     */
+    async register({ id, key, contract, network, args, name }) {
+        const contractAddress = await contract.getAddress();
+        const deploymentTx = contract.deploymentTransaction();
+        const contractId = String(id);
+        (0, logger_1.logMagenta)({ text: `*** ${contractId} ***\n` });
+        (0, logger_1.logMagenta)({ text: `Network: ${network}` });
+        (0, logger_1.logMagenta)({ text: `contract address: ${contractAddress}` });
+        if (deploymentTx) {
+            (0, logger_1.logMagenta)({ text: `tx: ${deploymentTx.hash}` });
+            (0, logger_1.logMagenta)({ text: `deployer address: ${deploymentTx.from}` });
+            (0, logger_1.logMagenta)({ text: `gas price: ${deploymentTx.gasPrice}` });
+            (0, logger_1.logMagenta)({ text: `gas used: ${deploymentTx.gasLimit}` });
+        }
+        (0, logger_1.logMagenta)({ text: `\n******\n` });
+        const logEntry = {
+            id: contractId,
+            deploymentTxHash: deploymentTx?.hash,
+        };
+        if (args !== undefined) {
+            logEntry.verify = {
+                name,
+                args: JSON.stringify(args),
+            };
+        }
+        this.db.set(`${network}.instance.${contractAddress}`, logEntry).write();
+        const namedEntry = this.db.get(`${network}.named.${contractId}${key !== undefined ? `.${key}` : ""}`).value();
+        const count = namedEntry?.count ?? 0;
+        this.db
+            .set(`${network}.named.${contractId}${key !== undefined ? `.${key}` : ""}`, {
+            address: contractAddress,
+            count: count + 1,
+        })
+            .write();
+    }
+    /**
+     * Get contract instances from the json file
+     *
+     * @param network - selected network
+     * @returns {[string, IStorageInstanceEntry][]} storage instance entries
+     */
+    getInstances(network) {
+        const collection = this.db.get(`${network}.instance`);
+        const value = collection.value();
+        return Object.entries(value || []);
+    }
+    /**
+     * Check if contract is verified or not locally
+     *
+     * @param address - contract address
+     * @param network - selected network
+     * @returns contract verified or not
+     */
+    getVerified(address, network) {
+        return this.db.get(`${network}.verified.${address}`).value();
+    }
+    /**
+     * Get deployment arguments from the json file
+     *
+     * @param id - contract name
+     * @param network - selected network
+     * @param key - contract key
+     * @returns deployment arguments
+     */
+    getContractArgs(id, network, key) {
+        const address = this.getAddress(id, network, key);
+        const collection = this.db.get(`${network}.instance.${address}`);
+        const instanceEntry = collection.value();
+        if (!instanceEntry?.verify?.args) {
+            return undefined;
+        }
+        return JSON.parse(instanceEntry.verify.args);
+    }
+    /**
+     * Get contract address by name from the json file
+     *
+     * @param id - contract name
+     * @param network - selected network
+     * @returns contract address
+     */
+    getAddress(id, network, key) {
+        const collection = this.db.get(`${network}.named.${id}${key !== undefined ? `.${key}` : ""}`);
+        const namedEntry = collection.value();
+        return namedEntry?.address;
+    }
+    /**
+     * Get contract addresses by names from the json file
+     *
+     * @param ids - contract names
+     * @param network - selected network
+     * @returns contract address
+     */
+    getAddresses(ids, network, keys = []) {
+        const collection = this.db.get(`${network}.named`).value();
+        return ids
+            .map((id, index) => {
+            const entry = collection?.[id];
+            if (entry && keys[index] in entry) {
+                return entry[keys[index]];
+            }
+            return entry;
+        })
+            .map((entity) => entity?.address);
+    }
+    /**
+     * Get contract address by name from the json file
+     *
+     * @param id - contract name
+     * @param network - selected network
+     * @throws {Error} if there is no address the error will be thrown
+     * @returns contract address
+     */
+    mustGetAddress(id, network, key) {
+        const address = this.getAddress(id, network, key);
+        if (!address) {
+            throw new Error(`Contract ${id} is not saved`);
+        }
+        return address;
+    }
+    /**
+     * Get Contract Deployment Transaction Hash
+     */
+    getDeploymentTxHash(id, network, address) {
+        const collection = this.db.get(`${network}.instance.${address}`);
+        const instanceEntry = collection.value();
+        if (instanceEntry?.id !== id) {
+            throw new Error(`Contract ${id} with address ${address} and network ${network} not found.`);
+        }
+        return instanceEntry.deploymentTxHash;
+    }
+    /**
+     * Get contract from the json file with sizes and multi count
+     *
+     * @param deployer - deployer address
+     * @param network - selected network
+     * @returns {[entries: Map<string, string>, length: number, multiCount: number]}
+     */
+    printContracts(deployer, network) {
+        (0, logger_1.logMagenta)({ text: `Contracts deployed at ${network} by ${deployer}` });
+        (0, logger_1.logMagenta)({ text: "---------------------------------" });
+        const entryMap = new Map();
+        const data = this.db.get(network).value();
+        const { named, instance } = data || {};
+        const namedEntries = Object.entries(named || {});
+        const instanceEntries = Object.entries(instance || {});
+        let multiCount = 0;
+        namedEntries.forEach(([key, value]) => {
+            if (key.startsWith("~")) {
+                return;
+            }
+            if (typeof value.count === "number" && typeof value.address === "string") {
+                if (value.count > 1) {
+                    (0, logger_1.logMagenta)({ text: `\t${key}: N=${value.count}` });
+                    multiCount += 1;
+                }
+                else {
+                    (0, logger_1.logMagenta)({ text: `\t${key}: ${value.address}` });
+                    entryMap.set(key, value.address);
+                }
+            }
+            else {
+                const entries = Object.entries(value);
+                entries.forEach(([id, nested]) => {
+                    if (nested.count > 1) {
+                        (0, logger_1.logMagenta)({ text: `\t${key}-${id}: N=${nested.count}` });
+                        multiCount += 1;
+                    }
+                    else {
+                        (0, logger_1.logMagenta)({ text: `\t${key}-${id}: ${nested.address}` });
+                        entryMap.set(key, nested.address);
+                    }
+                });
+            }
+        });
+        (0, logger_1.logMagenta)({ text: "---------------------------------" });
+        (0, logger_1.logMagenta)({ text: `N# Contracts: ${entryMap.size + multiCount} / ${instanceEntries.length}` });
+        return [entryMap, instanceEntries.length, multiCount];
+    }
+    /**
+     * Clean json file for selected network
+     *
+     * @param network - selected network
+     */
+    cleanup(network) {
+        this.db.set(network, {}).write();
+    }
+}
+exports.ContractStorage = ContractStorage;
+//# sourceMappingURL=ContractStorage.js.map

package/build/tasks/helpers/ContractStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractStorage.js","sourceRoot":"","sources":["../../../tasks/helpers/ContractStorage.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAkE;AAClE,kDAAwB;AACxB,uEAA+C;AAC/C,+EAA2D;AAE3D,gDAAwB;AAIxB,4CAA6C;AAgB7C;;;GAGG;AACH,MAAa,eAAe;IAW1B;;OAEG;IACH,YAAoB,WAAoB;QAgGxC;;;;;;WAMG;QACH,gBAAW,GAAG,CAAC,OAAe,EAAE,OAAe,EAAE,QAAiB,EAAQ,EAAE;YAC1E,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,aAAa,OAAO,EAAE,EAAE,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;QAClE,CAAC,CAAC;QAxGA,IAAI,CAAC,EAAE,GAAG,IAAA,eAAG,EACX,OAAO,MAAM,KAAK,WAAW;YAC3B,CAAC,CAAC,IAAI,sBAAgB,CAAW,oBAAoB,CAAC;YACtD,CAAC,CAAC,IAAI,kBAAQ,CAAW,WAAW,IAAI,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,2BAA2B,CAAC,CAAC,CACpG,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,WAAoB;QACrC,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;YAC9B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;QAC9D,CAAC;QAED,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAkB,EAAE,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAyB;QAC/F,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAEpD,MAAM,YAAY,GAAG,QAAQ,CAAC,qBAAqB,EAAE,CAAC;QACtD,MAAM,UAAU,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QAE9B,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,OAAO,UAAU,QAAQ,EAAE,CAAC,CAAC;QAChD,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,OAAO,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,eAAe,EAAE,EAAE,CAAC,CAAC;QAE7D,IAAI,YAAY,EAAE,CAAC;YACjB,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACjD,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,qBAAqB,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC/D,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,cAAc,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC5D,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,aAAa,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAA0B;YACtC,EAAE,EAAE,UAAU;YACd,gBAAgB,EAAE,YAAY,EAAE,IAAI;SACrC,CAAC;QAEF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,QAAQ,CAAC,MAAM,GAAG;gBAChB,IAAI;gBACJ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,aAAa,eAAe,EAAE,EAAE,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC;QAExE,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,UAAU,UAAU,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAE9F,CAAC;QACd,MAAM,KAAK,GAAG,UAAU,EAAE,KAAK,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,EAAE;aACJ,GAAG,CAAC,GAAG,OAAO,UAAU,UAAU,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE;YAC1E,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,KAAK,GAAG,CAAC;SACjB,CAAC;aACD,KAAK,EAAE,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,OAAe;QAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAyC,CAAC;QAExE,OAAO,MAAM,CAAC,OAAO,CAAwB,KAAK,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAe,EAAE,OAAe;QAC1C,OAAO,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,aAAa,OAAO,EAAE,CAAC,CAAC,KAAK,EAAwB,CAAC;IACrF,CAAC;IAaD;;;;;;;OAOG;IACH,eAAe,CAAiC,EAAM,EAAE,OAAe,EAAE,GAAY;QACnF,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,aAAa,OAAO,EAAE,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,EAAuC,CAAC;QAE9E,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAa,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAiC,EAAM,EAAE,OAAe,EAAE,GAAY;QAC9E,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,UAAU,EAAE,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9F,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,EAAoC,CAAC;QAExE,OAAO,UAAU,EAAE,OAAO,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CACV,GAAS,EACT,OAAe,EACf,OAAiB,EAAE;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,QAAQ,CAAC,CAAC,KAAK,EAE3C,CAAC;QAEd,OAAO,GAAG;aACP,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;YACjB,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;YAE/B,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;gBAClC,OAAQ,KAA4C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACpE,CAAC;YAED,OAAO,KAAuC,CAAC;QACjD,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAiC,EAAM,EAAE,OAAe,EAAE,GAAY;QAClF,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAElD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,mBAAmB,CAAiC,EAAM,EAAE,OAAe,EAAE,OAAe;QAC1F,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,aAAa,OAAO,EAAE,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,EAAuC,CAAC;QAE9E,IAAI,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,YAAY,EAAE,iBAAiB,OAAO,gBAAgB,OAAO,aAAa,CAAC,CAAC;QAC9F,CAAC;QAED,OAAO,aAAa,CAAC,gBAAgB,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,QAAgB,EAAE,OAAe;QAC9C,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,yBAAyB,OAAO,OAAO,QAAQ,EAAE,EAAE,CAAC,CAAC;QACxE,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC,CAAC;QAE1D,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAwB,CAAC;QAChE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QACvC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAA0D,KAAK,IAAI,EAAE,CAAC,CAAC;QAC1G,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAwB,QAAQ,IAAI,EAAE,CAAC,CAAC;QAE9E,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACpC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,OAAO;YACT,CAAC;YAED,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACzE,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;oBACpB,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,KAAK,GAAG,OAAO,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACnD,UAAU,IAAI,CAAC,CAAC;gBAClB,CAAC;qBAAM,CAAC;oBACN,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,KAAK,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACnD,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAqB,KAA2C,CAAC,CAAC;gBAEhG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE;oBAC/B,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;wBACrB,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,OAAO,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;wBAC1D,UAAU,IAAI,CAAC,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;wBAC1D,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;oBACpC,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC,CAAC;QAC1D,IAAA,mBAAU,EAAC,EAAE,IAAI,EAAE,iBAAiB,QAAQ,CAAC,IAAI,GAAG,UAAU,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEhG,OAAO,CAAC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC;CACF;AAtRD,0CAsRC"}

package/build/tasks/helpers/ContractVerifier.d.ts

@@ -0,0 +1,26 @@
+import type { HardhatRuntimeEnvironment } from "hardhat/types";
+/**
+ * @notice Contract verifier allows to verify contract using hardhat-etherscan plugin.
+ */
+export declare class ContractVerifier {
+    /**
+     * Hardhat runtime environment
+     */
+    private hre;
+    /**
+     * Initialize class properties
+     *
+     * @param hre - Hardhat runtime environment
+     */
+    constructor(hre: HardhatRuntimeEnvironment);
+    /**
+     * Verify contract through etherscan
+     *
+     * @param address - contract address
+     * @param constructorArguments - stringified constructor arguments
+     * @param libraries - stringified libraries which can't be detected automatically
+     * @returns
+     */
+    verify(address: string, constructorArguments: string, contract?: string, libraries?: string): Promise<[boolean, string]>;
+}
+//# sourceMappingURL=ContractVerifier.d.ts.map

package/build/tasks/helpers/ContractVerifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractVerifier.d.ts","sourceRoot":"","sources":["../../../tasks/helpers/ContractVerifier.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,yBAAyB,EAAa,MAAM,eAAe,CAAC;AAE1E;;GAEG;AACH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,OAAO,CAAC,GAAG,CAA4B;IAEvC;;;;OAIG;gBACS,GAAG,EAAE,yBAAyB;IAI1C;;;;;;;OAOG;IACG,MAAM,CACV,OAAO,EAAE,MAAM,EACf,oBAAoB,EAAE,MAAM,EAC5B,QAAQ,CAAC,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;CAyB9B"}

package/build/tasks/helpers/ContractVerifier.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractVerifier = void 0;
+/**
+ * @notice Contract verifier allows to verify contract using hardhat-etherscan plugin.
+ */
+class ContractVerifier {
+    /**
+     * Initialize class properties
+     *
+     * @param hre - Hardhat runtime environment
+     */
+    constructor(hre) {
+        this.hre = hre;
+    }
+    /**
+     * Verify contract through etherscan
+     *
+     * @param address - contract address
+     * @param constructorArguments - stringified constructor arguments
+     * @param libraries - stringified libraries which can't be detected automatically
+     * @returns
+     */
+    async verify(address, constructorArguments, contract, libraries) {
+        const params = {
+            address,
+            constructorArguments: JSON.parse(constructorArguments),
+            contract,
+        };
+        if (libraries) {
+            params.libraries = JSON.parse(libraries);
+        }
+        // Run etherscan task
+        const error = await this.hre
+            .run("verify:verify", params)
+            .then(() => "")
+            .catch((err) => {
+            if (err.message === "Contract source code already verified") {
+                return "";
+            }
+            return err.message;
+        });
+        return [!error, error];
+    }
+}
+exports.ContractVerifier = ContractVerifier;
+//# sourceMappingURL=ContractVerifier.js.map

package/build/tasks/helpers/ContractVerifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractVerifier.js","sourceRoot":"","sources":["../../../tasks/helpers/ContractVerifier.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,gBAAgB;IAM3B;;;;OAIG;IACH,YAAY,GAA8B;QACxC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,OAAe,EACf,oBAA4B,EAC5B,QAAiB,EACjB,SAAkB;QAElB,MAAM,MAAM,GAA6B;YACvC,OAAO;YACP,oBAAoB,EAAE,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAc;YACnE,QAAQ;SACT,CAAC;QAEF,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAc,CAAC;QACxD,CAAC;QAED,qBAAqB;QACrB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG;aACzB,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC;aAC5B,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;aACd,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;YACpB,IAAI,GAAG,CAAC,OAAO,KAAK,uCAAuC,EAAE,CAAC;gBAC5D,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO,GAAG,CAAC,OAAO,CAAC;QACrB,CAAC,CAAC,CAAC;QAEL,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACzB,CAAC;CACF;AArDD,4CAqDC"}

package/build/tasks/helpers/Deployment.d.ts

@@ -0,0 +1,180 @@
+import { BaseContract, ContractFactory, Signer } from "ethers";
+import type { TAbi } from "./types";
+import type { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers";
+import type { ConfigurableTaskDefinition, HardhatRuntimeEnvironment, TaskArguments } from "hardhat/types";
+import { EContracts, IDeployContractParams, IDeployContractWithLinkedLibrariesParams, IDeployParams, IDeployStep, IGetContractParams } from "./types";
+/**
+ * @notice Deployment helper class to run sequential deploy using steps and deploy contracts.
+ */
+export declare class Deployment {
+    /**
+     * Singleton instance for class
+     */
+    private static INSTANCE?;
+    /**
+     * Hardhat runtime environment
+     */
+    private hre?;
+    /**
+     * Step catalog to create sequential tasks
+     */
+    private stepCatalog;
+    /**
+     * Json file database instance
+     */
+    private config;
+    /**
+     * Contract storage
+     */
+    private storage;
+    /**
+     * Contracts name mapping
+     */
+    private contractNames;
+    /**
+     * Initialize class properties only once
+     */
+    private constructor();
+    /**
+     * Get singleton object
+     *
+     * @returns {ContractStorage} singleton object
+     */
+    static getInstance({ contractNames, hre, }?: {
+        contractNames?: Record<EContracts, string>;
+        hre?: HardhatRuntimeEnvironment;
+    }): Deployment;
+    /**
+     * Start deploy with console log information
+     *
+     * @param catalog - deploy steps catalog
+     * @param {IDeployParams} params - deploy params
+     * @returns deploy steps for selected catalog
+     */
+    start(catolog: string, { incremental, verify }: IDeployParams): Promise<IDeployStep[]>;
+    /**
+     * Run deploy steps
+     *
+     * @param steps - deploy steps
+     * @param skip - skip steps with less or equal index
+     */
+    runSteps(steps: IDeployStep[], skip: number): Promise<void>;
+    /**
+     * Print deployment results and check warnings
+     *
+     * @param strict - fail on warnings is enabled
+     * @throws error if strict is enabled and warning is found
+     */
+    checkResults(strict?: boolean): Promise<void>;
+    /**
+     * Finish deployment with console log information
+     *
+     * @param startBalance - start deployer balance
+     * @param isSuccess - success or not
+     */
+    finish(startBalance: bigint, isSuccess: boolean): Promise<void>;
+    /**
+     * Get deployer (first signer) from hardhat runtime environment
+     *
+     * @returns {Promise<HardhatEthersSigner>} - signer
+     */
+    getDeployer(): Promise<HardhatEthersSigner>;
+    /**
+     * Set hardhat runtime environment
+     *
+     * @param hre - hardhat runtime environment
+     */
+    setHre(hre: HardhatRuntimeEnvironment): void;
+    /**
+     * Set contract names
+     *
+     * @param contractNames - contract names
+     */
+    setContractNames(contractNames: Record<EContracts, string>): void;
+    /**
+     * Check if hardhat runtime environment is set
+     *
+     * @throws {Error} error if there is no hardhat runtime environment set
+     */
+    private checkHre;
+    /**
+     * Register deploy task by updating step catalog and return task definition
+     *
+     * @param taskName - unique task name
+     * @param stepName - task description
+     * @param paramsFn - optional function to override default task arguments
+     * @returns {Promise<ConfigurableTaskDefinition>} hardhat task definition
+     */
+    deployTask(taskName: string, stepName: string, paramsFn?: (params: IDeployParams) => Promise<TaskArguments>): Promise<ConfigurableTaskDefinition>;
+    /**
+     * Register deployment step
+     *
+     * @param deployType - deploy type
+     * @param {IDeployStepCatalog} - deploy step catalog name, description and param mapper
+     */
+    private addStep;
+    /**
+     * Get default params from hardhat task
+     *
+     * @param {IDeployParams} params - hardhat task arguments
+     * @returns {Promise<TaskArguments>} params for deploy workflow
+     */
+    private getDefaultParams;
+    /**
+     * Get deploy step sequence
+     *
+     * @param deployType - deploy type
+     * @param {IDeployParams} params - deploy params
+     * @returns {Promise<IDeployStep[]>} deploy steps
+     */
+    private getDeploySteps;
+    /**
+     * Deploy contract and return it
+     *
+     * @param {IDeployContractParams} params - parameters of deploy contract
+     * @param args - constructor arguments
+     * @returns deployed contract
+     */
+    deployContract<T extends BaseContract, ID = EContracts>({ name, abi, bytecode, signer }: IDeployContractParams<ID>, ...args: unknown[]): Promise<T>;
+    /**
+     * Deploy contract with linked libraries using contract factory
+     *
+     * @param {IDeployContractWithLinkedLibrariesParams} params - parameters of deploy contract with linked libraries
+     * @param args - constructor arguments
+     * @returns deployed contract
+     */
+    deployContractWithLinkedLibraries<T extends BaseContract>({ contractFactory, signer }: IDeployContractWithLinkedLibrariesParams, ...args: unknown[]): Promise<T>;
+    /**
+     * Creates contract factory from abi and bytecode
+     *
+     * @param name - contract name
+     * @param abi - Contract abi
+     * @param bytecode - Contract linked bytecode
+     * @param signer - signer
+     * @returns contract factory with linked libraries
+     */
+    createContractFactory(abi: TAbi, bytecode: string, signer?: Signer): Promise<ContractFactory>;
+    /**
+     * Get deploy config field (see deploy-config.json)
+     *
+     * @param id - contract name
+     * @param field - config field key
+     * @returns config field value or null
+     */
+    getDeployConfigField<T = string | number | boolean, ID extends string = EContracts>(id: ID, field: string, mustGet?: boolean): T;
+    /**
+     * Update deploy config field (see deploy-config.json)
+     * @param id - contract name
+     * @param field - config field key
+     * @param value - config field value
+     */
+    updateDeployConfig<T = string | number | boolean, ID extends string = EContracts>(id: ID, field: string, value: T): void;
+    /**
+     * Get contract by name and group key
+     *
+     * @param {IGetContractParams} params - params
+     * @returns contract wrapper
+     */
+    getContract<T extends BaseContract>({ name, key, address, abi, signer }: IGetContractParams): Promise<T>;
+}
+//# sourceMappingURL=Deployment.d.ts.map

package/build/tasks/helpers/Deployment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deployment.d.ts","sourceRoot":"","sources":["../../../tasks/helpers/Deployment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAO/D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AACnF,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAK1G,OAAO,EACL,UAAU,EACV,qBAAqB,EACrB,wCAAwC,EACxC,aAAa,EACb,WAAW,EAEX,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAOjB;;GAEG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAa;IAErC;;OAEG;IACH,OAAO,CAAC,GAAG,CAAC,CAA4B;IAExC;;OAEG;IACH,OAAO,CAAC,WAAW,CAAkD;IAErE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAyB;IAEvC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAkB;IAEjC;;OAEG;IACH,OAAO,CAAC,aAAa,CAA6B;IAElD;;OAEG;IACH,OAAO;IAeP;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EACjB,aAA0B,EAC1B,GAAe,GAChB,GAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAAC,GAAG,CAAC,EAAE,yBAAyB,CAAA;KAAO,GAAG,UAAU;IAQpG;;;;;;OAMG;IACG,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA4B5F;;;;;OAKG;IACG,QAAQ,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBjE;;;;;OAKG;IACG,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BnD;;;;;OAKG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBrE;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAQjD;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,yBAAyB,GAAG,IAAI;IAI5C;;;;OAIG;IACH,gBAAgB,CAAC,aAAa,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,IAAI;IAIjE;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAMhB;;;;;;;OAOG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,aAAa,CAAC,GAC3D,OAAO,CAAC,0BAA0B,CAAC;IAOtC;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAUf;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB,CACmB;IAE3C;;;;;;OAMG;YACW,cAAc;IAmB5B;;;;;;OAMG;IACG,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,GAAG,UAAU,EAC1D,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,qBAAqB,CAAC,EAAE,CAAC,EAC1D,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,OAAO,CAAC,CAAC,CAAC;IAmBb;;;;;;OAMG;IACG,iCAAiC,CAAC,CAAC,SAAS,YAAY,EAC5D,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,wCAAwC,EACrE,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,OAAO,CAAC,CAAC,CAAC;IAab;;;;;;;;OAQG;IACG,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAMnG;;;;;;OAMG;IACH,oBAAoB,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,EAAE,SAAS,MAAM,GAAG,UAAU,EAChF,EAAE,EAAE,EAAE,EACN,KAAK,EAAE,MAAM,EACb,OAAO,UAAQ,GACd,CAAC;IAcJ;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAAE,EAAE,SAAS,MAAM,GAAG,UAAU,EAC9E,EAAE,EAAE,EAAE,EACN,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,CAAC,GACP,IAAI;IAMP;;;;;OAKG;IACG,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;CAgB/G"}