Merge pull request #2142 from multiversx/add-data-esdt-token-properties

add extra data to `get_token_properties` query

Author: andrei-marinica

chain/core/src/types/flags/esdt_token_type.rs

@@ -38,6 +38,18 @@ impl EsdtTokenType {
             EsdtTokenType::Invalid => 255,
         }
     }
+
+    pub fn collection_from_string(token_type: &str) -> Self {
+        match token_type {
+            "NonFungibleESDT" => EsdtTokenType::NonFungibleV2,
+            "SemiFungibleESDT" => EsdtTokenType::SemiFungible,
+            "MetaESDT" => EsdtTokenType::MetaFungible,
+            "DynamicNonFungibleESDT" => EsdtTokenType::DynamicNFT,
+            "DynamicSemiFungibleESDT" => EsdtTokenType::DynamicSFT,
+            "DynamicMetaESDT" => EsdtTokenType::DynamicMeta,
+            _ => EsdtTokenType::Invalid,
+        }
+    }
 }
 
 impl From<u8> for EsdtTokenType {

framework/base/src/types/interaction/system_proxy/token_properties_result.rs

@@ -1,3 +1,5 @@
+use alloc::string::String;
+use multiversx_chain_core::types::{Address, EsdtTokenType};
 use multiversx_sc_codec::{
     DecodeErrorHandler, TopDecodeInput, TopDecodeMulti, TopDecodeMultiInput,
 };
@@ -20,8 +22,11 @@ const PREFIXES: &[&[u8]] = &[
     b"NumWiped-",
 ];
 
-#[derive(Debug, Clone, Default)]
+#[derive(Debug, Clone)]
 pub struct TokenPropertiesResult {
+    pub token_name: String,
+    pub token_type: EsdtTokenType,
+    pub owner_address: Address,
     pub num_decimals: usize,
     pub is_paused: bool,
     pub can_upgrade: bool,
@@ -63,6 +68,27 @@ impl TokenPropertiesResult {
             }
         }
     }
+
+    fn default() -> Self {
+        TokenPropertiesResult {
+            token_name: String::new(),
+            token_type: EsdtTokenType::Invalid,
+            owner_address: Address::zero(),
+            num_decimals: 0,
+            is_paused: false,
+            can_upgrade: false,
+            can_mint: false,
+            can_burn: false,
+            can_change_owner: false,
+            can_pause: false,
+            can_freeze: false,
+            can_wipe: false,
+            can_add_special_roles: false,
+            can_transfer_nft_create_role: false,
+            nft_create_stopped: false,
+            num_wiped: 0,
+        }
+    }
 }
 
 impl TopDecodeMulti for TokenPropertiesResult {
@@ -72,6 +98,11 @@ impl TopDecodeMulti for TokenPropertiesResult {
         H: DecodeErrorHandler,
     {
         let mut token_properties = TokenPropertiesResult::default();
+
+        token_properties.token_name = String::multi_decode_or_handle_err(input, h)?;
+        let token_type = String::multi_decode_or_handle_err(input, h)?;
+        token_properties.token_type = EsdtTokenType::collection_from_string(token_type.as_str());
+        token_properties.owner_address = Address::multi_decode_or_handle_err(input, h)?;
         while input.has_next() {
             let value = input.next_value_input(h)?;
             let mut buffer = [0u8; MAX_BUFFER_SIZE];

framework/scenario/tests/token_properties_result_test.rs

@@ -1,4 +1,8 @@
-use multiversx_sc::{codec::TopDecodeMulti, imports::TokenPropertiesResult};
+use multiversx_sc::{
+    codec::TopDecodeMulti,
+    imports::{Bech32Address, TokenPropertiesResult},
+    types::EsdtTokenType,
+};
 
 fn hex_decode(hex: &[u8]) -> Option<Vec<u8>> {
     if hex.len() % 2 != 0 {
@@ -23,15 +27,20 @@ fn hex_decode(hex: &[u8]) -> Option<Vec<u8>> {
 
 #[test]
 fn multi_decode_from_api_response() {
-    let raw_input = b"@6f6b@544553544e4654@44796e616d69634e6f6e46756e6769626c6545534454@0139472eff6886771a982f3083da5d421f24c29181e63888228dc81ca60d69e1@30@30@4e756d446563696d616c732d3138@49735061757365642d66616c7365@43616e557067726164652d74727565@43616e4d696e742d66616c7365@43616e4275726e2d74727565@43616e4368616e67654f776e65722d66616c7365@43616e50617573652d66616c7365@43616e467265657a652d66616c7365@43616e576970652d66616c7365@43616e4164645370656369616c526f6c65732d74727565@43616e5472616e736665724e4654437265617465526f6c652d66616c7365@4e465443726561746553746f707065642d66616c7365@4e756d57697065642d30";
+    let raw_input = b"@544553544e4654@44796e616d69634e6f6e46756e6769626c6545534454@0139472eff6886771a982f3083da5d421f24c29181e63888228dc81ca60d69e1@30@30@4e756d446563696d616c732d3138@49735061757365642d66616c7365@43616e557067726164652d74727565@43616e4d696e742d66616c7365@43616e4275726e2d74727565@43616e4368616e67654f776e65722d66616c7365@43616e50617573652d66616c7365@43616e467265657a652d66616c7365@43616e576970652d66616c7365@43616e4164645370656369616c526f6c65732d74727565@43616e5472616e736665724e4654437265617465526f6c652d66616c7365@4e465443726561746553746f707065642d66616c7365@4e756d57697065642d30";
     let mut input: Vec<Vec<u8>> = raw_input
         .split(|&b| b == b'@')
         .filter(|slice| !slice.is_empty())
         .map(|slice| hex_decode(slice).unwrap())
         .collect();
 
     let token_properties = TokenPropertiesResult::multi_decode(&mut input).unwrap();
-
+    assert!(token_properties.token_name == "TESTNFT");
+    assert!(token_properties.token_type == EsdtTokenType::DynamicNFT);
+    assert!(
+        Bech32Address::from(token_properties.owner_address).to_bech32_str()
+            == "erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th"
+    );
     assert!(token_properties.num_decimals == 18usize);
     assert!(!token_properties.is_paused);
     assert!(token_properties.can_upgrade);

tools/interactor-system-func-calls/src/system_sc_interact.rs

@@ -227,11 +227,11 @@ pub async fn system_sc_interact_cli() {
 }
 
 pub struct SysFuncCallsInteract {
-    interactor: Interactor,
-    wallet_address: Bech32Address,
-    other_wallet_address: Bech32Address,
+    pub interactor: Interactor,
+    pub wallet_address: Bech32Address,
+    pub other_wallet_address: Bech32Address,
     #[allow(unused)]
-    state: State,
+    pub state: State,
 }
 
 impl SysFuncCallsInteract {
@@ -260,10 +260,8 @@ impl SysFuncCallsInteract {
 
         let res = self
             .interactor
-            .tx()
-            .from(&self.wallet_address)
+            .query()
             .to(ESDTSystemSCAddress)
-            .gas(100_000_000u64)
             .typed(ESDTSystemSCProxy)
             .get_token_properties(token_id)
             .returns(ReturnsResult)

tools/interactor-system-func-calls/tests/chain_simulator_token_tests.rs

@@ -344,6 +344,9 @@ async fn get_token_properties() {
         .get_token_properties(dynamic_meta_esdt_token_id.as_bytes())
         .await;
 
+    assert!(token_properties.owner_address == interact.wallet_address.to_address());
+    assert!(token_properties.token_name == "TESTMETA");
+    assert!(token_properties.token_type == EsdtTokenType::DynamicMeta);
     assert!(token_properties.num_decimals == 18usize);
     assert!(!token_properties.is_paused);
     assert!(token_properties.can_upgrade);