Enum UserSignature 

#[non_exhaustive]
pub enum UserSignature {
    Simple(SimpleSignature),
    Multisig(MultisigAggregatedSignature),
    PasskeyAuthenticator(PasskeyAuthenticator),
    MoveAuthenticator(MoveAuthenticator),
}

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 / passkey / move-authenticator

Note: Due to historical reasons, signatures are serialized slightly different from the majority of the types in IOTA. 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)

PasskeyAuthenticator(PasskeyAuthenticator)

MoveAuthenticator(MoveAuthenticator)

Implementations

impl UserSignature

pub fn derive_address(&self) -> Address

Derive the Address of the signer that this signature authenticates.

impl UserSignature

pub fn is_simple(&self) -> bool

Checks if this is a simple variant.

pub fn as_simple(&self) -> &SimpleSignature

Converts this into a simple if it is a simple variant, or panics otherwise.

pub fn as_mut_simple(&mut self) -> &mut SimpleSignature

Converts this into a mut simple if it is a simple variant, or panics otherwise.

pub fn as_opt_simple(&self) -> Option<&SimpleSignature>

Converts this into a simple if it is a simple variant, or returns None otherwise.

pub fn as_opt_mut_simple(&mut self) -> Option<&mut SimpleSignature>

Converts this into a mut simple if it is a simple variant, or returns None otherwise.

pub fn into_opt_simple(self) -> Option<SimpleSignature>

Converts this into a simple if it is a simple variant, or returns None otherwise.

pub fn into_simple(self) -> SimpleSignature

Converts this into a simple if it is a simple variant, or panics otherwise.

pub fn is_multisig(&self) -> bool

Checks if this is a multisig variant.

pub fn as_multisig(&self) -> &MultisigAggregatedSignature

Converts this into a multisig if it is a multisig variant, or panics otherwise.

pub fn as_mut_multisig(&mut self) -> &mut MultisigAggregatedSignature

Converts this into a mut multisig if it is a multisig variant, or panics otherwise.

pub fn as_opt_multisig(&self) -> Option<&MultisigAggregatedSignature>

Converts this into a multisig if it is a multisig variant, or returns None otherwise.

pub fn as_opt_mut_multisig( &mut self, ) -> Option<&mut MultisigAggregatedSignature>

Converts this into a mut multisig if it is a multisig variant, or returns None otherwise.

pub fn into_opt_multisig(self) -> Option<MultisigAggregatedSignature>

Converts this into a multisig if it is a multisig variant, or returns None otherwise.

pub fn into_multisig(self) -> MultisigAggregatedSignature

Converts this into a multisig if it is a multisig variant, or panics otherwise.

pub fn is_passkey_authenticator(&self) -> bool

Checks if this is a passkey_authenticator variant.

pub fn as_passkey_authenticator(&self) -> &PasskeyAuthenticator

Converts this into a passkey_authenticator if it is a passkey_authenticator variant, or panics otherwise.

pub fn as_mut_passkey_authenticator(&mut self) -> &mut PasskeyAuthenticator

Converts this into a mut passkey_authenticator if it is a passkey_authenticator variant, or panics otherwise.

pub fn as_opt_passkey_authenticator(&self) -> Option<&PasskeyAuthenticator>

Converts this into a passkey_authenticator if it is a passkey_authenticator variant, or returns None otherwise.

pub fn as_opt_mut_passkey_authenticator( &mut self, ) -> Option<&mut PasskeyAuthenticator>

Converts this into a mut passkey_authenticator if it is a passkey_authenticator variant, or returns None otherwise.

pub fn into_opt_passkey_authenticator(self) -> Option<PasskeyAuthenticator>

Converts this into a passkey_authenticator if it is a passkey_authenticator variant, or returns None otherwise.

pub fn into_passkey_authenticator(self) -> PasskeyAuthenticator

Converts this into a passkey_authenticator if it is a passkey_authenticator variant, or panics otherwise.

pub fn is_move_authenticator(&self) -> bool

Checks if this is a move_authenticator variant.

pub fn as_move_authenticator(&self) -> &MoveAuthenticator

Converts this into a move_authenticator if it is a move_authenticator variant, or panics otherwise.

pub fn as_mut_move_authenticator(&mut self) -> &mut MoveAuthenticator

Converts this into a mut move_authenticator if it is a move_authenticator variant, or panics otherwise.

pub fn as_opt_move_authenticator(&self) -> Option<&MoveAuthenticator>

Converts this into a move_authenticator if it is a move_authenticator variant, or returns None otherwise.

pub fn as_opt_mut_move_authenticator( &mut self, ) -> Option<&mut MoveAuthenticator>

Converts this into a mut move_authenticator if it is a move_authenticator variant, or returns None otherwise.

pub fn into_opt_move_authenticator(self) -> Option<MoveAuthenticator>

Converts this into a move_authenticator if it is a move_authenticator variant, or returns None otherwise.

pub fn into_move_authenticator(self) -> MoveAuthenticator

Converts this into a move_authenticator if it is a move_authenticator variant, or panics otherwise.

pub fn scheme(&self) -> SignatureScheme

Return the flag for this signature scheme

pub fn to_public_key(&self) -> Result<PublicKey, InvalidSignatureScheme>

Return the public key for this signature, if the scheme supports it.

impl UserSignature

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

pub fn to_base64(&self) -> String

pub fn from_bytes( bytes: impl AsRef<[u8]>, ) -> Result<UserSignature, SignatureFromBytesError>

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

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_shared: <UserSignature as Arbitrary>::Parameters, ) -> <UserSignature as Arbitrary>::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 AuthenticatorTrait for UserSignature

fn verify_claims<T>( &self, value: &IntentMessage<T>, author: Address, aux_verify_data: &VerifyParams, ) -> IotaResult

where T: Serialize,

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D, ) -> Result<UserSignature, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MoveAuthenticator> for UserSignature

fn from(value: MoveAuthenticator) -> UserSignature

Converts to this type from the input type.

impl From<MultisigAggregatedSignature> for UserSignature

fn from(value: MultisigAggregatedSignature) -> UserSignature

Converts to this type from the input type.

impl From<PasskeyAuthenticator> for UserSignature

fn from(value: PasskeyAuthenticator) -> UserSignature

Converts to this type from the input type.

impl From<SimpleSignature> for UserSignature

fn from(value: SimpleSignature) -> UserSignature

Converts to this type from the input type.

impl FromStr for UserSignature

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<UserSignature, <UserSignature as FromStr>::Err>

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

impl Hash for UserSignature

Available on crate feature serde only.

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

where H: Hasher,

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<UserSignature> for MultisigMemberSignature

type Error = MultisigError

The type returned in the event of a conversion error.

fn try_from( signature: UserSignature, ) -> Result<MultisigMemberSignature, <MultisigMemberSignature as TryFrom<UserSignature>>::Error>

Performs the conversion.

impl Eq for UserSignature

impl StructuralPartialEq for UserSignature