Interface OnchainProvider

interface OnchainProvider {
    broadcastTransaction(...txs: string[]): Promise<string>;
    getChainTip(): Promise<{ hash: string; height: number; time: number }>;
    getCoins(address: string): Promise<Coin[]>;
    getFeeRate(): Promise<number | undefined>;
    getRawTransaction(txid: string): Promise<Uint8Array<ArrayBufferLike>>;
    getTransactions(address: string): Promise<ExplorerTransaction[]>;
    getTxOutspends(txid: string): Promise<{ spent: boolean; txid?: string }[]>;
    getTxStatus(
        txid: string,
    ): Promise<
        | { confirmed: false }
        | { blockHeight: number; blockTime: number; confirmed: true },
    >;
    watchAddresses(
        addresses: string[],
        eventCallback: (txs: ExplorerTransaction[]) => void,
    ): Promise<() => void>;
}

Implemented by

Index

Methods

broadcastTransaction getChainTip getCoins getFeeRate getRawTransaction getTransactions getTxOutspends getTxStatus watchAddresses

Methods

broadcastTransaction

broadcastTransaction(...txs: string[]): Promise<string>
Broadcast a single transaction or a 1P1C package.
Parameters
- ...txs: string[]
  One or more raw transaction hex strings
Returns Promise<string>
Broadcast transaction id

Throws
Error if the broadcast request fails or the package shape is invalid
- Defined in packages/ts-sdk/src/providers/onchain.ts:91

getChainTip

getChainTip(): Promise<{ hash: string; height: number; time: number }>
Fetch the current chain tip.

Returns Promise<{ hash: string; height: number; time: number }>
Current chain height, median-time-past, and block hash

Remarks
time is the tip's median-time-past, not the header's own nTime. BIP-113 evaluates seconds-typed OP_CHECKLOCKTIMEVERIFY / OP_CHECKSEQUENCEVERIFY against MTP, which lags the tip by roughly an hour; the header time may sit two hours ahead of it. An implementation returning the header time calls a timelock mature before the network does — surfacing as a broadcast the node rejects, not as a bug here.
- Defined in packages/ts-sdk/src/providers/onchain.ts:147

getCoins

getCoins(address: string): Promise<Coin[]>
Fetch spendable onchain outputs for an address.
Parameters
- address: string
  Bitcoin address to query
Returns Promise<Coin[]>
Spendable onchain outputs for the address

See
Coin
- Defined in packages/ts-sdk/src/providers/onchain.ts:72

getFeeRate

getFeeRate(): Promise<number | undefined>
Fetch the current fastest fee rate estimate.

Returns Promise<number | undefined>
Fee rate in sats/vB, if available

Remarks
Implementations may return undefined when the backing service does not expose a usable fee estimate.
- Defined in packages/ts-sdk/src/providers/onchain.ts:82

getRawTransaction

getRawTransaction(txid: string): Promise<Uint8Array<ArrayBufferLike>>
Fetch the raw wire-format bytes of a transaction.
Parameters
- txid: string
  Transaction id to fetch
Returns Promise<Uint8Array<ArrayBufferLike>>
Serialized transaction bytes

Throws
Error if the transaction is unknown to the backend

Remarks
Needed to carry a boarding or commitment tx as a PSBT prevout field — those have no off-chain source, so the indexer cannot serve them.
- Defined in packages/ts-sdk/src/providers/onchain.ts:123

getTransactions

getTransactions(address: string): Promise<ExplorerTransaction[]>
Fetch transactions associated with an address.
Parameters
- address: string
  Bitcoin address to query
Returns Promise<ExplorerTransaction[]>
Transactions involving the address

See
ExplorerTransaction
- Defined in packages/ts-sdk/src/providers/onchain.ts:111

getTxOutspends

getTxOutspends(txid: string): Promise<{ spent: boolean; txid?: string }[]>
Fetch outspend information for every output in a transaction.
Parameters
- txid: string
  Transaction id to inspect
Returns Promise<{ spent: boolean; txid?: string }[]>
Per-output spend status information. txid (the spender) may be absent even when spent is true: some Esplora deployments (e.g. mempool.arkade.sh) omit it from /outspends.

See
getTxStatus
- Defined in packages/ts-sdk/src/providers/onchain.ts:102

getTxStatus

getTxStatus(
    txid: string,
): Promise<
    | { confirmed: false }
    | { blockHeight: number; blockTime: number; confirmed: true },
>
Fetch confirmation status for a transaction.
Parameters
- txid: string
  Transaction id to inspect
Returns Promise<
| { confirmed: false }
| { blockHeight: number; blockTime: number; confirmed: true },
>
Confirmation status and block metadata when confirmed

See
getTxOutspends
- Defined in packages/ts-sdk/src/providers/onchain.ts:132

watchAddresses

watchAddresses(
addresses: string[],
eventCallback: (txs: ExplorerTransaction[]) => void,
): Promise<() => void>
Watch a set of addresses and invoke the callback when transactions are observed.
Parameters
- addresses: string[]
  Addresses to monitor
- eventCallback: (txs: ExplorerTransaction[]) => void
  Callback invoked when matching transactions are seen
Returns Promise<() => void>
Stop function that cancels the watch

Remarks
Implementations may use websockets, server-sent events, polling, or a hybrid strategy.

See
getTransactions
- Defined in packages/ts-sdk/src/providers/onchain.ts:163

Interface OnchainProvider

Implemented by

Index

Methods

Methods

broadcastTransaction

Parameters

Returns Promise<string>

Throws

getChainTip

Returns Promise<{ hash: string; height: number; time: number }>

Remarks

getCoins

Parameters

Returns Promise<Coin[]>

See

getFeeRate

Returns Promise<number | undefined>

Remarks

getRawTransaction

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Throws

Remarks

getTransactions

Parameters

Returns Promise<ExplorerTransaction[]>

See

getTxOutspends

Parameters

Returns Promise<{ spent: boolean; txid?: string }[]>

See

getTxStatus

Parameters

Returns Promise< | { confirmed: false } | { blockHeight: number; blockTime: number; confirmed: true },>

See

watchAddresses

Parameters

Returns Promise<() => void>

Remarks

See

Settings

On This Page

Returns Promise<
| { confirmed: false }
| { blockHeight: number; blockTime: number; confirmed: true },
>