Struct Initializer

pub struct Initializer {
    pub stake: Stake,
    pub params: Parameters,
    /* private fields */
}

Initializer for Signer. This is the data that is used during the key registration procedure. Once the latter is finished, this instance is consumed into an Signer.

Fields

stake: Stake

This participant’s stake.

params: Parameters

Current protocol instantiation parameters.

Implementations

impl Initializer

pub fn new<R: RngCore + CryptoRng>( params: Parameters, stake: Stake, rng: &mut R, ) -> Self

Builds an Initializer that is ready to register with the key registration service. This function generates the signing and verification key with a PoP, and initialises the structure.

pub fn setup<R: RngCore + CryptoRng>( params: Parameters, stake: Stake, rng: &mut R, ) -> Self

👎Deprecated since 0.5.0: Use new instead

Builds an Initializer that is ready to register with the key registration service. This function generates the signing and verification key with a PoP, and initialises the structure.

pub fn get_verification_key_proof_of_possession( &self, ) -> VerificationKeyProofOfPossession

Extract the verification key with proof of possession.

pub fn verification_key(&self) -> VerificationKeyProofOfPossession

👎Deprecated since 0.5.0: Use get_verification_key_proof_of_possession instead

Extract the verification key.

pub fn create_signer<D: Digest + Clone + FixedOutput>( self, closed_reg: ClosedKeyRegistration<D>, ) -> Result<Signer<D>, RegisterError>

Build the avk for the given list of parties.

Note that if this Initializer was modified between the last call to register, then the resulting Signer may not be able to produce valid signatures.

Returns an Signer specialized to

• this Signer’s ID and current stake
• this Signer’s parameter valuation
• the avk as built from the current registered parties (according to the registration service)
• the current total stake (according to the registration service)

Error

This function fails if the initializer is not registered.

pub fn new_signer<D: Digest + Clone + FixedOutput>( self, closed_reg: ClosedKeyRegistration<D>, ) -> Result<Signer<D>, RegisterError>

👎Deprecated since 0.5.0: Use create_signer instead

Build the avk for the given list of parties.

Note that if this Initializer was modified between the last call to register, then the resulting Signer may not be able to produce valid signatures.

Returns an Signer specialized to

• this Signer’s ID and current stake
• this Signer’s parameter valuation
• the avk as built from the current registered parties (according to the registration service)
• the current total stake (according to the registration service)

Error

This function fails if the initializer is not registered.

pub fn create_basic_signer<D: Digest + Clone + FixedOutput>( self, eligible_parties: &[MerkleTreeLeaf], ) -> Option<Signer<D>>

Creates a new basic signer that does not include closed registration. Takes eligible_parties as a parameter and determines the signer’s index in the parties. eligible_parties is verified and trusted which is only run by a full-node that has already verified the parties.

pub fn new_core_signer<D: Digest + Clone + FixedOutput>( self, eligible_parties: &[MerkleTreeLeaf], ) -> Option<Signer<D>>

👎Deprecated since 0.5.0: Use create_basic_signer instead

Creates a new basic signer that does not include closed registration. Takes eligible_parties as a parameter and determines the signer’s index in the parties. eligible_parties is verified and trusted which is only run by a full-node that has already verified the parties.

pub fn to_bytes(&self) -> [u8; 256]

Convert to bytes

Layout

• Stake (u64)
• Params
• Secret Key
• Public key (including PoP)

pub fn from_bytes(bytes: &[u8]) -> Result<Initializer, RegisterError>

Convert a slice of bytes to an Initializer

Error

The function fails if the given string of bytes is not of required size.

Trait Implementations

impl Clone for Initializer

fn clone(&self) -> Initializer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Initializer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Initializer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Initializer

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Initializer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.