@metamask-institutional/websocket-client - npm Package Compare versions

Comparing version 0.1.40 to 0.2.0

CHANGELOG.md

@@ -150,2 +150,18 @@ # Change Log
 
+## [0.2.0](https://github.com/consensys-vertical-apps/metamask-institutional/compare/websocket-client-v0.1.40...websocket-client-v0.2.0) (2024-04-17)
+
+
+### Features
+
+* **websocketclient transasctionupdate:** initial handshake work ([#670](https://github.com/consensys-vertical-apps/metamask-institutional/issues/670)) ([5cd3bd6](https://github.com/consensys-vertical-apps/metamask-institutional/commit/5cd3bd60e9fd342b4b82c8bb589de8b4a0373c5a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @metamask-institutional/custody-keyring bumped from ^1.0.12 to ^1.1.0
+    * @metamask-institutional/sdk bumped from ^0.1.25 to ^0.1.26
+    * @metamask-institutional/types bumped from ^1.0.4 to ^1.1.0
+
 ## [0.1.23](https://github.com/consensys-vertical-apps/metamask-institutional/compare/websocket-client-v0.1.22...websocket-client-v0.1.23) (2023-05-17)
@@ -152,0 +168,0 @@

dist/interfaces/IWebsocketClientControllerOptions.d.ts

 import { CustodyKeyring, MmiConfigurationController } from "@metamask-institutional/custody-keyring";
-import { ICustodianUpdate } from "@metamask-institutional/types";
+import { ConnectionRequest, ICustodianUpdate } from "@metamask-institutional/types";
 export declare class IWebsocketClientControllerOptions {
@@ -7,2 +7,4 @@ initState?: Record<string, unknown>;
     handleUpdateEvent?: (ev: ICustodianUpdate) => void;
+    handleHandShakeEvent?: (ev: ICustodianUpdate) => void;
+    handleConnectionRequest?: (ev: ConnectionRequest) => void;
     onFailure?: () => void;
@@ -9,0 +11,0 @@ mmiConfigurationController: MmiConfigurationController;

dist/package.json

 {
   "name": "@metamask-institutional/websocket-client",
-  "version": "0.1.40",
+  "version": "0.2.0",
   "description": "This package will export WebsocketClient, responsible for establishing a connection to the WebSocket API and handle all the messages for transaction updates.",
@@ -30,9 +30,9 @@ "author": "Antonio Regadas <[e-mail]>",
   },
-  "gitHead": "aad6e51aaecb79cc40d9ca691d71bde30f4fb221",
+  "gitHead": "77d24b36e98558ddca8ff460ac34b1c894aaea58",
   "dependencies": {
-    "@metamask-institutional/custody-keyring": "^1.0.12",
-    "@metamask-institutional/sdk": "^0.1.25",
-    "@metamask-institutional/types": "^1.0.4",
+    "@metamask-institutional/custody-keyring": "^1.1.0",
+    "@metamask-institutional/sdk": "^0.1.26",
+    "@metamask-institutional/types": "^1.1.0",
     "mock-socket": "^9.2.1"
   }
 }

dist/WebsocketClient.d.ts

 /// <reference types="node" />
 import { MmiConfigurationController } from "@metamask-institutional/custody-keyring";
+import { ConnectionRequest } from "@metamask-institutional/types";
 import { EventEmitter } from "events";
@@ -12,2 +13,4 @@ import { IRequestStreamResponse } from "./interfaces/IRequestStreamResponse";
     handleUpdateEvent: (ev: any) => void;
+    handleHandShakeEvent: (ev: any) => void;
+    handleConnectionRequest: (ev: ConnectionRequest) => void;
     onReconnect: () => void;
@@ -14,0 +17,0 @@ onWebsocketClose: () => void;

dist/WebsocketClient.js

@@ -10,2 +10,4 @@ "use strict";
         this.handleUpdateEvent = opts.handleUpdateEvent;
+        this.handleHandShakeEvent = opts.handleHandShakeEvent;
+        this.handleConnectionRequest = opts.handleConnectionRequest;
         this.onFailure = opts.onFailure;
@@ -56,2 +58,8 @@ this.mmiConfigurationController = opts.mmiConfigurationController;
         }
+        if (msg.event === "handshake") {
+            this.handleHandShakeEvent(msg.data);
+        }
+        if (msg.event === "connection.request") {
+            this.handleConnectionRequest(msg.data);
+        }
         if (msg.error &&
@@ -58,0 +66,0 @@ !msg.error.requestId) {

package.json

 {
   "name": "@metamask-institutional/websocket-client",
-  "version": "0.1.40",
+  "version": "0.2.0",
   "description": "This package will export WebsocketClient, responsible for establishing a connection to the WebSocket API and handle all the messages for transaction updates.",
@@ -30,9 +30,9 @@ "author": "Antonio Regadas <[e-mail]>",
   },
-  "gitHead": "aad6e51aaecb79cc40d9ca691d71bde30f4fb221",
+  "gitHead": "77d24b36e98558ddca8ff460ac34b1c894aaea58",
   "dependencies": {
-    "@metamask-institutional/custody-keyring": "^1.0.12",
-    "@metamask-institutional/sdk": "^0.1.25",
-    "@metamask-institutional/types": "^1.0.4",
+    "@metamask-institutional/custody-keyring": "^1.1.0",
+    "@metamask-institutional/sdk": "^0.1.26",
+    "@metamask-institutional/types": "^1.1.0",
     "mock-socket": "^9.2.1"
   }
 }

src/interfaces/IWebsocketClientControllerOptions.ts

 import { CustodyKeyring, MmiConfigurationController } from "@metamask-institutional/custody-keyring";
-import { ICustodianUpdate } from "@metamask-institutional/types";
+import { ConnectionRequest, ICustodianUpdate } from "@metamask-institutional/types";
 
@@ -8,2 +8,4 @@ export class IWebsocketClientControllerOptions {
   handleUpdateEvent?: (ev: ICustodianUpdate) => void;
+  handleHandShakeEvent?: (ev: ICustodianUpdate) => void;
+  handleConnectionRequest?: (ev: ConnectionRequest) => void;
   onFailure?: () => void;
@@ -10,0 +12,0 @@ mmiConfigurationController: MmiConfigurationController;

src/WebsocketClient.ts

 import { MmiConfigurationController } from "@metamask-institutional/custody-keyring";
+import { ConnectionRequest } from "@metamask-institutional/types";
 import { EventEmitter } from "events";
@@ -16,2 +17,4 @@
   public handleUpdateEvent: (ev: any) => void;
+  public handleHandShakeEvent: (ev: any) => void;
+  public handleConnectionRequest: (ev: ConnectionRequest) => void;
   public onReconnect: () => void;
@@ -35,2 +38,4 @@ public onWebsocketClose: () => void;
     this.handleUpdateEvent = opts.handleUpdateEvent;
+    this.handleHandShakeEvent = opts.handleHandShakeEvent;
+    this.handleConnectionRequest = opts.handleConnectionRequest;
     this.onFailure = opts.onFailure;
@@ -97,2 +102,10 @@ this.mmiConfigurationController = opts.mmiConfigurationController;
 
+    if (msg.event === "handshake") {
+      this.handleHandShakeEvent(msg.data);
+    }
+
+    if (msg.event === "connection.request") {
+      this.handleConnectionRequest(msg.data);
+    }
+
     if (
@@ -99,0 +112,0 @@ msg.error &&

No alert changes

Improved metrics

Total package byte prevSize

34397

6.26%

Lines of code

488

5.63%

Dependency changes

• Updated

  @metamask-institutional/custody-keyring@^1.1.0

• Updated

  @metamask-institutional/sdk@^0.1.26

• Updated

  @metamask-institutional/types@^1.1.0