Struct safe_network::messaging::node::SignatureAggregator

pub struct SignatureAggregator { /* fields omitted */ }

Aggregator for signature shares for arbitrary payloads.

This aggregator allows to collect BLS signature shares for some payload one by one until enough of them are collected. At that point it combines them into a full BLS signature of the given payload. It also automatically rejects invalid signature shares and expires entries that did not collect enough signature shares within a given time.

This aggregator also handles the case when the same payload is signed with a signature share corresponding to a different BLS public key. In that case, the payloads will be aggregated separately. This avoids mixing signature shares created from different curves which would otherwise lead to invalid signature to be produced even though all the shares are valid.

Implementations

impl SignatureAggregator

pub fn new() -> Self

Create new aggregator with default expiration.

pub fn with_expiration(expiration: Duration) -> Self

Create new aggregator with the given expiration.

pub fn add(
    &mut self,
    payload: &[u8],
    sig_share: SigShare
) -> Result<KeyedSig, Error>

Add new share into the aggregator. If enough valid signature shares were collected, returns its KeyedSig (signature + public key). Otherwise returns error which details why the aggregation did not succeed yet.

Note: returned Error::NotEnoughShares does not indicate a failure. It simply means more shares still need to be added for that particular payload. This error could be safely ignored (it might still be useful perhaps for debugging). The other error variants, however, indicate failures and should be treated a such. See [Error] for more info.

Trait Implementations

impl Default for SignatureAggregator

fn default() -> Self

Returns the “default value” for a type.