@tchain/tcabci-read-js-client 2.5.11 → 2.6.2

package/client.d.ts

@@ -1,4 +1,4 @@
-import { TXType } from './transaction'
+import { Transaction, TXType } from './transaction'
 import { SuccessCallback, ErrorCallback, CloseCallback, ListenCallback } from './callback'
 
 declare class TCaBCIClient {
@@ -36,8 +36,8 @@ declare class TCaBCIClient {
   LastBlock(
     chainName?: null,
     chainVersion?: null,
-  ): { blocks: Record<string, any>; total_count: number }
-  Tx(id: string, signature: string): Promise<{ tx: Record<string, any> }>
+  ): { blocks: Transaction[]; total_count: number }
+  Tx(id: string, signature: string): Promise<{ tx: Transaction }>
   TxSummary({
     recipientAddrs,
     senderAddrs,
@@ -50,9 +50,9 @@ declare class TCaBCIClient {
     chain_name: string
     chain_version: string
     first_block_height: number
-    first_transaction: Record<string, any>
+    first_transaction: Transaction
     last_block_height: number
-    last_transaction: Record<string, any>
+    last_transaction: Transaction
     total_count: number
   }>
   TxSearch({
@@ -72,12 +72,14 @@ declare class TCaBCIClient {
     orderBy,
     chainName,
     chainVersion,
-  }): Promise<{ txs: Record<string, any>[]; total_count: number }>
+  }): Promise<{ txs: Transaction[]; total_count: number }>
   BroadcastCommit({
     id,
     version,
     type,
     data,
+    additional_data,
+    cipher_data,
     sender_addr,
     recipient_addr,
     sign,
@@ -88,6 +90,8 @@ declare class TCaBCIClient {
     version,
     type,
     data,
+    additional_data,
+    cipher_data,
     sender_addr,
     recipient_addr,
     sign,
@@ -98,6 +102,8 @@ declare class TCaBCIClient {
     version,
     type,
     data,
+    additional_data,
+    cipher_data,
     sender_addr,
     recipient_addr,
     sign,

package/client.js

@@ -10,27 +10,21 @@ import {
   TRANSACTION_NOT_BROADCAST,
   TRANSACTION_TYPE_NOT_VALID,
 } from './errors.js'
-import {
-  SUBSCRIBEMessage,
-  UNSUBSCRIBEMessage,
-  READ_NODE_ADDRESS,
-  READ_NODE_WS_ADDRESS,
-} from './constants.js'
-import Message from './message.js'
-import { isJSON, fromJSON } from './util.js'
+import { READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS } from './constants.js'
+import Message, { SUBSCRIBEMessage, UNSUBSCRIBEMessage } from './message.js'
 import { Options } from './websocketOptions.js'
 import { TWebSocket } from './websocket.js'
-import { TX_TYPE_LIST } from './transaction.js'
+import { Transaction, TX_TYPE_LIST } from './transaction.js'
 
 /**
  * @callback SuccessCallback
- * @param {Event} event
+ * @param {Transaction} event
  * @return void
  */
 
 /**
  * @callback ErrorCallback
- * @param {Event} event
+ * @param {Error|Event|ErrorEvent} event
  * @return void
  */
 
@@ -53,7 +47,7 @@ export default class TCaBCIClient {
   _connected = false
   _chainName = 'transferchain'
   _chainVersion = 'v1'
-  _version = `v2.5.11`
+  _version = `v2.6.2`
   /**
    * @type {?SuccessCallback}
    */
@@ -249,7 +243,7 @@ export default class TCaBCIClient {
     if (!this.IsConnected()) throw new Error(NOT_CONNECTED)
 
     const addrs = [],
-      sdata = signedData ?? this.SubscribedSignedData
+      _signedData = signedData ?? this.SubscribedSignedData
 
     addrs.push(...addresses)
 
@@ -264,7 +258,13 @@ export default class TCaBCIClient {
       addrs.push(...newAddress)
     }
 
-    const message = new Message(true, SUBSCRIBEMessage, addrs, sdata, txTypes)
+    const message = new Message(
+      true,
+      SUBSCRIBEMessage,
+      addrs,
+      _signedData,
+      txTypes,
+    )
 
     this._ws.send(message.ToJSON())
     this._setSubscribeAddresses(addrs, true)
@@ -294,7 +294,7 @@ export default class TCaBCIClient {
   /**
    * @param {?string} chainName
    * @param {?string} chainVersion
-   * @return {Promise<{blocks: Object<string, *>, total_count: number}>}
+   * @return {Promise<{blocks: Transaction[], total_count: number}>}
    */
   LastBlock(chainName = null, chainVersion = null) {
     return this._httpClient(
@@ -304,7 +304,15 @@ export default class TCaBCIClient {
       },
     )
       .then((res) => {
-        return { blocks: res.data, total_count: res.total_count }
+        const data = []
+
+        for (const _data of res.data) {
+          const { transaction, error } = Transaction.FromObject(_data)
+          if (error) return Promise.reject(error)
+          data.push(transaction)
+        }
+
+        return { blocks: data, total_count: res.total_count }
       })
       .catch((e) => this._handleRestError(e, new Error(BLOCK_NOT_FOUND)))
   }
@@ -324,7 +332,10 @@ export default class TCaBCIClient {
       headers: { 'X-Signature': signature },
     })
       .then((res) => {
-        return { tx: res.data }
+        const { transaction, error } = Transaction.FromObject(res.data)
+        if (error) return Promise.reject(error)
+
+        return { tx: transaction }
       })
       .catch((e) => this._handleRestError(e))
   }
@@ -337,7 +348,15 @@ export default class TCaBCIClient {
    * @param {?Array<string>} types
    * @param {?string} chainName
    * @param {?string} chainVersion
-   * @return {Promise<any>}
+   * @return {Promise<{
+   *           chain_name: string,
+   *           chain_version: string,
+   *           first_block_height: number,
+   *           first_transaction: Transaction,
+   *           last_block_height: number,
+   *           last_transaction: Transaction,
+   *           total_count: number,
+   *         }>}
    */
   TxSummary({
     recipientAddrs,
@@ -364,13 +383,22 @@ export default class TCaBCIClient {
       }),
     })
       .then((res) => {
+        const { transaction, error } = Transaction.FromObject(
+          res.data.first_transaction,
+        )
+        if (error) return Promise.reject(error)
+
+        const { transaction: lastTransaction, error: errorTwo } =
+          Transaction.FromObject(res.data.last_transaction)
+        if (errorTwo) return Promise.reject(errorTwo)
+
         return {
           chain_name: res.data.chain_name,
           chain_version: res.data.chain_version,
           first_block_height: res.data.first_block_height,
-          first_transaction: res.data.first_transaction,
+          first_transaction: transaction,
           last_block_height: res.data.last_block_height,
-          last_transaction: res.data.last_transaction,
+          last_transaction: lastTransaction,
           total_count: res.total_count,
         }
       })
@@ -394,7 +422,7 @@ export default class TCaBCIClient {
    * @param {string} orderBy
    * @param {?string} chainName
    * @param {?string} chainVersion
-   * @return {Promise<any>}
+   * @return {Promise<{txs: Transaction[], total_count: number}>}
    */
   TxSearch({
     heightOperator,
@@ -434,8 +462,16 @@ export default class TCaBCIClient {
       }),
     })
       .then((res) => {
+        const data = []
+
+        for (const _data of res.data) {
+          const { transaction, error } = Transaction.FromObject(_data)
+          if (error) return Promise.reject(error)
+          data.push(transaction)
+        }
+
         return {
-          txs: res.data,
+          txs: data,
           total_count: res.total_count,
         }
       })
@@ -484,6 +520,8 @@ export default class TCaBCIClient {
    * @param {number} version
    * @param {string} type
    * @param {string} data
+   * @param {?string} additional_data
+   * @param {?string} cipher_data
    * @param {string} sender_addr
    * @param {string} recipient_addr
    * @param {string} sign
@@ -495,6 +533,8 @@ export default class TCaBCIClient {
     version,
     type,
     data,
+    additional_data = null,
+    cipher_data = null,
     sender_addr,
     recipient_addr,
     sign,
@@ -506,6 +546,8 @@ export default class TCaBCIClient {
         version,
         type,
         data,
+        additional_data,
+        cipher_data,
         sender_addr,
         recipient_addr,
         sign,
@@ -521,6 +563,8 @@ export default class TCaBCIClient {
    * @param {number} version
    * @param {string} type
    * @param {string} data
+   * @param {?string} additional_data
+   * @param {?string} cipher_data
    * @param {string} sender_addr
    * @param {string} recipient_addr
    * @param {string} sign
@@ -532,6 +576,8 @@ export default class TCaBCIClient {
     version,
     type,
     data,
+    additional_data = null,
+    cipher_data = null,
     sender_addr,
     recipient_addr,
     sign,
@@ -543,6 +589,8 @@ export default class TCaBCIClient {
         version,
         type,
         data,
+        additional_data,
+        cipher_data,
         sender_addr,
         recipient_addr,
         sign,
@@ -554,7 +602,18 @@ export default class TCaBCIClient {
   }
 
   broadcast(
-    { id, version, type, data, sender_addr, recipient_addr, sign, fee },
+    {
+      id,
+      version,
+      type,
+      data,
+      additional_data = null,
+      cipher_data = null,
+      sender_addr,
+      recipient_addr,
+      sign,
+      fee,
+    },
     sync = false,
     commit = false,
   ) {
@@ -571,6 +630,8 @@ export default class TCaBCIClient {
           version,
           type,
           data,
+          ...(additional_data ? { additional_data } : {}),
+          ...(cipher_data ? { cipher_data } : {}),
           sender_addr,
           recipient_addr,
           sign,
@@ -614,22 +675,6 @@ export default class TCaBCIClient {
     })
   }
 
-  _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<TWebSocket>}
    */
@@ -658,9 +703,7 @@ export default class TCaBCIClient {
         return { status: message.data }
       }
 
-      this._callListenCallback(
-        !isJSON(message.data) ? message.data : fromJSON(message.data),
-      )
+      this._callListenCallback(message.data)
     })
 
     this._ws.addCloseListener((e) => {
@@ -723,15 +766,33 @@ export default class TCaBCIClient {
     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) {
+    const { transaction, error } = Transaction.FromJSON(message)
+    if (error) this._callErrorCallback(error)
+    else if (this._listenCb) this._listenCb(transaction)
+  }
+
   /**
    * @param {string} uri
    * @param {RequestInit} req
-   * @return {Promise<any>}
+   * @return {Promise<Record<string, any>>}
    */
   _httpClient(uri, req) {
     req.cache = 'no-cache'
     req.headers = {
-      Client: `tcabaci-read-js-client-${this._version}`,
+      Client: `tcabaci-read-js-client/${this._version}`,
     }
     req.priority = 'high'
 

package/constants.js

@@ -1,5 +1,2 @@
-export const SUBSCRIBEMessage = 'subscribe',
-  UNSUBSCRIBEMessage = 'unsubscribe',
-  CHARACTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789',
-  READ_NODE_ADDRESS = 'https://read-node-01.transferchain.io',
+export const READ_NODE_ADDRESS = 'https://read-node-01.transferchain.io',
   READ_NODE_WS_ADDRESS = 'wss://read-node-01.transferchain.io/ws'

package/message.js

@@ -1,7 +1,9 @@
 import { INVALID_ARGUMENTS, INVALID_ARGUMENT_WITH_CS } from './errors.js'
-import { SUBSCRIBEMessage, UNSUBSCRIBEMessage } from './constants.js'
 import { TX_TYPE_LIST } from './transaction.js'
 
+export const SUBSCRIBEMessage = 'subscribe',
+  UNSUBSCRIBEMessage = 'unsubscribe'
+
 export default class Message {
   _is_web = false
   _type = ''

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tchain/tcabci-read-js-client",
-  "version": "2.5.11",
+  "version": "2.6.2",
   "description": "TransferChain Fastest Read Network WebSocket Client",
   "main": "client.js",
   "type": "module",
@@ -26,20 +26,20 @@
   },
   "homepage": "https://github.com/TransferChain/tcabci-read-js-client#readme",
   "devDependencies": {
-    "@eslint/js": "^9.39.1",
+    "@eslint/js": "^9.39.2",
     "@types/chai": "^5.2.3",
-    "chai": "^6.2.1",
-    "eslint": "^9.39.1",
+    "chai": "^6.2.2",
+    "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-prettier": "^5.5.5",
     "esm": "^3.2.25",
     "express": "^5.2.1",
     "globals": "^16.5.0",
     "mocha": "^11.7.5",
     "nyc": "^17.1.0",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.1",
     "unit.js": "^2.1.1",
-    "ws": "^8.18.3"
+    "ws": "^8.19.0"
   },
   "dependencies": {
     "reconnecting-websocket": "^4.4.0"

package/transaction.d.ts

@@ -1,4 +1,4 @@
-export declare type TXType = string;
+export declare type TXType = string
 
 export declare const TX_TYPE_MASTER: TXType,
   TX_TYPE_ADDRESS: TXType,
@@ -50,34 +50,43 @@ export declare const TX_TYPE_MASTER: TXType,
   TX_TYPE_PASSWD_DATAV2: TXType,
   TX_TYPE_PASSWD_DATAV2_POLICY: TXType,
   TX_TYPE_COLLECTION: TXType,
-  TX_TYPE_COLLECTION_POLICY: TXType;
+  TX_TYPE_COLLECTION_POLICY: TXType
 
-export declare const TX_TYPE_LIST: TXType[];
+export declare const TX_TYPE_LIST: TXType[]
 
 export declare class Transaction {
-  constructor(
-    id: string,
-    height: number,
-    version: number,
-    typ: TXType,
-    sender_addr: string,
-    recipient_addr: string,
-    data: string,
-    sign: string,
-    fee: number,
-    hash: string,
-    inserted_at: Date,
-  )
-  get ID(): string;
-  get Height(): number;
-  get Version(): number;
-  get Typ(): TXType;
-  get SenderAddr(): string;
-  get RecipientAddr(): string;
-  get Data(): string;
-  get Sign(): string;
-  get Fee(): number;
-  get Hash(): string;
-  get InsertedAt(): Date;
-  ToJSON(): string;
+  constructor({
+    id,
+    height,
+    version,
+    typ,
+    sender_addr,
+    recipient_addr,
+    data,
+    sign,
+    fee,
+    hash,
+    inserted_at,
+    additionalData,
+    cipherData,
+  }?: Record<string, any>)
+  get ID(): string
+  get Height(): number
+  get Version(): number
+  get Typ(): TXType
+  get SenderAddr(): string
+  get RecipientAddr(): string
+  get Data(): string
+  get AdditionalData(): string
+  get CipherData(): string
+  get Sign(): string
+  get Fee(): number
+  get Hash(): string
+  get InsertedAt(): Date
+  static FromJSON(value: string): { transaction?: Transaction; error?: Error }
+  static FromObject(obj: Record<string, any>): {
+    transaction?: Transaction
+    error?: Error
+  }
+  ToJSON(): string
 }

package/transaction.js

@@ -106,13 +106,17 @@ export const TX_TYPE_MASTER = 'initial_storage',
   ]
 
 export class Transaction {
+  _order
   _id
+  _identifier
   _height
   _version
   _typ
   _sender_addr
   _recipient_addr
   _data
+  _additionalData
+  _cipherData
   _sign
   _fee
   _hash
@@ -130,9 +134,11 @@ export class Transaction {
    * @param {number} fee
    * @param {string} hash
    * @param {Date} inserted_at
+   * @param {?string} additionalData
+   * @param {?string} cipherData
    * @throws Error
    */
-  constructor(
+  constructor({
     id,
     height,
     version,
@@ -144,7 +150,9 @@ export class Transaction {
     fee,
     hash,
     inserted_at,
-  ) {
+    additionalData = null,
+    cipherData = null,
+  } = {}) {
     this._id = id
     this._height = height
     this._version = version
@@ -156,8 +164,8 @@ export class Transaction {
     this._fee = fee
     this._hash = hash
     this._inserted_at = inserted_at
-
-    this._validate()
+    if (additionalData) this._additionalData = additionalData
+    if (cipherData) this._cipherData = cipherData
   }
 
   get ID() {
@@ -188,6 +196,14 @@ export class Transaction {
     return this._data
   }
 
+  get AdditionalData() {
+    return this._additionalData
+  }
+
+  get CipherData() {
+    return this._cipherData
+  }
+
   get Sign() {
     return this._sign
   }
@@ -204,6 +220,57 @@ export class Transaction {
     return this._inserted_at
   }
 
+  static FromJSON(value) {
+    try {
+      const parsed = JSON.parse(value),
+        tx = new Transaction()
+
+      if (parsed.order) tx._order = parsed.order
+      tx._id = parsed.id
+      if (parsed.identifier) tx._identifier = parsed.identifier
+      tx._height = parsed.height
+      tx._version = parsed.version
+      tx._sender_addr = parsed.sender_addr
+      tx._recipient_addr = parsed.recipient_addr
+      tx._data = parsed.data
+      if (parsed.additional_data) tx._additionalData = parsed.additional_data
+      if (parsed.cipher_data) tx._cipherData = parsed.cipher_data
+      tx._sign = parsed.sign
+      tx._fee = parsed.fee
+      tx._hash = parsed.hash
+      tx._inserted_at = new Date(parsed.inserted_at)
+
+      return { transaction: tx, error: null }
+    } catch (e) {
+      return { transaction: null, error: e }
+    }
+  }
+
+  static FromObject(obj) {
+    try {
+      const tx = new Transaction()
+
+      if (obj.order) tx._order = obj.order
+      tx._id = obj.id
+      if (obj.identifier) tx._identifier = obj.identifier
+      tx._height = obj.height
+      tx._version = obj.version
+      tx._sender_addr = obj.sender_addr
+      tx._recipient_addr = obj.recipient_addr
+      tx._data = obj.data
+      if (obj.additional_data) tx._additionalData = obj.additional_data
+      if (obj.cipher_data) tx._cipherData = obj.cipher_data
+      tx._sign = obj.sign
+      tx._fee = obj.fee
+      tx._hash = obj.hash
+      tx._inserted_at = new Date(obj.inserted_at)
+
+      return { transaction: tx, error: null }
+    } catch (e) {
+      return { transaction: null, error: e }
+    }
+  }
+
   /**
    * @return {string}
    * @throws Error
@@ -223,11 +290,15 @@ export class Transaction {
       fee: this._fee,
       hash: this._hash,
       inserted_at: this._inserted_at.toISOString(),
+      ...(this._additionalData
+        ? { additional_data: this._additionalData }
+        : {}),
+      ...(this._cipherData ? { cipher_data: this._cipherData } : {}),
     })
   }
 
-  _validate() {
-    if (typeof this._id !== 'number')
+  Validate() {
+    if (typeof this._id === 'undefined')
       throw new Error(INVALID_ARGUMENT_WITH_CS('id'))
     if (typeof this._height !== 'number')
       throw new Error(INVALID_ARGUMENT_WITH_CS('height'))
@@ -241,8 +312,18 @@ export class Transaction {
       throw new Error(INVALID_ARGUMENT_WITH_CS('senderAddr'))
     if (typeof this._recipient_addr !== 'string')
       throw new Error(INVALID_ARGUMENT_WITH_CS('recipientAddr'))
-    if (typeof this._data !== 'object')
+    if (typeof this._data !== 'string')
       throw new Error(INVALID_ARGUMENT_WITH_CS('data'))
+    if (
+      typeof this._additionalData !== 'undefined' &&
+      typeof this._additionalData !== 'string'
+    )
+      throw new Error(INVALID_ARGUMENT_WITH_CS('additionalData'))
+    if (
+      typeof this._cipherData !== 'undefined' &&
+      typeof this._cipherData !== 'string'
+    )
+      throw new Error(INVALID_ARGUMENT_WITH_CS('cipherData'))
     if (typeof this._sign !== 'object')
       throw new Error(INVALID_ARGUMENT_WITH_CS('sign'))
     if (typeof this._fee !== 'number')

package/websocket.js

@@ -26,6 +26,8 @@ export class TWebSocket {
   _errorCallbacks = []
   _closeCallbacks = []
 
+  _connectionErrorCount = 0
+
   /**
    * @param {Options} options
    * @constructor
@@ -251,6 +253,8 @@ export class TWebSocket {
   }
 
   _make() {
+    if (this._connectionErrorCount > 15) return
+
     this._client = new ReconnectingWebSocket(
       this._options.url,
       this._options.protocols,
@@ -258,6 +262,7 @@ export class TWebSocket {
     )
 
     this._openListener = (e) => {
+      this._connectionErrorCount = 0
       this._onOpen(e)
     }
     this._client.addEventListener('open', this._openListener)
@@ -274,6 +279,15 @@ export class TWebSocket {
 
     this._errorListener = (e) => {
       this._onError(e)
+      if (this._connectionErrorCount > 15) {
+        this._onError(new Error('Internet connectivity problem!'))
+        this._disconnect().catch((err) => {
+          this._onError(err)
+        })
+
+        return
+      }
+      this._connectionErrorCount++
     }
     this._client.addEventListener('error', this._errorListener)
   }
@@ -308,6 +322,7 @@ export class TWebSocket {
     this._messageListener = () => {}
 
     this._client.close(code)
+    this._connectionErrorCount = 0
   }
 
   /**
@@ -319,7 +334,7 @@ export class TWebSocket {
   }
 
   /**
-   * @param {ErrorEvent} event
+   * @param {Error|Event|ErrorEvent} event
    * @private
    */
   _onError(event) {

package/websocketOptions.js

@@ -13,7 +13,7 @@ export class Options {
   _protocols = []
   _customWS
   _endpoints = ['ws', 'longpoll']
-  _version = `v2.5.11`
+  _version = `v2.6.2`
 
   _maxConnectionDelay = 10000
   _minReconnectionDelay = 1000 + Math.random() * 4000