@openzeppelin/upgrades-core 1.13.1 → 1.14.0

package/dist/storage/report.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"report.test.js","sourceRoot":"","sources":["../../src/storage/report.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAoC;AAEpC,8CAA6C;AAC7C,qCAAoC;AAGpC,0DAAsD;AACtD,gDAA0D;AAC1D,uCAAoD;AACpD,qCAA4D;AAM5D,MAAM,IAAI,GAAG,aAAwB,CAAC;AAEtC,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC;AAE1C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;IACpB,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,qCAAqC,CAAC,CAAC;IACtF,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IACD,MAAM,UAAU,GAAe,SAAS,CAAC,MAAM,CAAC;IAChD,MAAM,SAAS,GAAuC,EAAE,CAAC;IACzD,KAAK,MAAM,GAAG,IAAI,IAAA,eAAO,EAAC,oBAAoB,EAAE,UAAU,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC,GAAG,CAAC,EAAE;QACrG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;KAC3B;IACD,MAAM,KAAK,GAAG,IAAA,kCAAe,EAAC,UAAU,CAAC,CAAC;IAC1C,CAAC,CAAC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,IAAA,8BAAoB,EAAC,SAAS,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;AACxG,CAAC,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,QAAuB,EAAE,OAAsB;IAChE,MAAM,gBAAgB,GAAG,IAAA,0BAAiB,EAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,iCAAuB,EAAE,CAAC;IACjD,OAAO,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;AACtE,CAAC;AAED,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE;IAClB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACtE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,8BAA8B,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;IAChB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;IACpE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,4BAA4B,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE;IAC3B,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;IAC/E,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,uCAAuC,CAAC,CAAC;IACnF,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;IAChB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;IACrE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,6BAA6B,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE;IAClB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,+BAA+B,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE;IAC3B,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,kCAAkC,CAAC,CAAC;IAC9E,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,sCAAsC,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE;IACjB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACtE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACtE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE;IAClB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC"}
+{"version":3,"file":"report.test.js","sourceRoot":"","sources":["../../src/storage/report.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAoC;AAEpC,8CAA6C;AAC7C,qCAAoC;AAGpC,0DAAsD;AACtD,gDAA0D;AAC1D,uCAAoD;AACpD,qCAA4D;AAM5D,MAAM,IAAI,GAAG,aAAwB,CAAC;AAEtC,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC;AAE1C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;IACpB,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,qCAAqC,CAAC,CAAC;IACtF,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IACD,MAAM,UAAU,GAAe,SAAS,CAAC,MAAM,CAAC;IAChD,MAAM,SAAS,GAAuC,EAAE,CAAC;IACzD,KAAK,MAAM,GAAG,IAAI,IAAA,eAAO,EAAC,oBAAoB,EAAE,UAAU,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC,GAAG,CAAC,EAAE;QACrG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;KAC3B;IACD,MAAM,KAAK,GAAG,IAAA,kCAAe,EAAC,UAAU,CAAC,CAAC;IAC1C,CAAC,CAAC,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,IAAA,8BAAoB,EAAC,SAAS,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;AACxG,CAAC,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,QAAuB,EAAE,OAAsB;IAChE,MAAM,gBAAgB,GAAG,IAAA,0BAAiB,EAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,eAAe,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,iCAAuB,EAAE,CAAC;IACjD,OAAO,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;AACtE,CAAC;AAED,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE;IAClB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACtE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,8BAA8B,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;IAChB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;IACpE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,4BAA4B,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE;IAC3B,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;IAC/E,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,uCAAuC,CAAC,CAAC;IACnF,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,4BAA4B,EAAE,CAAC,CAAC,EAAE;IACrC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2CAA2C,CAAC,CAAC;IACvF,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,+CAA+C,CAAC,CAAC;IAC3F,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;IAChB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;IACrE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,6BAA6B,CAAC,CAAC;IACzE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE;IAClB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,+BAA+B,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,EAAE;IAC3B,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,kCAAkC,CAAC,CAAC;IAC9E,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,sCAAsC,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE;IACjB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACtE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACtE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE;IAClB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;IACvE,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC"}

package/dist/storage.test.js

@@ -160,7 +160,7 @@ test('storage upgrade with structs', t => {
             change: {
                 kind: 'struct members',
                 ops: {
-                    length: 1,
+                    length: 2,
                     0: { kind: 'delete' },
                 },
             },

package/dist/utils/execall.d.ts

@@ -0,0 +1,2 @@
+export declare function execall(re: RegExp, text: string): Generator<RegExpExecArray, void, unknown>;
+//# sourceMappingURL=execall.d.ts.map

package/dist/utils/execall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execall.d.ts","sourceRoot":"","sources":["../../src/utils/execall.ts"],"names":[],"mappings":"AAAA,wBAAiB,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,6CAUhD"}

package/dist/utils/execall.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execall = void 0;
+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;
+        }
+    }
+}
+exports.execall = execall;
+//# sourceMappingURL=execall.js.map

package/dist/utils/execall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execall.js","sourceRoot":"","sources":["../../src/utils/execall.ts"],"names":[],"mappings":";;;AAAA,QAAe,CAAC,CAAC,OAAO,CAAC,EAAU,EAAE,IAAY;IAC/C,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;AAVD,0BAUC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.13.1",
+  "version": "1.14.0",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -59,5 +59,5 @@
     "proper-lockfile": "^4.1.1",
     "solidity-ast": "^0.4.15"
   },
-  "gitHead": "986cfff65ecbe4706ff62391ddc22ba31c547eb8"
+  "gitHead": "7bb2763c321c55a02e07e4b2b969f49921c5a048"
 }

package/src/storage/compare.ts

@@ -1,7 +1,7 @@
 import { levenshtein, Operation } from '../levenshtein';
-import { ParsedTypeDetailed, StorageItem as _StorageItem } from './layout';
+import { hasLayout, ParsedTypeDetailed, isEnumMembers, isStructMembers } from './layout';
 import { UpgradesError } from '../error';
-import { StructMember as _StructMember, isEnumMembers, isStructMembers } from './layout';
+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';
@@ -9,7 +9,7 @@ import { isValueType } from '../utils/is-value-type';
 export type StorageItem = _StorageItem<ParsedTypeDetailed>;
 type StructMember = _StructMember<ParsedTypeDetailed>;
 
-export type StorageField = StorageItem | StructMember;
+export type StorageField = _StorageField<ParsedTypeDetailed>;
 export type StorageOperation<F extends StorageField> = Operation<F, StorageFieldChange<F>>;
 
 export type EnumOperation = Operation<string, { kind: 'replace'; original: string; updated: string }>;
@@ -17,6 +17,7 @@ export type EnumOperation = Operation<string, { kind: 'replace'; original: strin
 type StorageFieldChange<F extends StorageField> = (
   | { kind: 'replace' | 'rename' }
   | { kind: 'typechange'; change: TypeChange }
+  | { kind: 'layoutchange'; change: LayoutChange }
 ) & {
   original: F;
   updated: F;
@@ -28,6 +29,7 @@ export type TypeChange = (
         | 'obvious mismatch'
         | 'unknown'
         | 'array grow'
+        | 'visibility change'
         | 'array shrink'
         | 'array dynamic'
         | 'enum resize'
@@ -51,6 +53,13 @@ export type TypeChange = (
   updated: ParsedTypeDetailed;
 };
 
+export interface LayoutChange {
+  uncertain?: boolean;
+  slot?: Record<'from' | 'to', string>;
+  offset?: Record<'from' | 'to', number>;
+  bytes?: Record<'from' | 'to', string>;
+}
+
 export class StorageLayoutComparator {
   hasAllowedUncheckedCustomTypes = false;
 
@@ -78,16 +87,53 @@ export class StorageLayoutComparator {
     }
   }
 
-  getFieldChange<F extends StorageField>(original: F, updated: F): StorageFieldChange<F> | undefined {
-    const nameChange = !this.unsafeAllowRenames && original.label !== updated.label;
-    const typeChange = this.getTypeChange(original.type, updated.type, { allowAppend: false });
+  getVisibilityChange(original: ParsedTypeDetailed, updated: ParsedTypeDetailed): TypeChange | undefined {
+    const re = /^t_function_(internal|external)/;
+    const originalVisibility = original.head.match(re);
+    const updatedVisibility = updated.head.match(re);
+    assert(originalVisibility && updatedVisibility);
+    if (originalVisibility[0] !== updatedVisibility[0]) {
+      return { kind: 'visibility change', original, updated };
+    }
+  }
 
-    if (typeChange && nameChange) {
+  getFieldChange<F extends StorageField>(original: F, updated: F): StorageFieldChange<F> | undefined {
+    const nameChange = !this.unsafeAllowRenames && original.label !== (updated.renamedFrom ?? updated.label);
+    const retypedFromOriginal = original.type.item.label === updated.retypedFrom?.trim();
+    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 };
+    } 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 };
+    } 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 };
+    }
+  }
+
+  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)) {
+      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);
+      const bytes = change(original.type.item.numberOfBytes, updated.type.item.numberOfBytes);
+      if (slot || offset || bytes) {
+        return { slot, offset, bytes };
+      }
+    } else {
+      return { uncertain: true };
     }
   }
 
@@ -97,7 +143,6 @@ export class StorageLayoutComparator {
     { allowAppend }: { allowAppend: boolean },
   ): TypeChange | undefined {
     const key = JSON.stringify({ original: original.id, updated: updated.id, allowAppend });
-
     if (this.cache.has(key)) {
       return this.cache.get(key);
     }
@@ -121,6 +166,10 @@ export class StorageLayoutComparator {
     updated: ParsedTypeDetailed,
     { allowAppend }: { allowAppend: boolean },
   ): TypeChange | undefined {
+    if (updated.head.startsWith('t_function')) {
+      return this.getVisibilityChange(original, updated);
+    }
+
     if (original.head !== updated.head) {
       return { kind: 'obvious mismatch', original, updated };
     }

package/src/storage/extract.ts

@@ -13,6 +13,7 @@ import { SrcDecoder } from '../src-decoder';
 import { ASTDereferencer } from '../ast-dereferencer';
 import { mapValues } from '../utils/map-values';
 import { pick } from '../utils/pick';
+import { execall } from '../utils/execall';
 
 const currentLayoutVersion = '1.1';
 
@@ -31,7 +32,10 @@ export function extractStorageLayout(
     layout.types = mapValues(storageLayout.types, m => {
       return {
         label: m.label,
-        members: m.members?.map(m => (typeof m === 'string' ? m : pick(m, ['label', 'type']))) as TypeItem['members'],
+        members: m.members?.map(m =>
+          typeof m === 'string' ? m : pick(m, ['label', 'type', 'offset', 'slot']),
+        ) as TypeItem['members'],
+        numberOfBytes: m.numberOfBytes,
       };
     });
 
@@ -39,11 +43,12 @@ export function extractStorageLayout(
       const origin = getOriginContract(contractDef, storage.astId, deref);
       assert(origin, `Did not find variable declaration node for '${storage.label}'`);
       const { varDecl, contract } = origin;
+      const { renamedFrom, retypedFrom } = getRetypedRenamed(varDecl);
       // Solc layout doesn't bring members for enums so we get them using the ast method
       loadLayoutType(varDecl, layout, deref);
       const { label, offset, slot, type } = storage;
       const src = decodeSrc(varDecl);
-      layout.storage.push({ label, offset, slot, type, contract, src });
+      layout.storage.push({ label, offset, slot, type, contract, src, retypedFrom, renamedFrom });
       layout.flat = true;
     }
   } else {
@@ -51,12 +56,14 @@ export function extractStorageLayout(
       if (isNodeType('VariableDeclaration', varDecl)) {
         if (!varDecl.constant && varDecl.mutability !== 'immutable') {
           const type = normalizeTypeIdentifier(typeDescriptions(varDecl).typeIdentifier);
-
+          const { renamedFrom, retypedFrom } = getRetypedRenamed(varDecl);
           layout.storage.push({
             contract: contractDef.name,
             label: varDecl.name,
             type,
             src: decodeSrc(varDecl),
+            retypedFrom,
+            renamedFrom,
           });
 
           loadLayoutType(varDecl, layout, deref);
@@ -103,7 +110,6 @@ function getTypeMembers(typeDef: StructDefinition | EnumDefinition): TypeItem['m
 function getOriginContract(contract: ContractDefinition, astId: number | undefined, deref: ASTDereferencer) {
   for (const id of contract.linearizedBaseContracts.reverse()) {
     const parentContract = deref(['ContractDefinition'], id);
-
     const varDecl = parentContract.nodes.find(n => n.id == astId);
     if (varDecl && isNodeType('VariableDeclaration', varDecl)) {
       return { varDecl, contract: parentContract.name };
@@ -141,3 +147,23 @@ function loadLayoutType(varDecl: VariableDeclaration, layout: StorageLayout, der
     }
   }
 }
+
+function getRetypedRenamed(varDecl: VariableDeclaration) {
+  let retypedFrom, renamedFrom;
+  if ('documentation' in varDecl) {
+    const docs = typeof varDecl.documentation === 'string' ? varDecl.documentation : varDecl.documentation?.text ?? '';
+    for (const { groups } of execall(
+      /^\s*(?:@(?<title>\w+)(?::(?<tag>[a-z][a-z-]*))? )?(?<args>(?:(?!^\s@\w+)[^])*)/m,
+      docs,
+    )) {
+      if (groups?.title === 'custom') {
+        if (groups.tag === 'oz-retyped-from') {
+          retypedFrom = groups.args;
+        } else if (groups.tag === 'oz-renamed-from') {
+          renamedFrom = groups.args;
+        }
+      }
+    }
+  }
+  return { retypedFrom, renamedFrom };
+}

package/src/storage/layout.ts

@@ -12,6 +12,8 @@ export interface StorageLayout {
   flat?: boolean;
 }
 
+export type StorageField<Type = string> = StorageItem<Type> | StructMember<Type>;
+
 export interface StorageItem<Type = string> {
   astId?: number;
   contract: string;
@@ -20,11 +22,14 @@ export interface StorageItem<Type = string> {
   src: string;
   offset?: number;
   slot?: string;
+  retypedFrom?: string;
+  renamedFrom?: string;
 }
 
 export interface TypeItem<Type = string> {
   label: string;
   members?: TypeItemMembers<Type>;
+  numberOfBytes?: string;
 }
 
 export type TypeItemMembers<Type = string> = StructMember<Type>[] | EnumMember[];
@@ -32,6 +37,10 @@ export type TypeItemMembers<Type = string> = StructMember<Type>[] | EnumMember[]
 export interface StructMember<Type = string> {
   label: string;
   type: Type;
+  retypedFrom?: string;
+  renamedFrom?: string;
+  offset?: number;
+  slot?: string;
 }
 
 export type EnumMember = string;
@@ -46,7 +55,6 @@ type Replace<T, K extends string, V> = Omit<T, K> & Record<K, V>;
 
 export function getDetailedLayout(layout: StorageLayout): StorageItem<ParsedTypeDetailed>[] {
   const cache: Record<string, ParsedTypeDetailed> = {};
-
   return layout.storage.map(parseWithDetails);
 
   function parseWithDetails<I extends { type: string }>(item: I): Replace<I, 'type', ParsedTypeDetailed> {
@@ -75,7 +83,7 @@ export function getDetailedLayout(layout: StorageLayout): StorageItem<ParsedType
     cache[parsed.id] = detailed;
 
     detailed.args = parsed.args?.map(addDetailsToParsedType);
-    detailed.rets = parsed.args?.map(addDetailsToParsedType);
+    detailed.rets = parsed.rets?.map(addDetailsToParsedType);
     detailed.item.members =
       item?.members && (isStructMembers(item?.members) ? item.members.map(parseWithDetails) : item?.members);
 
@@ -90,3 +98,10 @@ export function isEnumMembers<T>(members: TypeItemMembers<T>): members is EnumMe
 export function isStructMembers<T>(members: TypeItemMembers<T>): members is StructMember<T>[] {
   return members.length === 0 || typeof members[0] === 'object';
 }
+
+export type StorageFieldWithLayout = StorageField<ParsedTypeDetailed> &
+  Required<Pick<StorageField, 'offset' | 'slot'>> & { type: { item: Required<Pick<TypeItem, 'numberOfBytes'>> } };
+
+export function hasLayout(field: StorageField<ParsedTypeDetailed>): field is StorageFieldWithLayout {
+  return field.offset !== undefined && field.slot !== undefined && field.type.item.numberOfBytes !== undefined;
+}

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

@@ -0,0 +1,106 @@
+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/RenamedRetyped.sol:RenameV1',
+  'contracts/test/RenamedRetyped.sol:RenameV2',
+  'contracts/test/RenamedRetyped.sol:RetypeV1',
+  'contracts/test/RenamedRetyped.sol:RetypeV2',
+  'contracts/test/RenamedRetyped.sol:WronglyReportedRetypeV3',
+  'contracts/test/RenamedRetyped.sol:MissmatchingTypeRetypeV4',
+  'contracts/test/RenamedRetyped.sol:ConfusingRetypeV1',
+  'contracts/test/RenamedRetyped.sol:ConfusingRetypeV2',
+  'contracts/test/RenamedRetyped.sol:NonHardcodedRetypeV1',
+  'contracts/test/RenamedRetyped.sol:NonHardcodedRetypeV2',
+];
+
+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/RenamedRetyped.sol'].ast)) {
+      contracts[def.name] = def;
+      deref[def.name] = astDereferencer(solcOutput);
+      storageLayout[def.name] = (
+        solcOutput.contracts['contracts/test/RenamedRetyped.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('succesful rename', t => {
+  const v1 = t.context.extractStorageLayout('RenameV1');
+  const v2 = t.context.extractStorageLayout('RenameV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('succesful retype', t => {
+  const v1 = t.context.extractStorageLayout('RetypeV1');
+  const v2 = t.context.extractStorageLayout('RetypeV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('wrongly reported retype', t => {
+  const v1 = t.context.extractStorageLayout('RetypeV1');
+  const v2 = t.context.extractStorageLayout('WronglyReportedRetypeV3');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('rightly reported retype but incompatible new type', t => {
+  const v1 = t.context.extractStorageLayout('RetypeV1');
+  const v2 = t.context.extractStorageLayout('MissmatchingTypeRetypeV4');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('confusing bad retype', t => {
+  const v1 = t.context.extractStorageLayout('ConfusingRetypeV1');
+  const v2 = t.context.extractStorageLayout('ConfusingRetypeV2');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('non-hardcoded retype', t => {
+  const v1 = t.context.extractStorageLayout('NonHardcodedRetypeV1');
+  const v2 = t.context.extractStorageLayout('NonHardcodedRetypeV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.snapshot(report.explain());
+});

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

@@ -0,0 +1,44 @@
+# Snapshot report for `src/storage/report-rename-retype.test.ts`
+
+The actual snapshot is saved in `report-rename-retype.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## succesful rename
+
+> Snapshot 1
+
+    ''
+
+## succesful retype
+
+> Snapshot 1
+
+    ''
+
+## wrongly reported retype
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`x\` to an incompatible type␊
+      - Bad upgrade from bool to uint8`
+
+## rightly reported retype but incompatible new type
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`x\` (bool -> bytes32)␊
+      - Number of bytes changed from 1 to 32`
+
+## confusing bad retype
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`x\` to an incompatible type␊
+      - Bad upgrade from bool to uint8`
+
+## non-hardcoded retype
+
+> Snapshot 1
+
+    ''

package/src/storage/report.test.ts

@@ -59,6 +59,13 @@ test('obvious mismatch', t => {
   t.snapshot(report.explain());
 });
 
+test('function visibility change', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_FunctionType_Visibility_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_FunctionType_Visibility_V2_Bad');
+  const report = getReport(v1, v2);
+  t.snapshot(report.explain());
+});
+
 test('array', t => {
   const v1 = t.context.extractStorageLayout('StorageUpgrade_Array_V1');
   const v2 = t.context.extractStorageLayout('StorageUpgrade_Array_V2_Bad');

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

@@ -90,6 +90,17 @@ Generated by [AVA](https://avajs.dev).
     file.sol:1: Upgraded \`a1\` to an incompatible type␊
       - Bad upgrade from uint256[] to mapping(uint256 => uint256)`
 
+## function visibility change
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`s1\` to an incompatible type␊
+      - Bad upgrade from struct StorageUpgrade_FunctionType_Visibility_V1.S to struct StorageUpgrade_FunctionType_Visibility_V2_Bad.S␊
+      - In struct StorageUpgrade_FunctionType_Visibility_V2_Bad.S␊
+        - Upgraded \`m\` to an incompatible type␊
+          - Bad upgrade from function () to function () external␊
+            Different visibility`
+
 ## array
 
 > Snapshot 1

package/src/storage/report.ts

@@ -2,7 +2,7 @@ import _chalk from 'chalk';
 
 import type { BasicOperation } from '../levenshtein';
 import type { ParsedTypeDetailed } from './layout';
-import type { StorageOperation, StorageItem, StorageField, TypeChange, EnumOperation } from './compare';
+import type { StorageOperation, StorageItem, StorageField, TypeChange, EnumOperation, LayoutChange } from './compare';
 import { itemize, itemizeWith } from '../utils/itemize';
 import { indent } from '../utils/indent';
 import { assert } from '../utils/assert';
@@ -22,8 +22,12 @@ export class LayoutCompatibilityReport {
     const chalk = new _chalk.Instance({ level: color && _chalk.supportsColor ? _chalk.supportsColor.level : 0 });
     const res = [];
 
-    for (const op of this.ops) {
+    for (const [i, op] of this.ops.entries()) {
       const src = 'updated' in op ? op.updated.src : op.original.contract;
+      // Only print layoutchange if it's the first op, otherwise we assume it will be explained by previous ops.
+      if (op.kind === 'layoutchange' && i !== 0) {
+        continue;
+      }
       res.push(
         chalk.bold(src) + ':' + indent(explainStorageOperation(op, { kind: 'layout', allowAppend: true }), 2, 1),
       );
@@ -52,13 +56,20 @@ function explainStorageOperation(op: StorageOperation<StorageField>, ctx: Storag
           : [];
       return `Upgraded ${label(op.updated)} to an incompatible type\n` + itemize(basic, ...details);
     }
-
     case 'rename':
       return `Renamed ${label(op.original)} to ${label(op.updated)}`;
 
     case 'replace':
       return `Replaced ${label(op.original)} with ${label(op.updated)} of incompatible type`;
 
+    case 'layoutchange': {
+      return (
+        `Layout ${op.change.uncertain ? 'could have changed' : 'changed'} for ${label(op.updated)} ` +
+        `(${op.original.type.item.label} -> ${op.updated.type.item.label})\n` +
+        describeLayoutTransition(op.change)
+      ).trimEnd();
+    }
+
     default: {
       const title = explainBasicOperation(op, t => t.label);
       const hints = [];
@@ -90,6 +101,9 @@ function explainStorageOperation(op: StorageOperation<StorageField>, ctx: Storag
 
 function explainTypeChange(ch: TypeChange): string {
   switch (ch.kind) {
+    case 'visibility change':
+      return `Bad upgrade ${describeTransition(ch.original, ch.updated)}\nDifferent visibility`;
+
     case 'obvious mismatch':
     case 'struct members':
     case 'enum members':
@@ -172,7 +186,16 @@ function explainTypeChangeDetails(ch: TypeChange): string | undefined {
       const { allowAppend } = ch;
       return (
         `In ${ch.updated.item.label}\n` +
-        itemize(...ch.ops.map(op => explainStorageOperation(op, { kind: 'struct', allowAppend })))
+        itemize(
+          ...ch.ops.flatMap((op, i) => {
+            if (op.kind === 'layoutchange' && i !== 0) {
+              // Only print layoutchange if it's the first op, otherwise we assume it will be explained by previous ops.
+              return [];
+            } else {
+              return [explainStorageOperation(op, { kind: 'struct', allowAppend })];
+            }
+          }),
+        )
       );
     }
 
@@ -215,6 +238,18 @@ function describeTransition(original: ParsedTypeDetailed, updated: ParsedTypeDet
   }
 }
 
+function describeLayoutTransition(change: LayoutChange): string {
+  const res = [];
+  for (const k of ['slot', 'offset', 'bytes'] as const) {
+    const ch = change[k];
+    if (ch) {
+      const label = (k === 'bytes' ? 'number of bytes' : k).replace(/^./, c => c.toUpperCase());
+      res.push(`${label} changed from ${ch.from} to ${ch.to}`);
+    }
+  }
+  return itemize(...res);
+}
+
 function label(variable: { label: string }): string {
   return '`' + variable.label + '`';
 }

package/src/storage.test.ts

@@ -179,7 +179,7 @@ test('storage upgrade with structs', t => {
       change: {
         kind: 'struct members',
         ops: {
-          length: 1,
+          length: 2,
           0: { kind: 'delete' },
         },
       },