@openzeppelin/upgrades-core 1.26.2 → 1.27.1

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 zOS Global Limited
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/cli/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli/cli.ts"],"names":[],"mappings":""}

package/dist/cli/cli.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validate_1 = require("./validate");
+const run = async () => {
+    await (0, validate_1.main)(process.argv.slice(2));
+};
+void run();
+//# sourceMappingURL=cli.js.map

package/dist/cli/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli/cli.ts"],"names":[],"mappings":";;;AAEA,yCAAkC;AAElC,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;IACrB,MAAM,IAAA,eAAI,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,KAAK,GAAG,EAAE,CAAC"}

package/dist/cli/cli.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cli.test.d.ts.map

package/dist/cli/cli.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.test.d.ts","sourceRoot":"","sources":["../../src/cli/cli.test.ts"],"names":[],"mappings":""}

package/dist/cli/cli.test.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const util_1 = require("util");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const rimraf_1 = __importDefault(require("rimraf"));
+const hardhat_1 = require("hardhat");
+const execAsync = (0, util_1.promisify)(child_process_1.exec);
+const rimraf = (0, util_1.promisify)(rimraf_1.default);
+const CLI = 'node dist/cli/cli.js';
+async function getTempDir(t) {
+    const temp = await fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'upgrades-core-test-'));
+    t.teardown(() => rimraf(temp));
+    return temp;
+}
+(0, ava_1.default)('help', async (t) => {
+    const output = (await execAsync(`${CLI} validate --help`)).stdout;
+    t.snapshot(output);
+});
+(0, ava_1.default)('no args', async (t) => {
+    const output = (await execAsync(CLI)).stdout;
+    t.snapshot(output);
+});
+(0, ava_1.default)('validate - errors', async (t) => {
+    const temp = await getTempDir(t);
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Validate.sol:Safe`);
+    await fs_1.promises.writeFile(path_1.default.join(temp, 'validate.json'), JSON.stringify(buildInfo));
+    const error = await t.throwsAsync(execAsync(`${CLI} validate ${temp}`));
+    const expectation = [`Stdout: ${error.stdout}`, `Stderr: ${error.stderr}`];
+    t.snapshot(expectation.join('\n'));
+});
+(0, ava_1.default)('validate - no upgradeable', async (t) => {
+    const temp = await getTempDir(t);
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Storage088.sol:Storage088`);
+    await fs_1.promises.writeFile(path_1.default.join(temp, 'validate.json'), JSON.stringify(buildInfo));
+    const output = (await execAsync(`${CLI} validate ${temp}`)).stdout;
+    t.snapshot(output);
+});
+(0, ava_1.default)('validate - ok', async (t) => {
+    const temp = await getTempDir(t);
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Annotation.sol:Annotation`);
+    await fs_1.promises.writeFile(path_1.default.join(temp, 'validate.json'), JSON.stringify(buildInfo));
+    const output = (await execAsync(`${CLI} validate ${temp}`)).stdout;
+    t.snapshot(output);
+});
+//# sourceMappingURL=cli.test.js.map

package/dist/cli/cli.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.test.js","sourceRoot":"","sources":["../../src/cli/cli.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA6C;AAC7C,+BAAiC;AACjC,iDAAqC;AACrC,2BAAoC;AACpC,gDAAwB;AACxB,4CAAoB;AACpB,oDAAiC;AACjC,qCAAoC;AAEpC,MAAM,SAAS,GAAG,IAAA,gBAAS,EAAC,oBAAI,CAAC,CAAC;AAClC,MAAM,MAAM,GAAG,IAAA,gBAAS,EAAC,gBAAW,CAAC,CAAC;AAEtC,MAAM,GAAG,GAAG,sBAAsB,CAAC;AAEnC,KAAK,UAAU,UAAU,CAAC,CAAmB;IAC3C,MAAM,IAAI,GAAG,MAAM,aAAE,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAC7E,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAA,aAAI,EAAC,MAAM,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACrB,MAAM,MAAM,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,GAAG,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC;IAClE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,SAAS,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACxB,MAAM,MAAM,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;IAC7C,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,mBAAmB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAClC,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,sCAAsC,CAAC,CAAC;IACvF,MAAM,aAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhF,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,GAAG,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;IACxE,MAAM,WAAW,GAAa,CAAC,WAAY,KAAa,CAAC,MAAM,EAAE,EAAE,WAAY,KAAa,CAAC,MAAM,EAAE,CAAC,CAAC;IACvG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,2BAA2B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC1C,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,8CAA8C,CAAC,CAAC;IAC/F,MAAM,aAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhF,MAAM,MAAM,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,GAAG,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,eAAe,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9B,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,8CAA8C,CAAC,CAAC;IAC/F,MAAM,aAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhF,MAAM,MAAM,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,GAAG,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1,4 @@
+export { ValidateUpgradeSafetyOptions, validateUpgradeSafety } from './validate/validate-upgrade-safety';
+export { ProjectReport } from './validate/project-report';
+export { ReferenceContractNotFound } from './validate/upgradeability-assessment';
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AACzG,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC"}

package/dist/cli/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceContractNotFound = exports.ProjectReport = exports.validateUpgradeSafety = void 0;
+var validate_upgrade_safety_1 = require("./validate/validate-upgrade-safety");
+Object.defineProperty(exports, "validateUpgradeSafety", { enumerable: true, get: function () { return validate_upgrade_safety_1.validateUpgradeSafety; } });
+var project_report_1 = require("./validate/project-report");
+Object.defineProperty(exports, "ProjectReport", { enumerable: true, get: function () { return project_report_1.ProjectReport; } });
+var upgradeability_assessment_1 = require("./validate/upgradeability-assessment");
+Object.defineProperty(exports, "ReferenceContractNotFound", { enumerable: true, get: function () { return upgradeability_assessment_1.ReferenceContractNotFound; } });
+//# sourceMappingURL=index.js.map

package/dist/cli/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";;;AAAA,8EAAyG;AAAlE,gIAAA,qBAAqB,OAAA;AAC5D,4DAA0D;AAAjD,+GAAA,aAAa,OAAA;AACtB,kFAAiF;AAAxE,sIAAA,yBAAyB,OAAA"}

package/dist/cli/validate/build-info-file.d.ts

@@ -0,0 +1,22 @@
+import { SolcOutput, SolcInput } from '../..';
+/**
+ * A build info file containing Solidity compiler input and output JSON objects.
+ */
+export interface BuildInfoFile {
+    /**
+     * The Solidity compiler input JSON object.
+     */
+    input: SolcInput;
+    /**
+     * The Solidity compiler output JSON object.
+     */
+    output: SolcOutput;
+}
+/**
+ * Gets the build info files from the build info directory.
+ *
+ * @param buildInfoDir Build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
+ * @returns The build info files with Solidity compiler input and output.
+ */
+export declare function getBuildInfoFiles(buildInfoDir?: string): Promise<BuildInfoFile[]>;
+//# sourceMappingURL=build-info-file.d.ts.map

package/dist/cli/validate/build-info-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-info-file.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/build-info-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AA6B9C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;CACpB;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,YAAY,CAAC,EAAE,MAAM,4BAI5D"}

package/dist/cli/validate/build-info-file.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBuildInfoFiles = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const error_1 = require("./error");
+const HARDHAT_COMPILE_COMMAND = 'npx hardhat clean && npx hardhat compile';
+const FOUNDRY_COMPILE_COMMAND = 'forge clean && forge build';
+const STORAGE_LAYOUT_HELP = `\
+If using Hardhat, include the 'storageLayout' output selection in your Hardhat config:
+  module.exports = {
+    solidity: {
+      settings: {
+        outputSelection: {
+          '*': {
+            '*': ['storageLayout'],
+          },
+        },
+      },
+    },
+  };
+Then recompile your contracts with '${HARDHAT_COMPILE_COMMAND}' and try again.
+
+If using Foundry, include the "storageLayout" extra output in foundry.toml:
+  [profile.default]
+  build_info = true
+  extra_output = ["storageLayout"]
+Then recompile your contracts with '${FOUNDRY_COMPILE_COMMAND}' and try again.`;
+/**
+ * Gets the build info files from the build info directory.
+ *
+ * @param buildInfoDir Build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
+ * @returns The build info files with Solidity compiler input and output.
+ */
+async function getBuildInfoFiles(buildInfoDir) {
+    const dir = await findDir(buildInfoDir);
+    const jsonFiles = await getJsonFiles(dir);
+    return await readBuildInfo(jsonFiles);
+}
+exports.getBuildInfoFiles = getBuildInfoFiles;
+async function findDir(buildInfoDir) {
+    if (buildInfoDir !== undefined && !(await hasJsonFiles(buildInfoDir))) {
+        throw new error_1.ValidateCommandError(`The directory '${buildInfoDir}' does not exist or does not contain any build info files.`, () => `\
+If using Foundry, ensure your foundry.toml file has build_info = true.
+Compile your contracts with '${HARDHAT_COMPILE_COMMAND}' or '${FOUNDRY_COMPILE_COMMAND}' and try again with the correct path to the build info directory.`);
+    }
+    const dir = buildInfoDir ?? (await findDefaultDir());
+    return dir;
+}
+async function findDefaultDir() {
+    const hardhatRelativeDir = path_1.default.join('artifacts', 'build-info');
+    const foundryRelativeDir = path_1.default.join('out', 'build-info');
+    const hardhatDir = path_1.default.join(process.cwd(), hardhatRelativeDir);
+    const foundryDir = path_1.default.join(process.cwd(), foundryRelativeDir);
+    const hasHardhatBuildInfo = await hasJsonFiles(hardhatDir);
+    const hasFoundryBuildInfo = await hasJsonFiles(foundryDir);
+    if (hasHardhatBuildInfo && hasFoundryBuildInfo) {
+        throw new error_1.ValidateCommandError(`Found both Hardhat and Foundry build info directories: '${hardhatRelativeDir}' and '${foundryRelativeDir}'.`, () => `Specify the build info directory that you want to validate.`);
+    }
+    else if (hasHardhatBuildInfo) {
+        return hardhatDir;
+    }
+    else if (hasFoundryBuildInfo) {
+        return foundryDir;
+    }
+    else {
+        throw new error_1.ValidateCommandError(`Could not find the default Hardhat or Foundry build info directory.`, () => `Compile your contracts with '${HARDHAT_COMPILE_COMMAND}' or '${FOUNDRY_COMPILE_COMMAND}', or specify the build info directory that you want to validate.`);
+    }
+}
+async function hasJsonFiles(dir) {
+    return (await exists(dir)) && (await getJsonFiles(dir)).length > 0;
+}
+async function exists(dir) {
+    try {
+        await fs_1.promises.access(dir);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+}
+async function getJsonFiles(dir) {
+    const files = await fs_1.promises.readdir(dir);
+    const jsonFiles = files.filter(file => file.endsWith('.json'));
+    return jsonFiles.map(file => path_1.default.join(dir, file));
+}
+async function readBuildInfo(buildInfoFilePaths) {
+    const buildInfoFiles = [];
+    for (const buildInfoFilePath of buildInfoFilePaths) {
+        const buildInfoJson = await readJSON(buildInfoFilePath);
+        if (buildInfoJson.input === undefined || buildInfoJson.output === undefined) {
+            throw new error_1.ValidateCommandError(`Build info file ${buildInfoFilePath} must contain Solidity compiler input and output.`);
+        }
+        else {
+            if (!hasStorageLayoutSetting(buildInfoJson)) {
+                throw new error_1.ValidateCommandError(`Build info file ${buildInfoFilePath} does not contain storage layout.`, () => STORAGE_LAYOUT_HELP);
+            }
+            buildInfoFiles.push({
+                input: buildInfoJson.input,
+                output: buildInfoJson.output,
+            });
+        }
+    }
+    return buildInfoFiles;
+}
+function hasStorageLayoutSetting(buildInfoJson) {
+    const o = buildInfoJson.input.settings?.outputSelection;
+    return o?.['*']?.['*'] && (o['*']['*'].includes('storageLayout') || o['*']['*'].includes('*'));
+}
+async function readJSON(path) {
+    return JSON.parse(await fs_1.promises.readFile(path, 'utf8'));
+}
+//# sourceMappingURL=build-info-file.js.map

package/dist/cli/validate/build-info-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-info-file.js","sourceRoot":"","sources":["../../../src/cli/validate/build-info-file.ts"],"names":[],"mappings":";;;;;;AAEA,2BAAoC;AACpC,gDAAwB;AACxB,mCAA+C;AAE/C,MAAM,uBAAuB,GAAG,0CAA0C,CAAC;AAC3E,MAAM,uBAAuB,GAAG,4BAA4B,CAAC;AAC7D,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;sCAaU,uBAAuB;;;;;;sCAMvB,uBAAuB,kBAAkB,CAAC;AAiBhF;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CAAC,YAAqB;IAC3D,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;IAC1C,OAAO,MAAM,aAAa,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAJD,8CAIC;AAED,KAAK,UAAU,OAAO,CAAC,YAAgC;IACrD,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE;QACrE,MAAM,IAAI,4BAAoB,CAC5B,kBAAkB,YAAY,4DAA4D,EAC1F,GAAG,EAAE,CAAC;;+BAEmB,uBAAuB,SAAS,uBAAuB,oEAAoE,CACrJ,CAAC;KACH;IACD,MAAM,GAAG,GAAG,YAAY,IAAI,CAAC,MAAM,cAAc,EAAE,CAAC,CAAC;IACrD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,cAAc;IAC3B,MAAM,kBAAkB,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAChE,MAAM,kBAAkB,GAAG,cAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAE1D,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,CAAC,CAAC;IAChE,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAkB,CAAC,CAAC;IAEhE,MAAM,mBAAmB,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC;IAC3D,MAAM,mBAAmB,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC;IAE3D,IAAI,mBAAmB,IAAI,mBAAmB,EAAE;QAC9C,MAAM,IAAI,4BAAoB,CAC5B,2DAA2D,kBAAkB,UAAU,kBAAkB,IAAI,EAC7G,GAAG,EAAE,CAAC,6DAA6D,CACpE,CAAC;KACH;SAAM,IAAI,mBAAmB,EAAE;QAC9B,OAAO,UAAU,CAAC;KACnB;SAAM,IAAI,mBAAmB,EAAE;QAC9B,OAAO,UAAU,CAAC;KACnB;SAAM;QACL,MAAM,IAAI,4BAAoB,CAC5B,qEAAqE,EACrE,GAAG,EAAE,CACH,gCAAgC,uBAAuB,SAAS,uBAAuB,mEAAmE,CAC7J,CAAC;KACH;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,GAAW;IACrC,OAAO,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACrE,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,GAAW;IAC/B,IAAI;QACF,MAAM,aAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;KACb;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,GAAW;IACrC,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,kBAA4B;IACvD,MAAM,cAAc,GAAoB,EAAE,CAAC;IAE3C,KAAK,MAAM,iBAAiB,IAAI,kBAAkB,EAAE;QAClD,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACxD,IAAI,aAAa,CAAC,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YAC3E,MAAM,IAAI,4BAAoB,CAC5B,mBAAmB,iBAAiB,mDAAmD,CACxF,CAAC;SACH;aAAM;YACL,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,EAAE;gBAC3C,MAAM,IAAI,4BAAoB,CAC5B,mBAAmB,iBAAiB,mCAAmC,EACvE,GAAG,EAAE,CAAC,mBAAmB,CAC1B,CAAC;aACH;YAED,cAAc,CAAC,IAAI,CAAC;gBAClB,KAAK,EAAE,aAAa,CAAC,KAAK;gBAC1B,MAAM,EAAE,aAAa,CAAC,MAAM;aAC7B,CAAC,CAAC;SACJ;KACF;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,uBAAuB,CAAC,aAAkB;IACjD,MAAM,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,eAAe,CAAC;IACxD,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AACjG,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AACrD,CAAC"}

package/dist/cli/validate/build-info-file.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=build-info-file.test.d.ts.map

package/dist/cli/validate/build-info-file.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-info-file.test.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/build-info-file.test.ts"],"names":[],"mappings":""}

package/dist/cli/validate/build-info-file.test.js

@@ -0,0 +1,175 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const fs_1 = require("fs");
+const rimraf_1 = __importDefault(require("rimraf"));
+const util_1 = __importDefault(require("util"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const build_info_file_1 = require("./build-info-file");
+const rimraf = util_1.default.promisify(rimraf_1.default);
+ava_1.default.beforeEach(async (t) => {
+    process.chdir(await fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), `upgrades-core-test-${t.title.replace(/\s/g, '-')}-`)));
+});
+ava_1.default.afterEach(async () => {
+    await rimraf(process.cwd());
+});
+const BUILD_INFO = {
+    input: {
+        language: 'Solidity',
+        sources: {
+            'mypath/MyContract.sol': {
+                content: 'contract MyContract {}',
+            },
+        },
+        settings: {
+            outputSelection: {
+                '*': {
+                    '*': ['storageLayout'],
+                },
+            },
+        },
+    },
+    output: {
+        sources: {
+            'mypath/MyContract.sol': {
+                ast: {},
+                id: 123,
+            },
+        },
+    },
+};
+const BUILD_INFO_2 = {
+    input: {
+        language: 'Solidity',
+        sources: {
+            'mypath/MyContract.sol': {
+                content: 'contract MyContractModified {}',
+            },
+        },
+        settings: {
+            outputSelection: {
+                '*': {
+                    '*': ['storageLayout'],
+                },
+            },
+        },
+    },
+    output: {
+        sources: {
+            'mypath/MyContract.sol': {
+                ast: {},
+                id: 456,
+            },
+        },
+    },
+};
+const BUILD_INFO_NO_LAYOUT = {
+    input: {
+        language: 'Solidity',
+        sources: {
+            'mypath/MyContract.sol': {
+                content: 'contract MyContract {}',
+            },
+        },
+        settings: {
+            outputSelection: {
+                '*': {
+                    '*': ['abi'],
+                },
+            },
+        },
+    },
+    output: {
+        sources: {
+            'mypath/MyContract.sol': {
+                ast: {},
+                id: 123,
+            },
+        },
+    },
+};
+ava_1.default.serial('get build info files - default hardhat', async (t) => {
+    await fs_1.promises.mkdir('artifacts/build-info', { recursive: true });
+    await fs_1.promises.mkdir('out/build-info', { recursive: true }); // should be ignored since it's empty
+    await fs_1.promises.writeFile('artifacts/build-info/build-info.json', JSON.stringify(BUILD_INFO));
+    await fs_1.promises.writeFile('artifacts/build-info/build-info-2.json', JSON.stringify(BUILD_INFO_2));
+    const buildInfoFiles = await (0, build_info_file_1.getBuildInfoFiles)();
+    assertBuildInfoFiles(t, buildInfoFiles);
+});
+ava_1.default.serial('get build info files - default foundry', async (t) => {
+    await fs_1.promises.mkdir('out/build-info', { recursive: true });
+    await fs_1.promises.mkdir('artifacts/build-info', { recursive: true }); // should be ignored since it's empty
+    await fs_1.promises.writeFile('out/build-info/build-info.json', JSON.stringify(BUILD_INFO));
+    await fs_1.promises.writeFile('out/build-info/build-info-2.json', JSON.stringify(BUILD_INFO_2));
+    const buildInfoFiles = await (0, build_info_file_1.getBuildInfoFiles)();
+    assertBuildInfoFiles(t, buildInfoFiles);
+});
+ava_1.default.serial('get build info files - both hardhat and foundry dirs exist', async (t) => {
+    await fs_1.promises.mkdir('artifacts/build-info', { recursive: true });
+    await fs_1.promises.writeFile('artifacts/build-info/build-info.json', JSON.stringify(BUILD_INFO));
+    await fs_1.promises.mkdir('out/build-info', { recursive: true });
+    await fs_1.promises.writeFile('out/build-info/build-info-2.json', JSON.stringify(BUILD_INFO_2));
+    const error = await t.throwsAsync((0, build_info_file_1.getBuildInfoFiles)());
+    t.true(error?.message.includes('Found both Hardhat and Foundry build info directories'));
+});
+ava_1.default.serial('get build info files - no default dirs exist', async (t) => {
+    const error = await t.throwsAsync((0, build_info_file_1.getBuildInfoFiles)());
+    t.true(error?.message.includes('Could not find the default Hardhat or Foundry build info directory'));
+});
+ava_1.default.serial('get build info files - override with custom relative path', async (t) => {
+    await fs_1.promises.mkdir('artifacts/build-info', { recursive: true });
+    await fs_1.promises.mkdir('out/build-info', { recursive: true });
+    await fs_1.promises.mkdir('custom/build-info', { recursive: true });
+    await fs_1.promises.writeFile('custom/build-info/build-info.json', JSON.stringify(BUILD_INFO));
+    await fs_1.promises.writeFile('custom/build-info/build-info-2.json', JSON.stringify(BUILD_INFO_2));
+    const buildInfoFiles = await (0, build_info_file_1.getBuildInfoFiles)('custom/build-info');
+    assertBuildInfoFiles(t, buildInfoFiles);
+});
+ava_1.default.serial('get build info files - override with custom absolute path', async (t) => {
+    await fs_1.promises.mkdir('artifacts/build-info', { recursive: true });
+    await fs_1.promises.mkdir('out/build-info', { recursive: true });
+    await fs_1.promises.mkdir('custom/build-info', { recursive: true });
+    await fs_1.promises.writeFile('custom/build-info/build-info.json', JSON.stringify(BUILD_INFO));
+    await fs_1.promises.writeFile('custom/build-info/build-info-2.json', JSON.stringify(BUILD_INFO_2));
+    const buildInfoFiles = await (0, build_info_file_1.getBuildInfoFiles)(path_1.default.join(process.cwd(), 'custom/build-info'));
+    assertBuildInfoFiles(t, buildInfoFiles);
+});
+ava_1.default.serial('invalid build info file', async (t) => {
+    await fs_1.promises.mkdir('invalid-build-info', { recursive: true });
+    await fs_1.promises.writeFile('invalid-build-info/invalid.json', JSON.stringify({ output: {} }));
+    const error = await t.throwsAsync((0, build_info_file_1.getBuildInfoFiles)('invalid-build-info'));
+    t.true(error?.message.includes('must contain Solidity compiler input and output'));
+});
+ava_1.default.serial('dir does not exist', async (t) => {
+    const error = await t.throwsAsync((0, build_info_file_1.getBuildInfoFiles)('invalid-dir'));
+    t.true(error?.message.includes('does not exist'));
+});
+ava_1.default.serial('no build info files', async (t) => {
+    await fs_1.promises.mkdir('empty-dir', { recursive: true });
+    await fs_1.promises.writeFile('empty-dir/notjson.txt', 'abc');
+    const error = await t.throwsAsync((0, build_info_file_1.getBuildInfoFiles)('empty-dir'));
+    t.true(error?.message.includes('does not contain any build info files'));
+});
+ava_1.default.serial('no storage layout', async (t) => {
+    await fs_1.promises.mkdir('no-storage-layout', { recursive: true });
+    await fs_1.promises.writeFile('no-storage-layout/build-info.json', JSON.stringify(BUILD_INFO_NO_LAYOUT));
+    const error = await t.throwsAsync((0, build_info_file_1.getBuildInfoFiles)('no-storage-layout'));
+    t.true(error?.message.includes('does not contain storage layout'));
+});
+function assertBuildInfoFiles(t, buildInfoFiles) {
+    t.is(buildInfoFiles.length, 2);
+    const buildInfoFile1 = buildInfoFiles.find(b => b.input.sources['mypath/MyContract.sol'].content === 'contract MyContract {}');
+    const buildInfoFile2 = buildInfoFiles.find(b => b.input.sources['mypath/MyContract.sol'].content === 'contract MyContractModified {}');
+    if (buildInfoFile1 === undefined || buildInfoFile2 === undefined) {
+        t.fail('build info files not found');
+    }
+    else {
+        t.is(buildInfoFile1.output.sources['mypath/MyContract.sol'].id, 123);
+        t.is(buildInfoFile2.output.sources['mypath/MyContract.sol'].id, 456);
+    }
+}
+//# sourceMappingURL=build-info-file.test.js.map

package/dist/cli/validate/build-info-file.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-info-file.test.js","sourceRoot":"","sources":["../../../src/cli/validate/build-info-file.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA6C;AAE7C,2BAAoC;AACpC,oDAAiC;AACjC,gDAAwB;AACxB,gDAAwB;AACxB,4CAAoB;AACpB,uDAAqE;AAErE,MAAM,MAAM,GAAG,cAAI,CAAC,SAAS,CAAC,gBAAW,CAAC,CAAC;AAE3C,aAAI,CAAC,UAAU,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;IACxB,OAAO,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAChH,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;IACxB,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG;IACjB,KAAK,EAAE;QACL,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE;YACP,uBAAuB,EAAE;gBACvB,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,QAAQ,EAAE;YACR,eAAe,EAAE;gBACf,GAAG,EAAE;oBACH,GAAG,EAAE,CAAC,eAAe,CAAC;iBACvB;aACF;SACF;KACF;IACD,MAAM,EAAE;QACN,OAAO,EAAE;YACP,uBAAuB,EAAE;gBACvB,GAAG,EAAE,EAAE;gBACP,EAAE,EAAE,GAAG;aACR;SACF;KACF;CACF,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,KAAK,EAAE;QACL,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE;YACP,uBAAuB,EAAE;gBACvB,OAAO,EAAE,gCAAgC;aAC1C;SACF;QACD,QAAQ,EAAE;YACR,eAAe,EAAE;gBACf,GAAG,EAAE;oBACH,GAAG,EAAE,CAAC,eAAe,CAAC;iBACvB;aACF;SACF;KACF;IACD,MAAM,EAAE;QACN,OAAO,EAAE;YACP,uBAAuB,EAAE;gBACvB,GAAG,EAAE,EAAE;gBACP,EAAE,EAAE,GAAG;aACR;SACF;KACF;CACF,CAAC;AAEF,MAAM,oBAAoB,GAAG;IAC3B,KAAK,EAAE;QACL,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE;YACP,uBAAuB,EAAE;gBACvB,OAAO,EAAE,wBAAwB;aAClC;SACF;QACD,QAAQ,EAAE;YACR,eAAe,EAAE;gBACf,GAAG,EAAE;oBACH,GAAG,EAAE,CAAC,KAAK,CAAC;iBACb;aACF;SACF;KACF;IACD,MAAM,EAAE;QACN,OAAO,EAAE;YACP,uBAAuB,EAAE;gBACvB,GAAG,EAAE,EAAE;gBACP,EAAE,EAAE,GAAG;aACR;SACF;KACF;CACF,CAAC;AAEF,aAAI,CAAC,MAAM,CAAC,wCAAwC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9D,MAAM,aAAE,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,MAAM,aAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,qCAAqC;IAE5F,MAAM,aAAE,CAAC,SAAS,CAAC,sCAAsC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACvF,MAAM,aAAE,CAAC,SAAS,CAAC,wCAAwC,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAE3F,MAAM,cAAc,GAAG,MAAM,IAAA,mCAAiB,GAAE,CAAC;IAEjD,oBAAoB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,wCAAwC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9D,MAAM,aAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,MAAM,aAAE,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,qCAAqC;IAElG,MAAM,aAAE,CAAC,SAAS,CAAC,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACjF,MAAM,aAAE,CAAC,SAAS,CAAC,kCAAkC,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAErF,MAAM,cAAc,GAAG,MAAM,IAAA,mCAAiB,GAAE,CAAC;IAEjD,oBAAoB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,4DAA4D,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAClF,MAAM,aAAE,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,MAAM,aAAE,CAAC,SAAS,CAAC,sCAAsC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAEvF,MAAM,aAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,MAAM,aAAE,CAAC,SAAS,CAAC,kCAAkC,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAErF,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,mCAAiB,GAAE,CAAC,CAAC;IACvD,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,uDAAuD,CAAC,CAAC,CAAC;AAC3F,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,8CAA8C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACpE,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,mCAAiB,GAAE,CAAC,CAAC;IACvD,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,oEAAoE,CAAC,CAAC,CAAC;AACxG,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,2DAA2D,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjF,MAAM,aAAE,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,MAAM,aAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtD,MAAM,aAAE,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEzD,MAAM,aAAE,CAAC,SAAS,CAAC,mCAAmC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACpF,MAAM,aAAE,CAAC,SAAS,CAAC,qCAAqC,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAExF,MAAM,cAAc,GAAG,MAAM,IAAA,mCAAiB,EAAC,mBAAmB,CAAC,CAAC;IAEpE,oBAAoB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,2DAA2D,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjF,MAAM,aAAE,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,MAAM,aAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtD,MAAM,aAAE,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEzD,MAAM,aAAE,CAAC,SAAS,CAAC,mCAAmC,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACpF,MAAM,aAAE,CAAC,SAAS,CAAC,qCAAqC,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IAExF,MAAM,cAAc,GAAG,MAAM,IAAA,mCAAiB,EAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAE9F,oBAAoB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,yBAAyB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC/C,MAAM,aAAE,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE1D,MAAM,aAAE,CAAC,SAAS,CAAC,iCAAiC,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACtF,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,mCAAiB,EAAC,oBAAoB,CAAC,CAAC,CAAC;IAC3E,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,mCAAiB,EAAC,aAAa,CAAC,CAAC,CAAC;IACpE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3C,MAAM,aAAE,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,MAAM,aAAE,CAAC,SAAS,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IAEnD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,mCAAiB,EAAC,WAAW,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,uCAAuC,CAAC,CAAC,CAAC;AAC3E,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACzC,MAAM,aAAE,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,MAAM,aAAE,CAAC,SAAS,CAAC,mCAAmC,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAE9F,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,mCAAiB,EAAC,mBAAmB,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CAAC,CAAC;AACrE,CAAC,CAAC,CAAC;AAEH,SAAS,oBAAoB,CAAC,CAAmB,EAAE,cAA+B;IAChF,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/B,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,OAAO,KAAK,wBAAwB,CACnF,CAAC;IACF,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,OAAO,KAAK,gCAAgC,CAC3F,CAAC;IAEF,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,EAAE;QAChE,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;KACtC;SAAM;QACL,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACrE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;KACtE;AACH,CAAC"}

package/dist/cli/validate/contract-report.d.ts

@@ -0,0 +1,31 @@
+import { ValidateUpgradeSafetyOptions, UpgradeableContractErrorReport } from '../..';
+import { Report } from '../../standalone';
+import { SourceContract } from './validations';
+import { LayoutCompatibilityReport } from '../../storage/report';
+/**
+ * Report for an upgradeable contract.
+ * Contains the standalone report, and if there is a reference contract, the reference contract name and storage layout report.
+ */
+export declare class UpgradeableContractReport implements Report {
+    readonly contract: string;
+    readonly reference: string | undefined;
+    readonly standaloneReport: UpgradeableContractErrorReport;
+    readonly storageLayoutReport: LayoutCompatibilityReport | undefined;
+    constructor(contract: string, reference: string | undefined, standaloneReport: UpgradeableContractErrorReport, storageLayoutReport: LayoutCompatibilityReport | undefined);
+    get ok(): boolean;
+    /**
+     * Explain any errors in the report.
+     */
+    explain(color?: boolean): string;
+}
+/**
+ * Gets upgradeble contract reports for the upgradeable contracts in the given set of source contracts.
+ * Only contracts that are detected as upgradeable will be included in the reports.
+ * Reports include upgradeable contracts regardless of whether they pass or fail upgrade safety checks.
+ *
+ * @param sourceContracts The source contracts to check, which must include all contracts that are referenced by the given contracts. Can also include non-upgradeable contracts, which will be ignored.
+ * @param opts The validation options.
+ * @returns The upgradeable contract reports.
+ */
+export declare function getContractReports(sourceContracts: SourceContract[], opts: ValidateUpgradeSafetyOptions): UpgradeableContractReport[];
+//# sourceMappingURL=contract-report.d.ts.map

package/dist/cli/validate/contract-report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-report.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/contract-report.ts"],"names":[],"mappings":"AAEA,OAAO,EAOL,4BAA4B,EAE5B,8BAA8B,EAE/B,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAGjE;;;GAGG;AACH,qBAAa,yBAA0B,YAAW,MAAM;IAEpD,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IACtC,QAAQ,CAAC,gBAAgB,EAAE,8BAA8B;IACzD,QAAQ,CAAC,mBAAmB,EAAE,yBAAyB,GAAG,SAAS;gBAH1D,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,gBAAgB,EAAE,8BAA8B,EAChD,mBAAmB,EAAE,yBAAyB,GAAG,SAAS;IAGrE,IAAI,EAAE,IAAI,OAAO,CAEhB;IAED;;OAEG;IACH,OAAO,CAAC,KAAK,UAAO,GAAG,MAAM;CAiB9B;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,4BAA4B,+BAgBvG"}

package/dist/cli/validate/contract-report.js

@@ -0,0 +1,107 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContractReports = exports.UpgradeableContractReport = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const debug_1 = __importDefault(require("../../utils/debug"));
+const __1 = require("../..");
+const upgradeability_assessment_1 = require("./upgradeability-assessment");
+const indent_1 = require("../../utils/indent");
+/**
+ * Report for an upgradeable contract.
+ * Contains the standalone report, and if there is a reference contract, the reference contract name and storage layout report.
+ */
+class UpgradeableContractReport {
+    constructor(contract, reference, standaloneReport, storageLayoutReport) {
+        this.contract = contract;
+        this.reference = reference;
+        this.standaloneReport = standaloneReport;
+        this.storageLayoutReport = storageLayoutReport;
+    }
+    get ok() {
+        return this.standaloneReport.ok && (this.storageLayoutReport === undefined || this.storageLayoutReport.ok);
+    }
+    /**
+     * Explain any errors in the report.
+     */
+    explain(color = true) {
+        const result = [];
+        const chalk = new chalk_1.default.Instance({ level: color && chalk_1.default.supportsColor ? chalk_1.default.supportsColor.level : 0 });
+        const icon = this.ok ? chalk.green('✔') : chalk.red('✘');
+        if (this.reference === undefined) {
+            result.push(` ${icon}  ${this.contract}`);
+        }
+        else {
+            result.push(` ${icon}  ${this.contract} (upgrades from ${this.reference})`);
+        }
+        if (!this.standaloneReport.ok) {
+            result.push((0, indent_1.indent)(this.standaloneReport.explain(color), 6));
+        }
+        if (this.storageLayoutReport !== undefined && !this.storageLayoutReport.ok) {
+            result.push((0, indent_1.indent)(this.storageLayoutReport.explain(color), 6));
+        }
+        return result.join('\n\n');
+    }
+}
+exports.UpgradeableContractReport = UpgradeableContractReport;
+/**
+ * Gets upgradeble contract reports for the upgradeable contracts in the given set of source contracts.
+ * Only contracts that are detected as upgradeable will be included in the reports.
+ * Reports include upgradeable contracts regardless of whether they pass or fail upgrade safety checks.
+ *
+ * @param sourceContracts The source contracts to check, which must include all contracts that are referenced by the given contracts. Can also include non-upgradeable contracts, which will be ignored.
+ * @param opts The validation options.
+ * @returns The upgradeable contract reports.
+ */
+function getContractReports(sourceContracts, opts) {
+    const upgradeableContractReports = [];
+    for (const sourceContract of sourceContracts) {
+        const upgradeabilityAssessment = (0, upgradeability_assessment_1.getUpgradeabilityAssessment)(sourceContract, sourceContracts);
+        if (upgradeabilityAssessment.upgradeable) {
+            const reference = upgradeabilityAssessment.referenceContract;
+            const uups = upgradeabilityAssessment.uups;
+            const kind = uups ? 'uups' : 'transparent';
+            const report = getUpgradeableContractReport(sourceContract, reference, { ...opts, kind: kind });
+            if (report !== undefined) {
+                upgradeableContractReports.push(report);
+            }
+        }
+    }
+    return upgradeableContractReports;
+}
+exports.getContractReports = getContractReports;
+function getUpgradeableContractReport(contract, referenceContract, opts) {
+    let version;
+    try {
+        version = (0, __1.getContractVersion)(contract.validationData, contract.name);
+    }
+    catch (e) {
+        if (e.message.endsWith('is abstract')) {
+            // Skip abstract upgradeable contracts - they will be validated as part of their caller contracts
+            // for the functions that are in use.
+            return undefined;
+        }
+        else {
+            throw e;
+        }
+    }
+    (0, debug_1.default)('Checking: ' + contract.fullyQualifiedName);
+    const standaloneReport = getStandaloneReport(contract.validationData, version, opts);
+    let reference;
+    let storageLayoutReport;
+    if (opts.unsafeSkipStorageCheck !== true && referenceContract !== undefined) {
+        const layout = (0, __1.getStorageLayout)(contract.validationData, version);
+        const referenceVersion = (0, __1.getContractVersion)(referenceContract.validationData, referenceContract.name);
+        const referenceLayout = (0, __1.getStorageLayout)(referenceContract.validationData, referenceVersion);
+        reference = referenceContract.fullyQualifiedName;
+        storageLayoutReport = (0, __1.getStorageUpgradeReport)(referenceLayout, layout, (0, __1.withValidationDefaults)(opts));
+    }
+    return new UpgradeableContractReport(contract.fullyQualifiedName, reference, standaloneReport, storageLayoutReport);
+}
+function getStandaloneReport(data, version, opts) {
+    const errors = (0, __1.getErrors)(data, version, (0, __1.withValidationDefaults)(opts));
+    return new __1.UpgradeableContractErrorReport(errors);
+}
+//# sourceMappingURL=contract-report.js.map