npm - @openzeppelin/upgrades-core - Versions diffs - 1.34.4 → 1.35.1 - Mend

@openzeppelin/upgrades-core 1.34.4 → 1.35.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

package/CHANGELOG.md +9 -0
package/dist/utils/make-namespaced.d.ts +8 -3
package/dist/utils/make-namespaced.d.ts.map +1 -1
package/dist/utils/make-namespaced.js +92 -17
package/dist/utils/make-namespaced.js.map +1 -1
package/dist/utils/make-namespaced.test.js +7 -2
package/dist/utils/make-namespaced.test.js.map +1 -1
package/dist/utils/slang/trivia.d.ts +9 -0
package/dist/utils/slang/trivia.d.ts.map +1 -0
package/dist/utils/slang/trivia.js +23 -0
package/dist/utils/slang/trivia.js.map +1 -0
package/package.json +2 -1
package/src/utils/make-namespaced.test.ts +12 -1
package/src/utils/make-namespaced.test.ts.md +309 -16
package/src/utils/make-namespaced.test.ts.snap +0 -0
package/src/utils/make-namespaced.ts +111 -24
package/src/utils/slang/trivia.ts +23 -0

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,14 @@
 # Changelog
+## 1.35.1 (2024-08-13)
+- Fix Hardhat compile error when `fallback` or `receive` functions are present. ([#1060](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1060))
+## 1.35.0 (2024-07-31)
+- Fix Hardhat compile error when public variables are used to implement interface functions. ([#1055](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1055))
+- Remove non-struct NatSpec from Hardhat compilation step for namespaced storage layout validations. ([#1051](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1051))
 ## 1.34.4 (2024-07-22)
 - Fix Hardhat compile error when return parameter names are documented as param. ([#1050](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1050))

package/dist/utils/make-namespaced.d.ts CHANGED Viewed

@@ -5,15 +5,20 @@ import { SolcInput, SolcOutput } from '../solc-api';
  *
  * This makes the following modifications to the input:
  * - Adds a state variable for each namespaced struct definition
- * - 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
+ * - For each contract, for all node types that are not needed for storage layout or may call 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)
+ * - Converts all custom errors and constants (at file level) to dummy enums with the same name (do not delete them since they might be imported by other files)
+ * - Replaces functions as follows:
+ *   - For regular function and free function, keep declarations since they may be referenced by constants (free functions may also be imported by other files). But simplify compilation by removing modifiers and body, and replace return parameters with bools which can be default initialized.
+ *   - Constructors are not needed, since we removed anything that may call constructors. Convert to dummy enums to avoid orphaning possible NatSpec.
+ *   - Fallback and receive functions are not needed, since they don't have signatures. Convert to dummy enums to avoid orphaning possible NatSpec.
  *
  * Also sets the outputSelection to only include storageLayout and ast, since the other outputs are not needed.
  *
  * @param input The original solc input.
  * @param output The original solc output.
+ * @param solcVersion The version of the solc compiler that was originally used to compile the input.
  * @returns The modified solc input with storage layout that includes namespaced type information.
  */
-export declare function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcInput;
+export declare function makeNamespacedInput(input: SolcInput, output: SolcOutput, solcVersion?: string): SolcInput;
 //# sourceMappingURL=make-namespaced.d.ts.map

package/dist/utils/make-namespaced.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"make-namespaced.d.ts","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAYpD~~;;;;;;;;;;;;;;;GAeG~~;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,GAAG,SAAS,~~CAwHnF~~"}
1	+ {"version":3,"file":"make-namespaced.d.ts","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAYpD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAgIzG"}

package/dist/utils/make-namespaced.js CHANGED Viewed

@@ -16,17 +16,22 @@ const OUTPUT_SELECTION = {
  *
  * This makes the following modifications to the input:
  * - Adds a state variable for each namespaced struct definition
- * - 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
+ * - For each contract, for all node types that are not needed for storage layout or may call 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)
+ * - Converts all custom errors and constants (at file level) to dummy enums with the same name (do not delete them since they might be imported by other files)
+ * - Replaces functions as follows:
+ *   - For regular function and free function, keep declarations since they may be referenced by constants (free functions may also be imported by other files). But simplify compilation by removing modifiers and body, and replace return parameters with bools which can be default initialized.
+ *   - Constructors are not needed, since we removed anything that may call constructors. Convert to dummy enums to avoid orphaning possible NatSpec.
+ *   - Fallback and receive functions are not needed, since they don't have signatures. Convert to dummy enums to avoid orphaning possible NatSpec.
  *
  * Also sets the outputSelection to only include storageLayout and ast, since the other outputs are not needed.
  *
  * @param input The original solc input.
  * @param output The original solc output.
+ * @param solcVersion The version of the solc compiler that was originally used to compile the input.
  * @returns The modified solc input with storage layout that includes namespaced type information.
  */
-function makeNamespacedInput(input, output) {
+function makeNamespacedInput(input, output, solcVersion) {
     const modifiedSources = {};
     for (const [sourcePath] of Object.entries(input.sources)) {
         const source = input.sources[sourcePath];
@@ -40,6 +45,11 @@ function makeNamespacedInput(input, output) {
             switch (node.nodeType) {
                 case 'ContractDefinition': {
                     const contractDef = node;
+                    // Mark contracts as abstract, since state variables are converted to dummy enums
+                    // which would not generate public getters for inherited interface functions
+                    if (contractDef.contractKind === 'contract' && !contractDef.abstract) {
+                        modifications.push(makeInsertBefore(contractDef, 'abstract '));
+                    }
                     // Remove any calls to parent constructors from the inheritance list
                     const inherits = contractDef.baseContracts;
                     for (const inherit of inherits) {
@@ -131,10 +141,59 @@ function makeNamespacedInput(input, output) {
                 }
             }
         }
-        modifiedSources[sourcePath] = { ...source, content: getModifiedSource(orig, modifications) };
+        const modifiedSource = tryRemoveNonStructNatSpec(getModifiedSource(orig, modifications), solcVersion);
+        modifiedSources[sourcePath] = { ...source, content: modifiedSource };
     }
     return { ...input, sources: modifiedSources, settings: { ...input.settings, outputSelection: OUTPUT_SELECTION } };
 }
+/**
+ * If Slang is supported for the current platform and we have the compiler version available,
+ * use Slang to parse and remove all NatSpec comments that do not precede a struct definition and return the modified content.
+ *
+ * Otherwise, return the original content.
+ */
+function tryRemoveNonStructNatSpec(origContent, solcVersion) {
+    const natSpecRemovals = [];
+    if (solcVersion !== undefined && tryRequire('@nomicfoundation/slang')) {
+        /* eslint-disable @typescript-eslint/no-var-requires */
+        const { Language } = require('@nomicfoundation/slang/language');
+        const { NonterminalKind, TerminalKind } = require('@nomicfoundation/slang/kinds');
+        const { TerminalNode } = require('@nomicfoundation/slang/cst');
+        const { isTrivia } = require('./slang/trivia');
+        /* eslint-enable @typescript-eslint/no-var-requires */
+        const language = new Language(solcVersion);
+        const parseOutput = language.parse(NonterminalKind.SourceUnit, origContent);
+        const cursor = parseOutput.createTreeCursor();
+        while (cursor.goToNextTerminalWithKinds([TerminalKind.MultiLineNatSpecComment, TerminalKind.SingleLineNatSpecComment])) {
+            // Lookahead to determine if the next non-trivia node is the struct keyword.
+            // If so, this NatSpec is part of the struct definition and should not be removed.
+            const lookaheadCursor = cursor.clone();
+            while (lookaheadCursor.goToNextTerminal() && isTrivia(lookaheadCursor.node())) {
+                // skip over trivia nodes
+            }
+            if (lookaheadCursor.node().kind === TerminalKind.StructKeyword) {
+                continue;
+            }
+            const triviaNode = cursor.node();
+            (0, assert_1.assert)(triviaNode instanceof TerminalNode);
+            natSpecRemovals.push(makeDeleteRange(cursor.textRange.start.utf8, cursor.textRange.end.utf8));
+        }
+        return getModifiedSource(Buffer.from(origContent, 'utf8'), natSpecRemovals);
+    }
+    else {
+        return origContent;
+    }
+}
+function tryRequire(id) {
+    try {
+        require(id);
+        return true;
+    }
+    catch (e) {
+        // do nothing
+    }
+    return false;
+}
 function toDummyEnumWithName(name) {
     return `enum ${name} { dummy }`;
 }
@@ -142,21 +201,30 @@ function toDummyEnumWithAstId(astId) {
     return `enum $astId_${astId}_${(Math.random() * 1e6).toFixed(0)} { dummy }`;
 }
 function replaceFunction(node, orig, modifications) {
-    if (node.kind === 'constructor') {
-        modifications.push(makeDelete(node, orig));
-    }
-    else {
-        if (node.modifiers.length > 0) {
-            for (const modifier of node.modifiers) {
-                modifications.push(makeDelete(modifier, orig));
+    switch (node.kind) {
+        case 'freeFunction':
+        case 'function': {
+            if (node.modifiers.length > 0) {
+                for (const modifier of node.modifiers) {
+                    modifications.push(makeDelete(modifier, orig));
+                }
             }
+            if (node.returnParameters.parameters.length > 0) {
+                modifications.push(makeReplace(node.returnParameters, orig, `(${node.returnParameters.parameters.map(param => toReturnParameterReplacement(param)).join(', ')})`));
+            }
+            if (node.body) {
+                modifications.push(makeReplace(node.body, orig, '{}'));
+            }
+            break;
         }
-        if (node.returnParameters.parameters.length > 0) {
-            modifications.push(makeReplace(node.returnParameters, orig, `(${node.returnParameters.parameters.map(param => toReturnParameterReplacement(param)).join(', ')})`));
-        }
-        if (node.body) {
-            modifications.push(makeReplace(node.body, orig, '{}'));
+        case 'constructor':
+        case 'fallback':
+        case 'receive': {
+            modifications.push(makeReplace(node, orig, toDummyEnumWithAstId(node.id)));
+            break;
         }
+        default:
+            return (0, assert_1.assertUnreachable)(node.kind);
     }
 }
 function toReturnParameterReplacement(param) {
@@ -177,6 +245,10 @@ function makeReplace(node, orig, text) {
     const { start, end } = makeDelete(node, orig);
     return { start, end, text };
 }
+function makeInsertBefore(node, text) {
+    const { start } = getPositions(node);
+    return { start: start, end: start, text };
+}
 function makeInsertAfter(node, text) {
     const { end } = getPositions(node);
     return { start: end, end, text };
@@ -193,7 +265,10 @@ function makeDelete(node, orig) {
             end += 1;
         }
     }
-    return { start: positions.start, end };
+    return makeDeleteRange(positions.start, end);
+}
+function makeDeleteRange(start, end) {
+    return { start, end };
 }
 function getModifiedSource(orig, modifications) {
     let result = '';

package/dist/utils/make-namespaced.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"make-namespaced.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":";;~~AA8BA~~,~~kDAwHC~~;~~AAtJD~~,8CAAgD;AAGhD,oDAAoE;AACpE,~~qCAAkC~~;~~AAGlC~~,MAAM,gBAAgB,GAAG;IACvB,GAAG,EAAE;QACH,GAAG,EAAE,CAAC,eAAe,CAAC;QACtB,EAAE,EAAE,CAAC,KAAK,CAAC;KACZ;CACF,CAAC;AAEF~~;;;;;;;;;;;;;;;GAeG~~;AACH,SAAgB,mBAAmB,CAAC,KAAgB,EAAE,MAAkB;~~IACtE~~,MAAM,eAAe,GAAyC,EAAE,CAAC;IAEjE,KAAK,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAEzC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,eAAe,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;YACrC,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAmB,EAAE,CAAC;QAEzC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACxD,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACtB,KAAK,oBAAoB,CAAC,CAAC,CAAC;oBAC1B,MAAM,WAAW,GAAG,IAAI,CAAC;oBAEzB,oEAAoE;oBACpE,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;oBAC3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;4BACrC,IAAA,eAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;4BAC5C,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;wBACxE,CAAC;oBACH,CAAC;oBAED,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC;oBACxC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;wBACzC,QAAQ,YAAY,CAAC,QAAQ,EAAE,CAAC;4BAC9B,KAAK,oBAAoB,CAAC,CAAC,CAAC;gCAC1B,eAAe,CAAC,YAAY,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;gCACnD,MAAM;4BACR,CAAC;4BACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;gCAC3B,4EAA4E;gCAC5E,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;oCAC1B,MAAM;gCACR,CAAC;gCACD,mDAAmD;4BACrD,CAAC;4BACD,KAAK,iBAAiB,CAAC;4BACvB,KAAK,iBAAiB,CAAC;4BACvB,KAAK,oBAAoB,CAAC;4BAC1B,KAAK,mBAAmB,CAAC,CAAC,CAAC;gCACzB,2GAA2G;gCAC3G,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gCAC3F,MAAM;4BACR,CAAC;4BACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gCACxB,MAAM,eAAe,GAAG,IAAA,wCAA4B,EAAC,YAAY,CAAC,CAAC;gCACnE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oCAClC,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC;oCACrC,MAAM,YAAY,GAAG,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;oCAC1E,MAAM,UAAU,GAAG,IAAI,UAAU,IAAI,YAAY,GAAG,CAAC;oCAErD,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;gCAChE,CAAC;gCACD,MAAM;4BACR,CAAC;4BACD,KAAK,gBAAgB,CAAC;4BACtB,KAAK,gCAAgC,CAAC;4BACtC,OAAO,CAAC,CAAC,CAAC;gCACR,oEAAoE;gCACpE,oFAAoF;gCACpF,kDAAkD;gCAClD,MAAM;4BACR,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,MAAM;gBACR,CAAC;gBAED,KAAK,oBAAoB,CAAC,CAAC,CAAC;oBAC1B,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;oBAC3C,MAAM;gBACR,CAAC;gBAED,yGAAyG;gBACzG,sFAAsF;gBACtF,qEAAqE;gBACrE,KAAK,qBAAqB,CAAC,CAAC,CAAC;oBAC3B,4EAA4E;oBAC5E,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAClB,MAAM;oBACR,CAAC;oBACD,mDAAmD;gBACrD,CAAC;gBACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;oBACvB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC5E,MAAM;gBACR,CAAC;gBACD,8GAA8G;gBAC9G,iFAAiF;gBACjF,KAAK,mBAAmB;oBACtB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC3E,MAAM;gBACR,KAAK,gBAAgB,CAAC;gBACtB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB,CAAC;gBACxB,KAAK,gCAAgC,CAAC;gBACtC,OAAO,CAAC,CAAC,CAAC;oBACR,oEAAoE;oBACpE,+EAA+E;oBAC/E,iDAAiD;oBACjD,sEAAsE;oBACtE,oFAAoF;oBACpF,mFAAmF;oBACnF,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,~~iBAAiB~~,CAAC,~~IAAI~~,EAAE,~~aAAa~~,CAAC,EAAE,CAAC;~~IAC/F~~,CAAC;~~IAED~~,~~OAAO~~,EAAE,~~GAAG~~,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,eAAe,EAAE,~~gBAAgB~~,EAAE,EAAE,CAAC;~~AACpH~~,CAAC;AAQD,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,QAAQ,IAAI,YAAY,CAAC;AAClC,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,eAAe,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC;AAC9E,CAAC;AAED,SAAS,eAAe,CAAC,IAAwB,EAAE,IAAY,EAAE,aAA6B;IAC5F,~~IAAI~~,IAAI,CAAC,IAAI,~~KAAK,aAAa,~~EAAE,CAAC;~~QAChC~~,~~aAAa~~,CAAC,~~IAAI~~,~~CAAC,~~UAAU,CAAC,~~IAAI,EAAE,IAAI,~~CAAC,CAAC~~,CAAC~~;~~IAC7C~~,~~CAAC;SAAM,CAAC;QACN,~~IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;~~YAC9B~~,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;~~gBACtC~~,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;~~YACjD~~,CAAC;~~QACH~~,CAAC;~~QAED~~,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;~~YAChD~~,aAAa,CAAC,IAAI,CAChB,WAAW,CACT,IAAI,CAAC,gBAAgB,EACrB,IAAI,EACJ,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrG,CACF,CAAC;~~QACJ~~,CAAC;~~QAED~~,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;~~YACd~~,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;~~QACzD~~,CAAC;~~IACH~~,CAAC;AACH,CAAC;AAED,SAAS,4BAA4B,CAAC,KAA0B;IAC9D,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU;IAC9B,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;IAC3B,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED,SAAS,WAAW,CAAC,IAAU,EAAE,IAAY,EAAE,IAAY;IACzD,iCAAiC;IACjC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,eAAe,CAAC,IAAU,EAAE,IAAY;IAC/C,MAAM,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CAAC,IAAU,EAAE,IAAY;IAC1C,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC;IACxB,+DAA+D;IAC/D,IAAI,IAAA,kBAAU,EAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE,CAAC;QAC5C,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClF,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACzE,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,OAAO,~~EAAE~~,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC;~~AACzC~~,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY,EAAE,aAA6B;IACpE,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,IAAA,eAAM,EAAC,YAAY,CAAC,KAAK,IAAI,aAAa,CAAC,CAAC;QAC5C,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAEnE,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC;QAC9B,CAAC;QAED,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC;IACnC,CAAC;IAED,IAAA,eAAM,EAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,OAAO,MAAM,CAAC;AAChB,CAAC"}
1	+ {"version":3,"file":"make-namespaced.js","sourceRoot":"","sources":["../../src/utils/make-namespaced.ts"],"names":[],"mappings":";;AAmCA,kDAgIC;AAnKD,8CAAgD;AAGhD,oDAAoE;AACpE,qCAAqD;AAGrD,MAAM,gBAAgB,GAAG;IACvB,GAAG,EAAE;QACH,GAAG,EAAE,CAAC,eAAe,CAAC;QACtB,EAAE,EAAE,CAAC,KAAK,CAAC;KACZ;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,mBAAmB,CAAC,KAAgB,EAAE,MAAkB,EAAE,WAAoB;IAC5F,MAAM,eAAe,GAAyC,EAAE,CAAC;IAEjE,KAAK,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAEzC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,eAAe,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC;YACrC,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,MAAM,aAAa,GAAmB,EAAE,CAAC;QAEzC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACxD,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACtB,KAAK,oBAAoB,CAAC,CAAC,CAAC;oBAC1B,MAAM,WAAW,GAAG,IAAI,CAAC;oBAEzB,iFAAiF;oBACjF,4EAA4E;oBAC5E,IAAI,WAAW,CAAC,YAAY,KAAK,UAAU,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;wBACrE,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;oBACjE,CAAC;oBAED,oEAAoE;oBACpE,MAAM,QAAQ,GAAG,WAAW,CAAC,aAAa,CAAC;oBAC3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;4BACrC,IAAA,eAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;4BAC5C,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;wBACxE,CAAC;oBACH,CAAC;oBAED,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC;oBACxC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;wBACzC,QAAQ,YAAY,CAAC,QAAQ,EAAE,CAAC;4BAC9B,KAAK,oBAAoB,CAAC,CAAC,CAAC;gCAC1B,eAAe,CAAC,YAAY,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;gCACnD,MAAM;4BACR,CAAC;4BACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;gCAC3B,4EAA4E;gCAC5E,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;oCAC1B,MAAM;gCACR,CAAC;gCACD,mDAAmD;4BACrD,CAAC;4BACD,KAAK,iBAAiB,CAAC;4BACvB,KAAK,iBAAiB,CAAC;4BACvB,KAAK,oBAAoB,CAAC;4BAC1B,KAAK,mBAAmB,CAAC,CAAC,CAAC;gCACzB,2GAA2G;gCAC3G,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gCAC3F,MAAM;4BACR,CAAC;4BACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gCACxB,MAAM,eAAe,GAAG,IAAA,wCAA4B,EAAC,YAAY,CAAC,CAAC;gCACnE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oCAClC,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC;oCACrC,MAAM,YAAY,GAAG,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;oCAC1E,MAAM,UAAU,GAAG,IAAI,UAAU,IAAI,YAAY,GAAG,CAAC;oCAErD,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;gCAChE,CAAC;gCACD,MAAM;4BACR,CAAC;4BACD,KAAK,gBAAgB,CAAC;4BACtB,KAAK,gCAAgC,CAAC;4BACtC,OAAO,CAAC,CAAC,CAAC;gCACR,oEAAoE;gCACpE,oFAAoF;gCACpF,kDAAkD;gCAClD,MAAM;4BACR,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,MAAM;gBACR,CAAC;gBAED,KAAK,oBAAoB,CAAC,CAAC,CAAC;oBAC1B,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;oBAC3C,MAAM;gBACR,CAAC;gBAED,yGAAyG;gBACzG,sFAAsF;gBACtF,qEAAqE;gBACrE,KAAK,qBAAqB,CAAC,CAAC,CAAC;oBAC3B,4EAA4E;oBAC5E,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAClB,MAAM;oBACR,CAAC;oBACD,mDAAmD;gBACrD,CAAC;gBACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;oBACvB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC5E,MAAM;gBACR,CAAC;gBACD,8GAA8G;gBAC9G,iFAAiF;gBACjF,KAAK,mBAAmB;oBACtB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC3E,MAAM;gBACR,KAAK,gBAAgB,CAAC;gBACtB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,kBAAkB,CAAC;gBACxB,KAAK,gCAAgC,CAAC;gBACtC,OAAO,CAAC,CAAC,CAAC;oBACR,oEAAoE;oBACpE,+EAA+E;oBAC/E,iDAAiD;oBACjD,sEAAsE;oBACtE,oFAAoF;oBACpF,mFAAmF;oBACnF,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,cAAc,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,WAAW,CAAC,CAAC;QAEtG,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,eAAe,EAAE,gBAAgB,EAAE,EAAE,CAAC;AACpH,CAAC;AAED;;;;;GAKG;AACH,SAAS,yBAAyB,CAAC,WAAmB,EAAE,WAA+B;IACrF,MAAM,eAAe,GAAmB,EAAE,CAAC;IAE3C,IAAI,WAAW,KAAK,SAAS,IAAI,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;QACtE,uDAAuD;QACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAAC;QAChE,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;QAClF,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAC/D,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC/C,sDAAsD;QAEtD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,WAAW,CAAC,gBAAgB,EAAE,CAAC;QAE9C,OACE,MAAM,CAAC,yBAAyB,CAAC,CAAC,YAAY,CAAC,uBAAuB,EAAE,YAAY,CAAC,wBAAwB,CAAC,CAAC,EAC/G,CAAC;YACD,4EAA4E;YAC5E,kFAAkF;YAClF,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;YACvC,OAAO,eAAe,CAAC,gBAAgB,EAAE,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC9E,yBAAyB;YAC3B,CAAC;YACD,IAAI,eAAe,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,YAAY,CAAC,aAAa,EAAE,CAAC;gBAC/D,SAAS;YACX,CAAC;YAED,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YACjC,IAAA,eAAM,EAAC,UAAU,YAAY,YAAY,CAAC,CAAC;YAC3C,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAChG,CAAC;QACD,OAAO,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,eAAe,CAAC,CAAC;IAC9E,CAAC;SAAM,CAAC;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,EAAU;IAC5B,IAAI,CAAC;QACH,OAAO,CAAC,EAAE,CAAC,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,aAAa;IACf,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAQD,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,QAAQ,IAAI,YAAY,CAAC;AAClC,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,eAAe,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC;AAC9E,CAAC;AAED,SAAS,eAAe,CAAC,IAAwB,EAAE,IAAY,EAAE,aAA6B;IAC5F,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,cAAc,CAAC;QACpB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACtC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;YAED,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChD,aAAa,CAAC,IAAI,CAChB,WAAW,CACT,IAAI,CAAC,gBAAgB,EACrB,IAAI,EACJ,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrG,CACF,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YACzD,CAAC;YAED,MAAM;QACR,CAAC;QACD,KAAK,aAAa,CAAC;QACnB,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3E,MAAM;QACR,CAAC;QACD;YACE,OAAO,IAAA,0BAAiB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;AACH,CAAC;AAED,SAAS,4BAA4B,CAAC,KAA0B;IAC9D,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU;IAC9B,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,CAAC;IAC3B,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED,SAAS,WAAW,CAAC,IAAU,EAAE,IAAY,EAAE,IAAY;IACzD,iCAAiC;IACjC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAU,EAAE,IAAY;IAChD,MAAM,EAAE,KAAK,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,eAAe,CAAC,IAAU,EAAE,IAAY;IAC/C,MAAM,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CAAC,IAAU,EAAE,IAAY;IAC1C,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC;IACxB,+DAA+D;IAC/D,IAAI,IAAA,kBAAU,EAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE,CAAC;QAC5C,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClF,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACzE,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,OAAO,eAAe,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,eAAe,CAAC,KAAa,EAAE,GAAW;IACjD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACxB,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY,EAAE,aAA6B;IACpE,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,IAAA,eAAM,EAAC,YAAY,CAAC,KAAK,IAAI,aAAa,CAAC,CAAC;QAC5C,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAEnE,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC;QAC9B,CAAC;QAED,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC;IACnC,CAAC;IAED,IAAA,eAAM,EAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -11,18 +11,22 @@ const make_namespaced_1 = require("./make-namespaced");
     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 - keep all natspec', async (t) => {
+    const origBuildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/NamespacedToModifyImported.sol:Example');
+    await testMakeNamespaced(origBuildInfo, t, '0.8.20', true);
+});
 (0, ava_1.default)('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 hardhat_1.artifacts.getBuildInfo('contracts/test/NamespacedToModify07.sol:HasFunction');
     await testMakeNamespaced(origBuildInfo, t, '0.7.6');
 });
-async function testMakeNamespaced(origBuildInfo, t, solcVersion) {
+async function testMakeNamespaced(origBuildInfo, t, solcVersion, keepAllNatSpec = false) {
     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 = (0, make_namespaced_1.makeNamespacedInput)(origBuildInfo.input, origBuildInfo.output);
+    const modifiedInput = (0, make_namespaced_1.makeNamespacedInput)(origBuildInfo.input, origBuildInfo.output, keepAllNatSpec ? undefined : origBuildInfo.solcVersion);
     // 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, JSON.stringify(modifiedInput.sources, null, 2));
@@ -37,6 +41,7 @@ function normalizeIdentifiers(input) {
             source.content = source.content
                 .replace(/\$MainStorage_\d{1,6}/g, '$MainStorage_random')
                 .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random')
+                .replace(/\$StorageWithComment_\d{1,6}/g, '$StorageWithComment_random')
                 .replace(/\$astId_\d+_\d{1,6}/g, '$astId_id_random');
         }
     }

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

	@@ -1 +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,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,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;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,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvF,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,CAAC;QAClD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,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;QACzD,CAAC;IACH,CAAC;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,CAAC;QACvB,OAAO,MAAM,IAAA,aAAG,EAAC,6CAAgC,EAAE;YACjD,KAAK;YACL,UAAU,EAAE,SAAS,CAAC,YAAY;SACnC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,IAAA,aAAG,EAAC,2CAA8B,EAAE;YAC/C,KAAK;YACL,QAAQ,EAAE,SAAS,CAAC,YAAY;SACjC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
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,uDAAuD,CAAC,CAAC;IAC5G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,0CAA0C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACzD,MAAM,aAAa,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,uDAAuD,CAAC,CAAC;IAC5G,MAAM,kBAAkB,CAAC,aAAa,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC7D,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,EACnB,cAAc,GAAG,KAAK;IAEtB,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;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,EACvC,aAAa,CAAC,KAAK,EACnB,aAAa,CAAC,MAAM,EACpB,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,CACvD,CAAC;IAEF,2EAA2E;IAC3E,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACxE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvF,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,CAAC;QAClD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;iBAC5B,OAAO,CAAC,wBAAwB,EAAE,qBAAqB,CAAC;iBACxD,OAAO,CAAC,6BAA6B,EAAE,0BAA0B,CAAC;iBAClE,OAAO,CAAC,+BAA+B,EAAE,4BAA4B,CAAC;iBACtE,OAAO,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;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,CAAC;QACvB,OAAO,MAAM,IAAA,aAAG,EAAC,6CAAgC,EAAE;YACjD,KAAK;YACL,UAAU,EAAE,SAAS,CAAC,YAAY;SACnC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,IAAA,aAAG,EAAC,2CAA8B,EAAE;YAC/C,KAAK;YACL,QAAQ,EAAE,SAAS,CAAC,YAAY;SACjC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/utils/slang/trivia.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { Node } from '@nomicfoundation/slang/cst';
+/**
+ * Returns true if the node is a trivia terminal (whitespace or comment or NatSpec)
+ *
+ * CAUTION: This must be imported dynamically.
+ * Only import this file if Slang is supported on the current platform, otherwise an error will be thrown on import.
+ */
+export declare function isTrivia(node: Node): boolean;
+//# sourceMappingURL=trivia.d.ts.map

package/dist/utils/slang/trivia.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"trivia.d.ts","sourceRoot":"","sources":["../../../src/utils/slang/trivia.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAgB,MAAM,4BAA4B,CAAC;AAEhE;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,WAElC"}

package/dist/utils/slang/trivia.js ADDED Viewed

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTrivia = isTrivia;
+const kinds_1 = require("@nomicfoundation/slang/kinds");
+const cst_1 = require("@nomicfoundation/slang/cst");
+/**
+ * Returns true if the node is a trivia terminal (whitespace or comment or NatSpec)
+ *
+ * CAUTION: This must be imported dynamically.
+ * Only import this file if Slang is supported on the current platform, otherwise an error will be thrown on import.
+ */
+function isTrivia(node) {
+    return node instanceof cst_1.TerminalNode && isTriviaKind(node.kind);
+}
+function isTriviaKind(kind) {
+    return (kind === kinds_1.TerminalKind.EndOfLine ||
+        kind === kinds_1.TerminalKind.MultiLineComment ||
+        kind === kinds_1.TerminalKind.MultiLineNatSpecComment ||
+        kind === kinds_1.TerminalKind.SingleLineComment ||
+        kind === kinds_1.TerminalKind.SingleLineNatSpecComment ||
+        kind === kinds_1.TerminalKind.Whitespace);
+}
+//# sourceMappingURL=trivia.js.map

package/dist/utils/slang/trivia.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"trivia.js","sourceRoot":"","sources":["../../../src/utils/slang/trivia.ts"],"names":[],"mappings":";;AASA,4BAEC;AAXD,wDAA4D;AAC5D,oDAAgE;AAEhE;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAU;IACjC,OAAO,IAAI,YAAY,kBAAY,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,YAAY,CAAC,IAAkB;IACtC,OAAO,CACL,IAAI,KAAK,oBAAY,CAAC,SAAS;QAC/B,IAAI,KAAK,oBAAY,CAAC,gBAAgB;QACtC,IAAI,KAAK,oBAAY,CAAC,uBAAuB;QAC7C,IAAI,KAAK,oBAAY,CAAC,iBAAiB;QACvC,IAAI,KAAK,oBAAY,CAAC,wBAAwB;QAC9C,IAAI,KAAK,oBAAY,CAAC,UAAU,CACjC,CAAC;AACJ,CAAC"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.34.4",
+  "version": "1.35.1",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -61,6 +61,7 @@
     "typescript": "^5.0.0"
   },
   "dependencies": {
+    "@nomicfoundation/slang": "^0.15.1",
     "cbor": "^9.0.0",
     "chalk": "^4.1.0",
     "compare-versions": "^6.0.0",

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

@@ -16,6 +16,11 @@ test('make namespaced input', async t => {
   await testMakeNamespaced(origBuildInfo, t, '0.8.20');
 });
+test('make namespaced input - keep all natspec', async t => {
+  const origBuildInfo = await artifacts.getBuildInfo('contracts/test/NamespacedToModifyImported.sol:Example');
+  await testMakeNamespaced(origBuildInfo, t, '0.8.20', true);
+});
 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');
@@ -26,6 +31,7 @@ async function testMakeNamespaced(
   origBuildInfo: BuildInfo | undefined,
   t: ExecutionContext<unknown>,
   solcVersion: string,
+  keepAllNatSpec = false,
 ) {
   if (origBuildInfo === undefined) {
     throw new Error('Build info not found');
@@ -34,7 +40,11 @@ async function testMakeNamespaced(
   // 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);
+  const modifiedInput = makeNamespacedInput(
+    origBuildInfo.input,
+    origBuildInfo.output,
+    keepAllNatSpec ? undefined : origBuildInfo.solcVersion,
+  );
   // Run hardhat compile on the modified input and make sure it has no errors
   const modifiedOutput = await hardhatCompile(modifiedInput, solcVersion);
@@ -53,6 +63,7 @@ function normalizeIdentifiers(input: SolcInput): void {
       source.content = source.content
         .replace(/\$MainStorage_\d{1,6}/g, '$MainStorage_random')
         .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random')
+        .replace(/\$StorageWithComment_\d{1,6}/g, '$StorageWithComment_random')
         .replace(/\$astId_\d+_\d{1,6}/g, '$astId_id_random');
     }
   }

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

@@ -32,7 +32,7 @@ Generated by [AVA](https://avajs.dev).
           content: `// SPDX-License-Identifier: MIT␊
           pragma solidity ^0.8.20;␊
           ␊
-          contract Example {␊
+          abstract contract Example {␊
               /// @custom:storage-location erc7201:example.main␊
               struct MainStorage {␊
                   uint256 x;␊
@@ -44,6 +44,266 @@ Generated by [AVA](https://avajs.dev).
                   uint256 a;␊
                   uint256 b;␊
               } SecondaryStorage $SecondaryStorage_random;␊
+          ␊
+              /// @custom:storage-location erc7201:example.with.following.comment␊
+              // some comment␊
+              struct StorageWithComment {␊
+                  uint256 a;␊
+                  uint256 b;␊
+              } StorageWithComment $StorageWithComment_random;␊
+          ␊
+              ␊
+              function foo() public {}␊
+          ␊
+              ␊
+              function foo1(uint a) public {}␊
+          ␊
+              ␊
+              function foo2(uint a) internal {}␊
+              struct MyStruct { uint b; }␊
+          ␊
+              // keccak256(abi.encode(uint256(keccak256("example.main")) - 1)) & ~bytes32(uint256(0xff));␊
+              bytes32 private constant MAIN_STORAGE_LOCATION =␊
+                  0x183a6125c38840424c4a85fa12bab2ab606c4b6d0e7cc73c0c06ba5300eab500;␊
+          ␊
+              function _getMainStorage() private pure returns (bool $) {}␊
+          ␊
+              function _getXTimesY() internal view returns (bool) {}␊
+          ␊
+              ␊
+          ␊
+              ␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              // standalone doc␊
+          ␊
+              ␊
+          ␊
+              ␊
+              function foo3() public {}␊
+          ␊
+              ␊
+              function foo4() public {}␊
+          ␊
+              ␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+              enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          abstract contract HasFunction {␊
+            ␊
+            enum $astId_id_random { dummy }␊
+          ␊
+            function foo() pure public returns (bool) {}␊
+          }␊
+          ␊
+          abstract contract UsingFunction is HasFunction {␊
+            enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          function FreeFunctionUsingSelector() pure returns (bool) {}␊
+          ␊
+          bytes4 constant CONSTANT_USING_SELECTOR = HasFunction.foo.selector;␊
+          ␊
+          library Lib {␊
+            function usingSelector() pure public returns (bool) {}␊
+          ␊
+            function plusOne(uint x) pure public returns (bool) {}␊
+          }␊
+          ␊
+          abstract contract Consumer {␊
+            enum $astId_id_random { dummy }␊
+          ␊
+            function usingFreeFunction() pure public returns (bool) {}␊
+          ␊
+            function usingConstant() pure public returns (bool) {}␊
+          ␊
+            function usingLibraryFunction() pure public returns (bool) {}␊
+          }␊
+          ␊
+          abstract contract HasConstantWithSelector {␊
+            bytes4 constant CONTRACT_CONSTANT_USING_SELECTOR = HasFunction.foo.selector;␊
+          }␊
+          ␊
+          function plusTwo(uint x) pure returns (bool) {}␊
+          ␊
+          ␊
+          ␊
+          ␊
+          function plusThree(uint x) pure returns (bool) {}␊
+          ␊
+          ␊
+          ␊
+          ␊
+          function plusThree(uint x, uint y) pure returns (bool) {}␊
+          ␊
+          function originallyNoDocumentation() pure {}␊
+          ␊
+          ␊
+          enum $astId_id_random { dummy }␊
+          ␊
+          abstract contract UsingForDirectives {␊
+            enum $astId_id_random { dummy }␊
+          ␊
+            function usingFor(uint x) pure public returns (bool) {}␊
+          }␊
+          ␊
+          ␊
+          enum FreeEnum { MyEnum }␊
+          ␊
+          ␊
+          enum CustomErrorOutsideContract { dummy }␊
+          ␊
+          int8 constant MAX_SIZE_C = 2;␊
+          ␊
+          abstract contract StructArrayUsesConstant {␊
+            uint16 private constant MAX_SIZE = 10;␊
+          ␊
+            struct NotNamespaced {␊
+              uint16 a;␊
+              uint256[MAX_SIZE] b;␊
+              uint256[MAX_SIZE_C] c;␊
+            }␊
+          ␊
+            /// @custom:storage-location erc7201:uses.constant␊
+            struct MainStorage {␊
+              uint256 x;␊
+              uint256[MAX_SIZE] y;␊
+              uint256[MAX_SIZE_C] c;␊
+            } MainStorage $MainStorage_random;␊
+          }␊
+          ␊
+          address constant MY_ADDRESS = address(0);␊
+          uint constant CONVERTED_ADDRESS = uint160(MY_ADDRESS);␊
+          ␊
+          interface IDummy {␊
+          }␊
+          ␊
+          abstract contract UsesAddress {␊
+            IDummy public constant MY_CONTRACT = IDummy(MY_ADDRESS);␊
+          }␊
+          ␊
+          abstract contract HasFunctionWithRequiredReturn {␊
+              struct S { uint x; }␊
+              function foo(S calldata s) internal pure returns (bool) {}␊
+          }␊
+          ␊
+          ␊
+          function hasMultipleReturns() pure returns (bool, bool) {}␊
+          ␊
+          ␊
+          function hasMultipleNamedReturns() pure returns (bool a, bool b) {}␊
+          ␊
+          ␊
+          function hasReturnsDocumentedAsParams() pure returns (bool a, bool b) {}␊
+          ␊
+          abstract contract HasNatSpecWithMultipleReturns {␊
+              ␊
+              function hasMultipleReturnsInContract() public pure returns (bool, bool) {}␊
+          ␊
+              ␊
+              function hasMultipleNamedReturnsInContract() public pure returns (bool a, bool b) {}␊
+          ␊
+              ␊
+              function hasReturnsDocumentedAsParamsInContract() public pure returns (bool a, bool b) {}␊
+          }␊
+          ␊
+          interface IHasExternalViewFunction {␊
+              function foo() external view returns (bool);␊
+          }␊
+          ␊
+          abstract contract HasExternalViewFunction is IHasExternalViewFunction {␊
+              // This generates a getter function that conforms to the interface␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              // References a selector in an interface␊
+              bytes4 constant USING_INTERFACE_FUNCTION_SELECTOR = IHasExternalViewFunction.foo.selector;␊
+          ␊
+              // References a getter generated for a public variable␊
+              enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          abstract contract DeploysContractToImmutable {␊
+              enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          abstract contract HasSpecialFunctions {␊
+              ␊
+              ␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              // Regular function but payable␊
+              function hasPayable() public payable {}␊
+          ␊
+              bytes4 constant PAYABLE_SELECTOR = this.hasPayable.selector;␊
+          }`,
+        },
+        'contracts/test/NamespacedToModifyImported.sol': {
+          content: `// SPDX-License-Identifier: MIT␊
+          pragma solidity ^0.8.20;␊
+          ␊
+          import {CONSTANT_USING_SELECTOR, plusTwo, plusThree, CustomErrorOutsideContract} from "./NamespacedToModify.sol";␊
+          ␊
+          abstract contract Example {}␊
+          `,
+        },
+      },
+    }
+## make namespaced input - keep all natspec
+> Snapshot 1
+    {
+      language: 'Solidity',
+      settings: {
+        evmVersion: 'paris',
+        optimizer: {
+          enabled: true,
+          runs: 200,
+        },
+        outputSelection: {
+          '*': {
+            '': [
+              'ast',
+            ],
+            '*': [
+              'storageLayout',
+            ],
+          },
+        },
+      },
+      sources: {
+        'contracts/test/NamespacedToModify.sol': {
+          content: `// SPDX-License-Identifier: MIT␊
+          pragma solidity ^0.8.20;␊
+          ␊
+          abstract contract Example {␊
+              /// @custom:storage-location erc7201:example.main␊
+              struct MainStorage {␊
+                  uint256 x;␊
+                  uint256 y;␊
+              } MainStorage $MainStorage_random;␊
+          ␊
+              /// @custom:storage-location erc7201:example.secondary␊
+              struct SecondaryStorage {␊
+                  uint256 a;␊
+                  uint256 b;␊
+              } SecondaryStorage $SecondaryStorage_random;␊
+          ␊
+              /// @custom:storage-location erc7201:example.with.following.comment␊
+              // some comment␊
+              struct StorageWithComment {␊
+                  uint256 a;␊
+                  uint256 b;␊
+              } StorageWithComment $StorageWithComment_random;␊
           ␊
               /// @notice some natspec␊
               function foo() public {}␊
@@ -98,12 +358,14 @@ Generated by [AVA](https://avajs.dev).
               enum $astId_id_random { dummy }␊
           }␊
           ␊
-          contract HasFunction {␊
-            ␊
+          abstract contract HasFunction {␊
+            /// @param myInt an integer␊
+            enum $astId_id_random { dummy }␊
+          ␊
             function foo() pure public returns (bool) {}␊
           }␊
           ␊
-          contract UsingFunction is HasFunction {␊
+          abstract contract UsingFunction is HasFunction {␊
             enum $astId_id_random { dummy }␊
           }␊
           ␊
@@ -117,7 +379,7 @@ Generated by [AVA](https://avajs.dev).
             function plusOne(uint x) pure public returns (bool) {}␊
           }␊
           ␊
-          contract Consumer {␊
+          abstract contract Consumer {␊
             enum $astId_id_random { dummy }␊
           ␊
             function usingFreeFunction() pure public returns (bool) {}␊
@@ -127,7 +389,7 @@ Generated by [AVA](https://avajs.dev).
             function usingLibraryFunction() pure public returns (bool) {}␊
           }␊
           ␊
-          contract HasConstantWithSelector {␊
+          abstract contract HasConstantWithSelector {␊
             bytes4 constant CONTRACT_CONSTANT_USING_SELECTOR = HasFunction.foo.selector;␊
           }␊
           ␊
@@ -159,7 +421,7 @@ Generated by [AVA](https://avajs.dev).
            */␊
           enum $astId_id_random { dummy }␊
           ␊
-          contract UsingForDirectives {␊
+          abstract contract UsingForDirectives {␊
             enum $astId_id_random { dummy }␊
           ␊
             function usingFor(uint x) pure public returns (bool) {}␊
@@ -185,7 +447,7 @@ Generated by [AVA](https://avajs.dev).
           ␊
           int8 constant MAX_SIZE_C = 2;␊
           ␊
-          contract StructArrayUsesConstant {␊
+          abstract contract StructArrayUsesConstant {␊
             uint16 private constant MAX_SIZE = 10;␊
           ␊
             struct NotNamespaced {␊
@@ -208,11 +470,11 @@ Generated by [AVA](https://avajs.dev).
           interface IDummy {␊
           }␊
           ␊
-          contract UsesAddress {␊
+          abstract contract UsesAddress {␊
             IDummy public constant MY_CONTRACT = IDummy(MY_ADDRESS);␊
           }␊
           ␊
-          contract HasFunctionWithRequiredReturn {␊
+          abstract contract HasFunctionWithRequiredReturn {␊
               struct S { uint x; }␊
               function foo(S calldata s) internal pure returns (bool) {}␊
           }␊
@@ -235,7 +497,7 @@ Generated by [AVA](https://avajs.dev).
            */␊
           function hasReturnsDocumentedAsParams() pure returns (bool a, bool b) {}␊
           ␊
-          contract HasNatSpecWithMultipleReturns {␊
+          abstract contract HasNatSpecWithMultipleReturns {␊
               /**␊
                * @return uint 1␊
                * @return uint 2␊
@@ -254,7 +516,38 @@ Generated by [AVA](https://avajs.dev).
                */␊
               function hasReturnsDocumentedAsParamsInContract() public pure returns (bool a, bool b) {}␊
           }␊
-          `,
+          ␊
+          interface IHasExternalViewFunction {␊
+              function foo() external view returns (bool);␊
+          }␊
+          ␊
+          abstract contract HasExternalViewFunction is IHasExternalViewFunction {␊
+              // This generates a getter function that conforms to the interface␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              // References a selector in an interface␊
+              bytes4 constant USING_INTERFACE_FUNCTION_SELECTOR = IHasExternalViewFunction.foo.selector;␊
+          ␊
+              // References a getter generated for a public variable␊
+              enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          abstract contract DeploysContractToImmutable {␊
+              enum $astId_id_random { dummy }␊
+          }␊
+          ␊
+          abstract contract HasSpecialFunctions {␊
+              /// @param data call data␊
+              /// @return dataReturn returned data␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              enum $astId_id_random { dummy }␊
+          ␊
+              // Regular function but payable␊
+              function hasPayable() public payable {}␊
+          ␊
+              bytes4 constant PAYABLE_SELECTOR = this.hasPayable.selector;␊
+          }`,
         },
         'contracts/test/NamespacedToModifyImported.sol': {
           content: `// SPDX-License-Identifier: MIT␊
@@ -262,7 +555,7 @@ Generated by [AVA](https://avajs.dev).
           ␊
           import {CONSTANT_USING_SELECTOR, plusTwo, plusThree, CustomErrorOutsideContract} from "./NamespacedToModify.sol";␊
           ␊
-          contract Example {}␊
+          abstract contract Example {}␊
           `,
         },
       },
@@ -295,12 +588,12 @@ Generated by [AVA](https://avajs.dev).
           content: `// SPDX-License-Identifier: MIT␊
           pragma solidity 0.7.6;␊
            ␊
-          contract HasFunction {␊
-            ␊
+          abstract contract HasFunction {␊
+            enum $astId_id_random { dummy }␊
             function foo() pure public returns (bool) {}␊
           }␊
           ␊
-          contract UsingFunction is HasFunction {␊
+          abstract contract UsingFunction is HasFunction {␊
             enum $astId_id_random { dummy }␊
           }␊
           `,

package/src/utils/make-namespaced.test.ts.snap CHANGED Viewed

Binary file

package/src/utils/make-namespaced.ts CHANGED Viewed

@@ -2,7 +2,7 @@ import { isNodeType } from 'solidity-ast/utils';
 import { Node } from 'solidity-ast/node';
 import { SolcInput, SolcOutput } from '../solc-api';
 import { getStorageLocationAnnotation } from '../storage/namespace';
-import { assert } from './assert';
+import { assert, assertUnreachable } from './assert';
 import { FunctionDefinition, VariableDeclaration } from 'solidity-ast';
 const OUTPUT_SELECTION = {
@@ -18,17 +18,22 @@ const OUTPUT_SELECTION = {
  *
  * This makes the following modifications to the input:
  * - Adds a state variable for each namespaced struct definition
- * - 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
+ * - For each contract, for all node types that are not needed for storage layout or may call 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)
+ * - Converts all custom errors and constants (at file level) to dummy enums with the same name (do not delete them since they might be imported by other files)
+ * - Replaces functions as follows:
+ *   - For regular function and free function, keep declarations since they may be referenced by constants (free functions may also be imported by other files). But simplify compilation by removing modifiers and body, and replace return parameters with bools which can be default initialized.
+ *   - Constructors are not needed, since we removed anything that may call constructors. Convert to dummy enums to avoid orphaning possible NatSpec.
+ *   - Fallback and receive functions are not needed, since they don't have signatures. Convert to dummy enums to avoid orphaning possible NatSpec.
  *
  * Also sets the outputSelection to only include storageLayout and ast, since the other outputs are not needed.
  *
  * @param input The original solc input.
  * @param output The original solc output.
+ * @param solcVersion The version of the solc compiler that was originally used to compile the input.
  * @returns The modified solc input with storage layout that includes namespaced type information.
  */
-export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcInput {
+export function makeNamespacedInput(input: SolcInput, output: SolcOutput, solcVersion?: string): SolcInput {
   const modifiedSources: Record<string, { content?: string }> = {};
   for (const [sourcePath] of Object.entries(input.sources)) {
@@ -48,6 +53,12 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcI
         case 'ContractDefinition': {
           const contractDef = node;
+          // Mark contracts as abstract, since state variables are converted to dummy enums
+          // which would not generate public getters for inherited interface functions
+          if (contractDef.contractKind === 'contract' && !contractDef.abstract) {
+            modifications.push(makeInsertBefore(contractDef, 'abstract '));
+          }
           // Remove any calls to parent constructors from the inheritance list
           const inherits = contractDef.baseContracts;
           for (const inherit of inherits) {
@@ -144,12 +155,68 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcI
       }
     }
-    modifiedSources[sourcePath] = { ...source, content: getModifiedSource(orig, modifications) };
+    const modifiedSource = tryRemoveNonStructNatSpec(getModifiedSource(orig, modifications), solcVersion);
+    modifiedSources[sourcePath] = { ...source, content: modifiedSource };
   }
   return { ...input, sources: modifiedSources, settings: { ...input.settings, outputSelection: OUTPUT_SELECTION } };
 }
+/**
+ * If Slang is supported for the current platform and we have the compiler version available,
+ * use Slang to parse and remove all NatSpec comments that do not precede a struct definition and return the modified content.
+ *
+ * Otherwise, return the original content.
+ */
+function tryRemoveNonStructNatSpec(origContent: string, solcVersion: string | undefined): string {
+  const natSpecRemovals: Modification[] = [];
+  if (solcVersion !== undefined && tryRequire('@nomicfoundation/slang')) {
+    /* eslint-disable @typescript-eslint/no-var-requires */
+    const { Language } = require('@nomicfoundation/slang/language');
+    const { NonterminalKind, TerminalKind } = require('@nomicfoundation/slang/kinds');
+    const { TerminalNode } = require('@nomicfoundation/slang/cst');
+    const { isTrivia } = require('./slang/trivia');
+    /* eslint-enable @typescript-eslint/no-var-requires */
+    const language = new Language(solcVersion);
+    const parseOutput = language.parse(NonterminalKind.SourceUnit, origContent);
+    const cursor = parseOutput.createTreeCursor();
+    while (
+      cursor.goToNextTerminalWithKinds([TerminalKind.MultiLineNatSpecComment, TerminalKind.SingleLineNatSpecComment])
+    ) {
+      // Lookahead to determine if the next non-trivia node is the struct keyword.
+      // If so, this NatSpec is part of the struct definition and should not be removed.
+      const lookaheadCursor = cursor.clone();
+      while (lookaheadCursor.goToNextTerminal() && isTrivia(lookaheadCursor.node())) {
+        // skip over trivia nodes
+      }
+      if (lookaheadCursor.node().kind === TerminalKind.StructKeyword) {
+        continue;
+      }
+      const triviaNode = cursor.node();
+      assert(triviaNode instanceof TerminalNode);
+      natSpecRemovals.push(makeDeleteRange(cursor.textRange.start.utf8, cursor.textRange.end.utf8));
+    }
+    return getModifiedSource(Buffer.from(origContent, 'utf8'), natSpecRemovals);
+  } else {
+    return origContent;
+  }
+}
+function tryRequire(id: string) {
+  try {
+    require(id);
+    return true;
+  } catch (e: any) {
+    // do nothing
+  }
+  return false;
+}
 interface Modification {
   start: number;
   end: number;
@@ -165,28 +232,39 @@ function toDummyEnumWithAstId(astId: number) {
 }
 function replaceFunction(node: FunctionDefinition, orig: Buffer, modifications: Modification[]) {
-  if (node.kind === 'constructor') {
-    modifications.push(makeDelete(node, orig));
-  } else {
-    if (node.modifiers.length > 0) {
-      for (const modifier of node.modifiers) {
-        modifications.push(makeDelete(modifier, orig));
+  switch (node.kind) {
+    case 'freeFunction':
+    case 'function': {
+      if (node.modifiers.length > 0) {
+        for (const modifier of node.modifiers) {
+          modifications.push(makeDelete(modifier, orig));
+        }
       }
-    }
-    if (node.returnParameters.parameters.length > 0) {
-      modifications.push(
-        makeReplace(
-          node.returnParameters,
-          orig,
-          `(${node.returnParameters.parameters.map(param => toReturnParameterReplacement(param)).join(', ')})`,
-        ),
-      );
-    }
+      if (node.returnParameters.parameters.length > 0) {
+        modifications.push(
+          makeReplace(
+            node.returnParameters,
+            orig,
+            `(${node.returnParameters.parameters.map(param => toReturnParameterReplacement(param)).join(', ')})`,
+          ),
+        );
+      }
-    if (node.body) {
-      modifications.push(makeReplace(node.body, orig, '{}'));
+      if (node.body) {
+        modifications.push(makeReplace(node.body, orig, '{}'));
+      }
+      break;
     }
+    case 'constructor':
+    case 'fallback':
+    case 'receive': {
+      modifications.push(makeReplace(node, orig, toDummyEnumWithAstId(node.id)));
+      break;
+    }
+    default:
+      return assertUnreachable(node.kind);
   }
 }
@@ -210,6 +288,11 @@ function makeReplace(node: Node, orig: Buffer, text: string): Modification {
   return { start, end, text };
 }
+function makeInsertBefore(node: Node, text: string): Modification {
+  const { start } = getPositions(node);
+  return { start: start, end: start, text };
+}
 function makeInsertAfter(node: Node, text: string): Modification {
   const { end } = getPositions(node);
   return { start: end, end, text };
@@ -227,7 +310,11 @@ function makeDelete(node: Node, orig: Buffer): Modification {
       end += 1;
     }
   }
-  return { start: positions.start, end };
+  return makeDeleteRange(positions.start, end);
+}
+function makeDeleteRange(start: number, end: number): Modification {
+  return { start, end };
 }
 function getModifiedSource(orig: Buffer, modifications: Modification[]): string {

package/src/utils/slang/trivia.ts ADDED Viewed

@@ -0,0 +1,23 @@
+import { TerminalKind } from '@nomicfoundation/slang/kinds';
+import { Node, TerminalNode } from '@nomicfoundation/slang/cst';
+/**
+ * Returns true if the node is a trivia terminal (whitespace or comment or NatSpec)
+ *
+ * CAUTION: This must be imported dynamically.
+ * Only import this file if Slang is supported on the current platform, otherwise an error will be thrown on import.
+ */
+export function isTrivia(node: Node) {
+  return node instanceof TerminalNode && isTriviaKind(node.kind);
+}
+function isTriviaKind(kind: TerminalKind) {
+  return (
+    kind === TerminalKind.EndOfLine ||
+    kind === TerminalKind.MultiLineComment ||
+    kind === TerminalKind.MultiLineNatSpecComment ||
+    kind === TerminalKind.SingleLineComment ||
+    kind === TerminalKind.SingleLineNatSpecComment ||
+    kind === TerminalKind.Whitespace
+  );
+}