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 Sui blockchain. The number of required signautres 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 new(members: Vec<MultisigMember>, threshold: u16) -> Self

Construct a new committee from a list of MultisigMembers and a threshold.

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) -> u16

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 is_valid(&self) -> bool

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 larger than the threshold
• contains no duplicate members

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 flag, public keys and its weight.

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

When flag_i is ZkLogin, the pk_i for the ZkLoginPublicIdentifier refers to the same input used when deriving the address using the ZkLoginPublicIdentifier::derive_address_padded method (using the full 32-byte address_seed value).

Trait Implementations

impl Arbitrary for MultisigCommittee

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 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 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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MultisigCommittee

fn eq(&self, other: &MultisigCommittee) -> 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 MultisigCommittee

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 MultisigCommittee

impl StructuralPartialEq for MultisigCommittee