@tchain/tcabci-read-js-client 1.3.3 → 1.3.4

package/client.js

@@ -18,7 +18,7 @@ class TCAbciClient {
     subscribed = false
     subscribedAddresses = []
     connected = false
-    version = "v1.3.3"
+    version = "v1.3.4"
     errorCb = null
     listenCb = null
     ws = null
@@ -57,18 +57,31 @@ class TCAbciClient {
         this.setConnected(false)
         this.setSubscribed(false)
     }
-    Subscribe(addresses) {
+    Subscribe(addresses = [], txTypes = []) {
         if (!Array.isArray(addresses)) {
             throw INVALID_ARGUMENTS
         }
+
+        if (txTypes && !Array.isArray(addresses)) {
+            throw INVALID_ARGUMENTS
+        }
+
+        if (txTypes.length && txTypes.length > Object.values(TX_TYPE).length) {
+            throw INVALID_ARGUMENTS
+        }
+
         if (!this.getConnected()) {
             throw NOT_CONNECTED
         }
+
         let addrs = []
+
         if (addresses.length === 0) {
             throw ADDRESSES_IS_EMPTY
         }
+
         addrs = addresses
+
         if (this.getSubscribeAddresses().length > 0) {
             let newAddress = []
             for (let i = 0; i < addresses.length; i++) {
@@ -78,7 +91,8 @@ class TCAbciClient {
             }
             addrs = newAddress
         }
-        const message = new Message(true, MESSAGE_TYPE.SUBSCRIBE, addrs)
+
+        const message = new Message(true, MESSAGE_TYPE.SUBSCRIBE, addrs, txTypes)
         this.ws.send(message.ToJSONString())
         this.setSubscribeAddresses(addrs, true)
         this.setSubscribed(true)

package/client_test.js

@@ -63,7 +63,7 @@ describe("TCAbciClient TESTS", () => {
         const client = new tcAbciClient()
         client.Start()
             .then(() => {
-                client.Subscribe(["2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN"])
+                client.Subscribe(["2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN"], [TX_TYPE.TX_TYPE_STORAGE])
                 const { connected, subscribed } = client.Status()
                 unitJS.assert.equal(connected, true)
                 unitJS.assert.equal(subscribed, true)
@@ -74,6 +74,17 @@ describe("TCAbciClient TESTS", () => {
             })
     })
 
+  it('should error subscribe with invalid tx type parameter',(done) => {
+    const client = new tcAbciClient()
+    client.Start()
+      .then(() => {
+        client.Subscribe(["2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN"], ['invalid'])
+      })
+      .catch(() => {
+        done()
+      })
+  })
+
     it('should unsubscribe with valid parameters',(done) => {
         const client = new tcAbciClient()
         client.Start()

package/errors.js

@@ -1,14 +1,25 @@
-module.exports = {
-    ALREADY_CONNECTED: new Error("Already connected"),
-    NOT_CONNECTED: new Error("Not connected"),
-    INVALID_ARGUMENTS: new Error("Check your arguments"),
-    INVALID_ARGUMENT_WITH_CS: (val) => {
-        return new Error(this.INVALID_ARGUMENTS + " " + val)
+const ALREADY_CONNECTED = new Error("Already connected"),
+    NOT_CONNECTED = new Error("Not connected"),
+    INVALID_ARGUMENTS = new Error("Check your arguments"),
+    INVALID_ARGUMENT_WITH_CS = (val) => {
+        return new Error(INVALID_ARGUMENTS + " " + val)
     },
-    NOT_SUBSCRIBED: new Error("Not subscribed"),
-    ALREADY_SUBSCRIBED: new Error("Already subscribed"),
-    ADDRESSES_IS_EMPTY: new Error("Addresses is empty"),
-    BLOCK_NOT_FOUND: new Error("Block does not exist"),
-    TRANSACTION_TYPE_NOT_VALID: new Error("Transaction type is not valid"),
-    TRANSACTION_NOT_BROADCAST: new Error("Transaction can not be broadcast")
+    NOT_SUBSCRIBED = new Error("Not subscribed"),
+    ALREADY_SUBSCRIBED = new Error("Already subscribed"),
+    ADDRESSES_IS_EMPTY = new Error("Addresses is empty"),
+    BLOCK_NOT_FOUND = new Error("Block does not exist"),
+    TRANSACTION_TYPE_NOT_VALID = new Error("Transaction type is not valid"),
+    TRANSACTION_NOT_BROADCAST = new Error("Transaction can not be broadcast")
+
+module.exports = {
+    ALREADY_CONNECTED,
+    NOT_CONNECTED,
+    INVALID_ARGUMENTS,
+    INVALID_ARGUMENT_WITH_CS,
+    NOT_SUBSCRIBED,
+    ALREADY_SUBSCRIBED,
+    ADDRESSES_IS_EMPTY,
+    BLOCK_NOT_FOUND,
+    TRANSACTION_TYPE_NOT_VALID,
+    TRANSACTION_NOT_BROADCAST,
 }

package/message.js

@@ -1,13 +1,15 @@
 const { INVALID_ARGUMENTS, INVALID_ARGUMENT_WITH_CS } = require("./errors")
-const { MESSAGE_TYPE } = require("./constants")
+const { MESSAGE_TYPE, TX_TYPE} = require("./constants")
 class Message {
     #is_web = false
     #type = ""
     #addrs = []
-    constructor(isWeb, type, addrs) {
+    #txTypes = []
+    constructor(isWeb, type, addrs, txTypes = []) {
         this.#is_web = isWeb
         this.#type = type
         this.#addrs = addrs
+        this.#txTypes = txTypes
     }
 
     ToJSONString() {
@@ -15,7 +17,8 @@ class Message {
         return JSON.stringify({
             "is_web": this.#is_web,
             "type": this.#type,
-            "addrs": this.#addrs
+            "addrs": this.#addrs,
+            ...(this.#txTypes.length > 0 ? { "tx_types": this.#txTypes } : {})
         })
     }
 
@@ -23,15 +26,29 @@ class Message {
         if (typeof this.#is_web !== "boolean") {
             throw INVALID_ARGUMENT_WITH_CS("is_web")
         }
+
         if (typeof this.#type !== "string") {
             throw INVALID_ARGUMENT_WITH_CS("type")
         }
+
         if (!Array.isArray(this.#addrs)) {
             throw INVALID_ARGUMENT_WITH_CS("addrs")
         }
+
         if ([MESSAGE_TYPE.SUBSCRIBE, MESSAGE_TYPE.UNSUBSCRIBE].indexOf(this.#type) === -1) {
             throw INVALID_ARGUMENTS
         }
+
+        if (this.#txTypes.length) {
+            let vals = Object.values(TX_TYPE)
+            for (let i = 0; i < this.#txTypes.length; i++) {
+                if (vals.indexOf(this.#txTypes[i]) === -1) {
+                    throw INVALID_ARGUMENT_WITH_CS('tx_types')
+                }
+            }
+
+            vals = []
+        }
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tchain/tcabci-read-js-client",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "TransferChain Fastest Read Network WebSocket Client",
   "main": "client.js",
   "type": "commonjs",