Class ECPairSigner

Concrete secp256k1 key-pair signer backed by a CryptoBackend.

Instances are created exclusively through the static factory methods (ECPairSigner.fromPrivateKey, ECPairSigner.fromPublicKey, ECPairSigner.fromWIF, ECPairSigner.makeRandom).

Example

import { ECPairSigner, createNobleBackend } from 'ecpair';

const backend = createNobleBackend();
const signer  = ECPairSigner.makeRandom(backend, bitcoin);
const sig     = signer.sign(messageHash);

Implements

UniversalSigner

Index

Accessors

capabilities compressed network privateKey publicKey xOnlyPublicKey

Methods

fromPrivateKey fromPublicKey fromWIF hasCapability makeRandom sign signSchnorr toWIF tweak verify verifySchnorr

Accessors

capabilities

get capabilities(): number
Bitmask of SignerCapability flags representing the operations this signer can perform. Lazily computed and cached.

Returns number
Implementation of UniversalSigner.capabilities
- Defined in signer.ts:347

compressed

get compressed(): boolean
Whether the public key is in compressed SEC1 form.

Returns boolean
Implementation of UniversalSigner.compressed
- Defined in signer.ts:339

network

get network(): Network
Network this signer is bound to.

Returns Network
Implementation of UniversalSigner.network
- Defined in signer.ts:334

privateKey

get privateKey(): PrivateKey | undefined
Raw private key bytes, or undefined for public-key-only signers.

Returns PrivateKey | undefined
Implementation of UniversalSigner.privateKey
- Defined in signer.ts:300

publicKey

get publicKey(): PublicKey
SEC1-encoded public key. Lazily derived from the private key when the signer was created via fromPrivateKey or fromWIF.

Returns PublicKey
Throws
If neither a private nor public key is available (should never happen).
Implementation of UniversalSigner.publicKey
- Defined in signer.ts:310

xOnlyPublicKey

get xOnlyPublicKey(): XOnlyPublicKey
32-byte BIP-340 x-only public key (lazily derived and cached).

Returns XOnlyPublicKey
Implementation of UniversalSigner.xOnlyPublicKey
- Defined in signer.ts:326

Methods

`Static`fromPrivateKey

fromPrivateKey(
    backend: CryptoBackend,
    privateKey: PrivateKey,
    network: Network,
    options?: SignerOptions,
): ECPairSigner
Creates a signer from a raw private key.
Parameters
- backend: CryptoBackend
  Cryptographic backend to use.
- privateKey: PrivateKey
  32-byte secp256k1 private key.
- network: Network
  Target network.
- Optionaloptions: SignerOptions
  Optional settings (e.g. compressed).
Returns ECPairSigner
Throws
If the private key is not in the valid range [1, n).
- Defined in signer.ts:373

`Static`fromPublicKey

fromPublicKey(
    backend: CryptoBackend,
    publicKey: PublicKey,
    network: Network,
    options?: SignerOptions,
): ECPairSigner
Creates a public-key-only signer (cannot sign, export WIF, etc.).
Parameters
- backend: CryptoBackend
  Cryptographic backend to use.
- publicKey: PublicKey
  SEC1-encoded public key.
- network: Network
  Target network.
- Optionaloptions: SignerOptions
  Optional settings (e.g. compressed).
Returns ECPairSigner
Throws
If the public key is not a valid curve point.
- Defined in signer.ts:394

`Static`fromWIF

fromWIF(
    backend: CryptoBackend,
    wifString: string,
    network: Network | readonly Network[],
): ECPairSigner
Imports a signer from a WIF-encoded private key string.
Parameters
- backend: CryptoBackend
  Cryptographic backend to use.
- wifString: string
  Base58Check WIF string.
- network: Network | readonly Network[]
  One or more candidate networks whose WIF version byte is matched.
Returns ECPairSigner
Throws
If no network matches the decoded version byte.
- Defined in signer.ts:414

hasCapability

hasCapability(cap: number): boolean
Tests whether this signer has a specific capability.
Parameters
- cap: number
  SignerCapability flag to test.
Returns boolean
Implementation of UniversalSigner.hasCapability
- Defined in signer.ts:464

`Static`makeRandom

makeRandom(
    backend: CryptoBackend,
    network: Network,
    options?: RandomSignerOptions,
): ECPairSigner
Generates a new signer with a random private key.

Uses FIPS 186-5 B.4.2 / RFC 9380 modular reduction: 48 bytes of entropy are reduced via (seed mod (n − 1)) + 1, producing a key in [1, n) with negligible bias (< 2^−128).
Parameters
- backend: CryptoBackend
  Cryptographic backend to use.
- network: Network
  Target network.
- Optionaloptions: RandomSignerOptions
  Optional settings (rng, compressed).
Returns ECPairSigner
- Defined in signer.ts:436

sign

sign(hash: MessageHash, lowR?: boolean): Signature
Produces a compact ECDSA signature.

When lowR is true, grinds the nonce until the R value's first byte is <= 0x7f, producing a smaller DER encoding.
Parameters
- hash: MessageHash
  32-byte message digest.
- OptionallowR: boolean
  Enable low-R grinding. Defaults to false.
Returns Signature
Throws
If this is a public-key-only signer.
Implementation of UniversalSigner.sign
- Defined in signer.ts:478

signSchnorr

signSchnorr(hash: MessageHash): SchnorrSignature
Produces a 64-byte BIP-340 Schnorr signature.
Parameters
- hash: MessageHash
  32-byte message digest.
Returns SchnorrSignature
Throws
If this is a public-key-only signer.

Throws
If the backend does not support Schnorr signing.
Implementation of UniversalSigner.signSchnorr
- Defined in signer.ts:505

toWIF

toWIF(): string
Exports the private key as a WIF string using this signer's network.

Returns string
Throws
If this is a public-key-only signer.
Implementation of UniversalSigner.toWIF
- Defined in signer.ts:560

tweak

tweak(t: Bytes32): ECPairSigner
Derives a new signer by applying a Taproot-style scalar tweak.

When a private key is available the tweak is applied to the scalar (negating first if the public key has odd Y). Otherwise, only the public key is tweaked via x-only point addition.
Parameters
- t: Bytes32
  32-byte tweak scalar.
Returns ECPairSigner
Throws
If the tweaked key is invalid (e.g. lands on the point at infinity).
Implementation of UniversalSigner.tweak
- Defined in signer.ts:547

verify

verify(hash: MessageHash, signature: Signature): boolean
Verifies a compact ECDSA signature against this signer's public key.
Parameters
- hash: MessageHash
  32-byte message digest.
- signature: Signature
  Compact ECDSA signature.
Returns boolean
Implementation of UniversalSigner.verify
- Defined in signer.ts:519

verifySchnorr

verifySchnorr(hash: MessageHash, signature: SchnorrSignature): boolean
Verifies a BIP-340 Schnorr signature against this signer's x-only public key.
Parameters
- hash: MessageHash
  32-byte message digest.
- signature: SchnorrSignature
  64-byte Schnorr signature.
Returns boolean
Throws
If the backend does not support Schnorr verification.
Implementation of UniversalSigner.verifySchnorr
- Defined in signer.ts:530

Class ECPairSigner

Example

Implements

Index

Accessors

Methods

Accessors

capabilities

Returns number

compressed

Returns boolean

network

Returns Network

privateKey

Returns PrivateKey | undefined

publicKey

Returns PublicKey

Throws

xOnlyPublicKey

Returns XOnlyPublicKey

Methods

StaticfromPrivateKey

Parameters

Returns ECPairSigner

Throws

StaticfromPublicKey

Parameters

Returns ECPairSigner

Throws

StaticfromWIF

Parameters

Returns ECPairSigner

Throws

hasCapability

Parameters

Returns boolean

StaticmakeRandom

Parameters

Returns ECPairSigner

sign

Parameters

Returns Signature

Throws

signSchnorr

Parameters

Returns SchnorrSignature

Throws

Throws

toWIF

Returns string

Throws

tweak

Parameters

Returns ECPairSigner

Throws

verify

Parameters

Returns boolean

verifySchnorr

Parameters

Returns boolean

Throws

Settings

On This Page

`Static`fromPrivateKey

`Static`fromPublicKey

`Static`fromWIF

`Static`makeRandom