Interface UniversalSigner

Full-featured signer interface exposing every operation that ECPairSigner supports.

interface UniversalSigner {
    capabilities: number;
    compressed: boolean;
    network: Network;
    privateKey?: PrivateKey;
    publicKey: PublicKey;
    xOnlyPublicKey: XOnlyPublicKey;
    hasCapability(cap: number): boolean;
    sign(hash: MessageHash, lowR?: boolean): Signature;
    signSchnorr?(hash: MessageHash): SchnorrSignature;
    toWIF(): string;
    tweak(t: Bytes32): UniversalSigner;
    verify(hash: MessageHash, signature: Signature): boolean;
    verifySchnorr(hash: MessageHash, signature: SchnorrSignature): boolean;
}

Hierarchy (View Summary)

Signer
- UniversalSigner

Implemented by

ECPairSigner

Index

Properties

capabilities compressed network privateKey? publicKey xOnlyPublicKey

Methods

hasCapability sign signSchnorr? toWIF tweak verify verifySchnorr

Properties

`Readonly`capabilities

capabilities: number

Bitmask of SignerCapability flags.

`Readonly`compressed

compressed: boolean

Whether the public key is in compressed SEC1 form.

`Readonly`network

network: Network

Network this signer is bound to.

`Optional` `Readonly`privateKey

privateKey?: PrivateKey

Raw private key bytes, or undefined for public-key-only signers.

`Readonly`publicKey

publicKey: PublicKey

SEC1-encoded public key (33 or 65 bytes).

`Readonly`xOnlyPublicKey

xOnlyPublicKey: XOnlyPublicKey

32-byte BIP-340 x-only public key.

Methods

hasCapability

hasCapability(cap: number): boolean
Tests whether the signer has a specific capability.
Parameters
- cap: number
  SignerCapability flag to test.
Returns boolean
- Defined in signer.ts:132

sign

sign(hash: MessageHash, lowR?: boolean): Signature
Produces a compact ECDSA signature over hash.
Parameters
- hash: MessageHash
  32-byte message digest.
- OptionallowR: boolean
  When true, grinds for a low-R value (smaller DER encoding).
Returns Signature
Inherited from Signer.sign
- Defined in signer.ts:39

`Optional`signSchnorr

signSchnorr?(hash: MessageHash): SchnorrSignature
Produces a BIP-340 Schnorr signature over hash.
Parameters
- hash: MessageHash
  32-byte message digest.
Returns SchnorrSignature
Inherited from Signer.signSchnorr
- Defined in signer.ts:44

toWIF

toWIF(): string
Exports the private key as a WIF string.

Returns string
Throws
If this is a public-key-only signer.
- Defined in signer.ts:154

tweak

tweak(t: Bytes32): UniversalSigner
Derives a new signer by applying a Taproot-style scalar tweak.
Parameters
- t: Bytes32
  32-byte tweak scalar.
Returns UniversalSigner
- Defined in signer.ts:149

verify

verify(hash: MessageHash, signature: Signature): boolean
Verifies a compact ECDSA signature.
Parameters
- hash: MessageHash
  32-byte message digest.
- signature: Signature
  Compact ECDSA signature.
Returns boolean
- Defined in signer.ts:138

verifySchnorr

verifySchnorr(hash: MessageHash, signature: SchnorrSignature): boolean
Verifies a BIP-340 Schnorr signature.
Parameters
- hash: MessageHash
  32-byte message digest.
- signature: SchnorrSignature
  64-byte Schnorr signature.
Returns boolean
- Defined in signer.ts:144