Struct Tss

pub struct Tss<P> {
    pub(crate) peer_id: P,
    pub(crate) frost_id: Identifier,
    pub(crate) frost_to_peer: BTreeMap<Identifier, P>,
    pub(crate) threshold: u16,
    pub(crate) coordinators: BTreeSet<Identifier>,
    pub(crate) state: TssState,
    pub(crate) committed: bool,
}

Tss state machine.

Fields

peer_id: P

frost_id: Identifier

frost_to_peer: BTreeMap<Identifier, P>

threshold: u16

coordinators: BTreeSet<Identifier>

state: TssState

committed: bool

Implementations

impl<P> Tss<P>

where P: Clone + Ord + Display + ToFrostIdentifier,

pub fn new( peer_id: P, members: BTreeSet<P>, threshold: u16, recover: Option<(SigningShare, VerifiableSecretSharingCommitment)>, span: &Span, ) -> Self

Initializes a new TSS instance with the given parameters.

Flow:

1. Validates that the peer_id is part of the members.
2. Converts the peer_id to a FROST identifier.
3. Maps each member to their FROST identifier.
4. Selects coordinators from the members.
5. Determines if the current instance is a coordinator.
6. If recover is provided, initializes the state with a Roast session; otherwise, initializes with a Dkg session.
7. Returns the new TSS instance.

pub fn peer_id(&self) -> &P

Returns the peer ID of the TSS instance.

pub(crate) fn frost_to_peer(&self, frost: &Identifier) -> P

Converts a FROST identifier to the corresponding peer ID.

Flow:

1. Looks up the FROST identifier in the frost_to_peer map.
2. Returns the corresponding peer ID.

pub fn total_nodes(&self) -> usize

Returns the total number of nodes involved in the TSS process.

pub fn threshold(&self) -> usize

Returns the threshold value for the TSS process.

pub fn committed(&self) -> bool

Checks if the TSS instance has committed.

pub fn on_message(&mut self, peer_id: P, msg: TssMessage, span: &Span)

Handles incoming messages and updates the state accordingly.

Flow:

1. Logs the receipt of the message.
2. Validates that the message is not from the peer itself.
3. Converts the sender to a FROST identifier and validates it.
4. Processes the message based on the current state (DKG or ROAST).
5. Returns the result of the processing.

pub fn on_commit( &mut self, commitment: VerifiableSecretSharingCommitment, span: &Span, )

Handles commit actions and updates the state accordingly.

Flow

1. Logs the commit action.
2. If in the DKG state, processes the commit and sets committed to true.
3. Logs an error if not in the DKG state.

pub(crate) fn get_or_insert_session(&mut self, id: u64) -> Option<&mut Roast>

Retrieves or inserts a signing session.

Flow:

1. If in the ROAST state, retrieves or inserts a signing session for the given ID.
2. Returns the session or None if not in the ROAST state.

pub fn on_start(&mut self, id: u64, span: &Span)

Starts a signing session for the given ID.

Flow:

1. Logs the start action.
2. Inserts a new session if it does not already exist.
3. Logs an error if not ready to sign.

pub fn on_sign(&mut self, id: u64, data: Vec<u8>, span: &Span)

Signs data for the given session ID.

Flow:

1. Logs the sign action.
2. Sets the data for the session if it exists.
3. Logs an error if not ready to sign.

pub fn on_complete(&mut self, id: u64, span: &Span)

Purpose: Completes a signing session for the given ID.

Flow:

1. Logs the complete action.
2. Removes the session if it exists.
3. Logs an error if not ready to sign.

pub fn next_action(&mut self, span: &Span) -> Option<TssAction<P>>

Retrieves the next action to be performed by the TSS state machine. This could be a message to send, a commitment to make, or a signature to produce. Flow:

1. If in the DKG state, returns the next DKG action.
2. If in the ROAST state, returns the next ROAST action.
3. Returns None if no action is available.