Struct MultiSig

pub struct MultiSig { /* private fields */ }

The struct that contains signatures and public keys necessary for authenticating a MultiSig.

Implementations

impl MultiSig

pub fn insecure_new( sigs: Vec<CompressedSignature>, bitmap: BitmapUnit, multisig_pk: MultiSigPublicKey, ) -> Self

Create MultiSig from its fields without validation

pub fn combine( full_sigs: Vec<GenericSignature>, multisig_pk: MultiSigPublicKey, ) -> Result<Self, SuiError>

This combines a list of [enum Signature] flag || signature || pk to a MultiSig. The order of full_sigs must be the same as the order of public keys in [enum MultiSigPublicKey]. e.g. for [pk1, pk2, pk3, pk4, pk5], [sig1, sig2, sig5] is valid, but [sig2, sig1, sig5] is invalid.

pub fn init_and_validate(&mut self) -> Result<Self, FastCryptoError>

pub fn get_pk(&self) -> &MultiSigPublicKey

pub fn get_sigs(&self) -> &[CompressedSignature]

pub fn get_bitmap(&self) -> u16

pub fn get_zklogin_sigs(&self) -> Result<Vec<ZkLoginAuthenticator>, SuiError>

pub fn get_indices(&self) -> Result<Vec<u8>, SuiError>

pub fn has_passkey_sigs(&self) -> bool

Trait Implementations

impl AsRef<[u8]> for MultiSig

This initialize the underlying bytes representation of MultiSig. It encodes [struct MultiSig] as the MultiSig flag (0x03) concat with the bcs bytes of [struct MultiSig] i.e. flag || bcs_bytes(MultiSig).

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AuthenticatorTrait for MultiSig

fn verify_user_authenticator_epoch( &self, epoch_id: EpochId, max_epoch_upper_bound_delta: Option<u64>, ) -> Result<(), SuiError>

fn verify_claims<T>( &self, value: &IntentMessage<T>, multisig_address: SuiAddress, verify_params: &VerifyParams, zklogin_inputs_cache: Arc<VerifiedDigestCache<ZKLoginInputsDigest>>, ) -> Result<(), SuiError>

where T: Serialize,

impl Clone for MultiSig

fn clone(&self) -> MultiSig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiSig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultiSig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&MultiSig> for MultisigAggregatedSignature

fn from(value: &MultiSig) -> Self

Converts to this type from the input type.

impl From<MultiSig> for GenericSignature

fn from(v: MultiSig) -> GenericSignature

Converts to this type from the input type.

impl FromStr for MultiSig

type Err = SuiError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MultiSig

Necessary trait for [struct SenderSignedData].

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 JsonSchema for MultiSig

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MultiSig

Necessary trait for [struct SenderSignedData].

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 MultiSig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToFromBytes for MultiSig

fn from_bytes(bytes: &[u8]) -> Result<MultiSig, FastCryptoError>

Parse an object from its byte representation

fn as_bytes(&self) -> &[u8]

Borrow a byte slice representing the serialized form of this object

impl TryFrom<MultiSigLegacy> for MultiSig

type Error = FastCryptoError

The type returned in the event of a conversion error.

fn try_from(multisig: MultiSigLegacy) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<MultiSig> for GenericSignature

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<MultiSig, <Self as TryInto<MultiSig>>::Error>

Performs the conversion.

impl Eq for MultiSig

Necessary trait for [struct SenderSignedData].