@openzeppelin/upgrades-core 1.9.2 → 1.12.0

package/dist/validate/query.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUpgradeSafe = exports.getErrors = exports.getUnlinkedBytecode = exports.findVersionWithoutMetadataMatches = exports.unfoldStorageLayout = exports.getStorageLayout = exports.getContractNameAndRunValidation = exports.getContractVersion = exports.assertUpgradeSafe = void 0;
+exports.inferProxyKind = exports.isUpgradeSafe = exports.getErrors = exports.getUnlinkedBytecode = exports.findVersionWithoutMetadataMatches = exports.unfoldStorageLayout = exports.getStorageLayout = exports.getContractNameAndRunValidation = exports.getContractVersion = exports.assertUpgradeSafe = void 0;
 const version_1 = require("../version");
 const link_refs_1 = require("../link-refs");
 const overrides_1 = require("./overrides");
 const error_1 = require("./error");
 const data_1 = require("./data");
+const upgradeToSignature = 'upgradeTo(address)';
 function assertUpgradeSafe(data, version, opts) {
     const dataV3 = (0, data_1.normalizeValidationData)(data);
     const [contractName] = getContractNameAndRunValidation(dataV3, version);
-    let errors = getErrors(dataV3, version);
-    errors = (0, overrides_1.processExceptions)(contractName, errors, opts);
+    const errors = getErrors(dataV3, version, opts);
     if (errors.length > 0) {
         throw new error_1.ValidationErrors(contractName, errors);
     }
@@ -86,21 +86,25 @@ function getUnlinkedBytecode(data, bytecode) {
     return bytecode;
 }
 exports.getUnlinkedBytecode = getUnlinkedBytecode;
-function getErrors(data, version) {
+function getErrors(data, version, opts = {}) {
     const dataV3 = (0, data_1.normalizeValidationData)(data);
     const [contractName, runValidation] = getContractNameAndRunValidation(dataV3, version);
     const c = runValidation[contractName];
     const errors = getUsedContractsAndLibraries(contractName, runValidation).flatMap(name => runValidation[name].errors);
-    const selfAndInheritedMethods = c.methods.concat(...c.inherit.map(name => runValidation[name].methods));
-    if (!selfAndInheritedMethods.includes('upgradeTo(address)')) {
+    const selfAndInheritedMethods = getAllMethods(runValidation, contractName);
+    if (!selfAndInheritedMethods.includes(upgradeToSignature)) {
         errors.push({
             src: c.src,
             kind: 'missing-public-upgradeto',
         });
     }
-    return errors;
+    return (0, overrides_1.processExceptions)(contractName, errors, opts);
 }
 exports.getErrors = getErrors;
+function getAllMethods(runValidation, contractName) {
+    const c = runValidation[contractName];
+    return c.methods.concat(...c.inherit.map(name => runValidation[name].methods));
+}
 function getUsedContractsAndLibraries(contractName, runValidation) {
     const c = runValidation[contractName];
     // Add current contract and all of its parents
@@ -118,4 +122,16 @@ function isUpgradeSafe(data, version) {
     return getErrors(dataV3, version).length == 0;
 }
 exports.isUpgradeSafe = isUpgradeSafe;
+function inferProxyKind(data, version) {
+    const dataV3 = (0, data_1.normalizeValidationData)(data);
+    const [contractName, runValidation] = getContractNameAndRunValidation(dataV3, version);
+    const methods = getAllMethods(runValidation, contractName);
+    if (methods.includes(upgradeToSignature)) {
+        return 'uups';
+    }
+    else {
+        return 'transparent';
+    }
+}
+exports.inferProxyKind = inferProxyKind;
 //# sourceMappingURL=query.js.map

package/dist/validate/query.js.map

@@ -1 +1 @@
-{"version":3,"file":"query.js","sourceRoot":"","sources":["../../src/validate/query.ts"],"names":[],"mappings":";;;AAAA,wCAAiD;AAGjD,4CAA8C;AAC9C,2CAAmE;AACnE,mCAA2C;AAC3C,iCAAiE;AAEjE,SAAgB,iBAAiB,CAAC,IAAoB,EAAE,OAAgB,EAAE,IAAuB;IAC/F,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExE,IAAI,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,MAAM,GAAG,IAAA,6BAAiB,EAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAEvD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,wBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KAClD;AACH,CAAC;AAVD,8CAUC;AAED,SAAgB,kBAAkB,CAAC,OAA0B,EAAE,YAAoB;IACjF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1C,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,cAAc,CAAC,CAAC;KACzD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAND,gDAMC;AAED,SAAgB,+BAA+B,CAAC,IAAoB,EAAE,OAAgB;IACpF,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAE7C,IAAI,aAAa,CAAC;IAClB,IAAI,YAAY,CAAC;IAEjB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,GAAG,EAAE;QACnC,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CACzC,IAAI,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,0CAAE,YAAY,MAAK,OAAO,CAAC,YAAY,CAAA,EAAA,CACxE,CAAC;QACF,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,aAAa,GAAG,UAAU,CAAC;YAC3B,MAAM;SACP;KACF;IAED,IAAI,YAAY,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE;QAC7D,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;KACjH;IAED,OAAO,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;AACvC,CAAC;AArBD,0EAqBC;AAED,SAAgB,gBAAgB,CAAC,IAAoB,EAAE,OAAgB;IACrE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvF,OAAO,mBAAmB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;AAC1D,CAAC;AAJD,4CAIC;AAED,SAAgB,mBAAmB,CAAC,OAA0B,EAAE,YAAoB;IAClF,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,MAAM,MAAM,GAAkB,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE;QACnD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KACzD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AARD,kDAQC;AAED,QAAe,CAAC,CAAC,iCAAiC,CAChD,IAAoB,EACpB,sBAA8B;;IAE9B,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAE7C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,GAAG,EAAE;QACnC,KAAK,MAAM,YAAY,IAAI,UAAU,EAAE;YACrC,IAAI,CAAA,MAAA,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,0CAAE,eAAe,MAAK,sBAAsB,EAAE;gBAChF,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;aAClC;SACF;KACF;AACH,CAAC;AAbD,8EAaC;AAED,SAAgB,mBAAmB,CAAC,IAAoB,EAAE,QAAgB;;IACxE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAE7C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,GAAG,EAAE;QACnC,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE7G,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE;YACpC,MAAM,EAAE,cAAc,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,gBAAgB,GAAG,IAAA,0BAAc,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,gBAAgB,CAAC,CAAC;YAE7C,IAAI,CAAA,MAAA,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,0CAAE,YAAY,MAAK,OAAO,CAAC,YAAY,EAAE;gBACnE,OAAO,gBAAgB,CAAC;aACzB;SACF;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAlBD,kDAkBC;AAED,SAAgB,SAAS,CAAC,IAAoB,EAAE,OAAgB;IAC9D,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvF,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG,4BAA4B,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;IAErH,MAAM,uBAAuB,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAExG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QAC3D,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,CAAC,CAAC,GAAG;YACV,IAAI,EAAE,0BAA0B;SACjC,CAAC,CAAC;KACJ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,8BAiBC;AAED,SAAS,4BAA4B,CAAC,YAAoB,EAAE,aAAgC;IAC1F,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IACtC,8CAA8C;IAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAClD,0DAA0D;IAC1D,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;QACpB,KAAK,MAAM,EAAE,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE;YAC5C,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAgB,aAAa,CAAC,IAAoB,EAAE,OAAgB;IAClE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;AAChD,CAAC;AAHD,sCAGC"}
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../src/validate/query.ts"],"names":[],"mappings":";;;AAAA,wCAAiD;AAGjD,4CAA8C;AAC9C,2CAAmE;AACnE,mCAA2C;AAC3C,iCAAiE;AAGjE,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAEhD,SAAgB,iBAAiB,CAAC,IAAoB,EAAE,OAAgB,EAAE,IAAuB;IAC/F,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAEhD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,wBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KAClD;AACH,CAAC;AATD,8CASC;AAED,SAAgB,kBAAkB,CAAC,OAA0B,EAAE,YAAoB;IACjF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1C,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,cAAc,CAAC,CAAC;KACzD;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAND,gDAMC;AAED,SAAgB,+BAA+B,CAAC,IAAoB,EAAE,OAAgB;IACpF,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAE7C,IAAI,aAAa,CAAC;IAClB,IAAI,YAAY,CAAC;IAEjB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,GAAG,EAAE;QACnC,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CACzC,IAAI,CAAC,EAAE,WAAC,OAAA,CAAA,MAAA,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,0CAAE,YAAY,MAAK,OAAO,CAAC,YAAY,CAAA,EAAA,CACxE,CAAC;QACF,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,aAAa,GAAG,UAAU,CAAC;YAC3B,MAAM;SACP;KACF;IAED,IAAI,YAAY,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE;QAC7D,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAC;KACjH;IAED,OAAO,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;AACvC,CAAC;AArBD,0EAqBC;AAED,SAAgB,gBAAgB,CAAC,IAAoB,EAAE,OAAgB;IACrE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvF,OAAO,mBAAmB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;AAC1D,CAAC;AAJD,4CAIC;AAED,SAAgB,mBAAmB,CAAC,OAA0B,EAAE,YAAoB;IAClF,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,MAAM,MAAM,GAAkB,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE;QACnD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KACzD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AARD,kDAQC;AAED,QAAe,CAAC,CAAC,iCAAiC,CAChD,IAAoB,EACpB,sBAA8B;;IAE9B,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAE7C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,GAAG,EAAE;QACnC,KAAK,MAAM,YAAY,IAAI,UAAU,EAAE;YACrC,IAAI,CAAA,MAAA,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,0CAAE,eAAe,MAAK,sBAAsB,EAAE;gBAChF,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;aAClC;SACF;KACF;AACH,CAAC;AAbD,8EAaC;AAED,SAAgB,mBAAmB,CAAC,IAAoB,EAAE,QAAgB;;IACxE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAE7C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,GAAG,EAAE;QACnC,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE7G,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE;YACpC,MAAM,EAAE,cAAc,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,gBAAgB,GAAG,IAAA,0BAAc,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,gBAAgB,CAAC,CAAC;YAE7C,IAAI,CAAA,MAAA,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,0CAAE,YAAY,MAAK,OAAO,CAAC,YAAY,EAAE;gBACnE,OAAO,gBAAgB,CAAC;aACzB;SACF;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAlBD,kDAkBC;AAED,SAAgB,SAAS,CAAC,IAAoB,EAAE,OAAgB,EAAE,OAA0B,EAAE;IAC5F,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvF,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG,4BAA4B,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;IAErH,MAAM,uBAAuB,GAAG,aAAa,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;IAE3E,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE;QACzD,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,CAAC,CAAC,GAAG;YACV,IAAI,EAAE,0BAA0B;SACjC,CAAC,CAAC;KACJ;IAED,OAAO,IAAA,6BAAiB,EAAC,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AACvD,CAAC;AAjBD,8BAiBC;AAED,SAAS,aAAa,CAAC,aAAgC,EAAE,YAAoB;IAC3E,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IACtC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,SAAS,4BAA4B,CAAC,YAAoB,EAAE,aAAgC;IAC1F,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;IACtC,8CAA8C;IAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAClD,0DAA0D;IAC1D,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;QACpB,KAAK,MAAM,EAAE,IAAI,aAAa,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE;YAC5C,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED,SAAgB,aAAa,CAAC,IAAoB,EAAE,OAAgB;IAClE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;AAChD,CAAC;AAHD,sCAGC;AAED,SAAgB,cAAc,CAAC,IAAoB,EAAE,OAAgB;IACnE,MAAM,MAAM,GAAG,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvF,MAAM,OAAO,GAAG,aAAa,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;IAC3D,IAAI,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE;QACxC,OAAO,MAAM,CAAC;KACf;SAAM;QACL,OAAO,aAAa,CAAC;KACtB;AACH,CAAC;AATD,wCASC"}

package/dist/validate/report.d.ts

@@ -0,0 +1,8 @@
+import { ValidationError } from './run';
+export declare class UpgradeableContractErrorReport {
+    readonly errors: ValidationError[];
+    constructor(errors: ValidationError[]);
+    get ok(): boolean;
+    explain(color?: boolean): string;
+}
+//# sourceMappingURL=report.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../src/validate/report.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAExC,qBAAa,8BAA8B;IAC7B,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE;gBAAzB,MAAM,EAAE,eAAe,EAAE;IAE9C,IAAI,EAAE,IAAI,OAAO,CAEhB;IAED,OAAO,CAAC,KAAK,UAAO,GAAG,MAAM;CAG9B"}

package/dist/validate/report.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpgradeableContractErrorReport = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+class UpgradeableContractErrorReport {
+    constructor(errors) {
+        this.errors = errors;
+    }
+    get ok() {
+        return this.errors.length === 0;
+    }
+    explain(color = true) {
+        return this.errors.map(e => describeError(e, color)).join('\n\n');
+    }
+}
+exports.UpgradeableContractErrorReport = UpgradeableContractErrorReport;
+const errorInfo = {
+    constructor: {
+        msg: e => `Contract \`${e.contract}\` has a constructor`,
+        hint: () => 'Define an initializer instead',
+        link: 'https://zpl.in/upgrades/error-001',
+    },
+    delegatecall: {
+        msg: () => `Use of delegatecall is not allowed`,
+        link: 'https://zpl.in/upgrades/error-002',
+    },
+    selfdestruct: {
+        msg: () => `Use of selfdestruct is not allowed`,
+        link: 'https://zpl.in/upgrades/error-003',
+    },
+    'state-variable-assignment': {
+        msg: e => `Variable \`${e.name}\` is assigned an initial value`,
+        hint: () => 'Move the assignment to the initializer',
+        link: 'https://zpl.in/upgrades/error-004',
+    },
+    'state-variable-immutable': {
+        msg: e => `Variable \`${e.name}\` is immutable`,
+        hint: () => `Use a constant or mutable variable instead`,
+        link: 'https://zpl.in/upgrades/error-005',
+    },
+    'external-library-linking': {
+        msg: e => `Linking external libraries like \`${e.name}\` is not yet supported`,
+        hint: () => `Use libraries with internal functions only, or skip this check with the \`unsafeAllowLinkedLibraries\` flag \n` +
+            `    if you have manually checked that the libraries are upgrade safe`,
+        link: 'https://zpl.in/upgrades/error-006',
+    },
+    'struct-definition': {
+        msg: e => `Structs like \`${e.name}\` are supported in the latest version of the plugin`,
+        hint: () => `Update your dependency and run again`,
+    },
+    'enum-definition': {
+        msg: e => `Enums like \`${e.name}\` are supported in the latest version of the plugin`,
+        hint: () => `Update your dependency and run again`,
+    },
+    'missing-public-upgradeto': {
+        msg: () => `Implementation is missing a public \`upgradeTo(address)\` function`,
+        hint: () => `Inherit UUPSUpgradeable to include this function in your contract\n` +
+            `    @openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol`,
+        link: 'https://zpl.in/upgrades/error-008',
+    },
+};
+function describeError(e, color = true) {
+    var _a;
+    const chalk = new chalk_1.default.Instance({ level: color && chalk_1.default.supportsColor ? chalk_1.default.supportsColor.level : 0 });
+    const info = errorInfo[e.kind];
+    const log = [chalk.bold(e.src) + ': ' + info.msg(e)];
+    const hint = (_a = info.hint) === null || _a === void 0 ? void 0 : _a.call(info, e);
+    if (hint) {
+        log.push(hint);
+    }
+    if (info.link) {
+        log.push(chalk.dim(info.link));
+    }
+    return log.join('\n    ');
+}
+//# sourceMappingURL=report.js.map

package/dist/validate/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../src/validate/report.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA2B;AAK3B,MAAa,8BAA8B;IACzC,YAAqB,MAAyB;QAAzB,WAAM,GAAN,MAAM,CAAmB;IAAG,CAAC;IAElD,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,CAAC,KAAK,GAAG,IAAI;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;CACF;AAVD,wEAUC;AAED,MAAM,SAAS,GAAuC;IACpD,WAAW,EAAE;QACX,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,QAAQ,sBAAsB;QACxD,IAAI,EAAE,GAAG,EAAE,CAAC,+BAA+B;QAC3C,IAAI,EAAE,mCAAmC;KAC1C;IACD,YAAY,EAAE;QACZ,GAAG,EAAE,GAAG,EAAE,CAAC,oCAAoC;QAC/C,IAAI,EAAE,mCAAmC;KAC1C;IACD,YAAY,EAAE;QACZ,GAAG,EAAE,GAAG,EAAE,CAAC,oCAAoC;QAC/C,IAAI,EAAE,mCAAmC;KAC1C;IACD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,IAAI,iCAAiC;QAC/D,IAAI,EAAE,GAAG,EAAE,CAAC,wCAAwC;QACpD,IAAI,EAAE,mCAAmC;KAC1C;IACD,0BAA0B,EAAE;QAC1B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,IAAI,iBAAiB;QAC/C,IAAI,EAAE,GAAG,EAAE,CAAC,4CAA4C;QACxD,IAAI,EAAE,mCAAmC;KAC1C;IACD,0BAA0B,EAAE;QAC1B,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,qCAAqC,CAAC,CAAC,IAAI,yBAAyB;QAC9E,IAAI,EAAE,GAAG,EAAE,CACT,gHAAgH;YAChH,sEAAsE;QACxE,IAAI,EAAE,mCAAmC;KAC1C;IACD,mBAAmB,EAAE;QACnB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,IAAI,sDAAsD;QACxF,IAAI,EAAE,GAAG,EAAE,CAAC,sCAAsC;KACnD;IACD,iBAAiB,EAAE;QACjB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,IAAI,sDAAsD;QACtF,IAAI,EAAE,GAAG,EAAE,CAAC,sCAAsC;KACnD;IACD,0BAA0B,EAAE;QAC1B,GAAG,EAAE,GAAG,EAAE,CAAC,oEAAoE;QAC/E,IAAI,EAAE,GAAG,EAAE,CACT,qEAAqE;YACrE,yEAAyE;QAC3E,IAAI,EAAE,mCAAmC;KAC1C;CACF,CAAC;AAEF,SAAS,aAAa,CAAC,CAAkB,EAAE,KAAK,GAAG,IAAI;;IACrD,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;IAC7G,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAQ,CAAC,CAAC,CAAC;IAC5D,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,IAAI,+CAAT,IAAI,EAAQ,CAAQ,CAAC,CAAC;IACnC,IAAI,IAAI,EAAE;QACR,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAChB;IACD,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;KAChC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC5B,CAAC"}

package/dist/version.d.ts

@@ -3,7 +3,7 @@ export interface Version {
     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;
+export declare function getVersion(bytecode: string, linkedBytecode?: string, constructorArgs?: string): Version;
+export declare function hashBytecode(bytecode: string, constructorArgs?: string): string;
+export declare function hashBytecodeWithoutMetadata(bytecode: string, constructorArgs?: string): string;
 //# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -1 +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"}
+{"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,EAAE,eAAe,SAAK,GAAG,OAAO,CAUnG;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,SAAK,GAAG,MAAM,CAsB3E;AAED,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,SAAK,GAAG,MAAM,CAE1F"}

package/dist/version.js

@@ -6,12 +6,12 @@ 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) {
+function getVersion(bytecode, linkedBytecode, constructorArgs = '') {
     if (bytecode !== '') {
         return {
             withMetadata: hashBytecode(bytecode),
             withoutMetadata: hashBytecodeWithoutMetadata(bytecode),
-            linkedWithoutMetadata: hashBytecodeWithoutMetadata(linkedBytecode !== null && linkedBytecode !== void 0 ? linkedBytecode : bytecode),
+            linkedWithoutMetadata: hashBytecodeWithoutMetadata(linkedBytecode !== null && linkedBytecode !== void 0 ? linkedBytecode : bytecode, constructorArgs),
         };
     }
     else {
@@ -19,7 +19,7 @@ function getVersion(bytecode, linkedBytecode) {
     }
 }
 exports.getVersion = getVersion;
-function hashBytecode(bytecode) {
+function hashBytecode(bytecode, constructorArgs = '') {
     bytecode = bytecode
         .replace(/__\$([0-9a-fA-F]{34})\$__/g, (_, placeholder) => `000${placeholder}000`)
         .replace(/__\w{36}__/g, placeholder => (0, ethereumjs_util_1.keccak256)(Buffer.from(placeholder)).toString('hex', 0, 20));
@@ -29,12 +29,18 @@ function hashBytecode(bytecode) {
     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');
+    if (!/^(0x)?[0-9a-fA-F]*$/.test(constructorArgs)) {
+        throw new Error('Constructor arguments are not a valid hex string');
+    }
+    const buf = Buffer.concat([
+        Buffer.from(bytecode.replace(/^0x/, ''), 'hex'),
+        Buffer.from(constructorArgs.replace(/^0x/, ''), 'hex'),
+    ]);
     return (0, ethereumjs_util_1.keccak256)(buf).toString('hex');
 }
 exports.hashBytecode = hashBytecode;
-function hashBytecodeWithoutMetadata(bytecode) {
-    return hashBytecode(trimBytecodeMetadata(bytecode));
+function hashBytecodeWithoutMetadata(bytecode, constructorArgs = '') {
+    return hashBytecode(trimBytecodeMetadata(bytecode), constructorArgs);
 }
 exports.hashBytecodeWithoutMetadata = hashBytecodeWithoutMetadata;
 function trimBytecodeMetadata(bytecode) {

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;;;;AAAA,qDAA4C;AAC5C,gDAAwB;AAQxB,SAAgB,UAAU,CAAC,QAAgB,EAAE,cAAuB;IAClE,IAAI,QAAQ,KAAK,EAAE,EAAE;QACnB,OAAO;YACL,YAAY,EAAE,YAAY,CAAC,QAAQ,CAAC;YACpC,eAAe,EAAE,2BAA2B,CAAC,QAAQ,CAAC;YACtD,qBAAqB,EAAE,2BAA2B,CAAC,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,QAAQ,CAAC;SAC/E,CAAC;KACH;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;AACH,CAAC;AAVD,gCAUC;AAED,SAAgB,YAAY,CAAC,QAAgB;IAC3C,QAAQ,GAAG,QAAQ;SAChB,OAAO,CAAC,4BAA4B,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC,MAAM,WAAW,KAAK,CAAC;SACjF,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,CAAC,IAAA,2BAAS,EAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAErG,uEAAuE;IACvE,iEAAiE;IACjE,kFAAkF;IAClF,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5D,OAAO,IAAA,2BAAS,EAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AAdD,oCAcC;AAED,SAAgB,2BAA2B,CAAC,QAAgB;IAC1D,OAAO,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;AACtD,CAAC;AAFD,kEAEC;AAED,SAAS,oBAAoB,CAAC,QAAgB;IAC5C,yBAAyB;IACzB,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE;QACxB,OAAO,QAAQ,CAAC;KACjB;IAED,0DAA0D;IAC1D,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAEnD,yCAAyC;IACzC,IAAI,cAAc,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACxC,OAAO,QAAQ,CAAC;KACjB;IAED,0EAA0E;IAC1E,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,GAAG,cAAc,GAAG,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEpE,iDAAiD;IACjD,IAAI;QACF,cAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACZ,uCAAuC;QACvC,OAAO,QAAQ,CAAC;KACjB;IAED,6BAA6B;IAC7B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;;;;AAAA,qDAA4C;AAC5C,gDAAwB;AAQxB,SAAgB,UAAU,CAAC,QAAgB,EAAE,cAAuB,EAAE,eAAe,GAAG,EAAE;IACxF,IAAI,QAAQ,KAAK,EAAE,EAAE;QACnB,OAAO;YACL,YAAY,EAAE,YAAY,CAAC,QAAQ,CAAC;YACpC,eAAe,EAAE,2BAA2B,CAAC,QAAQ,CAAC;YACtD,qBAAqB,EAAE,2BAA2B,CAAC,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,QAAQ,EAAE,eAAe,CAAC;SAChG,CAAC;KACH;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;AACH,CAAC;AAVD,gCAUC;AAED,SAAgB,YAAY,CAAC,QAAgB,EAAE,eAAe,GAAG,EAAE;IACjE,QAAQ,GAAG,QAAQ;SAChB,OAAO,CAAC,4BAA4B,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC,MAAM,WAAW,KAAK,CAAC;SACjF,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,CAAC,IAAA,2BAAS,EAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAErG,uEAAuE;IACvE,iEAAiE;IACjE,kFAAkF;IAClF,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;IAED,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;QAChD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACrE;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;QACxB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC;KACvD,CAAC,CAAC;IAEH,OAAO,IAAA,2BAAS,EAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AAtBD,oCAsBC;AAED,SAAgB,2BAA2B,CAAC,QAAgB,EAAE,eAAe,GAAG,EAAE;IAChF,OAAO,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAC,CAAC;AACvE,CAAC;AAFD,kEAEC;AAED,SAAS,oBAAoB,CAAC,QAAgB;IAC5C,yBAAyB;IACzB,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE;QACxB,OAAO,QAAQ,CAAC;KACjB;IAED,0DAA0D;IAC1D,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAEnD,yCAAyC;IACzC,IAAI,cAAc,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACxC,OAAO,QAAQ,CAAC;KACjB;IAED,0EAA0E;IAC1E,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,GAAG,cAAc,GAAG,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEpE,iDAAiD;IACjD,IAAI;QACF,cAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACZ,uCAAuC;QACvC,OAAO,QAAQ,CAAC;KACjB;IAED,6BAA6B;IAC7B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;AAC1C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.9.2",
+  "version": "1.12.0",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -13,6 +13,8 @@
     "/artifacts/contracts/proxy/AdminUpgradeabilityProxy.sol/AdminUpgradeabilityProxy.json",
     "/artifacts/contracts/proxy/ProxyAdmin.sol/ProxyAdmin.json",
     "/contracts/Initializable.sol",
+    "/artifacts/@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol",
+    "/artifacts/@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol",
     "/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol/ProxyAdmin.json ",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json"
@@ -30,7 +32,7 @@
   "devDependencies": {
     "@ava/typescript": "^2.0.0",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
-    "@nomiclabs/hardhat-etherscan": "^2.1.0",
+    "@nomiclabs/hardhat-etherscan": "^3.0.0",
     "@openzeppelin/contracts": "4.1.0",
     "@openzeppelin/contracts-upgradeable": "4.1.0",
     "@types/bn.js": "^5.0.0",
@@ -41,7 +43,7 @@
     "@types/proper-lockfile": "^4.1.1",
     "@types/rimraf": "^3.0.0",
     "ava": "^3.9.0",
-    "dotenv": "^10.0.0",
+    "dotenv": "^14.0.0",
     "fgbg": "^0.1.4",
     "hardhat": "^2.0.2",
     "rimraf": "^3.0.2",
@@ -51,10 +53,11 @@
     "bn.js": "^5.1.2",
     "cbor": "^8.0.0",
     "chalk": "^4.1.0",
-    "compare-versions": "^3.6.0",
+    "compare-versions": "^4.0.0",
     "debug": "^4.1.1",
     "ethereumjs-util": "^7.0.3",
     "proper-lockfile": "^4.1.1",
     "solidity-ast": "^0.4.15"
-  }
+  },
+  "gitHead": "aff3cdacedb7265f5b54cdb8408e9517bb009e7f"
 }

package/src/beacon.ts

@@ -0,0 +1,20 @@
+import { InvalidBeacon, getImplementationAddressFromBeacon } from './impl-address';
+import { EthereumProvider } from './provider';
+
+/**
+ * Checks if the address looks like a beacon.
+ *
+ * @returns true if the address has an implementation() function that returns an address, false otherwise.
+ */
+export async function isBeacon(provider: EthereumProvider, beaconAddress: string): Promise<boolean> {
+  try {
+    await getImplementationAddressFromBeacon(provider, beaconAddress);
+    return true;
+  } catch (e: any) {
+    if (e instanceof InvalidBeacon) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+}

package/src/deployment.test.ts

@@ -1,5 +1,6 @@
 import test from 'ava';
 import { promisify } from 'util';
+import { TransactionMinedTimeout } from '.';
 
 import { Deployment, resumeOrDeploy, waitAndValidateDeployment } from './deployment';
 import { stubProvider } from './stub-provider';
@@ -96,3 +97,27 @@ test('waits for a deployment to return contract code', async t => {
   provider.addContract(deployment.address);
   await waitAndValidateDeployment(provider, deployment);
 });
+
+test('tx mined timeout - no params', async t => {
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  try {
+    throw new TransactionMinedTimeout(deployment);
+  } catch (e: any) {
+    const EXPECTED =
+      /Timed out waiting for contract deployment to address \S+ with transaction \S+\n\nRun the function again to continue waiting for the transaction confirmation./;
+    t.true(EXPECTED.test(e.message), e.message);
+  }
+});
+
+test('tx mined timeout - params', async t => {
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  try {
+    throw new TransactionMinedTimeout(deployment, 'implementation', true);
+  } catch (e: any) {
+    const EXPECTED =
+      /Timed out waiting for implementation contract deployment to address \S+ with transaction \S+\n\nRun the function again to continue waiting for the transaction confirmation. If the problem persists, adjust the polling parameters with the timeout and pollingInterval options./;
+    t.true(EXPECTED.test(e.message), e.message);
+  }
+});

package/src/deployment.ts

@@ -10,6 +10,7 @@ import {
   isDevelopmentNetwork,
   isReceiptSuccessful,
 } from './provider';
+import { UpgradesError } from './error';
 
 const sleep = promisify(setTimeout);
 
@@ -18,6 +19,18 @@ export interface Deployment {
   txHash?: string;
 }
 
+export interface DeployOpts {
+  /**
+   * Timeout in milliseconds to wait for the transaction confirmation when deploying an implementation contract or proxy admin contract. Use `0` to wait indefinitely.
+   */
+  timeout?: number;
+
+  /**
+   * Polling interval in milliseconds between checks for the transaction confirmation when deploying an implementation contract or proxy admin contract.
+   */
+  pollingInterval?: number;
+}
+
 export async function resumeOrDeploy<T extends Deployment>(
   provider: EthereumProvider,
   cached: T | undefined,
@@ -51,24 +64,25 @@ export async function resumeOrDeploy<T extends Deployment>(
   return deployment;
 }
 
-export async function waitAndValidateDeployment(provider: EthereumProvider, deployment: Deployment): Promise<void> {
+export async function waitAndValidateDeployment(
+  provider: EthereumProvider,
+  deployment: Deployment,
+  type?: string,
+  opts?: DeployOpts,
+): Promise<void> {
   const { txHash, address } = deployment;
 
-  // Poll for 60 seconds with a 5 second poll interval.
-  // TODO: Make these parameters configurable.
-  const pollTimeout = 60e3;
-  const pollInterval = 5e3;
+  // Poll for 60 seconds with a 5 second poll interval by default.
+  const pollTimeout = opts?.timeout ?? 60e3;
+  const pollInterval = opts?.pollingInterval ?? 5e3;
+
+  debug('polling timeout', pollTimeout, 'polling interval', pollInterval);
 
   if (txHash !== undefined) {
     const startTime = Date.now();
 
     // eslint-disable-next-line no-constant-condition
     while (true) {
-      const elapsedTime = Date.now() - startTime;
-      if (elapsedTime >= pollTimeout) {
-        // A timeout is NOT an InvalidDeployment
-        throw new TransactionMinedTimeout(deployment);
-      }
       debug('verifying deployment tx mined', txHash);
       const receipt = await getTransactionReceipt(provider, txHash);
       if (receipt && isReceiptSuccessful(receipt)) {
@@ -81,6 +95,13 @@ export async function waitAndValidateDeployment(provider: EthereumProvider, depl
         debug('waiting for deployment tx mined', txHash);
         await sleep(pollInterval);
       }
+      if (pollTimeout != 0) {
+        const elapsedTime = Date.now() - startTime;
+        if (elapsedTime >= pollTimeout) {
+          // A timeout is NOT an InvalidDeployment
+          throw new TransactionMinedTimeout(deployment, type, !!opts);
+        }
+      }
     }
   }
 
@@ -96,9 +117,18 @@ export async function waitAndValidateDeployment(provider: EthereumProvider, depl
   debug('code in target address found', address);
 }
 
-export class TransactionMinedTimeout extends Error {
-  constructor(readonly deployment: Deployment) {
-    super(`Timed out waiting for transaction ${deployment.txHash}`);
+export class TransactionMinedTimeout extends UpgradesError {
+  constructor(readonly deployment: Deployment, type?: string, configurableTimeout?: boolean) {
+    super(
+      `Timed out waiting for ${type ? type + ' ' : ''}contract deployment to address ${
+        deployment.address
+      } with transaction ${deployment.txHash}`,
+      () =>
+        'Run the function again to continue waiting for the transaction confirmation.' +
+        (configurableTimeout
+          ? ' If the problem persists, adjust the polling parameters with the timeout and pollingInterval options.'
+          : ''),
+    );
   }
 }
 

package/src/eip-1967-type.ts

@@ -0,0 +1,35 @@
+import {
+  EIP1967BeaconNotFound,
+  EIP1967ImplementationNotFound,
+  getBeaconAddress,
+  getImplementationAddress,
+} from './eip-1967';
+import { EthereumProvider } from './provider';
+
+export async function isTransparentOrUUPSProxy(provider: EthereumProvider, address: string): Promise<boolean> {
+  try {
+    await getImplementationAddress(provider, address);
+    // if an exception was not encountered above, then this address is a transparent/uups proxy
+    return true;
+  } catch (e: any) {
+    if (e instanceof EIP1967ImplementationNotFound) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+}
+
+export async function isBeaconProxy(provider: EthereumProvider, address: string): Promise<boolean> {
+  try {
+    await getBeaconAddress(provider, address);
+    // if an exception was not encountered above, then this address is a beacon proxy
+    return true;
+  } catch (e: any) {
+    if (e instanceof EIP1967BeaconNotFound) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+}

package/src/eip-1967.ts

@@ -1,7 +1,12 @@
-import { toChecksumAddress, keccak256 } from 'ethereumjs-util';
 import BN from 'bn.js';
-
+import { keccak256 } from 'ethereumjs-util';
+import { UpgradesError } from './error';
 import { EthereumProvider, getStorageAt } from './provider';
+import { parseAddress } from './utils/address';
+
+export class EIP1967ImplementationNotFound extends UpgradesError {}
+
+export class EIP1967BeaconNotFound extends UpgradesError {}
 
 export async function getAdminAddress(provider: EthereumProvider, address: string): Promise<string> {
   const storage = await getStorageFallback(
@@ -11,7 +16,7 @@ export async function getAdminAddress(provider: EthereumProvider, address: strin
     toFallbackEip1967Hash('org.zeppelinos.proxy.admin'),
   );
 
-  return parseAddress(storage);
+  return parseAddressFromStorage(storage);
 }
 
 export async function getImplementationAddress(provider: EthereumProvider, address: string): Promise<string> {
@@ -23,20 +28,20 @@ export async function getImplementationAddress(provider: EthereumProvider, addre
   );
 
   if (isEmptySlot(storage)) {
-    throw new Error(`Contract at ${address} doesn't look like an administered ERC 1967 proxy`);
+    throw new EIP1967ImplementationNotFound(`Contract at ${address} doesn't look like an administered ERC 1967 proxy`);
   }
 
-  return parseAddress(storage);
+  return parseAddressFromStorage(storage);
 }
 
 export async function getBeaconAddress(provider: EthereumProvider, address: string): Promise<string> {
   const storage = await getStorageFallback(provider, address, toEip1967Hash('eip1967.proxy.beacon'));
 
   if (isEmptySlot(storage)) {
-    throw new Error(`Contract at ${address} doesn't look like an ERC 1967 beacon proxy`);
+    throw new EIP1967BeaconNotFound(`Contract at ${address} doesn't look like an ERC 1967 beacon proxy`);
   }
 
-  return parseAddress(storage);
+  return parseAddressFromStorage(storage);
 }
 
 async function getStorageFallback(provider: EthereumProvider, address: string, ...slots: string[]): Promise<string> {
@@ -67,11 +72,10 @@ function isEmptySlot(storage: string): boolean {
   return new BN(storage, 'hex').isZero();
 }
 
-function parseAddress(storage: string): string {
-  const buf = Buffer.from(storage.replace(/^0x/, ''), 'hex');
-  if (!buf.slice(0, 12).equals(Buffer.alloc(12, 0))) {
+function parseAddressFromStorage(storage: string): string {
+  const address = parseAddress(storage);
+  if (address === undefined) {
     throw new Error(`Value in storage is not an address (${storage})`);
   }
-  const address = '0x' + buf.toString('hex', 12, 32); // grab the last 20 bytes
-  return toChecksumAddress(address);
+  return address;
 }

package/src/impl-address.ts

@@ -0,0 +1,76 @@
+import { keccak256 } from 'ethereumjs-util';
+import {
+  call,
+  EIP1967BeaconNotFound,
+  EIP1967ImplementationNotFound,
+  getBeaconAddress,
+  getImplementationAddress,
+  UpgradesError,
+} from '.';
+
+import { EthereumProvider } from './provider';
+import { parseAddress } from './utils/address';
+
+export class InvalidBeacon extends UpgradesError {}
+
+/**
+ * Gets the implementation address from the beacon using its implementation() function.
+ * @param provider
+ * @param beaconAddress
+ * @returns The implementation address.
+ * @throws {InvalidBeacon} If the implementation() function could not be called or does not return an address.
+ */
+export async function getImplementationAddressFromBeacon(
+  provider: EthereumProvider,
+  beaconAddress: string,
+): Promise<string> {
+  const implementationFunction = '0x' + keccak256(Buffer.from('implementation()')).toString('hex').slice(0, 8);
+  let result: string | undefined;
+  try {
+    const implAddress = await call(provider, beaconAddress, implementationFunction);
+    result = parseAddress(implAddress);
+  } catch (e: any) {
+    if (
+      !(
+        e.message.includes('function selector was not recognized') ||
+        e.message.includes('invalid opcode') ||
+        e.message.includes('reverted')
+      )
+    ) {
+      throw e;
+    } // otherwise fall through with no result
+  }
+  if (result === undefined) {
+    throw new InvalidBeacon(`Contract at ${beaconAddress} doesn't look like a beacon`);
+  }
+  return result;
+}
+
+/**
+ * Gets the implementation address from a UUPS/Transparent/Beacon proxy.
+ *
+ * @returns a Promise with the implementation address, or undefined if a UUPS/Transparent/Beacon proxy is not located at the address.
+ */
+export async function getImplementationAddressFromProxy(
+  provider: EthereumProvider,
+  proxyAddress: string,
+): Promise<string | undefined> {
+  try {
+    return await getImplementationAddress(provider, proxyAddress);
+  } catch (e: any) {
+    if (e instanceof EIP1967ImplementationNotFound) {
+      try {
+        const beaconAddress = await getBeaconAddress(provider, proxyAddress);
+        return await getImplementationAddressFromBeacon(provider, beaconAddress);
+      } catch (e: any) {
+        if (e instanceof EIP1967BeaconNotFound) {
+          return undefined;
+        } else {
+          throw e;
+        }
+      }
+    } else {
+      throw e;
+    }
+  }
+}