Class: BitcoinApi

Defined in: packages/api/src/bitcoin.ts:19

Bitcoin network operations sub-facade. Always backed by a BitcoinConnection so it can be passed to resolve/update without extra configuration.

Lazily initialized by DidBtcr2Api to avoid connection overhead when Bitcoin features are not used.

Constructors

Constructor

new BitcoinApi(cfg): BitcoinApi

Defined in: packages/api/src/bitcoin.ts:61

Create a BitcoinApi for a specific network with optional endpoint overrides. Uses BitcoinConnection.forNetwork() — no env vars consulted.

Parameters

cfg

BitcoinApiConfig

The network and optional REST/RPC overrides.

Returns

BitcoinApi

Properties

connection

readonly connection: BitcoinConnection

Defined in: packages/api/src/bitcoin.ts:21

The underlying BitcoinConnection used for all operations.

Accessors

hasRpc

Get Signature

get hasRpc(): boolean

Defined in: packages/api/src/bitcoin.ts:37

Whether an RPC client is available for this network.

Returns

boolean

---

rest

Get Signature

get rest(): BitcoinRestClient

Defined in: packages/api/src/bitcoin.ts:24

REST client for the active network.

Returns

BitcoinRestClient

---

rpc

Get Signature

get rpc(): BitcoinCoreRpcClient | undefined

Defined in: packages/api/src/bitcoin.ts:32

RPC client for the active network, or undefined if not configured. Use requireRpc when RPC is expected to be available.

Returns

BitcoinCoreRpcClient | undefined

Methods

getBlock()

getBlock(params): Promise<EsploraBlock | undefined>

Defined in: packages/api/src/bitcoin.ts:113

Get a block by hash or height via REST.

Parameters

params

Block identifier — at least one of hash or height is required.

hash?

string

height?

number

Returns

Promise<EsploraBlock | undefined>

---

getTransaction()

getTransaction(txid): Promise<RawTransactionRest>

Defined in: packages/api/src/bitcoin.ts:86

Fetch a transaction by txid via REST.

Parameters

txid

string

The transaction ID (64-character hex string).

Returns

Promise<RawTransactionRest>

The fetched transaction.

---

getUtxos()

getUtxos(address): Promise<AddressUtxo[]>

Defined in: packages/api/src/bitcoin.ts:104

Get UTXOs for an address via REST.

Parameters

address

string

The Bitcoin address.

Returns

Promise<AddressUtxo[]>

---

requireRpc()

requireRpc(): BitcoinCoreRpcClient

Defined in: packages/api/src/bitcoin.ts:45

RPC client for the active network.

Returns

BitcoinCoreRpcClient

Throws

If RPC was not configured for this network.

---

send()

send(rawTxHex): Promise<string>

Defined in: packages/api/src/bitcoin.ts:95

Broadcast a raw tx (hex) via REST.

Parameters

rawTxHex

string

The raw transaction hex string.

Returns

Promise<string>

---

btcToSats()

static btcToSats(btc): number

Defined in: packages/api/src/bitcoin.ts:121

Convert BTC to satoshis (integer-safe string-split arithmetic).

Parameters

btc

number

Returns

number

---

satsToBtc()

static satsToBtc(sats): number

Defined in: packages/api/src/bitcoin.ts:126

Convert satoshis to BTC (integer-safe string-split arithmetic).

Parameters

sats

number

Returns

number