Skip to main content
To get started, install the latest version of the core Bigmi package.

Installation

Configuration

Client Configuration

The client is the core of Bigmi. Here’s how to configure it:

Parameters

Transport Configuration

Bigmi supports JSON-RPC endpoints that are consumed via HTTP. Bigmi also contains transports that wrap the Blockchair, Blockcypher, Ankr, and Mempool APIs for blockchain read operations. Most of these transports are free to use with API limits. They can be configured with an apiKey and baseUrl for production-ready use cases. It is recommended to use the fallback transport that wraps multiple transports for better reliability.

UTXO-API Transport Parameters

These include the API-based transports blockchair, ankr, mempool, and blockcypher.
As these are wrappers around the HTTP transport, they can also be configured with any of the HTTP Transport Config parameters.

HTTP Transport Config Parameters

Fallback Transport Config Parameters

Chain Configuration

Bigmi comes with mainnet and signet chain definitions.

Custom chains

Custom chains can be created using the defineChain util.

Actions

Bigmi contains many functions called actions that can be used to perform various blockchain operations.

Reading blockchain data

Creating and sending Bitcoin transactions