Class: SignatureProof

@nimiq/core / SignatureProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2109

A signature proof represents a signature together with its public key and the public key's merkle path. It is used as the proof for transactions.

Properties

merklePath

readonly merklePath: MerklePath

Defined in: @nimiq/core/types/wasm/web.d.ts:2154

The embedded merkle path.

publicKey

readonly publicKey: PublicKey | ES256PublicKey

Defined in: @nimiq/core/types/wasm/web.d.ts:2158

The embedded public key.

signature

readonly signature: ES256Signature | Signature

Defined in: @nimiq/core/types/wasm/web.d.ts:2162

The embedded signature.

ES256_SINGLE_SIG_SIZE

readonly static ES256_SINGLE_SIG_SIZE: number

Defined in: @nimiq/core/types/wasm/web.d.ts:2150

SINGLE_SIG_SIZE

readonly static SINGLE_SIG_SIZE: number

Defined in: @nimiq/core/types/wasm/web.d.ts:2163

Methods

[dispose]()

[dispose](): void

Defined in: @nimiq/core/types/wasm/web.d.ts:2112

Returns

void

free()

free(): void

Defined in: @nimiq/core/types/wasm/web.d.ts:2111

Returns

void

isSignedBy()

isSignedBy(sender): boolean

Defined in: @nimiq/core/types/wasm/web.d.ts:2120

Checks if the signature proof is signed by the provided address.

Parameters

sender

Address

Returns

boolean

serialize()

serialize(): Uint8Array

Defined in: @nimiq/core/types/wasm/web.d.ts:2129

Serializes the proof to a byte array, e.g. for assigning it to a transaction.proof field.

Returns

Uint8Array

toPlain()

toPlain(): PlainTransactionProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2137

Creates a JSON-compatible plain object representing the signature proof.

Returns

PlainTransactionProof

verify()

verify(data): boolean

Defined in: @nimiq/core/types/wasm/web.d.ts:2141

Verifies the signature proof against the provided data.

Parameters

data

Uint8Array

Returns

boolean

deserialize()

static deserialize(bytes): SignatureProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2116

Deserializes a signature proof from a byte array.

Parameters

bytes

Uint8Array

Returns

SignatureProof

multiSig()

static multiSig(signer_key, public_keys, signature): SignatureProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2125

Creates a Ed25519/Schnorr signature proof for a multi-sig signature. The public keys can also include ES256 keys.

Parameters

signer_key

PublicKey

public_keys

(PublicKey | ES256PublicKey)

signature

Signature

Returns

SignatureProof

singleSig()

static singleSig(public_key, signature): SignatureProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2133

Creates a Ed25519/Schnorr signature proof for a single-sig signature.

Parameters

public_key

PublicKey

signature

Signature

Returns

SignatureProof

webauthnMultiSig()

static webauthnMultiSig(signer_key, public_keys, signature, authenticator_data, client_data_json): SignatureProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2145

Creates a Webauthn signature proof for a multi-sig signature.

Parameters

signer_key

PublicKey | ES256PublicKey

public_keys

(PublicKey | ES256PublicKey)

signature

ES256Signature | Signature

authenticator_data

Uint8Array

client_data_json

Uint8Array

Returns

SignatureProof

webauthnSingleSig()

static webauthnSingleSig(public_key, signature, authenticator_data, client_data_json): SignatureProof

Defined in: @nimiq/core/types/wasm/web.d.ts:2149

Creates a Webauthn signature proof for a single-sig signature.

Parameters

public_key

PublicKey | ES256PublicKey

signature

ES256Signature | Signature

authenticator_data

Uint8Array

client_data_json

Uint8Array

Returns

SignatureProof