mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-15 06:51:07 +00:00
Add basic BABE consensus type (#2165)
* Add basic BABE consensus type * Update core/consensus/babe/slots/Cargo.toml Co-Authored-By: DemiMarie-parity <48690212+DemiMarie-parity@users.noreply.github.com> * Fix parameterization and run `rustfmt` * Respond to review comments * Update various Cargo.lock files * Revert "Update various Cargo.lock files" This reverts commit af53d7624752a744320e9cbb25749fdd8e6f46d2. * `BabeSealSignature` → `BabeSeal` * Move slot code to its own crate This was highly non-trivial, due to cyclic dependencies. * Remove redundancy between AuRa and BABE Some of the code duplication was removed using a macro. * Fix build error * Avoid non-`#[doc(hidden)]` re-exports Also, bump some library versions in `Cargo.toml`. * Remove dead code in AuRa * Remove impl_slot macro It was more trouble than it was worth. Also, delete useless dependencies on Serde. * AuRa and BABE need different DB keys * Bring back `aura::Network`, but deprecate it. * Improve docs and add `slot_duration` inherent method * Add docs to `substrate_consensus_aura::SlotDuration` * Add missing documentation and #![forbid(missing_docs, unsafe_code)] * Add a #![forbid(missing_docs)] * Remove dependency of `test-runtime` on `slots` * Update core/consensus/babe/src/lib.rs Co-Authored-By: DemiMarie-parity <48690212+DemiMarie-parity@users.noreply.github.com> * Remove wrongly added file * Fix copyright notice Co-Authored-By: DemiMarie-parity <48690212+DemiMarie-parity@users.noreply.github.com> * Bump `impl_version` and `spec_version` * Fix deprecation version; remove spurious carets * Update Cargo.lock * Update dependencies
This commit is contained in:
DemiMarie-parity
committed by
Bastian Köcher
Bastian Köcher
parent
72a1c6298e
commit
ae916c6c5e
@@ -0,0 +1,40 @@
|
||||
[package]
|
||||
name = "substrate-consensus-babe"
|
||||
version = "1.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
description = "BABE consensus algorithm for substrate"
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
parity-codec = "3.4.0"
|
||||
parity-codec-derive = "3.3.0"
|
||||
babe_primitives = { package = "substrate-consensus-babe-primitives", path = "primitives" }
|
||||
primitives = { package = "substrate-primitives", path = "../../primitives" }
|
||||
runtime_support = { package = "srml-support", path = "../../../srml/support" }
|
||||
runtime_version = { package = "sr-version", path = "../../sr-version" }
|
||||
runtime_io = { package = "sr-io", path = "../../sr-io" }
|
||||
inherents = { package = "substrate-inherents", path = "../../inherents" }
|
||||
srml-consensus = { path = "../../../srml/consensus" }
|
||||
substrate-telemetry = { path = "../../telemetry" }
|
||||
client = { package = "substrate-client", path = "../../client" }
|
||||
consensus_common = { package = "substrate-consensus-common", path = "../common" }
|
||||
authorities = { package = "substrate-consensus-authorities", path = "../authorities" }
|
||||
slots = { package = "substrate-consensus-slots", path = "../slots" }
|
||||
runtime_primitives = { package = "sr-primitives", path = "../../sr-primitives" }
|
||||
futures = "0.1.26"
|
||||
tokio = "0.1.18"
|
||||
parking_lot = "0.7.1"
|
||||
error-chain = "0.12.0"
|
||||
log = "0.4.6"
|
||||
|
||||
[dependencies.schnorrkel]
|
||||
git = "https://github.com/paritytech/schnorrkel"
|
||||
branch = "master"
|
||||
|
||||
[dev-dependencies]
|
||||
keyring = { package = "substrate-keyring", path = "../../keyring" }
|
||||
substrate-executor = { path = "../../executor" }
|
||||
network = { package = "substrate-network", path = "../../network", features = ["test-helpers"]}
|
||||
service = { package = "substrate-service", path = "../../service" }
|
||||
test_client = { package = "substrate-test-client", path = "../../test-client" }
|
||||
env_logger = "0.6.1"
|
||||
@@ -0,0 +1,19 @@
|
||||
[package]
|
||||
name = "substrate-consensus-babe-primitives"
|
||||
version = "1.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
description = "Primitives for BABE consensus"
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
substrate-client = { path = "../../../client", default-features = false }
|
||||
runtime_primitives = { package = "sr-primitives", path = "../../../sr-primitives", default-features = false }
|
||||
slots = { package = "substrate-consensus-slots", path = "../../slots", optional = true }
|
||||
parity-codec = "^3.4.0"
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"substrate-client/std",
|
||||
"slots",
|
||||
]
|
||||
@@ -0,0 +1,76 @@
|
||||
// Copyright 2019 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 BABE.
|
||||
#![forbid(warnings, unsafe_code, missing_docs)]
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
use runtime_primitives::ConsensusEngineId;
|
||||
use substrate_client::decl_runtime_apis;
|
||||
|
||||
use parity_codec::{Encode, Decode};
|
||||
|
||||
/// The `ConsensusEngineId` of BABE.
|
||||
pub const BABE_ENGINE_ID: ConsensusEngineId = [b'b', b'a', b'b', b'e'];
|
||||
|
||||
/// Configuration data used by the BABE consensus engine.
|
||||
#[derive(Copy, Clone, Hash, PartialEq, Eq, Debug, Encode, Decode)]
|
||||
pub struct BabeConfiguration {
|
||||
slot_duration: u64,
|
||||
expected_block_time: u64,
|
||||
}
|
||||
|
||||
impl BabeConfiguration {
|
||||
/// Return the expected block time in milliseconds for BABE. Currently,
|
||||
/// only the value provided by this type at genesis will be used.
|
||||
///
|
||||
/// Dynamic expected block time may be supported in the future.
|
||||
pub fn expected_block_time(&self) -> u64 {
|
||||
self.expected_block_time
|
||||
}
|
||||
|
||||
/// Return the slot duration in milliseconds for BABE. Currently, only
|
||||
/// the value provided by this type at genesis will be used.
|
||||
///
|
||||
/// Dynamic slot duration may be supported in the future.
|
||||
pub fn slot_duration(&self) -> u64 {
|
||||
self.slot_duration
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "std")]
|
||||
impl slots::SlotData for BabeConfiguration {
|
||||
/// Return the slot duration in milliseconds for BABE. Currently, only
|
||||
/// the value provided by this type at genesis will be used.
|
||||
///
|
||||
/// Dynamic slot duration may be supported in the future.
|
||||
fn slot_duration(&self) -> u64 {
|
||||
self.slot_duration
|
||||
}
|
||||
|
||||
const SLOT_KEY: &'static [u8] = b"babe_bootstrap_data";
|
||||
}
|
||||
|
||||
decl_runtime_apis! {
|
||||
/// API necessary for block authorship with BABE.
|
||||
pub trait BabeApi {
|
||||
/// Return the configuration for BABE. Currently,
|
||||
/// only the value provided by this type at genesis will be used.
|
||||
///
|
||||
/// Dynamic configuration may be supported in the future.
|
||||
fn startup_data() -> BabeConfiguration;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
// Copyright 2019 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/>.
|
||||
|
||||
//! BABE (Blind Assignment for Blockchain Extension) consensus in substrate.
|
||||
#![forbid(warnings, unsafe_code, missing_docs)]
|
||||
|
||||
pub use babe_primitives::*;
|
||||
use parity_codec::{Decode, Encode, Input};
|
||||
use runtime_primitives::generic;
|
||||
use primitives::sr25519::{
|
||||
Public,
|
||||
Signature,
|
||||
LocalizedSignature,
|
||||
};
|
||||
|
||||
use schnorrkel::{
|
||||
SecretKey as Secret,
|
||||
vrf::{VRFProof, VRF_PROOF_LENGTH},
|
||||
PUBLIC_KEY_LENGTH, SIGNATURE_LENGTH,
|
||||
};
|
||||
|
||||
/// A BABE seal. It includes:
|
||||
///
|
||||
/// * The public key
|
||||
/// * The VRF proof
|
||||
/// * The signature
|
||||
/// * The slot number
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct BabeSeal {
|
||||
proof: VRFProof,
|
||||
signature: LocalizedSignature,
|
||||
slot_num: u64,
|
||||
}
|
||||
|
||||
impl Encode for BabeSeal {
|
||||
fn encode(&self) -> Vec<u8> {
|
||||
parity_codec::Encode::encode(&(
|
||||
self.proof.to_bytes(),
|
||||
self.signature.signature.0,
|
||||
self.signature.signer.0,
|
||||
self.slot_num,
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
impl Decode for BabeSeal {
|
||||
fn decode<R: Input>(i: &mut R) -> Option<Self> {
|
||||
let (public_key, proof, sig, slot_num): (
|
||||
[u8; PUBLIC_KEY_LENGTH],
|
||||
[u8; VRF_PROOF_LENGTH],
|
||||
[u8; SIGNATURE_LENGTH],
|
||||
u64,
|
||||
) = Decode::decode(i)?;
|
||||
Some(BabeSeal {
|
||||
proof: VRFProof::from_bytes(&proof).ok()?,
|
||||
signature: LocalizedSignature {
|
||||
signature: Signature(sig),
|
||||
signer: Public(public_key),
|
||||
},
|
||||
slot_num,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// A digest item which is usable with BABE consensus.
|
||||
pub trait CompatibleDigestItem: Sized {
|
||||
/// Construct a digest item which contains a slot number and a signature on the
|
||||
/// hash.
|
||||
fn babe_seal(signature: BabeSeal) -> Self;
|
||||
|
||||
/// If this item is an Babe seal, return the slot number and signature.
|
||||
fn as_babe_seal(&self) -> Option<BabeSeal>;
|
||||
}
|
||||
|
||||
impl<Hash> CompatibleDigestItem for generic::DigestItem<Hash, Public, Secret> {
|
||||
/// Construct a digest item which is aaAASSAAAAAASDC a slot number and a signature on the
|
||||
/// hash.
|
||||
fn babe_seal(signature: BabeSeal) -> Self {
|
||||
generic::DigestItem::Consensus(BABE_ENGINE_ID, signature.encode())
|
||||
}
|
||||
|
||||
/// If this item is an BABE seal, return the slot number and signature.
|
||||
fn as_babe_seal(&self) -> Option<BabeSeal> {
|
||||
match self {
|
||||
generic::DigestItem::Consensus(BABE_ENGINE_ID, seal) => Decode::decode(&mut &seal[..]),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user