@openzeppelin/upgrades-core 1.29.0 → 1.30.1

package/src/storage-namespaced.test.ts

@@ -0,0 +1,146 @@
+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 { stabilizeStorageLayout } from './utils/stabilize-layout';
+
+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/Namespaced.sol:Example');
+  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/Namespaced.sol'].ast)) {
+    contracts[def.name] = def;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    storageLayouts[def.name] = solcOutput.contracts['contracts/test/Namespaced.sol'][def.name].storageLayout!;
+  }
+  const deref = astDereferencer(solcOutput);
+  t.context.extractStorageLayout = name =>
+    extractStorageLayout(contracts[name], dummyDecodeSrc, deref, storageLayouts[name]);
+});
+
+const dummyDecodeSrc = () => 'file.sol:1';
+
+test('layout', t => {
+  const layout = t.context.extractStorageLayout('Example');
+  t.snapshot(stabilizeStorageLayout(layout));
+});
+
+test('multiple namespaces', t => {
+  const layout = t.context.extractStorageLayout('MultipleNamespaces');
+  t.snapshot(stabilizeStorageLayout(layout));
+});
+
+test('namespaced upgrade ok', t => {
+  const v1 = t.context.extractStorageLayout('Example');
+  const v2 = t.context.extractStorageLayout('ExampleV2_Ok');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('namespaced upgrade bad', t => {
+  const v1 = t.context.extractStorageLayout('Example');
+  const v2 = t.context.extractStorageLayout('ExampleV2_Bad');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 1,
+    0: {
+      kind: 'delete',
+      original: {
+        contract: 'Example',
+        label: 'x',
+        type: {
+          id: 't_uint256',
+        },
+      },
+    },
+  });
+});
+
+test('recursive struct outer ok', t => {
+  const v1 = t.context.extractStorageLayout('RecursiveStruct');
+  const v2 = t.context.extractStorageLayout('RecursiveStructV2_Outer_Ok');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('recursive struct bad', t => {
+  const v1 = t.context.extractStorageLayout('RecursiveStruct');
+  const v2 = t.context.extractStorageLayout('RecursiveStructV2_Bad');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 1,
+    0: {
+      kind: 'typechange',
+      change: {
+        kind: 'struct members',
+        ops: {
+          length: 1,
+          0: { kind: 'append' },
+        },
+      },
+      original: { label: 's' },
+      updated: { label: 's' },
+    },
+  });
+});
+
+test('multiple namespaces and regular variables ok', t => {
+  const v1 = t.context.extractStorageLayout('MultipleNamespacesAndRegularVariables');
+  const v2 = t.context.extractStorageLayout('MultipleNamespacesAndRegularVariablesV2_Ok');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.deepEqual(comparison, []);
+});
+
+test('multiple namespaces and regular variables bad', t => {
+  const v1 = t.context.extractStorageLayout('MultipleNamespacesAndRegularVariables');
+  const v2 = t.context.extractStorageLayout('MultipleNamespacesAndRegularVariablesV2_Bad');
+  const comparison = getStorageUpgradeErrors(v1, v2);
+  t.like(comparison, {
+    length: 5,
+    0: {
+      kind: 'insert',
+      updated: {
+        label: 'c',
+      },
+    },
+    1: {
+      kind: 'layoutchange',
+      updated: {
+        label: 'a', // layout available for regular variable outside of namespace
+      },
+    },
+    2: {
+      kind: 'layoutchange',
+      updated: {
+        label: 'b', // layout available for regular variable outside of namespace
+      },
+    },
+    3: {
+      kind: 'insert',
+      updated: {
+        label: 'c',
+      },
+    },
+    4: {
+      kind: 'insert',
+      updated: {
+        label: 'c',
+      },
+    },
+  });
+});

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

@@ -0,0 +1,89 @@
+# Snapshot report for `src/storage-namespaced.test.ts`
+
+The actual snapshot is saved in `storage-namespaced.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## layout
+
+> Snapshot 1
+
+    {
+      namespaces: [
+        [
+          'erc7201:example.main',
+          [
+            {
+              contract: 'Example',
+              label: 'x',
+              src: 'file.sol:1',
+              type: 't_uint256',
+            },
+            {
+              contract: 'Example',
+              label: 'y',
+              src: 'file.sol:1',
+              type: 't_uint256',
+            },
+          ],
+        ],
+      ],
+      storage: [],
+      types: [
+        [
+          't_uint256',
+          {
+            label: 'uint256',
+            members: undefined,
+          },
+        ],
+      ],
+    }
+
+## multiple namespaces
+
+> Snapshot 1
+
+    {
+      namespaces: [
+        [
+          'erc7201:one',
+          [
+            {
+              contract: 'MultipleNamespaces',
+              label: 'a',
+              src: 'file.sol:1',
+              type: 't_uint256',
+            },
+          ],
+        ],
+        [
+          'erc7201:two',
+          [
+            {
+              contract: 'MultipleNamespaces',
+              label: 'a',
+              src: 'file.sol:1',
+              type: 't_uint128',
+            },
+          ],
+        ],
+      ],
+      storage: [],
+      types: [
+        [
+          't_uint256',
+          {
+            label: 'uint256',
+            members: undefined,
+          },
+        ],
+        [
+          't_uint128',
+          {
+            label: 'uint128',
+            members: undefined,
+          },
+        ],
+      ],
+    }

package/src/storage.test.ts.md

@@ -9,6 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     {
+      namespaces: [],
       storage: [
         {
           contract: 'Storage1',
@@ -92,6 +93,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     {
+      namespaces: [],
       storage: [
         {
           contract: 'Storage2',

package/src/upgrade-interface-version.test.ts

@@ -0,0 +1,37 @@
+import test from 'ava';
+import { EthereumProvider } from './provider';
+import { getUpgradeInterfaceVersion } from './upgrade-interface-version';
+
+const hash = '0x1234';
+
+function makeProviderReturning(result: unknown): EthereumProvider {
+  return { send: (_method: string, _params: unknown[]) => Promise.resolve(result) } as EthereumProvider;
+}
+
+function makeProviderError(msg: string): EthereumProvider {
+  return {
+    send: (_method: string, _params: unknown[]) => {
+      throw new Error(msg);
+    },
+  } as EthereumProvider;
+}
+
+test('getUpgradeInterfaceVersion returns version', async t => {
+  // abi encoding of '5.0.0'
+  const provider = makeProviderReturning(
+    '0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000005352e302e30000000000000000000000000000000000000000000000000000000',
+  );
+  t.is(await getUpgradeInterfaceVersion(provider, hash), '5.0.0');
+});
+
+test('getUpgradeInterfaceVersion throws unrelated error', async t => {
+  const provider = makeProviderError('unrelated error');
+  await t.throwsAsync(() => getUpgradeInterfaceVersion(provider, hash), { message: 'unrelated error' });
+});
+
+test('getUpgradeInterfaceVersion returns undefined for invalid selector', async t => {
+  const provider = makeProviderError(
+    `Transaction reverted: function selector was not recognized and there's no fallback function`,
+  );
+  t.is(await getUpgradeInterfaceVersion(provider, hash), undefined);
+});

package/src/upgrade-interface-version.ts

@@ -0,0 +1,27 @@
+import { callOptionalSignature } from './call-optional-signature';
+import { EthereumProvider } from './provider';
+
+export async function getUpgradeInterfaceVersion(
+  provider: EthereumProvider,
+  address: string,
+): Promise<string | undefined> {
+  const encodedVersion = await callOptionalSignature(provider, address, 'UPGRADE_INTERFACE_VERSION()');
+  if (encodedVersion !== undefined) {
+    // Encoded string
+    const buf = Buffer.from(encodedVersion.replace(/^0x/, ''), 'hex');
+
+    // The first 32 bytes represent the offset, which should be 32 for a string
+    const offset = parseInt(buf.slice(0, 32).toString('hex'), 16);
+    if (offset !== 32) {
+      throw new Error(`Unexpected type for UPGRADE_INTERFACE_VERSION at address ${address}. Expected a string`);
+    }
+
+    // The next 32 bytes represent the length of the string
+    const length = parseInt(buf.slice(32, 64).toString('hex'), 16);
+
+    // The rest is the string itself
+    return buf.slice(64, 64 + length).toString('utf8');
+  } else {
+    return undefined;
+  }
+}

package/src/utils/annotations.ts

@@ -1,6 +1,14 @@
 import { execall } from './execall';
 import { Node } from 'solidity-ast/node';
 
+/**
+ * Whether the given doc string has an annotation tag.
+ */
+export function hasAnnotationTag(doc: string, tag: string): boolean {
+  const regex = new RegExp(`^\\s*(@custom:${tag})(\\s|$)`, 'm');
+  return regex.test(doc);
+}
+
 /**
  * Get args from the doc string matching the given tag.
  *

package/src/utils/make-namespaced.test.ts

@@ -0,0 +1,74 @@
+import test, { ExecutionContext } from 'ava';
+import { artifacts, run } from 'hardhat';
+import {
+  TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD,
+  TASK_COMPILE_SOLIDITY_RUN_SOLC,
+  TASK_COMPILE_SOLIDITY_RUN_SOLCJS,
+} from 'hardhat/builtin-tasks/task-names';
+
+import { makeNamespacedInput } from './make-namespaced';
+import { SolcBuild } from 'hardhat/types/builtin-tasks';
+import { SolcInput, SolcOutput } from '../solc-api';
+import { BuildInfo } from 'hardhat/types';
+
+test('make namespaced input', async t => {
+  const origBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedToModify.sol:Example');
+  await testMakeNamespaced(origBuildInfo, t, '0.8.20');
+});
+
+test('make namespaced input - solc 0.7', async t => {
+  // The nameNamespacedInput function must work for different solc versions, since it is called before we check whether namespaces are used with solc >= 0.8.20
+  const origBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedToModify07.sol:HasFunction');
+  await testMakeNamespaced(origBuildInfo, t, '0.7.6');
+});
+
+async function testMakeNamespaced(
+  origBuildInfo: BuildInfo | undefined,
+  t: ExecutionContext<unknown>,
+  solcVersion: string,
+) {
+  if (origBuildInfo === undefined) {
+    throw new Error('Build info not found');
+  }
+
+  // Inefficient, but we want to test that we don't actually modify the original input object
+  const origInput = JSON.parse(JSON.stringify(origBuildInfo.input));
+
+  const modifiedInput = makeNamespacedInput(origBuildInfo.input, origBuildInfo.output);
+  normalizeStateVariableNames(modifiedInput);
+  t.snapshot(modifiedInput);
+
+  t.deepEqual(origBuildInfo.input, origInput);
+  t.notDeepEqual(modifiedInput, origInput);
+
+  // Run hardhat compile on the modified input and make sure it has no errors
+  const modifiedOutput = await hardhatCompile(modifiedInput, solcVersion);
+  t.is(modifiedOutput.errors, undefined);
+}
+
+function normalizeStateVariableNames(input: SolcInput): void {
+  for (const source of Object.values(input.sources)) {
+    if (source.content !== undefined) {
+      source.content = source.content.replace(/\$MainStorage_\d{1,6};/g, '$MainStorage_random;');
+    }
+  }
+}
+
+async function hardhatCompile(input: SolcInput, solcVersion: string): Promise<SolcOutput> {
+  const solcBuild: SolcBuild = await run(TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD, {
+    quiet: true,
+    solcVersion,
+  });
+
+  if (solcBuild.isSolcJs) {
+    return await run(TASK_COMPILE_SOLIDITY_RUN_SOLCJS, {
+      input,
+      solcJsPath: solcBuild.compilerPath,
+    });
+  } else {
+    return await run(TASK_COMPILE_SOLIDITY_RUN_SOLC, {
+      input,
+      solcPath: solcBuild.compilerPath,
+    });
+  }
+}

package/src/utils/make-namespaced.test.ts.md

@@ -0,0 +1,154 @@
+# Snapshot report for `src/utils/make-namespaced.test.ts`
+
+The actual snapshot is saved in `make-namespaced.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## make namespaced input
+
+> Snapshot 1
+
+    {
+      language: 'Solidity',
+      settings: {
+        optimizer: {
+          enabled: true,
+          runs: 200,
+        },
+        outputSelection: {
+          '*': {
+            '': [
+              'ast',
+            ],
+            '*': [
+              'storageLayout',
+            ],
+          },
+        },
+      },
+      sources: {
+        'contracts/test/NamespacedToModify.sol': {
+          content: `// SPDX-License-Identifier: MIT␊
+          pragma solidity ^0.8.20;␊
+          ␊
+          contract Example {␊
+              /// @custom:storage-location erc7201:example.main␊
+              struct MainStorage {␊
+                  uint256 x;␊
+                  uint256 y;␊
+              } MainStorage $MainStorage_random;␊
+          ␊
+              ␊
+              ␊
+          ␊
+              ␊
+              ␊
+          ␊
+              ␊
+              ␊
+              struct MyStruct { uint b; }␊
+          ␊
+              // keccak256(abi.encode(uint256(keccak256("example.main")) - 1)) & ~bytes32(uint256(0xff));␊
+              ␊
+          ␊
+              ␊
+          ␊
+              ␊
+          ␊
+              /// @notice standlone natspec␊
+          ␊
+              ␊
+              ␊
+          ␊
+              // standalone doc␊
+          ␊
+              /**␊
+               * standlone doc block␊
+               */␊
+          ␊
+              ␊
+              ␊
+          ␊
+              ␊
+              ␊
+          }␊
+          ␊
+          contract HasFunction {␊
+            ␊
+            ␊
+          }␊
+          ␊
+          contract UsingFunction is HasFunction {␊
+            ␊
+          }␊
+          ␊
+          uint256 constant FreeFunctionUsingSelector = 0;␊
+          ␊
+          uint256 constant CONSTANT_USING_SELECTOR = 0;␊
+          ␊
+          library Lib {␊
+            ␊
+          ␊
+            ␊
+          }␊
+          ␊
+          contract Consumer {␊
+            ␊
+          ␊
+            ␊
+          ␊
+            ␊
+          }␊
+          ␊
+          uint256 constant plusTwo = 0;␊
+          ␊
+          ␊
+          ␊
+          contract UsingForDirectives {␊
+            ␊
+          ␊
+            ␊
+          }`,
+        },
+      },
+    }
+
+## make namespaced input - solc 0.7
+
+> Snapshot 1
+
+    {
+      language: 'Solidity',
+      settings: {
+        optimizer: {
+          enabled: true,
+          runs: 200,
+        },
+        outputSelection: {
+          '*': {
+            '': [
+              'ast',
+            ],
+            '*': [
+              'storageLayout',
+            ],
+          },
+        },
+      },
+      sources: {
+        'contracts/test/NamespacedToModify07.sol': {
+          content: `// SPDX-License-Identifier: MIT␊
+          pragma solidity 0.7.6;␊
+           ␊
+          contract HasFunction {␊
+            ␊
+            ␊
+          }␊
+          ␊
+          contract UsingFunction is HasFunction {␊
+            ␊
+          }␊
+          `,
+        },
+      },
+    }