Fix modified namespaced compilation when multiple return parameters a…

…re documented (#1048)
OpenZeppelin · Jul 19, 2024 · 6a9aef6 · 6a9aef6
1 parent 88e2c1b
commit 6a9aef6
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 4 deletions.
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.34.3 (2024-07-19)
+
+- Fix Hardhat compile error when multiple return parameters are documented. ([#1048](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1048))
+
 ## 1.34.2 (2024-07-18)
 
 - Fix Hardhat compile error when constants have references to other constants. ([#1046](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/1046))

diff --git a/packages/core/contracts/test/NamespacedToModify.sol b/packages/core/contracts/test/NamespacedToModify.sol
@@ -214,4 +214,35 @@ contract HasFunctionWithRequiredReturn {
     function foo(S calldata s) internal pure returns (S calldata) {
         return s;
     }
-}
+}
+
+/**
+ * @return uint 1
+ * @return uint 2
+ */
+function hasMultipleReturns() pure returns (uint, uint) {
+    return (1, 2);
+}
+
+/**
+ * @return a first
+ * @return b second
+ */
+function hasMultipleNamedReturns() pure returns (uint a, uint b) {
+}
+
+contract HasNatSpecWithMultipleReturns {
+    /**
+     * @return uint 1
+     * @return uint 2
+     */
+    function hasMultipleReturnsInContract() public pure returns (uint, uint) {
+    }
+
+    /**
+     * @return a first
+     * @return b second
+     */
+    function hasMultipleNamedReturnsInContract() public pure returns (uint a, uint b) {
+    }
+}
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.34.2",
+  "version": "1.34.3",
   "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
@@ -215,7 +215,34 @@ Generated by [AVA](https://avajs.dev).
           contract HasFunctionWithRequiredReturn {␊
               struct S { uint x; }␊
               function foo(S calldata s) internal pure returns (bool) {}␊
-          }`,
+          }␊
+          ␊
+          /**␊
+           * @return uint 1␊
+           * @return uint 2␊
+           */␊
+          function hasMultipleReturns() pure returns (bool,bool) {}␊
+          ␊
+          /**␊
+           * @return a first␊
+           * @return b second␊
+           */␊
+          function hasMultipleNamedReturns() pure returns (bool,bool) {}␊
+          ␊
+          contract HasNatSpecWithMultipleReturns {␊
+              /**␊
+               * @return uint 1␊
+               * @return uint 2␊
+               */␊
+              function hasMultipleReturnsInContract() public pure returns (bool,bool) {}␊
+          ␊
+              /**␊
+               * @return a first␊
+               * @return b second␊
+               */␊
+              function hasMultipleNamedReturnsInContract() public pure returns (bool,bool) {}␊
+          }␊
+          `,
         },
         '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
@@ -175,7 +175,9 @@ function replaceFunction(node: FunctionDefinition, orig: Buffer, modifications:
     }
 
     if (node.returnParameters.parameters.length > 0) {
-      modifications.push(makeReplace(node.returnParameters, orig, '(bool)'));
+      modifications.push(
+        makeReplace(node.returnParameters, orig, `(${node.returnParameters.parameters.map(() => 'bool').join(',')})`),
+      );
     }
 
     if (node.body) {