Struct MultisigCommittee 

pub struct MultisigCommittee { /* private fields */ }

A multisig committee

A MultisigCommittee is a set of members who collectively control a single Address on the IOTA blockchain. The number of required signatures to authorize the execution of a transaction is determined by (signature_0_weight + signature_1_weight ..) >= threshold.

BCS

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

multisig-committee = (vector multisig-member)
                     u16    ; threshold

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

legacy-multisig-committee = (vector legacy-multisig-member)
                            u16     ; threshold

Implementations

impl MultisigCommittee

pub fn derive_address(&self) -> Address

Available on crate feature hash only.

Derive an Address from this MultisigCommittee.

A MultiSig address is defined as the 32-byte Blake2b hash of serializing the SignatureScheme flag (0x03), the threshold (in little endian), and the concatenation of all n flags, public keys and their weights, where flag_i? is the member’s SignatureScheme flag — omitted for Ed25519 keys, matching their plain address derivation.

hash(0x03 || threshold || flag_1? || pk_1 || weight_1 || ... || flag_n? || pk_n || weight_n).

impl MultisigCommittee

pub fn new_unchecked( members: Vec<MultisigMember>, threshold: ThresholdUnit, ) -> Self

Construct a MultisigCommittee without validating the result.

Unlike Self::new, this performs no checks: the committee may violate any of the invariants enforced by Self::validate (zero threshold, empty or oversized member list, zero-weight members, duplicate public keys, or a threshold exceeding the sum of weights).

Note that the order of the members is significant towards deriving the Address governed by this committee.

Prefer Self::new; this constructor is intended for deserialization paths and tests where the inputs are already known to be well-formed.

pub fn new( members: Vec<MultisigMember>, threshold: ThresholdUnit, ) -> Result<Self, MultisigError>

Construct a MultisigCommittee and verify it via Self::validate.

Compared to Self::new_unchecked, this rejects committees that:

• have a zero threshold;
• contain zero or more than ten members;
• contain a member with weight 0;
• have a threshold greater than the sum of all member weights;
• contain duplicate public keys.

Note that the order of the members is significant towards deriving the Address governed by this committee.

pub fn members(&self) -> &[MultisigMember]

The members of the committee

pub fn threshold(&self) -> ThresholdUnit

The total signature weight required to authorize a transaction for the address corresponding to this MultisigCommittee.

pub fn scheme(&self) -> SignatureScheme

Return the flag for this signature scheme

pub fn get_public_key_index(&self, public_key: &PublicKey) -> Option<u8>

Get the index of a public key in the committee, if it is a member.

pub fn validate(&self) -> Result<(), MultisigError>

Checks if the Committee is valid.

A valid committee is one that:

• Has a nonzero threshold
• Has at least one member
• Has at most ten members
• No member has weight 0
• the sum of the weights of all members must be at least the threshold
• contains no duplicate members

Trait Implementations

impl Arbitrary for MultisigCommittee

Available on crate feature proptest only.

type Parameters = ()

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

type Strategy = BoxedStrategy<MultisigCommittee>

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

fn arbitrary_with(_args: Self::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 MultisigCommittee

fn clone(&self) -> MultisigCommittee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultisigCommittee

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultisigCommittee

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 Display for MultisigCommittee

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

Formats the value using the given formatter.

impl Eq for MultisigCommittee

impl From<&MultisigCommittee> for Address

Available on crate feature hash only.

fn from(committee: &MultisigCommittee) -> Self

Converts to this type from the input type.

impl From<MultisigCommittee> for Address

Available on crate feature hash only.

fn from(committee: MultisigCommittee) -> Self

Converts to this type from the input type.

impl Hash for MultisigCommittee

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MultisigCommittee

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MultisigCommittee

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 StructuralPartialEq for MultisigCommittee