Merge pull request #1503 from multiversx/rh-rename

Result handlers renamed
multiversx · Mar 26, 2024 · 125a765 · 125a765
2 parents 8c28032 + cd8f93e
commit 125a765
Show file tree

Hide file tree

Showing 20 changed files with 115 additions and 103 deletions.
diff --git a/contracts/examples/adder/interact/src/basic_interact.rs b/contracts/examples/adder/interact/src/basic_interact.rs
@@ -8,7 +8,7 @@ use basic_interact_state::State;
 use clap::Parser;
 use multiversx_sc_snippets::{
     env_logger,
-    multiversx_sc::types::{Address, ReturnsNewAddress, ReturnsSimilar},
+    multiversx_sc::types::{Address, ReturnsNewAddress, ReturnsResultConv},
     multiversx_sc_scenario::{
         api::StaticApi,
         bech32,
@@ -197,7 +197,7 @@ impl AdderInteract {
             .to(self.state.adder().to_address())
             .typed(adder_proxy::AdderProxy)
             .sum()
-            .returns(ReturnsSimilar::<BigUint>::new())
+            .returns(ReturnsResultConv::<BigUint>::new())
             .prepare_async()
             .run()
             .await;

diff --git a/contracts/examples/adder/tests/adder_blackbox_chained_test.rs b/contracts/examples/adder/tests/adder_blackbox_chained_test.rs
@@ -1,5 +1,5 @@
 use adder::*;
-use multiversx_sc::types::{AddressExpr, ScExpr, WithResultNewAddress, WithResultSimilar};
+use multiversx_sc::types::{AddressExpr, ScExpr, WithNewAddress, WithResultConv};
 use multiversx_sc_scenario::{api::StaticApi, num_bigint::BigUint, scenario_model::*, *};
 
 const ADDER_PATH_EXPR: &str = "mxsc:output/adder.mxsc.json";
@@ -30,15 +30,15 @@ fn adder_blackbox_chained() {
                 .typed(adder_proxy::AdderProxy)
                 .init(5u32)
                 .code(MxscExpr("output/adder.mxsc.json"))
-                .with_result(WithResultNewAddress::new(|new_address| {
+                .with_result(WithNewAddress::new(|new_address| {
                     assert_eq!(new_address.to_address(), adder_contract.to_address());
                 }))
         })
         .chain_query(|tx| {
             tx.to(ScExpr("adder"))
                 .typed(adder_proxy::AdderProxy)
                 .sum()
-                .with_result(WithResultSimilar::new(|value: BigUint| {
+                .with_result(WithResultConv::new(|value: BigUint| {
                     assert_eq!(value, BigUint::from(5u32));
                 }))
         })

diff --git a/contracts/examples/adder/tests/adder_blackbox_legacy_proxy_test.rs b/contracts/examples/adder/tests/adder_blackbox_legacy_proxy_test.rs
@@ -1,7 +1,7 @@
 use adder::*;
 use multiversx_sc::{
     storage::mappers::SingleValue,
-    types::{AddressExpr, ReturnsSimilar, WithResultNewAddress},
+    types::{AddressExpr, ReturnsResultConv, WithNewAddress},
 };
 use multiversx_sc_scenario::{api::StaticApi, num_bigint::BigUint, scenario_model::*, *};
 
@@ -38,7 +38,7 @@ fn adder_blackbox_legacy_proxy() {
         .typed(adder_proxy::AdderProxy)
         .init(5u32)
         .code(CODE_EXPR)
-        .with_result(WithResultNewAddress::new(|new_address| {
+        .with_result(WithNewAddress::new(|new_address| {
             assert_eq!(new_address.to_address(), adder_contract.to_address());
         }))
         .run();
@@ -53,7 +53,7 @@ fn adder_blackbox_legacy_proxy() {
     let value = world
         .query()
         .call(adder_contract.sum())
-        .returns(ReturnsSimilar::<SingleValue<BigUint>>::new())
+        .returns(ReturnsResultConv::<SingleValue<BigUint>>::new())
         .run();
     assert_eq!(value.into(), BigUint::from(5u32));
 

diff --git a/contracts/examples/adder/tests/adder_blackbox_test.rs b/contracts/examples/adder/tests/adder_blackbox_test.rs
@@ -1,5 +1,5 @@
 use adder::*;
-use multiversx_sc::types::{AddressExpr, ReturnsSimilar, ScExpr, WithResultNewAddress};
+use multiversx_sc::types::{AddressExpr, ReturnsResultConv, ScExpr, WithNewAddress};
 use multiversx_sc_scenario::{api::StaticApi, num_bigint::BigUint, scenario_model::*, *};
 
 const ADDER_PATH_EXPR: &str = "mxsc:output/adder.mxsc.json";
@@ -36,7 +36,7 @@ fn adder_blackbox() {
         .typed(adder_proxy::AdderProxy)
         .init(5u32)
         .code(CODE_EXPR)
-        .with_result(WithResultNewAddress::new(|new_address| {
+        .with_result(WithNewAddress::new(|new_address| {
             assert_eq!(new_address.to_address(), adder_contract.to_address());
         }))
         .run();
@@ -46,7 +46,7 @@ fn adder_blackbox() {
         .to(SC_ADDER)
         .typed(adder_proxy::AdderProxy)
         .sum()
-        .returns(ReturnsSimilar::<BigUint>::new())
+        .returns(ReturnsResultConv::<BigUint>::new())
         .run();
     assert_eq!(value, BigUint::from(5u32));
 

diff --git a/contracts/examples/multisig/tests/multisig_blackbox_test.rs b/contracts/examples/multisig/tests/multisig_blackbox_test.rs
@@ -9,7 +9,7 @@ use multiversx_sc::{
         test_util::top_encode_to_vec_u8_or_panic,
     },
     storage::mappers::SingleValue,
-    types::{Address, AddressExpr, CodeMetadata, FunctionCall, ReturnsExact},
+    types::{Address, AddressExpr, CodeMetadata, FunctionCall, ReturnsResult},
 };
 use multiversx_sc_scenario::{
     api::StaticApi,
@@ -131,7 +131,7 @@ impl MultisigTestState {
                 self.multisig_contract
                     .propose_add_board_member(board_member_address),
             )
-            .returns(ReturnsExact)
+            .returns(ReturnsResult)
             .run()
     }
 

diff --git a/contracts/feature-tests/composability/forwarder-raw/src/forwarder_raw_deploy_upgrade.rs b/contracts/feature-tests/composability/forwarder-raw/src/forwarder_raw_deploy_upgrade.rs
@@ -16,7 +16,7 @@ pub trait ForwarderRawDeployUpgrade {
             .arguments_raw(args.to_arg_buffer())
             .with_gas_limit(self.blockchain().get_gas_left())
             .returns(ReturnsNewAddress)
-            .returns(ReturnsRaw)
+            .returns(ReturnsRawResult)
             .sync_call()
             .into()
     }

diff --git a/contracts/feature-tests/composability/forwarder-raw/src/forwarder_raw_sync.rs b/contracts/feature-tests/composability/forwarder-raw/src/forwarder_raw_sync.rs
@@ -20,7 +20,7 @@ pub trait ForwarderRawSync: super::forwarder_raw_common::ForwarderRawCommon {
             .function_name(endpoint_name)
             .argument(&args)
             .with_gas_limit(half_gas)
-            .returns(ReturnsRaw)
+            .returns(ReturnsRawResult)
             .sync_call();
 
         self.execute_on_dest_context_result(result);

diff --git a/framework/base/src/contract_base/wrappers/send_wrapper.rs b/framework/base/src/contract_base/wrappers/send_wrapper.rs
@@ -12,7 +12,7 @@ use crate::{
     },
     codec,
     esdt::ESDTSystemSmartContractProxy,
-    proxy_imports::{ReturnsRaw, ToSelf},
+    proxy_imports::{ReturnsRawResult, ToSelf},
     types::{
         BigUint, ContractCall, ContractCallNoPayment, EgldOrEsdtTokenIdentifier, EsdtTokenPayment,
         ManagedAddress, ManagedArgBuffer, ManagedBuffer, ManagedType, ManagedVec, TokenIdentifier,
@@ -390,7 +390,7 @@ where
             .raw_call()
             .function_name(endpoint_name)
             .arguments_raw(arg_buffer)
-            .returns(ReturnsRaw)
+            .returns(ReturnsRawResult)
             .sync_call()
     }
 

diff --git a/framework/base/src/types/interaction/tx_result_handler.rs b/framework/base/src/types/interaction/tx_result_handler.rs
@@ -1,3 +1,21 @@
+mod returns_bt;
+mod returns_new_address;
+mod returns_raw_result;
+mod returns_result;
+mod returns_result_conv;
+mod with_new_address;
+mod with_raw_result;
+mod with_result;
+mod with_result_conv;
+
+pub use returns_bt::*;
+pub use returns_new_address::*;
+pub use returns_raw_result::*;
+pub use returns_result::*;
+pub use returns_result_conv::*;
+pub use with_new_address::*;
+pub use with_result_conv::*;
+
 use super::TxEnv;
 
 pub trait TxResultHandler<Env>

diff --git a/...ypes/interaction/tx_rh_list/returns_bt.rs → ...teraction/tx_result_handler/returns_bt.rs b/...ypes/interaction/tx_rh_list/returns_bt.rs → ...teraction/tx_result_handler/returns_bt.rs
@@ -1,10 +1,11 @@
 use crate::{
     contract_base::BlockchainWrapper,
-    types::{BackTransfers, ManagedAddress, ManagedBuffer, ManagedVec, TxEnv},
+    types::{
+        BackTransfers, ManagedAddress, ManagedBuffer, ManagedVec, RHListItem, RHListItemExec, TxEnv,
+    },
 };
 
-use super::{RHListItem, RHListItemExec};
-
+/// Indicates that back-transfers will be returned.
 pub struct ReturnsBackTransfers;
 
 impl<Env, Original> RHListItem<Env, Original> for ReturnsBackTransfers

diff --git a/...raction/tx_rh_list/returns_new_address.rs → .../tx_result_handler/returns_new_address.rs b/...raction/tx_rh_list/returns_new_address.rs → .../tx_result_handler/returns_new_address.rs
@@ -1,7 +1,8 @@
-use crate::types::{DeployRawResult, ManagedAddress, ManagedBuffer, ManagedVec, TxEnv};
-
-use super::{RHListItem, RHListItemExec};
+use crate::types::{
+    DeployRawResult, ManagedAddress, ManagedBuffer, ManagedVec, RHListItem, RHListItemExec, TxEnv,
+};
 
+/// Indicates that the newly deployed address will be returned after a deploy.
 pub struct ReturnsNewAddress;
 
 impl<Env, Original> RHListItem<Env, Original> for ReturnsNewAddress

diff --git a/...pes/interaction/tx_rh_list/returns_raw.rs → ...n/tx_result_handler/returns_raw_result.rs b/...pes/interaction/tx_rh_list/returns_raw.rs → ...n/tx_result_handler/returns_raw_result.rs
@@ -1,20 +1,19 @@
-use crate::{
-    proxy_imports::SyncCallRawResult,
-    types::{DeployRawResult, ManagedAddress, ManagedBuffer, ManagedVec, TxEnv},
+use crate::types::{
+    DeployRawResult, ManagedAddress, ManagedBuffer, ManagedVec, RHListItem, RHListItemExec,
+    SyncCallRawResult, TxEnv,
 };
 
-use super::{RHListItem, RHListItemExec};
+/// Indicates that the raw result data will be returned.
+pub struct ReturnsRawResult;
 
-pub struct ReturnsRaw;
-
-impl<Env, Original> RHListItem<Env, Original> for ReturnsRaw
+impl<Env, Original> RHListItem<Env, Original> for ReturnsRawResult
 where
     Env: TxEnv,
 {
     type Returns = ManagedVec<Env::Api, ManagedBuffer<Env::Api>>;
 }
 
-impl<Env, Original> RHListItemExec<SyncCallRawResult<Env::Api>, Env, Original> for ReturnsRaw
+impl<Env, Original> RHListItemExec<SyncCallRawResult<Env::Api>, Env, Original> for ReturnsRawResult
 where
     Env: TxEnv,
 {
@@ -23,7 +22,7 @@ where
     }
 }
 
-impl<Env, Original> RHListItemExec<DeployRawResult<Env::Api>, Env, Original> for ReturnsRaw
+impl<Env, Original> RHListItemExec<DeployRawResult<Env::Api>, Env, Original> for ReturnsRawResult
 where
     Env: TxEnv,
 {

diff --git a/...s/interaction/tx_rh_list/returns_exact.rs → ...ction/tx_result_handler/returns_result.rs b/...s/interaction/tx_rh_list/returns_exact.rs → ...ction/tx_result_handler/returns_result.rs
@@ -2,21 +2,25 @@ use multiversx_sc_codec::TopDecodeMulti;
 
 use crate::{
     proxy_imports::SyncCallRawResult,
-    types::{interaction::contract_call_exec::decode_result, ManagedBuffer, ManagedVec, TxEnv},
+    types::{
+        interaction::contract_call_exec::decode_result, ManagedBuffer, ManagedVec, RHListItem,
+        RHListItemExec, TxEnv,
+    },
 };
 
-use super::{RHListItem, RHListItemExec};
+/// Indicates that result will be returned.
+///
+/// Value will be decoded according to the type defined in the smart contract.
+pub struct ReturnsResult;
 
-pub struct ReturnsExact;
-
-impl<Env, Original> RHListItem<Env, Original> for ReturnsExact
+impl<Env, Original> RHListItem<Env, Original> for ReturnsResult
 where
     Env: TxEnv,
 {
     type Returns = Original;
 }
 
-impl<Env, Original> RHListItemExec<SyncCallRawResult<Env::Api>, Env, Original> for ReturnsExact
+impl<Env, Original> RHListItemExec<SyncCallRawResult<Env::Api>, Env, Original> for ReturnsResult
 where
     Env: TxEnv,
     Original: TopDecodeMulti,

diff --git a/...interaction/tx_rh_list/returns_similar.rs → .../tx_result_handler/returns_result_conv.rs b/...interaction/tx_rh_list/returns_similar.rs → .../tx_result_handler/returns_result_conv.rs
@@ -3,31 +3,32 @@ use core::marker::PhantomData;
 use multiversx_sc_codec::{CodecFrom, TopEncodeMulti};
 
 use crate::types::{
-    interaction::contract_call_exec::decode_result, ManagedBuffer, ManagedVec, SyncCallRawResult,
-    TxEnv,
+    interaction::contract_call_exec::decode_result, ManagedBuffer, ManagedVec, RHListItem,
+    RHListItemExec, SyncCallRawResult, TxEnv,
 };
 
-use super::{RHListItem, RHListItemExec};
-
-pub struct ReturnsSimilar<T> {
+/// Indicates that result will be returned.
+///
+/// Value will be converted to type `T`, which should be compatible with the original type.
+pub struct ReturnsResultConv<T> {
     _phantom: PhantomData<T>,
 }
 
-impl<T> Default for ReturnsSimilar<T> {
+impl<T> Default for ReturnsResultConv<T> {
     fn default() -> Self {
         Self {
             _phantom: Default::default(),
         }
     }
 }
 
-impl<T> ReturnsSimilar<T> {
+impl<T> ReturnsResultConv<T> {
     pub fn new() -> Self {
         Self::default()
     }
 }
 
-impl<Env, Original, T> RHListItem<Env, Original> for ReturnsSimilar<T>
+impl<Env, Original, T> RHListItem<Env, Original> for ReturnsResultConv<T>
 where
     Env: TxEnv,
     Original: TopEncodeMulti,
@@ -37,7 +38,7 @@ where
 }
 
 impl<Env, Original, T> RHListItemExec<SyncCallRawResult<Env::Api>, Env, Original>
-    for ReturnsSimilar<T>
+    for ReturnsResultConv<T>
 where
     Env: TxEnv,
     Original: TopEncodeMulti,

diff --git a/...ion/tx_rh_list/with_result_new_address.rs → ...ion/tx_result_handler/with_new_address.rs b/...ion/tx_rh_list/with_result_new_address.rs → ...ion/tx_result_handler/with_new_address.rs
@@ -1,10 +1,11 @@
 use core::marker::PhantomData;
 
-use crate::types::{DeployRawResult, ManagedAddress, ManagedBuffer, ManagedVec, TxEnv};
+use crate::types::{
+    DeployRawResult, ManagedAddress, ManagedBuffer, ManagedVec, RHListItem, RHListItemExec, TxEnv,
+};
 
-use super::{RHListItem, RHListItemExec};
-
-pub struct WithResultNewAddress<Env, F>
+/// Defines a lambda function to be called on the newly deployed address, after a deploy.
+pub struct WithNewAddress<Env, F>
 where
     Env: TxEnv,
     F: FnOnce(&ManagedAddress<Env::Api>),
@@ -13,20 +14,20 @@ where
     pub f: F,
 }
 
-impl<Env, F> WithResultNewAddress<Env, F>
+impl<Env, F> WithNewAddress<Env, F>
 where
     Env: TxEnv,
     F: FnOnce(&ManagedAddress<Env::Api>),
 {
     pub fn new(f: F) -> Self {
-        WithResultNewAddress {
+        WithNewAddress {
             _phantom: PhantomData,
             f,
         }
     }
 }
 
-impl<Env, F, Original> RHListItem<Env, Original> for WithResultNewAddress<Env, F>
+impl<Env, F, Original> RHListItem<Env, Original> for WithNewAddress<Env, F>
 where
     Env: TxEnv,
     F: FnOnce(&ManagedAddress<Env::Api>),
@@ -35,7 +36,7 @@ where
 }
 
 impl<Env, F, Original> RHListItemExec<DeployRawResult<Env::Api>, Env, Original>
-    for WithResultNewAddress<Env, F>
+    for WithNewAddress<Env, F>
 where
     Env: TxEnv,
     F: FnOnce(&ManagedAddress<Env::Api>),