feat: added vm.keyExistsJson

crates/cheatcodes/spec/src/vm.rs

@@ -1661,8 +1661,12 @@ interface Vm {
     // limitations and caveats of the JSON parsing cheats.
 
     /// Checks if `key` exists in a JSON object.
-    #[cheatcode(group = Json)]
+    /// `keyExists` is being deprecated in favor of `keyExistsJson`. It will be removed in future versions.
+    #[cheatcode(group = Json, status = Deprecated)]
     function keyExists(string calldata json, string calldata key) external view returns (bool);
+    /// Checks if `key` exists in a JSON object.
+    #[cheatcode(group = Json)]
+    function keyExistsJson(string calldata json, string calldata key) external view returns (bool);
 
     /// ABI-encodes a JSON object.
     #[cheatcode(group = Json)]

crates/cheatcodes/src/json.rs

@@ -12,10 +12,14 @@ use std::{borrow::Cow, collections::BTreeMap, fmt::Write};
 impl Cheatcode for keyExistsCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { json, key } = self;
-        let json = parse_json_str(json)?;
-        let values = select(&json, key)?;
-        let exists = !values.is_empty();
-        Ok(exists.abi_encode())
+        check_json_key_exists(json, key)
+    }
+}
+
+impl Cheatcode for keyExistsJsonCall {
+    fn apply(&self, _state: &mut Cheatcodes) -> Result {
+        let Self { json, key } = self;
+        check_json_key_exists(json, key)
     }
 }
 
@@ -280,6 +284,13 @@ impl Cheatcode for writeJson_1Call {
     }
 }
 
+pub(super) fn check_json_key_exists(json: &str, key: &str) -> Result {
+    let json = parse_json_str(json)?;
+    let values = select(&json, key)?;
+    let exists = !values.is_empty();
+    Ok(exists.abi_encode())
+}
+
 fn parse_json(json: &str, path: &str) -> Result {
     let value = parse_json_str(json)?;
     let selected = select(&value, path)?;

crates/evm/traces/src/decoder/mod.rs

@@ -434,7 +434,9 @@ impl CallTraceDecoder {
             "parseJsonBytes32" |
             "parseJsonBytes32Array" |
             "writeJson" |
+            // `keyExists` is being deprecated in favor of `keyExistsJson`. It will be removed in future versions.
             "keyExists" |
+            "keyExistsJson" |
             "serializeBool" |
             "serializeUint" |
             "serializeInt" |
@@ -447,7 +449,11 @@ impl CallTraceDecoder {
                 } else {
                     let mut decoded = func.abi_decode_input(&data[SELECTOR_LEN..], false).ok()?;
                     let token =
-                        if func.name.as_str() == "parseJson" || func.name.as_str() == "keyExists" {
+
+                    if func.name.as_str() == "parseJson" || 
+                        // `keyExists` is being deprecated in favor of `keyExistsJson`. It will be removed in future versions.
+                        func.name.as_str() == "keyExists" || 
+                        func.name.as_str() == "keyExistsJson" {
                             "<JSON file>"
                         } else {
                             "<stringified JSON>"

testdata/cheats/Json.t.sol

@@ -286,6 +286,28 @@ contract WriteJsonTest is DSTest {
         assertEq(decodedData.a, 123);
     }
 
+    function test_checkKeyExistsJson() public {
+        string memory path = "fixtures/Json/write_complex_test.json";
+        string memory json = vm.readFile(path);
+        bool exists = vm.keyExistsJson(json, ".a");
+        assertTrue(exists);
+
+        // TODO: issue deprecation warning
+        exists = vm.keyExists(json, ".a");
+        assertTrue(exists);
+    }
+
+    function test_checkKeyDoesNotExistJson() public {
+        string memory path = "fixtures/Json/write_complex_test.json";
+        string memory json = vm.readFile(path);
+        bool exists = vm.keyExistsJson(json, ".d");
+        assertTrue(!exists);
+
+        // TODO: issue deprecation warning
+        exists = vm.keyExists(json, ".d");
+        assertTrue(!exists);
+    }
+
     function test_checkKeyExists() public {
         string memory path = "fixtures/Json/write_complex_test.json";
         string memory json = vm.readFile(path);