Skip to main content

Module provider

Module provider 

Source
Expand description

Interfaces and implementations for interacting with blockchain nodes and APIs.

Modules§

core
Core provider traits and information structs used to define general blockchain interaction interfaces.
error
Provider-specific error enumerations for handling transmission, retrieval, or interpretation issues.
esplora
Types and definitions for interacting specifically with an Esplora REST API provider backend.
network
Definitions distinguishing blockchain network states (e.g. mainnet, testnet, regtest) and related configurations.
rpc
Submodules and definitions handling direct JSON-RPC interfacing with backing Bitcoin/Elements core nodes.
simplex
Abstractions and composite providers intended for general usage in the Simplex SDK.

Structs§

ElementsRpc
A lightweight wrapper around the standard bitcoincore_rpc Client providing Elements-specific functionality.
EsploraProvider
A provider implementation that interacts with the Esplora REST API backend.
ProviderInfo
Contains foundational configuration elements required for initializing a generic blockchain provider.
SimplexProvider
A local provider used during Regtest or local development. It wraps an EsploraProvider for REST API queries and an ElementsRpc for direct node interactions.

Enums§

ProviderError
Defines standard errors possible when using a blockchain interaction provider.
RpcError
Errors that can occur when calling JSON-RPC methods on a Bitcoin Core or Elements node.
SimplicityNetwork
Represents the target network configuration for Simplicity interactions.

Statics§

LIQUID_MAINNET_GENESIS
The genesis block hash for Liquid mainnet.
LIQUID_REGTEST_GENESIS
The genesis block hash for Elements regtest environments.
LIQUID_TESTNET_BITCOIN_ASSET
The default Bitcoin AssetId used on Liquid testnet.
LIQUID_TESTNET_GENESIS
The genesis block hash for Liquid testnet.

Traits§

ProviderTrait
Baseline traits detailing required interaction methods between the SDK client and the underlying blockchain node or API.