@openzeppelin/upgrades-core 1.31.2 → 1.32.0-alpha.0

package/dist/utils/make-namespaced.test.js

@@ -8,7 +8,7 @@ const hardhat_1 = require("hardhat");
 const task_names_1 = require("hardhat/builtin-tasks/task-names");
 const make_namespaced_1 = require("./make-namespaced");
 (0, ava_1.default)('make namespaced input', async (t) => {
-    const origBuildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/NamespacedToModify.sol:Example');
+    const origBuildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/NamespacedToModifyImported.sol:Example');
     await testMakeNamespaced(origBuildInfo, t, '0.8.20');
 });
 (0, ava_1.default)('make namespaced input - solc 0.7', async (t) => {
@@ -23,20 +23,21 @@ async function testMakeNamespaced(origBuildInfo, t, solcVersion) {
     // 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 = (0, make_namespaced_1.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);
+    normalizeIdentifiers(modifiedInput);
+    t.snapshot(modifiedInput);
+    t.deepEqual(origBuildInfo.input, origInput);
+    t.notDeepEqual(modifiedInput, origInput);
 }
-function normalizeStateVariableNames(input) {
+function normalizeIdentifiers(input) {
     for (const source of Object.values(input.sources)) {
         if (source.content !== undefined) {
             source.content = source.content
-                .replace(/\$MainStorage_\d{1,6};/g, '$MainStorage_random;')
-                .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random');
+                .replace(/\$MainStorage_\d{1,6}/g, '$MainStorage_random')
+                .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random')
+                .replace(/\$astId_\d+_\d{1,6}/g, '$astId_id_random');
         }
     }
 }

package/dist/utils/make-namespaced.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"make-namespaced.test.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA6C;AAC7C,qCAAyC;AACzC,iEAI0C;AAE1C,uDAAwD;AAKxD,IAAA,aAAI,EAAC,uBAAuB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACtC,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,+CAA+C,CAAC,CAAC;IACpG,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,kCAAkC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjD,6JAA6J;IAC7J,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,qDAAqD,CAAC,CAAC;IAC1G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,kBAAkB,CAC/B,aAAoC,EACpC,CAA4B,EAC5B,WAAmB;IAEnB,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IAED,2FAA2F;IAC3F,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,IAAA,qCAAmB,EAAC,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACrF,2BAA2B,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAE1B,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAEzC,2EAA2E;IAC3E,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACxE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,2BAA2B,CAAC,KAAgB;IACnD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;QACjD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE;YAChC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;iBAC5B,OAAO,CAAC,yBAAyB,EAAE,sBAAsB,CAAC;iBAC1D,OAAO,CAAC,6BAA6B,EAAE,0BAA0B,CAAC,CAAC;SACvE;KACF;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,KAAgB,EAAE,WAAmB;IACjE,MAAM,SAAS,GAAc,MAAM,IAAA,aAAG,EAAC,iDAAoC,EAAE;QAC3E,KAAK,EAAE,IAAI;QACX,WAAW;KACZ,CAAC,CAAC;IAEH,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,OAAO,MAAM,IAAA,aAAG,EAAC,6CAAgC,EAAE;YACjD,KAAK;YACL,UAAU,EAAE,SAAS,CAAC,YAAY;SACnC,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,MAAM,IAAA,aAAG,EAAC,2CAA8B,EAAE;YAC/C,KAAK;YACL,QAAQ,EAAE,SAAS,CAAC,YAAY;SACjC,CAAC,CAAC;KACJ;AACH,CAAC"}
+{"version":3,"file":"make-namespaced.test.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAA6C;AAC7C,qCAAyC;AACzC,iEAI0C;AAE1C,uDAAwD;AAKxD,IAAA,aAAI,EAAC,uBAAuB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACtC,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,uDAAuD,CAAC,CAAC;IAC5G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,kCAAkC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjD,6JAA6J;IAC7J,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,qDAAqD,CAAC,CAAC;IAC1G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,kBAAkB,CAC/B,aAAoC,EACpC,CAA4B,EAC5B,WAAmB;IAEnB,IAAI,aAAa,KAAK,SAAS,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IAED,2FAA2F;IAC3F,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,IAAA,qCAAmB,EAAC,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAErF,2EAA2E;IAC3E,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACxE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEvC,oBAAoB,CAAC,aAAa,CAAC,CAAC;IACpC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAE1B,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAgB;IAC5C,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;QACjD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE;YAChC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;iBAC5B,OAAO,CAAC,wBAAwB,EAAE,qBAAqB,CAAC;iBACxD,OAAO,CAAC,6BAA6B,EAAE,0BAA0B,CAAC;iBAClE,OAAO,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;SACxD;KACF;AACH,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,KAAgB,EAAE,WAAmB;IACjE,MAAM,SAAS,GAAc,MAAM,IAAA,aAAG,EAAC,iDAAoC,EAAE;QAC3E,KAAK,EAAE,IAAI;QACX,WAAW;KACZ,CAAC,CAAC;IAEH,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,OAAO,MAAM,IAAA,aAAG,EAAC,6CAAgC,EAAE;YACjD,KAAK;YACL,UAAU,EAAE,SAAS,CAAC,YAAY;SACnC,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,MAAM,IAAA,aAAG,EAAC,2CAA8B,EAAE;YAC/C,KAAK;YACL,QAAQ,EAAE,SAAS,CAAC,YAAY;SACjC,CAAC,CAAC;KACJ;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.31.2",
+  "version": "1.32.0-alpha.0",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -13,22 +13,29 @@
     "/artifacts/contracts/proxy/AdminUpgradeabilityProxy.sol/AdminUpgradeabilityProxy.json",
     "/artifacts/contracts/proxy/ProxyAdmin.sol/ProxyAdmin.json",
     "/contracts/Initializable.sol",
-    "/artifacts/@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol",
-    "/artifacts/@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol",
-    "/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol",
+    "/artifacts/@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol/BeaconProxy.json",
+    "/artifacts/@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol/UpgradeableBeacon.json",
+    "/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol/ERC1967Proxy.json",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol/ProxyAdmin.json",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/ITransparentUpgradeableProxy.json",
-    "/artifacts/build-info.json"
+    "/artifacts/build-info.json",
+    "/artifacts/@openzeppelin/contracts-v5/proxy/beacon/BeaconProxy.sol/BeaconProxy.json",
+    "/artifacts/@openzeppelin/contracts-v5/proxy/beacon/UpgradeableBeacon.sol/UpgradeableBeacon.json",
+    "/artifacts/@openzeppelin/contracts-v5/proxy/ERC1967/ERC1967Proxy.sol/ERC1967Proxy.json",
+    "/artifacts/@openzeppelin/contracts-v5/proxy/transparent/ProxyAdmin.sol/ProxyAdmin.json",
+    "/artifacts/@openzeppelin/contracts-v5/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json",
+    "/artifacts/@openzeppelin/contracts-v5/proxy/transparent/TransparentUpgradeableProxy.sol/ITransparentUpgradeableProxy.json",
+    "/artifacts/build-info-v5.json"
   ],
   "scripts": {
     "clean": "hardhat clean && rimraf dist *.tsbuildinfo",
     "compile": "tsc -b && yarn compile:contracts",
-    "compile:contracts": "hardhat compile && node scripts/copy-build-info.js",
-    "prepare": "yarn clean && yarn compile",
-    "prepublishOnly": "bash scripts/copy-artifacts.sh",
-    "test": "tsc -b && hardhat compile --force && node scripts/copy-build-info.js && ava",
-    "test:watch": "hardhat compile --force && fgbg 'ava --watch' 'tsc -b --watch' --",
+    "compile:contracts": "hardhat compile",
+    "copyfiles": "node scripts/copy-build-info-v5.js && bash scripts/copy-legacy-artifacts.sh",
+    "prepare": "yarn clean && yarn compile && yarn copyfiles",
+    "test": "tsc -b && hardhat compile --force && yarn copyfiles && ava",
+    "test:watch": "hardhat compile --force && yarn copyfiles && fgbg 'ava --watch' 'tsc -b --watch' --",
     "version": "node ../../scripts/bump-changelog.js",
     "cli": "node ./dist/cli/cli.js"
   },
@@ -38,8 +45,8 @@
   "devDependencies": {
     "@ava/typescript": "^4.0.0",
     "@nomicfoundation/hardhat-ethers": "^3.0.5",
-    "@openzeppelin/contracts": "4.8.3",
-    "@openzeppelin/contracts-upgradeable": "4.8.3",
+    "@openzeppelin/contracts": "5.0.0",
+    "@openzeppelin/upgrades-core-legacy": "npm:@openzeppelin/upgrades-core@1.31.3",
     "@types/cbor": "^5.0.0",
     "@types/debug": "^4.1.5",
     "@types/mocha": "^7.0.2",
@@ -64,5 +71,5 @@
     "proper-lockfile": "^4.1.1",
     "solidity-ast": "^0.4.51"
   },
-  "gitHead": "6614824fca753f8fb853b48cfc722685e832a1b9"
+  "gitHead": "7fd74e339fe760d23aea5cc0bbf6bac525323ab4"
 }

package/src/index.ts

@@ -53,6 +53,7 @@ export {
   NoContractImportError,
   ValidateUpdateRequiresKindError,
   PrepareUpgradeRequiresKindError,
+  InitialOwnerUnsupportedKindError,
   assertNotProxy,
 } from './usage-error';
 

package/src/solidity-version.json

@@ -0,0 +1 @@
+"0.8.20"

package/src/standalone.test.ts

@@ -1,6 +1,8 @@
 import _test, { TestFn } from 'ava';
 import { artifacts } from 'hardhat';
 
+import SOLIDITY_VERSION from './solidity-version.json';
+
 import { SolcInput, SolcOutput } from './solc-api';
 import { UpgradeableContract } from './standalone';
 
@@ -21,7 +23,7 @@ test.before(async t => {
 });
 
 test('reports unsafe operation', t => {
-  const impl = new UpgradeableContract('StandaloneV1', t.context.solcInput, t.context.solcOutput);
+  const impl = new UpgradeableContract('StandaloneV1', t.context.solcInput, t.context.solcOutput, {}, SOLIDITY_VERSION);
   const report = impl.getErrorReport();
   t.false(report.ok);
   t.true(report.errors[0].kind === 'delegatecall');
@@ -32,6 +34,8 @@ test('reports unsafe operation - fully qualified name', t => {
     'contracts/test/Standalone.sol:StandaloneV1',
     t.context.solcInput,
     t.context.solcOutput,
+    {},
+    SOLIDITY_VERSION,
   );
   const report = impl.getErrorReport();
   t.false(report.ok);
@@ -39,25 +43,55 @@ test('reports unsafe operation - fully qualified name', t => {
 });
 
 test('reports storage upgrade errors', t => {
-  const v1 = new UpgradeableContract('StandaloneV1', t.context.solcInput, t.context.solcOutput);
+  const v1 = new UpgradeableContract('StandaloneV1', t.context.solcInput, t.context.solcOutput, {}, SOLIDITY_VERSION);
 
-  const v2Good = new UpgradeableContract('StandaloneV2Good', t.context.solcInput, t.context.solcOutput);
+  const v2Good = new UpgradeableContract(
+    'StandaloneV2Good',
+    t.context.solcInput,
+    t.context.solcOutput,
+    {},
+    SOLIDITY_VERSION,
+  );
   const goodReport = v1.getStorageUpgradeReport(v2Good);
   t.true(goodReport.ok);
 
-  const v2Bad = new UpgradeableContract('StandaloneV2Bad', t.context.solcInput, t.context.solcOutput);
+  const v2Bad = new UpgradeableContract(
+    'StandaloneV2Bad',
+    t.context.solcInput,
+    t.context.solcOutput,
+    {},
+    SOLIDITY_VERSION,
+  );
   const badReport = v1.getStorageUpgradeReport(v2Bad);
   t.false(badReport.ok);
 });
 
 test('dont report renamed version update', t => {
-  const v1 = new UpgradeableContract('StandaloneRenameV1', t.context.solcInput, t.context.solcOutput);
+  const v1 = new UpgradeableContract(
+    'StandaloneRenameV1',
+    t.context.solcInput,
+    t.context.solcOutput,
+    {},
+    SOLIDITY_VERSION,
+  );
 
-  const v2 = new UpgradeableContract('StandaloneRenameV2', t.context.solcInput, t.context.solcOutput);
+  const v2 = new UpgradeableContract(
+    'StandaloneRenameV2',
+    t.context.solcInput,
+    t.context.solcOutput,
+    {},
+    SOLIDITY_VERSION,
+  );
   const goodReport = v1.getStorageUpgradeReport(v2);
   t.true(goodReport.ok);
 
-  const v3 = new UpgradeableContract('StandaloneRenameV3', t.context.solcInput, t.context.solcOutput);
+  const v3 = new UpgradeableContract(
+    'StandaloneRenameV3',
+    t.context.solcInput,
+    t.context.solcOutput,
+    {},
+    SOLIDITY_VERSION,
+  );
   const goodReport2 = v2.getStorageUpgradeReport(v3);
   t.true(goodReport2.ok);
 });

package/src/usage-error.ts

@@ -95,6 +95,15 @@ export class PrepareUpgradeRequiresKindError extends UpgradesError {
   }
 }
 
+export class InitialOwnerUnsupportedKindError extends UpgradesError {
+  constructor(kind: string) {
+    super(
+      `The \`initialOwner\` option is not supported for this kind of proxy ('${kind}')`,
+      () => `Set the initial owner as part of your contract's initializer arguments instead.`,
+    );
+  }
+}
+
 export async function assertNotProxy(provider: EthereumProvider, address: string) {
   if (await isTransparentOrUUPSProxy(provider, address)) {
     throw new UpgradesError(

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

@@ -12,7 +12,7 @@ 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');
+  const origBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedToModifyImported.sol:Example');
   await testMakeNamespaced(origBuildInfo, t, '0.8.20');
 });
 
@@ -35,23 +35,25 @@ async function testMakeNamespaced(
   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);
+
+  normalizeIdentifiers(modifiedInput);
+  t.snapshot(modifiedInput);
+
+  t.deepEqual(origBuildInfo.input, origInput);
+  t.notDeepEqual(modifiedInput, origInput);
 }
 
-function normalizeStateVariableNames(input: SolcInput): void {
+function normalizeIdentifiers(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;')
-        .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random');
+        .replace(/\$MainStorage_\d{1,6}/g, '$MainStorage_random')
+        .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random')
+        .replace(/\$astId_\d+_\d{1,6}/g, '$astId_id_random');
     }
   }
 }

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

@@ -45,27 +45,27 @@ Generated by [AVA](https://avajs.dev).
                   uint256 b;␊
               } SecondaryStorage $SecondaryStorage_random;␊
           ␊
-              ␊
-              ␊
+              /// @notice some natspec␊
+              enum $astId_id_random { dummy }␊
           ␊
-              ␊
-              ␊
+              /// @param a docs␊
+              enum $astId_id_random { dummy }␊
           ␊
-              ␊
-              ␊
+              /// @param a docs␊
+              enum $astId_id_random { dummy }␊
               struct MyStruct { uint b; }␊
           ␊
               // keccak256(abi.encode(uint256(keccak256("example.main")) - 1)) & ~bytes32(uint256(0xff));␊
-              ␊
+              enum $astId_id_random { dummy }␊
           ␊
-              ␊
+              enum $astId_id_random { dummy }␊
           ␊
-              ␊
+              enum $astId_id_random { dummy }␊
           ␊
               /// @notice standlone natspec␊
           ␊
-              ␊
-              ␊
+              /// @notice natspec for var␊
+              enum $astId_id_random { dummy }␊
           ␊
               // standalone doc␊
           ␊
@@ -73,49 +73,114 @@ Generated by [AVA](https://avajs.dev).
                * standlone doc block␊
                */␊
           ␊
-              ␊
-              ␊
+              /**␊
+               * doc block without natspec␊
+               */␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              /**␊
+               * doc block with natspec␊
+               *␊
+               * @notice some natspec␊
+               */␊
+              enum $astId_id_random { dummy }␊
           ␊
-              ␊
-              ␊
+              /**␊
+               * @dev a custom error inside a contract␊
+               */␊
+              enum $astId_id_random { dummy }␊
           }␊
           ␊
           contract HasFunction {␊
-            ␊
-            ␊
+            enum $astId_id_random { dummy }␊
+            enum $astId_id_random { dummy }␊
           }␊
           ␊
           contract UsingFunction is HasFunction {␊
-            ␊
+            enum $astId_id_random { dummy }␊
           }␊
           ␊
-          uint256 constant FreeFunctionUsingSelector = 0;␊
+          enum FreeFunctionUsingSelector { dummy }␊
           ␊
-          uint256 constant CONSTANT_USING_SELECTOR = 0;␊
+          enum CONSTANT_USING_SELECTOR { dummy }␊
           ␊
           library Lib {␊
-            ␊
+            enum $astId_id_random { dummy }␊
           ␊
-            ␊
+            enum $astId_id_random { dummy }␊
           }␊
           ␊
           contract Consumer {␊
-            ␊
+            enum $astId_id_random { dummy }␊
+          ␊
+            enum $astId_id_random { dummy }␊
           ␊
-            ␊
+            enum $astId_id_random { dummy }␊
           ␊
-            ␊
+            enum $astId_id_random { dummy }␊
           }␊
           ␊
-          uint256 constant plusTwo = 0;␊
+          enum plusTwo { dummy }␊
+          ␊
+          /**␊
+           * @notice originally orphaned natspec␊
+           */␊
+          ␊
+          /**␊
+           * @dev plusThree␊
+           * @param x x␊
+           */␊
+          enum plusThree { dummy }␊
+          ␊
+          /// @notice originally orphaned natspec 2␊
           ␊
+          /**␊
+           * @dev plusThree overloaded␊
+           * @param x x␊
+           * @param y y␊
+           */␊
+          enum $astId_id_random { dummy }␊
           ␊
+          enum originallyNoDocumentation { dummy }␊
+          ␊
+          /**␊
+           * @param foo foo␊
+           */␊
+          enum $astId_id_random { dummy }␊
           ␊
           contract UsingForDirectives {␊
-            ␊
+            enum $astId_id_random { dummy }␊
+          ␊
+            enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          /**␊
+           * @title a␊
+           * @author a␊
+           * @inheritdoc Example␊
+           * @dev a␊
+           * @custom:a a␊
+           * @notice a␊
+           * @param a a␊
+           * @return a a␊
+           */␊
+          enum FreeEnum { MyEnum }␊
+          ␊
+          /**␊
+           * @dev a custom error outside a contract␊
+           * @param example example parameter␊
+           */␊
+          enum CustomErrorOutsideContract { dummy }␊
+          `,
+        },
+        'contracts/test/NamespacedToModifyImported.sol': {
+          content: `// SPDX-License-Identifier: MIT␊
+          pragma solidity ^0.8.20;␊
           ␊
-            ␊
-          }`,
+          import {CONSTANT_USING_SELECTOR, plusTwo, plusThree, CustomErrorOutsideContract} from "./NamespacedToModify.sol";␊
+          ␊
+          contract Example {}␊
+          `,
         },
       },
     }
@@ -148,12 +213,12 @@ Generated by [AVA](https://avajs.dev).
           pragma solidity 0.7.6;␊
            ␊
           contract HasFunction {␊
-            ␊
-            ␊
+            enum $astId_id_random { dummy }␊
+            enum $astId_id_random { dummy }␊
           }␊
           ␊
           contract UsingFunction is HasFunction {␊
-            ␊
+            enum $astId_id_random { dummy }␊
           }␊
           `,
         },

package/src/utils/make-namespaced.ts

@@ -17,10 +17,9 @@ const OUTPUT_SELECTION = {
  *
  * This makes the following modifications to the input:
  * - Adds a state variable for each namespaced struct definition
- * - Deletes all contracts' functions since they are not needed for storage layout
- * - Deletes all contracts' modifiers, variables, and parent constructor invocations to avoid compilation errors due to deleted functions and constructors
- * - Deletes all using for directives (at file level and in contracts) since they may reference deleted functions
- * - Converts all free functions and constants (at file level) to dummy variables (do not delete them since they might be imported by other files)
+ * - For each contract, for all node types that are not needed for storage layout or may reference deleted functions and constructors, converts them to dummy enums with random id
+ * - Converts all using for directives (at file level and in contracts) to dummy enums with random id (do not delete them to avoid orphaning possible NatSpec documentation)
+ * - Converts all custom errors, free functions and constants (at file level) to dummy enums with the same name (do not delete them since they might be imported by other files)
  *
  * Also sets the outputSelection to only include storageLayout and ast, since the other outputs are not needed.
  *
@@ -41,55 +40,95 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcI
 
     const orig = Buffer.from(source.content, 'utf8');
 
+    const replacedIdentifiers = new Set<string>();
     const modifications: Modification[] = [];
 
     for (const node of output.sources[sourcePath].ast.nodes) {
-      if (isNodeType('ContractDefinition', node)) {
-        const contractDef = node;
-
-        // Remove any calls to parent constructors from the inheritance list
-        const inherits = contractDef.baseContracts;
-        for (const inherit of inherits) {
-          if (Array.isArray(inherit.arguments)) {
-            assert(inherit.baseName.name !== undefined);
-            modifications.push(makeReplace(inherit, orig, inherit.baseName.name));
+      switch (node.nodeType) {
+        case 'ContractDefinition': {
+          const contractDef = node;
+
+          // Remove any calls to parent constructors from the inheritance list
+          const inherits = contractDef.baseContracts;
+          for (const inherit of inherits) {
+            if (Array.isArray(inherit.arguments)) {
+              assert(inherit.baseName.name !== undefined);
+              modifications.push(makeReplace(inherit, orig, inherit.baseName.name));
+            }
           }
-        }
 
-        const contractNodes = contractDef.nodes;
-        for (const contractNode of contractNodes) {
-          if (
-            isNodeType('FunctionDefinition', contractNode) ||
-            isNodeType('ModifierDefinition', contractNode) ||
-            isNodeType('VariableDeclaration', contractNode)
-          ) {
-            if (contractNode.documentation) {
-              modifications.push(makeDelete(contractNode.documentation, orig));
-            }
-            modifications.push(makeDelete(contractNode, orig));
-          } else if (isNodeType('UsingForDirective', contractNode)) {
-            modifications.push(makeDelete(contractNode, orig));
-          } else if (isNodeType('StructDefinition', contractNode)) {
-            const storageLocation = getStorageLocationAnnotation(contractNode);
-            if (storageLocation !== undefined) {
-              const structName = contractNode.name;
-              const variableName = `$${structName}_${(Math.random() * 1e6).toFixed(0)}`;
-              const insertText = ` ${structName} ${variableName};`;
-
-              modifications.push(makeInsertAfter(contractNode, insertText));
+          const contractNodes = contractDef.nodes;
+          for (const contractNode of contractNodes) {
+            switch (contractNode.nodeType) {
+              case 'ErrorDefinition':
+              case 'EventDefinition':
+              case 'FunctionDefinition':
+              case 'ModifierDefinition':
+              case 'UsingForDirective':
+              case 'VariableDeclaration': {
+                // Replace with an enum based on astId (the original name is not needed, since nothing should reference it)
+                modifications.push(makeReplace(contractNode, orig, toDummyEnumWithAstId(contractNode.id)));
+                break;
+              }
+              case 'StructDefinition': {
+                const storageLocation = getStorageLocationAnnotation(contractNode);
+                if (storageLocation !== undefined) {
+                  const structName = contractNode.name;
+                  const variableName = `$${structName}_${(Math.random() * 1e6).toFixed(0)}`;
+                  const insertText = ` ${structName} ${variableName};`;
+
+                  modifications.push(makeInsertAfter(contractNode, insertText));
+                }
+                break;
+              }
+              case 'EnumDefinition':
+              case 'UserDefinedValueTypeDefinition':
+              default: {
+                // - EnumDefinition may be used in structures with storage locations
+                // - UserDefinedValueTypeDefinition may be used in structures with storage locations
+                // - default: in case unexpected ast nodes show up
+                break;
+              }
             }
           }
+          break;
+        }
+
+        // - UsingForDirective isn't needed, but it might have NatSpec documentation which is not included in the AST.
+        //   We convert it to a dummy enum to avoid orphaning any possible documentation.
+        // - ErrorDefinition, FunctionDefinition, and VariableDeclaration might be imported by other files, so they cannot be deleted.
+        //   However, we need to remove their values to avoid referencing other deleted nodes.
+        //   We do this by converting them to dummy enums, but avoiding duplicate names.
+        case 'UsingForDirective':
+        case 'ErrorDefinition':
+        case 'FunctionDefinition':
+        case 'VariableDeclaration': {
+          // If an identifier with the same name was not previously written, replace with a dummy enum using its name.
+          // Otherwise replace with an enum based on astId to avoid duplicate names, which can happen if there was overloading.
+          // This does not need to check all identifiers from the original contract, since the original compilation
+          // should have failed if there were conflicts in the first place.
+          if ('name' in node && !replacedIdentifiers.has(node.name)) {
+            modifications.push(makeReplace(node, orig, toDummyEnumWithName(node.name)));
+            replacedIdentifiers.add(node.name);
+          } else {
+            modifications.push(makeReplace(node, orig, toDummyEnumWithAstId(node.id)));
+          }
+          break;
         }
-      } else if (isNodeType('FunctionDefinition', node) || isNodeType('VariableDeclaration', node)) {
-        if (node.documentation) {
-          modifications.push(makeDelete(node.documentation, orig));
+        case 'EnumDefinition':
+        case 'ImportDirective':
+        case 'PragmaDirective':
+        case 'StructDefinition':
+        case 'UserDefinedValueTypeDefinition':
+        default: {
+          // - EnumDefinition may be used in structures with storage locations
+          // - ImportDirective may import types used in structures with storage locations
+          // - PragmaDirective is necessary for compilation
+          // - StructDefinition may be used in structures with storage locations
+          // - UserDefinedValueTypeDefinition may be used in structures with storage locations
+          // - default: in case unexpected ast nodes show up (file-level events since 0.8.22)
+          break;
         }
-        // Replace with a dummy variable of arbitrary type
-        const name = node.name;
-        const insertText = `uint256 constant ${name} = 0;`;
-        modifications.push(makeReplace(node, orig, insertText));
-      } else if (isNodeType('UsingForDirective', node)) {
-        modifications.push(makeDelete(node, orig));
       }
     }
 
@@ -105,6 +144,14 @@ interface Modification {
   text?: string;
 }
 
+function toDummyEnumWithName(name: string) {
+  return `enum ${name} { dummy }`;
+}
+
+function toDummyEnumWithAstId(astId: number) {
+  return `enum $astId_${astId}_${(Math.random() * 1e6).toFixed(0)} { dummy }`;
+}
+
 function getPositions(node: Node) {
   const [start, length] = node.src.split(':').map(Number);
   const end = start + length;

package/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol/ERC1967Proxy.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/966b1f437e942115ba46359eb293018c.json"
-}

package/artifacts/@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol/BeaconProxy.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/966b1f437e942115ba46359eb293018c.json"
-}

package/artifacts/@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol/UpgradeableBeacon.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/966b1f437e942115ba46359eb293018c.json"
-}