@electrum-cash/web-socket 1.0.0

package/README.md

@@ -0,0 +1,93 @@
+# Electrum-Cash Web Socket
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.com/electrum-cash/web-socket.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.com/electrum-cash/web-socket/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { EventEmitter } from "eventemitter3";
+import { ElectrumSocket, ElectrumSocketEvents } from "@electrum-cash/network";
+/**
+ * Web Socket used when communicating with Electrum servers.
+ */
+export class ElectrumWebSocket extends EventEmitter<ElectrumSocketEvents> implements ElectrumSocket {
+    host: string;
+    port: number;
+    encrypted: boolean;
+    timeout: number;
+    /**
+     * Creates a socket configured with connection information for a given Electrum server.
+     *
+     * @param host        Fully qualified domain name or IP address of the host
+     * @param port        Network port for the host to connect to, defaults to the standard TLS port
+     * @param encrypted   If false, uses an unencrypted connection instead of the default on TLS
+     * @param timeout     If no connection is established after `timeout` ms, the connection is terminated
+     */
+    constructor(host: string, port?: number, encrypted?: boolean, timeout?: number);
+    /**
+     * Returns a string for the host identifier for usage in debug messages.
+     */
+    get hostIdentifier(): string;
+    /**
+     * Connect to host:port using the specified transport
+     */
+    connect(): void;
+    /**
+     * Forcibly terminate the connection.
+     *
+     * @throws {Error} if no connection was found
+     */
+    disconnect(): void;
+    /**
+     * Write data to the socket
+     *
+     * @param data       Data to be written to the socket
+     * @param callback   Callback function to be called when the write has completed
+     *
+     * @throws {Error} if no connection was found
+     * @returns true if the message was fully flushed to the socket, false if part of the message
+     * is queued in the user memory
+     */
+    write(data: Uint8Array | string, callback?: (err?: Error) => void): boolean;
+    readonly connected: [];
+    readonly disconnected: [];
+    readonly data: [string];
+    readonly error: [Error];
+}
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":";;ACQA;;GAEG;AACH,8BAA+B,SAAQ,aAAa,oBAAoB,CAAE,YAAW,cAAc;IA6B1F,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,OAAO;IAClB,OAAO,EAAE,MAAM;IAbvB;;;;;;;OAOG;gBAGK,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,MAAc,EACpB,SAAS,GAAE,OAAc,EACzB,OAAO,GAAE,MAAuB;IAOxC;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAG3B;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;IA4Ef;;;;OAIG;IACI,UAAU,IAAI,IAAI;IAiCzB;;;;;;;;;OASG;IACI,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO;IA+BlF,SAAgB,SAAS,EAAE,EAAE,CAAC;IAC9B,SAAgB,YAAY,EAAE,EAAE,CAAC;IACjC,SAAgB,IAAI,EAAE,CAAE,MAAM,CAAE,CAAC;IACjC,SAAgB,KAAK,EAAE,CAAE,KAAK,CAAE,CAAC;CACjC","sources":["source/source/constants.ts","source/source/web.ts","source/source/index.ts","source/index.ts"],"sourcesContent":[null,null,null,"export * from './web.ts';\n"],"names":[],"version":3,"file":"index.d.ts.map"}

package/dist/index.mjs

@@ -0,0 +1,168 @@
+import {WebSocket as $dvphU$WebSocket} from "@monsterbitar/isomorphic-ws";
+import {EventEmitter as $dvphU$EventEmitter} from "eventemitter3";
+import $dvphU$electrumcashdebuglogs from "@electrum-cash/debug-logs";
+
+
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $05743633fea447d4$exports = {};
+
+$parcel$export($05743633fea447d4$exports, "ElectrumWebSocket", () => $05743633fea447d4$export$25b4633f61498e1);
+
+
+
+// Export a default timeout value of 30 seconds.
+const $d801b1f9b7fc3074$export$1bddf2b96e25d075 = 30000;
+
+
+class $05743633fea447d4$export$25b4633f61498e1 extends (0, $dvphU$EventEmitter) {
+    host;
+    port;
+    encrypted;
+    timeout;
+    // Declare an empty WebSocket.
+    webSocket;
+    // Used to disconnect after some time if initial connection is too slow.
+    disconnectTimer;
+    // Initialize boolean that indicates whether the onConnect function has run (initialize to false).
+    onConnectHasRun;
+    // Initialize event forwarding functions.
+    eventForwarders;
+    /**
+	 * Creates a socket configured with connection information for a given Electrum server.
+	 *
+	 * @param host        Fully qualified domain name or IP address of the host
+	 * @param port        Network port for the host to connect to, defaults to the standard TLS port
+	 * @param encrypted   If false, uses an unencrypted connection instead of the default on TLS
+	 * @param timeout     If no connection is established after `timeout` ms, the connection is terminated
+	 */ constructor(host, port = 50004, encrypted = true, timeout = (0, $d801b1f9b7fc3074$export$1bddf2b96e25d075)){
+        // Initialize the event emitter.
+        super();
+        this.host = host;
+        this.port = port;
+        this.encrypted = encrypted;
+        this.timeout = timeout;
+        this.onConnectHasRun = false;
+        this.eventForwarders = {
+            disconnect: ()=>this.emit("disconnected"),
+            wsData: (event)=>this.emit("data", `${event.data}\n`),
+            wsError: (event)=>this.emit("error", new Error(event.error))
+        };
+    }
+    /**
+	 * Returns a string for the host identifier for usage in debug messages.
+	 */ get hostIdentifier() {
+        return `${this.host}:${this.port}`;
+    }
+    /**
+	 * Connect to host:port using the specified transport
+	 */ connect() {
+        // Check that no existing socket exists before initiating a new connection.
+        if (this.webSocket) throw new Error("Cannot initiate a new socket connection when an existing connection exists");
+        // Set a timer to force disconnect after `timeout` seconds
+        this.disconnectTimer = setTimeout(()=>this.disconnectOnTimeout(), this.timeout);
+        // Remove the timer if a connection is successfully established
+        this.once("connected", this.clearDisconnectTimerOnTimeout);
+        // Set a named connection type for logging purposes.
+        const connectionType = this.encrypted ? "an encrypted WebSocket" : "a WebSocket";
+        // Log that we are trying to establish a connection.
+        (0, $dvphU$electrumcashdebuglogs).network(`Initiating ${connectionType} connection to '${this.host}:${this.port}'.`);
+        if (this.encrypted) // Initialize this.webSocket (rejecting self-signed certificates).
+        // We reject self-signed certificates to match functionality of browsers.
+        this.webSocket = new (0, $dvphU$WebSocket)(`wss://${this.host}:${this.port}`);
+        else // Initialize this.webSocket.
+        this.webSocket = new (0, $dvphU$WebSocket)(`ws://${this.host}:${this.port}`);
+        // Trigger successful connection events.
+        this.webSocket.addEventListener("open", this.onConnect.bind(this));
+        // Forward the encountered errors.
+        this.webSocket.addEventListener("error", this.eventForwarders.wsError);
+    }
+    /**
+	 * Sets up forwarding of events related to the connection.
+	 */ onConnect() {
+        // If the onConnect function has already run, do not execute it again.
+        if (this.onConnectHasRun) return;
+        // Set a named connection type for logging purposes.
+        const connectionType = this.encrypted ? "an encrypted WebSocket" : "a WebSocket";
+        // Log that the connection has been established.
+        (0, $dvphU$electrumcashdebuglogs).network(`Established ${connectionType} connection with '${this.host}:${this.port}'.`);
+        // Forward the socket events
+        this.webSocket.addEventListener("close", this.eventForwarders.disconnect);
+        this.webSocket.addEventListener("message", this.eventForwarders.wsData);
+        // Indicate that the onConnect function has run.
+        this.onConnectHasRun = true;
+        // Emit the connect event.
+        this.emit("connected");
+    }
+    /**
+	 * Clears the disconnect timer if it is still active.
+	 */ clearDisconnectTimerOnTimeout() {
+        // Clear the retry timer if it is still active.
+        if (this.disconnectTimer) clearTimeout(this.disconnectTimer);
+    }
+    /**
+	 * Forcibly terminate the connection.
+	 *
+	 * @throws {Error} if no connection was found
+	 */ disconnect() {
+        // Clear the disconnect timer so that the socket does not try to disconnect again later.
+        this.clearDisconnectTimerOnTimeout();
+        try {
+            // Remove all event forwarders.
+            this.webSocket.removeEventListener("close", this.eventForwarders.disconnect);
+            this.webSocket.removeEventListener("message", this.eventForwarders.wsData);
+            this.webSocket.removeEventListener("error", this.eventForwarders.wsError);
+            // Gracefully terminate the connection.
+            this.webSocket.close();
+        } catch (ignored) {
+        // close() will throw an error if the connection has not been established yet.
+        // We ignore this error, since no similar error gets thrown in the TLS Socket.
+        } finally{
+            // Remove the stored socket regardless of any thrown errors.
+            this.webSocket = undefined;
+        }
+        // Indicate that the onConnect function has not run and it has to be run again.
+        this.onConnectHasRun = false;
+        // Emit a disconnect event
+        this.emit("disconnected");
+    }
+    /**
+	 * Write data to the socket
+	 *
+	 * @param data       Data to be written to the socket
+	 * @param callback   Callback function to be called when the write has completed
+	 *
+	 * @throws {Error} if no connection was found
+	 * @returns true if the message was fully flushed to the socket, false if part of the message
+	 * is queued in the user memory
+	 */ write(data, callback) {
+        // Throw an error if no active connection is found
+        if (!this.webSocket) throw new Error("Cannot write to socket when there is no active connection");
+        // Write data to the WebSocket
+        this.webSocket.send(data, callback);
+        // WebSockets always fit everything in a single request, so we return true
+        return true;
+    }
+    /**
+	 * Force a disconnection if no connection is established after `timeout` milliseconds.
+	 */ disconnectOnTimeout() {
+        // Remove the connect listener.
+        this.removeListener("connected", this.clearDisconnectTimerOnTimeout);
+        // Emit an error event so that connect is rejected upstream.
+        this.emit("error", new Error(`Connection to '${this.host}:${this.port}' timed out after ${this.timeout} milliseconds`));
+        // Forcibly disconnect to clean up the connection on timeout
+        this.disconnect();
+    }
+    // Add magic glue that makes typedoc happy so that we can have the events listed on the class.
+    connected;
+    disconnected;
+    data;
+    error;
+}
+
+
+
+
+export {$05743633fea447d4$export$25b4633f61498e1 as ElectrumWebSocket};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;AEAA,gDAAgD;AACzC,MAAM,4CAAiB;;;ADUvB,MAAM,iDAA0B,CAAA,GAAA,mBAAW;;;;;IAEjD,8BAA8B;IACtB,UAAqB;IAE7B,wEAAwE;IAChE,gBAAyB;IAEjC,kGAAkG;IAC1F,gBAAwB;IAEhC,yCAAyC;IACjC,gBAKN;IAEF;;;;;;;EAOC,GACD,YAEC,AAAO,IAAY,EACnB,AAAO,OAAe,KAAK,EAC3B,AAAO,YAAqB,IAAI,EAChC,AAAO,UAAkB,CAAA,GAAA,yCAAa,CAAC,CAExC;QACC,gCAAgC;QAChC,KAAK;aAPE,OAAA;aACA,OAAA;aACA,YAAA;aACA,UAAA;aAvBA,kBAAkB;aAGlB,kBACR;YACC,YAAY,IAAqB,IAAI,CAAC,IAAI,CAAC;YAC3C,QAAQ,CAAC,QAAwB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC;YACpE,SAAS,CAAC,QAAuB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,MAAM,MAAM,KAAK;QAC1E;IAoBA;IAEA;;EAEC,GACD,IAAI,iBACJ;QACC,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC;IAEA;;EAEC,GACD,UACA;QACC,2EAA2E;QAC3E,IAAG,IAAI,CAAC,SAAS,EAEhB,MAAM,IAAI,MAAM;QAGjB,0DAA0D;QAC1D,IAAI,CAAC,eAAe,GAAG,WAAW,IAAM,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,OAAO;QAEhF,+DAA+D;QAC/D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,6BAA6B;QAEzD,oDAAoD;QACpD,MAAM,iBAAkB,IAAI,CAAC,SAAS,GAAG,2BAA2B;QAEpE,oDAAoD;QACpD,CAAA,GAAA,4BAAI,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,eAAe,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAEvF,IAAG,IAAI,CAAC,SAAS,EAEhB,kEAAkE;QAClE,yEAAyE;QACzE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA,GAAA,gBAAQ,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aAIhE,6BAA6B;QAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA,GAAA,gBAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAGhE,wCAAwC;QACxC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI;QAEhE,kCAAkC;QAClC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,SAAS,IAAI,CAAC,eAAe,CAAC,OAAO;IACtE;IAEA;;EAEC,GACD,AAAQ,YACR;QACC,sEAAsE;QACtE,IAAG,IAAI,CAAC,eAAe,EAAE;QAEzB,oDAAoD;QACpD,MAAM,iBAAkB,IAAI,CAAC,SAAS,GAAG,2BAA2B;QAEpE,gDAAgD;QAChD,CAAA,GAAA,4BAAI,EAAE,OAAO,CAAC,CAAC,YAAY,EAAE,eAAe,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAE1F,4BAA4B;QAC5B,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,SAAS,IAAI,CAAC,eAAe,CAAC,UAAU;QACxE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,WAAW,IAAI,CAAC,eAAe,CAAC,MAAM;QAEtE,gDAAgD;QAChD,IAAI,CAAC,eAAe,GAAG;QAEvB,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC;IACX;IAEA;;EAEC,GACD,AAAQ,gCACR;QACC,+CAA+C;QAC/C,IAAG,IAAI,CAAC,eAAe,EAEtB,aAAa,IAAI,CAAC,eAAe;IAEnC;IAEA;;;;EAIC,GACD,AAAO,aACP;QACC,wFAAwF;QACxF,IAAI,CAAC,6BAA6B;QAElC,IACA;YACC,+BAA+B;YAC/B,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,IAAI,CAAC,eAAe,CAAC,UAAU;YAC3E,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,WAAW,IAAI,CAAC,eAAe,CAAC,MAAM;YACzE,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,IAAI,CAAC,eAAe,CAAC,OAAO;YAExE,uCAAuC;YACvC,IAAI,CAAC,SAAS,CAAC,KAAK;QACrB,EACA,OAAM,SACN;QACC,8EAA8E;QAC9E,8EAA8E;QAC/E,SAEA;YACC,4DAA4D;YAC5D,IAAI,CAAC,SAAS,GAAG;QAClB;QAEA,+EAA+E;QAC/E,IAAI,CAAC,eAAe,GAAG;QAEvB,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC;IACX;IAEA;;;;;;;;;EASC,GACD,AAAO,MAAM,IAAyB,EAAE,QAAgC,EACxE;QACC,kDAAkD;QAClD,IAAG,CAAC,IAAI,CAAC,SAAS,EAEjB,MAAM,IAAI,MAAM;QAGjB,8BAA8B;QAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM;QAE1B,0EAA0E;QAC1E,OAAO;IACR;IAEA;;EAEC,GACD,AAAQ,sBACR;QACC,+BAA+B;QAC/B,IAAI,CAAC,cAAc,CAAC,aAAa,IAAI,CAAC,6BAA6B;QAEnE,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;QAErH,4DAA4D;QAC5D,IAAI,CAAC,UAAU;IAChB;IAEA,8FAA8F;IAC9E,UAAc;IACd,aAAiB;IACjB,KAAiB;IACjB,MAAiB;AAClC","sources":["source/index.ts","source/web.ts","source/constants.ts"],"sourcesContent":["export * from './web.ts';\n","import { WebSocket } from '@monsterbitar/isomorphic-ws';\nimport { EventEmitter } from 'eventemitter3';\nimport debug from '@electrum-cash/debug-logs';\nimport { defaultTimeout } from './constants';\n\nimport type { MessageEvent, ErrorEvent } from '@monsterbitar/isomorphic-ws';\nimport type { ElectrumSocket, ElectrumSocketEvents } from '@electrum-cash/network';\n\n/**\n * Web Socket used when communicating with Electrum servers.\n */\nexport class ElectrumWebSocket extends EventEmitter<ElectrumSocketEvents> implements ElectrumSocket\n{\n\t// Declare an empty WebSocket.\n\tprivate webSocket: WebSocket;\n\n\t// Used to disconnect after some time if initial connection is too slow.\n\tprivate disconnectTimer?: number;\n\n\t// Initialize boolean that indicates whether the onConnect function has run (initialize to false).\n\tprivate onConnectHasRun = false;\n\n\t// Initialize event forwarding functions.\n\tprivate eventForwarders =\n\t{\n\t\tdisconnect: ()                => this.emit('disconnected'),\n\t\twsData: (event: MessageEvent) => this.emit('data', `${event.data}\\n`),\n\t\twsError: (event: ErrorEvent)  => this.emit('error', new Error(event.error)),\n\t};\n\n\t/**\n\t * Creates a socket configured with connection information for a given Electrum server.\n\t *\n\t * @param host        Fully qualified domain name or IP address of the host\n\t * @param port        Network port for the host to connect to, defaults to the standard TLS port\n\t * @param encrypted   If false, uses an unencrypted connection instead of the default on TLS\n\t * @param timeout     If no connection is established after `timeout` ms, the connection is terminated\n\t */\n\tpublic constructor\n\t(\n\t\tpublic host: string,\n\t\tpublic port: number = 50004,\n\t\tpublic encrypted: boolean = true,\n\t\tpublic timeout: number = defaultTimeout,\n\t)\n\t{\n\t\t// Initialize the event emitter.\n\t\tsuper();\n\t}\n\n\t/**\n\t * Returns a string for the host identifier for usage in debug messages.\n\t */\n\tget hostIdentifier(): string\n\t{\n\t\treturn `${this.host}:${this.port}`;\n\t}\n\n\t/**\n\t * Connect to host:port using the specified transport\n\t */\n\tconnect(): void\n\t{\n\t\t// Check that no existing socket exists before initiating a new connection.\n\t\tif(this.webSocket)\n\t\t{\n\t\t\tthrow(new Error('Cannot initiate a new socket connection when an existing connection exists'));\n\t\t}\n\n\t\t// Set a timer to force disconnect after `timeout` seconds\n\t\tthis.disconnectTimer = setTimeout(() => this.disconnectOnTimeout(), this.timeout) as unknown as number;\n\n\t\t// Remove the timer if a connection is successfully established\n\t\tthis.once('connected', this.clearDisconnectTimerOnTimeout);\n\n\t\t// Set a named connection type for logging purposes.\n\t\tconst connectionType = (this.encrypted ? 'an encrypted WebSocket' : 'a WebSocket');\n\n\t\t// Log that we are trying to establish a connection.\n\t\tdebug.network(`Initiating ${connectionType} connection to '${this.host}:${this.port}'.`);\n\n\t\tif(this.encrypted)\n\t\t{\n\t\t\t// Initialize this.webSocket (rejecting self-signed certificates).\n\t\t\t// We reject self-signed certificates to match functionality of browsers.\n\t\t\tthis.webSocket = new WebSocket(`wss://${this.host}:${this.port}`);\n\t\t}\n\t\telse\n\t\t{\n\t\t\t// Initialize this.webSocket.\n\t\t\tthis.webSocket = new WebSocket(`ws://${this.host}:${this.port}`);\n\t\t}\n\n\t\t// Trigger successful connection events.\n\t\tthis.webSocket.addEventListener('open', this.onConnect.bind(this));\n\n\t\t// Forward the encountered errors.\n\t\tthis.webSocket.addEventListener('error', this.eventForwarders.wsError);\n\t}\n\n\t/**\n\t * Sets up forwarding of events related to the connection.\n\t */\n\tprivate onConnect(): void\n\t{\n\t\t// If the onConnect function has already run, do not execute it again.\n\t\tif(this.onConnectHasRun) return;\n\n\t\t// Set a named connection type for logging purposes.\n\t\tconst connectionType = (this.encrypted ? 'an encrypted WebSocket' : 'a WebSocket');\n\n\t\t// Log that the connection has been established.\n\t\tdebug.network(`Established ${connectionType} connection with '${this.host}:${this.port}'.`);\n\n\t\t// Forward the socket events\n\t\tthis.webSocket.addEventListener('close', this.eventForwarders.disconnect);\n\t\tthis.webSocket.addEventListener('message', this.eventForwarders.wsData);\n\n\t\t// Indicate that the onConnect function has run.\n\t\tthis.onConnectHasRun = true;\n\n\t\t// Emit the connect event.\n\t\tthis.emit('connected');\n\t}\n\n\t/**\n\t * Clears the disconnect timer if it is still active.\n\t */\n\tprivate clearDisconnectTimerOnTimeout(): void\n\t{\n\t\t// Clear the retry timer if it is still active.\n\t\tif(this.disconnectTimer)\n\t\t{\n\t\t\tclearTimeout(this.disconnectTimer);\n\t\t}\n\t}\n\n\t/**\n\t * Forcibly terminate the connection.\n\t *\n\t * @throws {Error} if no connection was found\n\t */\n\tpublic disconnect(): void\n\t{\n\t\t// Clear the disconnect timer so that the socket does not try to disconnect again later.\n\t\tthis.clearDisconnectTimerOnTimeout();\n\n\t\ttry\n\t\t{\n\t\t\t// Remove all event forwarders.\n\t\t\tthis.webSocket.removeEventListener('close', this.eventForwarders.disconnect);\n\t\t\tthis.webSocket.removeEventListener('message', this.eventForwarders.wsData);\n\t\t\tthis.webSocket.removeEventListener('error', this.eventForwarders.wsError);\n\n\t\t\t// Gracefully terminate the connection.\n\t\t\tthis.webSocket.close();\n\t\t}\n\t\tcatch(ignored)\n\t\t{\n\t\t\t// close() will throw an error if the connection has not been established yet.\n\t\t\t// We ignore this error, since no similar error gets thrown in the TLS Socket.\n\t\t}\n\t\tfinally\n\t\t{\n\t\t\t// Remove the stored socket regardless of any thrown errors.\n\t\t\tthis.webSocket = undefined;\n\t\t}\n\n\t\t// Indicate that the onConnect function has not run and it has to be run again.\n\t\tthis.onConnectHasRun = false;\n\n\t\t// Emit a disconnect event\n\t\tthis.emit('disconnected');\n\t}\n\n\t/**\n\t * Write data to the socket\n\t *\n\t * @param data       Data to be written to the socket\n\t * @param callback   Callback function to be called when the write has completed\n\t *\n\t * @throws {Error} if no connection was found\n\t * @returns true if the message was fully flushed to the socket, false if part of the message\n\t * is queued in the user memory\n\t */\n\tpublic write(data: Uint8Array | string, callback?: (err?: Error) => void): boolean\n\t{\n\t\t// Throw an error if no active connection is found\n\t\tif(!this.webSocket)\n\t\t{\n\t\t\tthrow(new Error('Cannot write to socket when there is no active connection'));\n\t\t}\n\n\t\t// Write data to the WebSocket\n\t\tthis.webSocket.send(data, callback);\n\n\t\t// WebSockets always fit everything in a single request, so we return true\n\t\treturn true;\n\t}\n\n\t/**\n\t * Force a disconnection if no connection is established after `timeout` milliseconds.\n\t */\n\tprivate disconnectOnTimeout(): void\n\t{\n\t\t// Remove the connect listener.\n\t\tthis.removeListener('connected', this.clearDisconnectTimerOnTimeout);\n\n\t\t// Emit an error event so that connect is rejected upstream.\n\t\tthis.emit('error', new Error(`Connection to '${this.host}:${this.port}' timed out after ${this.timeout} milliseconds`));\n\n\t\t// Forcibly disconnect to clean up the connection on timeout\n\t\tthis.disconnect();\n\t}\n\n\t// Add magic glue that makes typedoc happy so that we can have the events listed on the class.\n\tpublic readonly connected: [];\n\tpublic readonly disconnected: [];\n\tpublic readonly data: [ string ];\n\tpublic readonly error: [ Error ];\n}\n","// Export a default timeout value of 30 seconds.\nexport const defaultTimeout = 30 * 1000;\n"],"names":[],"version":3,"file":"index.mjs.map"}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@electrum-cash/web-socket",
+  "version": "1.0.0",
+  "description": "@electrum-cash/web-socket implements the ElectrumSocket interface using web sockets.",
+  "keywords": [
+    "electrum",
+    "bitcoin",
+    "bitcoin cash"
+  ],
+  "homepage": "https://gitlab.com/electrum-cash/web-socket#readme",
+  "bugs": {
+    "url": "https://gitlab.com/electrum-cash/web-socket/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/electrum-cash/web-socket.git"
+  },
+  "author": "Jonathan Silverblood",
+  "license": "MIT",
+  "source": "./source/index.ts",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.mjs",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "default": "./dist/index.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "del ./dist",
+    "build": "npm run clean && parcel build",
+    "analyze": "parcel build --reporter @parcel/reporter-bundle-analyzer",
+    "docs": "typedoc --hideGenerator --categorizeByGroup",
+    "lint": "eslint . --ext .ts",
+    "syntax": "tsc --noEmit",
+    "spellcheck": "cspell 'source/**' 'test/**' 'examples/**'",
+    "test": "vitest --dir test/ --test-timeout=15000 --passWithNoTests --run --coverage"
+  },
+  "devDependencies": {
+    "@electrum-cash/network": "^4.0.2-development.8063220996",
+    "@generalprotocols/cspell-dictionary": "git+https://gitlab.com/GeneralProtocols/cspell-dictionary.git",
+    "@generalprotocols/eslint-config": "git+https://gitlab.com/GeneralProtocols/eslint-config.git",
+    "@parcel/packager-ts": "^2.12.0",
+    "@parcel/transformer-typescript-types": "^2.12.0",
+    "@types/debug": "^4.1.6",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@vitest/coverage-v8": "^1.3.1",
+    "cspell": "^8.6.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.42.0",
+    "eslint-plugin-import": "^2.23.4",
+    "events": "^3.3.0",
+    "parcel": "^2.12.0",
+    "typedoc": "^0.25.12",
+    "typedoc-plugin-coverage": "^3.1.0",
+    "typescript": "^5.1.3",
+    "vitest": "^1.3.1"
+  },
+  "dependencies": {
+    "@electrum-cash/debug-logs": "^1.0.0",
+    "@monsterbitar/isomorphic-ws": "^5.3.0",
+    "@types/ws": "^8.5.5",
+    "async-mutex": "^0.5.0",
+    "eventemitter3": "^5.0.1",
+    "lossless-json": "^4.0.1",
+    "ws": "^8.13.0"
+  }
+}