fix: properly calculate rewards to be distributed in all cases (#490)

Author: DylanVerstraete

substrate-node/pallets/pallet-smart-contract/src/lib.rs

@@ -158,7 +158,9 @@ pub mod pallet {
     pub type PalletVersion<T> = StorageValue<_, types::StorageVersion, ValueQuery>;
 
     #[pallet::type_value]
-    pub fn DefaultBillingFrequency<T: Config>() -> u64 { T::BillingFrequency::get() }
+    pub fn DefaultBillingFrequency<T: Config>() -> u64 {
+        T::BillingFrequency::get()
+    }
 
     #[pallet::storage]
     #[pallet::getter(fn billing_frequency)]
@@ -305,26 +307,26 @@ pub mod pallet {
     }
 
     #[pallet::genesis_config]
-	pub struct GenesisConfig {
+    pub struct GenesisConfig {
         pub billing_frequency: u64,
-	}
+    }
 
     // The default value for the genesis config type.
-	#[cfg(feature = "std")]
-	impl Default for GenesisConfig {
-		fn default() -> Self {
-			Self { 
+    #[cfg(feature = "std")]
+    impl Default for GenesisConfig {
+        fn default() -> Self {
+            Self {
                 billing_frequency: 600,
             }
-		}
-	}
+        }
+    }
 
-	#[pallet::genesis_build]
-	impl<T: Config> GenesisBuild<T> for GenesisConfig {
-		fn build(&self) {
+    #[pallet::genesis_build]
+    impl<T: Config> GenesisBuild<T> for GenesisConfig {
+        fn build(&self) {
             BillingFrequency::<T>::put(self.billing_frequency);
-		}
-	}
+        }
+    }
 
     #[pallet::call]
     impl<T: Config> Pallet<T> {
@@ -1144,14 +1146,19 @@ impl<T: Config> Pallet<T> {
                 WithdrawReasons::all(),
             );
 
+            // Fetch twin balance, if the amount locked in the contract lock exceeds the current unlocked
+            // balance we can only transfer out the remaining balance
+            // https://github.com/threefoldtech/tfchain/issues/479
+            let twin_balance = Self::get_usable_balance(&twin.account_id);
+
             // Fetch the default pricing policy
             let pricing_policy = pallet_tfgrid::PricingPolicies::<T>::get(1)
                 .ok_or(Error::<T>::PricingPolicyNotExists)?;
             // Distribute cultivation rewards
             match Self::_distribute_cultivation_rewards(
                 &contract,
                 &pricing_policy,
-                contract_lock.amount_locked,
+                twin_balance.min(contract_lock.amount_locked),
             ) {
                 Ok(_) => (),
                 Err(err) => log::error!("error while distributing cultivation rewards {:?}", err),

substrate-node/pallets/pallet-smart-contract/src/tests.rs

@@ -1332,6 +1332,7 @@ fn test_node_contract_grace_period_cancels_contract_when_grace_period_ends_works
         prepare_farm_and_node();
         run_to_block(1);
         TFTPriceModule::set_prices(Origin::signed(bob()), 50, 101).unwrap();
+        let initial_total_issuance = Balances::total_issuance();
 
         assert_ok!(SmartContractModule::create_node_contract(
             Origin::signed(charlie()),
@@ -1367,6 +1368,9 @@ fn test_node_contract_grace_period_cancels_contract_when_grace_period_ends_works
             true
         );
 
+        let twin = TfgridModule::twins(3).unwrap();
+        let free_balance = Balances::free_balance(&twin.account_id);
+
         run_to_block(32);
         run_to_block(42);
         run_to_block(52);
@@ -1379,6 +1383,9 @@ fn test_node_contract_grace_period_cancels_contract_when_grace_period_ends_works
         run_to_block(122);
         run_to_block(132);
 
+        // The user's total free balance should be distributed
+        validate_distribution_rewards(initial_total_issuance, free_balance, false);
+
         let c1 = SmartContractModule::contracts(1);
         assert_eq!(c1, None);
     });
@@ -1637,16 +1644,7 @@ fn test_rent_contract_canceled_due_to_out_of_funds_should_cancel_node_contracts_
         // check_report_cost(1, 3, amount_due_as_u128, 12, discount_received);
 
         let our_events = System::events();
-        // Event 1: Rent contract created
-        // Event 2: Node Contract created
-        // Event 3: Updated used resources
-        // Event 4: Grace period started rent contract
-        // Event 5: Grace period started node contract
-        // Event 6-17: Rent contract billed
-        // Event 18: Node contract canceled
-        // Event 19: Rent contract Canceled
-        // => no Node Contract billed event
-        assert_eq!(our_events.len(), 20);
+        assert_eq!(our_events.len(), 31);
 
         assert_eq!(
             our_events[5],
@@ -1672,7 +1670,7 @@ fn test_rent_contract_canceled_due_to_out_of_funds_should_cancel_node_contracts_
         );
 
         assert_eq!(
-            our_events[18],
+            our_events[29],
             record(MockEvent::SmartContractModule(SmartContractEvent::<
                 TestRuntime,
             >::NodeContractCanceled {
@@ -1682,7 +1680,7 @@ fn test_rent_contract_canceled_due_to_out_of_funds_should_cancel_node_contracts_
             }))
         );
         assert_eq!(
-            our_events[19],
+            our_events[30],
             record(MockEvent::SmartContractModule(SmartContractEvent::<
                 TestRuntime,
             >::RentContractCanceled {