Skip to main content

UserSignatureProtocol

UserSignatureProtocol Objects​

class UserSignatureProtocol(typing.Protocol)

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:

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.

user-signature = bytes ; where the contents of the bytes are defined by
; <user-signature-body>
user-signature-body = (%d00 ed25519-signature ed25519-public-key) /
(%d01 secp256k1-signature secp256k1-public-key) /
(%d02 secp256r1-signature secp256r1-public-key) /
(%d03 multisig-aggregated-signature) /
(%d06 passkey-authenticator) /
(%d07 move-authenticator)

as_move_authenticator​

def as_move_authenticator() -> MoveAuthenticator

Convert this signature into a move authenticator if it is one, or panic otherwise

as_multisig​

def as_multisig() -> MultisigAggregatedSignature

Convert this signature into a multisig aggregated signature if it is one, or panic otherwise

as_opt_move_authenticator​

def as_opt_move_authenticator() -> typing.Optional[MoveAuthenticator]

Convert this signature into a move authenticator if it is one, or return None otherwise

as_opt_multisig​

def as_opt_multisig() -> typing.Optional[MultisigAggregatedSignature]

Convert this signature into a multisig aggregated signature if it is one, or return None otherwise

as_opt_passkey_authenticator​

def as_opt_passkey_authenticator() -> typing.Optional[PasskeyAuthenticator]

Convert this signature into a passkey authenticator if it is one, or return None otherwise

as_opt_simple​

def as_opt_simple() -> typing.Optional[SimpleSignature]

Convert this signature into a simple signature if it is one, or return None otherwise

as_passkey_authenticator​

def as_passkey_authenticator() -> PasskeyAuthenticator

Convert this signature into a passkey authenticator if it is one, or panic otherwise

as_simple​

def as_simple() -> SimpleSignature

Convert this signature into a simple signature if it is one, or panic otherwise

is_move_authenticator​

def is_move_authenticator() -> bool

Check if this signature is a move authenticator

is_multisig​

def is_multisig() -> bool

Check if this signature is a multisig aggregated signature

is_passkey_authenticator​

def is_passkey_authenticator() -> bool

Check if this signature is a passkey authenticator

is_simple​

def is_simple() -> bool

Check if this signature is a simple signature

scheme​

def scheme() -> SignatureScheme

Return the flag for this signature scheme