@openzeppelin/upgrades-core 1.9.1

package/dist/validate/query.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.test.js","sourceRoot":"","sources":["../../src/validate/query.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AAGvB,mCAA8C;AAC9C,wCAAwC;AAExC,aAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,EAAE;IAC9B,MAAM,gBAAgB,GAAG,gDAAgD,CAAC;IAC1E,MAAM,cAAc,GAAG,gDAAgD,CAAC;IAExE,MAAM,UAAU,GAAgD;QAC9D,CAAC,EAAE;YACD,OAAO,EAAE,oBAAU,CAAC,gBAAgB,CAAC;YACrC,cAAc,EAAE;gBACd;oBACE,GAAG,EAAE,EAAE;oBACP,IAAI,EAAE,EAAE;oBACR,KAAK,EAAE,EAAE;oBACT,MAAM,EAAE,EAAE;oBACV,WAAW,EAAE,0CAA0C;iBACxD;gBACD;oBACE,GAAG,EAAE,EAAE;oBACP,IAAI,EAAE,EAAE;oBACR,KAAK,EAAE,EAAE;oBACT,MAAM,EAAE,EAAE;oBACV,WAAW,EAAE,0CAA0C;iBACxD;aACF;SACF;QACD,CAAC,EAAE;YACD,OAAO,EAAE,oBAAU,CAAC,gBAAgB,CAAC;YACrC,cAAc,EAAE;gBACd;oBACE,GAAG,EAAE,EAAE;oBACP,IAAI,EAAE,EAAE;oBACR,KAAK,EAAE,CAAC;oBACR,MAAM,EAAE,EAAE;oBACV,WAAW,EAAE,0CAA0C;iBACxD;aACF;SACF;KACF,CAAC;IAEF,MAAM,SAAS,GAAG,2BAAmB,CAAC,UAA+B,EAAE,cAAc,CAAC,CAAC;IAEvF,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC"}

package/dist/validate/run.d.ts

@@ -0,0 +1,39 @@
+import { SolcOutput } from '../solc-api';
+import { SrcDecoder } from '../src-decoder';
+import { Version } from '../version';
+import { LinkReference } from '../link-refs';
+import { StorageLayout } from '../storage/layout';
+export declare type ValidationRunData = Record<string, ContractValidation>;
+export interface ContractValidation {
+    version?: Version;
+    src: string;
+    inherit: string[];
+    libraries: string[];
+    methods: string[];
+    linkReferences: LinkReference[];
+    errors: ValidationError[];
+    layout: StorageLayout;
+}
+declare const errorKinds: readonly ["state-variable-assignment", "state-variable-immutable", "external-library-linking", "struct-definition", "enum-definition", "constructor", "delegatecall", "selfdestruct", "missing-public-upgradeto"];
+export declare type ValidationError = ValidationErrorConstructor | ValidationErrorOpcode | ValidationErrorWithName | ValidationErrorUpgradeability;
+interface ValidationErrorBase {
+    src: string;
+    kind: typeof errorKinds[number];
+}
+interface ValidationErrorWithName extends ValidationErrorBase {
+    name: string;
+    kind: 'state-variable-assignment' | 'state-variable-immutable' | 'external-library-linking' | 'struct-definition' | 'enum-definition';
+}
+interface ValidationErrorConstructor extends ValidationErrorBase {
+    kind: 'constructor';
+    contract: string;
+}
+interface ValidationErrorOpcode extends ValidationErrorBase {
+    kind: 'delegatecall' | 'selfdestruct';
+}
+interface ValidationErrorUpgradeability extends ValidationErrorBase {
+    kind: 'missing-public-upgradeto';
+}
+export declare function validate(solcOutput: SolcOutput, decodeSrc: SrcDecoder): ValidationRunData;
+export {};
+//# sourceMappingURL=run.d.ts.map

package/dist/validate/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/validate/run.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAgB,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAI5C,OAAO,EAAE,OAAO,EAAc,MAAM,YAAY,CAAC;AACjD,OAAO,EAAyB,aAAa,EAAE,MAAM,cAAc,CAAC;AAEpE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,oBAAY,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;AAEnE,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,QAAA,MAAM,UAAU,mNAUN,CAAC;AAEX,oBAAY,eAAe,GACvB,0BAA0B,GAC1B,qBAAqB,GACrB,uBAAuB,GACvB,6BAA6B,CAAC;AAElC,UAAU,mBAAmB;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;CACjC;AAED,UAAU,uBAAwB,SAAQ,mBAAmB;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EACA,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,GAC1B,mBAAmB,GACnB,iBAAiB,CAAC;CACvB;AAED,UAAU,0BAA2B,SAAQ,mBAAmB;IAC9D,IAAI,EAAE,aAAa,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,qBAAsB,SAAQ,mBAAmB;IACzD,IAAI,EAAE,cAAc,GAAG,cAAc,CAAC;CACvC;AAED,UAAU,6BAA8B,SAAQ,mBAAmB;IACjE,IAAI,EAAE,0BAA0B,CAAC;CAClC;AA4CD,wBAAgB,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,GAAG,iBAAiB,CAkEzF"}

package/dist/validate/run.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = void 0;
+const utils_1 = require("solidity-ast/utils");
+const ast_dereferencer_1 = require("../ast-dereferencer");
+const is_nullish_1 = require("../utils/is-nullish");
+const function_1 = require("../utils/function");
+const version_1 = require("../version");
+const link_refs_1 = require("../link-refs");
+const extract_1 = require("../storage/extract");
+const errorKinds = [
+    'state-variable-assignment',
+    'state-variable-immutable',
+    'external-library-linking',
+    'struct-definition',
+    'enum-definition',
+    'constructor',
+    'delegatecall',
+    'selfdestruct',
+    'missing-public-upgradeto',
+];
+function* execall(re, text) {
+    re = new RegExp(re, re.flags + (re.sticky ? '' : 'y'));
+    while (true) {
+        const match = re.exec(text);
+        if (match && match[0] !== '') {
+            yield match;
+        }
+        else {
+            break;
+        }
+    }
+}
+function getAllowed(node) {
+    var _a, _b;
+    if ('documentation' in node) {
+        const doc = typeof node.documentation === 'string' ? node.documentation : (_b = (_a = node.documentation) === null || _a === void 0 ? void 0 : _a.text) !== null && _b !== void 0 ? _b : '';
+        const result = [];
+        for (const { groups } of execall(/^\s*(?:@(?<title>\w+)(?::(?<tag>[a-z][a-z-]*))? )?(?<args>(?:(?!^\s@\w+)[^])*)/m, doc)) {
+            if (groups && groups.title === 'custom' && groups.tag === 'oz-upgrades-unsafe-allow') {
+                result.push(...groups.args.split(/\s+/));
+            }
+        }
+        result.forEach(arg => {
+            if (!errorKinds.includes(arg)) {
+                throw new Error(`NatSpec: oz-upgrades-unsafe-allow argument not recognized: ${arg}`);
+            }
+        });
+        return result;
+    }
+    else {
+        return [];
+    }
+}
+function skipCheck(error, node) {
+    return getAllowed(node).includes(error);
+}
+function validate(solcOutput, decodeSrc) {
+    var _a;
+    const validation = {};
+    const fromId = {};
+    const inheritIds = {};
+    const libraryIds = {};
+    const deref = ast_dereferencer_1.astDereferencer(solcOutput);
+    for (const source in solcOutput.contracts) {
+        for (const contractName in solcOutput.contracts[source]) {
+            const bytecode = solcOutput.contracts[source][contractName].evm.bytecode;
+            const version = bytecode.object === '' ? undefined : version_1.getVersion(bytecode.object);
+            const linkReferences = link_refs_1.extractLinkReferences(bytecode);
+            validation[contractName] = {
+                src: contractName,
+                version,
+                inherit: [],
+                libraries: [],
+                methods: [],
+                linkReferences,
+                errors: [],
+                layout: {
+                    storage: [],
+                    types: {},
+                },
+            };
+        }
+        for (const contractDef of utils_1.findAll('ContractDefinition', solcOutput.sources[source].ast)) {
+            fromId[contractDef.id] = contractDef.name;
+            // May be undefined in case of duplicate contract names in Truffle
+            const bytecode = (_a = solcOutput.contracts[source][contractDef.name]) === null || _a === void 0 ? void 0 : _a.evm.bytecode;
+            if (contractDef.name in validation && bytecode !== undefined) {
+                inheritIds[contractDef.name] = contractDef.linearizedBaseContracts.slice(1);
+                libraryIds[contractDef.name] = getReferencedLibraryIds(contractDef);
+                validation[contractDef.name].src = decodeSrc(contractDef);
+                validation[contractDef.name].errors = [
+                    ...getConstructorErrors(contractDef, decodeSrc),
+                    ...getOpcodeErrors(contractDef, decodeSrc),
+                    ...getStateVariableErrors(contractDef, decodeSrc),
+                    // TODO: add linked libraries support
+                    // https://github.com/OpenZeppelin/openzeppelin-upgrades/issues/52
+                    ...getLinkingErrors(contractDef, bytecode),
+                ];
+                validation[contractDef.name].layout = extract_1.extractStorageLayout(contractDef, decodeSrc, deref);
+                validation[contractDef.name].methods = [...utils_1.findAll('FunctionDefinition', contractDef)]
+                    .filter(fnDef => ['external', 'public'].includes(fnDef.visibility))
+                    .map(fnDef => function_1.getFunctionSignature(fnDef, deref));
+            }
+        }
+    }
+    for (const contractName in inheritIds) {
+        validation[contractName].inherit = inheritIds[contractName].map(id => fromId[id]);
+    }
+    for (const contractName in libraryIds) {
+        validation[contractName].libraries = libraryIds[contractName].map(id => fromId[id]);
+    }
+    return validation;
+}
+exports.validate = validate;
+function* getConstructorErrors(contractDef, decodeSrc) {
+    var _a, _b, _c;
+    for (const fnDef of utils_1.findAll('FunctionDefinition', contractDef, node => skipCheck('constructor', node))) {
+        if (fnDef.kind === 'constructor' && (((_c = (_b = (_a = fnDef.body) === null || _a === void 0 ? void 0 : _a.statements) === null || _b === void 0 ? void 0 : _b.length) !== null && _c !== void 0 ? _c : 0) > 0 || fnDef.modifiers.length > 0)) {
+            yield {
+                kind: 'constructor',
+                contract: contractDef.name,
+                src: decodeSrc(fnDef),
+            };
+        }
+    }
+}
+function* getOpcodeErrors(contractDef, decodeSrc) {
+    var _a, _b;
+    for (const fnCall of utils_1.findAll('FunctionCall', contractDef, node => skipCheck('delegatecall', node))) {
+        const fn = fnCall.expression;
+        if ((_a = fn.typeDescriptions.typeIdentifier) === null || _a === void 0 ? void 0 : _a.match(/^t_function_baredelegatecall_/)) {
+            yield {
+                kind: 'delegatecall',
+                src: decodeSrc(fnCall),
+            };
+        }
+    }
+    for (const fnCall of utils_1.findAll('FunctionCall', contractDef, node => skipCheck('selfdestruct', node))) {
+        const fn = fnCall.expression;
+        if ((_b = fn.typeDescriptions.typeIdentifier) === null || _b === void 0 ? void 0 : _b.match(/^t_function_selfdestruct_/)) {
+            yield {
+                kind: 'selfdestruct',
+                src: decodeSrc(fnCall),
+            };
+        }
+    }
+}
+function* getStateVariableErrors(contractDef, decodeSrc) {
+    for (const varDecl of contractDef.nodes) {
+        if (utils_1.isNodeType('VariableDeclaration', varDecl)) {
+            if (!varDecl.constant && !is_nullish_1.isNullish(varDecl.value)) {
+                if (!skipCheck('state-variable-assignment', contractDef) && !skipCheck('state-variable-assignment', varDecl)) {
+                    yield {
+                        kind: 'state-variable-assignment',
+                        name: varDecl.name,
+                        src: decodeSrc(varDecl),
+                    };
+                }
+            }
+            if (varDecl.mutability === 'immutable') {
+                if (!skipCheck('state-variable-immutable', contractDef) && !skipCheck('state-variable-immutable', varDecl)) {
+                    yield {
+                        kind: 'state-variable-immutable',
+                        name: varDecl.name,
+                        src: decodeSrc(varDecl),
+                    };
+                }
+            }
+        }
+    }
+}
+function getReferencedLibraryIds(contractDef) {
+    const implicitUsage = [...utils_1.findAll('UsingForDirective', contractDef)].map(usingForDirective => usingForDirective.libraryName.referencedDeclaration);
+    const explicitUsage = [...utils_1.findAll('Identifier', contractDef)]
+        .filter(identifier => { var _a; return (_a = identifier.typeDescriptions.typeString) === null || _a === void 0 ? void 0 : _a.match(/^type\(library/); })
+        .map(identifier => {
+        if (is_nullish_1.isNullish(identifier.referencedDeclaration)) {
+            throw new Error('Broken invariant: Identifier.referencedDeclaration should not be null');
+        }
+        return identifier.referencedDeclaration;
+    });
+    return [...new Set(implicitUsage.concat(explicitUsage))];
+}
+function* getLinkingErrors(contractDef, bytecode) {
+    const { linkReferences } = bytecode;
+    for (const source of Object.keys(linkReferences)) {
+        for (const libName of Object.keys(linkReferences[source])) {
+            if (!skipCheck('external-library-linking', contractDef)) {
+                yield {
+                    kind: 'external-library-linking',
+                    name: libName,
+                    src: source,
+                };
+            }
+        }
+    }
+}
+//# sourceMappingURL=run.js.map

package/dist/validate/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/validate/run.ts"],"names":[],"mappings":";;;AACA,8CAAyD;AAKzD,0DAAsD;AACtD,oDAAgD;AAChD,gDAAyD;AACzD,wCAAiD;AACjD,4CAAoE;AACpE,gDAA0D;AAgB1D,MAAM,UAAU,GAAG;IACjB,2BAA2B;IAC3B,0BAA0B;IAC1B,0BAA0B;IAC1B,mBAAmB;IACnB,iBAAiB;IACjB,aAAa;IACb,cAAc;IACd,cAAc;IACd,0BAA0B;CAClB,CAAC;AAoCX,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAU,EAAE,IAAY;IACxC,EAAE,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,OAAO,IAAI,EAAE;QACX,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;YAC5B,MAAM,KAAK,CAAC;SACb;aAAM;YACL,MAAM;SACP;KACF;AACH,CAAC;AAED,SAAS,UAAU,CAAC,IAAU;;IAC5B,IAAI,eAAe,IAAI,IAAI,EAAE;QAC3B,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,IAAI,mCAAI,EAAE,CAAC;QAEzG,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,OAAO,CAC9B,iFAAiF,EACjF,GAAG,CACJ,EAAE;YACD,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,GAAG,KAAK,0BAA0B,EAAE;gBACpF,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;aAC1C;SACF;QAED,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACnB,IAAI,CAAE,UAAgC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,8DAA8D,GAAG,EAAE,CAAC,CAAC;aACtF;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACf;SAAM;QACL,OAAO,EAAE,CAAC;KACX;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa,EAAE,IAAU;IAC1C,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED,SAAgB,QAAQ,CAAC,UAAsB,EAAE,SAAqB;;IACpE,MAAM,UAAU,GAAsB,EAAE,CAAC;IACzC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,MAAM,UAAU,GAA6B,EAAE,CAAC;IAChD,MAAM,UAAU,GAA6B,EAAE,CAAC;IAEhD,MAAM,KAAK,GAAG,kCAAe,CAAC,UAAU,CAAC,CAAC;IAE1C,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE;QACzC,KAAK,MAAM,YAAY,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YACvD,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;YACzE,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjF,MAAM,cAAc,GAAG,iCAAqB,CAAC,QAAQ,CAAC,CAAC;YAEvD,UAAU,CAAC,YAAY,CAAC,GAAG;gBACzB,GAAG,EAAE,YAAY;gBACjB,OAAO;gBACP,OAAO,EAAE,EAAE;gBACX,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE,EAAE;gBACX,cAAc;gBACd,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE;oBACN,OAAO,EAAE,EAAE;oBACX,KAAK,EAAE,EAAE;iBACV;aACF,CAAC;SACH;QAED,KAAK,MAAM,WAAW,IAAI,eAAO,CAAC,oBAAoB,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE;YACvF,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC;YAE1C,kEAAkE;YAClE,MAAM,QAAQ,GAAG,MAAA,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,0CAAE,GAAG,CAAC,QAAQ,CAAC;YAE9E,IAAI,WAAW,CAAC,IAAI,IAAI,UAAU,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC5D,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC5E,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;gBAEpE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;gBAC1D,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG;oBACpC,GAAG,oBAAoB,CAAC,WAAW,EAAE,SAAS,CAAC;oBAC/C,GAAG,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC;oBAC1C,GAAG,sBAAsB,CAAC,WAAW,EAAE,SAAS,CAAC;oBACjD,qCAAqC;oBACrC,kEAAkE;oBAClE,GAAG,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC;iBAC3C,CAAC;gBAEF,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,8BAAoB,CAAC,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;gBAC1F,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,GAAG,eAAO,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;qBACnF,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;qBAClE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,+BAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;aACrD;SACF;KACF;IAED,KAAK,MAAM,YAAY,IAAI,UAAU,EAAE;QACrC,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;KACnF;IAED,KAAK,MAAM,YAAY,IAAI,UAAU,EAAE;QACrC,UAAU,CAAC,YAAY,CAAC,CAAC,SAAS,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;KACrF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAlED,4BAkEC;AAED,QAAQ,CAAC,CAAC,oBAAoB,CAAC,WAA+B,EAAE,SAAqB;;IACnF,KAAK,MAAM,KAAK,IAAI,eAAO,CAAC,oBAAoB,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,EAAE;QACtG,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,CAAC,MAAA,MAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,UAAU,0CAAE,MAAM,mCAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE;YAC7G,MAAM;gBACJ,IAAI,EAAE,aAAa;gBACnB,QAAQ,EAAE,WAAW,CAAC,IAAI;gBAC1B,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC;aACtB,CAAC;SACH;KACF;AACH,CAAC;AAED,QAAQ,CAAC,CAAC,eAAe,CAAC,WAA+B,EAAE,SAAqB;;IAC9E,KAAK,MAAM,MAAM,IAAI,eAAO,CAAC,cAAc,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,EAAE;QAClG,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;QAC7B,IAAI,MAAA,EAAE,CAAC,gBAAgB,CAAC,cAAc,0CAAE,KAAK,CAAC,+BAA+B,CAAC,EAAE;YAC9E,MAAM;gBACJ,IAAI,EAAE,cAAc;gBACpB,GAAG,EAAE,SAAS,CAAC,MAAM,CAAC;aACvB,CAAC;SACH;KACF;IACD,KAAK,MAAM,MAAM,IAAI,eAAO,CAAC,cAAc,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,EAAE;QAClG,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;QAC7B,IAAI,MAAA,EAAE,CAAC,gBAAgB,CAAC,cAAc,0CAAE,KAAK,CAAC,2BAA2B,CAAC,EAAE;YAC1E,MAAM;gBACJ,IAAI,EAAE,cAAc;gBACpB,GAAG,EAAE,SAAS,CAAC,MAAM,CAAC;aACvB,CAAC;SACH;KACF;AACH,CAAC;AAED,QAAQ,CAAC,CAAC,sBAAsB,CAC9B,WAA+B,EAC/B,SAAqB;IAErB,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;QACvC,IAAI,kBAAU,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAE;YAC9C,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,sBAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAClD,IAAI,CAAC,SAAS,CAAC,2BAA2B,EAAE,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,EAAE;oBAC5G,MAAM;wBACJ,IAAI,EAAE,2BAA2B;wBACjC,IAAI,EAAE,OAAO,CAAC,IAAI;wBAClB,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;qBACxB,CAAC;iBACH;aACF;YACD,IAAI,OAAO,CAAC,UAAU,KAAK,WAAW,EAAE;gBACtC,IAAI,CAAC,SAAS,CAAC,0BAA0B,EAAE,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,0BAA0B,EAAE,OAAO,CAAC,EAAE;oBAC1G,MAAM;wBACJ,IAAI,EAAE,0BAA0B;wBAChC,IAAI,EAAE,OAAO,CAAC,IAAI;wBAClB,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;qBACxB,CAAC;iBACH;aACF;SACF;KACF;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,WAA+B;IAC9D,MAAM,aAAa,GAAG,CAAC,GAAG,eAAO,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CACtE,iBAAiB,CAAC,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,qBAAqB,CACzE,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,GAAG,eAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;SAC1D,MAAM,CAAC,UAAU,CAAC,EAAE,WAAC,OAAA,MAAA,UAAU,CAAC,gBAAgB,CAAC,UAAU,0CAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA,EAAA,CAAC;SACrF,GAAG,CAAC,UAAU,CAAC,EAAE;QAChB,IAAI,sBAAS,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC1F;QACD,OAAO,UAAU,CAAC,qBAAqB,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEL,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,QAAQ,CAAC,CAAC,gBAAgB,CACxB,WAA+B,EAC/B,QAAsB;IAEtB,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC;IACpC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;QAChD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE;YACzD,IAAI,CAAC,SAAS,CAAC,0BAA0B,EAAE,WAAW,CAAC,EAAE;gBACvD,MAAM;oBACJ,IAAI,EAAE,0BAA0B;oBAChC,IAAI,EAAE,OAAO;oBACb,GAAG,EAAE,MAAM;iBACZ,CAAC;aACH;SACF;KACF;AACH,CAAC"}

package/dist/validate.test.d.ts

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

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

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

package/dist/validate.test.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 });
+const ava_1 = __importDefault(require("ava"));
+const hardhat_1 = require("hardhat");
+const validate_1 = require("./validate");
+const src_decoder_1 = require("./src-decoder");
+const test = ava_1.default;
+test.before(async (t) => {
+    const contracts = [
+        'contracts/test/Validations.sol:HasEmptyConstructor',
+        'contracts/test/ValidationsNatspec.sol:HasNonEmptyConstructorNatspec1',
+        'contracts/test/Proxiable.sol:ChildOfProxiable',
+    ];
+    t.context.validation = {};
+    for (const contract of contracts) {
+        const buildInfo = await hardhat_1.artifacts.getBuildInfo(contract);
+        if (buildInfo === undefined) {
+            throw new Error(`Build info not found for contract ${contract}`);
+        }
+        const solcOutput = buildInfo.output;
+        const solcInput = buildInfo.input;
+        const decodeSrc = src_decoder_1.solcInputOutputDecoder(solcInput, solcOutput);
+        Object.assign(t.context.validation, validate_1.validate(solcOutput, decodeSrc));
+    }
+});
+function testValid(name, kind, valid) {
+    testOverride(name, kind, {}, valid);
+}
+function testOverride(name, kind, opts, valid) {
+    const optKeys = Object.keys(opts);
+    const describeOpts = optKeys.length > 0 ? '(' + optKeys.join(', ') + ')' : '';
+    const testName = [valid ? 'accepts' : 'rejects', kind, name, describeOpts].join(' ');
+    test(testName, t => {
+        const version = validate_1.getContractVersion(t.context.validation, name);
+        const assertUpgSafe = () => validate_1.assertUpgradeSafe([t.context.validation], version, { kind, ...opts });
+        if (valid) {
+            t.notThrows(assertUpgSafe);
+        }
+        else {
+            t.throws(assertUpgSafe);
+        }
+    });
+}
+testValid('HasEmptyConstructor', 'transparent', true);
+testValid('HasConstantStateVariableAssignment', 'transparent', true);
+testValid('HasStateVariable', 'transparent', true);
+testValid('UsesImplicitSafeInternalLibrary', 'transparent', true);
+testValid('UsesExplicitSafeInternalLibrary', 'transparent', true);
+testValid('HasNonEmptyConstructor', 'transparent', false);
+testValid('ParentHasNonEmptyConstructor', 'transparent', false);
+testValid('AncestorHasNonEmptyConstructor', 'transparent', false);
+testValid('HasStateVariableAssignment', 'transparent', false);
+testValid('HasImmutableStateVariable', 'transparent', false);
+testValid('HasSelfDestruct', 'transparent', false);
+testValid('HasDelegateCall', 'transparent', false);
+testValid('ImportedParentHasStateVariableAssignment', 'transparent', false);
+testValid('UsesImplicitUnsafeInternalLibrary', 'transparent', false);
+testValid('UsesExplicitUnsafeInternalLibrary', 'transparent', false);
+testValid('UsesImplicitUnsafeExternalLibrary', 'transparent', false);
+testValid('UsesExplicitUnsafeExternalLibrary', 'transparent', false);
+// Linked external libraries are not yet supported
+// see: https://github.com/OpenZeppelin/openzeppelin-upgrades/issues/52
+testValid('UsesImplicitSafeExternalLibrary', 'transparent', false);
+testValid('UsesExplicitSafeExternalLibrary', 'transparent', false);
+test('inherited storage', t => {
+    const version = validate_1.getContractVersion(t.context.validation, 'StorageInheritChild');
+    const layout = validate_1.getStorageLayout([t.context.validation], version);
+    t.is(layout.storage.length, 8);
+    for (let i = 0; i < layout.storage.length; i++) {
+        t.is(layout.storage[i].label, `v${i}`);
+        t.truthy(layout.types[layout.storage[i].type]);
+    }
+});
+testOverride('UsesImplicitSafeExternalLibrary', 'transparent', { unsafeAllowLinkedLibraries: true }, true);
+testOverride('UsesExplicitSafeExternalLibrary', 'transparent', { unsafeAllowLinkedLibraries: true }, true);
+testOverride('UsesImplicitSafeExternalLibrary', 'transparent', { unsafeAllow: ['external-library-linking'] }, true);
+testOverride('UsesExplicitSafeExternalLibrary', 'transparent', { unsafeAllow: ['external-library-linking'] }, true);
+testValid('HasEmptyConstructor', 'uups', false);
+testValid('HasInternalUpgradeToFunction', 'uups', false);
+testValid('HasUpgradeToFunction', 'uups', true);
+testValid('ParentHasUpgradeToFunction', 'uups', true);
+testValid('ChildOfProxiable', 'uups', true);
+testValid('HasNonEmptyConstructorNatspec1', 'transparent', true);
+testValid('HasNonEmptyConstructorNatspec2', 'transparent', true);
+testValid('HasNonEmptyConstructorNatspec3', 'transparent', true);
+testValid('HasNonEmptyConstructorNatspec4', 'transparent', true);
+testValid('ParentHasNonEmptyConstructorNatspec1', 'transparent', true);
+testValid('ParentHasNonEmptyConstructorNatspec2', 'transparent', true);
+testValid('AncestorHasNonEmptyConstructorNatspec1', 'transparent', true);
+testValid('AncestorHasNonEmptyConstructorNatspec2', 'transparent', true);
+testValid('HasStateVariableAssignmentNatspec1', 'transparent', true);
+testValid('HasStateVariableAssignmentNatspec2', 'transparent', true);
+testValid('HasStateVariableAssignmentNatspec3', 'transparent', false);
+testValid('HasImmutableStateVariableNatspec1', 'transparent', true);
+testValid('HasImmutableStateVariableNatspec2', 'transparent', true);
+testValid('HasImmutableStateVariableNatspec3', 'transparent', false);
+testValid('HasSelfDestructNatspec1', 'transparent', true);
+testValid('HasSelfDestructNatspec2', 'transparent', true);
+testValid('HasSelfDestructNatspec3', 'transparent', true);
+testValid('HasDelegateCallNatspec1', 'transparent', true);
+testValid('HasDelegateCallNatspec2', 'transparent', true);
+testValid('HasDelegateCallNatspec3', 'transparent', true);
+testValid('ImportedParentHasStateVariableAssignmentNatspec1', 'transparent', true);
+testValid('ImportedParentHasStateVariableAssignmentNatspec2', 'transparent', true);
+testValid('UsesImplicitSafeInternalLibraryNatspec', 'transparent', true);
+testValid('UsesImplicitSafeExternalLibraryNatspec', 'transparent', true);
+testValid('UsesImplicitUnsafeInternalLibraryNatspec', 'transparent', true);
+testValid('UsesImplicitUnsafeExternalLibraryNatspec', 'transparent', true);
+testValid('UsesExplicitSafeInternalLibraryNatspec', 'transparent', true);
+testValid('UsesExplicitSafeExternalLibraryNatspec', 'transparent', true);
+testValid('UsesExplicitUnsafeInternalLibraryNatspec', 'transparent', true);
+testValid('UsesExplicitUnsafeExternalLibraryNatspec', 'transparent', true);
+//# sourceMappingURL=validate.test.js.map

package/dist/validate.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.test.js","sourceRoot":"","sources":["../src/validate.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA2C;AAC3C,qCAAoC;AAEpC,yCAOoB;AACpB,+CAAuD;AAMvD,MAAM,IAAI,GAAG,aAA+B,CAAC;AAE7C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;IACpB,MAAM,SAAS,GAAG;QAChB,oDAAoD;QACpD,sEAAsE;QACtE,+CAA+C;KAChD,CAAC;IAEF,CAAC,CAAC,OAAO,CAAC,UAAU,GAAG,EAAmB,CAAC;IAC3C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,qCAAqC,QAAQ,EAAE,CAAC,CAAC;SAClE;QACD,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC;QAClC,MAAM,SAAS,GAAG,oCAAsB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;KACtE;AACH,CAAC,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,IAAY,EAAE,IAA+B,EAAE,KAAc;IAC9E,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,YAAY,CAAC,IAAY,EAAE,IAA+B,EAAE,IAAuB,EAAE,KAAc;IAC1G,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrF,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE;QACjB,MAAM,OAAO,GAAG,6BAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC/D,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,4BAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAClG,IAAI,KAAK,EAAE;YACT,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;SAC5B;aAAM;YACL,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;SACzB;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,CAAC,qBAAqB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACtD,SAAS,CAAC,oCAAoC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACrE,SAAS,CAAC,kBAAkB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACnD,SAAS,CAAC,iCAAiC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAClE,SAAS,CAAC,iCAAiC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAElE,SAAS,CAAC,wBAAwB,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAC1D,SAAS,CAAC,8BAA8B,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAChE,SAAS,CAAC,gCAAgC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAClE,SAAS,CAAC,4BAA4B,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAC9D,SAAS,CAAC,2BAA2B,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAC7D,SAAS,CAAC,iBAAiB,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACnD,SAAS,CAAC,iBAAiB,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACnD,SAAS,CAAC,0CAA0C,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAC5E,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACrE,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACrE,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACrE,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAErE,kDAAkD;AAClD,uEAAuE;AACvE,SAAS,CAAC,iCAAiC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACnE,SAAS,CAAC,iCAAiC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AAEnE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,EAAE;IAC5B,MAAM,OAAO,GAAG,6BAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,2BAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC9C,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACvC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;KAChD;AACH,CAAC,CAAC,CAAC;AAEH,YAAY,CAAC,iCAAiC,EAAE,aAAa,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;AAC3G,YAAY,CAAC,iCAAiC,EAAE,aAAa,EAAE,EAAE,0BAA0B,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;AAC3G,YAAY,CAAC,iCAAiC,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,0BAA0B,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACpH,YAAY,CAAC,iCAAiC,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,0BAA0B,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AAEpH,SAAS,CAAC,qBAAqB,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAChD,SAAS,CAAC,8BAA8B,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AACzD,SAAS,CAAC,sBAAsB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAChD,SAAS,CAAC,4BAA4B,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AACtD,SAAS,CAAC,kBAAkB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5C,SAAS,CAAC,gCAAgC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACjE,SAAS,CAAC,gCAAgC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACjE,SAAS,CAAC,gCAAgC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACjE,SAAS,CAAC,gCAAgC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACjE,SAAS,CAAC,sCAAsC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACvE,SAAS,CAAC,sCAAsC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACvE,SAAS,CAAC,wCAAwC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACzE,SAAS,CAAC,wCAAwC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACzE,SAAS,CAAC,oCAAoC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACrE,SAAS,CAAC,oCAAoC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACrE,SAAS,CAAC,oCAAoC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACtE,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACpE,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACpE,SAAS,CAAC,mCAAmC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;AACrE,SAAS,CAAC,yBAAyB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC1D,SAAS,CAAC,yBAAyB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC1D,SAAS,CAAC,yBAAyB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC1D,SAAS,CAAC,yBAAyB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC1D,SAAS,CAAC,yBAAyB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC1D,SAAS,CAAC,yBAAyB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC1D,SAAS,CAAC,kDAAkD,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACnF,SAAS,CAAC,kDAAkD,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACnF,SAAS,CAAC,wCAAwC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACzE,SAAS,CAAC,wCAAwC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACzE,SAAS,CAAC,0CAA0C,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC3E,SAAS,CAAC,0CAA0C,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC3E,SAAS,CAAC,wCAAwC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACzE,SAAS,CAAC,wCAAwC,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AACzE,SAAS,CAAC,0CAA0C,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAC3E,SAAS,CAAC,0CAA0C,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,9 @@
+export interface Version {
+    withMetadata: string;
+    withoutMetadata: string;
+    linkedWithoutMetadata: string;
+}
+export declare function getVersion(bytecode: string, linkedBytecode?: string): Version;
+export declare function hashBytecode(bytecode: string): string;
+export declare function hashBytecodeWithoutMetadata(bytecode: string): string;
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,OAAO;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAU7E;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAcrD;AAED,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEpE"}

package/dist/version.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashBytecodeWithoutMetadata = exports.hashBytecode = exports.getVersion = void 0;
+const ethereumjs_util_1 = require("ethereumjs-util");
+const cbor_1 = __importDefault(require("cbor"));
+function getVersion(bytecode, linkedBytecode) {
+    if (bytecode !== '') {
+        return {
+            withMetadata: hashBytecode(bytecode),
+            withoutMetadata: hashBytecodeWithoutMetadata(bytecode),
+            linkedWithoutMetadata: hashBytecodeWithoutMetadata(linkedBytecode !== null && linkedBytecode !== void 0 ? linkedBytecode : bytecode),
+        };
+    }
+    else {
+        throw new Error('Abstract contract not allowed here');
+    }
+}
+exports.getVersion = getVersion;
+function hashBytecode(bytecode) {
+    bytecode = bytecode
+        .replace(/__\$([0-9a-fA-F]{34})\$__/g, (_, placeholder) => `000${placeholder}000`)
+        .replace(/__\w{36}__/g, placeholder => ethereumjs_util_1.keccak256(Buffer.from(placeholder)).toString('hex', 0, 20));
+    // Fail if bytecode is still not valid hex after transformations above.
+    // Buffer.from silently truncates at the first non-hex character.
+    // NOTE: Some bytecode seems to have odd length, so we cannot do ([0-9a-fA-F]{2})*
+    if (!/^(0x)?[0-9a-fA-F]*$/.test(bytecode)) {
+        throw new Error('Bytecode is not a valid hex string');
+    }
+    const buf = Buffer.from(bytecode.replace(/^0x/, ''), 'hex');
+    return ethereumjs_util_1.keccak256(buf).toString('hex');
+}
+exports.hashBytecode = hashBytecode;
+function hashBytecodeWithoutMetadata(bytecode) {
+    return hashBytecode(trimBytecodeMetadata(bytecode));
+}
+exports.hashBytecodeWithoutMetadata = hashBytecodeWithoutMetadata;
+function trimBytecodeMetadata(bytecode) {
+    // Bail on empty bytecode
+    if (bytecode.length <= 4) {
+        return bytecode;
+    }
+    // Gather length of CBOR metadata from the end of the file
+    const rawLength = bytecode.slice(bytecode.length - 4);
+    const metadataLength = parseInt(rawLength, 16) * 2;
+    // Bail on unreasonable values for length
+    if (metadataLength > bytecode.length - 4) {
+        return bytecode;
+    }
+    // Gather what we assume is the CBOR encoded metadata, and try to parse it
+    const metadataStart = bytecode.length - metadataLength - 4;
+    const metadata = bytecode.slice(metadataStart, bytecode.length - 4);
+    // Parse it to see if it is indeed valid metadata
+    try {
+        cbor_1.default.decode(Buffer.from(metadata, 'hex'));
+    }
+    catch (err) {
+        // to do: log lack metadata to the user
+        return bytecode;
+    }
+    // Return bytecode without it
+    return bytecode.slice(0, metadataStart);
+}
+//# sourceMappingURL=version.js.map