feat(node): Modify rent reward distributions

common/src/pallet_tests.rs

@@ -130,7 +130,8 @@ macro_rules! impl_pallet_timestamp {
 
 #[macro_export]
 macro_rules! impl_pallet_authorship {
-    ($runtime:ty, EventHandler = $event_handler:ty) => {
+    ($( $tokens:tt )*) => {
+        #[allow(dead_code)]
         pub struct FixedBlockAuthor;
 
         impl FindAuthor<AccountId> for FixedBlockAuthor {
@@ -139,13 +140,37 @@ macro_rules! impl_pallet_authorship {
             }
         }
 
+        #[allow(dead_code)]
+        type AuthorshipFindAuthor = FixedBlockAuthor;
+        #[allow(dead_code)]
+        type AuthorshipEventHandler = ();
+
+        mod pallet_tests_authorship_config_impl {
+            use super::*;
+
+            $crate::impl_pallet_authorship_inner!($( $tokens )*);
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! impl_pallet_authorship_inner {
+    ($runtime:ty$(,)?) => {
         impl pallet_authorship::Config for $runtime {
-            type FindAuthor = FixedBlockAuthor;
-            type EventHandler = $event_handler;
+            type FindAuthor = AuthorshipFindAuthor;
+            type EventHandler = AuthorshipEventHandler;
         }
     };
 
-    ($runtime:ty) => {
-        $crate::impl_pallet_authorship!($runtime, EventHandler = ());
+    ($runtime:ty, FindAuthor = $find_author:ty $(, $( $rest:tt )*)?) => {
+        type AuthorshipFindAuthor = $find_author;
+
+        $crate::impl_pallet_authorship_inner!($runtime, $($( $rest )*)?);
+    };
+
+    ($runtime:ty, EventHandler = $event_handler:ty $(, $( $rest:tt )*)?) => {
+        type AuthorshipEventHandler = $event_handler;
+
+        $crate::impl_pallet_authorship_inner!($runtime, $($( $rest )*)?);
     };
 }

gcli/tests/cmd/claim.rs

@@ -18,15 +18,17 @@
 
 //! Integration tests for command `send`
 
-use crate::common::{self, node::NodeExec, Args, Result, ALICE_SS58_ADDRESS as ADDRESS};
+use crate::common::{
+    self, node::NodeExec, Args, Result, ALICE_SS58_ADDRESS as ADDRESS, RENT_POOL_SS58_ADDRESS,
+};
 use gsdk::Api;
 
 const REWARD_PER_BLOCK: u128 = 75_000; // 3_000 gas * 25 value per gas
 
 #[tokio::test]
 async fn test_command_claim_works() -> Result<()> {
     // hack to check initial alice balance
-    let (initial_balance, initial_stash) = {
+    let (initial_balance, initial_stash, rent_pool_initial) = {
         let node = common::dev()?;
 
         // Get balance of the testing address
@@ -40,6 +42,11 @@ async fn test_command_claim_works() -> Result<()> {
                 .get_balance(&signer.address())
                 .await
                 .unwrap_or(0),
+            signer
+                .api()
+                .get_balance(RENT_POOL_SS58_ADDRESS)
+                .await
+                .unwrap_or(0),
         )
     };
 
@@ -65,8 +72,13 @@ async fn test_command_claim_works() -> Result<()> {
 
     let burned_after = signer.api().get_balance(&signer.address()).await? - initial_stash;
     let after = signer.api().get_balance(ADDRESS).await?;
+    let rent_pool = signer.api().get_balance(RENT_POOL_SS58_ADDRESS).await?;
 
     assert_eq!(initial_balance - before - burned_before, REWARD_PER_BLOCK);
-    assert_eq!(initial_balance - burned_after, after);
+    assert_eq!(
+        initial_balance - burned_after - (rent_pool - rent_pool_initial),
+        after
+    );
+
     Ok(())
 }

gcli/tests/common/mod.rs

@@ -35,6 +35,7 @@ pub mod node;
 mod result;
 
 pub const ALICE_SS58_ADDRESS: &str = "kGkLEU3e3XXkJp2WK4eNpVmSab5xUNL9QtmLPh8QfCL2EgotW";
+pub const RENT_POOL_SS58_ADDRESS: &str = "kGkkENXuYL4Xw6H1ymWm6VwHLi66s56Ywt45pf9hEx1hmx5MV";
 
 impl NodeExec for Node {
     fn ws(&self) -> String {
@@ -93,8 +94,7 @@ pub fn program_id(bin: &[u8], salt: &[u8]) -> ProgramId {
 
 /// AccountId32 of `addr`
 pub fn alice_account_id() -> AccountId32 {
-    AccountId32::from_ss58check("kGkLEU3e3XXkJp2WK4eNpVmSab5xUNL9QtmLPh8QfCL2EgotW")
-        .expect("Invalid address")
+    AccountId32::from_ss58check(ALICE_SS58_ADDRESS).expect("Invalid address")
 }
 
 /// Create program messager

pallets/gear-bank/src/lib.rs

@@ -241,14 +241,6 @@ pub mod pallet {
             .map_err(|_| Error::<T>::InsufficientBankBalance)
         }
 
-        /// Transfers value from bank address to current block author.
-        fn reward_block_author(value: BalanceOf<T>) -> Result<(), Error<T>> {
-            let block_author = Authorship::<T>::author()
-                .unwrap_or_else(|| unreachable!("Failed to find block author!"));
-
-            Self::withdraw(&block_author, value)
-        }
-
         pub fn deposit_gas(
             account_id: &AccountIdOf<T>,
             amount: u64,
@@ -328,6 +320,18 @@ pub mod pallet {
             account_id: &AccountIdOf<T>,
             amount: u64,
             multiplier: GasMultiplier<T>,
+        ) -> Result<(), Error<T>> {
+            let block_author = Authorship::<T>::author()
+                .unwrap_or_else(|| unreachable!("Failed to find block author!"));
+
+            Self::spend_gas_to(&block_author, account_id, amount, multiplier)
+        }
+
+        pub fn spend_gas_to(
+            to: &AccountIdOf<T>,
+            account_id: &AccountIdOf<T>,
+            amount: u64,
+            multiplier: GasMultiplier<T>,
         ) -> Result<(), Error<T>> {
             if amount.is_zero() {
                 return Ok(());
@@ -339,7 +343,7 @@ pub mod pallet {
             // `*_no_transfer` function above.
             //
             // This call does only currency trait final transfer.
-            Self::reward_block_author(value).unwrap_or_else(|e| unreachable!("qed above: {e:?}"));
+            Self::withdraw(to, value).unwrap_or_else(|e| unreachable!("qed above: {e:?}"));
 
             Ok(())
         }

pallets/gear-bank/src/tests.rs

@@ -554,6 +554,8 @@ fn spend_gas_small_amount_validator_account_deleted() {
 #[test]
 fn spend_gas_zero() {
     new_test_ext().execute_with(|| {
+        let _block_author = Authorship::author();
+
         let h = frame_support::storage_root(frame_support::StateVersion::V1);
 
         assert_ok!(GearBank::spend_gas(&ALICE, 0, mult()));
@@ -573,6 +575,8 @@ fn spend_gas_zero() {
 fn spend_gas_insufficient_bank_balance() {
     // Unreachable case for Gear protocol.
     new_test_ext().execute_with(|| {
+        let _block_author = Authorship::author();
+
         const GAS_AMOUNT: u64 = 123_456;
 
         assert_ok!(GearBank::deposit_gas(&ALICE, GAS_AMOUNT, false));
@@ -595,6 +599,8 @@ fn spend_gas_insufficient_bank_balance() {
 #[test]
 fn spend_gas_insufficient_gas_balance() {
     new_test_ext().execute_with(|| {
+        let _block_author = Authorship::author();
+
         const GAS_AMOUNT: u64 = 123_456;
 
         assert_ok!(GearBank::deposit_gas(&ALICE, GAS_AMOUNT, false));
@@ -616,6 +622,8 @@ fn spend_gas_insufficient_gas_balance() {
 #[test]
 fn spend_gas_insufficient_inexistent_gas_balance() {
     new_test_ext().execute_with(|| {
+        let _block_author = Authorship::author();
+
         assert_noop!(
             GearBank::spend_gas(&ALICE, 1, mult()),
             Error::<Test>::InsufficientGasBalance

pallets/gear/src/internal.rs

@@ -19,9 +19,9 @@
 //! Internal details of Gear Pallet implementation.
 
 use crate::{
-    Config, CostsPerBlockOf, CurrencyOf, DispatchStashOf, Event, ExtManager, GasBalanceOf,
-    GasHandlerOf, GasNodeIdOf, GearBank, MailboxOf, Pallet, QueueOf, SchedulingCostOf, TaskPoolOf,
-    WaitlistOf,
+    AccountIdOf, Config, CostsPerBlockOf, CurrencyOf, DispatchStashOf, Event, ExtManager,
+    GasBalanceOf, GasHandlerOf, GasNodeIdOf, GearBank, MailboxOf, Pallet, QueueOf,
+    SchedulingCostOf, TaskPoolOf, WaitlistOf,
 };
 use alloc::collections::BTreeSet;
 use common::{
@@ -209,7 +209,11 @@ where
     ///
     /// Represents logic of burning gas by transferring gas from
     /// current `GasTree` owner to actual block producer.
-    pub(crate) fn spend_gas(id: impl Into<GasNodeIdOf<T>>, amount: GasBalanceOf<T>) {
+    pub(crate) fn spend_gas(
+        to: Option<AccountIdOf<T>>,
+        id: impl Into<GasNodeIdOf<T>>,
+        amount: GasBalanceOf<T>,
+    ) {
         let id = id.into();
 
         // If amount is zero, nothing to do.
@@ -225,9 +229,15 @@ where
         let (external, multiplier, _) = GasHandlerOf::<T>::get_origin_node(id)
             .unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
 
-        // Transferring reserved funds from external user to block author.
-        GearBank::<T>::spend_gas(&external, amount, multiplier)
-            .unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
+        // Transferring reserved funds from external user to destination.
+        let result = match to {
+            Some(account_id) => {
+                GearBank::<T>::spend_gas_to(&account_id, &external, amount, multiplier)
+            }
+            None => GearBank::<T>::spend_gas(&external, amount, multiplier),
+        };
+
+        result.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
     }
 
     /// Consumes message by given `MessageId` or gas reservation by `ReservationId`.
@@ -315,7 +325,7 @@ where
         // Spending gas, if need.
         if !amount.is_zero() {
             // Spending gas.
-            Self::spend_gas(id, amount)
+            Self::spend_gas(<T as Config>::RentPoolId::get(), id, amount)
         }
     }
 

pallets/gear/src/lib.rs

@@ -257,6 +257,9 @@ pub mod pallet {
         /// rent is disabled.
         #[pallet::constant]
         type ProgramRentDisabledDelta: Get<BlockNumberFor<Self>>;
+
+        /// The account id of the rent pool if any.
+        type RentPoolId: Get<Option<AccountIdOf<Self>>>;
     }
 
     #[pallet::pallet]

pallets/gear/src/manager/journal.rs

@@ -161,7 +161,7 @@ where
 
         GasAllowanceOf::<T>::decrease(amount);
 
-        Pallet::<T>::spend_gas(message_id, amount)
+        Pallet::<T>::spend_gas(None, message_id, amount)
     }
 
     fn exit_dispatch(&mut self, id_exited: ProgramId, value_destination: ProgramId) {

pallets/gear/src/mock.rs

@@ -50,6 +50,7 @@ pub(crate) const USER_2: AccountId = 2;
 pub(crate) const USER_3: AccountId = 3;
 pub(crate) const LOW_BALANCE_USER: AccountId = 4;
 pub(crate) const BLOCK_AUTHOR: AccountId = 255;
+pub(crate) const RENT_POOL: AccountId = 256;
 
 macro_rules! dry_run {
     (
@@ -89,7 +90,7 @@ pallet_gear_program::impl_config!(Test);
 pallet_gear_messenger::impl_config!(Test, CurrentBlockNumber = Gear);
 pallet_gear_scheduler::impl_config!(Test);
 pallet_gear_bank::impl_config!(Test);
-pallet_gear::impl_config!(Test, Schedule = DynamicSchedule);
+pallet_gear::impl_config!(Test, Schedule = DynamicSchedule, RentPoolId = ConstU64<RENT_POOL>);
 pallet_gear_gas::impl_config!(Test);
 common::impl_pallet_balances!(Test);
 common::impl_pallet_authorship!(Test);
@@ -191,6 +192,7 @@ pub fn new_test_ext() -> sp_io::TestExternalities {
             (USER_3, 500_000_000_000_000_u128),
             (LOW_BALANCE_USER, 1_000_000_u128),
             (BLOCK_AUTHOR, 500_000_u128),
+            (RENT_POOL, ExistentialDeposit::get()),
             (BankAddress::get(), ExistentialDeposit::get()),
         ],
     }

pallets/gear/src/pallet_tests.rs

@@ -27,6 +27,8 @@ macro_rules! impl_config {
         type GearConfigProgramRentEnabled = ConstBool<true>;
         #[allow(dead_code)]
         type GearConfigSchedule = ();
+        #[allow(dead_code)]
+        type GearRentPoolId = sp_runtime::traits::GetDefault;
 
         mod pallet_tests_gear_config_impl {
             use super::*;
@@ -62,6 +64,7 @@ macro_rules! impl_config_inner {
             type ProgramResumeSessionDuration = ResumeSessionDuration;
             type ProgramRentEnabled = GearConfigProgramRentEnabled;
             type ProgramRentDisabledDelta = RentFreePeriod;
+            type RentPoolId = GearRentPoolId;
         }
     };
 
@@ -82,4 +85,10 @@ macro_rules! impl_config_inner {
 
         $crate::impl_config_inner!($runtime, $($( $rest )*)?);
     };
+
+    ($runtime:ty, RentPoolId = $rent_pool_id:ty $(, $( $rest:tt )*)?) => {
+        type GearRentPoolId = $rent_pool_id;
+
+        $crate::impl_config_inner!($runtime, $($( $rest )*)?);
+    };
 }