@openzeppelin/upgrades-core 1.27.2 → 1.28.0

package/src/deployment.ts

@@ -257,7 +257,11 @@ export async function waitAndValidateDeployment(
 }
 
 export class TransactionMinedTimeout extends UpgradesError {
-  constructor(readonly deployment: Deployment & RemoteDeploymentId, type?: string, configurableTimeout?: boolean) {
+  constructor(
+    readonly deployment: Deployment & RemoteDeploymentId,
+    type?: string,
+    configurableTimeout?: boolean,
+  ) {
     super(
       `Timed out waiting for ${type ? type + ' ' : ''}contract deployment to address ${deployment.address} with ${
         deployment.remoteDeploymentId

package/src/impl-store.test.ts

@@ -1,8 +1,7 @@
 import test from 'ava';
 
 import { promises as fs } from 'fs';
-import rimrafAsync from 'rimraf';
-import util from 'util';
+import { rimraf } from 'rimraf';
 import path from 'path';
 import os from 'os';
 import sinon from 'sinon';
@@ -12,8 +11,6 @@ import { getVersion } from './version';
 import { stubProvider } from './stub-provider';
 import { ImplDeployment } from './manifest';
 
-const rimraf = util.promisify(rimrafAsync);
-
 test.before(async () => {
   process.chdir(await fs.mkdtemp(path.join(os.tmpdir(), 'upgrades-core-test-')));
 });

package/src/scripts/migrate-oz-cli-project.test.ts

@@ -1,8 +1,7 @@
 import os from 'os';
 import test from 'ava';
 import path from 'path';
-import util from 'util';
-import rimrafAsync from 'rimraf';
+import { rimraf } from 'rimraf';
 import { promises as fs } from 'fs';
 import { compare as compareVersions } from 'compare-versions';
 import {
@@ -13,7 +12,6 @@ import {
   migrateLegacyProject,
 } from './migrate-oz-cli-project';
 
-const rimraf = util.promisify(rimrafAsync);
 const BASE_PATH = 'src/scripts';
 const OPENZEPPELIN_FOLDER = '.openzeppelin';
 const PROJECT_FILE = path.join(OPENZEPPELIN_FOLDER, 'project.json');

package/src/standalone.ts

@@ -23,7 +23,12 @@ export class UpgradeableContract {
   readonly errors: ValidationError[];
   readonly layout: StorageLayout;
 
-  constructor(readonly name: string, solcInput: SolcInput, solcOutput: SolcOutput, opts: ValidationOptions = {}) {
+  constructor(
+    readonly name: string,
+    solcInput: SolcInput,
+    solcOutput: SolcOutput,
+    opts: ValidationOptions = {},
+  ) {
     const decodeSrc = solcInputOutputDecoder(solcInput, solcOutput);
     const validation = validate(solcOutput, decodeSrc);
     this.version = getContractVersion(validation, name);

package/src/storage/compare.ts

@@ -103,7 +103,10 @@ export class StorageLayoutComparator {
   stack = new Set<string>();
   cache = new Map<string, TypeChange | undefined>();
 
-  constructor(readonly unsafeAllowCustomTypes = false, readonly unsafeAllowRenames = false) {}
+  constructor(
+    readonly unsafeAllowCustomTypes = false,
+    readonly unsafeAllowRenames = false,
+  ) {}
 
   compareLayouts(original: StorageItem[], updated: StorageItem[]): LayoutCompatibilityReport {
     return new LayoutCompatibilityReport(this.layoutLevenshtein(original, updated, { allowAppend: true }));

package/src/storage/extract.ts

@@ -6,11 +6,10 @@ import {
   TypeDescriptions,
   VariableDeclaration,
 } from 'solidity-ast';
-import { isNodeType, findAll } from 'solidity-ast/utils';
+import { isNodeType, findAll, ASTDereferencer } from 'solidity-ast/utils';
 import { StorageLayout, TypeItem } from './layout';
 import { normalizeTypeIdentifier } from '../utils/type-id';
 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';

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

@@ -1,8 +1,7 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { ASTDereferencer, 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';

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

@@ -1,8 +1,7 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { ASTDereferencer, 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';

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

@@ -1,8 +1,7 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { ASTDereferencer, 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';

package/src/storage/report.test.ts

@@ -1,10 +1,9 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
 
 import { SolcOutput } from '../solc-api';
-import { astDereferencer } from '../ast-dereferencer';
 import { extractStorageLayout } from '../storage/extract';
 import { StorageLayoutComparator } from './compare';
 import { StorageLayout, getDetailedLayout } from './layout';

package/src/storage-0.8.test.ts

@@ -1,9 +1,8 @@
 import _test, { TestFn } from 'ava';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } 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';
@@ -112,3 +111,35 @@ test('renamed retyped - extraction', async t => {
   const layout = await t.context.extractStorageLayout('StorageRenamedRetyped');
   t.snapshot(stabilizeStorageLayout(layout));
 });
+
+test('mapping with user defined value type key - ok', async t => {
+  const v1 = await t.context.extractStorageLayout('Storage089_MappingUVDTKey_V1');
+  const v2 = await t.context.extractStorageLayout('Storage089_MappingUVDTKey_V2_Ok');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('mapping with user defined value type key - bad', async t => {
+  const v1 = await t.context.extractStorageLayout('Storage089_MappingUVDTKey_V1');
+  const v2 = await t.context.extractStorageLayout('Storage089_MappingUVDTKey_V2_Bad');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 2,
+    0: {
+      kind: 'typechange',
+      change: {
+        kind: 'mapping key',
+      },
+      original: { label: 'm1' },
+      updated: { label: 'm1' },
+    },
+    1: {
+      kind: 'typechange',
+      change: {
+        kind: 'mapping key',
+      },
+      original: { label: 'm2' },
+      updated: { label: 'm2' },
+    },
+  });
+});

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

@@ -1,9 +1,8 @@
 import _test, { TestFn } from 'ava';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } 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';

package/src/storage.test.ts

@@ -1,10 +1,9 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
 
 import { SolcOutput } from './solc-api';
-import { astDereferencer } from './ast-dereferencer';
 import { getStorageUpgradeErrors } from './storage';
 import { StorageLayout } from './storage/layout';
 import { extractStorageLayout } from './storage/extract';

package/src/utils/function.test.ts

@@ -1,11 +1,10 @@
 import test from 'ava';
 import { artifacts } from 'hardhat';
 import { FunctionDefinition } from 'solidity-ast';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 
 import { getFunctionSignature } from './function';
 import { SolcOutput } from '../solc-api';
-import { astDereferencer } from '../ast-dereferencer';
 
 testContract('ContractFunctionSignatures');
 testContract('LibraryFunctionSignatures');

package/src/utils/function.ts

@@ -1,5 +1,5 @@
 import type { FunctionDefinition, TypeName, VariableDeclaration } from 'solidity-ast';
-import { ASTDereferencer } from '../ast-dereferencer';
+import { ASTDereferencer } from 'solidity-ast/utils';
 import { assert, assertUnreachable } from './assert';
 
 function serializeParameterType(parameter: VariableDeclaration, deref: ASTDereferencer): string {

package/src/utils/is-value-type.ts

@@ -1,5 +1,5 @@
 import { ParsedTypeDetailed } from '../storage/layout';
 
 export function isValueType(type: ParsedTypeDetailed): boolean {
-  return type.args === undefined || ['t_contract', 't_enum'].includes(type.head);
+  return type.args === undefined || ['t_contract', 't_enum', 't_userDefinedValueType'].includes(type.head);
 }

package/src/validate/error.ts

@@ -3,7 +3,10 @@ import { UpgradesError } from '../error';
 import { UpgradeableContractErrorReport } from './report';
 
 export class ValidationErrors extends UpgradesError {
-  constructor(contractName: string, readonly errors: ValidationError[]) {
+  constructor(
+    contractName: string,
+    readonly errors: ValidationError[],
+  ) {
     super(`Contract \`${contractName}\` is not upgrade safe`, () =>
       new UpgradeableContractErrorReport(errors).explain(),
     );

package/src/validate/run.ts

@@ -1,10 +1,9 @@
 import { Node } from 'solidity-ast/node';
-import { isNodeType, findAll, ASTDereferencer } from 'solidity-ast/utils';
+import { isNodeType, findAll, ASTDereferencer, astDereferencer } from 'solidity-ast/utils';
 import type { ContractDefinition, FunctionDefinition } from 'solidity-ast';
 
 import { SolcOutput, SolcBytecode } from '../solc-api';
 import { SrcDecoder } from '../src-decoder';
-import { astDereferencer } from '../ast-dereferencer';
 import { isNullish } from '../utils/is-nullish';
 import { getFunctionSignature } from '../utils/function';
 import { Version, getVersion } from '../version';
@@ -48,7 +47,7 @@ export type ValidationError =
 
 interface ValidationErrorBase {
   src: string;
-  kind: typeof errorKinds[number];
+  kind: (typeof errorKinds)[number];
 }
 
 interface ValidationErrorWithName extends ValidationErrorBase {

package/dist/ast-dereferencer.d.ts

@@ -1,8 +0,0 @@
-import type { NodeType, NodeTypeMap } from 'solidity-ast/node';
-import type { SolcOutput } from './solc-api';
-export interface ASTDereferencer {
-    <T extends NodeType>(nodeTypes: T[]): (id: number) => NodeTypeMap[T];
-    <T extends NodeType>(nodeTypes: T[], id: number): NodeTypeMap[T];
-}
-export declare function astDereferencer(solcOutput: SolcOutput): ASTDereferencer;
-//# sourceMappingURL=ast-dereferencer.d.ts.map

package/dist/ast-dereferencer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ast-dereferencer.d.ts","sourceRoot":"","sources":["../src/ast-dereferencer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAQ,QAAQ,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAM7C,MAAM,WAAW,eAAe;IAC9B,CAAC,CAAC,SAAS,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,SAAS,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;CAClE;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,eAAe,CA0BvE"}

package/dist/ast-dereferencer.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.astDereferencer = void 0;
-const utils_1 = require("solidity-ast/utils");
-const curry_1 = require("./utils/curry");
-function astDereferencer(solcOutput) {
-    const asts = Array.from(Object.values(solcOutput.sources), s => s.ast);
-    const cache = new Map();
-    function deref(nodeTypes, id) {
-        const cached = cache.get(id);
-        if (cached) {
-            if (nodeTypes.includes(cached.nodeType)) {
-                return cached;
-            }
-        }
-        for (const ast of asts) {
-            for (const node of (0, utils_1.findAll)(nodeTypes, ast)) {
-                if (node.id === id) {
-                    cache.set(id, node);
-                    return node;
-                }
-            }
-        }
-        throw new Error(`No node with id ${id} of type ${nodeTypes}`);
-    }
-    return (0, curry_1.curry2)(deref);
-}
-exports.astDereferencer = astDereferencer;
-//# sourceMappingURL=ast-dereferencer.js.map

package/dist/ast-dereferencer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ast-dereferencer.js","sourceRoot":"","sources":["../src/ast-dereferencer.ts"],"names":[],"mappings":";;;AAAA,8CAA6C;AAG7C,yCAAuC;AAYvC,SAAgB,eAAe,CAAC,UAAsB;IACpD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAgB,CAAC;IAEtC,SAAS,KAAK,CAAqB,SAAc,EAAE,EAAU;QAC3D,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE7B,IAAI,MAAM,EAAE;YACV,IAAK,SAAwB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBACvD,OAAO,MAAwB,CAAC;aACjC;SACF;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,KAAK,MAAM,IAAI,IAAI,IAAA,eAAO,EAAC,SAAS,EAAE,GAAG,CAAC,EAAE;gBAC1C,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE;oBAClB,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;oBACpB,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,MAAM,IAAI,KAAK,CAAC,mBAAmB,EAAE,YAAY,SAAS,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AA1BD,0CA0BC"}

package/src/ast-dereferencer.ts

@@ -1,42 +0,0 @@
-import { findAll } from 'solidity-ast/utils';
-import type { Node, NodeType, NodeTypeMap } from 'solidity-ast/node';
-
-import { curry2 } from './utils/curry';
-import type { SolcOutput } from './solc-api';
-
-// An ASTDereferencer is a function that looks up an AST node given its id, in all of the source files involved in a
-// solc run. It will generally be used together with the AST property `referencedDeclaration` (found in Identifier,
-// UserDefinedTypeName, etc.) to look up a variable definition or type definition.
-
-export interface ASTDereferencer {
-  <T extends NodeType>(nodeTypes: T[]): (id: number) => NodeTypeMap[T];
-  <T extends NodeType>(nodeTypes: T[], id: number): NodeTypeMap[T];
-}
-
-export function astDereferencer(solcOutput: SolcOutput): ASTDereferencer {
-  const asts = Array.from(Object.values(solcOutput.sources), s => s.ast);
-  const cache = new Map<number, Node>();
-
-  function deref<T extends NodeType>(nodeTypes: T[], id: number): NodeTypeMap[T] {
-    const cached = cache.get(id);
-
-    if (cached) {
-      if ((nodeTypes as NodeType[]).includes(cached.nodeType)) {
-        return cached as NodeTypeMap[T];
-      }
-    }
-
-    for (const ast of asts) {
-      for (const node of findAll(nodeTypes, ast)) {
-        if (node.id === id) {
-          cache.set(id, node);
-          return node;
-        }
-      }
-    }
-
-    throw new Error(`No node with id ${id} of type ${nodeTypes}`);
-  }
-
-  return curry2(deref);
-}