hs-client: move all websocket calls under .ws namespace.

.eslintrc.json

@@ -1,6 +1,6 @@
 {
   "env": {
-    "es2020": true,
+    "es2022": true,
     "node": true
   },
   "extends": "eslint:recommended",
@@ -35,7 +35,7 @@
     }
   ],
   "parserOptions": {
-    "ecmaVersion": 11,
+    "ecmaVersion": 13,
     "ecmaFeatures": {
       "globalReturn": true
     },

CHANGELOG.md

@@ -38,6 +38,7 @@ process and allows parallel rescans.
     - expects ws hook for `block rescan interactive` params `rawEntry, rawTXs`
       that returns scanAction object.
     - expects ws hook for `block rescan interactive abort` param `message`.
+  - Move all `websocket` APIs under `.ws` namespace.
 
 ### Wallet Changes
 #### Configuration
@@ -63,6 +64,8 @@ process and allows parallel rescans.
     exact fee.
   - All transaction sending endpoints now fundlock/queue tx creation. (no more
     conflicting transactions)
+  - Move all `websocket` APIs under `.ws` namespace.
+
 
 ## v6.0.0
 

jsdoc.json

@@ -8,7 +8,10 @@
     "includePattern": ".+\\.js(doc)?$",
     "excludePattern": "(^|\\/|\\\\)_"
   },
-  "plugins": ["plugins/markdown"],
+  "plugins": [
+    "plugins/markdown",
+    "plugins/rm-imports"
+  ],
   "templates": {
     "cleverLinks": false,
     "monospaceLinks": false

lib/client/node.js

@@ -11,6 +11,7 @@
 
 const assert = require('bsert');
 const {Client} = require('bcurl');
+const WSClient = require('./wsclient');
 
 /**
  * Node Client
@@ -26,6 +27,8 @@ class NodeClient extends Client {
 
   constructor(options) {
     super(options);
+
+    this.ws = new NodeWSClient(this);
   }
 
   /**
@@ -34,9 +37,9 @@ class NodeClient extends Client {
    */
 
   async auth() {
-    await this.call('auth', this.password);
-    await this.watchChain();
-    await this.watchMempool();
+    await this.ws.call('auth', this.password);
+    await this.ws.watchChain();
+    await this.ws.watchMempool();
   }
 
   /**
@@ -192,7 +195,15 @@ class NodeClient extends Client {
   reset(height) {
     return this.post('/reset', { height });
   }
+}
+
+/**
+ * Node WS Client
+ * @alias module:client.NodeWSClient
+ * @extends {WSClient}
+ */
 
+class NodeWSClient extends WSClient {
   /**
    * Watch the blockchain.
    * @private

lib/client/wallet.js

@@ -12,6 +12,7 @@
 const assert = require('bsert');
 const EventEmitter = require('events');
 const {Client} = require('bcurl');
+const WSClient = require('./wsclient');
 
 /**
  * Wallet Client
@@ -28,6 +29,7 @@ class WalletClient extends Client {
   constructor(options) {
     super(options);
     this.wallets = new Map();
+    this.ws = new WalletWSClient(this);
   }
 
   /**
@@ -37,31 +39,31 @@ class WalletClient extends Client {
    */
 
   init() {
-    this.bind('tx', (id, details) => {
+    this.ws.bind('tx', (id, details) => {
       this.dispatch(id, 'tx', details);
     });
 
-    this.bind('confirmed', (id, details) => {
+    this.ws.bind('confirmed', (id, details) => {
       this.dispatch(id, 'confirmed', details);
     });
 
-    this.bind('unconfirmed', (id, details) => {
+    this.ws.bind('unconfirmed', (id, details) => {
       this.dispatch(id, 'unconfirmed', details);
     });
 
-    this.bind('conflict', (id, details) => {
+    this.ws.bind('conflict', (id, details) => {
       this.dispatch(id, 'conflict', details);
     });
 
-    this.bind('updated', (id, details) => {
+    this.ws.bind('updated', (id, details) => {
       this.dispatch(id, 'updated', details);
     });
 
-    this.bind('address', (id, receive) => {
+    this.ws.bind('address', (id, receive) => {
       this.dispatch(id, 'address', receive);
     });
 
-    this.bind('balance', (id, balance) => {
+    this.ws.bind('balance', (id, balance) => {
       this.dispatch(id, 'balance', balance);
     });
   }
@@ -104,7 +106,7 @@ class WalletClient extends Client {
    */
 
   async auth() {
-    await this.call('auth', this.password);
+    await this.ws.call('auth', this.password);
   }
 
   /**
@@ -124,38 +126,6 @@ class WalletClient extends Client {
     return new Wallet(this, id, token);
   }
 
-  /**
-   * Join a wallet.
-   */
-
-  all(token) {
-    return this.call('join', '*', token);
-  }
-
-  /**
-   * Leave a wallet.
-   */
-
-  none() {
-    return this.call('leave', '*');
-  }
-
-  /**
-   * Join a wallet.
-   */
-
-  join(id, token) {
-    return this.call('join', id, token);
-  }
-
-  /**
-   * Leave a wallet.
-   */
-
-  leave(id) {
-    return this.call('leave', id);
-  }
-
   /**
    * Rescan the chain.
    * @param {Number} height
@@ -913,7 +883,7 @@ class Wallet extends EventEmitter {
    */
 
   async open() {
-    await this.parent.join(this.id, this.token);
+    await this.parent.ws.join(this.id, this.token);
     this.parent.wallets.set(this.id, this);
   }
 
@@ -923,7 +893,7 @@ class Wallet extends EventEmitter {
    */
 
   async close() {
-    await this.parent.leave(this.id);
+    await this.parent.ws.leave(this.id);
     this.parent.wallets.delete(this.id);
   }
 
@@ -1577,6 +1547,46 @@ class Wallet extends EventEmitter {
   }
 }
 
+/**
+ * Wallet WS Client
+ * @alias module:client.WalletClient
+ * @extends {WSClient}
+ */
+
+class WalletWSClient extends WSClient {
+  /**
+   * Join a wallet.
+   */
+
+  all(token) {
+    return this.call('join', '*', token);
+  }
+
+  /**
+   * Leave a wallet.
+   */
+
+  none() {
+    return this.call('leave', '*');
+  }
+
+  /**
+   * Join a wallet.
+   */
+
+  join(id, token) {
+    return this.call('join', id, token);
+  }
+
+  /**
+   * Leave a wallet.
+   */
+
+  leave(id) {
+    return this.call('leave', id);
+  }
+}
+
 /*
  * Expose
  */

lib/client/wsclient.js

@@ -0,0 +1,124 @@
+/*!
+ * wsclient.js - WS Client for Node and Wallet.
+ * Copyright (c) 2024, Nodari Chkuaselidze (MIT License)
+ */
+
+'use strict';
+
+/** @typedef {import('bcurl').Client} Client */
+/** @typedef {import('bsock').Socket} Socket */
+
+/**
+ * Websocket Client
+ * @alias module:client.WSClient
+ */
+
+class WSClient {
+  /** @type {Client} */
+  client;
+
+  /** @type {Socket} */
+  socket;
+
+  /**
+   * @param {Client} client
+   */
+
+  constructor(client) {
+    this.client = client;
+    this.socket = client.socket;
+  }
+
+  /**
+   * @returns {Boolean}
+   */
+
+  get opened() {
+    return this.client.opened;
+  }
+
+  /**
+   * Open websocket.
+   * @returns {Promise}
+   */
+
+  async open() {
+    return this.client.open();
+  }
+
+  /**
+   * Close websocket.
+   * @returns {Promise}
+   */
+
+  async close() {
+    return this.client.close();
+  }
+
+  /**
+   * Alias for hook.
+   * @param {String} event
+   * @param {Function} handler
+   */
+
+  hook(event, handler) {
+    return this.client.hook(event, handler);
+  }
+
+  /**
+   * Alias for unhook.
+   * @param {String} event
+   * @param {Function} handler
+   */
+
+  unhook(event, handler) {
+    return this.client.unhook(event, handler);
+  }
+
+  /**
+   * Alias call.
+   * @param {String} event
+   * @param {...*} args
+   * @returns {Promise}
+   */
+
+  async call(event, ...args) {
+    return this.client.call(event, ...args);
+  }
+
+  /**
+   * Add an event listener.
+   * @param {String} event
+   * @param {Function} handler
+   */
+
+  bind(event, handler) {
+    return this.socket.bind(event, handler);
+  }
+
+  /**
+   * Remove an event listener.
+   * @param {String} event
+   * @param {Function} handler
+   */
+
+  unbind(event, handler) {
+    return this.socket.unbind(event, handler);
+  }
+
+  /**
+   * Fire an event.
+   * @param {String} event
+   * @param {...*} args
+   */
+
+  fire(event, ...args) {
+    return this.socket.fire(event, ...args);
+  }
+}
+
+/*
+ * Expose
+ */
+
+module.exports = WSClient;