Class SeedIdentity

Seed-based identity derived from a raw seed and an account descriptor template.

This is the recommended identity type for most applications. It uses standard BIP86 (Taproot) derivation by default; callers that need a different path supply the wildcard template directly.

Prefer this (or

See

MnemonicIdentity) over SingleKey for new integrations — SingleKey exists for backward compatibility with raw nsec-style keys.

The identity holds the wildcard template (e.g. tr([fp/86'/0'/0']xpub/0/*)) on its public descriptor field. HD rotation reads it directly; consumers that need a concrete descriptor at a specific index materialize it themselves (see HDDescriptorProvider in the wallet layer).

Exposes seed-level primitives (signing, derivation, the template) but is deliberately NOT a DescriptorProvider. Wrap it explicitly to get one:

HDDescriptorProvider for rotating receive addresses.
StaticDescriptorProvider for legacy, single-key behaviour.

The split prevents a SeedIdentity from being silently used as a concrete descriptor source, which would defeat HD rotation without any compile-time signal that something was wrong.

Example

const seed = mnemonicToSeedSync(mnemonic);

// Testnet (BIP86 wildcard descriptor m/86'/1'/0'/0/*)
const identity = SeedIdentity.fromSeed(seed, { isMainnet: false });

// Mainnet (BIP86 wildcard descriptor m/86'/0'/0'/0/*)
const identity = SeedIdentity.fromSeed(seed, { isMainnet: true });

// Caller-supplied wildcard descriptor (must end in `/*)`).
const identity = SeedIdentity.fromSeed(seed, { descriptor });

Hierarchy (View Summary)

SeedIdentity
- MnemonicIdentity

Implements

HDCapableIdentity

Index

Constructors

constructor

new SeedIdentity(seed: Uint8Array, opts?: SeedIdentityOptions): SeedIdentity
Constructs a SeedIdentity from a 64-byte seed and either a caller-supplied wildcard descriptor ({ descriptor }) or the default BIP86 path at the requested network ({ isMainnet }). Prefer the fromSeed factory for symmetry with MnemonicIdentity.fromMnemonic.

Throws on a non-wildcard descriptor, an xpub mismatch with the seed, or a missing derivation path.
Parameters
- seed: Uint8Array
- opts: SeedIdentityOptions = {}
Returns SeedIdentity
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:130

Properties

`Readonly`descriptor

descriptor: string

Wildcard account-descriptor template (e.g. tr([fp/86'/0'/0']xpub/0/*)). The canonical thing to pass through the system; consumers materialize a concrete descriptor at a specific index themselves (see HDDescriptorProvider in the wallet layer for the rotating-counter use case).

Methods

compressedPublicKey

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

Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of HDCapableIdentity.compressedPublicKey
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:218

ownsDescriptor

ownsDescriptor(descriptor: string): boolean
Returns true when descriptor is derived from this identity's seed.
Parameters
- descriptor: string
Returns boolean
Implementation of HDCapableIdentity.ownsDescriptor
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:261

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 HDCapableIdentity.sign
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:222

signDescriptorMessage

signDescriptorMessage(
    descriptor: string,
    message: Uint8Array,
    signatureType?: "schnorr" | "ecdsa",
): Promise<Uint8Array<ArrayBufferLike>>
Signs a message with the key derived from descriptor.
Parameters
- descriptor: string
- message: Uint8Array
- signatureType: "schnorr" | "ecdsa" = "schnorr"
Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of HDCapableIdentity.signDescriptorMessage
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:282

signDescriptorTransactions

signDescriptorTransactions(
requests: DescriptorSigningRequest[],
): Promise<Transaction[]>
Signs each request with the key derived from its descriptor. Each descriptor must share this identity's seed (ownsDescriptor).
Parameters
- requests: DescriptorSigningRequest[]
Returns Promise<Transaction[]>
Implementation of HDCapableIdentity.signDescriptorTransactions
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:269

signerSession

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

Returns SignerSession
Implementation of HDCapableIdentity.signerSession
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:247

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 HDCapableIdentity.signMessage
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:226

signSchnorrDeterministic

signSchnorrDeterministic(
messageHash: Uint8Array,
): Promise<Uint8Array<ArrayBufferLike>>
BIP-340 sign messageHash with this identity's own key, aux_rand = 0.

The descriptor-less sibling of signSchnorrDeterministicWithDescriptor, for an auto-mode wallet whose bare tr(pubkey) resolves to the identity itself rather than to a DescriptorIdentity. Deliberately NOT routed through signMessage, whose schnorr branch draws a random aux_rand and would make the "deterministic" signature unreproducible.
Parameters
- messageHash: Uint8Array
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:243

signSchnorrDeterministicWithDescriptor

signSchnorrDeterministicWithDescriptor(
descriptor: string,
messageHash: Uint8Array,
): Promise<Uint8Array<ArrayBufferLike>>
BIP-340 sign messageHash with the key derived from descriptor, aux_rand = 0. Backs DescriptorIdentity.signSchnorrDeterministic, which swap preimage derivation reads through.
Parameters
- descriptor: string
- messageHash: Uint8Array
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:299

toReadonly

toReadonly(): Promise<ReadonlyDescriptorIdentity>
Converts to a watch-only identity that cannot sign. Carries the template forward, so the readonly side stays HD-capable (can derive descriptors at any index without seed access).

Returns Promise<ReadonlyDescriptorIdentity>
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:256

xOnlyPublicKey

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

Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of HDCapableIdentity.xOnlyPublicKey
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:214

`Static`fromSeed

fromSeed(seed: Uint8Array, opts?: SeedIdentityOptions): SeedIdentity
Creates a SeedIdentity from a raw 64-byte seed.

Pass { isMainnet } for default BIP86 derivation, or { descriptor } for a caller-supplied account-descriptor template (the option's value must end with /*)).
Parameters
- seed: Uint8Array
  64-byte seed (typically from mnemonicToSeedSync)
- opts: SeedIdentityOptions = {}
  Network selection or descriptor template.
Returns SeedIdentity
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:210

Class SeedIdentity

See

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SeedIdentity

Properties

Readonlydescriptor

Methods

compressedPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

ownsDescriptor

Parameters

Returns boolean

sign

Parameters

Returns Promise<Transaction>

signDescriptorMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signDescriptorTransactions

Parameters

Returns Promise<Transaction[]>

signerSession

Returns SignerSession

signMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signSchnorrDeterministic

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signSchnorrDeterministicWithDescriptor

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

toReadonly

Returns Promise<ReadonlyDescriptorIdentity>

xOnlyPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

StaticfromSeed

Parameters

Returns SeedIdentity

Settings

On This Page

`Readonly`descriptor

`Static`fromSeed