Larger Test Keyring Support (#842)

* Allow creation of authority lists with any number of authorities

* Move keyring helpers into their own module

* Add helper for generating list of test accounts

* Fix import names in tests

* Rename Keyring trait to Signer

* Get list of accounts in a more functional way

* Clarify meaning of `test_keyring` return type

* Use concrete test account type instead of generics

* Make sure voter set contains all authorities which signed off on pre-commits
This commit is contained in:
Hernando Castano
2021-03-24 16:14:15 -04:00
committed by Bastian Köcher
parent a17c7eb80c
commit 78a9cdca66
7 changed files with 154 additions and 95 deletions
+11 -67
View File
@@ -19,15 +19,17 @@
#![cfg_attr(not(feature = "std"), no_std)]
use bp_header_chain::justification::GrandpaJustification;
use ed25519_dalek::{Keypair, PublicKey, SecretKey, Signature, Signer};
use finality_grandpa::voter_set::VoterSet;
use sp_application_crypto::{Public, TryFrom};
use sp_finality_grandpa::{AuthorityId, AuthorityList, AuthorityWeight};
use sp_application_crypto::TryFrom;
use sp_finality_grandpa::{AuthorityId, AuthorityWeight};
use sp_finality_grandpa::{AuthoritySignature, SetId};
use sp_runtime::traits::{Header as HeaderT, One, Zero};
use sp_runtime::RuntimeDebug;
use sp_std::prelude::*;
// Re-export all our test account utilities
pub use keyring::*;
mod keyring;
pub const TEST_GRANDPA_ROUND: u64 = 1;
pub const TEST_GRANDPA_SET_ID: SetId = 1;
@@ -40,7 +42,7 @@ pub struct JustificationGeneratorParams<H> {
/// The current authority set ID.
pub set_id: SetId,
/// The current GRANDPA authority set.
pub authorities: Vec<(Keyring, AuthorityWeight)>,
pub authorities: Vec<(Account, AuthorityWeight)>,
/// The number of headers included in our justification's vote ancestries.
pub depth: u32,
/// The number of forks, and thus the number of pre-commits in our justification.
@@ -53,7 +55,7 @@ impl<H: HeaderT> Default for JustificationGeneratorParams<H> {
header: test_header(One::one()),
round: TEST_GRANDPA_ROUND,
set_id: TEST_GRANDPA_SET_ID,
authorities: keyring(),
authorities: test_keyring(),
depth: 2,
forks: 1,
}
@@ -157,7 +159,7 @@ fn generate_chain<H: HeaderT>(fork_id: u8, depth: u32, ancestor: &H) -> Vec<H> {
}
fn signed_precommit<H: HeaderT>(
signer: &Keyring,
signer: &Account,
target: (H::Hash, H::Number),
round: u64,
set_id: SetId,
@@ -170,7 +172,7 @@ fn signed_precommit<H: HeaderT>(
let encoded =
sp_finality_grandpa::localized_payload(round, set_id, &finality_grandpa::Message::Precommit(precommit.clone()));
let signature = signer.pair().sign(&encoded);
let signature = signer.sign(&encoded);
let raw_signature: Vec<u8> = signature.to_bytes().into();
// Need to wrap our signature and id types that they match what our `SignedPrecommit` is expecting
@@ -211,61 +213,3 @@ pub fn test_header<H: HeaderT>(number: H::Number) -> H {
pub fn header_id<H: HeaderT>(index: u8) -> (H::Hash, H::Number) {
(test_header::<H>(index.into()).hash(), index.into())
}
/// Set of test accounts.
#[derive(RuntimeDebug, Clone, Copy)]
pub enum Keyring {
Alice,
Bob,
Charlie,
Dave,
Eve,
Ferdie,
}
impl Keyring {
pub fn public(&self) -> PublicKey {
(&self.secret()).into()
}
pub fn secret(&self) -> SecretKey {
SecretKey::from_bytes(&[*self as u8; 32]).expect("A static array of the correct length is a known good.")
}
pub fn pair(self) -> Keypair {
let mut pair: [u8; 64] = [0; 64];
let secret = self.secret();
pair[..32].copy_from_slice(&secret.to_bytes());
let public = self.public();
pair[32..].copy_from_slice(&public.to_bytes());
Keypair::from_bytes(&pair).expect("We expect the SecretKey to be good, so this must also be good.")
}
pub fn sign(self, msg: &[u8]) -> Signature {
self.pair().sign(msg)
}
}
impl From<Keyring> for AuthorityId {
fn from(k: Keyring) -> Self {
AuthorityId::from_slice(&k.public().to_bytes())
}
}
/// Get a valid set of voters for a Grandpa round.
pub fn voter_set() -> VoterSet<AuthorityId> {
VoterSet::new(authority_list()).unwrap()
}
/// Convenience function to get a list of Grandpa authorities.
pub fn authority_list() -> AuthorityList {
keyring().iter().map(|(id, w)| (AuthorityId::from(*id), *w)).collect()
}
/// Get the corresponding identities from the keyring for the "standard" authority set.
pub fn keyring() -> Vec<(Keyring, u64)> {
vec![(Keyring::Alice, 1), (Keyring::Bob, 1), (Keyring::Charlie, 1)]
}