Merge pull request #2013 from multiversx/check-state-partial-keys

fix for checking partial keys with checkState

Author: andrei-marinica

contracts/feature-tests/scenario-tester/scenarios/st-partial-key-check.scen.json

@@ -0,0 +1,76 @@
+{
+    "steps": [
+        {
+            "step": "setState",
+            "accounts": {
+                "address:owner": {
+                    "nonce": "1"
+                }
+            }
+        },
+        {
+            "step": "setState",
+            "newAddresses": [
+                {
+                    "creatorAddress": "address:owner",
+                    "creatorNonce": "1",
+                    "newAddress": "sc:scenario-tester"
+                }
+            ]
+        },
+        {
+            "step": "scDeploy",
+            "id": "",
+            "tx": {
+                "from": "address:owner",
+                "contractCode": "mxsc:../output/scenario-tester.mxsc.json",
+                "arguments": [
+                    "0x01"
+                ],
+                "gasLimit": "5,000,000"
+            },
+            "expect": {
+                "out": [
+                    "0x696e69742d726573756c74"
+                ],
+                "status": "0"
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "",
+            "tx": {
+                "from": "address:owner",
+                "to": "sc:scenario-tester",
+                "function": "set_other_mapper",
+                "arguments": [
+                    "0x536f6d6556616c7565496e53746f72616765"
+                ],
+                "gasLimit": "5,000,000"
+            },
+            "expect": {
+                "out": [],
+                "status": "0"
+            }
+        },
+        {
+            "step": "checkState",
+            "accounts": {
+                "address:owner": {
+                    "nonce": "*",
+                    "balance": "0",
+                    "storage": {},
+                    "code": ""
+                },
+                "sc:scenario-tester": {
+                    "storage": {
+                        "str:otherMapper": "str:SomeValueInStorage",
+                        "+": ""
+                    },
+                    "code": "*",
+                    "owner": "address:owner"
+                }
+            }
+        }
+    ]
+}

contracts/feature-tests/scenario-tester/src/lib.rs

@@ -12,6 +12,10 @@ pub trait ScenarioTester {
     #[storage_mapper("sum")]
     fn sum(&self) -> SingleValueMapper<BigUint>;
 
+    #[view(getOtherMapper)]
+    #[storage_mapper("otherMapper")]
+    fn other_mapper(&self) -> SingleValueMapper<ManagedBuffer>;
+
     /// Return value for testing reasons.
     #[init]
     fn init(&self, initial_value: BigUint) -> &'static str {
@@ -30,6 +34,12 @@ pub trait ScenarioTester {
         self.sum().update(|sum| *sum += value);
     }
 
+    /// Sets a value at another key
+    #[endpoint]
+    fn set_other_mapper(&self, value: ManagedBuffer) {
+        self.other_mapper().set(value);
+    }
+
     /// Tests "from" conversion for MultiValueN parameters
     #[endpoint]
     fn multi_param(&self, _value: MultiValue2<BigUint, BigUint>) {}

contracts/feature-tests/scenario-tester/src/scenario_tester_proxy.rs

@@ -99,6 +99,15 @@ where
             .original_result()
     }
 
+    pub fn other_mapper(
+        self,
+    ) -> TxTypedCall<Env, From, To, NotPayable, Gas, ManagedBuffer<Env::Api>> {
+        self.wrapped_tx
+            .payment(NotPayable)
+            .raw_call("getOtherMapper")
+            .original_result()
+    }
+
     /// Add desired amount to the storage variable. 
     pub fn add<
         Arg0: ProxyArg<BigUint<Env::Api>>,
@@ -113,6 +122,20 @@ where
             .original_result()
     }
 
+    /// Sets a value at another key 
+    pub fn set_other_mapper<
+        Arg0: ProxyArg<ManagedBuffer<Env::Api>>,
+    >(
+        self,
+        value: Arg0,
+    ) -> TxTypedCall<Env, From, To, NotPayable, Gas, ()> {
+        self.wrapped_tx
+            .payment(NotPayable)
+            .raw_call("set_other_mapper")
+            .argument(&value)
+            .original_result()
+    }
+
     /// Tests "from" conversion for MultiValueN parameters 
     pub fn multi_param<
         Arg0: ProxyArg<MultiValue2<BigUint<Env::Api>, BigUint<Env::Api>>>,

contracts/feature-tests/scenario-tester/tests/st_blackbox_test.rs

@@ -387,3 +387,37 @@ fn st_blackbox_returns_result_or_error() {
         ))
     );
 }
+
+#[test]
+fn st_blackbox_storage_check_test() {
+    let mut world = world();
+
+    world.account(OWNER_ADDRESS).nonce(1);
+
+    // set value for sum in storage
+    let new_address = world
+        .tx()
+        .from(OWNER_ADDRESS)
+        .typed(scenario_tester_proxy::ScenarioTesterProxy)
+        .init(BigUint::from(1u64))
+        .code(CODE_PATH)
+        .new_address(ST_ADDRESS)
+        .returns(ReturnsNewAddress)
+        .run();
+
+    assert_eq!(new_address, ST_ADDRESS.to_address());
+
+    // set value for otherMapper in storage
+    world
+        .tx()
+        .from(OWNER_ADDRESS)
+        .to(ST_ADDRESS)
+        .typed(scenario_tester_proxy::ScenarioTesterProxy)
+        .set_other_mapper(b"SomeValueInStorage")
+        .run();
+
+    // only check value for one key (partial check)
+    world
+        .check_account(ST_ADDRESS)
+        .check_storage("str:otherMapper", "str:SomeValueInStorage");
+}

contracts/feature-tests/scenario-tester/tests/st_scenario_go_test.rs

@@ -13,3 +13,8 @@ fn interactor_trace_go() {
 fn st_adder_go() {
     world().run("scenarios/st-adder.scen.json");
 }
+
+#[test]
+fn st_partial_key_check_go() {
+    world().run("scenarios/st-partial-key-check.scen.json");
+}

contracts/feature-tests/scenario-tester/tests/st_scenario_rs_test.rs

@@ -20,3 +20,8 @@ fn interactor_trace_rs() {
 fn st_adder_rs() {
     world().run("scenarios/st-adder.scen.json");
 }
+
+#[test]
+fn st_partial_key_check_rs() {
+    world().run("scenarios/st-partial-key-check.scen.json");
+}

contracts/feature-tests/scenario-tester/wasm/src/lib.rs

@@ -6,9 +6,9 @@
 
 // Init:                                 1
 // Upgrade:                              1
-// Endpoints:                            5
+// Endpoints:                            7
 // Async Callback (empty):               1
-// Total number of exported functions:   8
+// Total number of exported functions:  10
 
 #![no_std]
 
@@ -21,7 +21,9 @@ multiversx_sc_wasm_adapter::endpoints! {
         init => init
         upgrade => upgrade
         getSum => sum
+        getOtherMapper => other_mapper
         add => add
+        set_other_mapper => set_other_mapper
         multi_param => multi_param
         multi_return => multi_return
         sc_panic => sc_panic

framework/scenario/src/facade/world_tx/scenario_check_state.rs

@@ -218,6 +218,7 @@ impl<'w> CheckStateBuilder<'w> {
             CheckStorage::Star => CheckStorageDetails::default(),
             CheckStorage::Equal(details) => details.clone(),
         };
+        details.other_storages_allowed = true;
         details.storages.insert(
             BytesKey::interpret_from(key, &InterpreterContext::default()),
             CheckValue::Equal(BytesValue::interpret_from(