Rust质押奖励函数库pallet-staking-reward-fn的使用，Substrate区块链staking模块自定义奖励机制实现

安装

在项目目录中运行以下Cargo命令：

cargo add pallet-staking-reward-fn

或者在Cargo.toml中添加以下行：

pallet-staking-reward-fn = "24.0.0"

使用示例

以下是如何使用pallet-staking-reward-fn实现自定义质押奖励机制的完整示例：

use frame_support::{decl_module, decl_storage, dispatch::DispatchResult};
use pallet_staking_reward_fn::{RewardFunction, RewardParams};
use sp_runtime::Perbill;

// 1. 定义你的自定义奖励函数
pub struct CustomRewardFunction;

impl RewardFunction for CustomRewardFunction {
    fn calculate_reward(params: RewardParams) -> Perbill {
        // 自定义奖励计算逻辑
        // 例如：根据质押时间和金额计算奖励
        let base_reward = Perbill::from_percent(5); // 5%基础奖励
        
        // 如果质押超过100个代币，增加1%
        if params.stake > 100.into() {
            base_reward + Perbill::from_percent(1)
        } else {
            base_reward
        }
    }
}

// 2. 在你的pallet中使用自定义奖励函数
decl_module! {
    pub struct Module<T: Config> for enum Call where origin: T::Origin {
        fn set_reward_function(origin) -> DispatchResult {
            // 设置自定义奖励函数
            pallet_staking_reward_fn::RewardFunctionProvider::<T>::set(RewardFunctionType::Custom(Box::new(CustomRewardFunction)));
            
            Ok(())
        }
    }
}

// 3. 在你的runtime中配置staking奖励函数
impl pallet_staking::Config for Runtime {
    // ...
    type RewardFunction = pallet_staking_reward_fn::RewardFunctionAdapter<CustomRewardFunction>;
    // ...
}

实现细节

1. 自定义奖励函数:

   • 实现RewardFunction trait
   • 根据RewardParams(包含质押金额、时间等参数)计算奖励比例
   • 返回Perbill类型，表示奖励比例

2. 在pallet中使用:

   • 通过RewardFunctionProvider设置自定义奖励函数
   • 可以动态切换不同的奖励算法

3. runtime配置:

   • 在staking pallet配置中指定自定义奖励函数
   • 使用RewardFunctionAdapter适配器将自定义函数集成到staking模块

完整示例代码

// runtime/src/lib.rs

use frame_support::{parameter_types, traits::Everything};
use sp_runtime::{
    traits::{IdentifyAccount, Verify},
    Perbill,
};

// 1. 定义自定义奖励函数
pub struct TieredRewardFunction;

impl pallet_staking_reward_fn::RewardFunction for TieredRewardFunction {
    fn calculate_reward(params: pallet_staking_reward_fn::RewardParams) -> Perbill {
        // 分级奖励算法
        match params.stake {
            stake if stake > 1000.into() => Perbill::from_percent(8),  // 大额质押8%
            stake if stake > 500.into() => Perbill::from_percent(6),   // 中额质押6%
            stake if stake > 100.into() => Perbill::from_percent(5),   // 小额质押5%
            _ => Perbill::from_percent(3),                             // 默认3%
        }
    }
}

// 2. 创建自定义pallet
pub mod custom_staking_pallet {
    use super::*;
    use frame_support::{decl_module, decl_storage, dispatch::DispatchResult};
    use frame_system::ensure_root;

    pub trait Config: frame_system::Config {}

    decl_storage! {
        trait Store for Module<T: Config> as CustomStakingPallet {
            // 存储定义
        }
    }

    decl_module! {
        pub struct Module<T: Config> for enum Call where origin: T::Origin {
            // 设置奖励函数
            #[weight = 0]
            pub fn set_reward_function(origin) -> DispatchResult {
                ensure_root(origin)?;
                
                // 使用TieredRewardFunction作为奖励函数
                pallet_staking_reward_fn::RewardFunctionProvider::<T>::set(
                    pallet_staking_reward_fn::RewardFunctionType::Custom(Box::new(TieredRewardFunction))
                );
                
                Ok(())
            }
        }
    }
}

// 3. runtime配置
parameter_types! {
    pub const SessionsPerEra: sp_staking::SessionIndex = 6;
    pub const BondingDuration: sp_staking::EraIndex = 24;
}

impl pallet_staking::Config for Runtime {
    type Currency = Balances;
    type UnixTime = Timestamp;
    type CurrencyToVote = U128CurrencyToVote;
    type RewardFunction = pallet_staking_reward_fn::RewardFunctionAdapter<TieredRewardFunction>;
    type SessionsPerEra = SessionsPerEra;
    type BondingDuration = BondingDuration;
    type Slash = ();
    type SessionInterface = Self;
    type Event = Event;
    type WeightInfo = ();
    type MaxNominatorRewardedPerValidator = MaxNominatorRewardedPerValidator;
    type OffendingValidatorsThreshold = OffendingValidatorsThreshold;
}

// 4. 在construct_runtime!宏中包含pallet
construct_runtime!(
    pub enum Runtime where
        Block = Block,
        NodeBlock = opaque::Block,
        UncheckedExtrinsic = UncheckedExtrinsic
    {
        // ...
        Staking: pallet_staking::{Pallet, Call, Storage, Config<T>, Event<T>},
        CustomStakingPallet: custom_staking_pallet::{Pallet, Call, Storage},
        // ...
    }
);

功能说明

1. 分级奖励机制:

   • 根据质押金额不同提供不同奖励比例
   • 大额质押(>1000)获得8%奖励
   • 中额质押(>500)获得6%奖励
   • 小额质押(>100)获得5%奖励
   • 默认3%奖励

2. 动态设置:

   • 通过root账户调用set_reward_function方法
   • 可以随时更换奖励算法

3. 与staking模块集成:

   • 通过RewardFunctionAdapter将自定义函数集成到staking模块
   • 保持与原生staking模块的兼容性