mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-13 23:15:49 +00:00
Bastian Köcher
010e63116f
* Add simple benchmark for the runtime api * Make the executor support native calls * Some documentation * Hide behind `feature = "std"` * Rework the native calls * Make all tests compile again * Make every parameter using the Block serialized/deserialized in the native call * Forward `UnwindSafe` requirement * Remove debug stuff * Add some documentation * Fixes warnings * Fixes errors after master rebase * Fixes compilation after master rebase * Fixes compilation after rebase
99 lines
3.7 KiB
Rust
99 lines
3.7 KiB
Rust
// Copyright 2018 Parity Technologies (UK) Ltd.
|
|
// This file is part of Substrate.
|
|
|
|
// Substrate is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Substrate is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Primitives for GRANDPA integration, suitable for WASM compilation.
|
|
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
#![cfg_attr(not(feature = "std"), feature(alloc))]
|
|
|
|
#[cfg(not(feature = "std"))]
|
|
extern crate alloc;
|
|
|
|
extern crate substrate_primitives;
|
|
extern crate sr_primitives;
|
|
extern crate parity_codec;
|
|
|
|
#[macro_use]
|
|
extern crate parity_codec_derive;
|
|
|
|
#[macro_use]
|
|
extern crate substrate_client as client;
|
|
|
|
extern crate sr_std as rstd;
|
|
|
|
use substrate_primitives::Ed25519AuthorityId;
|
|
use sr_primitives::traits::{DigestFor, NumberFor};
|
|
use rstd::vec::Vec;
|
|
|
|
/// A scheduled change of authority set.
|
|
#[cfg_attr(feature = "std", derive(Debug, PartialEq))]
|
|
#[derive(Clone, Encode, Decode)]
|
|
pub struct ScheduledChange<N> {
|
|
/// The new authorities after the change, along with their respective weights.
|
|
pub next_authorities: Vec<(Ed25519AuthorityId, u64)>,
|
|
/// The number of blocks to delay.
|
|
pub delay: N,
|
|
}
|
|
|
|
/// WASM function call to check for pending changes.
|
|
pub const PENDING_CHANGE_CALL: &str = "grandpa_pending_change";
|
|
/// WASM function call to get current GRANDPA authorities.
|
|
pub const AUTHORITIES_CALL: &str = "grandpa_authorities";
|
|
|
|
/// Well-known storage keys for GRANDPA.
|
|
pub mod well_known_keys {
|
|
/// The key for the authorities and weights vector in storage.
|
|
pub const AUTHORITY_PREFIX: &[u8] = b":grandpa:auth:";
|
|
/// The key for the authorities count.
|
|
pub const AUTHORITY_COUNT: &[u8] = b":grandpa:auth:len";
|
|
}
|
|
|
|
decl_runtime_apis! {
|
|
/// APIs for integrating the GRANDPA finality gadget into runtimes.
|
|
/// This should be implemented on the runtime side.
|
|
///
|
|
/// This is primarily used for negotiating authority-set changes for the
|
|
/// gadget. GRANDPA uses a signalling model of changing authority sets:
|
|
/// changes should be signalled with a delay of N blocks, and then automatically
|
|
/// applied in the runtime after those N blocks have passed.
|
|
///
|
|
/// The consensus protocol will coordinate the handoff externally.
|
|
pub trait GrandpaApi {
|
|
/// Check a digest for pending changes.
|
|
/// Return `None` if there are no pending changes.
|
|
///
|
|
/// Precedence towards earlier or later digest items can be given
|
|
/// based on the rules of the chain.
|
|
///
|
|
/// No change should be scheduled if one is already and the delay has not
|
|
/// passed completely.
|
|
///
|
|
/// This should be a pure function: i.e. as long as the runtime can interpret
|
|
/// the digest type it should return the same result regardless of the current
|
|
/// state.
|
|
fn grandpa_pending_change(digest: &DigestFor<Block>)
|
|
-> Option<ScheduledChange<NumberFor<Block>>>;
|
|
|
|
/// Get the current GRANDPA authorities and weights. This should not change except
|
|
/// for when changes are scheduled and the corresponding delay has passed.
|
|
///
|
|
/// When called at block B, it will return the set of authorities that should be
|
|
/// used to finalize descendants of this block (B+1, B+2, ...). The block B itself
|
|
/// is finalized by the authorities from block B-1.
|
|
fn grandpa_authorities() -> Vec<(Ed25519AuthorityId, u64)>;
|
|
}
|
|
}
|