@openzeppelin/upgrades-core 1.29.0 → 1.30.1

package/src/storage-namespaced-conflicts-layout.test.ts.md

@@ -0,0 +1,53 @@
+# Snapshot report for `src/storage-namespaced-conflicts-layout.test.ts`
+
+The actual snapshot is saved in `storage-namespaced-conflicts-layout.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## duplicate namespace
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract DuplicateNamespace␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:10␊
+    - contracts/test/NamespacedConflicts.sol:15␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`
+
+## inherits duplicate
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract InheritsDuplicate␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:10␊
+    - contracts/test/NamespacedConflicts.sol:15␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`
+
+## conflicts with parent
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract ConflictsWithParent␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:45␊
+    - contracts/test/NamespacedConflicts.sol:30␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`
+
+## conflicts in both parents
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract ConflictsInBothParents␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:45␊
+    - contracts/test/NamespacedConflicts.sol:30␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`

package/src/storage-namespaced-conflicts.test.ts

@@ -0,0 +1,54 @@
+import _test, { TestFn } from 'ava';
+import { ContractDefinition } from 'solidity-ast';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
+import { artifacts } from 'hardhat';
+
+import { SolcOutput } from './solc-api';
+import { StorageLayout } from './storage/layout';
+import { extractStorageLayout } from './storage/extract';
+import { solcInputOutputDecoder } from './src-decoder';
+
+interface Context {
+  extractStorageLayout: (contract: string) => ReturnType<typeof extractStorageLayout>;
+}
+
+const test = _test as TestFn<Context>;
+
+test.before(async t => {
+  const buildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedConflicts.sol:DuplicateNamespace');
+  if (buildInfo === undefined) {
+    throw new Error('Build info not found');
+  }
+  const solcOutput: SolcOutput = buildInfo.output;
+  const contracts: Record<string, ContractDefinition> = {};
+  const storageLayouts: Record<string, StorageLayout> = {};
+  for (const def of findAll('ContractDefinition', solcOutput.sources['contracts/test/NamespacedConflicts.sol'].ast)) {
+    contracts[def.name] = def;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    storageLayouts[def.name] = solcOutput.contracts['contracts/test/NamespacedConflicts.sol'][def.name].storageLayout!;
+  }
+  const deref = astDereferencer(solcOutput);
+  const decodeSrc = solcInputOutputDecoder(buildInfo.input, solcOutput);
+  t.context.extractStorageLayout = name =>
+    extractStorageLayout(contracts[name], decodeSrc, deref, storageLayouts[name]);
+});
+
+test('duplicate namespace', t => {
+  const error = t.throws(() => t.context.extractStorageLayout('DuplicateNamespace'));
+  t.snapshot(error?.message);
+});
+
+test('inherits duplicate', t => {
+  const error = t.throws(() => t.context.extractStorageLayout('InheritsDuplicate'));
+  t.snapshot(error?.message);
+});
+
+test('conflicts with parent', t => {
+  const error = t.throws(() => t.context.extractStorageLayout('ConflictsWithParent'));
+  t.snapshot(error?.message);
+});
+
+test('conflicts in both parents', t => {
+  const error = t.throws(() => t.context.extractStorageLayout('ConflictsInBothParents'));
+  t.snapshot(error?.message);
+});

package/src/storage-namespaced-conflicts.test.ts.md

@@ -0,0 +1,53 @@
+# Snapshot report for `src/storage-namespaced-conflicts.test.ts`
+
+The actual snapshot is saved in `storage-namespaced-conflicts.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## duplicate namespace
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract DuplicateNamespace␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:10␊
+    - contracts/test/NamespacedConflicts.sol:15␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`
+
+## inherits duplicate
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract InheritsDuplicate␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:10␊
+    - contracts/test/NamespacedConflicts.sol:15␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`
+
+## conflicts with parent
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract ConflictsWithParent␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:45␊
+    - contracts/test/NamespacedConflicts.sol:30␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`
+
+## conflicts in both parents
+
+> Snapshot 1
+
+    `Namespace erc7201:conflicting is defined multiple times for contract ConflictsInBothParents␊
+    ␊
+    The namespace erc7201:conflicting was found in structs at the following locations:␊
+    - contracts/test/NamespacedConflicts.sol:45␊
+    - contracts/test/NamespacedConflicts.sol:30␊
+    ␊
+    Use a unique namespace id for each struct annotated with '@custom:storage-location erc7201:<NAMESPACE_ID>' in your contract and its inherited contracts.`

package/src/storage-namespaced-layout.test.ts

@@ -0,0 +1,77 @@
+import _test, { TestFn } from 'ava';
+import { ContractDefinition } from 'solidity-ast';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
+import { artifacts } from 'hardhat';
+
+import { SolcOutput } from './solc-api';
+import { StorageLayout } from './storage/layout';
+import { extractStorageLayout } from './storage/extract';
+import { stabilizeStorageLayout } from './utils/stabilize-layout';
+import { solcInputOutputDecoder } from './src-decoder';
+
+interface Context {
+  extractStorageLayout: (contract: string) => ReturnType<typeof extractStorageLayout>;
+}
+
+const test = _test as TestFn<Context>;
+
+test.before(async t => {
+  // Tests extracting the storage layout (to include slot and offset) using Namespaced.sol's Example as the original contract,
+  // and NamespacedLayout.sol's Example as the modified contract with the storage layout.
+  const origBuildInfo = await artifacts.getBuildInfo('contracts/test/Namespaced.sol:Example');
+  const namespacedBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedLayout.sol:Example');
+
+  if (origBuildInfo === undefined || namespacedBuildInfo === undefined) {
+    throw new Error('Build info not found');
+  }
+
+  const origSolcOutput: SolcOutput = origBuildInfo.output;
+  const origContracts: Record<string, ContractDefinition> = {};
+  const origStorageLayouts: Record<string, StorageLayout> = {};
+
+  const namespacedSolcOutput: SolcOutput = namespacedBuildInfo.output;
+  const namespacedContracts: Record<string, ContractDefinition> = {};
+  const namespacedStorageLayouts: Record<string, StorageLayout> = {};
+
+  const origContractDefs = [];
+  for (const def of findAll('ContractDefinition', origSolcOutput.sources['contracts/test/Namespaced.sol'].ast)) {
+    origContractDefs.push(def);
+  }
+  const namespacedContractDefs = [];
+  for (const def of findAll(
+    'ContractDefinition',
+    namespacedSolcOutput.sources['contracts/test/NamespacedLayout.sol'].ast,
+  )) {
+    namespacedContractDefs.push(def);
+  }
+
+  // Expects the first contract in Namespaced.sol and NamespacedLayout.sol to be 'Example'
+  const origContractDef = origContractDefs[0];
+  const namespacedContractDef = namespacedContractDefs[0];
+
+  origContracts[origContractDef.name] = origContractDef;
+  namespacedContracts[namespacedContractDef.name] = namespacedContractDef;
+
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  origStorageLayouts[origContractDef.name] =
+    origSolcOutput.contracts['contracts/test/Namespaced.sol'][origContractDef.name].storageLayout!;
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  namespacedStorageLayouts[namespacedContractDef.name] =
+    namespacedSolcOutput.contracts['contracts/test/NamespacedLayout.sol'][namespacedContractDef.name].storageLayout!;
+
+  const origDeref = astDereferencer(origSolcOutput);
+  const namespacedDeref = astDereferencer(namespacedSolcOutput);
+
+  const decodeSrc = solcInputOutputDecoder(origBuildInfo.input, origSolcOutput);
+  t.context.extractStorageLayout = name =>
+    extractStorageLayout(origContracts[name], decodeSrc, origDeref, origStorageLayouts[name], {
+      deref: namespacedDeref,
+      contractDef: namespacedContracts[name],
+      storageLayout: namespacedStorageLayouts[name],
+    });
+});
+
+test('layout', t => {
+  const layout = t.context.extractStorageLayout('Example');
+  t.snapshot(stabilizeStorageLayout(layout));
+});

package/src/storage-namespaced-layout.test.ts.md

@@ -0,0 +1,67 @@
+# Snapshot report for `src/storage-namespaced-layout.test.ts`
+
+The actual snapshot is saved in `storage-namespaced-layout.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## layout
+
+> Snapshot 1
+
+    {
+      namespaces: [
+        [
+          'erc7201:example.main',
+          [
+            {
+              contract: 'Example',
+              label: 'x',
+              offset: 0,
+              slot: '0',
+              src: 'contracts/test/Namespaced.sol:7',
+              type: 't_uint256',
+            },
+            {
+              contract: 'Example',
+              label: 'y',
+              offset: 0,
+              slot: '1',
+              src: 'contracts/test/Namespaced.sol:8',
+              type: 't_uint256',
+            },
+          ],
+        ],
+      ],
+      storage: [],
+      types: [
+        [
+          't_struct(MainStorage)storage',
+          {
+            label: 'struct Example.MainStorage',
+            members: [
+              {
+                label: 'x',
+                offset: 0,
+                slot: '0',
+                type: 't_uint256',
+              },
+              {
+                label: 'y',
+                offset: 0,
+                slot: '1',
+                type: 't_uint256',
+              },
+            ],
+            numberOfBytes: '64',
+          },
+        ],
+        [
+          't_uint256',
+          {
+            label: 'uint256',
+            members: undefined,
+            numberOfBytes: '32',
+          },
+        ],
+      ],
+    }

package/src/storage-namespaced-outside-contract.test.ts

@@ -0,0 +1,24 @@
+import test from 'ava';
+import { artifacts } from 'hardhat';
+
+import { validate } from './validate';
+import { solcInputOutputDecoder } from './src-decoder';
+
+test('namespace outside contract', async t => {
+  const contract = 'contracts/test/NamespacedOutsideContract.sol:Example';
+
+  const buildInfo = await artifacts.getBuildInfo(contract);
+  if (buildInfo === undefined) {
+    throw new Error(`Build info not found for contract ${contract}`);
+  }
+  const solcOutput = buildInfo.output;
+  const solcInput = buildInfo.input;
+  const decodeSrc = solcInputOutputDecoder(solcInput, solcOutput);
+  const error = t.throws(() => validate(solcOutput, decodeSrc));
+  t.assert(
+    error?.message.includes(
+      'contracts/test/NamespacedOutsideContract.sol:7: Namespace struct MainStorage is defined outside of a contract',
+    ),
+    error?.message,
+  );
+});

package/src/storage-namespaced-solc-versions.test.ts

@@ -0,0 +1,59 @@
+import _test, { TestFn } from 'ava';
+import { artifacts } from 'hardhat';
+
+import { validate } from './validate';
+import { solcInputOutputDecoder } from './src-decoder';
+
+interface Context {
+  validate: (solcVersion?: string) => ReturnType<typeof validate>;
+}
+
+const test = _test as TestFn<Context>;
+
+test.before(async t => {
+  const contract = 'contracts/test/Namespaced.sol:Example';
+
+  const buildInfo = await artifacts.getBuildInfo(contract);
+  if (buildInfo === undefined) {
+    throw new Error(`Build info not found for contract ${contract}`);
+  }
+  const solcOutput = buildInfo.output;
+  const solcInput = buildInfo.input;
+  const decodeSrc = solcInputOutputDecoder(solcInput, solcOutput);
+
+  t.context.validate = solcVersion => validate(solcOutput, decodeSrc, solcVersion, solcInput);
+});
+
+test('namespace with older solc version', async t => {
+  const { validate } = t.context;
+  const error = t.throws(() => validate('0.8.19'));
+  t.assert(
+    error?.message.includes(
+      `contracts/test/Namespaced.sol: Namespace annotations require Solidity version >= 0.8.20, but 0.8.19 was used`,
+    ),
+    error?.message,
+  );
+});
+
+test('namespace with correct solc version', async t => {
+  const { validate } = t.context;
+  validate('0.8.20');
+  t.pass();
+});
+
+test('namespace with newer solc version', async t => {
+  const { validate } = t.context;
+  validate('0.8.21');
+  t.pass();
+});
+
+test('namespace with no solc version', async t => {
+  const { validate } = t.context;
+  const error = t.throws(() => validate(undefined));
+  t.assert(
+    error?.message.includes(
+      `contracts/test/Namespaced.sol: Namespace annotations require Solidity version >= 0.8.20, but no solcVersion parameter was provided`,
+    ),
+    error?.message,
+  );
+});

package/src/storage-namespaced-udvt.test.ts

@@ -0,0 +1,160 @@
+import _test, { TestFn } from 'ava';
+import { ContractDefinition } from 'solidity-ast';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
+import { artifacts } from 'hardhat';
+
+import { SolcOutput } from './solc-api';
+import { getStorageUpgradeErrors } from './storage';
+import { StorageLayout } from './storage/layout';
+import { extractStorageLayout } from './storage/extract';
+import { solcInputOutputDecoder } from './src-decoder';
+
+interface Context {
+  extractStorageLayout: (contract: string, layoutInfo: boolean) => ReturnType<typeof extractStorageLayout>;
+}
+
+const test = _test as TestFn<Context>;
+
+test.before(async t => {
+  const origBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedUDVT.sol:NamespacedUDVT');
+  const namespacedBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedUDVTLayout.sol:NamespacedUDVT');
+
+  if (origBuildInfo === undefined || namespacedBuildInfo === undefined) {
+    throw new Error('Build info not found');
+  }
+
+  const origSolcOutput: SolcOutput = origBuildInfo.output;
+  const origContracts: Record<string, ContractDefinition> = {};
+  const origStorageLayouts: Record<string, StorageLayout> = {};
+
+  const namespacedSolcOutput: SolcOutput = namespacedBuildInfo.output;
+  const namespacedContracts: Record<string, ContractDefinition> = {};
+  const namespacedStorageLayouts: Record<string, StorageLayout> = {};
+
+  const origContractDefs = [];
+  for (const def of findAll('ContractDefinition', origSolcOutput.sources['contracts/test/NamespacedUDVT.sol'].ast)) {
+    origContractDefs.push(def);
+  }
+  const namespacedContractDefs = [];
+  for (const def of findAll(
+    'ContractDefinition',
+    namespacedSolcOutput.sources['contracts/test/NamespacedUDVTLayout.sol'].ast,
+  )) {
+    namespacedContractDefs.push(def);
+  }
+
+  for (let i = 0; i < origContractDefs.length; i++) {
+    const origContractDef = origContractDefs[i];
+    const namespacedContractDef = namespacedContractDefs[i];
+
+    origContracts[origContractDef.name] = origContractDef;
+    namespacedContracts[namespacedContractDef.name] = namespacedContractDef;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    origStorageLayouts[origContractDef.name] =
+      origSolcOutput.contracts['contracts/test/NamespacedUDVT.sol'][origContractDef.name].storageLayout!;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    namespacedStorageLayouts[namespacedContractDef.name] =
+      namespacedSolcOutput.contracts['contracts/test/NamespacedUDVTLayout.sol'][
+        namespacedContractDef.name
+      ].storageLayout!;
+  }
+  const origDeref = astDereferencer(origSolcOutput);
+  const namespacedDeref = astDereferencer(namespacedSolcOutput);
+
+  const decodeSrc = solcInputOutputDecoder(origBuildInfo.input, origSolcOutput);
+  t.context.extractStorageLayout = (name, layoutInfo) =>
+    extractStorageLayout(
+      origContracts[name],
+      decodeSrc,
+      origDeref,
+      origStorageLayouts[name],
+      layoutInfo
+        ? {
+            deref: namespacedDeref,
+            contractDef: namespacedContracts[name],
+            storageLayout: namespacedStorageLayouts[name],
+          }
+        : undefined,
+    );
+});
+
+test('user defined value types - layout info', async t => {
+  const v1 = t.context.extractStorageLayout('NamespacedUDVT', true);
+  const v2 = t.context.extractStorageLayout('NamespacedUDVT_V2_Ok', true);
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('user defined value types - no layout info', async t => {
+  const v1 = t.context.extractStorageLayout('NamespacedUDVT', false);
+  const v2 = t.context.extractStorageLayout('NamespacedUDVT_V2_Ok', false);
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('user defined value types - layout info - bad underlying type', async t => {
+  const v1 = t.context.extractStorageLayout('NamespacedUDVT', true);
+  const v2 = t.context.extractStorageLayout('NamespacedUDVT_V2_Resize', true);
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 1,
+    0: {
+      kind: 'typechange',
+      change: {
+        kind: 'type resize',
+      },
+      original: { label: 'my_user_value' },
+      updated: { label: 'my_user_value' },
+    },
+  });
+});
+
+test('user defined value types - no layout info - bad underlying type', async t => {
+  const v1 = t.context.extractStorageLayout('NamespacedUDVT', false);
+  const v2 = t.context.extractStorageLayout('NamespacedUDVT_V2_Resize', false);
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 1,
+    0: {
+      kind: 'typechange',
+      change: {
+        kind: 'unknown',
+      },
+      original: { label: 'my_user_value' },
+      updated: { label: 'my_user_value' },
+    },
+  });
+});
+
+test('mapping with user defined value type key - ok', t => {
+  const v1 = t.context.extractStorageLayout('NamespacedUDVT_MappingKey_V1', true);
+  const v2 = t.context.extractStorageLayout('NamespacedUDVT_MappingKey_V2_Ok', true);
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('mapping with user defined value type key - bad', t => {
+  const v1 = t.context.extractStorageLayout('NamespacedUDVT_MappingKey_V1', true);
+  const v2 = t.context.extractStorageLayout('NamespacedUDVT_MappingKey_V2_Bad', true);
+  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' },
+    },
+  });
+});