@openzeppelin/upgrades-core 1.17.0 → 1.19.1

package/dist/validate/data.js

@@ -1,10 +1,30 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.concatRunData = exports.isCurrentValidationData = exports.normalizeValidationData = void 0;
-const compare_versions_1 = __importDefault(require("compare-versions"));
+const versions = __importStar(require("compare-versions"));
 const currentMajor = '3';
 const currentVersion = '3.2';
 function normalizeValidationData(data) {
@@ -26,12 +46,12 @@ function isCurrentValidationData(data, exact = true) {
     else if (!('version' in data)) {
         return false;
     }
-    else if (typeof data.version === 'string' && compare_versions_1.default.validate(data.version)) {
+    else if (typeof data.version === 'string' && versions.validate(data.version)) {
         if (exact) {
             return data.version === currentVersion;
         }
         else {
-            return compare_versions_1.default.compare(data.version, `${currentMajor}.*`, '=');
+            return versions.compare(data.version, `${currentMajor}.*`, '=');
         }
     }
     else {

package/dist/validate/data.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.js","sourceRoot":"","sources":["../../src/validate/data.ts"],"names":[],"mappings":";;;;;;AAAA,wEAAwC;AAQxC,MAAM,YAAY,GAAG,GAAG,CAAC;AACzB,MAAM,cAAc,GAAG,KAAK,CAAC;AAW7B,SAAgB,uBAAuB,CAAC,IAAoB;IAC1D,IAAI,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;QACxC,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;KAC/C;SAAM;QACL,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;KACjD;AACH,CAAC;AARD,0DAQC;AAED,SAAgB,uBAAuB,CAAC,IAAoB,EAAE,KAAK,GAAG,IAAI;IACxE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE;QAC/B,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,0BAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC9E,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC;SACxC;aAAM;YACL,OAAO,0BAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,YAAY,IAAI,EAAE,GAAG,CAAC,CAAC;SACjE;KACF;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;KACjE;AACH,CAAC;AAdD,0DAcC;AAED,SAAgB,aAAa,CAC3B,UAA6B,EAC7B,YAAoC;IAEpC,OAAO;QACL,OAAO,EAAE,cAAc;QACvB,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,IAAI,EAAE,CAAC;KAClD,CAAC;AACJ,CAAC;AARD,sCAQC"}
+{"version":3,"file":"data.js","sourceRoot":"","sources":["../../src/validate/data.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA6C;AAQ7C,MAAM,YAAY,GAAG,GAAG,CAAC;AACzB,MAAM,cAAc,GAAG,KAAK,CAAC;AAW7B,SAAgB,uBAAuB,CAAC,IAAoB;IAC1D,IAAI,uBAAuB,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;QACxC,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;KAC/C;SAAM;QACL,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;KACjD;AACH,CAAC;AARD,0DAQC;AAED,SAAgB,uBAAuB,CAAC,IAAoB,EAAE,KAAK,GAAG,IAAI;IACxE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE;QAC/B,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC9E,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,OAAO,KAAK,cAAc,CAAC;SACxC;aAAM;YACL,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,YAAY,IAAI,EAAE,GAAG,CAAC,CAAC;SACjE;KACF;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;KACjE;AACH,CAAC;AAdD,0DAcC;AAED,SAAgB,aAAa,CAC3B,UAA6B,EAC7B,YAAoC;IAEpC,OAAO;QACL,OAAO,EAAE,cAAc;QACvB,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,IAAI,EAAE,CAAC;KAClD,CAAC;AACJ,CAAC;AARD,sCAQC"}

package/dist/validate/index.d.ts

@@ -1,5 +1,5 @@
 export { validate, ValidationRunData, ContractValidation } from './run';
-export { ValidationOptions, withValidationDefaults } from './overrides';
+export { ProxyKindOption, StandaloneValidationOptions, ValidationOptions, withValidationDefaults } from './overrides';
 export { ValidationErrors } from './error';
 export { RunValidation, ValidationLog, Validation, ValidationResult } from './compat';
 export { ValidationData, ValidationDataCurrent, isCurrentValidationData, concatRunData } from './data';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validate/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvG,OAAO,EACL,kBAAkB,EAClB,+BAA+B,EAC/B,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,SAAS,EACT,aAAa,EACb,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAG1D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validate/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACtH,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvG,OAAO,EACL,kBAAkB,EAClB,+BAA+B,EAC/B,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,SAAS,EACT,aAAa,EACb,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAG1D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC"}

package/dist/validate/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/validate/index.ts"],"names":[],"mappings":";;;AAAA,6BAAwE;AAA/D,+FAAA,QAAQ,OAAA;AACjB,yCAAwE;AAA5C,mHAAA,sBAAsB,OAAA;AAClD,iCAA2C;AAAlC,yGAAA,gBAAgB,OAAA;AAEzB,+BAAuG;AAAvD,+GAAA,uBAAuB,OAAA;AAAE,qGAAA,aAAa,OAAA;AACtF,iCASiB;AARf,2GAAA,kBAAkB,OAAA;AAClB,wHAAA,+BAA+B,OAAA;AAC/B,yGAAA,gBAAgB,OAAA;AAChB,0GAAA,iBAAiB,OAAA;AACjB,4GAAA,mBAAmB,OAAA;AACnB,kGAAA,SAAS,OAAA;AACT,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AAEhB,mCAA0D;AAAjD,wHAAA,8BAA8B,OAAA;AAEvC,0BAA0B;AAC1B,oCAA+C;AAAtC,sGAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/validate/index.ts"],"names":[],"mappings":";;;AAAA,6BAAwE;AAA/D,+FAAA,QAAQ,OAAA;AACjB,yCAAsH;AAA5C,mHAAA,sBAAsB,OAAA;AAChG,iCAA2C;AAAlC,yGAAA,gBAAgB,OAAA;AAEzB,+BAAuG;AAAvD,+GAAA,uBAAuB,OAAA;AAAE,qGAAA,aAAa,OAAA;AACtF,iCASiB;AARf,2GAAA,kBAAkB,OAAA;AAClB,wHAAA,+BAA+B,OAAA;AAC/B,yGAAA,gBAAgB,OAAA;AAChB,0GAAA,iBAAiB,OAAA;AACjB,4GAAA,mBAAmB,OAAA;AACnB,kGAAA,SAAS,OAAA;AACT,sGAAA,aAAa,OAAA;AACb,uGAAA,cAAc,OAAA;AAEhB,mCAA0D;AAAjD,wHAAA,8BAA8B,OAAA;AAEvC,0BAA0B;AAC1B,oCAA+C;AAAtC,sGAAA,eAAe,OAAA"}

package/dist/validate/overrides.d.ts

@@ -1,13 +1,44 @@
 import { ValidationError } from './run';
 import { ProxyDeployment } from '../manifest';
 export { silenceWarnings } from '../utils/log';
-export interface ValidationOptions {
+/**
+ * Option for the kind of proxy that will be used.
+ */
+export interface ProxyKindOption {
+    /**
+     * The kind of proxy to deploy, upgrade or import, or the kind of proxy that the implementation will be used with. Defaults to `"transparent"`.
+     */
+    kind?: ProxyDeployment['kind'];
+}
+/**
+ * Validation options in a standalone context (without storage layout comparisons with a previous implementation).
+ */
+export interface StandaloneValidationOptions extends ProxyKindOption {
+    /**
+     * @deprecated Equivalent to including "struct-definition" and "enum-definition" in unsafeAllow. No longer necessary.
+     */
     unsafeAllowCustomTypes?: boolean;
+    /**
+     * @deprecated Equivalent to including `"external-library-linking"` in {@link unsafeAllow}.
+     */
     unsafeAllowLinkedLibraries?: boolean;
+    /**
+     * Selectively disable one or more validation errors.
+     */
+    unsafeAllow?: ValidationError['kind'][];
+}
+/**
+ * Validation options in the context of an upgrade (with storage layout comparisions with a previous implementation).
+ */
+export interface ValidationOptions extends StandaloneValidationOptions {
+    /**
+     * Configure storage layout check to allow variable renaming.
+     */
     unsafeAllowRenames?: boolean;
+    /**
+     * Upgrades the proxy or beacon without first checking for storage layout compatibility errors. This is a dangerous option meant to be used as a last resort.
+     */
     unsafeSkipStorageCheck?: boolean;
-    unsafeAllow?: ValidationError['kind'][];
-    kind?: ProxyDeployment['kind'];
 }
 export declare const ValidationErrorUnsafeMessages: Record<ValidationError['kind'], string[]>;
 export declare function withValidationDefaults(opts: ValidationOptions): Required<ValidationOptions>;

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

@@ -1 +1 @@
-{"version":3,"file":"overrides.d.ts","sourceRoot":"","sources":["../../src/validate/overrides.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI9C,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,WAAW,iBAAiB;IAChC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;IACxC,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,eAAO,MAAM,6BAA6B,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CA0BnF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CA2B3F;AAED,wBAAgB,iBAAiB,CAC/B,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,eAAe,EAAE,EACzB,IAAI,EAAE,iBAAiB,GACtB,eAAe,EAAE,CAwBnB"}
+{"version":3,"file":"overrides.d.ts","sourceRoot":"","sources":["../../src/validate/overrides.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI9C,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,eAAe;IAClE;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,2BAA2B;IACpE;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,eAAO,MAAM,6BAA6B,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CA0BnF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CA2B3F;AAED,wBAAgB,iBAAiB,CAC/B,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,eAAe,EAAE,EACzB,IAAI,EAAE,iBAAiB,GACtB,eAAe,EAAE,CAwBnB"}

package/dist/validate/overrides.js.map

@@ -1 +1 @@
-{"version":3,"file":"overrides.js","sourceRoot":"","sources":["../../src/validate/overrides.ts"],"names":[],"mappings":";;;AAEA,sCAA0C;AAE1C,0BAA0B;AAC1B,oCAA+C;AAAtC,sGAAA,eAAe,OAAA;AAWX,QAAA,6BAA6B,GAA8C;IACtF,2BAA2B,EAAE;QAC3B,mEAAmE;QACnE,mEAAmE;KACpE;IACD,0BAA0B,EAAE,CAAC,kEAAkE,CAAC;IAChG,0BAA0B,EAAE;QAC1B,gGAAgG;QAChG,iFAAiF;KAClF;IACD,mBAAmB,EAAE;QACnB,8FAA8F;QAC9F,+EAA+E;KAChF;IACD,iBAAiB,EAAE;QACjB,0FAA0F;QAC1F,+EAA+E;KAChF;IACD,WAAW,EAAE,CAAC,qDAAqD,CAAC;IACpE,YAAY,EAAE,CAAC,sDAAsD,CAAC;IACtE,YAAY,EAAE,CAAC,sDAAsD,CAAC;IACtE,0BAA0B,EAAE;QAC1B,kFAAkF;QAClF,yFAAyF;QACzF,gFAAgF;KACjF;CACF,CAAC;AAEF,SAAgB,sBAAsB,CAAC,IAAuB;IAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;IAC3C,MAAM,sBAAsB,GAC1B,IAAI,CAAC,sBAAsB;QAC3B,CAAC,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACzF,MAAM,0BAA0B,GAC9B,IAAI,CAAC,0BAA0B,IAAI,WAAW,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IAEtF,IAAI,sBAAsB,EAAE;QAC1B,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;KAC1D;IACD,IAAI,0BAA0B,EAAE;QAC9B,WAAW,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;KAC9C;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,aAAa,CAAC;IAExC,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC;IAC5D,MAAM,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,IAAI,KAAK,CAAC;IAEpE,OAAO;QACL,sBAAsB;QACtB,0BAA0B;QAC1B,kBAAkB;QAClB,sBAAsB;QACtB,WAAW;QACX,IAAI;KACL,CAAC;AACJ,CAAC;AA3BD,wDA2BC;AAED,SAAgB,iBAAiB,CAC/B,YAAoB,EACpB,MAAyB,EACzB,IAAuB;IAEvB,MAAM,EAAE,WAAW,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,IAAI,KAAK,aAAa,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;QACzD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,0BAA0B,CAAC,CAAC;KAC5E;IAED,KAAK,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qCAA6B,CAAC,EAAE;QACzF,IAAI,WAAW,CAAC,QAAQ,CAAC,SAAoC,CAAC,EAAE;YAC9D,IAAI,eAAe,GAAG,KAAK,CAAC;YAE5B,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;gBAC7B,MAAM,WAAW,GAAG,SAAS,KAAK,KAAK,CAAC,IAAI,CAAC;gBAC7C,eAAe,GAAG,eAAe,IAAI,WAAW,CAAC;gBACjD,OAAO,CAAC,WAAW,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,IAAI,eAAe,IAAI,gBAAgB,EAAE;gBACvC,IAAA,gBAAU,EAAC,oCAAoC,YAAY,EAAE,EAAE,gBAAgB,CAAC,CAAC;aAClF;SACF;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA5BD,8CA4BC"}
+{"version":3,"file":"overrides.js","sourceRoot":"","sources":["../../src/validate/overrides.ts"],"names":[],"mappings":";;;AAEA,sCAA0C;AAE1C,0BAA0B;AAC1B,oCAA+C;AAAtC,sGAAA,eAAe,OAAA;AA+CX,QAAA,6BAA6B,GAA8C;IACtF,2BAA2B,EAAE;QAC3B,mEAAmE;QACnE,mEAAmE;KACpE;IACD,0BAA0B,EAAE,CAAC,kEAAkE,CAAC;IAChG,0BAA0B,EAAE;QAC1B,gGAAgG;QAChG,iFAAiF;KAClF;IACD,mBAAmB,EAAE;QACnB,8FAA8F;QAC9F,+EAA+E;KAChF;IACD,iBAAiB,EAAE;QACjB,0FAA0F;QAC1F,+EAA+E;KAChF;IACD,WAAW,EAAE,CAAC,qDAAqD,CAAC;IACpE,YAAY,EAAE,CAAC,sDAAsD,CAAC;IACtE,YAAY,EAAE,CAAC,sDAAsD,CAAC;IACtE,0BAA0B,EAAE;QAC1B,kFAAkF;QAClF,yFAAyF;QACzF,gFAAgF;KACjF;CACF,CAAC;AAEF,SAAgB,sBAAsB,CAAC,IAAuB;IAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;IAC3C,MAAM,sBAAsB,GAC1B,IAAI,CAAC,sBAAsB;QAC3B,CAAC,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACzF,MAAM,0BAA0B,GAC9B,IAAI,CAAC,0BAA0B,IAAI,WAAW,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IAEtF,IAAI,sBAAsB,EAAE;QAC1B,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;KAC1D;IACD,IAAI,0BAA0B,EAAE;QAC9B,WAAW,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;KAC9C;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,aAAa,CAAC;IAExC,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC;IAC5D,MAAM,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,IAAI,KAAK,CAAC;IAEpE,OAAO;QACL,sBAAsB;QACtB,0BAA0B;QAC1B,kBAAkB;QAClB,sBAAsB;QACtB,WAAW;QACX,IAAI;KACL,CAAC;AACJ,CAAC;AA3BD,wDA2BC;AAED,SAAgB,iBAAiB,CAC/B,YAAoB,EACpB,MAAyB,EACzB,IAAuB;IAEvB,MAAM,EAAE,WAAW,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,IAAI,KAAK,aAAa,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;QACzD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,0BAA0B,CAAC,CAAC;KAC5E;IAED,KAAK,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qCAA6B,CAAC,EAAE;QACzF,IAAI,WAAW,CAAC,QAAQ,CAAC,SAAoC,CAAC,EAAE;YAC9D,IAAI,eAAe,GAAG,KAAK,CAAC;YAE5B,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;gBAC7B,MAAM,WAAW,GAAG,SAAS,KAAK,KAAK,CAAC,IAAI,CAAC;gBAC7C,eAAe,GAAG,eAAe,IAAI,WAAW,CAAC;gBACjD,OAAO,CAAC,WAAW,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,IAAI,eAAe,IAAI,gBAAgB,EAAE;gBACvC,IAAA,gBAAU,EAAC,oCAAoC,YAAY,EAAE,EAAE,gBAAgB,CAAC,CAAC;aAClF;SACF;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA5BD,8CA4BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.17.0",
+  "version": "1.19.1",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -16,7 +16,7 @@
     "/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/ProxyAdmin.sol/ProxyAdmin.json",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json",
     "/artifacts/build-info.json"
   ],
@@ -52,11 +52,11 @@
   "dependencies": {
     "cbor": "^8.0.0",
     "chalk": "^4.1.0",
-    "compare-versions": "^4.0.0",
+    "compare-versions": "^5.0.0",
     "debug": "^4.1.1",
     "ethereumjs-util": "^7.0.3",
     "proper-lockfile": "^4.1.1",
     "solidity-ast": "^0.4.15"
   },
-  "gitHead": "3cf6771e63c6db6212eda75b9ba7a29ca4f2c15a"
+  "gitHead": "4046edb571e48c46838a4d9b927fc21254757b3e"
 }

package/src/index.ts

@@ -50,5 +50,7 @@ export {
   DeployBeaconProxyImplUnknownError,
   DeployBeaconProxyKindError,
   ForceImportUnsupportedError,
+  NoContractImportError,
+  ValidateUpdateRequiresKindError,
   assertNotProxy,
 } from './usage-error';

package/src/levenshtein.ts

@@ -10,7 +10,9 @@ export type BasicOperation<T> =
 
 export type Operation<T, C> = C | BasicOperation<T>;
 
-type GetChangeOp<T, C> = (a: T, b: T) => C | undefined;
+export type Cost = { cost?: number };
+
+type GetChangeOp<T, C> = (a: T, b: T) => (C & Cost) | undefined;
 
 export function levenshtein<T, C>(a: T[], b: T[], getChangeOp: GetChangeOp<T, C>): Operation<T, C>[] {
   const matrix = buildMatrix(a, b, getChangeOp);
@@ -76,7 +78,7 @@ function buildMatrix<T, C>(a: T[], b: T[], getChangeOp: GetChangeOp<T, C>): Matr
     const predCost = predecessor.totalCost;
     const change = getChangeOp(original, updated);
     if (change !== undefined) {
-      return { kind: 'change', totalCost: predCost + CHANGE_COST, predecessor, change };
+      return { kind: 'change', totalCost: predCost + (change.cost ?? CHANGE_COST), predecessor, change };
     } else {
       return { kind: 'nop', totalCost: predCost, predecessor };
     }

package/src/provider.ts

@@ -104,6 +104,8 @@ export const networkNames: { [chainId in number]?: string } = Object.freeze({
   42: 'kovan',
   137: 'polygon',
   80001: 'polygon-mumbai',
+  43113: 'avalanche-fuji',
+  43114: 'avalanche',
 });
 
 export async function isDevelopmentNetwork(provider: EthereumProvider): Promise<boolean> {

package/src/storage/compare.ts

@@ -1,10 +1,11 @@
-import { levenshtein, Operation } from '../levenshtein';
+import { Cost, levenshtein, Operation } from '../levenshtein';
 import { hasLayout, ParsedTypeDetailed, isEnumMembers, isStructMembers } from './layout';
 import { UpgradesError } from '../error';
 import { StorageItem as _StorageItem, StructMember as _StructMember, StorageField as _StorageField } from './layout';
 import { LayoutCompatibilityReport } from './report';
 import { assert } from '../utils/assert';
 import { isValueType } from '../utils/is-value-type';
+import { endMatchesGap, isGap } from './gap';
 
 export type StorageItem = _StorageItem<ParsedTypeDetailed>;
 type StructMember = _StructMember<ParsedTypeDetailed>;
@@ -15,13 +16,14 @@ export type StorageOperation<F extends StorageField> = Operation<F, StorageField
 export type EnumOperation = Operation<string, { kind: 'replace'; original: string; updated: string }>;
 
 type StorageFieldChange<F extends StorageField> = (
-  | { kind: 'replace' | 'rename' }
+  | { kind: 'replace' | 'rename' | 'finishgap' }
   | { kind: 'typechange'; change: TypeChange }
   | { kind: 'layoutchange'; change: LayoutChange }
+  | { kind: 'shrinkgap'; change: TypeChange }
 ) & {
   original: F;
   updated: F;
-};
+} & Cost;
 
 export type TypeChange = (
   | {
@@ -55,11 +57,45 @@ export type TypeChange = (
 
 export interface LayoutChange {
   uncertain?: boolean;
+  knownCompatible?: boolean;
   slot?: Record<'from' | 'to', string>;
   offset?: Record<'from' | 'to', number>;
   bytes?: Record<'from' | 'to', string>;
 }
 
+/**
+ * Gets the storage field's begin position as the number of bytes from 0.
+ *
+ * @param field the storage field
+ * @returns the begin position, or undefined if the slot or offset is undefined
+ */
+export function storageFieldBegin(field: StorageField): bigint | undefined {
+  if (field.slot === undefined || field.offset === undefined) {
+    return undefined;
+  }
+  return BigInt(field.slot) * 32n + BigInt(field.offset);
+}
+
+/**
+ * Gets the storage field's end position as the number of bytes from 0.
+ *
+ * @param field the storage field
+ * @returns the end position, or undefined if the slot or offset or number of bytes is undefined
+ */
+export function storageFieldEnd(field: StorageField): bigint | undefined {
+  const begin = storageFieldBegin(field);
+  const numberOfBytes = field.type.item.numberOfBytes;
+  if (begin === undefined || numberOfBytes === undefined) {
+    return undefined;
+  }
+  return begin + BigInt(numberOfBytes);
+}
+
+const LAYOUTCHANGE_COST = 0;
+const FINISHGAP_COST = 1;
+const SHRINKGAP_COST = 0;
+const TYPECHANGE_COST = 0;
+
 export class StorageLayoutComparator {
   hasAllowedUncheckedCustomTypes = false;
 
@@ -80,10 +116,39 @@ export class StorageLayoutComparator {
   ): StorageOperation<F>[] {
     const ops = levenshtein(original, updated, (a, b) => this.getFieldChange(a, b));
 
-    if (allowAppend) {
-      return ops.filter(o => o.kind !== 'append');
-    } else {
-      return ops;
+    // filter operations: the callback function returns true if operation is unsafe, false if safe
+    return ops.filter(o => {
+      if (o.kind === 'insert') {
+        const updatedStart = storageFieldBegin(o.updated);
+        const updatedEnd = storageFieldEnd(o.updated);
+        // If we cannot get the updated position, or if any entry in the original layout (that is not a gap) overlaps, then the insertion is unsafe.
+        return (
+          updatedStart === undefined ||
+          updatedEnd === undefined ||
+          original
+            .filter(entry => !isGap(entry))
+            .some(entry => {
+              const origStart = storageFieldBegin(entry);
+              const origEnd = storageFieldEnd(entry);
+              return (
+                origStart === undefined ||
+                origEnd === undefined ||
+                overlaps(origStart, origEnd, updatedStart, updatedEnd)
+              );
+            })
+        );
+      } else if ((o.kind === 'shrinkgap' || o.kind === 'finishgap') && endMatchesGap(o.original, o.updated)) {
+        // Gap shrink or gap replacement that finishes on the same slot is safe
+        return false;
+      } else if (o.kind === 'append' && allowAppend) {
+        return false;
+      }
+      return true;
+    });
+
+    // https://stackoverflow.com/questions/325933/determine-whether-two-date-ranges-overlap
+    function overlaps(startA: bigint, endA: bigint, startB: bigint, endB: bigint) {
+      return startA < endB && startB < endA;
     }
   }
 
@@ -107,28 +172,29 @@ export class StorageLayoutComparator {
     const typeChange = !retypedFromOriginal && this.getTypeChange(original.type, updated.type, { allowAppend: false });
     const layoutChange = this.getLayoutChange(original, updated);
 
-    if (updated.retypedFrom && layoutChange) {
-      return { kind: 'layoutchange', original, updated, change: layoutChange };
+    if (updated.retypedFrom && layoutChange && (!layoutChange.uncertain || !layoutChange.knownCompatible)) {
+      return { kind: 'layoutchange', original, updated, change: layoutChange, cost: LAYOUTCHANGE_COST };
+    } else if (nameChange && endMatchesGap(original, updated)) {
+      // original is a gap that was consumed by a non-gap ending at the same slot, which is safe
+      return { kind: 'finishgap', original, updated, cost: FINISHGAP_COST };
+    } else if (typeChange && typeChange.kind === 'array shrink' && endMatchesGap(original, updated)) {
+      // original and updated are a gap that was shrunk and ends at the same slot, which is safe
+      return { kind: 'shrinkgap', change: typeChange, original, updated, cost: SHRINKGAP_COST };
     } else if (typeChange && nameChange) {
       return { kind: 'replace', original, updated };
     } else if (nameChange) {
       return { kind: 'rename', original, updated };
     } else if (typeChange) {
-      return { kind: 'typechange', change: typeChange, original, updated };
+      return { kind: 'typechange', change: typeChange, original, updated, cost: TYPECHANGE_COST };
     } else if (layoutChange && !layoutChange.uncertain) {
       // Any layout change should be caught earlier as a type change, but we
       // add this check as a safety fallback.
-      return { kind: 'layoutchange', original, updated, change: layoutChange };
+      return { kind: 'layoutchange', original, updated, change: layoutChange, cost: LAYOUTCHANGE_COST };
     }
   }
 
   getLayoutChange(original: StorageField, updated: StorageField): LayoutChange | undefined {
-    const validPair = ['uint8', 'bool'];
-    const knownCompatibleTypes =
-      validPair.includes(original.type.item.label) && validPair.includes(updated.type.item.label);
-    if (original.type.item.label == updated.type.item.label || knownCompatibleTypes) {
-      return undefined;
-    } else if (hasLayout(original) && hasLayout(updated)) {
+    if (hasLayout(original) && hasLayout(updated)) {
       const change = <T>(from: T, to: T) => (from === to ? undefined : { from, to });
       const slot = change(original.slot, updated.slot);
       const offset = change(original.offset, updated.offset);
@@ -137,7 +203,11 @@ export class StorageLayoutComparator {
         return { slot, offset, bytes };
       }
     } else {
-      return { uncertain: true };
+      const validChanges = [['uint8', 'bool']];
+      const knownCompatible = validChanges.some(
+        group => group.includes(original.type.item.label) && group.includes(updated.type.item.label),
+      );
+      return { uncertain: true, knownCompatible };
     }
   }
 

package/src/storage/gap.ts

@@ -0,0 +1,26 @@
+import { StorageField, storageFieldEnd } from './compare';
+
+/**
+ * Returns true if the field represents a storage gap.
+ *
+ * @param field the storage field
+ * @returns true if field is a gap, otherwise false
+ */
+export function isGap(field: StorageField): boolean {
+  return field.label === '__gap' && field.type.head === 't_array';
+}
+
+/**
+ * Returns true if original storage field is a gap and the updated storage field
+ * ends at the exact same position as the gap.
+ *
+ * @param original the original storage field
+ * @param updated the updated storage field
+ * @returns true if original is a gap and original and updated end at the same position, otherwise false
+ */
+export function endMatchesGap(original: StorageField, updated: StorageField) {
+  const originalEnd = storageFieldEnd(original);
+  const updatedEnd = storageFieldEnd(updated);
+
+  return isGap(original) && originalEnd !== undefined && updatedEnd !== undefined && originalEnd === updatedEnd;
+}

package/src/storage/report-gap.test.ts

@@ -0,0 +1,119 @@
+import _test, { TestFn } from 'ava';
+import { ContractDefinition } from 'solidity-ast';
+import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { artifacts } from 'hardhat';
+import { astDereferencer } from '../ast-dereferencer';
+import { extractStorageLayout } from './extract';
+import { StorageLayoutComparator } from './compare';
+import { StorageLayout, getDetailedLayout } from './layout';
+
+interface Context {
+  extractStorageLayout: (contract: string) => ReturnType<typeof extractStorageLayout>;
+}
+
+const test = _test as TestFn<Context>;
+
+const dummyDecodeSrc = () => 'file.sol:1';
+const testContracts = [
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V1',
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Ok',
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Bad1',
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Bad2',
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Bad3',
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Bad4',
+  'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Bad5',
+  'contracts/test/Storage.sol:StorageUpgrade_MultiConsumeGap_V1',
+  'contracts/test/Storage.sol:StorageUpgrade_MultiConsumeGap_V2_Ok',
+];
+
+test.before(async t => {
+  const contracts: Record<string, ContractDefinition> = {};
+  const deref: Record<string, ASTDereferencer> = {};
+  const storageLayout: Record<string, StorageLayout> = {};
+  for (const contract of testContracts) {
+    const buildInfo = await artifacts.getBuildInfo(contract);
+    if (buildInfo === undefined) {
+      throw new Error(`Build info not found for contract ${contract}`);
+    }
+    const solcOutput = buildInfo.output;
+    for (const def of findAll('ContractDefinition', solcOutput.sources['contracts/test/Storage.sol'].ast)) {
+      contracts[def.name] = def;
+      deref[def.name] = astDereferencer(solcOutput);
+      storageLayout[def.name] = (solcOutput.contracts['contracts/test/Storage.sol'][def.name] as any).storageLayout;
+    }
+  }
+
+  t.context.extractStorageLayout = name =>
+    extractStorageLayout(contracts[name], dummyDecodeSrc, deref[name], storageLayout[name]);
+});
+
+function getReport(original: StorageLayout, updated: StorageLayout) {
+  const originalDetailed = getDetailedLayout(original);
+  const updatedDetailed = getDetailedLayout(updated);
+  const comparator = new StorageLayoutComparator();
+  return comparator.compareLayouts(originalDetailed, updatedDetailed);
+}
+
+test('shrinkgap', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Gap_V2_Ok');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.is(report.explain(), '');
+});
+
+test('finishgap', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_MultiConsumeGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_MultiConsumeGap_V2_Ok');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.is(report.explain(), '');
+});
+
+test('insert var without shrink gap', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Gap_V2_Bad1');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('delete var and expand gap', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Gap_V2_Bad2');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('shrink gap without adding var', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Gap_V2_Bad3');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('insert var and shrink gap too much', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Gap_V2_Bad4');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('insert vars and shrink gap not enough', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Gap_V2_Bad5');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('insert vars without shrink gap (uint128)', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_Uint128Gap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_Uint128Gap_V2_Bad');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});

package/src/storage/report-gap.test.ts.md

@@ -0,0 +1,59 @@
+# Snapshot report for `src/storage/report-gap.test.ts`
+
+The actual snapshot is saved in `report-gap.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## insert var without shrink gap
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`__gap\` (uint256[48] -> uint256[48])␊
+      - Slot changed from 2 to 3␊
+      > Set __gap array to size 47`
+
+## delete var and expand gap
+
+> Snapshot 1
+
+    `StorageUpgrade_Gap_V1: Deleted \`b\`␊
+      > Keep the variable even if unused␊
+    ␊
+    file.sol:1: Upgraded \`__gap\` to an incompatible type␊
+      - Bad storage gap resize from 48 to 49␊
+        Size cannot increase`
+
+## shrink gap without adding var
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`__gap\` to an incompatible type␊
+      - Bad storage gap resize from 48 to 47␊
+        Size decrease must match with corresponding variable inserts␊
+      > Set __gap array to size 48`
+
+## insert var and shrink gap too much
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`__gap\` to an incompatible type␊
+      - Bad storage gap resize from 48 to 46␊
+        Size decrease must match with corresponding variable inserts␊
+      > Set __gap array to size 47`
+
+## insert vars and shrink gap not enough
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`__gap\` to an incompatible type␊
+      - Bad storage gap resize from 48 to 47␊
+        Size decrease must match with corresponding variable inserts␊
+      > Set __gap array to size 46`
+
+## insert vars without shrink gap (uint128)
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`__gap\` (uint128[49] -> uint128[49])␊
+      - Slot changed from 1 to 2␊
+      > Set __gap array to size 48`

package/src/storage/report-rename-retype.test.ts

@@ -6,6 +6,7 @@ import { astDereferencer } from '../ast-dereferencer';
 import { extractStorageLayout } from './extract';
 import { StorageLayoutComparator } from './compare';
 import { StorageLayout, getDetailedLayout } from './layout';
+import { getStorageUpgradeErrors } from '.';
 
 interface Context {
   extractStorageLayout: (contract: string) => ReturnType<typeof extractStorageLayout>;
@@ -25,6 +26,8 @@ const testContracts = [
   'contracts/test/RenamedRetyped.sol:ConfusingRetypeV2',
   'contracts/test/RenamedRetyped.sol:NonHardcodedRetypeV1',
   'contracts/test/RenamedRetyped.sol:NonHardcodedRetypeV2',
+  'contracts/test/RenamedRetyped.sol:LayoutChangeV1',
+  'contracts/test/RenamedRetyped.sol:LayoutChangeV2',
 ];
 
 test.before(async t => {
@@ -104,3 +107,27 @@ test('non-hardcoded retype', t => {
   t.true(report.ok);
   t.snapshot(report.explain());
 });
+
+test('retype with layout change', t => {
+  const v1 = t.context.extractStorageLayout('LayoutChangeV1');
+  const v2 = t.context.extractStorageLayout('LayoutChangeV2');
+
+  // ensure both variables' layout changes appear in the internal errors
+  t.like(getStorageUpgradeErrors(v1, v2), {
+    length: 2,
+    0: {
+      kind: 'layoutchange',
+      original: { label: 'a' },
+      updated: { label: 'a' },
+    },
+    1: {
+      kind: 'layoutchange',
+      original: { label: 'b' },
+      updated: { label: 'b' },
+    },
+  });
+
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});

package/src/storage/report-rename-retype.test.ts.md

@@ -42,3 +42,10 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     ''
+
+## retype with layout change
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`a\` (bool -> uint16)␊
+      - Number of bytes changed from 1 to 2`