Skip to content

Reference

Account

NameTypeDescription
addressstringThe address of the account
addressTypeAddressTypeThe type of the address
publicKeystringThe public key of the account
purposeAddressPurposeThe purpose of the address

AddressType (enum)

NameValue
P2SH_P2WPKH"p2sh_p2wpkh"
P2WPKH"p2wpkh"
P2TR"p2tr"

AddressPurpose (enum)

NameValue
Ordinals"Ordinals"
Payment"Payment"

Config

NameTypeDescription
networksBitcoinNetwork[]The available Bitcoin networks
connectorsConnector[]The available connectors
currentConnectionConnector | undefinedThe current connection
networkBitcoinNetworkThe current Bitcoin network
setState(state: Partial<ConfigState>) => voidSets the configuration state
getState() => ConfigStateGets the current configuration state
subscribe(callback: (newState: ConfigState | undefined) => void) => () => voidSubscribes to configuration changes

NetworkConfig

NameTypeDescription
namestringThe display name of the network
networkBitcoinNetwork["id"]The network ID (from BitcoinNetwork)
rpcUrlstringThe RPC URL for the network
indexerUrlstringThe indexer URL for the network