@electrum-cash/network 4.1.4-development.11641455551 → 4.1.4-development.12704171077

package/dist/index.d.ts

@@ -1,413 +0,0 @@
-import { EventEmitter } from "eventemitter3";
-type RPCParameter = string | number | boolean | object | null;
-type RCPIdentifier = number | string | null;
-interface RPCBase {
-    jsonrpc: string;
-}
-interface RPCNotification extends RPCBase {
-    method: string;
-    params?: RPCParameter[];
-}
-interface RPCStatement extends RPCBase {
-    id: RCPIdentifier;
-    result: string;
-}
-interface RPCError {
-    code: number;
-    message: string;
-    data?: any;
-}
-interface RPCErrorResponse extends RPCBase {
-    id: RCPIdentifier;
-    error: RPCError;
-}
-type RPCResponse = RPCErrorResponse | RPCStatement | RPCNotification;
-/**
- * Optional settings that change the default behavior of the network connection.
- */
-export interface ElectrumNetworkOptions {
-    /** If set to true, numbers that can safely be parsed as integers will be `BigInt` rather than `Number`. */
-    useBigInt?: boolean;
-    /** When connected, send a keep-alive Ping message this often. */
-    sendKeepAliveIntervalInMilliSeconds?: number;
-    /** When disconnected, attempt to reconnect after this amount of time. */
-    reconnectAfterMilliSeconds?: number;
-    /** After every send, verify that we have received data after this amount of time. */
-    verifyConnectionTimeoutInMilliSeconds?: number;
-    /** Turn off automatic handling of browser visibility, which disconnects when application is not visible to be consistent across browsers.  */
-    disableBrowserVisibilityHandling?: boolean;
-    /** Turn off automatic handling of browser connectivity. */
-    disableBrowserConnectivityHandling?: boolean;
-}
-/**
- * List of events emitted by the ElectrumSocket.
- * @event
- * @ignore
- */
-export interface ElectrumSocketEvents {
-    /**
-     * Emitted when data has been received over the socket.
-     * @eventProperty
-     */
-    'data': [string];
-    /**
-     * Emitted when a socket connects.
-     * @eventProperty
-     */
-    'connected': [];
-    /**
-     * Emitted when a socket disconnects.
-     * @eventProperty
-     */
-    'disconnected': [];
-    /**
-     * Emitted when the socket has failed in some way.
-     * @eventProperty
-     */
-    'error': [Error];
-}
-/**
- * Abstract socket used when communicating with Electrum servers.
- */
-export interface ElectrumSocket extends EventEmitter<ElectrumSocketEvents>, ElectrumSocketEvents {
-    /**
-     * Utility function to provide a human accessible host identifier.
-     */
-    get hostIdentifier(): string;
-    /**
-     * Fully qualified domain name or IP address of the host
-     */
-    host: string;
-    /**
-     * Network port for the host to connect to, defaults to the standard TLS port
-     */
-    port: number;
-    /**
-     * If false, uses an unencrypted connection instead of the default on TLS
-     */
-    encrypted: boolean;
-    /**
-     * If no connection is established after `timeout` ms, the connection is terminated
-     */
-    timeout: number;
-    /**
-     * Connects to an Electrum server using the socket.
-     */
-    connect(): void;
-    /**
-     * Disconnects from the Electrum server from the socket.
-     */
-    disconnect(): void;
-    /**
-     * Write data to the Electrum server on the socket.
-     *
-     * @param data     - Data to be written to the socket
-     * @param callback - Callback function to be called when the write has completed
-     */
-    write(data: Uint8Array | string, callback?: (err?: Error) => void): boolean;
-}
-/**
- * @ignore
- */
-export interface VersionRejected {
-    error: RPCError;
-}
-/**
- * @ignore
- */
-export interface VersionNegotiated {
-    software: string;
-    protocol: string;
-}
-/**
- * @ignore
- */
-export type VersionNegotiationResponse = VersionNegotiated | VersionRejected;
-/**
- * List of events emitted by the ElectrumConnection.
- * @event
- * @ignore
- */
-export interface ElectrumConnectionEvents {
-    /**
-     * Emitted when any data has been received over the network.
-     * @eventProperty
-     */
-    'received': [];
-    /**
-     * Emitted when a complete electrum message has been received over the network.
-     * @eventProperty
-     */
-    'response': [RPCResponse];
-    /**
-     * Emitted when the connection has completed version negotiation.
-     * @eventProperty
-     */
-    'version': [VersionNegotiationResponse];
-    /**
-     * Emitted when a network connection is initiated.
-     * @eventProperty
-     */
-    'connecting': [];
-    /**
-     * Emitted when a network connection is successful.
-     * @eventProperty
-     */
-    'connected': [];
-    /**
-     * Emitted when a network disconnection is initiated.
-     * @eventProperty
-     */
-    'disconnecting': [];
-    /**
-     * Emitted when a network disconnection is successful.
-     * @eventProperty
-     */
-    'disconnected': [];
-    /**
-     * Emitted when a network connect attempts to automatically reconnect.
-     * @eventProperty
-     */
-    'reconnecting': [];
-    /**
-     * Emitted when the network has failed in some way.
-     * @eventProperty
-     */
-    'error': [Error];
-}
-/**
- * List of events emitted by the ElectrumClient.
- * @event
- * @ignore
- */
-export interface ElectrumClientEvents {
-    /**
-     * Emitted when an electrum subscription statement has been received over the network.
-     * @eventProperty
-     */
-    'notification': [RPCNotification];
-    /**
-     * Emitted when a network connection is initiated.
-     * @eventProperty
-     */
-    'connecting': [];
-    /**
-     * Emitted when a network connection is successful.
-     * @eventProperty
-     */
-    'connected': [];
-    /**
-     * Emitted when a network disconnection is initiated.
-     * @eventProperty
-     */
-    'disconnecting': [];
-    /**
-     * Emitted when a network disconnection is successful.
-     * @eventProperty
-     */
-    'disconnected': [];
-    /**
-     * Emitted when a network connect attempts to automatically reconnect.
-     * @eventProperty
-     */
-    'reconnecting': [];
-    /**
-     * Emitted when the network has failed in some way.
-     * @eventProperty
-     */
-    'error': [Error];
-}
-/**
- * A list of possible responses to requests.
- * @ignore
- */
-export type RequestResponse = RPCParameter | RPCParameter[];
-/**
- * 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 const isVersionRejected: (object: any) => object is VersionRejected;
-/**
- * @ignore
- */
-export const isVersionNegotiated: (object: any) => object is VersionNegotiated;
-/**
- * Enum that denotes the connection status of an ElectrumConnection.
- * @enum {number}
- * @property {0} DISCONNECTED    The connection is disconnected.
- * @property {1} AVAILABLE       The connection is connected.
- * @property {2} DISCONNECTING   The connection is disconnecting.
- * @property {3} CONNECTING      The connection is connecting.
- * @property {4} RECONNECTING    The connection is restarting.
- */
-export enum ConnectionStatus {
-    DISCONNECTED = 0,
-    CONNECTED = 1,
-    DISCONNECTING = 2,
-    CONNECTING = 3,
-    RECONNECTING = 4
-}
-/**
- * High-level Electrum client that lets applications send requests and subscribe to notification events from a server.
- */
-export class ElectrumClient<ElectrumEvents extends ElectrumClientEvents> extends EventEmitter<ElectrumClientEvents | ElectrumEvents> implements ElectrumClientEvents {
-    application: string;
-    version: string;
-    socketOrHostname: ElectrumSocket | string;
-    options: ElectrumNetworkOptions;
-    /**
-     * The name and version of the server software indexing the blockchain.
-     */
-    software: string;
-    /**
-     * The genesis hash of the blockchain indexed by the server.
-     * @remarks This is only available after a 'server.features' call.
-     */
-    genesisHash: string;
-    /**
-     * The chain height of the blockchain indexed by the server.
-     * @remarks This is only available after a 'blockchain.headers.subscribe' call.
-     */
-    chainHeight: number;
-    /**
-     * Timestamp of when we last received data from the server indexing the blockchain.
-     */
-    lastReceivedTimestamp: number;
-    /**
-     * Number corresponding to the underlying connection status.
-     */
-    get status(): ConnectionStatus;
-    /**
-     * Initializes an Electrum client.
-     *
-     * @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 options           - ...
-     *
-     * @throws {Error} if `version` is not a valid version string.
-     */
-    constructor(application: string, version: string, socketOrHostname: ElectrumSocket | string, options?: ElectrumNetworkOptions);
-    get hostIdentifier(): string;
-    get encrypted(): boolean;
-    /**
-     * Connects to the remote server.
-     *
-     * @throws {Error} if the socket connection fails.
-     * @returns a promise resolving when the connection is established.
-     */
-    connect(): Promise<void>;
-    /**
-     * Disconnects from the remote server and removes all event listeners/subscriptions and open requests.
-     *
-     * @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.
-     */
-    disconnect(force?: boolean, retainSubscriptions?: boolean): Promise<boolean>;
-    /**
-     * Calls a method on the remote server with the supplied parameters.
-     *
-     * @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.
-     */
-    request(method: string, ...parameters: RPCParameter[]): Promise<Error | RequestResponse>;
-    /**
-     * Subscribes to the method and payload at the server.
-     *
-     * @remarks the response for the subscription request is issued as a notification event.
-     *
-     * @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.
-     */
-    subscribe(method: string, ...parameters: RPCParameter[]): Promise<void>;
-    /**
-     * Unsubscribes to the method at the server and removes any callback functions
-     * when there are no more subscriptions 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.
-     * @returns a promise resolving when the subscription is removed.
-     */
-    unsubscribe(method: string, ...parameters: RPCParameter[]): Promise<void>;
-    /**
-     * Parser messages from the remote server to resolve request promises and emit subscription events.
-     *
-     * @param message - the response message
-     *
-     * @throws {Error} if the message ID does not match an existing request.
-     * @ignore
-     */
-    response(message: RPCResponse): void;
-    /**
-     * Callback function that is called when connection to the Electrum server is lost.
-     * Aborts all active requests with an error message indicating that connection was lost.
-     *
-     * @ignore
-     */
-    onConnectionDisconnect(): Promise<void>;
-    /**
-     * Stores the server provider software version field on successful version negotiation.
-     *
-     * @ignore
-     */
-    storeSoftwareVersion(versionStatement: any): Promise<void>;
-    /**
-     * Updates the last received timestamp.
-     *
-     * @ignore
-     */
-    updateLastReceivedTimestamp(): Promise<void>;
-    /**
-     * Checks if the provided message is a response to a headers subscription,
-     * and if so updates the locally stored chain height value for this client.
-     *
-     * @ignore
-     */
-    updateChainHeightFromHeadersNotifications(message: any): Promise<void>;
-    /**
-     * Checks if the provided message is a response to a server.features request,
-     * and if so stores the genesis hash for this client locally.
-     *
-     * @ignore
-     */
-    storeGenesisHashFromFeaturesResponse(message: any): Promise<void>;
-    /**
-     * Helper function to synchronize state and events with the underlying connection.
-     */
-    handleConnectionStatusChanges(eventName: any): Promise<void>;
-    readonly connecting: [];
-    readonly connected: [];
-    readonly disconnecting: [];
-    readonly disconnected: [];
-    readonly reconnecting: [];
-    readonly notification: [RPCNotification];
-    readonly error: [Error];
-}
-
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"mappings":";AACA,oBAA2B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;AAGrE,qBAA4B,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAGnD;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,aAAa,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,aAAa,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;CAChB;AAGD,mBAA0B,gBAAgB,GAAG,YAAY,GAAG,eAAe,CAAC;AE9C5E;;GAEG;AACH;IAEC,2GAA2G;IAC3G,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,iEAAiE;IACjE,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C,yEAAyE;IACzE,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,qFAAqF;IACrF,qCAAqC,CAAC,EAAE,MAAM,CAAC;IAE/C,8IAA8I;IAC9I,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C,2DAA2D;IAC3D,kCAAkC,CAAC,EAAE,OAAO,CAAC;CAC7C;AAED;;;;GAIG;AACH;IAEC;;;OAGG;IACH,MAAM,EAAE,CAAE,MAAM,CAAE,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,EAAE,CAAC;IAEhB;;;OAGG;IACH,cAAc,EAAE,EAAE,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,CAAE,KAAK,CAAE,CAAC;CACnB;AAED;;GAEG;AACH,+BAAgC,SAAQ,aAAa,oBAAoB,CAAC,EAAE,oBAAoB;IAE/F;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;CAC5E;AAED;;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,yCAAyC,iBAAiB,GAAG,eAAe,CAAC;AAE7E;;;;GAIG;AACH;IAEC;;;OAGG;IACH,UAAU,EAAE,EAAE,CAAC;IAEf;;;OAGG;IACH,UAAU,EAAE,CAAE,WAAW,CAAE,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,CAAE,0BAA0B,CAAE,CAAC;IAE1C;;;OAGG;IACH,YAAY,EAAE,EAAE,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,EAAE,CAAC;IAEhB;;;OAGG;IACH,eAAe,EAAE,EAAE,CAAC;IAEpB;;;OAGG;IACH,cAAc,EAAE,EAAE,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,EAAE,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,CAAE,KAAK,CAAE,CAAC;CACnB;AAED;;;;GAIG;AACH;IAEC;;;OAGG;IACH,cAAc,EAAE,CAAE,eAAe,CAAE,CAAC;IAEpC;;;OAGG;IACH,YAAY,EAAE,EAAE,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,EAAE,CAAC;IAEhB;;;OAGG;IACH,eAAe,EAAE,EAAE,CAAC;IAEpB;;;OAGG;IACH,cAAc,EAAE,EAAE,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,EAAE,CAAC;IAEnB;;;OAGG;IACH,OAAO,EAAE,CAAE,KAAK,CAAE,CAAC;CACnB;AAED;;;GAGG;AACH,8BAA8B,YAAY,GAAG,YAAY,EAAE,CAAC;AAE5D;;;;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,OAAO,MAAM,4BAAqC,GAAG,KAAG,MAAM,IAAI,eAGjE,CAAC;AAEF;;GAEG;AACH,OAAO,MAAM,8BAAuC,GAAG,KAAG,MAAM,IAAI,iBAGnE,CAAC;ACtRF;;;;;;;;GAQG;AACH;IAEC,YAAY,IAAI;IAChB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,UAAU,IAAI;IACd,YAAY,IAAI;CAChB;AGRD;;GAEG;AACH,4BAAqB,cAAc,SAAS,oBAAoB,CAAE,SAAQ,aAAa,oBAAoB,GAAG,cAAc,CAAE,YAAW,oBAAoB;IA0DpJ,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;IACf,gBAAgB,EAAE,cAAc,GAAG,MAAM;IACzC,OAAO,EAAE,sBAAsB;IA3DvC;;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;IACH,IAAW,MAAM,IAAI,gBAAgB,CAGpC;IAiBD;;;;;;;;;OASG;gBAEK,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,cAAc,GAAG,MAAM,EACzC,OAAO,GAAE,sBAA2B;IAc5C,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;IA0C7E;;;;;;;;;;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,WAAW,GAAG,IAAI;IA0DpC;;;;;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;IAO7D,SAAgB,UAAU,EAAE,EAAE,CAAC;IAC/B,SAAgB,SAAS,EAAE,EAAE,CAAC;IAC9B,SAAgB,aAAa,EAAE,EAAE,CAAC;IAClC,SAAgB,YAAY,EAAE,EAAE,CAAC;IACjC,SAAgB,YAAY,EAAE,EAAE,CAAC;IACjC,SAAgB,YAAY,EAAE,CAAE,eAAe,CAAE,CAAC;IAClD,SAAgB,KAAK,EAAE,CAAE,KAAK,CAAE,CAAC;CACjC","sources":["source/source/rpc-interfaces.ts","source/source/electrum-protocol.ts","source/source/interfaces.ts","source/source/enums.ts","source/source/electrum-connection.ts","source/source/constants.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 './enums';\n"],"names":[],"version":3,"file":"index.d.ts.map"}