From ab6de56ed94bed75866c78c62cad882e8a046348 Mon Sep 17 00:00:00 2001
From: zerosnacks <95942363+zerosnacks@users.noreply.github.com>
Date: Tue, 1 Oct 2024 20:48:53 +0200
Subject: [PATCH] fix: update snapshot cheatcodes (#613)

* update cheatcodes

* fix interface id
---
 src/Vm.sol    | 29 ++++++++++++++++++++++-------
 test/Vm.t.sol |  2 +-
 2 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/src/Vm.sol b/src/Vm.sol
index 591508c0..33466d21 100644
--- a/src/Vm.sol
+++ b/src/Vm.sol
@@ -1687,10 +1687,10 @@ interface Vm is VmSafe {
     /// Takes the snapshot ID to delete.
     /// Returns `true` if the snapshot was successfully deleted.
     /// Returns `false` if the snapshot does not exist.
-    function deleteSnapshot(uint256 snapshotId) external returns (bool success);
+    function deleteStateSnapshot(uint256 snapshotId) external returns (bool success);
 
     /// Removes _all_ snapshots previously created by `snapshot`.
-    function deleteSnapshots() external;
+    function deleteStateSnapshots() external;
 
     /// Sets `block.difficulty`.
     /// Not available on EVM versions from Paris onwards. Use `prevrandao` instead.
@@ -1781,14 +1781,14 @@ interface Vm is VmSafe {
     /// Takes the snapshot ID to revert to.
     /// Returns `true` if the snapshot was successfully reverted.
     /// Returns `false` if the snapshot does not exist.
-    /// **Note:** This does not automatically delete the snapshot. To delete the snapshot use `deleteSnapshot`.
-    function revertTo(uint256 snapshotId) external returns (bool success);
+    /// **Note:** This does not automatically delete the snapshot. To delete the snapshot use `deleteStateSnapshot`.
+    function revertToState(uint256 snapshotId) external returns (bool success);
 
     /// Revert the state of the EVM to a previous snapshot and automatically deletes the snapshots
     /// Takes the snapshot ID to revert to.
     /// Returns `true` if the snapshot was successfully reverted and deleted.
     /// Returns `false` if the snapshot does not exist.
-    function revertToAndDelete(uint256 snapshotId) external returns (bool success);
+    function revertToStateAndDelete(uint256 snapshotId) external returns (bool success);
 
     /// Revokes persistent status from the address, previously added via `makePersistent`.
     function revokePersistent(address account) external;
@@ -1828,8 +1828,8 @@ interface Vm is VmSafe {
 
     /// Snapshot the current state of the evm.
     /// Returns the ID of the snapshot that was created.
-    /// To revert a snapshot use `revertTo`.
-    function snapshot() external returns (uint256 snapshotId);
+    /// To revert a snapshot use `revertToState`.
+    function snapshotState() external returns (uint256 snapshotId);
 
     /// Sets all subsequent calls' `msg.sender` to be the input address until `stopPrank` is called.
     function startPrank(address msgSender) external;
@@ -1855,6 +1855,21 @@ interface Vm is VmSafe {
     /// Sets `block.timestamp`.
     function warp(uint256 newTimestamp) external;
 
+    /// `deleteSnapshot` is being deprecated in favor of `deleteStateSnapshot`. It will be removed in future versions.
+    function deleteSnapshot(uint256 snapshotId) external returns (bool success);
+
+    /// `deleteSnapshots` is being deprecated in favor of `deleteStateSnapshots`. It will be removed in future versions.
+    function deleteSnapshots() external;
+
+    /// `revertToAndDelete` is being deprecated in favor of `revertToStateAndDelete`. It will be removed in future versions.
+    function revertToAndDelete(uint256 snapshotId) external returns (bool success);
+
+    /// `revertTo` is being deprecated in favor of `revertToState`. It will be removed in future versions.
+    function revertTo(uint256 snapshotId) external returns (bool success);
+
+    /// `snapshot` is being deprecated in favor of `snapshotState`. It will be removed in future versions.
+    function snapshot() external returns (uint256 snapshotId);
+
     // ======== Testing ========
 
     /// Expect a call to an address with the specified `msg.value` and calldata, and a *minimum* amount of gas.
diff --git a/test/Vm.t.sol b/test/Vm.t.sol
index 7135409d..c08a57ae 100644
--- a/test/Vm.t.sol
+++ b/test/Vm.t.sol
@@ -9,7 +9,7 @@ import {Vm, VmSafe} from "../src/Vm.sol";
 // added to or removed from Vm or VmSafe.
 contract VmTest is Test {
     function test_VmInterfaceId() public pure {
-        assertEq(type(Vm).interfaceId, bytes4(0xa561dbe8), "Vm");
+        assertEq(type(Vm).interfaceId, bytes4(0x29bd9d0a), "Vm");
     }
 
     function test_VmSafeInterfaceId() public pure {