Class: UserSignature
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.
Extends
UniffiAbstractObject
Implements
Properties
[destructorGuardSymbol]
readonly [destructorGuardSymbol]: UniffiGcObject;
[pointerLiteralSymbol]
readonly [pointerLiteralSymbol]: bigint;
[uniffiTypeNameSymbol]
readonly [uniffiTypeNameSymbol]: "UserSignature" = "UserSignature";
Methods
asMoveAuthenticator()
asMoveAuthenticator(): MoveAuthenticatorLike;
Convert this signature into a move authenticator if it is one, or panic otherwise
Returns
Implementation of
UserSignatureLike.asMoveAuthenticator
asMultisig()
asMultisig(): MultisigAggregatedSignatureLike;
Convert this signature into a multisig aggregated signature if it is one, or panic otherwise
Returns
MultisigAggregatedSignatureLike
Implementation of
asOptMoveAuthenticator()
asOptMoveAuthenticator():
| MoveAuthenticatorLike
| undefined;
Convert this signature into a move authenticator if it is one, or return
None otherwise
Returns
| MoveAuthenticatorLike
| undefined
Implementation of
UserSignatureLike.asOptMoveAuthenticator
asOptMultisig()
asOptMultisig():
| MultisigAggregatedSignatureLike
| undefined;
Convert this signature into a multisig aggregated signature if it is
one, or return None otherwise
Returns
| MultisigAggregatedSignatureLike
| undefined
Implementation of
UserSignatureLike.asOptMultisig
asOptPasskeyAuthenticator()
asOptPasskeyAuthenticator():
| PasskeyAuthenticatorLike
| undefined;
Convert this signature into a passkey authenticator if it is one, or
return None otherwise
Returns
| PasskeyAuthenticatorLike
| undefined
Implementation of
UserSignatureLike.asOptPasskeyAuthenticator
asOptSimple()
asOptSimple(): SimpleSignatureLike | undefined;
Convert this signature into a simple signature if it is one, or return
None otherwise
Returns
SimpleSignatureLike | undefined
Implementation of
asPasskeyAuthenticator()
asPasskeyAuthenticator(): PasskeyAuthenticatorLike;
Convert this signature into a passkey authenticator if it is one, or panic otherwise
Returns
Implementation of
UserSignatureLike.asPasskeyAuthenticator
asSimple()
asSimple(): SimpleSignatureLike;
Convert this signature into a simple signature if it is one, or panic otherwise
Returns
Implementation of
equals()
equals(other): boolean;
Parameters
other
UserSignature
Returns
boolean
isMoveAuthenticator()
isMoveAuthenticator(): boolean;
Check if this signature is a move authenticator
Returns
boolean
Implementation of
UserSignatureLike.isMoveAuthenticator
isMultisig()
isMultisig(): boolean;
Check if this signature is a multisig aggregated signature
Returns
boolean
Implementation of
isPasskeyAuthenticator()
isPasskeyAuthenticator(): boolean;
Check if this signature is a passkey authenticator
Returns
boolean
Implementation of
UserSignatureLike.isPasskeyAuthenticator
isSimple()
isSimple(): boolean;
Check if this signature is a simple signature
Returns
boolean
Implementation of
scheme()
scheme(): SignatureScheme;
Return the flag for this signature scheme
Returns
Implementation of
toBase64()
toBase64(): string;
Returns
string
Implementation of
toBytes()
toBytes(): ArrayBuffer;
Returns
ArrayBuffer
Implementation of
toDebugString()
toDebugString(): string;
Returns
string
toString()
toString(): string;
Returns a string representation of an object.
Returns
string
uniffiDestroy()
uniffiDestroy(): void;
Explicitly tell Rust to destroy the native peer that backs this object.
Once this method has been called, any following method calls will throw an error.
Can be called more than once.
Returns
void
Overrides
UniffiAbstractObject.uniffiDestroy
uniffiUse()
uniffiUse<T>(block): T;
A convenience method to use this object, then destroy it after its use.
Type Parameters
T
T
Parameters
block
(obj) => T
Returns
T
Inherited from
UniffiAbstractObject.uniffiUse
fromBase64()
static fromBase64(base64): UserSignatureLike;
Parameters
base64
string
Returns
fromBytes()
static fromBytes(bytes): UserSignatureLike;
Parameters
bytes
ArrayBuffer
Returns
instanceOf()
static instanceOf(obj_): obj_ is UserSignature;
Parameters
obj_
any
Returns
obj_ is UserSignature
newMoveAuthenticator()
static newMoveAuthenticator(authenticator): UserSignatureLike;
Parameters
authenticator
Returns
newMultisig()
static newMultisig(signature): UserSignatureLike;
Parameters
signature
MultisigAggregatedSignatureLike
Returns
newPasskeyAuthenticator()
static newPasskeyAuthenticator(authenticator): UserSignatureLike;
Parameters
authenticator
Returns
newSimple()
static newSimple(signature): UserSignatureLike;