BtcClient
Defined in: wallet-btc/src/types.ts:8
Minimal chain-data client every transport implements. Values in satoshis, fee rates in sat/vB.
Methods
Section titled “Methods”broadcast()
Section titled “broadcast()”broadcast(
rawTx):Promise<string>
Defined in: wallet-btc/src/types.ts:19
Broadcast raw hex; returns the txid.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
close()
Section titled “close()”close():
Promise<void>
Defined in: wallet-btc/src/types.ts:10
Returns
Section titled “Returns”Promise<void>
connect()
Section titled “connect()”connect():
Promise<void>
Defined in: wallet-btc/src/types.ts:9
Returns
Section titled “Returns”Promise<void>
estimateFee()
Section titled “estimateFee()”estimateFee(
blocks):Promise<number>
Defined in: wallet-btc/src/types.ts:21
Fee rate in sat/vB for confirmation within blocks.
Parameters
Section titled “Parameters”blocks
Section titled “blocks”number
Returns
Section titled “Returns”Promise<number>
getBalance()
Section titled “getBalance()”getBalance(
address):Promise<{confirmed:bigint;unconfirmed:bigint;unconfirmedOutgoing?:bigint; }>
Defined in: wallet-btc/src/types.ts:11
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<{ confirmed: bigint; unconfirmed: bigint; unconfirmedOutgoing?: bigint; }>
getBlockHeight()?
Section titled “getBlockHeight()?”
optionalgetBlockHeight():Promise<number>
Defined in: wallet-btc/src/types.ts:23
Current chain tip height (anti-fee-sniping locktime). Optional.
Returns
Section titled “Returns”Promise<number>
getHistory()
Section titled “getHistory()”getHistory(
address):Promise<object[]>
Defined in: wallet-btc/src/types.ts:13
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<object[]>
getTransaction()
Section titled “getTransaction()”getTransaction(
txid):Promise<string>
Defined in: wallet-btc/src/types.ts:15
Raw transaction hex.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
getTransactionInfo()?
Section titled “getTransactionInfo()?”
optionalgetTransactionInfo(txid):Promise<BlockbookTx|undefined>
Defined in: wallet-btc/src/types.ts:17
Full tx record (used for receipts).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<BlockbookTx | undefined>
listUnspent()
Section titled “listUnspent()”listUnspent(
address):Promise<Utxo[]>
Defined in: wallet-btc/src/types.ts:12
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<Utxo[]>