feat(vara,gear-bank): Split gas and fees to author/treasury

pallets/gear-bank/src/lib.rs

@@ -46,6 +46,8 @@ macro_rules! impl_config {
             type Currency = Balances;
             type BankAddress = BankAddress;
             type GasMultiplier = GasMultiplier;
+            type SplitGas = SplitGas;
+            type SplitTxFeeRatio = SplitTxFeeRatio;
         }
     };
 }
@@ -78,7 +80,7 @@ pub mod pallet {
     use pallet_authorship::Pallet as Authorship;
     use parity_scale_codec::{Decode, Encode, EncodeLike, MaxEncodedLen};
     use scale_info::TypeInfo;
-    use sp_runtime::traits::Zero;
+    use sp_runtime::{traits::Zero, Perbill};
 
     // Funds pallet struct itself.
     #[pallet::pallet]
@@ -100,6 +102,11 @@ pub mod pallet {
         #[pallet::constant]
         /// Gas price converter.
         type GasMultiplier: Get<GasMultiplier<Self>>;
+
+        type SplitGas: Get<Option<(Perbill, AccountIdOf<Self>)>>;
+
+        /// The ratio of how much of the tx fees goes to the treasury
+        type SplitTxFeeRatio: Get<Option<u32>>;
     }
 
     // Funds pallets error.
@@ -218,10 +225,28 @@ pub mod pallet {
             while let Some((account_id, value)) = OnFinalizeTransfers::<T>::drain().next() {
                 total = total.saturating_add(value);
 
-                if let Err(e) = Self::withdraw(&account_id, value) {
-                    log::error!(
-                        "Block #{bn:?} ended with unreachable error while performing on-finalize transfer to {account_id:?}: {e:?}"
-                    );
+                if let Some((gas_split, split_dest)) = T::SplitGas::get() {
+                    // split value by `SplitGas`.
+                    let to_split = gas_split.mul_floor(value);
+                    let to_user = value - to_split;
+
+                    // Withdraw value to user.
+                    if let Err(e) = Self::withdraw(&account_id, to_user) {
+                        log::error!(
+                            "Block #{bn:?} ended with unreachable error while performing on-finalize transfer to {account_id:?}: {e:?}"
+                        );
+                    }
+
+                    // Withdraw value to `SplitGas` destination.
+                    if let Err(e) = Self::withdraw(&split_dest, to_split) {
+                        log::error!(
+                            "Block #{bn:?} ended with unreachable error while performing on-finalize transfer to {account_id:?}: {e:?}"
+                        );
+                    }
+                } else {
+                    let _ = Self::withdraw(&account_id, value).map_err(|e| log::error!(
+                                "Block #{bn:?} ended with unreachable error while performing on-finalize transfer to {account_id:?}: {e:?}"
+                            ));
                 }
             }
 

pallets/gear-bank/src/mock.rs

@@ -21,12 +21,13 @@ use frame_support::{
     construct_runtime, parameter_types,
     traits::{ConstU32, FindAuthor},
     weights::constants::RocksDbWeight,
+    PalletId,
 };
 use primitive_types::H256;
 use sp_io::TestExternalities;
 use sp_runtime::{
-    traits::{BlakeTwo256, IdentityLookup},
-    BuildStorage,
+    traits::{AccountIdConversion, BlakeTwo256, IdentityLookup},
+    BuildStorage, Perbill,
 };
 
 pub type AccountId = u8;
@@ -64,6 +65,9 @@ parameter_types! {
     pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(VALUE_PER_GAS);
     pub const BlockHashCount: BlockNumber = 250;
     pub const ExistentialDeposit: Balance = EXISTENTIAL_DEPOSIT;
+    // TODO: Issue #4058
+    pub SplitGas: Option<(Perbill, AccountId)> = Some((Perbill::from_percent(50), PalletId(*b"py/trsry").into_account_truncating()));
+    pub SplitTxFeeRatio: Option<u32> = None;
 }
 
 construct_runtime!(

pallets/gear-bank/src/tests.rs

@@ -499,7 +499,9 @@ fn spend_gas_all_balance_validator_account_deleted() {
 
         assert_bank_balance(0, 0);
 
-        assert_balance(&BLOCK_AUTHOR, gas_price(GAS_AMOUNT));
+        // mul ceil GAS_AMOUNT because of gas fee split.
+        let (gas_split, _) = SplitGas::get().unwrap();
+        assert_balance(&BLOCK_AUTHOR, gas_split.mul_ceil(gas_price(GAS_AMOUNT)));
 
         assert_alice_dec(gas_price(GAS_AMOUNT));
         assert_gas_value(&ALICE, 0, 0);
@@ -1636,7 +1638,12 @@ mod utils {
     // Asserts block author balance inc.
     #[track_caller]
     pub fn assert_block_author_inc(diff: Balance) {
-        assert_balance(&BLOCK_AUTHOR, EXISTENTIAL_DEPOSIT + diff)
+        // mul ceil diff because of gas fee split.
+        let (gas_split, _) = SplitGas::get().unwrap();
+        assert_balance(
+            &BLOCK_AUTHOR,
+            EXISTENTIAL_DEPOSIT + gas_split.mul_ceil(diff),
+        )
     }
 
     // Asserts Charlie balance inc.

pallets/gear-builtin/src/mock.rs

@@ -113,6 +113,8 @@ parameter_types! {
     pub const PerformanceMultiplier: u32 = 100;
     pub const BankAddress: AccountId = 15082001;
     pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(25);
+    pub SplitGas: Option<(Perbill, AccountId)> = None;
+    pub SplitTxFeeRatio: Option<u32> = None;
 }
 
 pallet_gear_bank::impl_config!(Test);

pallets/gear-builtin/src/tests/bad_builtin_ids.rs

@@ -82,6 +82,8 @@ parameter_types! {
     pub const PerformanceMultiplier: u32 = 100;
     pub const BankAddress: AccountId = 15082001;
     pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(25);
+    pub SplitGas: Option<(Perbill, AccountId)> = None;
+    pub SplitTxFeeRatio: Option<u32> = None;
 }
 
 pallet_gear_bank::impl_config!(Test);

pallets/gear-builtin/src/tests/staking.rs

@@ -704,6 +704,8 @@ mod util {
         pub const PerformanceMultiplier: u32 = 100;
         pub const BankAddress: AccountId = 15082001;
         pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(25);
+        pub SplitGas: Option<(Perbill, AccountId)> = None;
+        pub SplitTxFeeRatio: Option<u32> = None;
     }
 
     pub struct TestSessionHandler;

pallets/gear-debug/src/mock.rs

@@ -32,7 +32,7 @@ use primitive_types::H256;
 use sp_core::ConstBool;
 use sp_runtime::{
     traits::{BlakeTwo256, ConstU64, IdentityLookup},
-    BuildStorage,
+    BuildStorage, Perbill,
 };
 use sp_std::convert::{TryFrom, TryInto};
 
@@ -70,6 +70,8 @@ parameter_types! {
     pub ResumeSessionDuration: BlockNumber = 1_000;
     pub const BankAddress: AccountId = 15082001;
     pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(25);
+    pub SplitGas: Option<(Perbill, AccountId)> = None;
+    pub SplitTxFeeRatio: Option<u32> = None;
     pub ReserveThreshold: BlockNumber = 1;
 }
 

pallets/gear-eth-bridge/src/mock.rs

@@ -30,7 +30,7 @@ use sp_core::{ed25519::Public, H256};
 use sp_runtime::{
     impl_opaque_keys,
     traits::{BlakeTwo256, IdentityLookup},
-    BuildStorage,
+    BuildStorage, Perbill,
 };
 use sp_std::convert::{TryFrom, TryInto};
 
@@ -160,6 +160,8 @@ parameter_types! {
     pub const PerformanceMultiplier: u32 = 100;
     pub const BankAddress: AccountId = 15082001;
     pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(25);
+    pub SplitGas: Option<(Perbill, AccountId)> = None;
+    pub SplitTxFeeRatio: Option<u32> = None;
 }
 
 pallet_gear_bank::impl_config!(Test);

pallets/gear-scheduler/src/mock.rs

@@ -32,7 +32,7 @@ use pallet_gear::GasAllowanceOf;
 use sp_core::{ConstBool, H256};
 use sp_runtime::{
     traits::{BlakeTwo256, IdentityLookup},
-    BuildStorage,
+    BuildStorage, Perbill,
 };
 
 use sp_std::convert::{TryFrom, TryInto};
@@ -94,6 +94,8 @@ parameter_types! {
     pub ResumeSessionDuration: BlockNumber = 1_000;
     pub const BankAddress: AccountId = 15082001;
     pub const GasMultiplier: common::GasMultiplier<Balance, u64> = common::GasMultiplier::ValuePerGas(25);
+    pub SplitGas: Option<(Perbill, AccountId)> = None;
+    pub SplitTxFeeRatio: Option<u32> = None;
 }
 
 // Build genesis storage according to the mock runtime.