Global

Members

ClientState :number

Properties:
Name Type Description
UNAVAILABLE 0 The client is currently not available.
AVAILABLE 1 The client is available for use.
Enum that denotes the availability of an ElectrumClient.
Type:
  • number

ClusterDistribution :number

Properties:
Name Type Description
ALL 0 Send requests to all servers in the cluster.
Enum that denotes the distribution setting to use in an ElectrumCluster.
Type:
  • number

ClusterOrder :number

Properties:
Name Type Description
RANDOM 0 Send requests to randomly selected servers in the cluster.
PRIORITY 1 Send requests to servers in the cluster in the order they were added.
Enum that denotes the ordering to use in an ElectrumCluster.
Type:
  • number

ClusterStatus :number

Properties:
Name Type Description
DISABLED 0 The cluster is disabled and unusable.
DEGRADED 1 The cluster is degraded but still usable.
READY 2 The cluster is healthy and ready for use.
Enum that denotes the ready status of an ElectrumCluster.
Type:
  • number

ConnectionStatus :number

Properties:
Name Type Description
DISCONNECTED 0 The connection is disconnected.
AVAILABLE 1 The connection is connected.
DISCONNECTING 2 The connection is disconnecting.
CONNECTING 3 The connection is connecting.
RECONNECTING 4 The connection is restarting.
Enum that denotes the connection status of an ElectrumConnection.
Type:
  • number

(constant) ElectrumTransport

Properties:
Name Type Description
TCP object Port and Scheme to use unencrypted TCP sockets.
TCP_TLS object Port and Scheme to use TLS-encrypted TCP sockets.
WS object Port and Scheme to use unencrypted WebSockets.
WSS object Port and Scheme to use TLS-encrypted WebSockets.
Object containing the commonly used ports and schemes for specific Transports.
Example
const electrum = new ElectrumClient('Electrum client example', '1.4.1', 'bch.imaginary.cash', Transport.WSS.Port, Transport.WSS.Scheme);