Class SingleKey

In-memory single key implementation for Bitcoin transaction signing.

Example

// Create from hex string
const key = SingleKey.fromHex('your_private_key_hex');

// Create from raw bytes
const key = SingleKey.fromPrivateKey(privateKeyBytes);

// Create random key
const randomKey = SingleKey.fromRandomBytes();

// Sign a transaction
const signedTx = await key.sign(transaction);

Implements

Identity

Index

Methods

compressedPublicKey sign signerSession signMessage toHex toReadonly xOnlyPublicKey fromHex fromPrivateKey fromRandomBytes

Methods

compressedPublicKey

compressedPublicKey(): Promise<Uint8Array<ArrayBufferLike>>
Returns the compressed public key for this identity.

Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of Identity.compressedPublicKey
- Defined in identity/singleKey.ts:94

sign

sign(tx: Transaction, inputIndexes?: number[]): Promise<Transaction>
Sign the provided transaction inputs.
Parameters
- tx: Transaction
  Transaction to sign
- OptionalinputIndexes: number[]
  Optional input indexes to sign. When omitted, the implementation should sign every signable input.
Returns Promise<Transaction>
Implementation of Identity.sign
- Defined in identity/singleKey.ts:64

signerSession

signerSession(): SignerSession
Returns a signer session used for musig2 tree signing flows.

Returns SignerSession
Implementation of Identity.signerSession
- Defined in identity/singleKey.ts:102

signMessage

signMessage(
message: Uint8Array,
signatureType?: "schnorr" | "ecdsa",
): Promise<Uint8Array<ArrayBufferLike>>
Sign an arbitrary message using the requested signature type.
Parameters
- message: Uint8Array
- signatureType: "schnorr" | "ecdsa" = "schnorr"
Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of Identity.signMessage
- Defined in identity/singleKey.ts:106

toHex

toHex(): string
Export the private key as a hex string.

Returns string
The private key as a hex string
- Defined in identity/singleKey.ts:60

toReadonly

toReadonly(): Promise<ReadonlySingleKey>
Returns Promise<ReadonlySingleKey>
- Defined in identity/singleKey.ts:115

xOnlyPublicKey

xOnlyPublicKey(): Promise<Uint8Array<ArrayBufferLike>>
Returns the x-only public key used by Taproot scripts.

Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of Identity.xOnlyPublicKey
- Defined in identity/singleKey.ts:98

`Static`fromHex

fromHex(privateKeyHex: string): SingleKey
Create a signing identity from a hex-encoded private key.
Parameters
- privateKeyHex: string
Returns SingleKey
- Defined in identity/singleKey.ts:46

`Static`fromPrivateKey

fromPrivateKey(privateKey: Uint8Array): SingleKey
Create a signing identity from raw private key bytes.
Parameters
- privateKey: Uint8Array
Returns SingleKey
- Defined in identity/singleKey.ts:41

`Static`fromRandomBytes

fromRandomBytes(): SingleKey
Create a signing identity with a freshly generated random private key.

Returns SingleKey
- Defined in identity/singleKey.ts:51

Class SingleKey

Example

Implements

Index

Methods

Methods

compressedPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

sign

Parameters

Returns Promise<Transaction>

signerSession

Returns SignerSession

signMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

toHex

Returns string

toReadonly

Returns Promise<ReadonlySingleKey>

xOnlyPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

`Static`fromHex

Parameters

Returns SingleKey

`Static`fromPrivateKey

Parameters

Returns SingleKey

`Static`fromRandomBytes

Returns SingleKey

Settings

On This Page

Class SingleKey

Example

Implements

Index

Methods

Methods

compressedPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

sign

Parameters

Returns Promise<Transaction>

signerSession

Returns SignerSession

signMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

toHex

Returns string

toReadonly

Returns Promise<ReadonlySingleKey>

xOnlyPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

StaticfromHex

Parameters

Returns SingleKey

StaticfromPrivateKey

Parameters

Returns SingleKey

StaticfromRandomBytes

Returns SingleKey

Settings

On This Page

`Static`fromHex

`Static`fromPrivateKey

`Static`fromRandomBytes