@tchain/tcabci-read-js-client 2.1.4 → 2.2.0

package/README.md

@@ -15,11 +15,11 @@ $ npm i @tchain/tcabci-read-js-client
 **Subscribe, Listen and Unsubscribe Example**
 
 ```js
-import TCAbciClient from '@tchain/tcabci-read-js-client'
+import TCaBCIClient from '@tchain/tcabci-read-js-client'
 
-const client = new tcAbciClient()
+const client = new TCaBCIClient()
 // OR
-const client = new tcAbciClient([
+const client = new TCaBCIClient([
   'https://read-node-01.transferchain.io',
   'wss://read-node-01.transferchain.io/ws',
 ])
@@ -32,6 +32,14 @@ client.SetListenCallback(() => {
   // If a transaction has been sent to your addresses, the callback you set here will be called.
 })
 
+client.SetErrorCallback(() => {
+  // If network errors will be called.
+})
+
+client.SetCloseCallback(() => {
+  // If server side close will be called.
+})
+
 client.Unsubscribe()
 client.Stop()
 ```

package/client.js

@@ -20,12 +20,47 @@ import {
 import Message from './message.js'
 import { toJSON } from './util.js'
 
-export default class TCAbciClient {
+
+/**
+ * @callback successCallback
+ * @param {Event} event
+ * @return void
+ */
+/**
+ * @callback errorCallback
+ * @param {Event} event
+ * @return void
+ */
+/**
+ * @callback closeCallback
+ * @param {Event} event
+ * @return void
+ */
+/**
+ * @callback listenCallback
+ * @param {*} message
+ * @return void
+ */
+export default class TCaBCIClient {
   subscribed = false
   subscribedAddresses = []
   connected = false
-  version = 'v2.1.4'
+  version = 'v2.2.0'
+  /**
+   * @type {?successCallback}
+   */
+  successCb = null
+  /**
+   * @type {?errorCallback}
+   */
   errorCb = null
+  /**
+   * @type {?closeCallback}
+   */
+  closeCb = null
+  /**
+   * @type {?listenCallback}
+   */
   listenCb = null
   wsLibrary = null
   ws = null
@@ -75,12 +110,44 @@ export default class TCAbciClient {
     return this.ws
   }
 
+  /**
+   * @param {successCallback} cb
+   * @constructor
+   */
+  SetSuccessCallback(cb) {
+    this.successCb = cb
+
+    return this
+  }
+
+  /**
+   * @param {errorCallback} cb
+   * @constructor
+   */
   SetErrorCallback(cb) {
     this.errorCb = cb
+
+    return this
   }
 
+  /**
+   * @param {closeCallback} cb
+   * @constructor
+   */
+  SetCloseCallback(cb) {
+    this.closeCb = cb
+
+    return this
+  }
+
+  /**
+   * @param {listenCallback} cb
+   * @constructor
+   */
   SetListenCallback(cb) {
     this.listenCb = cb
+
+    return this
   }
 
   async Start() {
@@ -94,6 +161,8 @@ export default class TCAbciClient {
     this.Disconnect(1000)
     this.setConnected(false)
     this.setSubscribed(false)
+
+    return this
   }
 
   Subscribe(addresses = [], txTypes = []) {
@@ -332,30 +401,55 @@ export default class TCAbciClient {
     if (this.getConnected()) {
       this.ws.reconnect(code)
     }
+
+    return this
+  }
+
+  callSuccessCallback(event) {
+    if (this.successCb) this.successCb(event)
+  }
+
+  callErrorCallback(event) {
+    if (this.errorCb) this.errorCb(event)
+  }
+
+  callCloseCallback(event) {
+    if (this.closeCb) this.closeCb(event)
+  }
+
+  callListenCallback(message) {
+    if (this.listenCb) this.listenCb(message)
   }
 
+
+  /**
+   * @return {Promise<Event>}
+   */
   async connect() {
-    return new Promise((resolve, reject) => {
-      if (this.getConnected()) {
-        reject(ALREADY_CONNECTED)
-      }
+    if (this.getConnected()) {
+      return Promise.reject(ALREADY_CONNECTED)
+    }
 
-      const options = {
-        WebSocket: this.wsLibrary,
-        connectionTimeout: 1000,
-        maxRetries: 10,
-      }
+    const options = {
+      WebSocket: this.wsLibrary,
+      connectionTimeout: 1000,
+      maxRetries: 10,
+    }
 
-      this.ws = new ReconnectingWebSocket(this.readNodeWSAddress, [], options)
+    this.ws = new ReconnectingWebSocket(this.readNodeWSAddress, [], options)
 
+    return new Promise((resolve, reject) => {
       this.ws.onerror = (event) => {
         this.setConnected(false)
-        if (this.errorCb) this.errorCb(event.error ?? event)
+        this.setSubscribed(false)
+        this.callErrorCallback(event)
 
-        reject(event.error ?? event)
+        reject(event)
       }
       this.ws.onopen = (event) => {
         this.setConnected(true)
+        this.callSuccessCallback(event)
+
         resolve(event)
       }
       this.ws.onmessage = (message) => {
@@ -363,14 +457,14 @@ export default class TCAbciClient {
           return { status: message.data }
         }
 
-        if (this.listenCb) this.listenCb(toJSON(message.data))
+        this.callListenCallback(toJSON(message.data))
       }
       this.ws.onclose = (event) => {
         this.setConnected(false)
+        this.setSubscribed(false)
+        this.callCloseCallback(event)
 
-        if (this.errorCb) this.errorCb(event.error ?? event)
-
-        reject(event.error ?? event)
+        resolve(event)
       }
     })
   }

package/client_test.js

@@ -1,4 +1,4 @@
-import TCAbciClient from './client.js'
+import TCaBCIClient from './client.js'
 import { WebSocket } from 'ws'
 import unitJS from 'unit.js'
 import {
@@ -19,9 +19,9 @@ import {
 //
 // const { randomString } = require('./util')
 
-describe('TCAbciClient TESTS', () => {
-  it('should start with valid parameters', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+describe('TCaBCIClient', () => {
+  it('start with valid parameters', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Start()
@@ -37,8 +37,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
 
-  it('should start with valid parameters and read node addresses', (done) => {
-    const client = new TCAbciClient([READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS], WebSocket)
+  it('start with valid parameters and read node addresses', (done) => {
+    const client = new TCaBCIClient([READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS], WebSocket)
 
     client
       .Start()
@@ -54,8 +54,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
 
-  it('should reconnect with start and valid parameters', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('reconnect with start and valid parameters', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Start()
@@ -71,21 +71,21 @@ describe('TCAbciClient TESTS', () => {
         unitJS.assert.equal(c2, false)
         unitJS.assert.equal(b2, false)
 
-        setTimeout(() => {
+        setTimeout((client, done) => {
           const { connected, subscribed } = client.Status()
 
           unitJS.assert.equal(connected, true)
           unitJS.assert.equal(subscribed, false)
           done()
-        }, 3100)
+        }, 3100, client, done)
       })
       .catch((err) => {
         done(err)
       })
   })
 
-  it('should subscribe with valid parameters', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('subscribe with valid parameters', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Start()
@@ -96,10 +96,12 @@ describe('TCAbciClient TESTS', () => {
           ],
           [TX_TYPE.TX_TYPE_STORAGE],
         )
+
         const { connected, subscribed } = client.Status()
 
         unitJS.assert.equal(connected, true)
         unitJS.assert.equal(subscribed, true)
+
         done()
       })
       .catch((err) => {
@@ -108,7 +110,7 @@ describe('TCAbciClient TESTS', () => {
   })
 
   it('should error subscribe with invalid tx type parameter', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Start()
@@ -126,8 +128,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
 
-  it('should unsubscribe with valid parameters', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('unsubscribe with valid parameters', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Start()
@@ -155,8 +157,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
 
-  it('should return last block', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('last block', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .LastBlock()
@@ -170,8 +172,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
 
-  it('should return transaction search result', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('transaction search result', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .TxSearch({
@@ -194,8 +196,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
   //
-  it('should return transaction summary result', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('transaction summary result', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .TxSummary({
@@ -209,6 +211,7 @@ describe('TCAbciClient TESTS', () => {
         unitJS.value(data.last_block_height).isGreaterThan(0)
         unitJS.value(data.total_count).isGreaterThan(0)
         unitJS.value(data.last_transaction).isNotEmpty()
+
         done()
       })
       .catch((err) => {
@@ -216,8 +219,8 @@ describe('TCAbciClient TESTS', () => {
       })
   })
 
-  it('should not broadcast transaction if type is incorrect', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('should error not broadcast transaction if type is incorrect', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     try {
       client.Broadcast({
@@ -234,8 +237,8 @@ describe('TCAbciClient TESTS', () => {
     }
   })
 
-  it('should not broadcast transaction', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+  it('should error not broadcast transaction', (done) => {
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Broadcast({
@@ -261,7 +264,7 @@ describe('TCAbciClient TESTS', () => {
   })
 
   it('should error in bulk tx if addresses count is zero', (done) => {
-    const client = new TCAbciClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket)
 
     client
       .Bulk([])
@@ -277,13 +280,13 @@ describe('TCAbciClient TESTS', () => {
   it('should error in bulk tx if addresses count is greater than 251', (done) => {
     const addresses = []
 
-    for (let i = 0; i < 252; i++) {
+    for (let i = 0; i < 51; i++) {
       addresses.push(
         '2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN',
       )
     }
 
-    const client = new TCAbciClient(null, WebSocket)
+    const client = new TCaBCIClient(null, WebSocket)
 
     client
       .Bulk(addresses)

package/constants.js

@@ -18,6 +18,7 @@ export const MESSAGE_TYPE = {
     TX_TYPE_TRANSFER_CANCEL: 'transfer_Cancel',
     TX_TYPE_TRANSFER_SENT: 'transfer_sent',
     TX_TYPE_TRANSFER_RECEIVE_DELETE: 'transfer_receive_delete',
+    TX_TYPE_TRANSFER_INFO: 'transfer_info',
     TX_TYPE_STORAGE: 'storage',
     TX_TYPE_STORAGE_DELETE: 'storage_delete',
     TX_TYPE_BACKUP: 'backup',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tchain/tcabci-read-js-client",
-  "version": "2.1.4",
+  "version": "2.2.0",
   "description": "TransferChain Fastest Read Network WebSocket Client",
   "main": "client.js",
   "type": "module",
@@ -23,15 +23,16 @@
   },
   "homepage": "https://github.com/TransferChain/tcabci-read-js-client#readme",
   "devDependencies": {
-    "mocha": "^10.7.3",
-    "nyc": "^17.1.0",
-    "unit.js": "^2.1.1",
-    "eslint": "^9.11.1",
+    "eslint": "^9.13.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.30.0",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^7.1.0",
+    "express": "^4.21.1",
+    "mocha": "^10.7.3",
+    "nyc": "^17.1.0",
     "prettier": "^3.3.3",
+    "unit.js": "^2.1.1",
     "ws": "^8.18.0"
   },
   "dependencies": {