@openzeppelin/upgrades-core 1.26.1 → 1.27.0

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"contract-report.js","sourceRoot":"","sources":["../../../src/cli/validate/contract-report.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA2B;AAC3B,8DAAsC;AACtC,6BAWe;AAEf,2EAA0E;AAG1E,+CAA4C;AAE5C;;;GAGG;AACH,MAAa,yBAAyB;IACpC,YACW,QAAgB,EAChB,SAA6B,EAC7B,gBAAgD,EAChD,mBAA0D;QAH1D,aAAQ,GAAR,QAAQ,CAAQ;QAChB,cAAS,GAAT,SAAS,CAAoB;QAC7B,qBAAgB,GAAhB,gBAAgB,CAAgC;QAChD,wBAAmB,GAAnB,mBAAmB,CAAuC;IAClE,CAAC;IAEJ,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,mBAAmB,KAAK,SAAS,IAAI,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,KAAK,GAAG,IAAI;QAClB,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,IAAI,eAAM,CAAC,aAAa,CAAC,CAAC,CAAC,eAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7G,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;YAChC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC3C;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,CAAC,QAAQ,mBAAmB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;SAC7E;QACD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,EAAE;YAC7B,MAAM,CAAC,IAAI,CAAC,IAAA,eAAM,EAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SAC9D;QACD,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE;YAC1E,MAAM,CAAC,IAAI,CAAC,IAAA,eAAM,EAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SACjE;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;CACF;AAhCD,8DAgCC;AAED;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAC,eAAiC,EAAE,IAAkC;IACtG,MAAM,0BAA0B,GAAgC,EAAE,CAAC;IACnE,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;QAC5C,MAAM,wBAAwB,GAAG,IAAA,uDAA2B,EAAC,cAAc,EAAE,eAAe,CAAC,CAAC;QAC9F,IAAI,wBAAwB,CAAC,WAAW,EAAE;YACxC,MAAM,SAAS,GAAG,wBAAwB,CAAC,iBAAiB,CAAC;YAC7D,MAAM,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;YAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC;YAE3C,MAAM,MAAM,GAAG,4BAA4B,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAChG,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACzC;SACF;KACF;IACD,OAAO,0BAA0B,CAAC;AACpC,CAAC;AAhBD,gDAgBC;AAED,SAAS,4BAA4B,CACnC,QAAwB,EACxB,iBAA6C,EAC7C,IAAuB;IAEvB,IAAI,OAAO,CAAC;IACZ,IAAI;QACF,OAAO,GAAG,IAAA,sBAAkB,EAAC,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;KACtE;IAAC,OAAO,CAAM,EAAE;QACf,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YACrC,iGAAiG;YACjG,qCAAqC;YACrC,OAAO,SAAS,CAAC;SAClB;aAAM;YACL,MAAM,CAAC,CAAC;SACT;KACF;IAED,IAAA,eAAK,EAAC,YAAY,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAClD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAErF,IAAI,SAA6B,CAAC;IAClC,IAAI,mBAA0D,CAAC;IAE/D,IAAI,IAAI,CAAC,sBAAsB,KAAK,IAAI,IAAI,iBAAiB,KAAK,SAAS,EAAE;QAC3E,MAAM,MAAM,GAAG,IAAA,oBAAgB,EAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAElE,MAAM,gBAAgB,GAAG,IAAA,sBAAkB,EAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACtG,MAAM,eAAe,GAAG,IAAA,oBAAgB,EAAC,iBAAiB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAE7F,SAAS,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;QACjD,mBAAmB,GAAG,IAAA,2BAAuB,EAAC,eAAe,EAAE,MAAM,EAAE,IAAA,0BAAsB,EAAC,IAAI,CAAC,CAAC,CAAC;KACtG;IAED,OAAO,IAAI,yBAAyB,CAAC,QAAQ,CAAC,kBAAkB,EAAE,SAAS,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;AACtH,CAAC;AAED,SAAS,mBAAmB,CAC1B,IAAoB,EACpB,OAAgB,EAChB,IAAuB;IAEvB,MAAM,MAAM,GAAG,IAAA,aAAS,EAAC,IAAI,EAAE,OAAO,EAAE,IAAA,0BAAsB,EAAC,IAAI,CAAC,CAAC,CAAC;IACtE,OAAO,IAAI,kCAA8B,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC"}

package/dist/cli/validate/error.d.ts

@@ -0,0 +1,4 @@
+import { UpgradesError } from '../..';
+export declare class ValidateCommandError extends UpgradesError {
+}
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,qBAAa,oBAAqB,SAAQ,aAAa;CAAG"}

package/dist/cli/validate/error.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidateCommandError = void 0;
+const __1 = require("../..");
+class ValidateCommandError extends __1.UpgradesError {
+}
+exports.ValidateCommandError = ValidateCommandError;
+//# sourceMappingURL=error.js.map

package/dist/cli/validate/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/cli/validate/error.ts"],"names":[],"mappings":";;;AAAA,6BAAsC;AAEtC,MAAa,oBAAqB,SAAQ,iBAAa;CAAG;AAA1D,oDAA0D"}

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

@@ -0,0 +1,18 @@
+import { UpgradeableContractReport } from './contract-report';
+import { Report } from '../../standalone';
+export declare class ProjectReport implements Report {
+    readonly upgradeableContractReports: UpgradeableContractReport[];
+    constructor(upgradeableContractReports: UpgradeableContractReport[]);
+    get ok(): boolean;
+    explain(color?: boolean): string;
+    /**
+     * Number of contracts that passed upgrade safety checks.
+     */
+    get numPassed(): number;
+    /**
+     * Total number of upgradeable contracts detected.
+     */
+    get numTotal(): number;
+}
+export declare function getProjectReport(upgradeableContractReports: UpgradeableContractReport[]): ProjectReport;
+//# sourceMappingURL=project-report.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"project-report.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/project-report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,qBAAa,aAAc,YAAW,MAAM;IAC9B,QAAQ,CAAC,0BAA0B,EAAE,yBAAyB,EAAE;gBAAvD,0BAA0B,EAAE,yBAAyB,EAAE;IAE5E,IAAI,EAAE,IAAI,OAAO,CAEhB;IAED,OAAO,CAAC,KAAK,UAAO,GAAG,MAAM;IAgB7B;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;CACF;AAED,wBAAgB,gBAAgB,CAAC,0BAA0B,EAAE,yBAAyB,EAAE,GAAG,aAAa,CAEvG"}

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectReport = exports.ProjectReport = void 0;
+class ProjectReport {
+    constructor(upgradeableContractReports) {
+        this.upgradeableContractReports = upgradeableContractReports;
+    }
+    get ok() {
+        return this.upgradeableContractReports.every(r => r.ok);
+    }
+    explain(color = true) {
+        if (this.numTotal === 0) {
+            return 'No upgradeable contracts detected.';
+        }
+        else {
+            const lines = this.upgradeableContractReports.map(r => r.explain(color));
+            const numFailed = this.numTotal - this.numPassed;
+            const plural = numFailed === 1 ? '' : 's';
+            const status = this.ok ? 'SUCCESS' : 'FAILED';
+            lines.push(`${status} (${this.numTotal} upgradeable contract${plural} detected, ${this.numPassed} passed, ${numFailed} failed)`);
+            return lines.join('\n\n');
+        }
+    }
+    /**
+     * Number of contracts that passed upgrade safety checks.
+     */
+    get numPassed() {
+        return this.upgradeableContractReports.filter(r => r.ok).length;
+    }
+    /**
+     * Total number of upgradeable contracts detected.
+     */
+    get numTotal() {
+        return this.upgradeableContractReports.length;
+    }
+}
+exports.ProjectReport = ProjectReport;
+function getProjectReport(upgradeableContractReports) {
+    return new ProjectReport(upgradeableContractReports);
+}
+exports.getProjectReport = getProjectReport;
+//# sourceMappingURL=project-report.js.map

package/dist/cli/validate/project-report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-report.js","sourceRoot":"","sources":["../../../src/cli/validate/project-report.ts"],"names":[],"mappings":";;;AAGA,MAAa,aAAa;IACxB,YAAqB,0BAAuD;QAAvD,+BAA0B,GAA1B,0BAA0B,CAA6B;IAAG,CAAC;IAEhF,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,CAAC,KAAK,GAAG,IAAI;QAClB,IAAI,IAAI,CAAC,QAAQ,KAAK,CAAC,EAAE;YACvB,OAAO,oCAAoC,CAAC;SAC7C;aAAM;YACL,MAAM,KAAK,GAAG,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YACzE,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;YACjD,MAAM,MAAM,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;YAE9C,KAAK,CAAC,IAAI,CACR,GAAG,MAAM,KAAK,IAAI,CAAC,QAAQ,wBAAwB,MAAM,cAAc,IAAI,CAAC,SAAS,YAAY,SAAS,UAAU,CACrH,CAAC;YACF,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC3B;IACH,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC;IAChD,CAAC;CACF;AApCD,sCAoCC;AAED,SAAgB,gBAAgB,CAAC,0BAAuD;IACtF,OAAO,IAAI,aAAa,CAAC,0BAA0B,CAAC,CAAC;AACvD,CAAC;AAFD,4CAEC"}

package/dist/cli/validate/project-report.test.d.ts

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

package/dist/cli/validate/project-report.test.d.ts.map

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

package/dist/cli/validate/project-report.test.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const project_report_1 = require("./project-report");
+const validate_1 = require("../../validate");
+const ava_1 = __importDefault(require("ava"));
+const utils_1 = require("solidity-ast/utils");
+const hardhat_1 = require("hardhat");
+const ast_dereferencer_1 = require("../../ast-dereferencer");
+const extract_1 = require("../../storage/extract");
+const compare_1 = require("../../storage/compare");
+const layout_1 = require("../../storage/layout");
+const contract_report_1 = require("./contract-report");
+const test = ava_1.default;
+const dummyDecodeSrc = () => 'file.sol:1';
+test.before(async (t) => {
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/Storage.sol:Storage1');
+    if (buildInfo === undefined) {
+        throw new Error('Build info not found');
+    }
+    const solcOutput = buildInfo.output;
+    const contracts = {};
+    for (const def of (0, utils_1.findAll)('ContractDefinition', solcOutput.sources['contracts/test/Storage.sol'].ast)) {
+        contracts[def.name] = def;
+    }
+    const deref = (0, ast_dereferencer_1.astDereferencer)(solcOutput);
+    t.context.extractStorageLayout = name => (0, extract_1.extractStorageLayout)(contracts[name], dummyDecodeSrc, deref);
+});
+function getLayoutReport(original, updated) {
+    const originalDetailed = (0, layout_1.getDetailedLayout)(original);
+    const updatedDetailed = (0, layout_1.getDetailedLayout)(updated);
+    const comparator = new compare_1.StorageLayoutComparator();
+    return comparator.compareLayouts(originalDetailed, updatedDetailed);
+}
+test('get project report - ok - no upgradeable', async (t) => {
+    const report = (0, project_report_1.getProjectReport)([]);
+    t.true(report.ok);
+    t.is(report.numPassed, 0);
+    t.is(report.numTotal, 0);
+    t.is(report.explain(), 'No upgradeable contracts detected.');
+});
+test('get project report - ok - console', async (t) => {
+    const report = (0, project_report_1.getProjectReport)([
+        new contract_report_1.UpgradeableContractReport('mypath/MyContract.sol:MyContract1', undefined, new validate_1.UpgradeableContractErrorReport([]), undefined),
+    ]);
+    t.true(report.ok);
+    t.is(report.numPassed, 1);
+    t.is(report.numTotal, 1);
+    t.regex(report.explain(), /SUCCESS \(1 upgradeable contracts detected, 1 passed, 0 failed\)/);
+});
+test('get project report - errors - console', async (t) => {
+    const v1 = t.context.extractStorageLayout('StorageUpgrade_Replace_V1');
+    const v2 = t.context.extractStorageLayout('StorageUpgrade_Replace_V2');
+    const layoutReport = getLayoutReport(v1, v2);
+    const report = (0, project_report_1.getProjectReport)([
+        new contract_report_1.UpgradeableContractReport('mypath/MyContract.sol:MyContract', undefined, new validate_1.UpgradeableContractErrorReport([
+            {
+                src: 'MyContract.sol:10',
+                kind: 'missing-public-upgradeto',
+            },
+            {
+                src: 'MyContract.sol:20',
+                kind: 'delegatecall',
+            },
+        ]), undefined),
+        new contract_report_1.UpgradeableContractReport('MyContract2', 'MyContract', new validate_1.UpgradeableContractErrorReport([]), layoutReport),
+    ]);
+    t.false(report.ok);
+    t.is(report.numPassed, 0);
+    t.is(report.numTotal, 2);
+    t.snapshot(report.explain());
+});
+test('get project report - some passed', async (t) => {
+    const report = (0, project_report_1.getProjectReport)([
+        new contract_report_1.UpgradeableContractReport('mypath/MyContract.sol:MyContract1', undefined, new validate_1.UpgradeableContractErrorReport([
+            {
+                src: 'MyContract.sol:10',
+                kind: 'missing-public-upgradeto',
+            },
+        ]), undefined),
+        new contract_report_1.UpgradeableContractReport('mypath/MyContract.sol:MyContract2', undefined, new validate_1.UpgradeableContractErrorReport([]), undefined),
+    ]);
+    t.false(report.ok);
+    t.is(report.numPassed, 1);
+    t.is(report.numTotal, 2);
+    t.snapshot(report.explain());
+});
+//# sourceMappingURL=project-report.test.js.map

package/dist/cli/validate/project-report.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-report.test.js","sourceRoot":"","sources":["../../../src/cli/validate/project-report.test.ts"],"names":[],"mappings":";;;;;AAAA,qDAAoD;AACpD,6CAAgE;AAEhE,8CAAoC;AAEpC,8CAA6C;AAC7C,qCAAoC;AAGpC,6DAAyD;AACzD,mDAA6D;AAC7D,mDAAgE;AAChE,iDAAwE;AACxE,uDAA8D;AAM9D,MAAM,IAAI,GAAG,aAAwB,CAAC;AAEtC,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC;AAE1C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;IACpB,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,qCAAqC,CAAC,CAAC;IACtF,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IACD,MAAM,UAAU,GAAe,SAAS,CAAC,MAAM,CAAC;IAChD,MAAM,SAAS,GAAuC,EAAE,CAAC;IACzD,KAAK,MAAM,GAAG,IAAI,IAAA,eAAO,EAAC,oBAAoB,EAAE,UAAU,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC,GAAG,CAAC,EAAE;QACrG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;KAC3B;IACD,MAAM,KAAK,GAAG,IAAA,kCAAe,EAAC,UAAU,CAAC,CAAC;IAC1C,CAAC,CAAC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,IAAA,8BAAoB,EAAC,SAAS,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;AACxG,CAAC,CAAC,CAAC;AAEH,SAAS,eAAe,CAAC,QAAuB,EAAE,OAAsB;IACtE,MAAM,gBAAgB,GAAG,IAAA,0BAAiB,EAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,iCAAuB,EAAE,CAAC;IACjD,OAAO,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;AACtE,CAAC;AAED,IAAI,CAAC,0CAA0C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACzD,MAAM,MAAM,GAAG,IAAA,iCAAgB,EAAC,EAAE,CAAC,CAAC;IACpC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC1B,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,oCAAoC,CAAC,CAAC;AAC/D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mCAAmC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAClD,MAAM,MAAM,GAAG,IAAA,iCAAgB,EAAC;QAC9B,IAAI,2CAAyB,CAC3B,mCAAmC,EACnC,SAAS,EACT,IAAI,yCAA8B,CAAC,EAAE,CAAC,EACtC,SAAS,CACV;KACF,CAAC,CAAC;IAEH,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC1B,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,kEAAkE,CAAC,CAAC;AAChG,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACtD,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAE7C,MAAM,MAAM,GAAG,IAAA,iCAAgB,EAAC;QAC9B,IAAI,2CAAyB,CAC3B,kCAAkC,EAClC,SAAS,EACT,IAAI,yCAA8B,CAAC;YACjC;gBACE,GAAG,EAAE,mBAAmB;gBACxB,IAAI,EAAE,0BAA0B;aACjC;YACD;gBACE,GAAG,EAAE,mBAAmB;gBACxB,IAAI,EAAE,cAAc;aACrB;SACF,CAAC,EACF,SAAS,CACV;QACD,IAAI,2CAAyB,CAAC,aAAa,EAAE,YAAY,EAAE,IAAI,yCAA8B,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC;KACjH,CAAC,CAAC;IAEH,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC1B,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kCAAkC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjD,MAAM,MAAM,GAAG,IAAA,iCAAgB,EAAC;QAC9B,IAAI,2CAAyB,CAC3B,mCAAmC,EACnC,SAAS,EACT,IAAI,yCAA8B,CAAC;YACjC;gBACE,GAAG,EAAE,mBAAmB;gBACxB,IAAI,EAAE,0BAA0B;aACjC;SACF,CAAC,EACF,SAAS,CACV;QACD,IAAI,2CAAyB,CAC3B,mCAAmC,EACnC,SAAS,EACT,IAAI,yCAA8B,CAAC,EAAE,CAAC,EACtC,SAAS,CACV;KACF,CAAC,CAAC;IAEH,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC1B,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC"}

package/dist/cli/validate/upgradeability-assessment.d.ts

@@ -0,0 +1,19 @@
+import { SourceContract } from './validations';
+export declare class ReferenceContractNotFound extends Error {
+    /**
+     * The contract reference that could not be found.
+     */
+    readonly reference: string;
+    /**
+     * The fully qualified name of the contract that referenced the missing contract.
+     */
+    readonly origin: string;
+    constructor(reference: string, origin: string);
+}
+export interface UpgradeabilityAssessment {
+    upgradeable: boolean;
+    referenceContract?: SourceContract;
+    uups?: boolean;
+}
+export declare function getUpgradeabilityAssessment(contract: SourceContract, allContracts: SourceContract[]): UpgradeabilityAssessment;
+//# sourceMappingURL=upgradeability-assessment.d.ts.map

package/dist/cli/validate/upgradeability-assessment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgradeability-assessment.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/upgradeability-assessment.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C,qBAAa,yBAA0B,SAAQ,KAAK;IAClD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAK9C;AAOD,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,cAAc,CAAC;IACnC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,cAAc,EAAE,GAC7B,wBAAwB,CA2B1B"}

package/dist/cli/validate/upgradeability-assessment.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUpgradeabilityAssessment = exports.ReferenceContractNotFound = void 0;
+const annotations_1 = require("../../utils/annotations");
+const query_1 = require("../../validate/query");
+const error_1 = require("./error");
+class ReferenceContractNotFound extends Error {
+    constructor(reference, origin) {
+        super(`Could not find contract ${reference} referenced in ${origin}.`);
+        this.reference = reference;
+        this.origin = origin;
+    }
+}
+exports.ReferenceContractNotFound = ReferenceContractNotFound;
+function getUpgradeabilityAssessment(contract, allContracts) {
+    const fullContractName = contract.fullyQualifiedName;
+    const contractValidation = contract.validationData[fullContractName];
+    const isUUPS = (0, query_1.inferUUPS)(contract.validationData, fullContractName);
+    const annotationAssessment = getAnnotationAssessment(contract);
+    if (annotationAssessment.upgradeable) {
+        let referenceContract = undefined;
+        let isReferenceUUPS = false;
+        if (annotationAssessment.referenceName !== undefined) {
+            referenceContract = getReferenceContract(annotationAssessment.referenceName, contract, allContracts);
+            isReferenceUUPS = (0, query_1.inferUUPS)(referenceContract.validationData, referenceContract.fullyQualifiedName);
+        }
+        return {
+            upgradeable: true,
+            referenceContract: referenceContract,
+            uups: isReferenceUUPS || isUUPS,
+        };
+    }
+    else {
+        const initializable = (0, query_1.inferInitializable)(contractValidation);
+        return {
+            upgradeable: initializable || isUUPS,
+            uups: isUUPS,
+        };
+    }
+}
+exports.getUpgradeabilityAssessment = getUpgradeabilityAssessment;
+function getReferenceContract(reference, origin, allContracts) {
+    const referenceContracts = allContracts.filter(c => c.fullyQualifiedName === reference || c.name === reference);
+    if (referenceContracts.length > 1) {
+        throw new error_1.ValidateCommandError(`Found multiple contracts with name ${reference} referenced in ${origin.fullyQualifiedName}.`, () => `This may be caused by old copies of build info files. Clean and recompile your project, then run the command again with the updated files.`);
+    }
+    else if (referenceContracts.length === 1) {
+        return referenceContracts[0];
+    }
+    else {
+        throw new ReferenceContractNotFound(reference, origin.fullyQualifiedName);
+    }
+}
+function getAnnotationAssessment(contract) {
+    const node = contract.node;
+    if ('documentation' in node) {
+        const doc = (0, annotations_1.getDocumentation)(node);
+        const tag = 'oz-upgrades';
+        const hasUpgradeAnnotation = hasAnnotationTag(doc, tag);
+        if (hasUpgradeAnnotation) {
+            getAndValidateAnnotationArgs(doc, tag, contract, 0);
+        }
+        const upgradesFrom = getUpgradesFrom(doc, contract);
+        if (upgradesFrom !== undefined) {
+            return {
+                upgradeable: true,
+                referenceName: upgradesFrom,
+            };
+        }
+        else {
+            return {
+                upgradeable: hasUpgradeAnnotation,
+            };
+        }
+    }
+    else {
+        return {
+            upgradeable: false,
+        };
+    }
+}
+function getAndValidateAnnotationArgs(doc, tag, contract, expectedLength) {
+    const annotationArgs = (0, annotations_1.getAnnotationArgs)(doc, tag, undefined);
+    if (annotationArgs.length !== expectedLength) {
+        throw new error_1.ValidateCommandError(`Invalid number of arguments for @custom:${tag} annotation in contract ${contract.fullyQualifiedName}.`, () => `Found ${annotationArgs.length}, expected ${expectedLength}.`);
+    }
+    return annotationArgs;
+}
+function hasAnnotationTag(doc, tag) {
+    const regex = new RegExp(`^\\s*(@custom:${tag})(\\s|$)`, 'm');
+    return regex.test(doc);
+}
+function getUpgradesFrom(doc, contract) {
+    const tag = 'oz-upgrades-from';
+    if (hasAnnotationTag(doc, tag)) {
+        const annotationArgs = getAndValidateAnnotationArgs(doc, tag, contract, 1);
+        return annotationArgs[0];
+    }
+    else {
+        return undefined;
+    }
+}
+//# sourceMappingURL=upgradeability-assessment.js.map

package/dist/cli/validate/upgradeability-assessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgradeability-assessment.js","sourceRoot":"","sources":["../../../src/cli/validate/upgradeability-assessment.ts"],"names":[],"mappings":";;;AAAA,yDAA8E;AAC9E,gDAAqE;AACrE,mCAA+C;AAG/C,MAAa,yBAA0B,SAAQ,KAAK;IAWlD,YAAY,SAAiB,EAAE,MAAc;QAC3C,KAAK,CAAC,2BAA2B,SAAS,kBAAkB,MAAM,GAAG,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAhBD,8DAgBC;AAaD,SAAgB,2BAA2B,CACzC,QAAwB,EACxB,YAA8B;IAE9B,MAAM,gBAAgB,GAAG,QAAQ,CAAC,kBAAkB,CAAC;IACrD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG,IAAA,iBAAS,EAAC,QAAQ,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;IAEpE,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC/D,IAAI,oBAAoB,CAAC,WAAW,EAAE;QACpC,IAAI,iBAAiB,GAAG,SAAS,CAAC;QAClC,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,oBAAoB,CAAC,aAAa,KAAK,SAAS,EAAE;YACpD,iBAAiB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,aAAa,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;YACrG,eAAe,GAAG,IAAA,iBAAS,EAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;SACrG;QAED,OAAO;YACL,WAAW,EAAE,IAAI;YACjB,iBAAiB,EAAE,iBAAiB;YACpC,IAAI,EAAE,eAAe,IAAI,MAAM;SAChC,CAAC;KACH;SAAM;QACL,MAAM,aAAa,GAAG,IAAA,0BAAkB,EAAC,kBAAkB,CAAC,CAAC;QAC7D,OAAO;YACL,WAAW,EAAE,aAAa,IAAI,MAAM;YACpC,IAAI,EAAE,MAAM;SACb,CAAC;KACH;AACH,CAAC;AA9BD,kEA8BC;AAED,SAAS,oBAAoB,CAAC,SAAiB,EAAE,MAAsB,EAAE,YAA8B;IACrG,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,kBAAkB,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAEhH,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,MAAM,IAAI,4BAAoB,CAC5B,sCAAsC,SAAS,kBAAkB,MAAM,CAAC,kBAAkB,GAAG,EAC7F,GAAG,EAAE,CACH,4IAA4I,CAC/I,CAAC;KACH;SAAM,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1C,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC;KAC9B;SAAM;QACL,MAAM,IAAI,yBAAyB,CAAC,SAAS,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC;KAC3E;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,QAAwB;IACvD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAE3B,IAAI,eAAe,IAAI,IAAI,EAAE;QAC3B,MAAM,GAAG,GAAG,IAAA,8BAAgB,EAAC,IAAI,CAAC,CAAC;QAEnC,MAAM,GAAG,GAAG,aAAa,CAAC;QAC1B,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACxD,IAAI,oBAAoB,EAAE;YACxB,4BAA4B,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;SACrD;QAED,MAAM,YAAY,GAAG,eAAe,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QACpD,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,OAAO;gBACL,WAAW,EAAE,IAAI;gBACjB,aAAa,EAAE,YAAY;aAC5B,CAAC;SACH;aAAM;YACL,OAAO;gBACL,WAAW,EAAE,oBAAoB;aAClC,CAAC;SACH;KACF;SAAM;QACL,OAAO;YACL,WAAW,EAAE,KAAK;SACnB,CAAC;KACH;AACH,CAAC;AAED,SAAS,4BAA4B,CAAC,GAAW,EAAE,GAAW,EAAE,QAAwB,EAAE,cAAsB;IAC9G,MAAM,cAAc,GAAG,IAAA,+BAAiB,EAAC,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;IAC9D,IAAI,cAAc,CAAC,MAAM,KAAK,cAAc,EAAE;QAC5C,MAAM,IAAI,4BAAoB,CAC5B,2CAA2C,GAAG,2BAA2B,QAAQ,CAAC,kBAAkB,GAAG,EACvG,GAAG,EAAE,CAAC,SAAS,cAAc,CAAC,MAAM,cAAc,cAAc,GAAG,CACpE,CAAC;KACH;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAW,EAAE,GAAW;IAChD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,iBAAiB,GAAG,UAAU,EAAE,GAAG,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,eAAe,CAAC,GAAW,EAAE,QAAwB;IAC5D,MAAM,GAAG,GAAG,kBAAkB,CAAC;IAC/B,IAAI,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;QAC9B,MAAM,cAAc,GAAG,4BAA4B,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC3E,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;KAC1B;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC"}

package/dist/cli/validate/validate-upgrade-safety.d.ts

@@ -0,0 +1,16 @@
+import { ValidationOptions } from '../..';
+import { ProjectReport } from './project-report';
+/**
+ * Validation options for upgrade safety checks.
+ */
+export type ValidateUpgradeSafetyOptions = Omit<ValidationOptions, 'kind'>;
+/**
+ * Validates the upgrade safety of all contracts in the build info dir's build info files.
+ * Only contracts that are detected as upgradeable will be validated.
+ *
+ * @param buildInfoDir Absolute path of build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
+ * @param opts Validation options, or undefined to use the default validation options.
+ * @returns The project report.
+ */
+export declare function validateUpgradeSafety(buildInfoDir?: string, opts?: ValidateUpgradeSafetyOptions): Promise<ProjectReport>;
+//# sourceMappingURL=validate-upgrade-safety.d.ts.map

package/dist/cli/validate/validate-upgrade-safety.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-upgrade-safety.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/validate-upgrade-safety.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAI1C,OAAO,EAAE,aAAa,EAAoB,MAAM,kBAAkB,CAAC;AAGnE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAE3E;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,YAAY,CAAC,EAAE,MAAM,EACrB,IAAI,GAAE,4BAAiC,GACtC,OAAO,CAAC,aAAa,CAAC,CAKxB"}

package/dist/cli/validate/validate-upgrade-safety.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUpgradeSafety = void 0;
+const build_info_file_1 = require("./build-info-file");
+const contract_report_1 = require("./contract-report");
+const project_report_1 = require("./project-report");
+const validations_1 = require("./validations");
+/**
+ * Validates the upgrade safety of all contracts in the build info dir's build info files.
+ * Only contracts that are detected as upgradeable will be validated.
+ *
+ * @param buildInfoDir Absolute path of build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
+ * @param opts Validation options, or undefined to use the default validation options.
+ * @returns The project report.
+ */
+async function validateUpgradeSafety(buildInfoDir, opts = {}) {
+    const buildInfoFiles = await (0, build_info_file_1.getBuildInfoFiles)(buildInfoDir);
+    const sourceContracts = (0, validations_1.validateBuildInfoContracts)(buildInfoFiles);
+    const contractReports = (0, contract_report_1.getContractReports)(sourceContracts, opts);
+    return (0, project_report_1.getProjectReport)(contractReports);
+}
+exports.validateUpgradeSafety = validateUpgradeSafety;
+//# sourceMappingURL=validate-upgrade-safety.js.map

package/dist/cli/validate/validate-upgrade-safety.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-upgrade-safety.js","sourceRoot":"","sources":["../../../src/cli/validate/validate-upgrade-safety.ts"],"names":[],"mappings":";;;AAEA,uDAAsD;AACtD,uDAAuD;AACvD,qDAAmE;AACnE,+CAA2D;AAO3D;;;;;;;GAOG;AACI,KAAK,UAAU,qBAAqB,CACzC,YAAqB,EACrB,OAAqC,EAAE;IAEvC,MAAM,cAAc,GAAG,MAAM,IAAA,mCAAiB,EAAC,YAAY,CAAC,CAAC;IAC7D,MAAM,eAAe,GAAG,IAAA,wCAA0B,EAAC,cAAc,CAAC,CAAC;IACnE,MAAM,eAAe,GAAG,IAAA,oCAAkB,EAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAClE,OAAO,IAAA,iCAAgB,EAAC,eAAe,CAAC,CAAC;AAC3C,CAAC;AARD,sDAQC"}

package/dist/cli/validate/validate-upgrade-safety.test.d.ts

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

package/dist/cli/validate/validate-upgrade-safety.test.d.ts.map

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

package/dist/cli/validate/validate-upgrade-safety.test.js

@@ -0,0 +1,74 @@
+"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 hardhat_1 = require("hardhat");
+const validate_upgrade_safety_1 = require("./validate-upgrade-safety");
+const upgradeability_assessment_1 = require("./upgradeability-assessment");
+const rimraf = util_1.default.promisify(rimraf_1.default);
+ava_1.default.before(async () => {
+    process.chdir(await fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'upgrades-core-test-')));
+});
+ava_1.default.after(async () => {
+    await rimraf(process.cwd());
+});
+(0, ava_1.default)('validate upgrade safety', async (t) => {
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Validate.sol:Safe`);
+    await fs_1.promises.mkdir('validate-upgrade-safety');
+    await fs_1.promises.writeFile('validate-upgrade-safety/1.json', JSON.stringify(buildInfo));
+    const report = await (0, validate_upgrade_safety_1.validateUpgradeSafety)('validate-upgrade-safety');
+    t.false(report.ok);
+    t.snapshot(report.explain());
+});
+(0, ava_1.default)('ambiguous upgrades-from', async (t) => {
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Validate.sol:Safe`);
+    await fs_1.promises.mkdir('ambiguous-upgrades-from');
+    await fs_1.promises.writeFile('ambiguous-upgrades-from/1.json', JSON.stringify(buildInfo));
+    await fs_1.promises.writeFile('ambiguous-upgrades-from/2.json', JSON.stringify(buildInfo));
+    const error = await t.throwsAsync((0, validate_upgrade_safety_1.validateUpgradeSafety)('ambiguous-upgrades-from'));
+    t.true(error?.message.includes('Found multiple contracts with name'), error?.message);
+});
+(0, ava_1.default)('bad upgrade from 0.8.8 to 0.8.9', async (t) => {
+    await fs_1.promises.mkdir('bad-upgrade');
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Storage088.sol:Storage088`);
+    await fs_1.promises.writeFile('bad-upgrade/storage088.json', JSON.stringify(buildInfo));
+    const buildInfo2 = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Storage089.sol:Storage089`);
+    await fs_1.promises.writeFile('bad-upgrade/storage089.json', JSON.stringify(buildInfo2));
+    const report = await (0, validate_upgrade_safety_1.validateUpgradeSafety)('bad-upgrade');
+    t.false(report.ok);
+    t.snapshot(report.explain());
+});
+(0, ava_1.default)('reference contract not found', async (t) => {
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(`contracts/test/cli/Storage089.sol:Storage089`);
+    await fs_1.promises.mkdir('ref-not-found');
+    await fs_1.promises.writeFile('ref-not-found/storage089.json', JSON.stringify(buildInfo));
+    const error = await t.throwsAsync((0, validate_upgrade_safety_1.validateUpgradeSafety)('ref-not-found'));
+    t.true(error instanceof upgradeability_assessment_1.ReferenceContractNotFound);
+    t.is(error?.message, 'Could not find contract Storage088 referenced in contracts/test/cli/Storage089.sol:Storage089.');
+});
+(0, ava_1.default)('invalid annotation args - upgrades-from', async (t) => {
+    const fullyQualifiedName = `contracts/test/cli/InvalidAnnotationArgsUpgradesFrom.sol:InvalidAnnotationArgsUpgradesFrom`;
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(fullyQualifiedName);
+    await fs_1.promises.mkdir('invalid-annotation-args-upgrades-from');
+    await fs_1.promises.writeFile('invalid-annotation-args-upgrades-from/1.json', JSON.stringify(buildInfo));
+    const error = await t.throwsAsync((0, validate_upgrade_safety_1.validateUpgradeSafety)('invalid-annotation-args-upgrades-from'));
+    t.true(error?.message.includes(`Invalid number of arguments for @custom:oz-upgrades-from annotation in contract ${fullyQualifiedName}.`));
+    t.true(error?.message.includes('Found 0, expected 1'));
+});
+(0, ava_1.default)('invalid annotation args - upgrades', async (t) => {
+    const fullyQualifiedName = `contracts/test/cli/InvalidAnnotationArgsUpgrades.sol:InvalidAnnotationArgsUpgrades`;
+    const buildInfo = await hardhat_1.artifacts.getBuildInfo(fullyQualifiedName);
+    await fs_1.promises.mkdir('invalid-annotation-args-upgrades');
+    await fs_1.promises.writeFile('invalid-annotation-args-upgrades/1.json', JSON.stringify(buildInfo));
+    const error = await t.throwsAsync((0, validate_upgrade_safety_1.validateUpgradeSafety)('invalid-annotation-args-upgrades'));
+    t.true(error?.message.includes(`Invalid number of arguments for @custom:oz-upgrades annotation in contract ${fullyQualifiedName}.`));
+    t.true(error?.message.includes('Found 1, expected 0'));
+});
+//# sourceMappingURL=validate-upgrade-safety.test.js.map

package/dist/cli/validate/validate-upgrade-safety.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-upgrade-safety.test.js","sourceRoot":"","sources":["../../../src/cli/validate/validate-upgrade-safety.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AAEvB,2BAAoC;AACpC,oDAAiC;AACjC,gDAAwB;AACxB,gDAAwB;AACxB,4CAAoB;AAEpB,qCAAoC;AACpC,uEAAkE;AAClE,2EAAwE;AAExE,MAAM,MAAM,GAAG,cAAI,CAAC,SAAS,CAAC,gBAAW,CAAC,CAAC;AAE3C,aAAI,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;IACpB,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,yBAAyB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACxC,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,sCAAsC,CAAC,CAAC;IAEvF,MAAM,aAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC1C,MAAM,aAAE,CAAC,SAAS,CAAC,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhF,MAAM,MAAM,GAAG,MAAM,IAAA,+CAAqB,EAAC,yBAAyB,CAAC,CAAC;IACtE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,yBAAyB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACxC,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,sCAAsC,CAAC,CAAC;IAEvF,MAAM,aAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC1C,MAAM,aAAE,CAAC,SAAS,CAAC,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAChF,MAAM,aAAE,CAAC,SAAS,CAAC,gCAAgC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhF,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,+CAAqB,EAAC,yBAAyB,CAAC,CAAC,CAAC;IACpF,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,oCAAoC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACxF,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,iCAAiC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAChD,MAAM,aAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAE9B,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,8CAA8C,CAAC,CAAC;IAC/F,MAAM,aAAE,CAAC,SAAS,CAAC,6BAA6B,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAE7E,MAAM,UAAU,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,8CAA8C,CAAC,CAAC;IAChG,MAAM,aAAE,CAAC,SAAS,CAAC,6BAA6B,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAE9E,MAAM,MAAM,GAAG,MAAM,IAAA,+CAAqB,EAAC,aAAa,CAAC,CAAC;IAC1D,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,8BAA8B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC7C,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,8CAA8C,CAAC,CAAC;IAC/F,MAAM,aAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAChC,MAAM,aAAE,CAAC,SAAS,CAAC,+BAA+B,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAE/E,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,+CAAqB,EAAC,eAAe,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,IAAI,CAAC,KAAK,YAAY,qDAAyB,CAAC,CAAC;IACnD,CAAC,CAAC,EAAE,CACF,KAAK,EAAE,OAAO,EACd,gGAAgG,CACjG,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,yCAAyC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACxD,MAAM,kBAAkB,GAAG,4FAA4F,CAAC;IAExH,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IACnE,MAAM,aAAE,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACxD,MAAM,aAAE,CAAC,SAAS,CAAC,8CAA8C,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9F,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,+CAAqB,EAAC,uCAAuC,CAAC,CAAC,CAAC;IAClG,CAAC,CAAC,IAAI,CACJ,KAAK,EAAE,OAAO,CAAC,QAAQ,CACrB,mFAAmF,kBAAkB,GAAG,CACzG,CACF,CAAC;IACF,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,oCAAoC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACnD,MAAM,kBAAkB,GAAG,oFAAoF,CAAC;IAEhH,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IACnE,MAAM,aAAE,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACnD,MAAM,aAAE,CAAC,SAAS,CAAC,yCAAyC,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAEzF,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAA,+CAAqB,EAAC,kCAAkC,CAAC,CAAC,CAAC;IAC7F,CAAC,CAAC,IAAI,CACJ,KAAK,EAAE,OAAO,CAAC,QAAQ,CACrB,8EAA8E,kBAAkB,GAAG,CACpG,CACF,CAAC;IACF,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC"}

package/dist/cli/validate/validations.d.ts

@@ -0,0 +1,11 @@
+import { ValidationRunData } from '../..';
+import { ContractDefinition } from 'solidity-ast';
+import { BuildInfoFile } from './build-info-file';
+export interface SourceContract {
+    node: ContractDefinition;
+    name: string;
+    fullyQualifiedName: string;
+    validationData: ValidationRunData;
+}
+export declare function validateBuildInfoContracts(buildInfoFiles: BuildInfoFile[]): SourceContract[];
+//# sourceMappingURL=validations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validations.d.ts","sourceRoot":"","sources":["../../../src/cli/validate/validations.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2D,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAKnG,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,iBAAiB,CAAC;CACnC;AAED,wBAAgB,0BAA0B,CAAC,cAAc,EAAE,aAAa,EAAE,GAAG,cAAc,EAAE,CAO5F"}