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§
- Elements
Rpc - A lightweight wrapper around the standard
bitcoincore_rpcClientproviding Elements-specific functionality. - Esplora
Provider - A provider implementation that interacts with the Esplora REST API backend.
- Provider
Info - Contains foundational configuration elements required for initializing a generic blockchain provider.
- Simplex
Provider - A local provider used during Regtest or local development.
It wraps an
EsploraProviderfor REST API queries and anElementsRpcfor direct node interactions.
Enums§
- Provider
Error - 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.
- Simplicity
Network - 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
AssetIdused on Liquid testnet. - LIQUID_
TESTNET_ GENESIS - The genesis block hash for Liquid testnet.
Traits§
- Provider
Trait - Baseline traits detailing required interaction methods between the SDK client and the underlying blockchain node or API.