Struct Keyshare

pub struct Keyshare { /* private fields */ }

A key share representing a party’s portion of a distributed secret key.

This struct encapsulates all the information needed for a party to participate in distributed key generation and signing protocols. It includes:

• The party’s secret share
• Public key components
• Party ranks and identifiers
• Oblivious transfer seeds
• Additional protocol-specific data

The key share is stored in a compact binary format and provides methods for accessing its components and deriving child keys.

Implementations

impl Keyshare

pub const MAGIC: [u8; 4]

Magic number identifying valid key share data.

This constant is used to validate that a byte buffer contains a valid key share.

impl Keyshare

pub fn new(n: u8, t: u8, id: u8, extra: &[u8]) -> Keyshare

Creates a new key share with the specified parameters.

Arguments

• n - Total number of parties in the protocol
• t - Threshold value for the protocol
• id - ID of this party
• extra - Additional data to be embedded in the key share

Panics

Panics if n is less than 2.

pub fn from_bytes(buffer: &[u8]) -> Option<Self>

Creates a key share from a byte slice.

Arguments

• buffer - Byte slice containing the key share data

Returns

Some(Keyshare) if the buffer contains valid key share data, None otherwise.

pub fn from_vec(buffer: Vec<u8>) -> Result<Self, Vec<u8>>

Creates a key share from a vector of bytes.

Arguments

• buffer - Vector containing the key share data

Returns

Ok(Keyshare) if the vector contains valid key share data, Err(buffer) otherwise.

pub fn as_slice(&self) -> &[u8]

Returns the underlying byte slice of the key share.

pub fn public_key(&self) -> ProjectivePoint

Returns the public key as a ProjectivePoint.

pub fn rank_list(&self) -> Vec<u8>

Returns a vector of ranks for all parties.

pub fn x_i_list(&self) -> Vec<NonZeroScalar>

Returns a vector of x-coordinates for all parties.

pub fn zero_ranks(&self) -> bool

Returns true if all parties have rank zero.

pub fn get_rank(&self, party_id: u8) -> u8

Returns the rank of a specific party.

Arguments

• party_id - ID of the party

pub fn s_i(&self) -> Scalar

Returns the secret scalar s_i for this party.

pub fn extra_data(&self) -> &[u8]

Returns the user-defined data embedded in the key share.

This data is passed via the setup message during key generation and is immutable.

pub fn big_s(&self, party_id: u8) -> ProjectivePoint

Returns the public key component for a specific party.

Arguments

• party_id - ID of the party

impl Keyshare

pub fn root_chain_code(&self) -> [u8; 32]

Returns the root chain code.

pub fn root_public_key(&self) -> ProjectivePoint

Returns the root public key.

impl Keyshare

pub fn get_finger_print(&self) -> KeyFingerPrint

Returns the key fingerprint.

pub fn derive_with_offset( &self, chain_path: &DerivationPath, ) -> Result<(Scalar, ProjectivePoint), BIP32Error>

Derives a child key with the given chain path and offset.

Arguments

• chain_path - The derivation path to use

Returns

A tuple containing the derived scalar and public key, or an error if derivation fails.

pub fn derive_child_pubkey( &self, chain_path: &DerivationPath, ) -> Result<ProjectivePoint, BIP32Error>

Derives a child public key with the given chain path.

Arguments

• chain_path - The derivation path to use

Returns

The derived public key, or an error if derivation fails.

pub fn derive_xpub( &self, prefix: Prefix, chain_path: DerivationPath, ) -> Result<XPubKey, BIP32Error>

Derives an extended public key with the given prefix and chain path.

Arguments

• prefix - The prefix to use for the extended public key
• chain_path - The derivation path to use

Returns

The derived extended public key, or an error if derivation fails.

Trait Implementations

impl Clone for Keyshare

fn clone(&self) -> Keyshare

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Keyshare

type Target = KeyshareInfo

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for Keyshare

fn drop(&mut self)

Executes the destructor for this type.