Class: BitcoinRestClient ​
Defined in: packages/bitcoin/src/client/rest/index.ts:14
Implements a strongly-typed BitcoinRestClient to connect to remote bitcoin node via REST API. BitcoinRestClient
Constructors ​
Constructor ​
new BitcoinRestClient(
config):BitcoinRestClient
Defined in: packages/bitcoin/src/client/rest/index.ts:46
Parameters ​
config ​
Returns ​
BitcoinRestClient
Properties ​
address ​
address:
BitcoinAddress
Defined in: packages/bitcoin/src/client/rest/index.ts:38
The api calls related to bitcoin addresses.
api() ​
api: (
params) =>Promise<any>
Defined in: packages/bitcoin/src/client/rest/index.ts:44
The API call method that can be used to make requests to the REST API.
Parameters ​
params ​
Returns ​
Promise<any>
A promise resolving to the response data.
block ​
block:
BitcoinBlock
Defined in: packages/bitcoin/src/client/rest/index.ts:32
The api calls related to bitcoin blocks.
transaction ​
transaction:
BitcoinTransaction
Defined in: packages/bitcoin/src/client/rest/index.ts:26
The api calls related to bitcoin transactions.
Methods ​
connect() ​
staticconnect(config?):BitcoinRestClient
Defined in: packages/bitcoin/src/client/rest/index.ts:73
Static method connects to a bitcoin node running a esplora REST API.
Parameters ​
config? ​
The configuration object for the client (optional).
Returns ​
BitcoinRestClient
A new BitcoinRestClient instance.
Example ​
const rest = BitcoinRestClient.connect();