Merge pull request #1461 from multiversx/feat/managed-decimal

Feature: ManagedDecimal
multiversx · May 30, 2024 · 7b839c6 · 7b839c6
2 parents 7fe9f04 + dd103ea
commit 7b839c6
Show file tree

Hide file tree

Showing 31 changed files with 5,248 additions and 23 deletions.
diff --git a/contracts/feature-tests/abi-tester/abi_tester_expected_main.abi.json b/contracts/feature-tests/abi-tester/abi_tester_expected_main.abi.json
@@ -480,6 +480,14 @@
         {
             "ticker": "ExplicitDiscriminantMixed",
             "type": "ExplicitDiscriminantMixed"
+        },
+        {
+            "ticker": "ManagedDecimalVar",
+            "type": "ManagedDecimal<usize>"
+        },
+        {
+            "ticker": "ManagedDecimalConst",
+            "type": "ManagedDecimalWrapper"
         }
     ],
     "hasCallback": false,
@@ -796,6 +804,15 @@
                 }
             ]
         },
+        "ManagedDecimalWrapper": {
+            "type": "struct",
+            "fields": [
+                {
+                    "name": "field",
+                    "type": "ManagedDecimal<2>"
+                }
+            ]
+        },
         "OnlyShowsUpAsNested01": {
             "type": "struct",
             "docs": [

diff --git a/contracts/feature-tests/abi-tester/abi_tester_expected_view.abi.json b/contracts/feature-tests/abi-tester/abi_tester_expected_view.abi.json
@@ -131,6 +131,14 @@
         {
             "ticker": "ExplicitDiscriminantMixed",
             "type": "ExplicitDiscriminantMixed"
+        },
+        {
+            "ticker": "ManagedDecimalVar",
+            "type": "ManagedDecimal<usize>"
+        },
+        {
+            "ticker": "ManagedDecimalConst",
+            "type": "ManagedDecimalWrapper"
         }
     ],
     "hasCallback": false,
@@ -447,6 +455,15 @@
                 }
             ]
         },
+        "ManagedDecimalWrapper": {
+            "type": "struct",
+            "fields": [
+                {
+                    "name": "field",
+                    "type": "ManagedDecimal<2>"
+                }
+            ]
+        },
         "OnlyShowsUpAsNested01": {
             "type": "struct",
             "docs": [

diff --git a/contracts/feature-tests/abi-tester/src/abi_proxy.rs b/contracts/feature-tests/abi-tester/src/abi_proxy.rs
@@ -578,3 +578,12 @@ pub enum ExplicitDiscriminantMixed {
         b: u16,
     },
 }
+
+#[type_abi]
+#[derive(TopEncode, TopDecode)]
+pub struct ManagedDecimalWrapper<Api>
+where
+    Api: ManagedTypeApi,
+{
+    pub field: ManagedDecimal<Api, ConstDecimals<2>>,
+}
diff --git a/contracts/feature-tests/abi-tester/src/abi_test_type.rs b/contracts/feature-tests/abi-tester/src/abi_test_type.rs
@@ -1,7 +1,7 @@
 use crate::only_nested::*;
 use multiversx_sc::{
     api::ManagedTypeApi,
-    types::{BigUint, Box, ManagedBuffer},
+    types::{BigUint, Box, ConstDecimals, ManagedBuffer, ManagedDecimal},
 };
 multiversx_sc::derive_imports!();
 
@@ -42,3 +42,8 @@ pub struct OnlyShowsUpInEsdtAttr {
     #[allow(dead_code)]
     pub field: OnlyShowsUpAsNested10,
 }
+
+#[derive(TypeAbi)]
+pub struct ManagedDecimalWrapper<M: ManagedTypeApi> {
+    pub field: ManagedDecimal<M, ConstDecimals<2>>,
+}
diff --git a/contracts/feature-tests/abi-tester/src/abi_tester.rs b/contracts/feature-tests/abi-tester/src/abi_tester.rs
@@ -23,8 +23,10 @@ use only_nested::*;
 #[esdt_attribute("STRUCT1", AbiEnum)]
 #[esdt_attribute("STRUCT2", AbiManagedType<Self::Api>)]
 #[esdt_attribute("OnlyInEsdt", OnlyShowsUpInEsdtAttr)]
-#[esdt_attribute["ExplicitDiscriminant", ExplicitDiscriminant]]
-#[esdt_attribute["ExplicitDiscriminantMixed", ExplicitDiscriminantMixed]]
+#[esdt_attribute("ExplicitDiscriminant", ExplicitDiscriminant)]
+#[esdt_attribute("ExplicitDiscriminantMixed", ExplicitDiscriminantMixed)]
+#[esdt_attribute("ManagedDecimalVar", ManagedDecimal<Self::Api, NumDecimals>)]
+#[esdt_attribute("ManagedDecimalConst", ManagedDecimalWrapper<Self::Api>)]
 pub trait AbiTester {
     /// Contract constructor.
     #[init]

diff --git a/contracts/feature-tests/basic-features/scenarios/managed_decimal.scen.json b/contracts/feature-tests/basic-features/scenarios/managed_decimal.scen.json
@@ -0,0 +1,146 @@
+{
+    "steps": [
+        {
+            "step": "setState",
+            "accounts": {
+                "sc:basic-features": {
+                    "nonce": "0",
+                    "balance": "0",
+                    "code": "mxsc:../output/basic-features.mxsc.json"
+                },
+                "address:an_account": {
+                    "nonce": "0",
+                    "balance": "0"
+                }
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "1",
+            "tx": {
+                "from": "address:an_account",
+                "to": "sc:basic-features",
+                "function": "managed_decimal_addition",
+                "arguments": [
+                    "4",
+                    "5"
+                ],
+                "gasLimit": "1,000,000,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [
+                    "9"
+                ]
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "1",
+            "tx": {
+                "from": "address:an_account",
+                "to": "sc:basic-features",
+                "function": "managed_decimal_subtraction",
+                "arguments": [
+                    "9",
+                    "4"
+                ],
+                "gasLimit": "1,000,000,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [
+                    "5"
+                ]
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "2",
+            "tx": {
+                "from": "address:an_account",
+                "to": "sc:basic-features",
+                "function": "managed_decimal_subtraction",
+                "arguments": [
+                    "2",
+                    "8"
+                ],
+                "gasLimit": "1,000,000,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [],
+                "status": "4",
+                "message": "str:cannot subtract because result would be negative",
+                "gas": "*",
+                "refund": "*"
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "3",
+            "tx": {
+                "from": "address:an_account",
+                "to": "sc:basic-features",
+                "function": "managed_decimal_eq",
+                "arguments": [
+                    "13",
+                    "13"
+                ],
+                "gasLimit": "1,000,000,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [
+                    "0x01"
+                ],
+                "status": "",
+                "message": "*",
+                "gas": "*",
+                "refund": "*"
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "4",
+            "tx": {
+                "from": "address:an_account",
+                "to": "sc:basic-features",
+                "function": "managed_decimal_trunc",
+                "arguments": [],
+                "gasLimit": "1,000,000,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [
+                    "313"
+                ],
+                "status": "",
+                "message": "*",
+                "gas": "*",
+                "refund": "*"
+            }
+        },
+        {
+            "step": "scCall",
+            "id": "5",
+            "tx": {
+                "from": "address:an_account",
+                "to": "sc:basic-features",
+                "function": "managed_decimal_into_raw_units",
+                "arguments": [],
+                "gasLimit": "1,000,000,000,000",
+                "gasPrice": "0"
+            },
+            "expect": {
+                "out": [
+                    "12345"
+                ],
+                "status": "",
+                "message": "*",
+                "gas": "*",
+                "refund": "*"
+            }
+        }
+    ]
+}
diff --git a/contracts/feature-tests/basic-features/src/basic_features_main.rs b/contracts/feature-tests/basic-features/src/basic_features_main.rs
@@ -11,11 +11,13 @@ pub mod codec_err_test;
 pub mod crypto_features;
 pub mod echo;
 pub mod echo_managed;
+pub mod egld_decimal;
 pub mod elliptic_curve_features;
 pub mod event_features;
 pub mod macro_features;
 pub mod managed_address_features;
 pub mod managed_buffer_features;
+pub mod managed_decimal_features;
 pub mod managed_vec_features;
 pub mod non_zero_features;
 pub mod small_num_overflow_test_ops;
@@ -76,8 +78,10 @@ pub trait BasicFeatures:
     + small_num_overflow_test_ops::SmallIntOverflow
     + token_identifier_features::TokenIdentifierFeatures
     + non_zero_features::TypeFeatures
+    + egld_decimal::EgldDecimal
     + multiversx_sc_modules::default_issue_callbacks::DefaultIssueCallbacksModule
     + storage_mapper_get_at_address::StorageMapperGetAtAddress
+    + managed_decimal_features::ManagedDecimalFeatures
 {
     #[init]
     fn init(&self) {}

diff --git a/contracts/feature-tests/basic-features/src/basic_features_proxy.rs b/contracts/feature-tests/basic-features/src/basic_features_proxy.rs
@@ -74,6 +74,14 @@ where
             .argument(&bi)
             .original_result()
     }
+
+    pub fn returns_egld_decimal(
+        self,
+    ) -> TxTypedCall<Env, From, To, (), Gas, ManagedDecimal<Env::Api, ConstDecimals<18>>> {
+        self.wrapped_tx
+            .raw_call("returns_egld_decimal")
+            .original_result()
+    }
 }
 
 #[type_abi]

diff --git a/contracts/feature-tests/basic-features/src/egld_decimal.rs b/contracts/feature-tests/basic-features/src/egld_decimal.rs
@@ -0,0 +1,11 @@
+multiversx_sc::imports!();
+
+/// Used for testing the egld_decimal function return type
+#[multiversx_sc::module]
+pub trait EgldDecimal {
+    #[payable("EGLD")]
+    #[endpoint]
+    fn returns_egld_decimal(&self) -> ManagedDecimal<Self::Api, ConstDecimals<18>> {
+        self.call_value().egld_decimal()
+    }
+}
diff --git a/contracts/feature-tests/basic-features/src/managed_decimal_features.rs b/contracts/feature-tests/basic-features/src/managed_decimal_features.rs
@@ -0,0 +1,43 @@
+multiversx_sc::imports!();
+
+#[multiversx_sc::module]
+pub trait ManagedDecimalFeatures {
+    #[endpoint]
+    fn managed_decimal_addition(
+        &self,
+        first: ManagedDecimal<Self::Api, ConstDecimals<2>>,
+        second: ManagedDecimal<Self::Api, ConstDecimals<2>>,
+    ) -> ManagedDecimal<Self::Api, ConstDecimals<2>> {
+        first + second
+    }
+
+    #[endpoint]
+    fn managed_decimal_subtraction(
+        &self,
+        first: ManagedDecimal<Self::Api, ConstDecimals<2>>,
+        second: ManagedDecimal<Self::Api, ConstDecimals<2>>,
+    ) -> ManagedDecimal<Self::Api, ConstDecimals<2>> {
+        first - second
+    }
+
+    #[endpoint]
+    fn managed_decimal_eq(
+        &self,
+        first: ManagedDecimal<Self::Api, ConstDecimals<2>>,
+        second: ManagedDecimal<Self::Api, ConstDecimals<2>>,
+    ) -> bool {
+        first.eq(&second)
+    }
+
+    #[endpoint]
+    fn managed_decimal_trunc(&self) -> BigUint {
+        let dec = ManagedDecimal::from_raw_units(BigUint::from(31332u64), 2usize);
+        dec.trunc()
+    }
+
+    #[endpoint]
+    fn managed_decimal_into_raw_units(&self) -> BigUint {
+        let dec = ManagedDecimal::from_raw_units(BigUint::from(12345u64), 2usize);
+        dec.into_raw_units().clone()
+    }
+}