Struct PublicKeyPackage 

pub struct PublicKeyPackage<C: Ciphersuite> { /* private fields */ }

Public data that contains all the signers’ verifying shares as well as the group verifying key.

Used for verification purposes before publishing a signature.

Implementations

impl<C: Ciphersuite> PublicKeyPackage<C>

Auto-generated by derive_getters::Getters.

pub fn verifying_shares(&self) -> &BTreeMap<Identifier<C>, VerifyingShare<C>>

The verifying shares for all participants. Used to validate signature shares they generate.

pub fn verifying_key(&self) -> &VerifyingKey<C>

The joint public key for the entire group.

pub fn min_signers(&self) -> Option<u16>

The minimum number of signers (threshold) required for the group. This can be None in packages created with frost_core prior to 3.0.0.

impl<C> PublicKeyPackage<C>

where C: Ciphersuite,

pub fn new( verifying_shares: BTreeMap<Identifier<C>, VerifyingShare<C>>, verifying_key: VerifyingKey<C>, min_signers: Option<u16>, ) -> Self

Create a new PublicKeyPackage instance.

min_signers is an Option for compatibility with pre-3.0.0 packages. In normal usage, it should always be Some(value).

pub fn from_commitment( identifiers: &BTreeSet<Identifier<C>>, commitment: &VerifiableSecretSharingCommitment<C>, ) -> Result<PublicKeyPackage<C>, Error<C>>

Computes the public key package given a list of participant identifiers and a VerifiableSecretSharingCommitment. This is useful in scenarios where the commitments are published somewhere and it’s desirable to recreate the public key package from them.

pub fn from_dkg_commitments( commitments: &BTreeMap<Identifier<C>, &VerifiableSecretSharingCommitment<C>>, ) -> Result<PublicKeyPackage<C>, Error<C>>

Computes the public key package given a map of participant identifiers and their VerifiableSecretSharingCommitment from a distributed key generation process. This is useful in scenarios where the commitments are published somewhere and it’s desirable to recreate the public key package from them.

pub fn max_signers(&self) -> u16

Return the maximum number of signers.

impl<C> PublicKeyPackage<C>

where C: Ciphersuite,

pub fn serialize(&self) -> Result<Vec<u8>, Error<C>>

Available on crate feature serialization only.

Serialize the struct into a Vec.

pub fn deserialize(bytes: &[u8]) -> Result<Self, Error<C>>

Available on crate feature serialization only.

Deserialize the struct from a slice of bytes.

Trait Implementations

impl<C: Clone + Ciphersuite> Clone for PublicKeyPackage<C>

fn clone(&self) -> PublicKeyPackage<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Ciphersuite> Debug for PublicKeyPackage<C>

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for PublicKeyPackage<C>

where C: Ciphersuite,

Available on crate feature serde only.

Custom deserializer for PublicKeyPackage, which allows a non-existing min_signers field for the postcard encoding.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: PartialEq + Ciphersuite> PartialEq for PublicKeyPackage<C>

fn eq(&self, other: &PublicKeyPackage<C>) -> 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<C> Serialize for PublicKeyPackage<C>

where C: Ciphersuite,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: Eq + Ciphersuite> Eq for PublicKeyPackage<C>

impl<C: Ciphersuite> StructuralPartialEq for PublicKeyPackage<C>