Signer

Struct Signer 

Source
pub struct Signer<SignerType: SignerTrait> {
Show 23 fields pub dkg_id: u64, pub sign_id: u64, pub sign_iter_id: u64, pub threshold: u32, pub dkg_threshold: u32, pub total_signers: u32, pub total_keys: u32, pub signer: SignerType, pub signer_id: u32, pub state: State, pub commitments: HashMap<u32, PolyCommitment>, pub decrypted_shares: HashMap<u32, HashMap<u32, Scalar>>, pub decryption_keys: HashMap<u32, (u32, Point)>, pub invalid_private_shares: HashMap<u32, BadPrivateShare>, pub public_nonces: Vec<PublicNonce>, pub network_private_key: Scalar, pub public_keys: PublicKeys, pub dkg_public_shares: BTreeMap<u32, DkgPublicShares>, pub dkg_private_shares: BTreeMap<u32, DkgPrivateShares>, pub dkg_private_begin_msg: Option<DkgPrivateBegin>, pub dkg_end_begin_msg: Option<DkgEndBegin>, pub verify_packet_sigs: bool, pub coordinator_public_key: Option<PublicKey>, /* private fields */
}
Expand description

A state machine for a signing round

Fields§

§dkg_id: u64

current DKG round ID

§sign_id: u64

current signing round ID

§sign_iter_id: u64

current signing iteration ID

§threshold: u32

the threshold of the keys needed for a valid signature

§dkg_threshold: u32

the threshold of the keys needed for a valid DKG

§total_signers: u32

the total number of signers

§total_keys: u32

the total number of keys

§signer: SignerType

the Signer object

§signer_id: u32

the Signer ID

§state: State

the current state

§commitments: HashMap<u32, PolyCommitment>

map of polynomial commitments for each party party_id => PolyCommitment

§decrypted_shares: HashMap<u32, HashMap<u32, Scalar>>

map of decrypted DKG private shares src_party_id => (dst_key_id => private_share)

§decryption_keys: HashMap<u32, (u32, Point)>

shared secrets used to decrypt private shares src_party_id => (signer_id, dh shared key)

§invalid_private_shares: HashMap<u32, BadPrivateShare>

invalid private shares signer_id => {shared_key, tuple_proof}

§public_nonces: Vec<PublicNonce>

public nonces for this signing round

§network_private_key: Scalar

the private key used to sign messages sent over the network

§public_keys: PublicKeys

the public keys for all signers and coordinator

§dkg_public_shares: BTreeMap<u32, DkgPublicShares>

the DKG public shares received in this round

§dkg_private_shares: BTreeMap<u32, DkgPrivateShares>

the DKG private shares received in this round

§dkg_private_begin_msg: Option<DkgPrivateBegin>

the DKG private begin message received in this round

§dkg_end_begin_msg: Option<DkgEndBegin>

the DKG end begin message received in this round

§verify_packet_sigs: bool

whether to verify the signature on Packets

§coordinator_public_key: Option<PublicKey>

coordinator public key

Implementations§

Source§

impl<SignerType: SignerTrait> Signer<SignerType>

Source

pub fn new<R: RngCore + CryptoRng>( threshold: u32, dkg_threshold: u32, total_signers: u32, total_keys: u32, signer_id: u32, key_ids: Vec<u32>, network_private_key: Scalar, public_keys: PublicKeys, rng: &mut R, ) -> Result<Self, Error>

create a Signer

Source

pub fn load(state: &SavedState) -> Self

Load a coordinator from the previously saved state

Source

pub fn save(&self) -> SavedState

Save the state required to reconstruct the coordinator

Source

pub fn reset<T: RngCore + CryptoRng>(&mut self, dkg_id: u64, rng: &mut T)

Reset internal state

Source

pub fn process<R: RngCore + CryptoRng>( &mut self, packet: &Packet, rng: &mut R, ) -> Result<Vec<Message>, Error>

process the passed incoming message, and return any outgoing messages needed in response

Source

pub fn dkg_ended<R: RngCore + CryptoRng>( &mut self, rng: &mut R, ) -> Result<Message, Error>

DKG is done so compute secrets

Source

pub fn public_shares_done(&self) -> bool

do we have all DkgPublicShares?

Source

pub fn can_dkg_end(&self) -> bool

do we have all DkgPublicShares and DkgPrivateShares?

Source

pub fn dkg_end_begin( &mut self, dkg_end_begin: &DkgEndBegin, ) -> Result<Vec<Message>, Error>

handle incoming DkgEndBegin

Source

pub fn dkg_public_share( &mut self, dkg_public_shares: &DkgPublicShares, ) -> Result<Vec<Message>, Error>

handle incoming DkgPublicShares

Source

pub fn dkg_private_shares<R: RngCore + CryptoRng>( &mut self, dkg_private_shares: &DkgPrivateShares, rng: &mut R, ) -> Result<Vec<Message>, Error>

handle incoming DkgPrivateShares

Trait Implementations§

Source§

impl<SignerType: Clone + SignerTrait> Clone for Signer<SignerType>

Source§

fn clone(&self) -> Signer<SignerType>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<SignerType: SignerTrait> Debug for Signer<SignerType>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<SignerType: PartialEq + SignerTrait> PartialEq for Signer<SignerType>

Source§

fn eq(&self, other: &Signer<SignerType>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<SignerType: SignerTrait> StateMachine<State, Error> for Signer<SignerType>

Source§

fn move_to(&mut self, state: State) -> Result<(), Error>

Attempt to move the state machine to a new state
Source§

fn can_move_to(&self, state: &State) -> Result<(), Error>

Check if the state machine can move to a new state
Source§

impl<SignerType: SignerTrait> StructuralPartialEq for Signer<SignerType>

Auto Trait Implementations§

§

impl<SignerType> Freeze for Signer<SignerType>
where SignerType: Freeze,

§

impl<SignerType> RefUnwindSafe for Signer<SignerType>
where SignerType: RefUnwindSafe,

§

impl<SignerType> Send for Signer<SignerType>
where SignerType: Send,

§

impl<SignerType> Sync for Signer<SignerType>
where SignerType: Sync,

§

impl<SignerType> Unpin for Signer<SignerType>
where SignerType: Unpin,

§

impl<SignerType> UnwindSafe for Signer<SignerType>
where SignerType: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more