Merge pull request #5467 from NomicFoundation/stack-traces-tests-conditionals-for-reverts

fvictorio · web-flow · commit b9227a4cd42b · 2024-07-02T22:05:02.000+02:00
Avoid unconditional reverts in stack traces tests
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/call-message/multiple-modifiers-require/c.sol b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/call-message/multiple-modifiers-require/c.sol
@@ -7,8 +7,11 @@ contract C {
     _;
   }
 
-  function test(bool b) m1(b) m2(b) public {
-    revert();
+  function test(bool b, bool doRevert) m1(b) m2(b) public {
+    // always true, used to prevent optimizations
+    if (doRevert) {
+      revert();
+    }
   }
 
   modifier m1(bool b)  {
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/call-message/multiple-modifiers-require/test.json b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/call-message/multiple-modifiers-require/test.json
@@ -6,7 +6,7 @@
     },
     {
       "to": 0,
-      "params": [false],
+      "params": [false, true],
       "function": "test",
       "stackTrace": [
         {
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/create-message/multiple-modifiers-require/c.sol b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/create-message/multiple-modifiers-require/c.sol
@@ -7,8 +7,11 @@ contract C {
     _;
   }
 
-  constructor(bool b) m1(b) m2(b) public {
-    revert();
+  constructor(bool b, bool doRevert) m1(b) m2(b) public {
+    // always true, used to prevent optimizations
+    if (doRevert) {
+      revert();
+    }
   }
 
   modifier m1(bool b)  {
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/create-message/multiple-modifiers-require/test.json b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/modifiers/create-message/multiple-modifiers-require/test.json
@@ -3,7 +3,7 @@
     {
       "file": "c.sol",
       "contract": "C",
-      "params": [false],
+      "params": [false, true],
       "stackTrace": [
         {
           "type": "CALLSTACK_ENTRY",
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/between-statements/c.sol b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/between-statements/c.sol
@@ -7,7 +7,10 @@ contract C {
 
   receive() external payable {
     i += 1;
-    revert();
+    // always true, used to prevent optimizations
+    if (msg.value == 0) {
+      revert();
+    }
     j += 2;
   }
 
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/between-statements/test.json b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/between-statements/test.json
@@ -14,7 +14,7 @@
             "contract": "C",
             "file": "c.sol",
             "function": "<receive>",
-            "line": 10
+            "line": 12
           }
         }
       ]
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/no-other-statements/c.sol b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/no-other-statements/c.sol
@@ -5,7 +5,10 @@ contract C {
   receive() external payable {
 
 
-    revert();
+    // always true, used to prevent optimizations
+    if (msg.value == 0) {
+      revert();
+    }
   }
 
 }
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/no-other-statements/test.json b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/no-other-statements/test.json
@@ -14,7 +14,7 @@
             "contract": "C",
             "file": "c.sol",
             "function": "<receive>",
-            "line": 8
+            "line": 10
           }
         }
       ]
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-after/c.sol b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-after/c.sol
@@ -7,7 +7,10 @@ contract C {
   receive() external  payable {
 
 
-    revert();
+    // always true, used to prevent optimizations
+    if (msg.value == 0) {
+      revert();
+    }
     i += 1;
   }
 
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-after/test.json b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-after/test.json
@@ -14,7 +14,7 @@
             "contract": "C",
             "file": "c.sol",
             "function": "<receive>",
-            "line": 10
+            "line": 12
           }
         }
       ]
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-before/c.sol b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-before/c.sol
@@ -7,7 +7,10 @@ contract C {
   receive() external payable {
     i += 1;
 
-    revert();
+    // always true, used to prevent optimizations
+    if (msg.value == 0) {
+      revert();
+    }
   }
 
 }
diff --git a/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-before/test.json b/packages/hardhat-core/test/internal/hardhat-network/stack-traces/test-files/0_8/revert-without-message/revert-without-message/within-receive/statement-before/test.json
@@ -14,7 +14,7 @@
             "contract": "C",
             "file": "c.sol",
             "function": "<receive>",
-            "line": 10
+            "line": 12
           }
         }
       ]

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,11 @@ contract C {`
`7`	`7`	`_;`
`8`	`8`	`}`
`9`	`9`
`10`		`- function test(bool b) m1(b) m2(b) public {`
`11`		`- revert();`
	`10`	`+ function test(bool b, bool doRevert) m1(b) m2(b) public {`
	`11`	`+ // always true, used to prevent optimizations`
	`12`	`+ if (doRevert) {`
	`13`	`+ revert();`
	`14`	`+ }`
`12`	`15`	`}`
`13`	`16`
`14`	`17`	`modifier m1(bool b) {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`},`
`7`	`7`	`{`
`8`	`8`	`"to": 0,`
`9`		`- "params": [false],`
	`9`	`+ "params": [false, true],`
`10`	`10`	`"function": "test",`
`11`	`11`	`"stackTrace": [`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`{`
`4`	`4`	`"file": "c.sol",`
`5`	`5`	`"contract": "C",`
`6`		`- "params": [false],`
	`6`	`+ "params": [false, true],`
`7`	`7`	`"stackTrace": [`
`8`	`8`	`{`
`9`	`9`	`"type": "CALLSTACK_ENTRY",`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`"contract": "C",`
`15`	`15`	`"file": "c.sol",`
`16`	`16`	`"function": "<receive>",`
`17`		`- "line": 10`
	`17`	`+ "line": 12`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`	`]`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,10 @@ contract C {`
`5`	`5`	`receive() external payable {`
`6`	`6`
`7`	`7`
`8`		`- revert();`
	`8`	`+ // always true, used to prevent optimizations`
	`9`	`+ if (msg.value == 0) {`
	`10`	`+ revert();`
	`11`	`+ }`
`9`	`12`	`}`
`10`	`13`
`11`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,10 @@ contract C {`
`7`	`7`	`receive() external payable {`
`8`	`8`
`9`	`9`
`10`		`- revert();`
	`10`	`+ // always true, used to prevent optimizations`
	`11`	`+ if (msg.value == 0) {`
	`12`	`+ revert();`
	`13`	`+ }`
`11`	`14`	`i += 1;`
`12`	`15`	`}`
`13`	`16`