ElectrumApi

The ElectrumxApi provides methods to simplify interacting with Electrumx endpoints.

Return value

All values returned by ElectrumxApi's methods are wrapped in a ToResult<T> type.

type ToResult<T> = [Error | {
    code: number
    message: string
} | any, undefined] | [null, T]

This guide assumes all methods execute successfully without errors. And all Result in the examples are success values from ToResult<T>.

Endpoints

The atomicals-electrumx define the following atomicals related endpoints: