pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-29 04:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simplify BABE pre-digest definitions (#5289)

Browse Source 
* Init vrf crate without type alias

* Generic PreDigest definition for BABE

* Fix BABE vrf interface change

* Missing default-features def in sp-consensus-babe

* Fix sp-consensus-babe compile

* frame-babe: fix type inference

* Unify type definitions of vrf output/proof and randomness

* frame-babe: fix tests

* Bump node impl version

* Update cargo lock

* Derive Copy for RawVRFOutput and RawVRFProof

* Fix duplicated derive

Co-authored-by: Gavin Wood <gavin@parity.io>
This commit is contained in:
Wei Tang
2020-03-23 11:53:41 +01:00
committed by GitHub
parent 95d1d668c3
commit 9c7261fab3
17 changed files with 392 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/primitives/consensus/babe/src/digests.rs
+46 -151
View File
@@ -18,92 +18,35 @@
#[cfg(feature = "std")]
use super::{BABE_ENGINE_ID, AuthoritySignature};
#[cfg(not(feature = "std"))]
use super::{VRF_OUTPUT_LENGTH, VRF_PROOF_LENGTH};
use super::{AuthorityId, AuthorityIndex, SlotNumber, BabeAuthorityWeight};
#[cfg(feature = "std")]
use sp_runtime::{DigestItem, generic::OpaqueDigestItemId};
#[cfg(feature = "std")]
use std::fmt::Debug;
use std::{fmt::Debug, convert::{TryFrom, TryInto}};
use codec::{Decode, Encode};
#[cfg(feature = "std")]
use codec::{Codec, Input, Error};
#[cfg(feature = "std")]
use schnorrkel::{
SignatureError, errors::MultiSignatureStage,
vrf::{VRFProof, VRFOutput, VRF_OUTPUT_LENGTH, VRF_PROOF_LENGTH}
};
use codec::Codec;
use sp_std::vec::Vec;
use sp_consensus_vrf::schnorrkel::{self, Randomness};
#[cfg(feature = "std")]
use sp_consensus_vrf::schnorrkel::SignatureError;
/// A BABE pre-runtime digest. This contains all data required to validate a
/// block and for the BABE runtime module. Slots can be assigned to a primary
/// (VRF based) and to a secondary (slot number based).
#[cfg(feature = "std")]
#[derive(Clone, Debug)]
pub enum PreDigest {
/// A primary VRF-based slot assignment.
Primary {
/// VRF output
vrf_output: VRFOutput,
/// VRF proof
vrf_proof: VRFProof,
/// Authority index
authority_index: super::AuthorityIndex,
/// Slot number
slot_number: SlotNumber,
},
/// A secondary deterministic slot assignment.
Secondary {
/// Authority index
authority_index: super::AuthorityIndex,
/// Slot number
slot_number: SlotNumber,
},
}
#[cfg(feature = "std")]
impl PreDigest {
/// Returns the slot number of the pre digest.
pub fn authority_index(&self) -> AuthorityIndex {
match self {
PreDigest::Primary { authority_index, .. } => *authority_index,
PreDigest::Secondary { authority_index, .. } => *authority_index,
}
}
/// Returns the slot number of the pre digest.
pub fn slot_number(&self) -> SlotNumber {
match self {
PreDigest::Primary { slot_number, .. } => *slot_number,
PreDigest::Secondary { slot_number, .. } => *slot_number,
}
}
/// Returns the weight _added_ by this digest, not the cumulative weight
/// of the chain.
pub fn added_weight(&self) -> crate::BabeBlockWeight {
match self {
PreDigest::Primary { .. } => 1,
PreDigest::Secondary { .. } => 0,
}
}
}
/// A raw version of `BabePreDigest`, usable on `no_std`.
#[derive(Copy, Clone, Encode, Decode)]
pub enum RawPreDigest {
#[derive(Clone, Debug, Encode, Decode)]
pub enum RawPreDigest<VRFOutput=schnorrkel::RawVRFOutput, VRFProof=schnorrkel::RawVRFProof> {
/// A primary VRF-based slot assignment.
#[codec(index = "1")]
Primary {
/// Authority index
authority_index: AuthorityIndex,
authority_index: super::AuthorityIndex,
/// Slot number
slot_number: SlotNumber,
/// VRF output
vrf_output: [u8; VRF_OUTPUT_LENGTH],
vrf_output: VRFOutput,
/// VRF proof
vrf_proof: [u8; VRF_PROOF_LENGTH],
vrf_proof: VRFProof,
},
/// A secondary deterministic slot assignment.
#[codec(index = "2")]
@@ -114,13 +57,25 @@ pub enum RawPreDigest {
/// are assigned based on slot number and epoch randomness. But including
/// it makes things easier for higher-level users of the chain data to
/// be aware of the author of a secondary-slot block.
authority_index: AuthorityIndex,
authority_index: super::AuthorityIndex,
/// Slot number
slot_number: SlotNumber,
},
}
impl RawPreDigest {
#[cfg(feature = "std")]
/// A BABE pre-runtime digest for std.
pub type PreDigest = RawPreDigest<schnorrkel::VRFOutput, schnorrkel::VRFProof>;
impl<VRFOutput, VRFProof> RawPreDigest<VRFOutput, VRFProof> {
/// Returns the slot number of the pre digest.
pub fn authority_index(&self) -> AuthorityIndex {
match self {
RawPreDigest::Primary { authority_index, .. } => *authority_index,
RawPreDigest::Secondary { authority_index, .. } => *authority_index,
}
}
/// Returns the slot number of the pre digest.
pub fn slot_number(&self) -> SlotNumber {
match self {
@@ -128,65 +83,36 @@ impl RawPreDigest {
RawPreDigest::Secondary { slot_number, .. } => *slot_number,
}
}
}
#[cfg(feature = "std")]
impl Encode for PreDigest {
fn encode(&self) -> Vec<u8> {
let raw = match self {
PreDigest::Primary {
vrf_output,
vrf_proof,
authority_index,
slot_number,
} => {
RawPreDigest::Primary {
vrf_output: *vrf_output.as_bytes(),
vrf_proof: vrf_proof.to_bytes(),
authority_index: *authority_index,
slot_number: *slot_number,
}
},
PreDigest::Secondary {
authority_index,
slot_number,
} => {
RawPreDigest::Secondary {
authority_index: *authority_index,
slot_number: *slot_number,
}
},
};
codec::Encode::encode(&raw)
/// Returns the weight _added_ by this digest, not the cumulative weight
/// of the chain.
pub fn added_weight(&self) -> crate::BabeBlockWeight {
match self {
RawPreDigest::Primary { .. } => 1,
RawPreDigest::Secondary { .. } => 0,
}
}
}
#[cfg(feature = "std")]
impl codec::EncodeLike for PreDigest {}
impl TryFrom<RawPreDigest> for PreDigest {
type Error = SignatureError;
#[cfg(feature = "std")]
impl Decode for PreDigest {
fn decode<R: Input>(i: &mut R) -> Result<Self, Error> {
let pre_digest = match Decode::decode(i)? {
RawPreDigest::Primary { vrf_output, vrf_proof, authority_index, slot_number } => {
// Verify (at compile time) that the sizes in babe_primitives are correct
let _: [u8; super::VRF_OUTPUT_LENGTH] = vrf_output;
let _: [u8; super::VRF_PROOF_LENGTH] = vrf_proof;
PreDigest::Primary {
vrf_proof: VRFProof::from_bytes(&vrf_proof).map_err(convert_error)?,
vrf_output: VRFOutput::from_bytes(&vrf_output).map_err(convert_error)?,
fn try_from(raw: RawPreDigest) -> Result<PreDigest, SignatureError> {
Ok(match raw {
RawPreDigest::Primary { authority_index, slot_number, vrf_output, vrf_proof } =>
RawPreDigest::Primary {
authority_index,
slot_number,
vrf_output: vrf_output.try_into()?,
vrf_proof: vrf_proof.try_into()?,
},
RawPreDigest::Secondary { authority_index, slot_number } =>
RawPreDigest::Secondary {
authority_index,
slot_number,
}
},
RawPreDigest::Secondary { authority_index, slot_number } => {
PreDigest::Secondary { authority_index, slot_number }
},
};
Ok(pre_digest)
})
}
}
@@ -198,7 +124,7 @@ pub struct NextEpochDescriptor {
pub authorities: Vec<(AuthorityId, BabeAuthorityWeight)>,
/// The value of randomness to use for the slot-assignment.
pub randomness: [u8; VRF_OUTPUT_LENGTH],
pub randomness: Randomness,
}
/// A digest item which is usable with BABE consensus.
@@ -248,34 +174,3 @@ impl<Hash> CompatibleDigestItem for DigestItem<Hash> where
})
}
}
#[cfg(feature = "std")]
fn convert_error(e: SignatureError) -> codec::Error {
use SignatureError::*;
use MultiSignatureStage::*;
match e {
EquationFalse => "Signature error: `EquationFalse`".into(),
PointDecompressionError => "Signature error: `PointDecompressionError`".into(),
ScalarFormatError => "Signature error: `ScalarFormatError`".into(),
NotMarkedSchnorrkel => "Signature error: `NotMarkedSchnorrkel`".into(),
BytesLengthError { .. } => "Signature error: `BytesLengthError`".into(),
MuSigAbsent { musig_stage: Commitment } =>
"Signature error: `MuSigAbsent` at stage `Commitment`".into(),
MuSigAbsent { musig_stage: Reveal } =>
"Signature error: `MuSigAbsent` at stage `Reveal`".into(),
MuSigAbsent { musig_stage: Cosignature } =>
"Signature error: `MuSigAbsent` at stage `Commitment`".into(),
MuSigInconsistent { musig_stage: Commitment, duplicate: true } =>
"Signature error: `MuSigInconsistent` at stage `Commitment` on duplicate".into(),
MuSigInconsistent { musig_stage: Commitment, duplicate: false } =>
"Signature error: `MuSigInconsistent` at stage `Commitment` on not duplicate".into(),
MuSigInconsistent { musig_stage: Reveal, duplicate: true } =>
"Signature error: `MuSigInconsistent` at stage `Reveal` on duplicate".into(),
MuSigInconsistent { musig_stage: Reveal, duplicate: false } =>
"Signature error: `MuSigInconsistent` at stage `Reveal` on not duplicate".into(),
MuSigInconsistent { musig_stage: Cosignature, duplicate: true } =>
"Signature error: `MuSigInconsistent` at stage `Cosignature` on duplicate".into(),
MuSigInconsistent { musig_stage: Cosignature, duplicate: false } =>
"Signature error: `MuSigInconsistent` at stage `Cosignature` on not duplicate".into(),
}
}
substrate/primitives/consensus/babe/src/lib.rs
+5 -7
View File
@@ -22,6 +22,10 @@
pub mod digests;
pub mod inherents;
pub use sp_consensus_vrf::schnorrkel::{
Randomness, VRF_PROOF_LENGTH, VRF_OUTPUT_LENGTH, RANDOMNESS_LENGTH
};
use codec::{Encode, Decode};
use sp_std::vec::Vec;
use sp_runtime::{ConsensusEngineId, RuntimeDebug};
@@ -50,12 +54,6 @@ pub type AuthorityId = app::Public;
/// The `ConsensusEngineId` of BABE.
pub const BABE_ENGINE_ID: ConsensusEngineId = *b"BABE";
/// The length of the VRF output
pub const VRF_OUTPUT_LENGTH: usize = 32;
/// The length of the VRF proof
pub const VRF_PROOF_LENGTH: usize = 64;
/// The length of the public key
pub const PUBLIC_KEY_LENGTH: usize = 32;
@@ -115,7 +113,7 @@ pub struct BabeConfiguration {
pub genesis_authorities: Vec<(AuthorityId, BabeAuthorityWeight)>,
/// The randomness for the genesis epoch.
pub randomness: [u8; VRF_OUTPUT_LENGTH],
pub randomness: Randomness,
/// Whether this chain should run with secondary slots, which are assigned
/// in round-robin manner.