WalletManagerBtc

Defined in: wallet-btc/src/manager.ts:20

One seed → Bitcoin accounts. p2wpkh (default): BIP-84, m/84’/0’/0’/0/i on mainnet, m/84’/1’/0’/0/i on test networks — bc1q… / tb1q… p2tr: BIP-86, m/86’/0’/0’/0/i (key-path taproot) — bc1p… / tb1p… Paths may be relative to the purpose/coin prefix (“0’/0/i”) or given in full.

Built with a secp256k1 Signer instead of a seed, the manager wraps it:

• a derivable SeedSigner sitting at the account branch (m/84'/0'/0'/0 or m/86'/0'/0'/0, per addressType/network) yields getAccount(i) children;
• a SeedSigner at a leaf, or any external signer, is getAccount(0) (path = the signer’s path, or ‘external’) with the configured address type; other indexes/paths throw.

Extends

• WalletManager<WalletAccountBtc, BtcConfig>

Constructors

Constructor

new WalletManagerBtc(seedOrSigner, config?): WalletManagerBtc

Defined in: wallet-btc/src/manager.ts:21

Parameters

seedOrSigner

string | Uint8Array<ArrayBufferLike> | Signer

config?

BtcConfig = {}

Returns

WalletManagerBtc

Overrides

WalletManager<WalletAccountBtc, BtcConfig>.constructor

Properties

_accounts

protected readonly _accounts: Map<string, WalletAccountBtc>

Defined in: core/dist/index.d.ts:271

Inherited from

WalletManager._accounts

---

_config

protected readonly _config: BtcConfig

Defined in: core/dist/index.d.ts:270

Inherited from

WalletManager._config

---

_signer

protected readonly _signer: Signer | undefined

Defined in: core/dist/index.d.ts:269

Inherited from

WalletManager._signer

Accessors

basePath

Get Signature

get basePath(): string

Defined in: wallet-btc/src/manager.ts:30

m/84'/0' for p2wpkh or m/86'/0' for p2tr on mainnet (coin type 1 on test networks); account i is at basePath/0'/0/i.

Returns

string

Methods

cachedAccount()

protected cachedAccount(key, create): Promise<WalletAccountBtc>

Defined in: core/dist/index.d.ts:295

The account cached under key, built by create at most once: concurrent calls share one build. Throws once the manager is disposed; an account whose build finishes after dispose() is disposed itself and the call throws, so no live signing account outlives the manager.

Parameters

key

string

create

() => WalletAccountBtc | Promise<WalletAccountBtc>

Returns

Promise<WalletAccountBtc>

Inherited from

WalletManager.cachedAccount

---

dispose()

dispose(): void

Defined in: core/dist/index.d.ts:302

Dispose every derived account and zeroize the seed; subclasses zeroize their own extras first, then call super.

Returns

void

Inherited from

WalletManager.dispose

---

externalSigner()

protected externalSigner(): Signer | undefined

Defined in: core/dist/index.d.ts:281

The Signer this manager was built with, if any (no mnemonic then). Chain managers decide how to turn it into accounts.

Returns

Signer | undefined

Inherited from

WalletManager.externalSigner

---

getAccount()

getAccount(index?): Promise<WalletAccountBtc>

Defined in: wallet-btc/src/manager.ts:34

Account index on the chain’s standard path. Cached per index.

Parameters

index?

number = 0

Returns

Promise<WalletAccountBtc>

Overrides

WalletManager.getAccount

---

getAccountByPath()

getAccountByPath(path): Promise<WalletAccountBtc>

Defined in: wallet-btc/src/manager.ts:38

Account at an explicit path. Cached per path.

Parameters

path

string

Returns

Promise<WalletAccountBtc>

Overrides

WalletManager.getAccountByPath

---

getFeeRates()

getFeeRates(): Promise<FeeRates>

Defined in: wallet-btc/src/manager.ts:71

sat/vB from the client’s estimator: fast = 1 block, normal = 3, slow = 6.

Returns

Promise<FeeRates>

Overrides

WalletManager.getFeeRates

---

getReadOnlyAccount()

getReadOnlyAccount(address): WalletAccountReadOnlyBtc

Defined in: wallet-btc/src/manager.ts:66

A read-only account for any address, with this manager’s config.

Parameters

address

string

Returns

WalletAccountReadOnlyBtc

---

requireSigner()

protected requireSigner(curve): Signer

Defined in: core/dist/index.d.ts:283

The external signer, asserted to sign on curve; throws when the manager holds a mnemonic instead.

Parameters

curve

SignerCurve

Returns

Signer

Inherited from

WalletManager.requireSigner

---

seedBytes()

protected seedBytes(): Uint8Array

Defined in: core/dist/index.d.ts:275

The 64-byte seed this manager derives from; throws for a Signer-built or disposed manager.

Returns

Uint8Array

Inherited from

WalletManager.seedBytes

---

signerAccount()

protected signerAccount(key, signer, relativePath, build): Promise<WalletAccountBtc>

Defined in: core/dist/index.d.ts:300

cachedAccount over an injected signer: the signer itself (relativePath undefined) or its child along relativePath. A child that never becomes an account is disposed.

Parameters

key

string

signer

Signer

relativePath

string | undefined

build

(leaf, publicKey) => WalletAccountBtc

Returns

Promise<WalletAccountBtc>

Inherited from

WalletManager.signerAccount

---

getRandomSeedPhrase()

static getRandomSeedPhrase(words?): string

Defined in: core/dist/index.d.ts:279

Same as the core getRandomSeedPhrase.

Parameters

words?

12 | 24

Returns

string

Inherited from

WalletManager.getRandomSeedPhrase

---

isValidSeedPhrase()

static isValidSeedPhrase(seed): boolean

Defined in: core/dist/index.d.ts:277

Same as the core isValidSeedPhrase.

Parameters

seed

string

Returns

boolean

Inherited from

WalletManager.isValidSeedPhrase