@tchain/tcabci-read-js-client 2.6.3 → 2.6.5

package/callback.d.ts

@@ -1,4 +1,6 @@
+import { Transaction } from './transaction'
+
 export declare type SuccessCallback = (event: Event) => void
 export declare type ErrorCallback = (event: Event) => void
 export declare type CloseCallback = (event: Event) => void
-export declare type ListenCallback = (event: Event) => void
+export declare type ListenCallback = (tx: Transaction) => void

package/client.js

@@ -47,7 +47,7 @@ export default class TCaBCIClient {
   _connected = false
   _chainName = 'transferchain'
   _chainVersion = 'v1'
-  _version = `v2.6.3`
+  _version = `v2.6.5`
   /**
    * @type {?SuccessCallback}
    */
@@ -383,20 +383,29 @@ export default class TCaBCIClient {
       }),
     })
       .then((res) => {
-        const { transaction, error } = Transaction.FromObject(
-          res.data.first_transaction,
-        )
-        if (error) return Promise.reject(error)
+        let firstTransaction, lastTransaction
 
-        const { transaction: lastTransaction, error: errorTwo } =
-          Transaction.FromObject(res.data.last_transaction)
-        if (errorTwo) return Promise.reject(errorTwo)
+        if (res.data.first_transaction) {
+          const { transaction, error } = Transaction.FromObject(
+            res.data.first_transaction,
+          )
+          if (error) return Promise.reject(error)
+          firstTransaction = transaction
+        }
+
+        if (res.data.last_transaction) {
+          const { transaction, error: errorTwo } = Transaction.FromObject(
+            res.data.last_transaction,
+          )
+          if (errorTwo) return Promise.reject(errorTwo)
+          lastTransaction = transaction
+        }
 
         return {
           chain_name: res.data.chain_name,
           chain_version: res.data.chain_version,
           first_block_height: res.data.first_block_height,
-          first_transaction: transaction,
+          first_transaction: firstTransaction,
           last_block_height: res.data.last_block_height,
           last_transaction: lastTransaction,
           total_count: res.total_count,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tchain/tcabci-read-js-client",
-  "version": "2.6.3",
+  "version": "2.6.5",
   "description": "TransferChain Fastest Read Network WebSocket Client",
   "main": "client.js",
   "type": "module",
@@ -26,10 +26,10 @@
   },
   "homepage": "https://github.com/TransferChain/tcabci-read-js-client#readme",
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
+    "@eslint/js": "^10.0.1",
     "@types/chai": "^5.2.3",
     "chai": "^6.2.2",
-    "eslint": "^9.39.2",
+    "eslint": "^10.0.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.5",
     "esm": "^3.2.25",

package/transaction.d.ts

@@ -69,7 +69,10 @@ export declare class Transaction {
     inserted_at,
     additionalData,
     cipherData,
+    chainName,
+    chainVersion,
   }?: Record<string, any>)
+  get Order(): number
   get ID(): string
   get Height(): number
   get Version(): number
@@ -83,10 +86,13 @@ export declare class Transaction {
   get Fee(): number
   get Hash(): string
   get InsertedAt(): Date
+  get ChainName(): string
+  get ChainVersion(): string
   static FromJSON(value: string): { transaction?: Transaction; error?: Error }
   static FromObject(obj: Record<string, any>): {
     transaction?: Transaction
     error?: Error
   }
   ToJSON(): string
+  ToObject(): Record<string, any>
 }

package/transaction.js

@@ -121,6 +121,8 @@ export class Transaction {
   _fee
   _hash
   _inserted_at
+  _chainName
+  _chainVersion
 
   /**
    * @param {string} id
@@ -136,6 +138,8 @@ export class Transaction {
    * @param {Date} inserted_at
    * @param {?string} additionalData
    * @param {?string} cipherData
+   * @param {?string} chainName
+   * @param {?string} chainVersion
    * @throws Error
    */
   constructor({
@@ -152,6 +156,8 @@ export class Transaction {
     inserted_at,
     additionalData = null,
     cipherData = null,
+    chainName = null,
+    chainVersion = null,
   } = {}) {
     this._id = id
     this._height = height
@@ -166,6 +172,12 @@ export class Transaction {
     this._inserted_at = inserted_at
     if (additionalData) this._additionalData = additionalData
     if (cipherData) this._cipherData = cipherData
+    if (chainName) this._chainName = chainName
+    if (chainVersion) this._chainVersion = chainVersion
+  }
+
+  get Order() {
+    return this._order
   }
 
   get ID() {
@@ -220,26 +232,48 @@ export class Transaction {
     return this._inserted_at
   }
 
+  get ChainName() {
+    return this._chainName
+  }
+
+  get ChainVersion() {
+    return this._chainVersion
+  }
+
   static FromJSON(value) {
+    if (typeof value !== 'string')
+      return {
+        transaction: null,
+        error: new Error('invalid json payload'),
+      }
+
     try {
       const parsed = JSON.parse(value),
         tx = new Transaction()
 
-      if (parsed.order) tx._order = parsed.order
+      if (typeof parsed.order !== 'undefined') tx._order = parsed.order
       tx._id = parsed.id
       tx._typ = parsed.typ
-      if (parsed.identifier) tx._identifier = parsed.identifier
+      if (typeof parsed.identifier !== 'undefined')
+        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
+      if (typeof parsed.additional_data !== 'undefined')
+        tx._additionalData = parsed.additional_data
+      if (typeof parsed.cipher_data !== 'undefined')
+        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)
+      if (typeof parsed.inserted_at !== 'undefined')
+        tx._inserted_at = new Date(parsed.inserted_at)
+      if (typeof parsed.chain_name !== 'undefined')
+        this._chainName = parsed.chain_name
+      if (typeof parsed.chain_version !== 'undefined')
+        this._chainVersion = parsed.chain_version
 
       return { transaction: tx, error: null }
     } catch (e) {
@@ -248,24 +282,37 @@ export class Transaction {
   }
 
   static FromObject(obj) {
+    if (!obj)
+      return {
+        transaction: null,
+        error: new Error('invalid obj payload'),
+      }
+
     try {
       const tx = new Transaction()
 
-      if (obj.order) tx._order = obj.order
+      if (typeof obj.order !== 'undefined') tx._order = obj.order
       tx._id = obj.id
       tx._typ = obj.typ
-      if (obj.identifier) tx._identifier = obj.identifier
+      if (typeof obj.identifier !== 'undefined') 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
+      if (typeof obj.additional_data !== 'undefined')
+        tx._additionalData = obj.additional_data
+      if (typeof obj.cipher_data !== 'undefined')
+        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)
+      if (typeof obj.inserted_at !== 'undefined')
+        tx._inserted_at = new Date(obj.inserted_at)
+      if (typeof obj.chain_name !== 'undefined')
+        this._chainName = obj.chain_name
+      if (typeof obj.chain_version !== 'undefined')
+        this._chainVersion = obj.chain_version
 
       return { transaction: tx, error: null }
     } catch (e) {
@@ -291,14 +338,48 @@ export class Transaction {
       sign: this._sign,
       fee: this._fee,
       hash: this._hash,
-      inserted_at: this._inserted_at.toISOString(),
+      ...(this._inserted_at
+        ? { inserted_at: this._inserted_at.toISOString() }
+        : {}),
       ...(this._additionalData
         ? { additional_data: this._additionalData }
         : {}),
       ...(this._cipherData ? { cipher_data: this._cipherData } : {}),
+      ...(this._chainName ? { chain_name: this._chainName } : {}),
+      ...(this._chainVersion ? { chain_version: this._chainVersion } : {}),
     })
   }
 
+  /**
+   * @return {Object<string, *>}
+   * @throws Error
+   */
+  ToObject() {
+    this.Validate()
+
+    return {
+      id: this._id,
+      height: this._height,
+      version: this._version,
+      typ: this._typ,
+      sender_addr: this._sender_addr,
+      recipient_addr: this._recipient_addr,
+      data: this._data,
+      sign: this._sign,
+      fee: this._fee,
+      hash: this._hash,
+      ...(this._inserted_at
+        ? { inserted_at: this._inserted_at.toISOString() }
+        : {}),
+      ...(this._additionalData
+        ? { additional_data: this._additionalData }
+        : {}),
+      ...(this._cipherData ? { cipher_data: this._cipherData } : {}),
+      ...(this._chainName ? { chain_name: this._chainName } : {}),
+      ...(this._chainVersion ? { chain_version: this._chainVersion } : {}),
+    }
+  }
+
   Validate() {
     if (typeof this._id === 'undefined')
       throw new Error(INVALID_ARGUMENT_WITH_CS('id'))
@@ -314,23 +395,23 @@ 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 !== 'string')
+    if (typeof this._data === 'undefined')
       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')
+    if (typeof this._sign === 'undefined')
       throw new Error(INVALID_ARGUMENT_WITH_CS('sign'))
     if (typeof this._fee !== 'number')
       throw new Error(INVALID_ARGUMENT_WITH_CS('fee'))
-    if (!(this._inserted_at instanceof Date))
+    if (this._inserted_at && !(this._inserted_at instanceof Date))
       throw new Error(INVALID_ARGUMENT_WITH_CS('insertedAt'))
+    if (
+      typeof this._chainName !== 'undefined' &&
+      typeof this._chainName !== 'string'
+    )
+      throw new Error(INVALID_ARGUMENT_WITH_CS('chainName'))
+    if (
+      typeof this._chainVersion !== 'undefined' &&
+      typeof this._chainVersion !== 'string'
+    )
+      throw new Error(INVALID_ARGUMENT_WITH_CS('chainVersion'))
   }
 }

package/websocketOptions.js

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