Struct ThresholdSign 

pub struct ThresholdSign<N> { /* private fields */ }

A threshold signing algorithm instance. On input, broadcasts our threshold signature share. Upon receiving at least num_faulty + 1 shares, attempts to combine them into a signature. If that signature is valid, the instance outputs it and terminates; otherwise the instance aborts.

Implementations

impl<N: NodeIdT> ThresholdSign<N>

pub fn new(netinfo: Arc<NetworkInfo<N>>) -> Self

Creates a new instance of ThresholdSign, with the goal to collaboratively sign doc.

pub fn new_with_document<M: AsRef<[u8]>>( netinfo: Arc<NetworkInfo<N>>, doc: M, ) -> Result<Self>

Creates a new instance of ThresholdSign, including setting the document to sign.

pub fn set_document<M: AsRef<[u8]>>(&mut self, doc: M) -> Result<()>

Sets doc_hash. Signature shares can only be sent after this function is completed.

pub fn sign(&mut self) -> Result<Step<N>>

Sends our signature shares, and if we have collected enough, returns the full signature. Returns an error if the message to sign hasn’t been received yet.

pub fn handle_message( &mut self, sender_id: &N, message: Message, ) -> Result<Step<N>>

Handles a message with a signature share received from sender_id.

This must be called with every message we receive from another node.

If we have collected enough, returns the full signature.

pub fn netinfo(&self) -> &Arc<NetworkInfo<N>>

Returns the information about the node IDs in the network, and the cryptographic keys.

Trait Implementations

impl<N: NodeIdT> ConsensusProtocol for ThresholdSign<N>

fn handle_input<R: Rng>(&mut self, _input: (), _rng: &mut R) -> Result<Step<N>>

Sends our threshold signature share if not yet sent.

fn handle_message<R: Rng>( &mut self, sender_id: &Self::NodeId, message: Message, _rng: &mut R, ) -> Result<Step<N>>

Receives input from a remote node.

fn terminated(&self) -> bool

Whether the algorithm has terminated.

type NodeId = N

Unique node identifier.

type Input = ()

The input provided by the user.

type Output = Signature

The output type. Some algorithms return an output exactly once, others return multiple times.

type Message = Message

The messages that need to be exchanged between the instances in the participating nodes.

type Error = Error

The errors that can occur during execution.

type FaultKind = FaultKind

The kinds of message faults that can be detected during execution.

fn our_id(&self) -> &Self::NodeId

Returns this node’s own ID.

impl<N: Debug> Debug for ThresholdSign<N>

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

Formats the value using the given formatter.

impl<N: NodeIdT> Display for ThresholdSign<N>

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

Formats the value using the given formatter.