Enum UserSignature

#[non_exhaustive]
pub enum UserSignature {
    Simple(SimpleSignature),
    Multisig(MultisigAggregatedSignature),
    ZkLogin(Box<ZkLoginAuthenticator>),
    Passkey(PasskeyAuthenticator),
}

A signature from a user

A UserSignature is most commonly used to authorize the execution and inclusion of a transaction to the blockchain.

BCS

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

user-signature-bcs = bytes ; where the contents of the bytes are defined by <user-signature>
user-signature = simple-signature / multisig / multisig-legacy / zklogin / passkey

Note: Due to historical reasons, signatures are serialized slightly different from the majority of the types in Sui. In particular if a signature is ever embedded in another structure it generally is serialized as bytes meaning it has a length prefix that defines the length of the completely serialized signature.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Simple(SimpleSignature)

Multisig(MultisigAggregatedSignature)

ZkLogin(Box<ZkLoginAuthenticator>)

Passkey(PasskeyAuthenticator)

Implementations

impl UserSignature

pub fn to_bytes(&self) -> Vec<u8>

Available on crate feature serde only.

pub fn to_base64(&self) -> String

Available on crate feature serde only.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Available on crate feature serde only.

pub fn from_base64(s: &str) -> Result<Self, Error>

Available on crate feature serde only.

impl UserSignature

pub fn scheme(&self) -> SignatureScheme

Return the flag for this signature scheme

impl UserSignature

pub fn derive_address(&self) -> Address

Available on crate feature hash only.

pub fn derive_addresses(&self) -> impl ExactSizeIterator<Item = Address>

Available on crate feature hash only.

Trait Implementations

impl Arbitrary for UserSignature

type Parameters = ()

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

type Strategy = BoxedStrategy<UserSignature>

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 UserSignature

fn clone(&self) -> UserSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserSignature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserSignature

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 UserSignature

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

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 UserSignature

impl StructuralPartialEq for UserSignature