Struct diem_types::validator_verifier::ValidatorVerifier

pub struct ValidatorVerifier { /* private fields */ }

Supports validation of signatures for known authors with individual voting powers. This struct can be used for all signature verification operations including block and network signature verification, respectively.

Implementations

impl ValidatorVerifier

pub fn new( address_to_validator_info: BTreeMap<AccountAddress, ValidatorConsensusInfo> ) -> Self

Initialize with a map of account address to validator info and set quorum size to default (2f + 1) or zero if address_to_validator_info is empty.

pub fn new_with_quorum_voting_power( address_to_validator_info: BTreeMap<AccountAddress, ValidatorConsensusInfo>, quorum_voting_power: u64 ) -> Result<Self>

Initializes a validator verifier with a specified quorum voting power.

pub fn new_for_testing( address_to_validator_info: BTreeMap<AccountAddress, ValidatorConsensusInfo>, quorum_voting_power: u64, total_voting_power: u64 ) -> Self

Initializes a validator verifier with a specified quorum voting power and total power.

pub fn new_single(author: AccountAddress, public_key: Ed25519PublicKey) -> Self

Helper method to initialize with a single author and public key with quorum voting power 1.

pub fn verify<T: Serialize + CryptoHash>( &self, author: AccountAddress, message: &T, signature: &Ed25519Signature ) -> Result<(), VerifyError>

Verify the correctness of a signature of a message by a known author.

pub fn verify_aggregated_struct_signature<T: CryptoHash + Serialize>( &self, message: &T, aggregated_signature: &BTreeMap<AccountAddress, Ed25519Signature> ) -> Result<(), VerifyError>

This function will successfully return when at least quorum_size signatures of known authors are successfully verified. Also, an aggregated signature is considered invalid if any of the attached signatures is invalid or it does not correspond to a known author. The latter is to prevent malicious users from adding arbitrary content to the signature payload that would go unnoticed.

pub fn batch_verify_aggregated_signatures<T: CryptoHash + Serialize>( &self, message: &T, aggregated_signature: &BTreeMap<AccountAddress, Ed25519Signature> ) -> Result<(), VerifyError>

This function will try batch signature verification and falls back to normal iterated verification if batching fails.

pub fn check_voting_power<'a>( &self, authors: impl Iterator<Item = &'a AccountAddress> ) -> Result<(), VerifyError>

Ensure there is at least quorum_voting_power in the provided signatures and there are only known authors. According to the threshold verification policy, invalid public keys are not allowed.

pub fn get_public_key(&self, author: &AccountAddress) -> Option<Ed25519PublicKey>

Returns the public key for this address.

pub fn get_voting_power(&self, author: &AccountAddress) -> Option<u64>

Returns the voting power for this address.

pub fn get_ordered_account_addresses_iter( &self ) -> impl Iterator<Item = AccountAddress> + '_

Returns an ordered list of account addresses as an Iterator.

pub fn len(&self) -> usize

Returns the number of authors to be validated.

pub fn is_empty(&self) -> bool

Is there at least one author?

pub fn quorum_voting_power(&self) -> u64

Returns quorum voting power.

Trait Implementations

impl Arbitrary for ValidatorVerifier

type Parameters = (<BTreeMap<AccountAddress, ValidatorConsensusInfo, Global> as Arbitrary>::Parameters, <u64 as Arbitrary>::Parameters, <u64 as Arbitrary>::Parameters)

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<(<BTreeMap<AccountAddress, ValidatorConsensusInfo, Global> as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (BTreeMap<AccountAddress, ValidatorConsensusInfo, Global>, u64, u64)) -> ValidatorVerifier>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for ValidatorVerifier

fn clone(&self) -> ValidatorVerifier

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ValidatorVerifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValidatorVerifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ValidatorVerifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&ValidatorSet> for ValidatorVerifier

fn from(validator_set: &ValidatorSet) -> Self

Converts to this type from the input type.

impl From<&ValidatorVerifier> for ValidatorSet

fn from(verifier: &ValidatorVerifier) -> Self

Converts to this type from the input type.

impl PartialEq<ValidatorVerifier> for ValidatorVerifier

fn eq(&self, other: &ValidatorVerifier) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ValidatorVerifier

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ValidatorVerifier

impl StructuralEq for ValidatorVerifier

impl StructuralPartialEq for ValidatorVerifier