mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-10-27 22:19:49 +00:00
frame: remove finality-tracker (#7228)
* frame: remove finality-tracker * node: remove unused parameter types * node: bump spec_version
This commit is contained in:
André Silva authored and GitHub committed
1 parent
8e8a37f7a1
commit
f3ea1624f6
22 files changed
+21
-638
No files matched your search
@@ -1,43 +0,0 @@
|
||||
[package]
|
||||
name = "pallet-finality-tracker"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
license = "Apache-2.0"
|
||||
homepage = "https://substrate.dev"
|
||||
repository = "https://github.com/paritytech/substrate/"
|
||||
description = "FRAME Pallet that tracks the last finalized block, as perceived by block authors."
|
||||
documentation = "https://docs.rs/pallet-finality-tracker"
|
||||
readme = "README.md"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
targets = ["x86_64-unknown-linux-gnu"]
|
||||
|
||||
|
||||
[dependencies]
|
||||
serde = { version = "1.0.101", default-features = false, features = ["derive"] }
|
||||
codec = { package = "parity-scale-codec", version = "1.3.4", default-features = false }
|
||||
sp-inherents = { version = "2.0.0", default-features = false, path = "../../primitives/inherents" }
|
||||
sp-std = { version = "2.0.0", default-features = false, path = "../../primitives/std" }
|
||||
sp-runtime = { version = "2.0.0", default-features = false, path = "../../primitives/runtime" }
|
||||
sp-finality-tracker = { version = "2.0.0", default-features = false, path = "../../primitives/finality-tracker" }
|
||||
frame-support = { version = "2.0.0", default-features = false, path = "../support" }
|
||||
frame-system = { version = "2.0.0", default-features = false, path = "../system" }
|
||||
impl-trait-for-tuples = "0.1.3"
|
||||
|
||||
[dev-dependencies]
|
||||
sp-core = { version = "2.0.0", default-features = false, path = "../../primitives/core" }
|
||||
sp-io = { version = "2.0.0", default-features = false, path = "../../primitives/io" }
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"serde/std",
|
||||
"codec/std",
|
||||
"sp-std/std",
|
||||
"frame-support/std",
|
||||
"sp-runtime/std",
|
||||
"frame-system/std",
|
||||
"sp-finality-tracker/std",
|
||||
"sp-inherents/std",
|
||||
]
|
||||
@@ -1,3 +0,0 @@
|
||||
FRAME Pallet that tracks the last finalized block, as perceived by block authors.
|
||||
|
||||
License: Apache-2.0
|
||||
@@ -1,352 +0,0 @@
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Copyright (C) 2019-2020 Parity Technologies (UK) Ltd.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! FRAME Pallet that tracks the last finalized block, as perceived by block authors.
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
use sp_inherents::{InherentIdentifier, ProvideInherent, InherentData, MakeFatalError};
|
||||
use sp_runtime::traits::{One, Zero, SaturatedConversion};
|
||||
use sp_std::{prelude::*, result, cmp, vec};
|
||||
use frame_support::{decl_module, decl_storage, decl_error, ensure};
|
||||
use frame_support::traits::Get;
|
||||
use frame_support::weights::{DispatchClass};
|
||||
use frame_system::{ensure_none, Trait as SystemTrait};
|
||||
use sp_finality_tracker::{INHERENT_IDENTIFIER, FinalizedInherentData};
|
||||
|
||||
pub const DEFAULT_WINDOW_SIZE: u32 = 101;
|
||||
pub const DEFAULT_REPORT_LATENCY: u32 = 1000;
|
||||
|
||||
pub trait Trait: SystemTrait {
|
||||
/// Something which can be notified when the timestamp is set. Set this to `()`
|
||||
/// if not needed.
|
||||
type OnFinalizationStalled: OnFinalizationStalled<Self::BlockNumber>;
|
||||
/// The number of recent samples to keep from this chain. Default is 101.
|
||||
type WindowSize: Get<Self::BlockNumber>;
|
||||
/// The delay after which point things become suspicious. Default is 1000.
|
||||
type ReportLatency: Get<Self::BlockNumber>;
|
||||
}
|
||||
|
||||
decl_storage! {
|
||||
trait Store for Module<T: Trait> as FinalityTracker {
|
||||
/// Recent hints.
|
||||
RecentHints get(fn recent_hints) build(|_| vec![T::BlockNumber::zero()]): Vec<T::BlockNumber>;
|
||||
/// Ordered recent hints.
|
||||
OrderedHints get(fn ordered_hints) build(|_| vec![T::BlockNumber::zero()]): Vec<T::BlockNumber>;
|
||||
/// The median.
|
||||
Median get(fn median) build(|_| T::BlockNumber::zero()): T::BlockNumber;
|
||||
|
||||
/// Final hint to apply in the block. `None` means "same as parent".
|
||||
Update: Option<T::BlockNumber>;
|
||||
|
||||
// when initialized through config this is set in the beginning.
|
||||
Initialized get(fn initialized) build(|_| false): bool;
|
||||
}
|
||||
}
|
||||
|
||||
decl_error! {
|
||||
pub enum Error for Module<T: Trait> {
|
||||
/// Final hint must be updated only once in the block
|
||||
AlreadyUpdated,
|
||||
/// Finalized height above block number
|
||||
BadHint,
|
||||
}
|
||||
}
|
||||
|
||||
decl_module! {
|
||||
pub struct Module<T: Trait> for enum Call where origin: T::Origin {
|
||||
type Error = Error<T>;
|
||||
/// The number of recent samples to keep from this chain. Default is 101.
|
||||
const WindowSize: T::BlockNumber = T::WindowSize::get();
|
||||
|
||||
/// The delay after which point things become suspicious. Default is 1000.
|
||||
const ReportLatency: T::BlockNumber = T::ReportLatency::get();
|
||||
|
||||
/// Hint that the author of this block thinks the best finalized
|
||||
/// block is the given number.
|
||||
#[weight = (0, DispatchClass::Mandatory)]
|
||||
fn final_hint(origin, #[compact] hint: T::BlockNumber) {
|
||||
ensure_none(origin)?;
|
||||
ensure!(!<Self as Store>::Update::exists(), Error::<T>::AlreadyUpdated);
|
||||
ensure!(
|
||||
frame_system::Module::<T>::block_number() >= hint,
|
||||
Error::<T>::BadHint,
|
||||
);
|
||||
<Self as Store>::Update::put(hint);
|
||||
}
|
||||
|
||||
fn on_finalize() {
|
||||
Self::update_hint(<Self as Store>::Update::take())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Trait> Module<T> {
|
||||
fn update_hint(hint: Option<T::BlockNumber>) {
|
||||
if !Self::initialized() {
|
||||
<Self as Store>::RecentHints::put(vec![T::BlockNumber::zero()]);
|
||||
<Self as Store>::OrderedHints::put(vec![T::BlockNumber::zero()]);
|
||||
<Self as Store>::Median::put(T::BlockNumber::zero());
|
||||
|
||||
<Self as Store>::Initialized::put(true);
|
||||
}
|
||||
|
||||
let mut recent = Self::recent_hints();
|
||||
let mut ordered = Self::ordered_hints();
|
||||
let window_size = cmp::max(T::BlockNumber::one(), T::WindowSize::get());
|
||||
|
||||
let hint = hint.unwrap_or_else(|| recent.last()
|
||||
.expect("always at least one recent sample; qed").clone()
|
||||
);
|
||||
|
||||
// prune off the front of the list -- typically 1 except for when
|
||||
// the sample size has just been shrunk.
|
||||
{
|
||||
// take into account the item we haven't pushed yet.
|
||||
let to_prune = (recent.len() + 1).saturating_sub(window_size.saturated_into::<usize>());
|
||||
|
||||
for drained in recent.drain(..to_prune) {
|
||||
let idx = ordered.binary_search(&drained)
|
||||
.expect("recent and ordered contain the same items; qed");
|
||||
|
||||
ordered.remove(idx);
|
||||
}
|
||||
}
|
||||
|
||||
// find the position in the ordered list where the new item goes.
|
||||
let ordered_idx = ordered.binary_search(&hint)
|
||||
.unwrap_or_else(|idx| idx);
|
||||
|
||||
ordered.insert(ordered_idx, hint);
|
||||
recent.push(hint);
|
||||
|
||||
let two = T::BlockNumber::one() + T::BlockNumber::one();
|
||||
|
||||
let median = {
|
||||
let len = ordered.len();
|
||||
assert!(len > 0, "pruning dictated by window_size which is always saturated at 1; qed");
|
||||
|
||||
if len % 2 == 0 {
|
||||
let a = ordered[len / 2];
|
||||
let b = ordered[(len / 2) - 1];
|
||||
|
||||
// compute average.
|
||||
(a + b) / two
|
||||
} else {
|
||||
ordered[len / 2]
|
||||
}
|
||||
};
|
||||
|
||||
let our_window_size = recent.len() as u32;
|
||||
|
||||
<Self as Store>::RecentHints::put(recent);
|
||||
<Self as Store>::OrderedHints::put(ordered);
|
||||
<Self as Store>::Median::put(median);
|
||||
|
||||
if T::BlockNumber::from(our_window_size) == window_size {
|
||||
let now = frame_system::Module::<T>::block_number();
|
||||
let latency = T::ReportLatency::get();
|
||||
|
||||
// the delay is the latency plus half the window size.
|
||||
let delay = latency + (window_size / two);
|
||||
// median may be at most n - delay
|
||||
if median + delay <= now {
|
||||
T::OnFinalizationStalled::on_stalled(window_size - T::BlockNumber::one(), median);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Called when finalization stalled at a given number.
|
||||
#[impl_trait_for_tuples::impl_for_tuples(30)]
|
||||
pub trait OnFinalizationStalled<N> {
|
||||
/// The parameter here is how many more blocks to wait before applying
|
||||
/// changes triggered by finality stalling.
|
||||
fn on_stalled(further_wait: N, median: N);
|
||||
}
|
||||
|
||||
impl<T: Trait> ProvideInherent for Module<T> {
|
||||
type Call = Call<T>;
|
||||
type Error = MakeFatalError<()>;
|
||||
const INHERENT_IDENTIFIER: InherentIdentifier = INHERENT_IDENTIFIER;
|
||||
|
||||
fn create_inherent(data: &InherentData) -> Option<Self::Call> {
|
||||
if let Ok(final_num) = data.finalized_number() {
|
||||
// make hint only when not same as last to avoid bloat.
|
||||
Self::recent_hints().last().and_then(|last| if last == &final_num {
|
||||
None
|
||||
} else {
|
||||
Some(Call::final_hint(final_num))
|
||||
})
|
||||
} else {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
||||
fn check_inherent(_call: &Self::Call, _data: &InherentData) -> result::Result<(), Self::Error> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use sp_io::TestExternalities;
|
||||
use sp_core::H256;
|
||||
use sp_runtime::{
|
||||
testing::Header,
|
||||
traits::{BlakeTwo256, IdentityLookup},
|
||||
Perbill,
|
||||
};
|
||||
use frame_support::{
|
||||
assert_ok, impl_outer_origin, parameter_types,
|
||||
weights::Weight,
|
||||
traits::OnFinalize,
|
||||
};
|
||||
use frame_system as system;
|
||||
use std::cell::RefCell;
|
||||
|
||||
#[derive(Clone, PartialEq, Debug)]
|
||||
pub struct StallEvent {
|
||||
at: u64,
|
||||
further_wait: u64,
|
||||
}
|
||||
|
||||
#[derive(Clone, Eq, PartialEq)]
|
||||
pub struct Test;
|
||||
|
||||
impl_outer_origin! {
|
||||
pub enum Origin for Test where system = frame_system {}
|
||||
}
|
||||
|
||||
thread_local! {
|
||||
static NOTIFICATIONS: RefCell<Vec<StallEvent>> = Default::default();
|
||||
}
|
||||
|
||||
pub struct StallTracker;
|
||||
impl OnFinalizationStalled<u64> for StallTracker {
|
||||
fn on_stalled(further_wait: u64, _median: u64) {
|
||||
let now = System::block_number();
|
||||
NOTIFICATIONS.with(|v| v.borrow_mut().push(StallEvent { at: now, further_wait }));
|
||||
}
|
||||
}
|
||||
|
||||
parameter_types! {
|
||||
pub const BlockHashCount: u64 = 250;
|
||||
pub const MaximumBlockWeight: Weight = 1024;
|
||||
pub const MaximumBlockLength: u32 = 2 * 1024;
|
||||
pub const AvailableBlockRatio: Perbill = Perbill::one();
|
||||
}
|
||||
impl system::Trait for Test {
|
||||
type BaseCallFilter = ();
|
||||
type Origin = Origin;
|
||||
type Index = u64;
|
||||
type BlockNumber = u64;
|
||||
type Call = ();
|
||||
type Hash = H256;
|
||||
type Hashing = BlakeTwo256;
|
||||
type AccountId = u64;
|
||||
type Lookup = IdentityLookup<u64>;
|
||||
type Header = Header;
|
||||
type Event = ();
|
||||
type BlockHashCount = BlockHashCount;
|
||||
type MaximumBlockWeight = MaximumBlockWeight;
|
||||
type DbWeight = ();
|
||||
type BlockExecutionWeight = ();
|
||||
type ExtrinsicBaseWeight = ();
|
||||
type MaximumExtrinsicWeight = MaximumBlockWeight;
|
||||
type AvailableBlockRatio = AvailableBlockRatio;
|
||||
type MaximumBlockLength = MaximumBlockLength;
|
||||
type Version = ();
|
||||
type PalletInfo = ();
|
||||
type AccountData = ();
|
||||
type OnNewAccount = ();
|
||||
type OnKilledAccount = ();
|
||||
type SystemWeightInfo = ();
|
||||
}
|
||||
parameter_types! {
|
||||
pub const WindowSize: u64 = 11;
|
||||
pub const ReportLatency: u64 = 100;
|
||||
}
|
||||
impl Trait for Test {
|
||||
type OnFinalizationStalled = StallTracker;
|
||||
type WindowSize = WindowSize;
|
||||
type ReportLatency = ReportLatency;
|
||||
}
|
||||
|
||||
type System = system::Module<Test>;
|
||||
type FinalityTracker = Module<Test>;
|
||||
|
||||
#[test]
|
||||
fn median_works() {
|
||||
let t = system::GenesisConfig::default().build_storage::<Test>().unwrap();
|
||||
TestExternalities::new(t).execute_with(|| {
|
||||
FinalityTracker::update_hint(Some(500));
|
||||
assert_eq!(FinalityTracker::median(), 250);
|
||||
assert!(NOTIFICATIONS.with(|n| n.borrow().is_empty()));
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn notifies_when_stalled() {
|
||||
let t = system::GenesisConfig::default().build_storage::<Test>().unwrap();
|
||||
TestExternalities::new(t).execute_with(|| {
|
||||
let mut parent_hash = System::parent_hash();
|
||||
for i in 2..106 {
|
||||
System::initialize(
|
||||
&i,
|
||||
&parent_hash,
|
||||
&Default::default(),
|
||||
&Default::default(),
|
||||
Default::default()
|
||||
);
|
||||
FinalityTracker::on_finalize(i);
|
||||
let hdr = System::finalize();
|
||||
parent_hash = hdr.hash();
|
||||
}
|
||||
|
||||
assert_eq!(
|
||||
NOTIFICATIONS.with(|n| n.borrow().clone()),
|
||||
vec![StallEvent { at: 105, further_wait: 10 }]
|
||||
)
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn recent_notifications_prevent_stalling() {
|
||||
let t = system::GenesisConfig::default().build_storage::<Test>().unwrap();
|
||||
TestExternalities::new(t).execute_with(|| {
|
||||
let mut parent_hash = System::parent_hash();
|
||||
for i in 2..106 {
|
||||
System::initialize(
|
||||
&i,
|
||||
&parent_hash,
|
||||
&Default::default(),
|
||||
&Default::default(),
|
||||
Default::default(),
|
||||
);
|
||||
assert_ok!(FinalityTracker::final_hint(Origin::none(), i - 1));
|
||||
FinalityTracker::on_finalize(i);
|
||||
let hdr = System::finalize();
|
||||
parent_hash = hdr.hash();
|
||||
}
|
||||
|
||||
assert!(NOTIFICATIONS.with(|n| n.borrow().is_empty()));
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -27,7 +27,6 @@ frame-support = { version = "2.0.0", default-features = false, path = "../suppor
|
||||
frame-system = { version = "2.0.0", default-features = false, path = "../system" }
|
||||
pallet-authorship = { version = "2.0.0", default-features = false, path = "../authorship" }
|
||||
pallet-session = { version = "2.0.0", default-features = false, path = "../session" }
|
||||
pallet-finality-tracker = { version = "2.0.0", default-features = false, path = "../finality-tracker" }
|
||||
|
||||
[dev-dependencies]
|
||||
frame-benchmarking = { version = "2.0.0", path = "../benchmarking" }
|
||||
@@ -57,6 +56,5 @@ std = [
|
||||
"frame-system/std",
|
||||
"pallet-authorship/std",
|
||||
"pallet-session/std",
|
||||
"pallet-finality-tracker/std",
|
||||
]
|
||||
runtime-benchmarks = ["frame-benchmarking"]
|
||||
@@ -44,7 +44,6 @@ use frame_support::{
|
||||
storage, traits::KeyOwnerProofSystem, weights::{Pays, Weight}, Parameter,
|
||||
};
|
||||
use frame_system::{ensure_none, ensure_root, ensure_signed};
|
||||
use pallet_finality_tracker::OnFinalizationStalled;
|
||||
use sp_runtime::{
|
||||
generic::DigestItem,
|
||||
traits::Zero,
|
||||
@@ -575,6 +574,13 @@ impl<T: Trait> Module<T> {
|
||||
)
|
||||
.ok()
|
||||
}
|
||||
|
||||
fn on_stalled(further_wait: T::BlockNumber, median: T::BlockNumber) {
|
||||
// when we record old authority sets we could try to figure out _who_
|
||||
// failed. until then, we can't meaningfully guard against
|
||||
// `next == last` the way that normal session changes do.
|
||||
<Stalled<T>>::put((further_wait, median));
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Trait> sp_runtime::BoundToRuntimeAppPublic for Module<T> {
|
||||
@@ -635,12 +641,3 @@ impl<T: Trait> pallet_session::OneSessionHandler<T::AccountId> for Module<T>
|
||||
Self::deposit_log(ConsensusLog::OnDisabled(i as u64))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Trait> OnFinalizationStalled<T::BlockNumber> for Module<T> {
|
||||
fn on_stalled(further_wait: T::BlockNumber, median: T::BlockNumber) {
|
||||
// when we record old authority sets, we can use `pallet_finality_tracker::median`
|
||||
// to figure out _who_ failed. until then, we can't meaningfully guard
|
||||
// against `next == last` the way that normal session changes do.
|
||||
<Stalled<T>>::put((further_wait, median));
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user