@openzeppelin/upgrades-core 1.20.4 → 1.20.6

package/dist/validate/data.d.ts

@@ -1,12 +1,12 @@
 import { ValidationRunData } from './run';
-declare type ValidationDataV1 = ValidationRunData;
-declare type ValidationDataV2 = ValidationRunData[];
+type ValidationDataV1 = ValidationRunData;
+type ValidationDataV2 = ValidationRunData[];
 interface ValidationDataV3 {
     version: '3' | '3.1' | '3.2' | '3.3' | '3.4';
     log: ValidationRunData[];
 }
-export declare type ValidationDataCurrent = ValidationDataV3;
-export declare type ValidationData = ValidationDataV1 | ValidationDataV2 | ValidationDataV3;
+export type ValidationDataCurrent = ValidationDataV3;
+export type ValidationData = ValidationDataV1 | ValidationDataV2 | ValidationDataV3;
 export declare function normalizeValidationData(data: ValidationData): ValidationDataCurrent;
 export declare function isCurrentValidationData(data: ValidationData, exact?: boolean): data is ValidationDataCurrent;
 export declare function concatRunData(newRunData: ValidationRunData, previousData?: ValidationDataCurrent): ValidationDataCurrent;

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

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../src/validate/data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,aAAK,gBAAgB,GAAG,iBAAiB,CAAC;AAE1C,aAAK,gBAAgB,GAAG,iBAAiB,EAAE,CAAC;AAK5C,UAAU,gBAAgB;IACxB,OAAO,EAAE,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAC7C,GAAG,EAAE,iBAAiB,EAAE,CAAC;CAC1B;AAED,oBAAY,qBAAqB,GAAG,gBAAgB,CAAC;AAErD,oBAAY,cAAc,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEpF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,qBAAqB,CAQnF;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,UAAO,GAAG,IAAI,IAAI,qBAAqB,CAczG;AAED,wBAAgB,aAAa,CAC3B,UAAU,EAAE,iBAAiB,EAC7B,YAAY,CAAC,EAAE,qBAAqB,GACnC,qBAAqB,CAKvB"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../src/validate/data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,KAAK,gBAAgB,GAAG,iBAAiB,CAAC;AAE1C,KAAK,gBAAgB,GAAG,iBAAiB,EAAE,CAAC;AAK5C,UAAU,gBAAgB;IACxB,OAAO,EAAE,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAC7C,GAAG,EAAE,iBAAiB,EAAE,CAAC;CAC1B;AAED,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAErD,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEpF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,qBAAqB,CAQnF;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,UAAO,GAAG,IAAI,IAAI,qBAAqB,CAczG;AAED,wBAAgB,aAAa,CAC3B,UAAU,EAAE,iBAAiB,EAC7B,YAAY,CAAC,EAAE,qBAAqB,GACnC,qBAAqB,CAKvB"}

package/dist/validate/run.d.ts

@@ -3,7 +3,7 @@ import { SrcDecoder } from '../src-decoder';
 import { Version } from '../version';
 import { LinkReference } from '../link-refs';
 import { StorageLayout } from '../storage/layout';
-export declare type ValidationRunData = Record<string, ContractValidation>;
+export type ValidationRunData = Record<string, ContractValidation>;
 export interface ContractValidation {
     version?: Version;
     src: string;
@@ -16,7 +16,7 @@ export interface ContractValidation {
     solcVersion?: string;
 }
 declare const errorKinds: readonly ["state-variable-assignment", "state-variable-immutable", "external-library-linking", "struct-definition", "enum-definition", "constructor", "delegatecall", "selfdestruct", "missing-public-upgradeto"];
-export declare type ValidationError = ValidationErrorConstructor | ValidationErrorOpcode | ValidationErrorWithName | ValidationErrorUpgradeability;
+export type ValidationError = ValidationErrorConstructor | ValidationErrorOpcode | ValidationErrorWithName | ValidationErrorUpgradeability;
 interface ValidationErrorBase {
     src: string;
     kind: typeof errorKinds[number];

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.20.4",
+  "version": "1.20.6",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -58,5 +58,5 @@
     "proper-lockfile": "^4.1.1",
     "solidity-ast": "^0.4.15"
   },
-  "gitHead": "7f39ba7df93a3d5d9e7ecfe905cd09eb1af82b3f"
+  "gitHead": "56dd6059cc916a95378d9e5893306fbb9020f071"
 }

package/src/storage/compare.ts

@@ -168,8 +168,9 @@ export class StorageLayoutComparator {
       original.label !== updated.renamedFrom &&
       (updated.label !== original.label ||
         (updated.renamedFrom !== undefined && updated.renamedFrom !== original.renamedFrom));
-    const retypedFromOriginal = original.type.item.label === updated.retypedFrom?.trim();
-    const typeChange = !retypedFromOriginal && this.getTypeChange(original.type, updated.type, { allowAppend: false });
+    const typeChange =
+      !this.isRetypedFromOriginal(original, updated) &&
+      this.getTypeChange(original.type, updated.type, { allowAppend: false });
     const layoutChange = this.getLayoutChange(original, updated);
 
     if (updated.retypedFrom && layoutChange && (!layoutChange.uncertain || !layoutChange.knownCompatible)) {
@@ -193,6 +194,13 @@ export class StorageLayoutComparator {
     }
   }
 
+  private isRetypedFromOriginal(original: StorageField, updated: StorageField) {
+    const originalLabel = stripContractSubstrings(original.type.item.label);
+    const updatedLabel = stripContractSubstrings(updated.retypedFrom?.trim());
+
+    return originalLabel === updatedLabel;
+  }
+
   getLayoutChange(original: StorageField, updated: StorageField): LayoutChange | undefined {
     if (hasLayout(original) && hasLayout(updated)) {
       const change = <T>(from: T, to: T) => (from === to ? undefined : { from, to });
@@ -244,7 +252,16 @@ export class StorageLayoutComparator {
       return this.getVisibilityChange(original, updated);
     }
 
-    if (original.head !== updated.head) {
+    if (
+      (original.head === 't_contract' && updated.head === 't_address') ||
+      (original.head === 't_address' && updated.head === 't_contract')
+    ) {
+      // changing contract to address or address to contract
+      // equivalent to just addresses
+      return undefined;
+    }
+
+    if (normalizeMemoryPointer(original.head) !== normalizeMemoryPointer(updated.head)) {
       return { kind: 'obvious mismatch', original, updated };
     }
 
@@ -256,6 +273,7 @@ export class StorageLayoutComparator {
 
     switch (original.head) {
       case 't_contract':
+        // changing contract to contract
         // no storage layout errors can be introduced here since it is just an address
         return undefined;
 
@@ -389,3 +407,17 @@ export class StorageLayoutComparator {
 function enumSize(memberCount: number): number {
   return Math.ceil(Math.log2(Math.max(2, memberCount)) / 8);
 }
+
+export function stripContractSubstrings(label?: string) {
+  if (label !== undefined) {
+    return label.replace(/\b(contract|struct|enum) /g, '');
+  }
+}
+
+/**
+ * Some versions of Solidity use type ids with _memory_ptr suffix while other versions use _memory suffix.
+ * Normalize these for type comparison purposes only.
+ */
+function normalizeMemoryPointer(typeIdentifier: string): string {
+  return typeIdentifier.replace(/_memory_ptr\b/g, '_memory');
+}

package/src/storage/report-retype-from-contract.test.ts

@@ -0,0 +1,169 @@
+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, stripContractSubstrings } from './compare';
+import { StorageLayout, getDetailedLayout } from './layout';
+import { getStorageUpgradeErrors } from '.';
+
+interface Context {
+  extractStorageLayout: (contract: string) => ReturnType<typeof extractStorageLayout>;
+}
+
+const test = _test as TestFn<Context>;
+
+const dummyDecodeSrc = () => 'file.sol:1';
+const testContracts = [
+  'contracts/test/RetypeFromContract.sol:RetypeContractToUint160V1',
+  'contracts/test/RetypeFromContract.sol:RetypeContractToUint160V2',
+  'contracts/test/RetypeFromContract.sol:RetypeUint160ToContractV1',
+  'contracts/test/RetypeFromContract.sol:RetypeUint160ToContractV2',
+  'contracts/test/RetypeFromContract.sol:RetypeContractToUint160MappingV1',
+  'contracts/test/RetypeFromContract.sol:RetypeContractToUint160MappingV2',
+  'contracts/test/RetypeFromContract.sol:RetypeUint160ToContractMappingV1',
+  'contracts/test/RetypeFromContract.sol:RetypeUint160ToContractMappingV2',
+  'contracts/test/RetypeFromContract.sol:ImplicitRetypeV1',
+  'contracts/test/RetypeFromContract.sol:ImplicitRetypeV2',
+  'contracts/test/RetypeFromContract.sol:ImplicitRetypeMappingV1',
+  'contracts/test/RetypeFromContract.sol:ImplicitRetypeMappingV2',
+  'contracts/test/RetypeFromContract.sol:RetypeStructV1',
+  'contracts/test/RetypeFromContract.sol:RetypeStructV2',
+  'contracts/test/RetypeFromContract.sol:RetypeStructV2Bad',
+  'contracts/test/RetypeFromContract.sol:RetypeEnumV1',
+  'contracts/test/RetypeFromContract.sol:RetypeEnumV2',
+  'contracts/test/RetypeFromContract.sol:RetypeEnumV2Bad',
+];
+
+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/RetypeFromContract.sol'].ast)) {
+      contracts[def.name] = def;
+      deref[def.name] = astDereferencer(solcOutput);
+      storageLayout[def.name] = (
+        solcOutput.contracts['contracts/test/RetypeFromContract.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('retype contract to uint160', t => {
+  const v1 = t.context.extractStorageLayout('RetypeContractToUint160V1');
+  const v2 = t.context.extractStorageLayout('RetypeContractToUint160V2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('retype uint160 to contract', t => {
+  const v1 = t.context.extractStorageLayout('RetypeUint160ToContractV1');
+  const v2 = t.context.extractStorageLayout('RetypeUint160ToContractV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('retype contract to uint160 mapping', t => {
+  const v1 = t.context.extractStorageLayout('RetypeContractToUint160MappingV1');
+  const v2 = t.context.extractStorageLayout('RetypeContractToUint160MappingV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('retype uint160 to contract mapping', t => {
+  const v1 = t.context.extractStorageLayout('RetypeUint160ToContractMappingV1');
+  const v2 = t.context.extractStorageLayout('RetypeUint160ToContractMappingV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('implicit retype', t => {
+  const v1 = t.context.extractStorageLayout('ImplicitRetypeV1');
+  const v2 = t.context.extractStorageLayout('ImplicitRetypeV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('implicit retype mapping', t => {
+  const v1 = t.context.extractStorageLayout('ImplicitRetypeMappingV1');
+  const v2 = t.context.extractStorageLayout('ImplicitRetypeMappingV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('strip contract substrings', t => {
+  t.is(stripContractSubstrings(undefined), undefined);
+  t.is(stripContractSubstrings('address'), 'address');
+  t.is(stripContractSubstrings('CustomContract'), 'CustomContract');
+  t.is(stripContractSubstrings('contract CustomContract'), 'CustomContract');
+  t.is(stripContractSubstrings('mapping(uint8 => CustomContract)'), 'mapping(uint8 => CustomContract)');
+  t.is(stripContractSubstrings('mapping(uint8 => contract CustomContract)'), 'mapping(uint8 => CustomContract)');
+  t.is(stripContractSubstrings('mapping(contract CustomContract => uint8)'), 'mapping(CustomContract => uint8)');
+  t.is(stripContractSubstrings('mapping(contract A => contract B)'), 'mapping(A => B)');
+  t.is(stripContractSubstrings('mapping(Substringcontract => address)'), 'mapping(Substringcontract => address)');
+  t.is(
+    stripContractSubstrings('mapping(contract Substringcontract => address)'),
+    'mapping(Substringcontract => address)',
+  );
+  t.is(stripContractSubstrings('Mystruct'), 'Mystruct');
+  t.is(stripContractSubstrings('struct Mystruct'), 'Mystruct');
+  t.is(stripContractSubstrings('Myenum'), 'Myenum');
+  t.is(stripContractSubstrings('enum Myenum'), 'Myenum');
+});
+
+test('retype from struct', t => {
+  const v1 = t.context.extractStorageLayout('RetypeStructV1');
+  const v2 = t.context.extractStorageLayout('RetypeStructV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('bad retype from struct', t => {
+  const v1 = t.context.extractStorageLayout('RetypeStructV1');
+  const v2 = t.context.extractStorageLayout('RetypeStructV2Bad');
+  t.like(getStorageUpgradeErrors(v1, v2), {
+    length: 1,
+    0: {
+      kind: 'layoutchange',
+      original: { label: 'x' },
+      updated: { label: 'x' },
+    },
+  });
+});
+
+test('retype from enum', t => {
+  const v1 = t.context.extractStorageLayout('RetypeEnumV1');
+  const v2 = t.context.extractStorageLayout('RetypeEnumV2');
+  const report = getReport(v1, v2);
+  t.true(report.ok, report.explain());
+});
+
+test('bad retype from enum', t => {
+  const v1 = t.context.extractStorageLayout('RetypeEnumV1');
+  const v2 = t.context.extractStorageLayout('RetypeEnumV2Bad');
+  t.like(getStorageUpgradeErrors(v1, v2), {
+    length: 1,
+    0: {
+      kind: 'layoutchange',
+      original: { label: 'x' },
+      updated: { label: 'x' },
+    },
+  });
+});

package/src/storage/report.ts

@@ -73,12 +73,10 @@ function getExpectedGapSize(original: StorageField, updated: StorageField) {
   return expectedSizeBytes / bytesPerItem;
 }
 
-function suggestGapSize(original: StorageField, updated: StorageField): string {
+function suggestGapSize(original: StorageField, updated: StorageField): string | undefined {
   const expectedSize = getExpectedGapSize(original, updated);
   if (expectedSize !== undefined) {
     return `Set __gap array to size ${expectedSize}`;
-  } else {
-    return '';
   }
 }
 
@@ -97,7 +95,10 @@ function explainStorageOperation(op: StorageOperation<StorageField>, ctx: Storag
           : [];
       const hints = [];
       if (isGap(op.original) && op.change.kind === 'array shrink') {
-        hints.push(suggestGapSize(op.original, op.updated));
+        const suggestion = suggestGapSize(op.original, op.updated);
+        if (suggestion) {
+          hints.push(suggestion);
+        }
       }
       return printWithHints({
         title: `Upgraded ${label(op.updated)} to an incompatible type\n` + itemize(basic, ...details),
@@ -122,7 +123,10 @@ function explainStorageOperation(op: StorageOperation<StorageField>, ctx: Storag
       const hints = [];
 
       if (isGap(op.original)) {
-        hints.push(suggestGapSize(op.original, op.updated));
+        const suggestion = suggestGapSize(op.original, op.updated);
+        if (suggestion) {
+          hints.push(suggestion);
+        }
       }
 
       return printWithHints({ title, hints });

package/src/storage-memory-0.5.test.ts

@@ -0,0 +1,89 @@
+import _test, { TestFn } from 'ava';
+import { findAll } from 'solidity-ast/utils';
+import { artifacts } from 'hardhat';
+
+import { SolcOutput } from './solc-api';
+import { astDereferencer } from './ast-dereferencer';
+import { getStorageUpgradeErrors } from './storage';
+import { extractStorageLayout } from './storage/extract';
+import { BuildInfo } from 'hardhat/types';
+import { stabilizeStorageLayout } from './utils/stabilize-layout';
+
+interface Context {
+  extractStorageLayout: (
+    contract: string,
+    contractName?: string,
+    withLayout?: boolean,
+  ) => Promise<ReturnType<typeof extractStorageLayout>>;
+}
+
+const test = _test as TestFn<Context>;
+
+test.before(async t => {
+  const buildInfoCache: Record<string, BuildInfo | undefined> = {};
+  t.context.extractStorageLayout = async (contractFile, contractName, withLayout = true) => {
+    const expectedContract = contractName ?? contractFile;
+
+    const [file] = contractFile.split('_');
+    const source = `contracts/test/${file}.sol`;
+    const buildInfo = (buildInfoCache[source] ??= await artifacts.getBuildInfo(`${source}:${expectedContract}`));
+    if (buildInfo === undefined) {
+      throw new Error(`Build info for ${source} not found`);
+    }
+    const solcOutput: SolcOutput = buildInfo.output;
+    for (const def of findAll('ContractDefinition', solcOutput.sources[source].ast)) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const layout = solcOutput.contracts[source][def.name].storageLayout!;
+      if (def.name === expectedContract) {
+        return extractStorageLayout(def, dummyDecodeSrc, astDereferencer(solcOutput), withLayout ? layout : undefined);
+      }
+    }
+    throw new Error(`Contract ${expectedContract} not found in ${source}`);
+  };
+});
+
+const dummyDecodeSrc = () => 'file.sol:1';
+
+test('memory 0.5.16', async t => {
+  const layout = await t.context.extractStorageLayout('Memory05');
+  t.snapshot(stabilizeStorageLayout(layout));
+});
+
+test('memory 0.8.9', async t => {
+  const layout = await t.context.extractStorageLayout('Memory08');
+  t.snapshot(stabilizeStorageLayout(layout));
+});
+
+test('memory - upgrade from 0.5.16 to 0.8.9', async t => {
+  const v1 = await t.context.extractStorageLayout('Memory05');
+  const v2 = await t.context.extractStorageLayout('Memory08');
+
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('memory - bad upgrade from 0.5.16 to 0.8.9', async t => {
+  const v1 = await t.context.extractStorageLayout('Memory05');
+  const v2 = await t.context.extractStorageLayout('Memory08', 'Memory08Bad');
+
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 2,
+    0: {
+      kind: 'typechange',
+      change: {
+        kind: 'mapping key',
+      },
+      original: { label: 'a' },
+      updated: { label: 'a' },
+    },
+    1: {
+      kind: 'typechange',
+      change: {
+        kind: 'mapping key',
+      },
+      original: { label: 'b' },
+      updated: { label: 'b' },
+    },
+  });
+});

package/src/storage-memory-0.5.test.ts.md

@@ -0,0 +1,175 @@
+# Snapshot report for `src/storage-memory-0.5.test.ts`
+
+The actual snapshot is saved in `storage-memory-0.5.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## memory 0.5.16
+
+> Snapshot 1
+
+    {
+      storage: [
+        {
+          contract: 'Memory05',
+          label: 'a',
+          offset: 0,
+          renamedFrom: undefined,
+          retypedFrom: undefined,
+          slot: '0',
+          src: 'file.sol:1',
+          type: 't_mapping(t_string_memory,t_address)',
+        },
+        {
+          contract: 'Memory05',
+          label: 'b',
+          offset: 0,
+          renamedFrom: undefined,
+          retypedFrom: undefined,
+          slot: '1',
+          src: 'file.sol:1',
+          type: 't_mapping(t_bytes_memory,t_address)',
+        },
+      ],
+      types: [
+        [
+          't_address',
+          {
+            label: 'address',
+            members: undefined,
+            numberOfBytes: '20',
+          },
+        ],
+        [
+          't_bytes_memory',
+          {
+            label: 'bytes',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_mapping(t_bytes_memory,t_address)',
+          {
+            label: 'mapping(bytes => address)',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_mapping(t_string_memory,t_address)',
+          {
+            label: 'mapping(string => address)',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_string_memory',
+          {
+            label: 'string',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_string_storage',
+          {
+            label: 'string',
+            members: undefined,
+          },
+        ],
+        [
+          't_bytes_storage',
+          {
+            label: 'bytes',
+            members: undefined,
+          },
+        ],
+      ],
+    }
+
+## memory 0.8.9
+
+> Snapshot 1
+
+    {
+      storage: [
+        {
+          contract: 'Memory08',
+          label: 'a',
+          offset: 0,
+          renamedFrom: undefined,
+          retypedFrom: undefined,
+          slot: '0',
+          src: 'file.sol:1',
+          type: 't_mapping(t_string_memory_ptr,t_address)',
+        },
+        {
+          contract: 'Memory08',
+          label: 'b',
+          offset: 0,
+          renamedFrom: undefined,
+          retypedFrom: undefined,
+          slot: '1',
+          src: 'file.sol:1',
+          type: 't_mapping(t_bytes_memory_ptr,t_address)',
+        },
+      ],
+      types: [
+        [
+          't_address',
+          {
+            label: 'address',
+            members: undefined,
+            numberOfBytes: '20',
+          },
+        ],
+        [
+          't_bytes_memory_ptr',
+          {
+            label: 'bytes',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_mapping(t_bytes_memory_ptr,t_address)',
+          {
+            label: 'mapping(bytes => address)',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_mapping(t_string_memory_ptr,t_address)',
+          {
+            label: 'mapping(string => address)',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_string_memory_ptr',
+          {
+            label: 'string',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+        [
+          't_string_storage',
+          {
+            label: 'string',
+            members: undefined,
+          },
+        ],
+        [
+          't_bytes_storage',
+          {
+            label: 'bytes',
+            members: undefined,
+          },
+        ],
+      ],
+    }