Skip to main content

MempoolProvider

scrypt-ts-opcat v1.0.1

scrypt-ts-opcat / MempoolProvider

Class: MempoolProvider

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:12

The MempoolProvider is backed by [Mempool][https://opcatlabs.io](https://opcatlabs.io)

Implements​

Constructors​

new MempoolProvider()​

new MempoolProvider(network): MempoolProvider

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:18

Parameters​

network​

SupportedNetwork

Returns​

MempoolProvider

Properties​

network​

readonly network: SupportedNetwork

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:18

Methods​

addNewUTXO()​

addNewUTXO(utxo): void

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:81

Add a UTXO to the provider

Parameters​

utxo​

UTXO

Returns​

void

Implementation of​

UtxoProvider.addNewUTXO

broadcast()​

broadcast(txHex): Promise\<string>

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:186

Send a raw transaction hex string.

Parameters​

txHex​

string

Returns​

Promise\<string>

A promise which resolves to the hash of the transaction that has been sent.

Implementation of​

ChainProvider.broadcast

getConfirmations()​

getConfirmations(txId): Promise\<number>

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:103

Query a transaction confirmation

Parameters​

txId​

string

Returns​

Promise\<number>

Implementation of​

ChainProvider.getConfirmations

getFeeRate()​

getFeeRate(): Promise\<number>

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:85

Query current network fee

Returns​

Promise\<number>

Implementation of​

ChainProvider.getFeeRate

getNetwork()​

getNetwork(): Promise\<SupportedNetwork>

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:20

Get the current network the provider is connected to.

Returns​

Promise\<SupportedNetwork>

A promise which resolves to the current network identifier.

Implementation of​

ChainProvider.getNetwork

getRawTransaction()​

getRawTransaction(txId): Promise\<string>

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:195

Get a transaction raw hex from the network.

Parameters​

txId​

string

Returns​

Promise\<string>

The query result with the transaction raw hex.

Implementation of​

ChainProvider.getRawTransaction

getUtxos()​

getUtxos(address, _options?): Promise\<UTXO[]>

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:24

Get a list of the UTXOs.

Parameters​

address​

string

The address of the returned UTXOs belongs to.

_options?​

UtxoQueryOptions

Returns​

Promise\<UTXO[]>

A promise which resolves to a list of UTXO for the query options.

Implementation of​

UtxoProvider.getUtxos

markSpent()​

markSpent(txId, vout): void

Defined in: packages/scrypt-ts-opcat/src/providers/mempoolProvider.ts:74

Mark an outpoint as spent

Parameters​

txId​

string

vout​

number

Returns​

void

Implementation of​

UtxoProvider.markSpent