Skip to content
docs

SignOptions

Defined in: signer.ts:59

Per-call options for Signer.sign.

Properties

Section titled “Properties”

aux?

Section titled “aux?”

optional aux?: Uint8Array<ArrayBufferLike>

Defined in: signer.ts:65

BIP-340 auxiliary randomness (32 bytes) — deterministic tests only; omit for fresh randomness.

context?

Section titled “context?”

optional context?: string

Defined in: signer.ts:63

What is being signed (see the table above). Informational for local signers.

scheme?

Section titled “scheme?”

optional scheme?: SignScheme

Defined in: signer.ts:61

Defaults to defaultScheme for the signer’s curve.

tweak?

Section titled “tweak?”

optional tweak?: Uint8Array<ArrayBufferLike>

Defined in: signer.ts:73

BIP-341 key tweak (32 bytes), schnorr only: the signer signs with (even(priv) + tweak) mod n, i.e. for the tweaked output key — taproot key-path spends (BIP-86: tweak = taggedHash('TapTweak', xonlyPub)). A hardware/MPC signer that tweaks internally may ignore it, but it must still produce a signature valid under the tweaked key.