add new assumePayable cheat (#270)

* add new assumePayable cheat

* also exclude precompile addresses in assumePayable

* simplify assumePayable and add test

* add more tests for assertions

* use low level call instead of try catch for panic assertion

Author: hexcowboy

src/StdCheats.sol

@@ -463,6 +463,13 @@ abstract contract StdCheatsSafe {
             vm.resumeGasMetering();
         }
     }
+
+    // a cheat for fuzzing addresses that are payable only
+    // see https://github.com/foundry-rs/foundry/issues/3631
+    function assumePayable(address addr) internal virtual {
+        (bool success,) = payable(addr).call{value: 0}("");
+        vm.assume(success);
+    }
 }
 
 // Wrappers around cheatcodes to avoid footguns

test/StdCheats.t.sol

@@ -269,6 +269,30 @@ contract StdCheatsTest is Test {
                 || addr > address(0x4200000000000000000000000000000000000800)
         );
     }
+
+    function testAssumePayable() external {
+        // all should revert since these addresses are not payable
+
+        // VM address
+        vm.expectRevert();
+        assumePayable(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);
+
+        // Console address
+        vm.expectRevert();
+        assumePayable(0x000000000000000000636F6e736F6c652e6c6f67);
+
+        // Create2Deployer
+        vm.expectRevert();
+        assumePayable(0x4e59b44847b379578588920cA78FbF26c0B4956C);
+    }
+
+    function testAssumePayable(address addr) external {
+        assumePayable(addr);
+        assertTrue(
+            addr != 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D && addr != 0x000000000000000000636F6e736F6c652e6c6f67
+                && addr != 0x4e59b44847b379578588920cA78FbF26c0B4956C
+        );
+    }
 }
 
 contract Bar {