@electrum-cash/network 4.0.0-development.6655313659 → 4.0.0-development.8017810652

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from "events";
+import { ElectrumSocket } from "@electrum-cash/sockets";
 type RPCParameter = string | number | boolean | null;
 interface RPCBase {
     jsonrpc: string;
@@ -47,69 +48,51 @@ export enum ConnectionStatus {
     CONNECTING = 3,
     RECONNECTING = 4
 }
-export interface ClientConfig {
-    state: ClientState;
-    connection: ElectrumClient;
-}
 /**
  * A list of possible responses to requests.
+ * @ignore
  */
 export type RequestResponse = object | string | number | boolean | null | RequestResponse[];
+/**
+ * Request resolvers are used to process the response of a request. This takes either
+ * an error object or any stringified data, while the other parameter is omitted.
+ * @ignore
+ */
 export type RequestResolver = (error?: Error, data?: string) => void;
+/**
+ * Typing for promise resolution.
+ * @ignore
+ */
 export type ResolveFunction<T> = (value: T | PromiseLike<T>) => void;
+/**
+ * Typing for promise rejection.
+ * @ignore
+ */
 export type RejectFunction = (reason?: any) => void;
+/**
+ * @ignore
+ */
 export interface VersionRejected {
     error: RPCError;
 }
+/**
+ * @ignore
+ */
 export interface VersionNegotiated {
     software: string;
     protocol: string;
 }
-export const isVersionRejected: (object: any) => object is VersionRejected;
-export const isVersionNegotiated: (object: any) => object is VersionNegotiated;
 /**
- * Possible Transport Schemes for communication with the Electrum server
+ * @ignore
  */
-export type TransportScheme = 'tcp' | 'tcp_tls' | 'ws' | 'wss';
-export interface ConnectionOptions {
-    rejectUnauthorized?: boolean;
-    serverName?: string;
-}
+export const isVersionRejected: (object: any) => object is VersionRejected;
 /**
- * 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);
- *
- * @property {object} TCP       Port and Scheme to use unencrypted TCP sockets.
- * @property {object} TCP_TLS   Port and Scheme to use TLS-encrypted TCP sockets.
- * @property {object} WS        Port and Scheme to use unencrypted WebSockets.
- * @property {object} WSS       Port and Scheme to use TLS-encrypted WebSockets.
+ * @ignore
  */
-export const ElectrumTransport: {
-    TCP: {
-        Port: number;
-        Scheme: TransportScheme;
-    };
-    TCP_TLS: {
-        Port: number;
-        Scheme: TransportScheme;
-    };
-    WS: {
-        Port: number;
-        Scheme: TransportScheme;
-    };
-    WSS: {
-        Port: number;
-        Scheme: TransportScheme;
-    };
-};
-export const DefaultParameters: {
-    PORT: number;
-    TRANSPORT_SCHEME: TransportScheme;
-    RECONNECT: number;
-    TIMEOUT: number;
-    PING_INTERVAL: number;
-    USE_BIG_INT: boolean;
-};
+export const isVersionNegotiated: (object: any) => object is VersionNegotiated;
+export const DEFAULT_PING_INTERVAL: number;
+export const DEFAULT_RECONNECT_INTERVAL: number;
+export const DEFAULT_BIG_INTEGERS = false;
 /**
  * Triggers when the underlying connection is established.
  *
@@ -131,10 +114,7 @@ export const DefaultParameters: {
 export class ElectrumClient extends EventEmitter {
     application: string;
     version: string;
-    host: string;
-    port: number;
-    scheme: TransportScheme;
-    timeout: number;
+    socketOrHostname: ElectrumSocket | string;
     pingInterval: number;
     reconnectInterval: number;
     useBigInt: boolean;
@@ -163,19 +143,18 @@ export class ElectrumClient extends EventEmitter {
     /**
      * Initializes an Electrum client.
      *
-     * @param {string} application            your application name, used to identify to the electrum host.
-     * @param {string} version                protocol version to use with the host.
-     * @param {string} host                   fully qualified domain name or IP number of the host.
-     * @param {number} port                   the TCP network port of the host.
-     * @param {TransportScheme} scheme        the transport scheme to use for connection
-     * @param {number} timeout                how long network delays we will wait for before taking action, in milliseconds.
-     * @param {number} pingInterval           the time between sending pings to the electrum host, in milliseconds.
-     * @param {number} reconnectInterval      the time between reconnection attempts to the electrum host, in milliseconds.
-     * @param {boolean} useBigInt			  whether to use bigint for numbers in json response.
+     * @param application       - your application name, used to identify to the electrum host.
+     * @param version           - protocol version to use with the host.
+     * @param socketOrHostname  - pre-configured electrum socket or fully qualified domain name or IP number of the host
+     * @param pingInterval      - the time between sending pings to the electrum host, in milliseconds.
+     * @param reconnectInterval - the time between reconnection attempts to the electrum host, in milliseconds.
+     * @param useBigInt         - whether to use bigint for numbers in json response.
      *
      * @throws {Error} if `version` is not a valid version string.
      */
-    constructor(application: string, version: string, host: string, port?: number, scheme?: TransportScheme, timeout?: number, pingInterval?: number, reconnectInterval?: number, useBigInt?: boolean);
+    constructor(application: string, version: string, socketOrHostname: ElectrumSocket | string, pingInterval?: number, reconnectInterval?: number, useBigInt?: boolean);
+    get hostIdentifier(): string;
+    get encrypted(): boolean;
     /**
      * Connects to the remote server.
      *
@@ -186,8 +165,8 @@ export class ElectrumClient extends EventEmitter {
     /**
      * Disconnects from the remote server and removes all event listeners/subscriptions and open requests.
      *
-     * @param {boolean} force                 disconnect even if the connection has not been fully established yet.
-     * @param {boolean} retainSubscriptions   retain subscription data so they will be restored on reconnection.
+     * @param force               - disconnect even if the connection has not been fully established yet.
+     * @param retainSubscriptions - retain subscription data so they will be restored on reconnection.
      *
      * @returns true if successfully disconnected, or false if there was no connection.
      */
@@ -195,8 +174,8 @@ export class ElectrumClient extends EventEmitter {
     /**
      * Calls a method on the remote server with the supplied parameters.
      *
-     * @param {string} method          name of the method to call.
-     * @param {...string} parameters   one or more parameters for the method.
+     * @param method     - name of the method to call.
+     * @param parameters - one or more parameters for the method.
      *
      * @throws {Error} if the client is disconnected.
      * @returns a promise that resolves with the result of the method or an Error.
@@ -207,8 +186,8 @@ export class ElectrumClient extends EventEmitter {
      *
      * @note the response for the subscription request is issued as a notification event.
      *
-     * @param {string}    method       one of the subscribable methods the server supports.
-     * @param {...string} parameters   one or more parameters for the method.
+     * @param method     - one of the subscribable methods the server supports.
+     * @param parameters - one or more parameters for the method.
      *
      * @throws {Error} if the client is disconnected.
      * @returns a promise resolving when the subscription is established.
@@ -218,8 +197,8 @@ export class ElectrumClient extends EventEmitter {
      * Unsubscribes to the method at the server and removes any callback functions
      * when there are no more subscriptions for the method.
      *
-     * @param {string}    method       a previously subscribed to method.
-     * @param {...string} parameters   one or more parameters for the method.
+     * @param method     - a previously subscribed to method.
+     * @param parameters - one or more parameters for the method.
      *
      * @throws {Error} if no subscriptions exist for the combination of the provided `method` and `parameters.
      * @throws {Error} if the client is disconnected.
@@ -229,7 +208,7 @@ export class ElectrumClient extends EventEmitter {
     /**
      * Parser messages from the remote server to resolve request promises and emit subscription events.
      *
-     * @param {RPCNotification | RPCResponse} message   the response message
+     * @param message - the response message
      *
      * @throws {Error} if the message ID does not match an existing request.
      * @ignore

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"mappings":";ACCA,oBAA2B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAG5D;IAEC,OAAO,EAAE,MAAM,CAAC;CAChB;AAGD,yBAAiC,SAAQ,OAAO;IAE/C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAWD,sBAA8B,SAAQ,OAAO;IAE5C,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;IAEC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACX;AAGD,0BAAkC,SAAQ,OAAO;IAEhD,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;CAChB;AAGD,mBAA0B,gBAAgB,GAAG,YAAY,CAAC;AE3C1D;;;;;GAKG;AACH;IAEC,WAAW,IAAI;IACf,SAAS,IAAI;CACb;AAED;;;;;;;;GAQG;AACH;IAEC,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,UAAU,IAAI;IACd,YAAY,IAAI;CAChB;AC3BD;IAGC,KAAK,EAAE,WAAW,CAAC;IAGnB,UAAU,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,8BAA8B,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,eAAe,EAAE,CAAC;AAI5F,8BAA8B,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAGrE,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AACrE,6BAA6B,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;AAEpD;IAEC,KAAK,EAAE,QAAQ,CAAC;CAChB;AAED;IAEC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,OAAO,MAAM,4BAAqC,GAAG,8BAGpD,CAAC;AAEF,OAAO,MAAM,8BAAuC,GAAG,gCAGtD,CAAC;AAEF;;GAEG;AACH,8BAA8B,KAAK,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC;AAG/D;IAEC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;ACvDD;;;;;;;;GAQG;AACH,OAAO,MAAM;;;;;;;;;;;;;;;;;CAMZ,CAAC;AAEF,OAAO,MAAM;;;;;;;CAoBZ,CAAC;AG7BF;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;GAEG;AACH,2BAAqB,SAAQ,YAAY;IA4DhC,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,eAAe;IACvB,OAAO,EAAE,MAAM;IACf,YAAY,EAAE,MAAM;IACpB,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,OAAO;IAlE1B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACI,qBAAqB,EAAE,MAAM,CAAC;IAErC;;OAEG;IACI,MAAM,EAAE,gBAAgB,CAAiC;IAiBhE;;;;;;;;;;;;;;OAcG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,MAA+B,EACrC,MAAM,GAAE,eAAoD,EAC5D,OAAO,GAAE,MAAkC,EAC3C,YAAY,GAAE,MAAwC,EACtD,iBAAiB,GAAE,MAAoC,EACvD,SAAS,GAAE,OAAuC;IAU1D;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA0C9B;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,GAAE,OAAe,EAAE,mBAAmB,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAehG;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;IAgD9F;;;;;;;;;;OAUG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B7E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgF/E;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IA0DtD;;;;;OAKG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB7C;;;;OAIG;IACG,oBAAoB,CAAC,gBAAgB,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;IAa3D;;;;OAIG;IACG,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC;IAMlD;;;;;OAKG;IACG,yCAAyC,CAAC,OAAO,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvE;;;;;OAKG;IACG,oCAAoC,CAAC,OAAO,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBlE;;OAEG;IACG,6BAA6B,CAAC,SAAS,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ7D","sources":["source/source/util.ts","source/source/rpc-interfaces.ts","source/source/electrum-protocol.ts","source/source/enums.ts","source/source/interfaces.ts","source/source/constants.ts","source/source/electrum-socket.ts","source/source/electrum-connection.ts","source/source/electrum-client.ts","source/source/index.ts","source/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,"export { default as ElectrumClient } from './electrum-client';\n\nexport * from './interfaces';\nexport * from './constants';\nexport * from './enums';\n"],"names":[],"version":3,"file":"index.d.ts.map"}
+{"mappings":";;AACA,oBAA2B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAG5D;IAEC,OAAO,EAAE,MAAM,CAAC;CAChB;AAGD,yBAAiC,SAAQ,OAAO;IAE/C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAWD,sBAA8B,SAAQ,OAAO;IAE5C,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;IAEC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;CACX;AAGD,0BAAkC,SAAQ,OAAO;IAEhD,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;CAChB;AAGD,mBAA0B,gBAAgB,GAAG,YAAY,CAAC;AE3C1D;;;;;GAKG;AACH;IAEC,WAAW,IAAI;IACf,SAAS,IAAI;CACb;AAED;;;;;;;;GAQG;AACH;IAEC,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,UAAU,IAAI;IACd,YAAY,IAAI;CAChB;AC3BD;;;GAGG;AACH,8BAA8B,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,eAAe,EAAE,CAAC;AAE5F;;;;GAIG;AACH,8BAA8B,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAErE;;;GAGG;AACH,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAErE;;;GAGG;AACH,6BAA6B,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;AAEpD;;GAEG;AACH;IAEC,KAAK,EAAE,QAAQ,CAAC;CAChB;AAED;;GAEG;AACH;IAEC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,OAAO,MAAM,4BAAqC,GAAG,8BAGpD,CAAC;AAEF;;GAEG;AACH,OAAO,MAAM,8BAAuC,GAAG,gCAGtD,CAAC;AC1DF,OAAO,MAAM,6BAAgC,CAAC;AAG9C,OAAO,MAAM,kCAAqC,CAAC;AAGnD,OAAO,MAAM,4BAA4B,CAAC;AEI1C;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;GAEG;AACH,2BAAqB,SAAQ,YAAY;IAyDhC,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,gBAAgB,EAAE,cAAc,GAAG,MAAM;IACzC,YAAY,EAAE,MAAM;IACpB,iBAAiB,EAAE,MAAM;IACzB,SAAS,EAAE,OAAO;IA5D1B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACI,qBAAqB,EAAE,MAAM,CAAC;IAErC;;OAEG;IACI,MAAM,EAAE,gBAAgB,CAAiC;IAiBhE;;;;;;;;;;;OAWG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,cAAc,GAAG,MAAM,EACzC,YAAY,GAAE,MAA8B,EAC5C,iBAAiB,GAAE,MAAmC,EACtD,SAAS,GAAE,OAA8B;IAWjD,IAAI,cAAc,IAAI,MAAM,CAG3B;IAGD,IAAI,SAAS,IAAI,OAAO,CAGvB;IAED;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA0C9B;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,GAAE,OAAe,EAAE,mBAAmB,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAehG;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC;IAgD9F;;;;;;;;;;OAUG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B7E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgF/E;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,WAAW,GAAG,IAAI;IA0DtD;;;;;OAKG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB7C;;;;OAIG;IACG,oBAAoB,CAAC,gBAAgB,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;IAa3D;;;;OAIG;IACG,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC;IAMlD;;;;;OAKG;IACG,yCAAyC,CAAC,OAAO,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvE;;;;;OAKG;IACG,oCAAoC,CAAC,OAAO,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBlE;;OAEG;IACG,6BAA6B,CAAC,SAAS,KAAA,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ7D","sources":["source/source/rpc-interfaces.ts","source/source/electrum-protocol.ts","source/source/enums.ts","source/source/interfaces.ts","source/source/constants.ts","source/source/electrum-connection.ts","source/source/electrum-client.ts","source/source/index.ts","source/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,"export { default as ElectrumClient } from './electrum-client';\n\nexport * from './interfaces';\nexport * from './constants';\nexport * from './enums';\n"],"names":[],"version":3,"file":"index.d.ts.map"}