Struct MultisigAggregatedSignature

pub struct MultisigAggregatedSignature { /* private fields */ }

Aggregated signature from members of a multisig committee.

BCS

The BCS serialized form for this type is defined by the following ABNF:

multisig-aggregated-signature = (vector multisig-member-signature)
                                u16     ; bitmap
                                multisig-committee

There is also a legacy encoding for this type defined as:

legacy-multisig-aggregated-signature = (vector multisig-member-signature)
                                       roaring-bitmap   ; bitmap
                                       legacy-multisig-committee
roaring-bitmap = bytes  ; where the contents of the bytes are valid
                        ; according to the serialized spec for
                        ; roaring bitmaps

See here for the specification for the serialized format of RoaringBitmaps.

Implementations

impl MultisigAggregatedSignature

pub fn new( committee: MultisigCommittee, signatures: Vec<MultisigMemberSignature>, bitmap: u16, ) -> Self

Construct a new aggregated multisig signature.

Since the list of signatures doesn’t contain sufficient information to identify which committee member provided the signature, it is up to the caller to ensure that the provided signature list is in the same order as it’s corresponding member in the provided committee and that it’s position in the provided bitmap is set.

pub fn signatures(&self) -> &[MultisigMemberSignature]

The list of signatures from committee members

pub fn bitmap(&self) -> u16

The bitmap that indicates which committee members provided their signature.

pub fn legacy_bitmap(&self) -> Option<&RoaringBitmap>

The legacy roaring bitmap, if this is a legacy formatted signature

pub fn with_legacy_bitmap(&mut self, legacy_bitmap: RoaringBitmap)

Configure with a legacy roaring bitmap

pub fn committee(&self) -> &MultisigCommittee

The committee for this aggregated signature

Trait Implementations

impl Arbitrary for MultisigAggregatedSignature

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<MultisigAggregatedSignature>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: <Self as Arbitrary>::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MultisigAggregatedSignature

fn clone(&self) -> MultisigAggregatedSignature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultisigAggregatedSignature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultisigAggregatedSignature

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MultisigAggregatedSignature

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MultisigAggregatedSignature

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MultisigAggregatedSignature