Added latest cheatcodes (#31)

* Added latest cheatcodes * refactor: reorder alphabetically --------- Co-authored-by: Paul Razvan Berg <[email protected]>
PaulRBerg · Jul 31, 2023 · e643154 · e643154
1 parent 40a646a
commit e643154
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/src/Vm.sol b/src/Vm.sol
@@ -13,6 +13,14 @@ pragma solidity >=0.8.0 <0.9.0;
 /// @dev This interface can be safely used in scripts running on a live network, so for example you don't accidentally
 /// change the block timestamp and use a fake timestamp as a value somewhere.
 interface VmSafe {
+    enum CallerMode {
+        None,
+        Broadcast,
+        RecurrentBroadcast,
+        Prank,
+        RecurrentPrank
+    }
+
     struct DirEntry {
         string errorMessage;
         string path;
@@ -93,7 +101,7 @@ interface VmSafe {
         pure
         returns (uint256 privateKey);
 
-    /// @dev Reads environment variables
+    /// @dev Reads environment variables, (name) => (value)
     function envAddress(string calldata name) external view returns (address value);
 
     function envBool(string calldata name) external view returns (bool value);
@@ -678,6 +686,10 @@ interface Vm is VmSafe {
     /// If used on unsupported EVM versions, it will revert.
     function prevrandao(bytes32 newPrevrandao) external;
 
+    /// @dev Reads the current `msg.sender` and `tx.origin` from state and reports if there is any active caller
+    /// modification.
+    function readCallers() external returns (CallerMode callerMode, address msgSender, address txOrigin);
+
     /// @dev Removes a file from the filesystem.
     /// This cheatcode will revert in the following situations, but is not limited to just these cases:
     ///   - `path` points to a directory.
@@ -727,6 +739,9 @@ interface Vm is VmSafe {
     /// @dev Sets the nonce of an account to an arbitrary value.
     function setNonceUnsafe(address account, uint64 newNonce) external;
 
+    /// @dev Marks a test as skipped. Must be called at the top of the test.
+    function skip(bool skipTest) external;
+
     /// @dev Snapshot the current state of the EVM.
     /// Returns the id of the snapshot that was created.
     /// To revert a snapshot use `revertTo`.