Skip to main content

RPCProvider

bitcoinjs-lib v0.2.9-beta.16

bitcoinjs-lib / RPCProvider

Class: RPCProvider

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:12

The RPCProvider is backed by [bitcoin RPC][https://developer.bitcoin.org/reference/rpc/](https://developer.bitcoin.org/reference/rpc/)

Implements​

Constructors​

new RPCProvider()​

new RPCProvider(url, walletName, username, password): RPCProvider

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:18

Parameters​

url​

string

walletName​

string

username​

string

password​

string

Returns​

RPCProvider

Properties​

password​

readonly password: string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:22

url​

readonly url: string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:19

username​

readonly username: string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:21

walletName​

readonly walletName: string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:20

Methods​

addNewUTXO()​

addNewUTXO(utxo): void

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:292

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-btc/src/providers/rpcProvider.ts:170

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-btc/src/providers/rpcProvider.ts:75

Query a transaction confirmation

Parameters​

txId​

string

Returns​

Promise\<number>

Implementation of​

ChainProvider.getConfirmations

getFeeRate()​

getFeeRate(): Promise\<number>

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:24

Query current network fee

Returns​

Promise\<number>

Implementation of​

ChainProvider.getFeeRate

getRawTransaction()​

getRawTransaction(txId): Promise\<string>

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:179

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

getRpcPassword()​

protected getRpcPassword(): string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:68

Returns​

string

getRpcUrl()​

protected getRpcUrl(walletName): string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:71

Parameters​

walletName​

string

Returns​

string

getRpcUser()​

protected getRpcUser(): string

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:65

Returns​

string

getUtxos()​

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

Defined in: packages/scrypt-ts-btc/src/providers/rpcProvider.ts:229

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-btc/src/providers/rpcProvider.ts:285

Mark an outpoint as spent

Parameters​

txId​

string

vout​

number

Returns​

void

Implementation of​

UtxoProvider.markSpent