WalletAccountReadOnlyBtc

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

Watch-only Bitcoin account: balances, quotes, receipts, BIP-137 verification. No key.

Extended by

• WalletAccountBtc

Implements

• IWalletAccountReadOnly

Constructors

Constructor

new WalletAccountReadOnlyBtc(address, config?): WalletAccountReadOnlyBtc

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

Parameters

address

string

config?

BtcConfig = {}

Returns

WalletAccountReadOnlyBtc

Properties

_client

protected readonly _client: BtcClient | undefined

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

---

_config

protected readonly _config: BtcConfig

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

---

_network

protected readonly _network: BTC_NETWORK

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

---

_networkName

protected readonly _networkName: BtcNetwork

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

---

address

readonly address: string

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

The address.

---

addressType

readonly addressType: BtcAddressType | undefined

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

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

---

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

IWalletAccountReadOnly.chain

---

dustLimit

readonly dustLimit: bigint

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

Smallest output this address type may create, in satoshis.

---

scriptKind

readonly scriptKind: ScriptKind

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

Script type of the address.

---

scriptPubKey

readonly scriptPubKey: Uint8Array

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

Output script of address.

Accessors

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

Methods

getAddress()

getAddress(): Promise<string>

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

The address.

Returns

Promise<string>

Implementation of

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

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

---

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

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

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

---

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>

---

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

spend

BtcSpend

Returns

Promise<SpendPlan>

---

quoteSendTransaction()

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

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

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

Parameters

tx

BtcSpend

Returns

Promise<{ fee: bigint; }>

Implementation of

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

IWalletAccountReadOnly.quoteTransfer

---

requireClient()

protected requireClient(what): BtcClient

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

Parameters

what

string

Returns

BtcClient

---

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>

---

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

IWalletAccountReadOnly.verify