Skip to main content

Interface: UserSignatureLike

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

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.

Methods​

asMoveAuthenticator()​

asMoveAuthenticator(): MoveAuthenticatorLike;

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

Returns​

MoveAuthenticatorLike

asMultisig()​

asMultisig(): MultisigAggregatedSignatureLike;

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

Returns​

MultisigAggregatedSignatureLike

asOptMoveAuthenticator()​

asOptMoveAuthenticator(): 
  | MoveAuthenticatorLike
  | undefined;

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

Returns​

| MoveAuthenticatorLike | undefined

asOptMultisig()​

asOptMultisig(): 
  | MultisigAggregatedSignatureLike
  | undefined;

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

Returns​

| MultisigAggregatedSignatureLike | undefined

asOptPasskeyAuthenticator()​

asOptPasskeyAuthenticator(): 
  | PasskeyAuthenticatorLike
  | undefined;

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

Returns​

| PasskeyAuthenticatorLike | undefined

asOptSimple()​

asOptSimple(): SimpleSignatureLike | undefined;

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

Returns​

SimpleSignatureLike | undefined

asPasskeyAuthenticator()​

asPasskeyAuthenticator(): PasskeyAuthenticatorLike;

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

Returns​

PasskeyAuthenticatorLike

asSimple()​

asSimple(): SimpleSignatureLike;

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

Returns​

SimpleSignatureLike

isMoveAuthenticator()​

isMoveAuthenticator(): boolean;

Check if this signature is a move authenticator

Returns​

boolean

isMultisig()​

isMultisig(): boolean;

Check if this signature is a multisig aggregated signature

Returns​

boolean

isPasskeyAuthenticator()​

isPasskeyAuthenticator(): boolean;

Check if this signature is a passkey authenticator

Returns​

boolean

isSimple()​

isSimple(): boolean;

Check if this signature is a simple signature

Returns​

boolean

scheme()​

scheme(): SignatureScheme;

Return the flag for this signature scheme

Returns​

SignatureScheme

toBase64()​

toBase64(): string;

Returns​

string

toBytes()​

toBytes(): ArrayBuffer;

Returns​

ArrayBuffer