Class MnemonicIdentity

Mnemonic-based identity derived from a BIP39 phrase.

This is the most user-friendly identity type — recommended for wallet applications where users manage their own backup phrase. Extends

See

SeedIdentity with mnemonic validation and optional passphrase support.

Example

const identity = MnemonicIdentity.fromMnemonic(
  'abandon abandon abandon ...',
  { isMainnet: true, passphrase: 'secret' }
);

Hierarchy (View Summary)

SeedIdentity
- MnemonicIdentity

Index

Properties

descriptor

Methods

compressedPublicKey ownsDescriptor sign signDescriptorMessage signDescriptorTransactions signerSession signMessage signSchnorrDeterministic signSchnorrDeterministicWithDescriptor toReadonly xOnlyPublicKey fromMnemonic fromSeed

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>>
Inherited from SeedIdentity.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
Inherited from SeedIdentity.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>
Inherited from SeedIdentity.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>>
Inherited from SeedIdentity.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[]>
Inherited from SeedIdentity.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
Inherited from SeedIdentity.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>>
Inherited from SeedIdentity.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>>
Inherited from SeedIdentity.signSchnorrDeterministic
- 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>>
Inherited from SeedIdentity.signSchnorrDeterministicWithDescriptor
- 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>
Inherited from SeedIdentity.toReadonly
- 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>>
Inherited from SeedIdentity.xOnlyPublicKey
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:214

`Static`fromMnemonic

fromMnemonic(phrase: string, opts?: MnemonicOptions): MnemonicIdentity
Creates a MnemonicIdentity from a BIP39 mnemonic phrase.

Pass { isMainnet } for default BIP86 derivation, or { descriptor } for a caller-supplied account-descriptor template (the option's value must end with /*)).
Parameters
- phrase: string
  BIP39 mnemonic phrase (12 or 24 words)
- opts: MnemonicOptions = {}
  Network selection or descriptor template, plus optional passphrase
Returns MnemonicIdentity
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:411

`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
Inherited from SeedIdentity.fromSeed
- Defined in packages/ts-sdk/src/identity/seedIdentity.ts:210

Class MnemonicIdentity

See

Example

Hierarchy (View Summary)

Index

Properties

Methods

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

StaticfromMnemonic

Parameters

Returns MnemonicIdentity

StaticfromSeed

Parameters

Returns SeedIdentity

Settings

On This Page

`Readonly`descriptor

`Static`fromMnemonic

`Static`fromSeed