BtcConfig

Defined in: wallet-btc/src/types.ts:47

Options for a Bitcoin wallet manager or account: transports, network, address type and fee limits.

Properties

addressType?

optional addressType?: BtcAddressType

Defined in: wallet-btc/src/types.ts:53

p2wpkh (BIP-84, default) or p2tr (BIP-86 taproot). Changes the derivation path and the address.

---

antiFeeSniping?

optional antiFeeSniping?: boolean

Defined in: wallet-btc/src/types.ts:69

Set nLockTime to the current height so the tx cannot be mined into a reorg (default true; skipped when the transport has no getBlockHeight).

---

client?

optional client?: BtcClient | BtcClientConfig | BtcClient | BtcClientConfig[]

Defined in: wallet-btc/src/types.ts:49

One or more transports (config objects or ready BtcClients). A list fails over in order. Omit for an offline (sign-only) wallet.

---

fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

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

Injectable fetch (tests, custom agents). Defaults to globalThis.fetch.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

maxFeeRate?

optional maxFeeRate?: number

Defined in: wallet-btc/src/types.ts:63

Fee-rate ceiling in sat/vB (default 500). Anything above is refused before signing or broadcast.

---

maxInputs?

optional maxInputs?: number

Defined in: wallet-btc/src/types.ts:65

Coin-selection input cap (default 200).

---

network?

optional network?: BtcNetwork

Defined in: wallet-btc/src/types.ts:51

Network; default bitcoin (mainnet).

---

rbf?

optional rbf?: boolean

Defined in: wallet-btc/src/types.ts:67

Opt-in to replace-by-fee signalling (default true).

---

retries?

optional retries?: number

Defined in: wallet-btc/src/types.ts:55

Extra attempts across the client list after the first failure (default 3).

---

timeoutMs?

optional timeoutMs?: number

Defined in: wallet-btc/src/types.ts:57

Per-request timeout in ms (default 15000).

---

transactionMaxFee?

optional transactionMaxFee?: number | bigint

Defined in: wallet-btc/src/types.ts:61

Max fee (sats) for sendTransaction / signTransaction.

---

transferMaxFee?

optional transferMaxFee?: number | bigint

Defined in: wallet-btc/src/types.ts:59

Max fee (sats) for transfer.