Improvements to the Asset Pallet (#1591)

* Cherry-pick Add validate_ticker_registration_rules, base_create_asset_with_custom_type, validate_asset_creation_rules; Improve validate_asset_transfer; Remove old functions

* Remove fee if ticker registration expiry is still valid

* Add ensure_valid_asset_identifiers check for asset creation

* Add validate_and_create_asset function

* Remove clone

pallets/asset/src/error.rs

@@ -83,6 +83,10 @@ decl_error! {
         /// Number of asset mediators would exceed the maximum allowed.
         NumberOfAssetMediatorsExceeded,
         /// Invalid ticker character - valid set: A`..`Z` `0`..`9` `_` `-` `.` `/`.
-        InvalidTickerCharacter
+        InvalidTickerCharacter,
+        /// Failed to transfer the asset - asset is frozen.
+        InvalidTransferFrozenAsset,
+        /// Failed to transfer an NFT - compliance failed.
+        InvalidTransferComplianceFailure
     }
 }

pallets/asset/src/types.rs

@@ -16,7 +16,7 @@ pub enum AssetOwnershipRelation {
     AssetOwned,
 }
 
-/// struct to store the token details.
+/// Stores the details of a security token.
 #[derive(Clone, Debug, Decode, Default, Encode, TypeInfo, PartialEq, Eq)]
 pub struct SecurityToken {
     pub total_supply: Balance,
@@ -25,6 +25,23 @@ pub struct SecurityToken {
     pub asset_type: AssetType,
 }
 
+impl SecurityToken {
+    /// Creates a new [`SecurityToken`] instance.
+    pub fn new(
+        total_supply: Balance,
+        owner_did: IdentityId,
+        divisible: bool,
+        asset_type: AssetType,
+    ) -> Self {
+        Self {
+            total_supply,
+            owner_did,
+            divisible,
+            asset_type,
+        }
+    }
+}
+
 /// struct to store the ticker registration details.
 #[derive(Clone, Debug, Decode, Default, Encode, TypeInfo, PartialEq, Eq)]
 pub struct TickerRegistration<T> {
@@ -40,10 +57,29 @@ pub struct TickerRegistrationConfig<T> {
     pub registration_length: Option<T>,
 }
 
-/// Enum that represents the current status of a ticker.
-#[derive(Clone, Debug, Decode, Encode, PartialEq, Eq)]
-pub enum TickerRegistrationStatus {
-    RegisteredByOther,
-    Available,
-    RegisteredByDid,
+/// Tracks information regarding ticker registration.
+#[derive(Clone, Debug)]
+pub struct TickerRegistrationStatus {
+    can_reregister: bool,
+    charge_fee: bool,
+}
+
+impl TickerRegistrationStatus {
+    /// Creates a new [`TickerRegistrationStatus`] instance.
+    pub fn new(can_reregister: bool, charge_fee: bool) -> Self {
+        TickerRegistrationStatus {
+            can_reregister,
+            charge_fee,
+        }
+    }
+
+    /// Returns `true` if the ticker can be reregistered.
+    pub fn can_reregister(&self) -> bool {
+        self.can_reregister
+    }
+
+    /// Returns `true` if the ticker registration fee must be charged.
+    pub fn charge_fee(&self) -> bool {
+        self.charge_fee
+    }
 }

pallets/common/src/constants.rs

@@ -47,10 +47,8 @@ pub mod queue_priority {
 
 // ERC1400 transfer status codes
 pub const ERC1400_TRANSFER_FAILURE: u8 = 0x50;
-pub const ERC1400_TRANSFER_SUCCESS: u8 = 0x51;
 pub const ERC1400_INSUFFICIENT_BALANCE: u8 = 0x52;
 pub const ERC1400_INSUFFICIENT_ALLOWANCE: u8 = 0x53;
-pub const ERC1400_TRANSFERS_HALTED: u8 = 0x54;
 pub const ERC1400_FUNDS_LOCKED: u8 = 0x55;
 pub const ERC1400_INVALID_SENDER: u8 = 0x56;
 pub const ERC1400_INVALID_RECEIVER: u8 = 0x57;
@@ -59,15 +57,12 @@ pub const ERC1400_INVALID_OPERATOR: u8 = 0x58;
 // Application-specific status codes
 pub const INVALID_SENDER_DID: u8 = 0xa0;
 pub const INVALID_RECEIVER_DID: u8 = 0xa1;
-pub const COMPLIANCE_MANAGER_FAILURE: u8 = 0xa2;
 pub const INVALID_GRANULARITY: u8 = 0xa4;
 pub const APP_TX_VOLUME_LIMIT_REACHED: u8 = 0xa5;
 pub const APP_BLOCKED_TX: u8 = 0xa6;
 pub const APP_FUNDS_LOCKED: u8 = 0xa7;
 pub const APP_FUNDS_LIMIT_REACHED: u8 = 0xa8;
-pub const PORTFOLIO_FAILURE: u8 = 0xa9;
 pub const CUSTODIAN_ERROR: u8 = 0xaa;
-pub const TRANSFER_MANAGER_FAILURE: u8 = 0xac;
 
 // PIP pallet constants.
 pub const PIP_MAX_REPORTING_SIZE: usize = 1024;

pallets/runtime/tests/src/asset_test.rs

@@ -353,7 +353,10 @@ fn valid_transfers_pass() {
 
             // Should fail as sender matches receiver.
             let transfer = |from, to| transfer(ticker, from, to, 500);
-            assert_noop!(transfer(owner, owner), AssetError::InvalidTransfer);
+            assert_noop!(
+                transfer(owner, owner),
+                PortfolioError::DestinationIsSamePortfolio
+            );
             assert_ok!(transfer(owner, alice));
 
             assert_eq!(Asset::balance_of(&ticker, owner.did), TOTAL_SUPPLY - 500);
@@ -486,7 +489,7 @@ fn controller_transfer() {
             // Should fail as sender matches receiver.
             assert_noop!(
                 transfer(ticker, owner, owner, 500),
-                AssetError::InvalidTransfer
+                PortfolioError::DestinationIsSamePortfolio
             );
 
             assert_ok!(transfer(ticker, owner, alice, 500));

pallets/runtime/tests/src/compliance_manager_test.rs

@@ -5,7 +5,6 @@ use sp_std::prelude::*;
 
 use pallet_compliance_manager::Error as CMError;
 use polymesh_common_utilities::compliance_manager::ComplianceFnConfig;
-use polymesh_common_utilities::constants::ERC1400_TRANSFER_SUCCESS;
 use polymesh_primitives::agent::AgentGroup;
 use polymesh_primitives::compliance_manager::{
     AssetComplianceResult, ComplianceRequirement, ComplianceRequirementResult,
@@ -35,32 +34,27 @@ type EAError = pallet_external_agents::Error<TestStorage>;
 macro_rules! assert_invalid_transfer {
     ($ticker:expr, $from:expr, $to:expr, $amount:expr) => {
         let mut weight_meter = WeightMeter::max_limit_no_minimum();
-        assert_ne!(
-            Asset::_is_valid_transfer(
-                &$ticker,
-                PortfolioId::default_portfolio($from),
-                PortfolioId::default_portfolio($to),
-                $amount,
-                &mut weight_meter
-            ),
-            Ok(ERC1400_TRANSFER_SUCCESS)
-        );
+        assert!(Asset::validate_asset_transfer(
+            &$ticker,
+            &PortfolioId::default_portfolio($from),
+            &PortfolioId::default_portfolio($to),
+            $amount,
+            &mut weight_meter
+        )
+        .is_err(),);
     };
 }
 
 macro_rules! assert_valid_transfer {
     ($ticker:expr, $from:expr, $to:expr, $amount:expr) => {
         let mut weight_meter = WeightMeter::max_limit_no_minimum();
-        assert_eq!(
-            Asset::_is_valid_transfer(
-                &$ticker,
-                PortfolioId::default_portfolio($from),
-                PortfolioId::default_portfolio($to),
-                $amount,
-                &mut weight_meter
-            ),
-            Ok(ERC1400_TRANSFER_SUCCESS)
-        );
+        assert_ok!(Asset::validate_asset_transfer(
+            &$ticker,
+            &PortfolioId::default_portfolio($from),
+            &PortfolioId::default_portfolio($to),
+            $amount,
+            &mut weight_meter
+        ),);
     };
 }
 

pallets/runtime/tests/src/corporate_actions_test.rs

@@ -2024,7 +2024,7 @@ fn dist_claim_misc_bad() {
 
         // Travel back in time. Now dist is active, but compliance rules not met, so transfer fails.
         set_timestamp(5);
-        noop(AssetError::InvalidTransfer.into());
+        noop(AssetError::InvalidTransferComplianceFailure.into());
     });
 }
 

pallets/runtime/tests/src/settlement_test.rs

@@ -22,7 +22,6 @@ use pallet_settlement::{
     UserVenues, VenueInstructions,
 };
 use polymesh_common_utilities::constants::currency::ONE_UNIT;
-use polymesh_common_utilities::constants::ERC1400_TRANSFER_SUCCESS;
 use polymesh_primitives::asset::{AssetType, NonFungibleType};
 use polymesh_primitives::asset_metadata::{
     AssetMetadataKey, AssetMetadataLocalKey, AssetMetadataValue,
@@ -1430,16 +1429,13 @@ fn test_weights_for_settlement_transaction() {
             assert_affirm_instruction!(bob_signed.clone(), instruction_id, bob_did);
 
             let mut weight_meter = WeightMeter::max_limit_no_minimum();
-            assert_ok!(
-                Asset::_is_valid_transfer(
-                    &TICKER,
-                    PortfolioId::default_portfolio(alice_did),
-                    PortfolioId::default_portfolio(bob_did),
-                    100,
-                    &mut weight_meter
-                ),
-                ERC1400_TRANSFER_SUCCESS
-            );
+            assert_ok!(Asset::validate_asset_transfer(
+                &TICKER,
+                &PortfolioId::default_portfolio(alice_did),
+                &PortfolioId::default_portfolio(bob_did),
+                100,
+                &mut weight_meter
+            ),);
         });
 }
 

pallets/runtime/tests/src/transfer_compliance_test.rs

@@ -463,10 +463,7 @@ impl AssetTracker {
 
     #[track_caller]
     pub fn ensure_invalid_transfer(&mut self, from: u64, to: u64, amount: u128) {
-        assert_noop!(
-            self.do_transfer(from, to, amount),
-            AssetError::InvalidTransfer
-        );
+        assert_noop!(self.do_transfer(from, to, amount), Error::InvalidTransfer);
     }
 
     pub fn fetch_stats_key2(&self, stat_type: &StatType) -> Vec<Stat2ndKey> {