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 identity/seedIdentity.ts:128

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 identity/seedIdentity.ts:216

isOurs

isOurs(descriptor: string): boolean
Returns true when descriptor is derived from this identity's seed. HD descriptors match by account xpub; bare tr(pubkey) descriptors match by raw pubkey. See descriptorIsOurs.
Parameters
- descriptor: string
Returns boolean
Deprecated
Prefer DescriptorProvider.isOurs() via HDDescriptorProvider for rotating HD wallets or StaticDescriptorProvider for legacy single-key wallets.
Implementation of HDCapableIdentity.isOurs
- Defined in identity/seedIdentity.ts:253

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 identity/seedIdentity.ts:220

signerSession

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

Returns SignerSession
Implementation of HDCapableIdentity.signerSession
- Defined in identity/seedIdentity.ts:231

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 identity/seedIdentity.ts:224

signMessageWithDescriptor

signMessageWithDescriptor(
    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>>
Deprecated
Prefer DescriptorProvider.signMessageWithDescriptor() via HDDescriptorProvider or StaticDescriptorProvider. Identities keep this method only as backing implementation for descriptor providers.
Implementation of HDCapableIdentity.signMessageWithDescriptor
- Defined in identity/seedIdentity.ts:284

signWithDescriptor

signWithDescriptor(requests: DescriptorSigningRequest[]): Promise<Transaction[]>
Signs each request with the key derived from its descriptor. Each descriptor must share this identity's seed (isOurs).
Parameters
- requests: DescriptorSigningRequest[]
Returns Promise<Transaction[]>
Deprecated
Prefer DescriptorProvider.signWithDescriptor() via HDDescriptorProvider or StaticDescriptorProvider. Identities keep this method only as backing implementation for descriptor providers.
Implementation of HDCapableIdentity.signWithDescriptor
- Defined in identity/seedIdentity.ts:265

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 identity/seedIdentity.ts:240

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 identity/seedIdentity.ts:212

`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 identity/seedIdentity.ts:208

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>>

isOurs

Parameters

Returns boolean

Deprecated

sign

Parameters

Returns Promise<Transaction>

signerSession

Returns SignerSession

signMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signMessageWithDescriptor

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Deprecated

signWithDescriptor

Parameters

Returns Promise<Transaction[]>

Deprecated

toReadonly

Returns Promise<ReadonlyDescriptorIdentity>

xOnlyPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

StaticfromSeed

Parameters

Returns SeedIdentity

Settings

On This Page

`Readonly`descriptor

`Static`fromSeed