Skip to main content

Interface: SimpleSignatureLike

A basic signature

This enumeration defines the set of simple or basic signature schemes supported by IOTA. Most signature schemes supported by IOTA end up comprising of a at least one simple signature scheme.

BCS

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

simple-signature = bytes ; where the contents of the bytes are defined by
; <simple-signature-body>
simple-signature-body = (ed25519-flag ed25519-signature ed25519-public-key) /
(secp256k1-flag secp256k1-signature secp256k1-public-key) /
(secp256r1-flag secp256r1-signature secp256r1-public-key)

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​

ed25519PubKey()​

ed25519PubKey(): Ed25519PublicKeyLike;

Returns​

Ed25519PublicKeyLike

ed25519PubKeyOpt()​

ed25519PubKeyOpt(): Ed25519PublicKeyLike | undefined;

Returns​

Ed25519PublicKeyLike | undefined

ed25519Sig()​

ed25519Sig(): Ed25519SignatureLike;

Returns​

Ed25519SignatureLike

ed25519SigOpt()​

ed25519SigOpt(): Ed25519SignatureLike | undefined;

Returns​

Ed25519SignatureLike | undefined

isEd25519()​

isEd25519(): boolean;

Returns​

boolean

isSecp256k1()​

isSecp256k1(): boolean;

Returns​

boolean

isSecp256r1()​

isSecp256r1(): boolean;

Returns​

boolean

scheme()​

scheme(): SignatureScheme;

Returns​

SignatureScheme

secp256k1PubKey()​

secp256k1PubKey(): Secp256k1PublicKeyLike;

Returns​

Secp256k1PublicKeyLike

secp256k1PubKeyOpt()​

secp256k1PubKeyOpt(): 
  | Secp256k1PublicKeyLike
  | undefined;

Returns​

| Secp256k1PublicKeyLike | undefined

secp256k1Sig()​

secp256k1Sig(): Secp256k1SignatureLike;

Returns​

Secp256k1SignatureLike

secp256k1SigOpt()​

secp256k1SigOpt(): 
  | Secp256k1SignatureLike
  | undefined;

Returns​

| Secp256k1SignatureLike | undefined

secp256r1PubKey()​

secp256r1PubKey(): Secp256r1PublicKeyLike;

Returns​

Secp256r1PublicKeyLike

secp256r1PubKeyOpt()​

secp256r1PubKeyOpt(): 
  | Secp256r1PublicKeyLike
  | undefined;

Returns​

| Secp256r1PublicKeyLike | undefined

secp256r1Sig()​

secp256r1Sig(): Secp256r1SignatureLike;

Returns​

Secp256r1SignatureLike

secp256r1SigOpt()​

secp256r1SigOpt(): 
  | Secp256r1SignatureLike
  | undefined;

Returns​

| Secp256r1SignatureLike | undefined

signatureBytes()​

signatureBytes(): ArrayBuffer;

The raw signature bytes, without the scheme flag or the public key.

Returns​

ArrayBuffer

toBase64()​

toBase64(): string;

Base64-encode this signature as its flag || sig || pubkey bytes.

Returns​

string

toBytes()​

toBytes(): ArrayBuffer;

Returns​

ArrayBuffer

toPublicKey()​

toPublicKey(): PublicKeyLike;

The public key embedded in this signature.

Returns​

PublicKeyLike