MESH-2060/Add more checks to execute_instruction (#1630)

* Add more checks to execute_instruction; Add pruning tests for success and rollback

* Fix events emition; Assert events on test; Clear storage improvements

---------

Co-authored-by: Adam Dossa <adam.dossa@gmail.com>

pallets/runtime/tests/src/lib.rs

@@ -32,6 +32,7 @@ mod pips_test;
 mod portfolio;
 mod protocol_fee;
 mod relayer_test;
+mod settlement_pallet;
 mod settlement_test;
 mod signed_extra;
 mod staking;

pallets/runtime/tests/src/settlement_pallet/execute_instruction.rs

@@ -0,0 +1,205 @@
+use frame_support::{assert_ok, StorageDoubleMap, StorageMap};
+use sp_keyring::AccountKeyring;
+
+use pallet_asset::BalanceOf;
+use pallet_portfolio::PortfolioLockedAssets;
+use pallet_settlement::{
+    AffirmsReceived, Error, InstructionAffirmsPending, InstructionDetails, InstructionLegStatus,
+    InstructionLegs, InstructionMediatorsAffirmations, InstructionStatuses, OffChainAffirmations,
+    RawEvent, UserAffirmations, VenueInstructions,
+};
+use polymesh_common_utilities::SystematicIssuers::Settlement as SettlementDID;
+use polymesh_primitives::settlement::{
+    AffirmationStatus, Instruction, InstructionId, InstructionStatus, Leg, LegId, SettlementType,
+};
+use polymesh_primitives::{PortfolioId, Ticker};
+
+use crate::settlement_test::{create_token, create_token_and_venue};
+use crate::storage::User;
+use crate::{next_block, ExtBuilder, TestStorage};
+
+type Settlement = pallet_settlement::Module<TestStorage>;
+type System = frame_system::Pallet<TestStorage>;
+
+const TICKER: Ticker = Ticker::new_unchecked([b'A', b'C', b'M', b'E', 0, 0, 0, 0, 0, 0, 0, 0]);
+const TICKER2: Ticker = Ticker::new_unchecked([b'A', b'C', b'M', b'Y', 0, 0, 0, 0, 0, 0, 0, 0]);
+
+#[test]
+fn execute_instruction_storage_pruning() {
+    ExtBuilder::default().build().execute_with(|| {
+        let instruction_id = InstructionId(0);
+        let bob = User::new(AccountKeyring::Bob);
+        let alice = User::new(AccountKeyring::Alice);
+        let bob_default_portfolio = PortfolioId::default_portfolio(bob.did);
+        let alice_default_portfolio = PortfolioId::default_portfolio(alice.did);
+
+        let venue_id = create_token_and_venue(TICKER, alice);
+        let legs: Vec<Leg> = vec![Leg::Fungible {
+            sender: PortfolioId::default_portfolio(alice.did),
+            receiver: PortfolioId::default_portfolio(bob.did),
+            ticker: TICKER,
+            amount: 1_000,
+        }];
+        assert_ok!(Settlement::add_instruction(
+            alice.origin(),
+            venue_id,
+            SettlementType::SettleOnAffirmation,
+            None,
+            None,
+            legs.clone(),
+            None,
+        ));
+        assert_ok!(Settlement::affirm_instruction(
+            alice.origin(),
+            instruction_id,
+            vec![alice_default_portfolio]
+        ));
+        assert_ok!(Settlement::affirm_instruction(
+            bob.origin(),
+            instruction_id,
+            vec![bob_default_portfolio]
+        ));
+        next_block();
+
+        // Asserts all storage have been pruned
+        assert_eq!(InstructionAffirmsPending::get(instruction_id), 0);
+        assert_eq!(VenueInstructions::iter_prefix_values(venue_id).next(), None);
+        assert_eq!(
+            InstructionLegs::iter_prefix_values(instruction_id).next(),
+            None
+        );
+        assert_eq!(
+            InstructionDetails::<TestStorage>::get(instruction_id),
+            Instruction::default()
+        );
+        assert_eq!(
+            InstructionLegStatus::<TestStorage>::iter_prefix_values(instruction_id).next(),
+            None
+        );
+        assert_eq!(
+            OffChainAffirmations::iter_prefix_values(instruction_id).next(),
+            None
+        );
+        assert_eq!(
+            AffirmsReceived::iter_prefix_values(instruction_id).next(),
+            None
+        );
+        assert_eq!(
+            InstructionMediatorsAffirmations::<TestStorage>::iter_prefix_values(instruction_id)
+                .next(),
+            None
+        );
+        assert_eq!(
+            UserAffirmations::get(alice_default_portfolio, instruction_id),
+            AffirmationStatus::Unknown
+        );
+        assert_eq!(
+            UserAffirmations::get(bob_default_portfolio, instruction_id),
+            AffirmationStatus::Unknown
+        );
+        assert_eq!(
+            InstructionStatuses::<TestStorage>::get(instruction_id),
+            InstructionStatus::Success(1)
+        );
+    });
+}
+
+#[test]
+fn execute_instruction_storage_rollback() {
+    ExtBuilder::default().build().execute_with(|| {
+        System::set_block_number(1);
+
+        let instruction_id = InstructionId(0);
+        let bob = User::new(AccountKeyring::Bob);
+        let alice = User::new(AccountKeyring::Alice);
+        let bob_default_portfolio = PortfolioId::default_portfolio(bob.did);
+        let alice_default_portfolio = PortfolioId::default_portfolio(alice.did);
+
+        let venue_id = create_token_and_venue(TICKER, alice);
+        create_token(TICKER2, alice);
+        let legs: Vec<Leg> = vec![
+            Leg::Fungible {
+                sender: PortfolioId::default_portfolio(alice.did),
+                receiver: PortfolioId::default_portfolio(bob.did),
+                ticker: TICKER,
+                amount: 1_000,
+            },
+            Leg::Fungible {
+                sender: PortfolioId::default_portfolio(alice.did),
+                receiver: PortfolioId::default_portfolio(bob.did),
+                ticker: TICKER2,
+                amount: 1_000,
+            },
+        ];
+        assert_ok!(Settlement::add_instruction(
+            alice.origin(),
+            venue_id,
+            SettlementType::SettleOnAffirmation,
+            None,
+            None,
+            legs.clone(),
+            None,
+        ));
+        assert_ok!(Settlement::affirm_instruction(
+            alice.origin(),
+            instruction_id,
+            vec![alice_default_portfolio]
+        ));
+        assert_ok!(Settlement::affirm_instruction(
+            bob.origin(),
+            instruction_id,
+            vec![bob_default_portfolio]
+        ));
+        // Removes TICKER2 balance to force an error
+        BalanceOf::insert(TICKER2, alice.did, 0);
+        next_block();
+        // Asserts storage has not changed
+        assert_eq!(
+            PortfolioLockedAssets::get(alice_default_portfolio, TICKER),
+            1_000
+        );
+        assert_eq!(
+            PortfolioLockedAssets::get(alice_default_portfolio, TICKER2),
+            1_000
+        );
+        assert_eq!(
+            UserAffirmations::get(alice_default_portfolio, instruction_id),
+            AffirmationStatus::Affirmed
+        );
+        assert_eq!(
+            UserAffirmations::get(bob_default_portfolio, instruction_id),
+            AffirmationStatus::Affirmed
+        );
+        assert_eq!(
+            InstructionStatuses::<TestStorage>::get(instruction_id),
+            InstructionStatus::Failed
+        );
+        let all_legs = InstructionLegs::iter_prefix_values(instruction_id).collect::<Vec<_>>();
+        assert_eq!(all_legs.len(), 2);
+        // Asserts the events are being emitted
+        let mut system_events = System::events();
+        system_events.pop().unwrap();
+        assert_eq!(
+            system_events.pop().unwrap().event,
+            crate::storage::EventTest::Settlement(RawEvent::FailedToExecuteInstruction(
+                instruction_id,
+                Error::<TestStorage>::FailedToReleaseLockOrTransferAssets.into()
+            ))
+        );
+        assert_eq!(
+            system_events.pop().unwrap().event,
+            crate::storage::EventTest::Settlement(RawEvent::InstructionFailed(
+                SettlementDID.as_id(),
+                instruction_id
+            ))
+        );
+        assert_eq!(
+            system_events.pop().unwrap().event,
+            crate::storage::EventTest::Settlement(RawEvent::LegFailedExecution(
+                SettlementDID.as_id(),
+                instruction_id,
+                LegId(1)
+            ))
+        );
+    });
+}

pallets/runtime/tests/src/settlement_pallet/mod.rs

@@ -0,0 +1 @@
+mod execute_instruction;

pallets/runtime/tests/src/settlement_test.rs

@@ -177,12 +177,12 @@ impl Deref for UserWithBalance {
     }
 }
 
-fn create_token_and_venue(ticker: Ticker, user: User) -> VenueId {
+pub(crate) fn create_token_and_venue(ticker: Ticker, user: User) -> VenueId {
     create_token(ticker, user);
     create_venue(user)
 }
 
-fn create_token(ticker: Ticker, user: User) {
+pub(crate) fn create_token(ticker: Ticker, user: User) {
     assert_ok!(Asset::create_asset(
         user.origin(),
         ticker.as_slice().into(),