pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-05-31 09:51:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

pallet-grandpa: Improve/Clarify docs of note_stalled (#11623)

Browse Source
This commit is contained in:
Bastian Köcher
2022-06-13 10:31:16 +02:00
committed by GitHub
parent 973b6be6f5
commit 70d8b674a9
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/grandpa/src/lib.rs
+11 -6
View File
@@ -231,12 +231,17 @@ pub mod pallet {
)
}
/// Note that the current authority set of the GRANDPA finality gadget has
/// stalled. This will trigger a forced authority set change at the beginning
/// of the next session, to be enacted `delay` blocks after that. The delay
/// should be high enough to safely assume that the block signalling the
/// forced change will not be re-orged (e.g. 1000 blocks). The GRANDPA voters
/// will start the new authority set using the given finalized block as base.
/// Note that the current authority set of the GRANDPA finality gadget has stalled.
///
/// This will trigger a forced authority set change at the beginning of the next session, to
/// be enacted `delay` blocks after that. The `delay` should be high enough to safely assume
/// that the block signalling the forced change will not be re-orged e.g. 1000 blocks.
/// The block production rate (which may be slowed down because of finality lagging) should
/// be taken into account when choosing the `delay`. The GRANDPA voters based on the new
/// authority will start voting on top of `best_finalized_block_number` for new finalized
/// blocks. `best_finalized_block_number` should be the highest of the latest finalized
/// block of all validators of the new authority set.
///
/// Only callable by root.
#[pallet::weight(T::WeightInfo::note_stalled())]
pub fn note_stalled(