WalletAccountBtc

Defined in: wallet-btc/src/account.ts:45

Signing Bitcoin account — BIP-84 p2wpkh or BIP-86 p2tr (key-path). The key never enters this package: every signature is one signer.sign(...) call over a btc-signer-computed sighash — a LocalSigner for seed wallets, anything else (hardware, MPC, backend) through externalSigner():

p2wpkh input  → `ecdsa`              over the BIP-143 sighash (SIGHASH_ALL), DER-encoded here
p2tr input    → `schnorr` + `tweak`  over the BIP-341 sighash (DEFAULT), tweak = TapTweak(xonly)
BIP-137 msg   → `ecdsa-recoverable`  over the magic hash

Every spend is resolved to a full description (“what you sign”) and run through the hard safety checks (fee-rate ceiling, recipient/amount exactness, change ownership) before signing AND before broadcast — also for caller-supplied raw hex.

Extends

WalletAccountReadOnlyBtc

Implements

IWalletAccount

Constructors

Constructor

new WalletAccountBtc(signer, publicKey, path, config?): WalletAccountBtc

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

publicKey is the signer’s compressed secp256k1 key (33 bytes); it is needed synchronously for the address.

Parameters

signer

Signer

publicKey

Uint8Array

path

string

config?

BtcConfig = {}

Returns

WalletAccountBtc

Overrides

WalletAccountReadOnlyBtc.constructor

Properties

_client

protected readonly _client: BtcClient | undefined

Defined in: wallet-btc/src/read-only-account.ts:39

Inherited from

WalletAccountReadOnlyBtc._client

_config

protected readonly _config: BtcConfig

Defined in: wallet-btc/src/read-only-account.ts:38

Inherited from

WalletAccountReadOnlyBtc._config

_network

protected readonly _network: BTC_NETWORK

Defined in: wallet-btc/src/read-only-account.ts:40

Inherited from

WalletAccountReadOnlyBtc._network

_networkName

protected readonly _networkName: BtcNetwork

Defined in: wallet-btc/src/read-only-account.ts:41

Inherited from

WalletAccountReadOnlyBtc._networkName

address

readonly address: string

Defined in: wallet-btc/src/read-only-account.ts:28

The address.

Inherited from

WalletAccountReadOnlyBtc.address

addressType

readonly addressType: BtcAddressType

Defined in: wallet-btc/src/account.ts:52

p2wpkh / p2tr when the address is one we know how to spend from; undefined for other script types.

Overrides

WalletAccountReadOnlyBtc.addressType

chain

readonly chain: string

Defined in: wallet-btc/src/read-only-account.ts:29

CAIP-2 chain id, e.g. “eip155:1”, “solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp”, “ton:-239”, “tron:0x2b6653dc”, “bip122:000000000019d6689c085ae165831e93”.

Implementation of

IWalletAccount.chain

Inherited from

WalletAccountReadOnlyBtc.chain

dustLimit

readonly dustLimit: bigint

Defined in: wallet-btc/src/read-only-account.ts:37

Smallest output this address type may create, in satoshis.

Inherited from

WalletAccountReadOnlyBtc.dustLimit

needsNetwork

readonly needsNetwork: true = true

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

UTXOs, fee rate and tip height come from the network before signing.

Implementation of

IWalletAccount.needsNetwork

path

readonly path: string

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

Derivation path, or external for an external signer.

publicKey

readonly publicKey: Uint8Array

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

Compressed secp256k1 public key.

scriptKind

readonly scriptKind: ScriptKind

Defined in: wallet-btc/src/read-only-account.ts:33

Script type of the address.

Inherited from

WalletAccountReadOnlyBtc.scriptKind

scriptPubKey

readonly scriptPubKey: Uint8Array

Defined in: wallet-btc/src/read-only-account.ts:31

Output script of address.

Inherited from

WalletAccountReadOnlyBtc.scriptPubKey

signerKind

readonly signerKind: "seed" | "key" | "external"

Defined in: wallet-btc/src/account.ts:60

What holds the key: seed, key (one imported key) or external.

Accessors

index

Get Signature

get index(): number | undefined

Defined in: wallet-btc/src/account.ts:84

Account index for the standard m/{84|86}‘/{0|1}’/0’/0/i path.

Returns

number | undefined

maxFeeRate

Get Signature

get maxFeeRate(): number

Defined in: wallet-btc/src/read-only-account.ts:63

Fee-rate ceiling in sat/vB: BtcConfig.maxFeeRate or DEFAULT_MAX_FEE_RATE.

Returns

number

Inherited from

WalletAccountReadOnlyBtc.maxFeeRate

Methods

describeTransaction()

describeTransaction(tx): Promise<BtcTxDescription>

Defined in: wallet-btc/src/account.ts:250

“What you sign”: the fully resolved spend (signed, NOT broadcast) or a caller’s raw hex.

Parameters

tx

BtcTransaction

Returns

Promise<BtcTxDescription>

dispose()

dispose(): void

Defined in: wallet-btc/src/account.ts:319

Zeroize this account’s key material.

Returns

void

Implementation of

IWalletAccount.dispose

getAddress()

getAddress(): Promise<string>

Defined in: wallet-btc/src/read-only-account.ts:68

The address.

Returns

Promise<string>

Implementation of

IWalletAccount.getAddress

Inherited from

WalletAccountReadOnlyBtc.getAddress

getBalance()

getBalance(): Promise<bigint>

Defined in: wallet-btc/src/read-only-account.ts:71

Confirmed minus pending outgoing (Bitcoin Core wallet semantics).

Returns

Promise<bigint>

Implementation of

IWalletAccount.getBalance

Inherited from

WalletAccountReadOnlyBtc.getBalance

getMaxSpendable()

getMaxSpendable(opts?): Promise<BtcMaxSpendableResult>

Defined in: wallet-btc/src/read-only-account.ts:136

Everything spendable in ONE transaction to a single output of our own address type, no change.

Parameters

opts?

confirmationTarget?

number

feeRate?

number | bigint

to?

string

Returns

Promise<BtcMaxSpendableResult>

Inherited from

WalletAccountReadOnlyBtc.getMaxSpendable

getTokenBalance()

getTokenBalance(_token): Promise<bigint>

Defined in: wallet-btc/src/read-only-account.ts:77

Always throws: Bitcoin has no tokens.

Parameters

_token

string

Returns

Promise<bigint>

Implementation of

IWalletAccount.getTokenBalance

Inherited from

WalletAccountReadOnlyBtc.getTokenBalance

getTransactionReceipt()

getTransactionReceipt(hash): Promise<BtcReceipt | undefined>

Defined in: wallet-btc/src/read-only-account.ts:147

Undefined until the transaction is mined.

Parameters

hash

string

Returns

Promise<BtcReceipt | undefined>

Implementation of

IWalletAccount.getTransactionReceipt

Inherited from

WalletAccountReadOnlyBtc.getTransactionReceipt

inputWeight()

protected inputWeight(): number

Defined in: wallet-btc/src/read-only-account.ts:82

Weight one of OUR inputs adds; throws for address types we cannot spend from.

Returns

number

Inherited from

WalletAccountReadOnlyBtc.inputWeight

lockTimeHeight()

protected lockTimeHeight(): Promise<number>

Defined in: wallet-btc/src/read-only-account.ts:167

Chain tip for anti-fee-sniping; undefined when disabled or the transport cannot tell.

Returns

Promise<number>

Inherited from

WalletAccountReadOnlyBtc.lockTimeHeight

planSpend()

protected planSpend(spend): Promise<SpendPlan>

Defined in: wallet-btc/src/read-only-account.ts:97

Coin selection for a spend (see coinselect.ts). Validates the recipient and the dust floor first.

Parameters

quoteSendTransaction()

quoteSendTransaction(tx): Promise<{ fee: bigint; }>

Defined in: wallet-btc/src/account.ts:268

Fee of a spend in satoshis, from a coin selection at the current fee rate.

Parameters

tx

BtcTransaction

Returns

Promise<{ fee: bigint; }>

Implementation of

IWalletAccount.quoteSendTransaction

Overrides

WalletAccountReadOnlyBtc.quoteSendTransaction

quoteTransfer()

quoteTransfer(o): Promise<{ fee: bigint; }>

Defined in: wallet-btc/src/read-only-account.ts:130

Fee of a transfer in satoshis.

Parameters

o

BtcTransferOptions

Returns

Promise<{ fee: bigint; }>

Throws

Error when token is set.

Implementation of

IWalletAccount.quoteTransfer

Inherited from

WalletAccountReadOnlyBtc.quoteTransfer

requireClient()

protected requireClient(what): BtcClient

Defined in: wallet-btc/src/read-only-account.ts:57

Parameters

what

string

Returns

BtcClient

Inherited from

WalletAccountReadOnlyBtc.requireClient

resolveFeeRate()

protected resolveFeeRate(spend): Promise<bigint>

Defined in: wallet-btc/src/read-only-account.ts:87

Parameters

spend

confirmationTarget?

number

feeRate?

number | bigint

Returns

Promise<bigint>

Inherited from

WalletAccountReadOnlyBtc.resolveFeeRate

sendTransaction()

sendTransaction(tx, options?): Promise<TransferResult>

Defined in: wallet-btc/src/account.ts:273

Sign and broadcast.

Parameters

tx

BtcTransaction

options?

WriteOptions = {}

Returns

Promise<TransferResult>

Implementation of

IWalletAccount.sendTransaction

sign()

sign(message): Promise<string>

Defined in: wallet-btc/src/account.ts:94

BIP-137 p2wpkh signature, base64 (Electrum / Bitcoin Core encoding). Not available for taproot accounts.

Parameters

message

string | Uint8Array<ArrayBufferLike>

Returns

Promise<string>

Implementation of

IWalletAccount.sign

signTransaction()

signTransaction(tx, options?): Promise<string>

Defined in: wallet-btc/src/account.ts:256

Sign without broadcasting. Returns the raw transaction hex. Raw hex input gets the checks sendTransaction runs (prevouts through the client) and is returned unchanged, never re-signed.

Parameters

tx

BtcTransaction

options?

WriteOptions = {}

Returns

Promise<string>

Implementation of

IWalletAccount.signTransaction

toReadOnlyAccount()

toReadOnlyAccount(): IWalletAccountReadOnly

Defined in: wallet-btc/src/account.ts:314

The same address as a WalletAccountReadOnlyBtc.

Returns

IWalletAccountReadOnly

Implementation of

IWalletAccount.toReadOnlyAccount

transfer()

transfer(o, writeOptions?): Promise<TransferResult>

Defined in: wallet-btc/src/account.ts:289

Native BTC only (token is rejected). Subject to transferMaxFee.

Parameters

o

BtcTransferOptions

writeOptions?

WriteOptions = {}

Returns

Promise<TransferResult>

Implementation of

IWalletAccount.transfer

verify()

verify(message, signature): Promise<boolean>

Defined in: wallet-btc/src/read-only-account.ts:159

BIP-137: recover the key and compare its p2wpkh address with ours. Taproot addresses have no BIP-137 form.

Parameters

message

string | Uint8Array<ArrayBufferLike>

signature

string

Returns

Promise<boolean>

Implementation of

IWalletAccount.verify

Inherited from

WalletAccountReadOnlyBtc.verify

fromPrivateKey()

static fromPrivateKey(privateKey, publicKey, path, config?): WalletAccountBtc

Defined in: wallet-btc/src/account.ts:79

Back-compat: wrap a raw derived key in a LocalSigner (the account takes ownership; it cannot derive).

Parameters

privateKey

Uint8Array

publicKey

Uint8Array

path

string

config?

BtcConfig = {}

Returns

WalletAccountBtc