@skalenetwork/upgrade-tools 2.0.0-refactor.17 → 2.0.0-refactor.19

package/README.md

@@ -4,19 +4,74 @@ Scripts to support upgrades of smart contracts. The package contains common used
 
 ## Upgrade scripts
 
-To write upgrade script import `upgrade` function.
+To write an upgrade script extend `Upgrader` class.
 
 ```typescript
-import { upgrade } from "@skalenetwork/upgrade-tools"
+import { Upgrader } from "@skalenetwork/upgrade-tools";
+
+class ExampleContractUpgrader extends Upgrader {
+
+    getDeployedVersion = async () => {
+        return await (await this.getExampleContract()).version();
+    };
+
+    setVersion = async (newVersion: string) => {
+        const exampleContract = await this.getExampleContract();
+        const setVersionTransaction = {
+            to: exampleContract.address,
+            data: exampleContract.interface.encodeFunctionData("setVersion", [newVersion])
+        };
+        this.transactions.push(setVersionTransaction);
+    }
+
+    async getExampleContract() {
+        return await ethers.getContractAt("ExampleContract", this.abi["example_contract_address"] as string);
+    }
+}
+
+async function main() {
+    const abi = JSON.parse(await fs.readFile(process.env.ABI, "utf-8")) as SkaleABIFile;
+
+    const upgrader = new ExampleContractUpgrader(
+        "ExampleContract",
+        "1.0.0",
+        abi,
+        ["ExampleContract"]
+    );
+
+    await upgrader.upgrade();
+}
+
+if (require.main === module) {
+    main()
+        .then(() => process.exit(0))
+        .catch(error => {
+            console.error(error);
+            process.exit(1);
+        });
+}
+```
+
+### Abstract functions
+
+The `Upgrader` has 2 abstract functions. It's mandatory to override them:
+
+```typescript
+abstract getDeployedVersion: () => Promise<string | undefined>
+abstract setVersion: (newVersion: string) => Promise<void>
 ```
 
-Then call it with parameters below:
+- `getDeployedVersion` returns string representing a deployed version of the contract
+- `setVersion` creates a transaction to set a new version of the contract
+
+### Protected functions
+
+There are functions that may be overridden to customize an upgrade process
+
+```typescript
+deployNewContracts = () => { return Promise.resolve() };
+initialize = () => { return Promise.resolve() };
+```
 
-- `projectName` - project name
-- `targetVersion` - version of smart contracts that can be upgraded by the script
-- `getDeployedVersion` - a function to request current version from smart contracts
-- `setVersion` - function that sets version to smart contracts
-- `safeMockAccessRequirements` - list of smart contracts that requires ownership changing for successful upgrade (when EOA + SafeMock are used during upgrade)
-- `contractNamesToUpgrade` - list of smart contracts to upgrade
-- `deployNewContracts` - optional - a function that deploys new smart contracts
-- `initialize` - optional - a function that setup smart contracts after upgrade
+- `deployNewContracts` is called before proxies upgrade and is used to deploy new instances
+- `initialize` is called after proxies upgrade and is used to send initializing transactions

package/dist/src/index.d.ts

@@ -5,5 +5,4 @@ export * from "./multiSend";
 export * from "./submitters";
 export * from "./verification";
 export * from "./version";
-export * from "./upgrade";
 export * from "./upgrader";

package/dist/src/index.js

@@ -21,5 +21,4 @@ __exportStar(require("./multiSend"), exports);
 __exportStar(require("./submitters"), exports);
 __exportStar(require("./verification"), exports);
 __exportStar(require("./version"), exports);
-__exportStar(require("./upgrade"), exports);
 __exportStar(require("./upgrader"), exports);

package/dist/src/submitters/auto-submitter.js

@@ -45,7 +45,6 @@ const chalk_1 = __importDefault(require("chalk"));
 const safe_ima_legacy_marionette_submitter_1 = require("./safe-ima-legacy-marionette-submitter");
 const fs_1 = require("fs");
 const marionette_1 = require("./types/marionette");
-const safe_ima_marionette_submitter_1 = require("./safe-ima-marionette-submitter");
 class AutoSubmitter extends submitter_1.Submitter {
     submit(transactions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -64,14 +63,28 @@ class AutoSubmitter extends submitter_1.Submitter {
                     const safeAddress = this._getSafeAddress();
                     const schainHash = this._getSchainHash();
                     const mainnetChainId = this._getMainnetChainId();
-                    if (yield this._versionFunctionExists()) {
-                        console.log("version() function was found. Use normal Marionette");
-                        submitter = new safe_ima_marionette_submitter_1.SafeImaMarionetteSubmitter(safeAddress, imaAbi, schainHash, mainnetChainId);
-                    }
-                    else {
-                        console.log("No version() function was found. Use legacy Marionette");
-                        submitter = new safe_ima_legacy_marionette_submitter_1.SafeImaLegacyMarionetteSubmitter(safeAddress, imaAbi, schainHash, mainnetChainId);
-                    }
+                    // TODO: after marionette has multiSend functionality
+                    // query version and properly select a submitter
+                    // based on it
+                    //
+                    // if (await this._versionFunctionExists()) {
+                    //     console.log("version() function was found. Use normal Marionette")
+                    //     submitter = new SafeImaMarionetteSubmitter(
+                    //         safeAddress,
+                    //         imaAbi,
+                    //         schainHash,
+                    //         mainnetChainId
+                    //     )
+                    // } else {
+                    //     console.log("No version() function was found. Use legacy Marionette")
+                    //     submitter = new SafeImaLegacyMarionetteSubmitter(
+                    //         safeAddress,
+                    //         imaAbi,
+                    //         schainHash,
+                    //         mainnetChainId
+                    //     )
+                    // }
+                    submitter = new safe_ima_legacy_marionette_submitter_1.SafeImaLegacyMarionetteSubmitter(safeAddress, imaAbi, schainHash, mainnetChainId);
                 }
                 else {
                     // assuming owner is a Gnosis Safe

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skalenetwork/upgrade-tools",
-  "version": "2.0.0-refactor.17",
+  "version": "2.0.0-refactor.19",
   "description": "Scripts to support upgrades of smart contracts",
   "files": [
     "dist/**/*"

package/dist/src/upgrade.d.ts

@@ -1,8 +0,0 @@
-import { Contract } from "ethers";
-import { OwnableUpgradeable } from "../typechain-types";
-import { SkaleABIFile } from "./types/SkaleABIFile";
-export declare function getContractFactoryAndUpdateManifest(contract: string): Promise<import("ethers").ContractFactory>;
-declare type DeploymentAction<ContractManagerType extends Contract> = (safeTransactions: string[], abi: SkaleABIFile, contractManager: ContractManagerType) => Promise<void>;
-declare type MultiTransactionAction<ContractManagerType extends Contract> = (abi: SkaleABIFile, contractManager: ContractManagerType) => Promise<string[][]>;
-export declare function upgrade<ContractManagerType extends OwnableUpgradeable>(projectName: string, targetVersion: string, getDeployedVersion: (abi: SkaleABIFile) => Promise<string | undefined>, setVersion: (safeTransaction: string[], abi: SkaleABIFile, newVersion: string) => Promise<void>, safeMockAccessRequirements: string[], contractNamesToUpgrade: string[], deployNewContracts: DeploymentAction<ContractManagerType>, initialize: DeploymentAction<ContractManagerType>, afterUpgrade?: MultiTransactionAction<ContractManagerType>): Promise<void>;
-export {};

package/dist/src/upgrade.js

@@ -1,234 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.upgrade = exports.getContractFactoryAndUpdateManifest = void 0;
-const deploy_1 = require("./deploy");
-const fs_1 = require("fs");
-const hardhat_1 = require("hardhat");
-const hardhat_2 = __importDefault(require("hardhat"));
-const upgrades_core_1 = require("@openzeppelin/upgrades-core");
-const chalk_1 = __importDefault(require("chalk"));
-const admin_1 = require("@openzeppelin/hardhat-upgrades/dist/admin");
-const version_1 = require("./version");
-const abi_1 = require("./abi");
-const verification_1 = require("./verification");
-const multiSend_1 = require("./multiSend");
-const gnosis_safe_1 = require("./gnosis-safe");
-function getContractFactoryAndUpdateManifest(contract) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const manifest = JSON.parse(yield fs_1.promises.readFile(yield (0, deploy_1.getManifestFile)(), "utf-8"));
-        const { linkReferences } = yield hardhat_1.artifacts.readArtifact(contract);
-        if (!Object.keys(linkReferences).length)
-            return yield hardhat_1.ethers.getContractFactory(contract);
-        const librariesToUpgrade = [];
-        const oldLibraries = {};
-        if (manifest.libraries === undefined) {
-            Object.assign(manifest, { libraries: {} });
-        }
-        for (const key of Object.keys(linkReferences)) {
-            const libraryName = Object.keys(linkReferences[key])[0];
-            const { bytecode } = yield hardhat_1.artifacts.readArtifact(libraryName);
-            if (manifest.libraries[libraryName] === undefined) {
-                librariesToUpgrade.push(libraryName);
-                continue;
-            }
-            const libraryBytecodeHash = manifest.libraries[libraryName].bytecodeHash;
-            if ((0, upgrades_core_1.hashBytecode)(bytecode) !== libraryBytecodeHash) {
-                librariesToUpgrade.push(libraryName);
-            }
-            else {
-                oldLibraries[libraryName] = manifest.libraries[libraryName].address;
-            }
-        }
-        const libraries = yield (0, deploy_1.deployLibraries)(librariesToUpgrade);
-        for (const [libraryName, libraryAddress] of libraries.entries()) {
-            const { bytecode } = yield hardhat_1.artifacts.readArtifact(libraryName);
-            manifest.libraries[libraryName] = { "address": libraryAddress, "bytecodeHash": (0, upgrades_core_1.hashBytecode)(bytecode) };
-        }
-        Object.assign(libraries, oldLibraries);
-        yield fs_1.promises.writeFile(yield (0, deploy_1.getManifestFile)(), JSON.stringify(manifest, null, 4));
-        return yield (0, deploy_1.getLinkedContractFactory)(contract, libraries);
-    });
-}
-exports.getContractFactoryAndUpdateManifest = getContractFactoryAndUpdateManifest;
-function upgrade(projectName, targetVersion, getDeployedVersion, setVersion, safeMockAccessRequirements, contractNamesToUpgrade, deployNewContracts, initialize, afterUpgrade) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!process.env.ABI) {
-            console.log(chalk_1.default.red("Set path to file with ABI and addresses to ABI environment variables"));
-            return;
-        }
-        const abiFilename = process.env.ABI;
-        const abi = JSON.parse(yield fs_1.promises.readFile(abiFilename, "utf-8"));
-        const proxyAdmin = yield (0, admin_1.getManifestAdmin)(hardhat_2.default);
-        const contractManagerName = "ContractManager";
-        const contractManagerFactory = yield hardhat_1.ethers.getContractFactory(contractManagerName);
-        // const contractManager = (contractManagerFactory.attach(abi[getContractKeyInAbiFile(contractManagerName) + "_address"] as string)) as ContractManagerType;
-        const contractManager = (contractManagerFactory.attach(abi["Mock"]));
-        const deployedVersion = yield getDeployedVersion(abi);
-        const version = yield (0, version_1.getVersion)();
-        if (deployedVersion) {
-            if (deployedVersion !== targetVersion) {
-                console.log(chalk_1.default.red(`This script can't upgrade version ${deployedVersion} to ${version}`));
-                process.exit(1);
-            }
-        }
-        else {
-            console.log(chalk_1.default.yellow(`Can't check currently deployed version of ${projectName}`));
-        }
-        console.log(`Will mark updated version as ${version}`);
-        const [deployer] = yield hardhat_1.ethers.getSigners();
-        let safe = yield proxyAdmin.owner();
-        const safeTransactions = [];
-        let safeMock = undefined;
-        if ((yield hardhat_1.ethers.provider.getCode(safe)) === "0x") {
-            console.log("Owner is not a contract");
-            if (deployer.address !== safe) {
-                console.log(chalk_1.default.red(`Used address does not have permissions to upgrade ${projectName}`));
-                process.exit(1);
-            }
-            console.log(chalk_1.default.blue("Deploy SafeMock to simulate upgrade via multisig"));
-            const safeMockFactory = yield hardhat_1.ethers.getContractFactory("SafeMock");
-            safeMock = yield safeMockFactory.deploy();
-            yield safeMock.deployTransaction.wait();
-            console.log(chalk_1.default.blue("Transfer ownership to SafeMock"));
-            safe = safeMock.address;
-            yield (yield proxyAdmin.transferOwnership(safe)).wait();
-            yield (yield contractManager.transferOwnership(safe)).wait();
-            for (const contractName of safeMockAccessRequirements) {
-                const contractFactory = yield getContractFactoryAndUpdateManifest(contractName);
-                // const contractAddress = abi[getContractKeyInAbiFile(contractName) + "_address"] as string;
-                const contractAddress = abi["Mock"];
-                const contract = contractFactory.attach(contractAddress);
-                console.log(chalk_1.default.blue(`Grant access to ${contractName}`));
-                yield (yield contract.grantRole(yield contract.DEFAULT_ADMIN_ROLE(), safe)).wait();
-            }
-        }
-        else {
-            try {
-                const safeMockFactory = yield hardhat_1.ethers.getContractFactory("SafeMock");
-                const checkSafeMock = safeMockFactory.attach(safe);
-                if (yield checkSafeMock.IS_SAFE_MOCK()) {
-                    safeMock = checkSafeMock;
-                }
-            }
-            catch (e) {
-                console.log(chalk_1.default.yellow("Owner is not SafeMock"));
-            }
-        }
-        // Deploy new contracts
-        yield deployNewContracts(safeTransactions, abi, contractManager);
-        // deploy new implementations
-        const contractsToUpgrade = [];
-        for (const contract of contractNamesToUpgrade) {
-            const contractFactory = yield getContractFactoryAndUpdateManifest(contract);
-            let _contract = contract;
-            if (contract === "BountyV2") {
-                if (!abi[ /*getContractKeyInAbiFile(contract) + */"_address"])
-                    _contract = "Bounty";
-                console.log(_contract);
-            }
-            const proxyAddress = abi[ /*getContractKeyInAbiFile(_contract) + */"_address"];
-            console.log(`Prepare upgrade of ${contract}`);
-            const newImplementationAddress = yield hardhat_1.upgrades.prepareUpgrade(proxyAddress, contractFactory, {
-                unsafeAllowLinkedLibraries: true,
-                unsafeAllowRenames: true
-            });
-            const currentImplementationAddress = yield (0, upgrades_core_1.getImplementationAddress)(hardhat_1.network.provider, proxyAddress);
-            if (newImplementationAddress !== currentImplementationAddress) {
-                contractsToUpgrade.push({
-                    proxyAddress,
-                    implementationAddress: newImplementationAddress,
-                    name: contract,
-                    abi: (0, abi_1.getAbi)(contractFactory.interface)
-                });
-                yield (0, verification_1.verify)(contract, newImplementationAddress, []);
-            }
-            else {
-                console.log(chalk_1.default.gray(`Contract ${contract} is up to date`));
-            }
-        }
-        // Switch proxies to new implementations
-        for (const contract of contractsToUpgrade) {
-            console.log(chalk_1.default.yellowBright(`Prepare transaction to upgrade ${contract.name} at ${contract.proxyAddress} to ${contract.implementationAddress}`));
-            safeTransactions.push((0, multiSend_1.encodeTransaction)(0, proxyAdmin.address, 0, proxyAdmin.interface.encodeFunctionData("upgrade", [contract.proxyAddress, contract.implementationAddress])));
-            abi[ /*getContractKeyInAbiFile(contract.name) + */"_abi"] = contract.abi;
-        }
-        yield initialize(safeTransactions, abi, contractManager);
-        // write version
-        yield setVersion(safeTransactions, abi, version);
-        yield fs_1.promises.writeFile(`data/transactions-${version}-${hardhat_1.network.name}.json`, JSON.stringify(safeTransactions, null, 4));
-        let privateKey = hardhat_1.network.config.accounts[0];
-        if (hardhat_1.network.config.accounts === "remote") {
-            // Don't have an information about private key
-            // Use random one because we most probable run tests
-            privateKey = hardhat_1.ethers.Wallet.createRandom().privateKey;
-        }
-        const safeTx = yield (0, gnosis_safe_1.createMultiSendTransaction)(hardhat_1.ethers, safe, privateKey, safeTransactions, (yield hardhat_1.ethers.provider.getNetwork()).chainId, safeMock !== undefined ? 0 : undefined);
-        let transactionsBatches;
-        if (afterUpgrade !== undefined) {
-            transactionsBatches = yield afterUpgrade(abi, contractManager);
-            for (const { index, batch } of transactionsBatches.map((batch, index) => ({ index, batch }))) {
-                yield fs_1.promises.writeFile(`data/after-transactions-${index}-${version}-${hardhat_1.network.name}.json`, JSON.stringify(batch, null, 4));
-            }
-        }
-        if (!safeMock) {
-            const chainId = (yield hardhat_1.ethers.provider.getNetwork()).chainId;
-            yield (0, gnosis_safe_1.sendSafeTransaction)(safe, chainId, safeTx);
-            if (transactionsBatches !== undefined) {
-                for (const { batch, index } of transactionsBatches.map((batch, index) => ({ batch, index }))) {
-                    const multiSendTransaction = yield (0, gnosis_safe_1.createMultiSendTransaction)(hardhat_1.ethers, safe, privateKey, batch, safeTx.nonce + index + 1);
-                    yield (0, gnosis_safe_1.sendSafeTransaction)(safe, chainId, multiSendTransaction);
-                }
-            }
-        }
-        else {
-            console.log(chalk_1.default.blue("Send upgrade transactions to safe mock"));
-            try {
-                yield (yield deployer.sendTransaction({
-                    to: safeMock.address,
-                    value: safeTx.value,
-                    data: safeTx.data,
-                })).wait();
-                if (transactionsBatches !== undefined) {
-                    for (const batch of transactionsBatches) {
-                        const multiSendTransaction = yield (0, gnosis_safe_1.createMultiSendTransaction)(hardhat_1.ethers, safe, privateKey, batch, 0);
-                        yield (yield deployer.sendTransaction({
-                            to: safeMock.address,
-                            value: multiSendTransaction.value,
-                            data: multiSendTransaction.data,
-                        })).wait();
-                    }
-                }
-                console.log(chalk_1.default.blue("Transactions have been sent"));
-            }
-            catch (exception) {
-                console.log(chalk_1.default.red("Error during upgrade"));
-                console.log(exception);
-                process.exitCode = 13;
-            }
-            finally {
-                console.log(chalk_1.default.blue("Return ownership to wallet"));
-                yield (yield safeMock.transferProxyAdminOwnership(contractManager.address, deployer.address)).wait();
-                yield (yield safeMock.transferProxyAdminOwnership(proxyAdmin.address, deployer.address)).wait();
-                if ((yield proxyAdmin.owner()) !== deployer.address) {
-                    console.log(chalk_1.default.blue("Something went wrong with ownership transfer"));
-                    process.exit(1);
-                }
-            }
-        }
-        yield fs_1.promises.writeFile(`data/${projectName}-${version}-${hardhat_1.network.name}-abi.json`, JSON.stringify(abi, null, 4));
-        console.log("Done");
-    });
-}
-exports.upgrade = upgrade;