Include empty mapping keys (#85)

GiovanniTorrisi-ChainSecurity · Stefan Effenberger · web-flow · commit 089fd719ec81 · 2026-02-26T14:23:12.000+01:00
* Delete DVF file regardless of test outcome

* Debug issue and fix

* Add tests for empty key in string and byte mapping

* Update decode test data

* Clean up

* Fix decodign test

* updated test case dvfs

* updated e2e tests to use different ports in all cases

---------

Co-authored-by: Stefan Effenberger &lt;stefan.effenberger@chainsecurity.com&gt;
diff --git a/lib/state/contract_state.rs b/lib/state/contract_state.rs
@@ -366,7 +366,7 @@ impl<'a> ContractState<'a> {
                             )
                         );
                         // Look for mapping usages
-                        if length_in_bytes > U256::from(32_u64)
+                        if length_in_bytes >= U256::from(32_u64)
                             && length_in_bytes < U256::from(usize::MAX / 2)
                         {
                             let usize_str_length =
diff --git a/lib/web3.rs b/lib/web3.rs
@@ -2047,7 +2047,7 @@ impl StorageSnapshot {
         }
     }
 
-    // Collect all storage slots that have not previously been queried
+    // Collect all storage slots that have not been queried previously
     pub fn get_unused_nonzero_storage_slots(&self) -> Vec<UnusedStoragePart> {
         let mut unused_storage_parts: Vec<UnusedStoragePart> = vec![];
 
diff --git a/tests/Contracts/src/BytesMapping.sol b/tests/Contracts/src/BytesMapping.sol
@@ -12,6 +12,7 @@ contract BytesMapping {
         x[bytes("Hello this is a test")] = 5;
         x[bytes("A veryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryvery long string")] = 42;
         b = bytes("Just some normal bytes.");
+        x[bytes("")] = 42;
     }
 
     function f() external {
diff --git a/tests/Contracts/src/StringMapping.sol b/tests/Contracts/src/StringMapping.sol
@@ -12,6 +12,7 @@ contract StringMapping {
         x["A veryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryvery long string"] = 42;
         y["abc"] = "a short string";
         y["a"] = "A veryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryvery long string.";
+        x[""] = 42;
         emit SomeE("EventData", 1000);
     }
 
diff --git a/tests/expected_dvfs/Deploy_0.dvf.json b/tests/expected_dvfs/Deploy_0.dvf.json
@@ -21,6 +21,15 @@
       "value_hint": "4a75737420736f6d65206e6f726d616c2062797465732e",
       "comparison_operator": "Equal"
     },
+    {
+      "slot": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
+      "offset": 0,
+      "var_name": "x[0x]",
+      "var_type": "t_uint256",
+      "value": "0x000000000000000000000000000000000000000000000000000000000000002a",
+      "value_hint": "42",
+      "comparison_operator": "Equal"
+    },
     {
       "slot": "0x4a8918e67ba0b26637797e1472ee3d675d66efda39253f7139f8eabc58b20ffb",
       "offset": 0,
diff --git a/tests/expected_dvfs/Deploy_0_b1.dvf.json b/tests/expected_dvfs/Deploy_0_b1.dvf.json
@@ -1,12 +1,12 @@
 {
   "version": "0.9.1",
-  "id": "0x4be820f0e3915aa5f0cc36ac62260161931c5873c01ed998e18c5f62fbcd2ed0",
+  "id": "0x25996dc252a0472b41456da06f497121e6d712e89eb3d46b84765f3759640a5b",
   "contract_name": "BytesMapping",
   "address": "0x5fbdb2315678afecb367f032d93f642f64180aa3",
-  "chain_id": 1337,
+  "chain_id": 31337,
   "deployment_block_num": 2,
   "init_block_num": 2,
-  "deployment_tx": "0x11819f70620f7d3a7a69eee5e9ad55cedec78c9fc5a83ab743fdec42a77ab504",
+  "deployment_tx": "0xa2179eff8c7827da8b42a4b2a304d7449f49a8923818b21e553fdb7c8b3357cb",
   "codehash": "0x3867a08d0f6ad7f18a522cb18383fa3eb688bbde257d84652a614fda9167b190",
   "insecure": false,
   "immutables": [],
@@ -21,6 +21,15 @@
       "value_hint": "4a75737420736f6d65206e6f726d616c2062797465732e",
       "comparison_operator": "Equal"
     },
+    {
+      "slot": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
+      "offset": 0,
+      "var_name": "x[0x]",
+      "var_type": "t_uint256",
+      "value": "0x000000000000000000000000000000000000000000000000000000000000002a",
+      "value_hint": "42",
+      "comparison_operator": "Equal"
+    },
     {
       "slot": "0x4a8918e67ba0b26637797e1472ee3d675d66efda39253f7139f8eabc58b20ffb",
       "offset": 0,
diff --git a/tests/expected_dvfs/Deploy_0_updated.dvf.json b/tests/expected_dvfs/Deploy_0_updated.dvf.json
@@ -20,6 +20,15 @@
       "value_hint": "4a75737420736f6d65206e6f726d616c2062797465732e",
       "comparison_operator": "Equal"
     },
+    {
+      "slot": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
+      "offset": 0,
+      "var_name": "x[0x]",
+      "var_type": "t_uint256",
+      "value": "0x000000000000000000000000000000000000000000000000000000000000002a",
+      "value_hint": "42",
+      "comparison_operator": "Equal"
+    },
     {
       "slot": "0x4a8918e67ba0b26637797e1472ee3d675d66efda39253f7139f8eabc58b20ffb",
       "offset": 0,
diff --git a/tests/expected_dvfs/Deploy_1.dvf.json b/tests/expected_dvfs/Deploy_1.dvf.json
@@ -12,6 +12,15 @@
   "immutables": [],
   "constructor_args": [],
   "critical_storage_variables": [
+    {
+      "slot": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
+      "offset": 0,
+      "var_name": "x[]",
+      "var_type": "t_uint256",
+      "value": "0x000000000000000000000000000000000000000000000000000000000000002a",
+      "value_hint": "42",
+      "comparison_operator": "Equal"
+    },
     {
       "slot": "0x2fccf76901d0aa8dbb54cf0f8d3d8db6b27e630b57020bc913d21efd33831cbc",
       "offset": 0,
diff --git a/tests/expected_dvfs/Deploy_1_b1.dvf.json b/tests/expected_dvfs/Deploy_1_b1.dvf.json
@@ -1,17 +1,26 @@
 {
   "version": "0.9.1",
-  "id": "0xddec5fab35250ee9bb557688e3df2c8ddca9c277e454546e5358aa48a1dfd25c",
+  "id": "0x62fabab8f05c6d0fd7dfe72a984b8a9260ca936be36a3a203e40d8143d4240f0",
   "contract_name": "StringMapping",
   "address": "0x5fbdb2315678afecb367f032d93f642f64180aa3",
-  "chain_id": 1337,
+  "chain_id": 31337,
   "deployment_block_num": 2,
   "init_block_num": 2,
-  "deployment_tx": "0xbd44492ce35b11b438be83b11fef8e1f18f3dd1f847c791083f3659d2a66885c",
+  "deployment_tx": "0x7a0aa5e701e0c9d0e249bf3ae61a1723583ab168eec26b652e6d7331ea3980fb",
   "codehash": "0x2feab59f98325c0ad112156daca7c79dc9e9e17c16be3e374874788370b91e02",
   "insecure": false,
   "immutables": [],
   "constructor_args": [],
   "critical_storage_variables": [
+    {
+      "slot": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
+      "offset": 0,
+      "var_name": "x[]",
+      "var_type": "t_uint256",
+      "value": "0x000000000000000000000000000000000000000000000000000000000000002a",
+      "value_hint": "42",
+      "comparison_operator": "Equal"
+    },
     {
       "slot": "0x2fccf76901d0aa8dbb54cf0f8d3d8db6b27e630b57020bc913d21efd33831cbc",
       "offset": 0,
diff --git a/tests/expected_dvfs/Deploy_1_updated.dvf.json b/tests/expected_dvfs/Deploy_1_updated.dvf.json
@@ -11,6 +11,15 @@
   "immutables": [],
   "constructor_args": [],
   "critical_storage_variables": [
+    {
+      "slot": "0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563",
+      "offset": 0,
+      "var_name": "x[]",
+      "var_type": "t_uint256",
+      "value": "0x000000000000000000000000000000000000000000000000000000000000002a",
+      "value_hint": "42",
+      "comparison_operator": "Equal"
+    },
     {
       "slot": "0x2fccf76901d0aa8dbb54cf0f8d3d8db6b27e630b57020bc913d21efd33831cbc",
       "offset": 0,
diff --git a/tests/test_end_to_end.rs b/tests/test_end_to_end.rs
@@ -779,7 +779,7 @@ mod tests {
 
     #[test]
     fn test_e2e_proxy_upgrade() {
-        let port = 8548u16;
+        let port = 8557u16;
         let config_file = match DVFConfig::test_config_file(Some(port)) {
             Ok(config) => config,
             Err(err) => {
@@ -1331,7 +1331,7 @@ mod tests {
 
     #[test]
     fn test_e2e_failing_validate_events() {
-        let port = 8551u16;
+        let port = 8558u16;
         let config_file = match DVFConfig::test_config_file(Some(port)) {
             Ok(config) => config,
             Err(err) => {

Original file line number	Diff line number	Diff line change
`@@ -366,7 +366,7 @@ impl<'a> ContractState<'a> {`
`366`	`366`	`)`
`367`	`367`	`);`
`368`	`368`	`// Look for mapping usages`
`369`		`- if length_in_bytes > U256::from(32_u64)`
	`369`	`+ if length_in_bytes >= U256::from(32_u64)`
`370`	`370`	`&& length_in_bytes < U256::from(usize::MAX / 2)`
`371`	`371`	`{`
`372`	`372`	`let usize_str_length =`
Original file line number	Diff line number	Diff line change
`@@ -2047,7 +2047,7 @@ impl StorageSnapshot {`
`2047`	`2047`	`}`
`2048`	`2048`	`}`
`2049`	`2049`
`2050`		`- // Collect all storage slots that have not previously been queried`
	`2050`	`+ // Collect all storage slots that have not been queried previously`
`2051`	`2051`	`pub fn get_unused_nonzero_storage_slots(&self) -> Vec<UnusedStoragePart> {`
`2052`	`2052`	`let mut unused_storage_parts: Vec<UnusedStoragePart> = vec![];`
`2053`	`2053`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ contract BytesMapping {`
`12`	`12`	`x[bytes("Hello this is a test")] = 5;`
`13`	`13`	`x[bytes("A veryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryvery long string")] = 42;`
`14`	`14`	`b = bytes("Just some normal bytes.");`
	`15`	`+ x[bytes("")] = 42;`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`function f() external {`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ contract StringMapping {`
`12`	`12`	`x["A veryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryvery long string"] = 42;`
`13`	`13`	`y["abc"] = "a short string";`
`14`	`14`	`y["a"] = "A veryveryveryveryveryveryveryveryveryveryveryveryveryveryveryveryvery long string.";`
	`15`	`+ x[""] = 42;`
`15`	`16`	`emit SomeE("EventData", 1000);`
`16`	`17`	`}`
`17`	`18`