chia-agent 14.3.1 → 14.3.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [14.3.3]
+### Changed
+- The default service name which [`Daemon`](./src/daemon/index.ts) client tries to register is now `wallet_ui`.  
+  Previously `chia_agent` service and optionally `wallet_ui` service were registered to `chia-blockchain`'s `Daemon`.  
+
+## [14.3.2]
+### Changed
+- Error logs are generated when
+  - an error occurs during sending a message.
+  - it receives a websocket message with unexpected format.
+- Debug logs are generated when ping/pong events are triggered.
+
 ## [14.3.1]
 ### Changed
 - Added a `Host` header when sending https request to a remote host.
@@ -1708,6 +1720,8 @@ daemon.sendMessage(destination, get_block_record_by_height_command, data);
 Initial release.
 
 <!-- [Unreleased]: https://github.com/Chia-Mine/chia-agent/compare/v0.0.1...v0.0.2 -->
+[14.3.3]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.2...v14.3.3
+[14.3.2]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.1...v14.3.2
 [14.3.1]: https://github.com/Chia-Mine/chia-agent/compare/v14.3.0...v14.3.1
 [14.3.0]: https://github.com/Chia-Mine/chia-agent/compare/v14.2.2...v14.3.0
 [14.2.2]: https://github.com/Chia-Mine/chia-agent/compare/v14.2.1...v14.2.2

package/daemon/connection.d.ts

@@ -1,5 +1,6 @@
 import * as WS from "ws";
 import { Event } from "ws";
+export declare const defaultTimeoutInMs = 50000;
 export declare function open(url: string, timeoutMs?: number): Promise<{
     ws: WS;
     openEvent: Event;

package/daemon/connection.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.open = void 0;
+exports.open = exports.defaultTimeoutInMs = void 0;
 const fs_1 = require("fs");
 const config_1 = require("../config");
 const WS = require("ws");
@@ -25,25 +25,33 @@ function create(url) {
     };
     return new WS(url, options);
 }
-const defaultTimeoutInMs = 50000;
+exports.defaultTimeoutInMs = 50000;
 function open(url, timeoutMs) {
     return new Promise((resolve, reject) => {
         const ws = create(url);
         let timer = null;
-        timeoutMs = typeof timeoutMs === "number" ? timeoutMs : defaultTimeoutInMs;
+        timeoutMs = typeof timeoutMs === "number" ? timeoutMs : exports.defaultTimeoutInMs;
+        let opened = false;
         timer = setTimeout(() => {
             timer = null;
             (0, logger_1.getLogger)().error("Request to open connection timed out");
             reject("Timeout");
         }, timeoutMs);
-        ws.onopen = (openEvent) => {
+        const onOpenError = (err) => {
+            if (!opened) {
+                reject(err);
+            }
+        };
+        ws.on("open", (openEvent) => {
+            opened = true;
+            ws.off("error", onOpenError);
             if (timer !== null) {
                 clearTimeout(timer);
                 timer = null;
                 resolve({ ws, openEvent });
             }
-        };
-        ws.onerror = (err) => reject(err);
+        });
+        ws.on("error", onOpenError);
     });
 }
 exports.open = open;

package/daemon/index.d.ts

@@ -7,7 +7,7 @@ export type WsEvent = Event | MessageEvent | ErrorEvent | CloseEvent;
 export type EventListener<T = WsEvent> = (ev: T) => unknown;
 type EventListenerOf<T> = T extends "open" ? EventListener<Event> : T extends "message" ? EventListener<MessageEvent> : T extends "error" ? EventListener<ErrorEvent> : T extends "close" ? EventListener<CloseEvent> : never;
 export type MessageListener<D extends WsMessage> = (msg: D) => unknown;
-export declare function getDaemon(): Daemon;
+export declare function getDaemon(serviceName?: string): Daemon;
 declare class Daemon {
     protected _socket: WS | null;
     protected _connectedUrl: string;
@@ -22,9 +22,10 @@ declare class Daemon {
     protected _closing: boolean;
     protected _onClosePromise: (() => unknown) | undefined;
     protected _subscriptions: string[];
+    protected _serviceName: string;
     get connected(): boolean;
     get closing(): boolean;
-    constructor();
+    constructor(serviceName?: string);
     /**
      * Connect to local daemon via websocket.
      * @param daemonServerURL
@@ -57,6 +58,8 @@ declare class Daemon {
     protected onError(error: ErrorEvent): void;
     protected onMessage(event: MessageEvent): void;
     protected onClose(event: CloseEvent): void;
+    protected onPing(): void;
+    protected onPong(): void;
 }
 export type TDaemon = InstanceType<typeof Daemon>;
 export {};

package/daemon/index.js

@@ -14,13 +14,13 @@ const crypto_1 = require("crypto");
 const logger_1 = require("../logger");
 const connection_1 = require("./connection");
 const index_1 = require("../config/index");
-const chia_agent_service = "chia_agent";
+const DEFAULT_SERVICE_NAME = "wallet_ui";
 let daemon = null;
-function getDaemon() {
+function getDaemon(serviceName) {
     if (daemon) {
         return daemon;
     }
-    return daemon = new Daemon();
+    return daemon = new Daemon(serviceName);
 }
 exports.getDaemon = getDaemon;
 // Gracefully disconnect from remote daemon server on Ctrl+C.
@@ -53,7 +53,7 @@ class Daemon {
     get closing() {
         return this._closing;
     }
-    constructor() {
+    constructor(serviceName) {
         this._socket = null;
         this._connectedUrl = "";
         this._responseQueue = {};
@@ -64,10 +64,16 @@ class Daemon {
         this._messageListeners = {};
         this._closing = false;
         this._subscriptions = [];
+        this._serviceName = DEFAULT_SERVICE_NAME;
         this.onOpen = this.onOpen.bind(this);
         this.onError = this.onError.bind(this);
         this.onMessage = this.onMessage.bind(this);
         this.onClose = this.onClose.bind(this);
+        this.onPing = this.onPing.bind(this);
+        this.onPong = this.onPong.bind(this);
+        if (serviceName) {
+            this._serviceName = serviceName;
+        }
     }
     /**
      * Connect to local daemon via websocket.
@@ -92,9 +98,11 @@ class Daemon {
             (0, logger_1.getLogger)().debug(`Opening websocket connection to ${daemonServerURL}`);
             const result = yield (0, connection_1.open)(daemonServerURL, timeoutMs);
             this._socket = result.ws;
-            this._socket.onerror = this.onError;
-            this._socket.onmessage = this.onMessage;
-            this._socket.onclose = this.onClose;
+            this._socket.on("error", this.onError);
+            this._socket.addEventListener("message", this.onMessage);
+            this._socket.on("close", this.onClose);
+            this._socket.on("ping", this.onPing);
+            this._socket.on("pong", this.onPong);
             yield this.onOpen(result.openEvent, daemonServerURL);
             return true;
         });
@@ -124,7 +132,13 @@ class Daemon {
                 const reqId = message.request_id;
                 this._responseQueue[reqId] = resolve;
                 (0, logger_1.getLogger)().debug(`Sending message. dest=${destination} command=${command} reqId=${reqId}`);
-                this._socket.send(JSON.stringify(message));
+                const messageStr = JSON.stringify(message);
+                this._socket.send(messageStr, (err) => {
+                    if (err) {
+                        (0, logger_1.getLogger)().error(`Error while sending message: ${messageStr}`);
+                        (0, logger_1.getLogger)().error(JSON.stringify(err));
+                    }
+                });
             });
         });
     }
@@ -133,7 +147,7 @@ class Daemon {
             command,
             data,
             ack: false,
-            origin: chia_agent_service,
+            origin: this._serviceName,
             destination,
             request_id: (0, crypto_1.randomBytes)(32).toString("hex"),
         };
@@ -150,7 +164,7 @@ class Daemon {
                     data: { success: true },
                     ack: true,
                     origin: "daemon",
-                    destination: chia_agent_service,
+                    destination: service,
                     request_id: "",
                 };
             }
@@ -244,7 +258,7 @@ class Daemon {
             (0, logger_1.getLogger)().info("ws connection opened");
             this._connectedUrl = url;
             this._openEventListeners.forEach(l => l(event));
-            return this.subscribe(chia_agent_service);
+            return this.subscribe(this._serviceName);
         });
     }
     onError(error) {
@@ -252,8 +266,19 @@ class Daemon {
         this._errorEventListeners.forEach(l => l(error));
     }
     onMessage(event) {
-        const payload = JSON.parse(event.data);
-        const { request_id, origin, command } = payload;
+        let payload;
+        let request_id;
+        let origin;
+        let command;
+        try {
+            payload = JSON.parse(event.data);
+            ({ request_id, origin, command } = payload);
+        }
+        catch (err) {
+            (0, logger_1.getLogger)().error(`Failed to parse message data: ${JSON.stringify(err)}`);
+            (0, logger_1.getLogger)().error(`payload: ${event.data}`);
+            return;
+        }
         (0, logger_1.getLogger)().debug(`Arrived message. origin=${origin} command=${command} reqId=${request_id}`);
         const resolver = this._responseQueue[request_id];
         if (resolver) {
@@ -273,9 +298,11 @@ class Daemon {
     }
     onClose(event) {
         if (this._socket) {
-            this._socket.removeEventListener("error", this.onError);
+            this._socket.off("error", this.onError);
             this._socket.removeEventListener("message", this.onMessage);
-            this._socket.removeEventListener("close", this.onClose);
+            this._socket.off("close", this.onClose);
+            this._socket.off("ping", this.onPing);
+            this._socket.off("pong", this.onPong);
             this._socket = null;
         }
         this._closing = false;
@@ -289,4 +316,10 @@ class Daemon {
             this._onClosePromise = undefined;
         }
     }
+    onPing() {
+        (0, logger_1.getLogger)().debug("Received ping");
+    }
+    onPong() {
+        (0, logger_1.getLogger)().debug("Received pong");
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chia-agent",
-  "version": "14.3.1",
+  "version": "14.3.3",
   "author": "ChiaMineJP <admin@chiamine.jp>",
   "description": "chia rpc/websocket client library",
   "license": "MIT",