Class DescriptorIdentity

Identity pinned to one materialized HD descriptor: every key and signature it produces belongs to that index rather than to the wallet's baseline key.

Lets components that take a plain Identity (VHTLC claim/refund, batch joins) operate on a rotated index without knowing about descriptors.

Deliberately does NOT satisfy isBatchSignable, isHDCapableIdentity, or hasToReadonly — it is a leaf signer, not another HD root.

Implements

Identity

Index

Constructors

constructor

Methods

compressedPublicKey sign signerSession signMessage signSchnorrDeterministic xOnlyPublicKey

Constructors

constructor

new DescriptorIdentity(
__namedParameters: DescriptorIdentityOptions,
): DescriptorIdentity
Parameters
- __namedParameters: DescriptorIdentityOptions
Returns DescriptorIdentity
- Defined in packages/ts-sdk/src/identity/descriptorIdentity.ts:69

Methods

compressedPublicKey

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

Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of Identity.compressedPublicKey
- Defined in packages/ts-sdk/src/identity/descriptorIdentity.ts:79

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 packages/ts-sdk/src/identity/descriptorIdentity.ts:83

signerSession

signerSession(): SignerSession
Delegated: TreeSignerSession.random() consults no key material, so the session is index-independent.

Returns SignerSession
Implementation of Identity.signerSession
- Defined in packages/ts-sdk/src/identity/descriptorIdentity.ts:104

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 packages/ts-sdk/src/identity/descriptorIdentity.ts:93

signSchnorrDeterministic

signSchnorrDeterministic(
messageHash: Uint8Array,
): Promise<Uint8Array<ArrayBufferLike>>
Throws rather than falling back to the baseline key: a preimage derived from the wrong index is unrecoverable, and callers probe this member through a structural guard that cannot tell the two apart.
Parameters
- messageHash: Uint8Array
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/ts-sdk/src/identity/descriptorIdentity.ts:113

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 packages/ts-sdk/src/identity/descriptorIdentity.ts:75

Class DescriptorIdentity

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DescriptorIdentity

Methods

compressedPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

sign

Parameters

Returns Promise<Transaction>

signerSession

Returns SignerSession

signMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signSchnorrDeterministic

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

xOnlyPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

Settings

On This Page