Leave constants as is when making namespaced input (#1009)

OpenZeppelin · Apr 16, 2024 · 20f0207 · 20f0207
1 parent 9932c6a
commit 20f0207
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 6 deletions.
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,8 +1,9 @@
 # Changelog
 
-## Unreleased
+## 1.32.6 (2024-04-16)
 
 - This plugin is now compiled with TypeScript v5. ([#760](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/760))
+- Fix Hardhat compile error when referencing a constant within a struct definition. ([#1009](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1009))
 
 ## 1.32.5 (2024-02-21)
 

diff --git a/packages/core/contracts/test/NamespacedToModify.sol b/packages/core/contracts/test/NamespacedToModify.sol
@@ -168,3 +168,18 @@ enum FreeEnum { MyEnum }
  * @param example example parameter
  */
 error CustomErrorOutsideContract(Example example);
+
+contract StructArrayUsesConstant {
+  uint16 private constant MAX_SIZE = 10;
+
+  struct NotNamespaced {
+    uint16 a;
+    uint256[MAX_SIZE] b;
+  }
+
+  /// @custom:storage-location erc7201:uses.constant
+  struct MainStorage {
+    uint256 x;
+    uint256[MAX_SIZE] y;
+  }
+}
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.32.5",
+  "version": "1.32.6",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",

diff --git a/packages/core/src/utils/make-namespaced.test.ts.md b/packages/core/src/utils/make-namespaced.test.ts.md
@@ -56,7 +56,8 @@ Generated by [AVA](https://avajs.dev).
               struct MyStruct { uint b; }␊
           ␊
               // keccak256(abi.encode(uint256(keccak256("example.main")) - 1)) & ~bytes32(uint256(0xff));␊
-              enum $astId_id_random { dummy }␊
+              bytes32 private constant MAIN_STORAGE_LOCATION =␊
+                  0x183a6125c38840424c4a85fa12bab2ab606c4b6d0e7cc73c0c06ba5300eab500;␊
           ␊
               enum $astId_id_random { dummy }␊
           ␊
@@ -171,7 +172,21 @@ Generated by [AVA](https://avajs.dev).
            * @param example example parameter␊
            */␊
           enum CustomErrorOutsideContract { dummy }␊
-          `,
+          ␊
+          contract StructArrayUsesConstant {␊
+            uint16 private constant MAX_SIZE = 10;␊
+          ␊
+            struct NotNamespaced {␊
+              uint16 a;␊
+              uint256[MAX_SIZE] b;␊
+            }␊
+          ␊
+            /// @custom:storage-location erc7201:uses.constant␊
+            struct MainStorage {␊
+              uint256 x;␊
+              uint256[MAX_SIZE] y;␊
+            } MainStorage $MainStorage_random;␊
+          }`,
         },
         'contracts/test/NamespacedToModifyImported.sol': {
           content: `// SPDX-License-Identifier: MIT␊

diff --git a/packages/core/src/utils/make-namespaced.test.ts.snap b/packages/core/src/utils/make-namespaced.test.ts.snap
diff --git a/packages/core/src/utils/make-namespaced.ts b/packages/core/src/utils/make-namespaced.ts
@@ -60,12 +60,18 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcI
           const contractNodes = contractDef.nodes;
           for (const contractNode of contractNodes) {
             switch (contractNode.nodeType) {
+              case 'VariableDeclaration': {
+                // If variable is a constant, keep it since it may be referenced in a struct
+                if (contractNode.constant) {
+                  break;
+                }
+                // Otherwise, fall through to convert to dummy enum
+              }
               case 'ErrorDefinition':
               case 'EventDefinition':
               case 'FunctionDefinition':
               case 'ModifierDefinition':
-              case 'UsingForDirective':
-              case 'VariableDeclaration': {
+              case 'UsingForDirective': {
                 // 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;