Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optimize hooks #1690

Merged
merged 2 commits into from
Mar 11, 2025
Merged

optimize hooks #1690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f50717
optimize hooks
SunTiebing Mar 10, 2025
180ae45
fix test
SunTiebing Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion pallets/channel-commission/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,11 @@ pub mod pallet {

#[pallet::hooks]
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_initialize(_: BlockNumberFor<T>) -> Weight {
fn on_idle(_n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight {
if remaining_weight.any_lt(T::DbWeight::get().reads_writes(12, 6)) {
return Weight::zero();
}

let channel_count: u32 = ChannelNextId::<T>::get().into();
let current_block_number = T::BlockNumberProvider::current_block_number();

Expand Down
3 changes: 2 additions & 1 deletion pallets/channel-commission/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ use bifrost_primitives::{
VTokenSupplyProvider, VtokenMintingInterface,
};
use frame_support::dispatch::DispatchResultWithPostInfo;
use frame_support::pallet_prelude::{Hooks, Weight};
use frame_support::{
derive_impl, ord_parameter_types, parameter_types, traits::Nothing, BoundedVec, PalletId,
};
Expand Down Expand Up @@ -275,6 +276,6 @@ impl ExtBuilder {
pub(crate) fn run_to_block(n: u64) {
while System::block_number() < n {
System::set_block_number(System::block_number() + 1);
ChannelCommission::on_initialize(System::block_number());
ChannelCommission::on_idle(System::block_number(), Weight::MAX);
}
}
10 changes: 5 additions & 5 deletions pallets/channel-commission/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -999,7 +999,7 @@ fn register_a_new_channel_and_mint_should_update_shares_and_get_claimable_tokens
}

#[test]
fn on_initialize_hook_should_work() {
fn on_idle_hook_should_work() {
ExtBuilder::default()
.one_hundred_for_alice_n_bob()
.build()
Expand Down Expand Up @@ -1061,7 +1061,7 @@ fn on_initialize_hook_should_work() {

// set block number to 100
System::set_block_number(100);
ChannelCommission::on_initialize(100);
ChannelCommission::on_idle(100, Weight::MAX);
// set_clearing_environment already been called in block 100
// check whether the clearing environment is set correctly for block 100
assert_eq!(
Expand All @@ -1078,7 +1078,7 @@ fn on_initialize_hook_should_work() {
let channel_b_vtoken_share_before = ChannelVtokenShares::<Runtime>::get(1, VKSM);

System::set_block_number(101);
ChannelCommission::on_initialize(101);
ChannelCommission::on_idle(101, Weight::MAX);

let channel_a_commission = 4;
// check channel A claimable KSM amount after being cleared
Expand All @@ -1103,7 +1103,7 @@ fn on_initialize_hook_should_work() {
);

System::set_block_number(102);
ChannelCommission::on_initialize(102);
ChannelCommission::on_idle(102, Weight::MAX);

let channel_b_commission = 2;
// check channel B claimable KSM amount after being cleared
Expand Down Expand Up @@ -1131,7 +1131,7 @@ fn on_initialize_hook_should_work() {
assert_eq!(bifrost_account_balance_before, 0);

System::set_block_number(103);
ChannelCommission::on_initialize(103);
ChannelCommission::on_idle(103, Weight::MAX);

// cleared commissions should be none
assert_eq!(PeriodClearedCommissions::<Runtime>::get(KSM), 0);
Expand Down
2 changes: 1 addition & 1 deletion pallets/fee-share/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ pub mod pallet {

#[pallet::hooks]
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_idle(_: BlockNumberFor<T>, _remaining_weight: Weight) -> Weight {
fn on_initialize(_: BlockNumberFor<T>) -> Weight {
let current_block_number = T::BlockNumberProvider::current_block_number();
DollarStandardInfos::<T>::iter().for_each(|(distribution_id, mut info)| {
if current_block_number.eq(&info.target_block) {
Expand Down
22 changes: 8 additions & 14 deletions pallets/fee-share/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use frame_support::{assert_err, assert_ok};
use sp_arithmetic::per_things::Perbill;

#[test]
fn on_idle() {
fn on_initialize() {
ExtBuilder::default()
.one_hundred_for_alice_n_bob()
.build()
Expand All @@ -44,13 +44,13 @@ fn on_idle() {
assert_ok!(FeeShare::set_era_length(RuntimeOrigin::signed(ALICE), 1));
let current_block_number = System::block_number() + 1;
System::set_block_number(current_block_number);
FeeShare::on_idle(current_block_number, Weight::zero());
FeeShare::on_initialize(current_block_number);
assert_ok!(<Tokens as MultiCurrency<AccountId>>::transfer(
KSM, &ALICE, &keeper, 100,
));
let current_block_number = System::block_number() + 1;
System::set_block_number(current_block_number);
FeeShare::on_idle(current_block_number, Weight::zero());
FeeShare::on_initialize(current_block_number);
assert_eq!(Tokens::free_balance(KSM, &keeper), 0);
});
}
Expand Down Expand Up @@ -80,17 +80,11 @@ fn edit_delete_distribution() {
<Runtime as Config>::FeeSharePalletId::get().into_sub_account_truncating(0);

assert_ok!(FeeShare::set_era_length(RuntimeOrigin::signed(ALICE), 1));
FeeShare::on_idle(
<frame_system::Pallet<Runtime>>::block_number() + 1,
Weight::zero(),
);
FeeShare::on_initialize(<frame_system::Pallet<Runtime>>::block_number() + 1);
assert_ok!(<Tokens as MultiCurrency<AccountId>>::transfer(
KSM, &ALICE, &keeper, 100,
));
FeeShare::on_idle(
<frame_system::Pallet<Runtime>>::block_number() + 2,
Weight::zero(),
);
FeeShare::on_initialize(<frame_system::Pallet<Runtime>>::block_number() + 2);
assert_eq!(Tokens::free_balance(KSM, &keeper), 10100);
assert_ok!(FeeShare::execute_distribute(
RuntimeOrigin::signed(ALICE),
Expand Down Expand Up @@ -142,7 +136,7 @@ fn set_usd_config_should_work() {
assert_eq!(Tokens::free_balance(KSM, &BOB), 100);
let current_block_number = System::block_number() + 1;
System::set_block_number(current_block_number);
FeeShare::on_idle(current_block_number, Weight::zero());
FeeShare::on_initialize(current_block_number);
assert_ok!(<Tokens as MultiCurrency<AccountId>>::transfer(
KSM, &ALICE, &keeper, 100,
));
Expand All @@ -153,7 +147,7 @@ fn set_usd_config_should_work() {
);
let current_block_number = System::block_number() + 1;
System::set_block_number(current_block_number);
FeeShare::on_idle(current_block_number, Weight::zero());
FeeShare::on_initialize(current_block_number);
assert_eq!(Tokens::free_balance(KSM, &keeper), 0);
assert_eq!(Tokens::free_balance(KSM, &BOB), 10100);
assert_eq!(
Expand All @@ -165,7 +159,7 @@ fn set_usd_config_should_work() {
));
let current_block_number = System::block_number() + 8;
System::set_block_number(current_block_number);
FeeShare::on_idle(current_block_number, Weight::zero());
FeeShare::on_initialize(current_block_number);
assert_eq!(
DollarStandardInfos::<Runtime>::get(0).unwrap().cumulative,
0
Expand Down
6 changes: 5 additions & 1 deletion pallets/vtoken-minting/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,11 @@ pub mod pallet {

#[pallet::hooks]
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_initialize(_n: BlockNumberFor<T>) -> Weight {
fn on_idle(_n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight {
if remaining_weight.any_lt(T::DbWeight::get().reads_writes(12, 6)) {
return Weight::zero();
}

for currency in OngoingTimeUnit::<T>::iter_keys() {
let result = Self::handle_ledger_by_currency(currency);
match result {
Expand Down
4 changes: 2 additions & 2 deletions pallets/vtoken-minting/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,8 +291,8 @@ pub fn run_to_block(n: BlockNumber) {
VtokenMinting::on_finalize(System::block_number());
System::on_finalize(System::block_number());
System::set_block_number(System::block_number() + 1);
System::on_initialize(System::block_number());
VtokenMinting::on_initialize(System::block_number());
System::on_idle(System::block_number(), Weight::MAX);
VtokenMinting::on_idle(System::block_number(), Weight::MAX);
}
}

Expand Down
60 changes: 30 additions & 30 deletions pallets/vtoken-minting/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,10 +388,10 @@ fn movr() {
VMOVR,
10000000000000000000
));
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(MOVR), TimeUnit::Round(2));
assert_eq!(
OngoingTimeUnit::<Runtime>::get(MOVR),
Expand Down Expand Up @@ -504,10 +504,10 @@ fn eth() {
V_WETH,
10000000000000000000
));
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(WETH), TimeUnit::Round(2));
assert_eq!(
OngoingTimeUnit::<Runtime>::get(WETH),
Expand Down Expand Up @@ -572,11 +572,11 @@ fn hook() {
1
));
assert_eq!(UnlockDuration::<Runtime>::get(KSM), Some(TimeUnit::Era(1)));
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(KSM), TimeUnit::Era(4));
assert_ok!(VtokenMinting::increase_token_pool(KSM, 1000));
assert_ok!(VtokenMinting::mint(
Expand Down Expand Up @@ -606,9 +606,9 @@ fn hook() {
));
let (entrance_account, _exit_account) = VtokenMinting::get_entrance_and_exit_accounts();
assert_eq!(Tokens::free_balance(KSM, &entrance_account), 300);
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(KSM), TimeUnit::Era(4));
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(TokenUnlockLedger::<Runtime>::get(KSM, 0), None);
assert_eq!(TokenUnlockLedger::<Runtime>::get(KSM, 1), None);
assert_eq!(
Expand All @@ -626,9 +626,9 @@ fn hook() {
KSM,
TimeUnit::Era(5)
));
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(0);
VtokenMinting::on_initialize(1);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(0, Weight::MAX);
VtokenMinting::on_idle(1, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(KSM), TimeUnit::Era(6));
assert_eq!(UnlockingTotal::<Runtime>::get(KSM), 0);
assert_ok!(VtokenMinting::mint(
Expand All @@ -639,7 +639,7 @@ fn hook() {
None
));
assert_ok!(VtokenMinting::redeem(Some(BOB).into(), None, VKSM, 200));
VtokenMinting::on_initialize(0);
VtokenMinting::on_idle(0, Weight::MAX);
assert_eq!(
TokenUnlockLedger::<Runtime>::get(KSM, 2),
Some((BOB, 100, TimeUnit::Era(6), RedeemType::Native))
Expand Down Expand Up @@ -763,11 +763,11 @@ fn fast_redeem_for_fil() {
UnlockDuration::<Runtime>::get(FIL),
Some(TimeUnit::Kblock(1))
);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(FIL), TimeUnit::Kblock(4));
assert_ok!(VtokenMinting::increase_token_pool(FIL, 1000));
assert_ok!(VtokenMinting::mint(
Expand Down Expand Up @@ -797,9 +797,9 @@ fn fast_redeem_for_fil() {
));
let (entrance_account, _exit_account) = VtokenMinting::get_entrance_and_exit_accounts();
assert_eq!(Tokens::free_balance(FIL, &entrance_account), 300);
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(FIL), TimeUnit::Kblock(4));
VtokenMinting::on_initialize(100);
VtokenMinting::on_idle(100, Weight::MAX);
assert_eq!(TokenUnlockLedger::<Runtime>::get(FIL, 0), None);
assert_eq!(TokenUnlockLedger::<Runtime>::get(FIL, 1), None);
assert_eq!(
Expand All @@ -817,9 +817,9 @@ fn fast_redeem_for_fil() {
FIL,
TimeUnit::Kblock(5)
));
VtokenMinting::on_initialize(100);
VtokenMinting::on_initialize(0);
VtokenMinting::on_initialize(1);
VtokenMinting::on_idle(100, Weight::MAX);
VtokenMinting::on_idle(0, Weight::MAX);
VtokenMinting::on_idle(1, Weight::MAX);
assert_eq!(MinTimeUnit::<Runtime>::get(FIL), TimeUnit::Kblock(6));
assert_eq!(UnlockingTotal::<Runtime>::get(FIL), 0);
assert_ok!(VtokenMinting::mint(
Expand All @@ -830,7 +830,7 @@ fn fast_redeem_for_fil() {
None
));
assert_ok!(VtokenMinting::redeem(Some(BOB).into(), None, VFIL, 200));
VtokenMinting::on_initialize(0);
VtokenMinting::on_idle(0, Weight::MAX);
assert_eq!(
TokenUnlockLedger::<Runtime>::get(FIL, 2),
Some((BOB, 100, TimeUnit::Kblock(6), RedeemType::Native))
Expand Down