@tchain/tcabci-read-js-client 2.3.0 → 2.4.0

package/client.js

@@ -18,7 +18,7 @@ import {
   TX_TYPE,
 } from './constants.js'
 import Message from './message.js'
-import { toJSON } from './util.js'
+import { isJSON, toJSON } from './util.js'
 
 /**
  * @callback successCallback
@@ -43,10 +43,11 @@ import { toJSON } from './util.js'
 export default class TCaBCIClient {
   subscribed = false
   subscribedAddresses = []
+  subscribedSignedData = {}
   connected = false
   chainName = 'transferchain'
   chainVersion = 'v1'
-  version = 'v2.3.0'
+  version = 'v2.4.0'
   /**
    * @type {?successCallback}
    */
@@ -80,15 +81,17 @@ export default class TCaBCIClient {
     chainName = null,
     chainVersion = null,
   ) {
-    if (!wsLibrary) throw INVALID_ARGUMENTS
+    if (!wsLibrary) throw new Error(INVALID_ARGUMENTS)
     this.wsLibrary = wsLibrary
 
     if (Array.isArray(readNodeAddresses) && readNodeAddresses.length === 2) {
       this.readNodeAddress = readNodeAddresses[0]
       this.readNodeWSAddress = readNodeAddresses[1]
 
-      if (!readNodeAddresses[0].startsWith('http')) throw INVALID_ARGUMENTS
-      if (!readNodeAddresses[1].startsWith('ws')) throw INVALID_ARGUMENTS
+      if (!readNodeAddresses[0].startsWith('http'))
+        throw new Error(INVALID_ARGUMENTS)
+      if (!readNodeAddresses[1].startsWith('ws'))
+        throw new Error(INVALID_ARGUMENTS)
     }
 
     if (chainName) this.chainName = chainName
@@ -165,9 +168,13 @@ export default class TCaBCIClient {
     return this.connect()
   }
 
+  /**
+   * @return {TCaBCIClient}
+   * @throws {Error}
+   */
   Stop() {
     if (!this.getConnected()) {
-      throw NOT_CONNECTED
+      throw new Error(NOT_CONNECTED)
     }
     this.Disconnect(1000)
     this.setConnected(false)
@@ -176,30 +183,42 @@ export default class TCaBCIClient {
     return this
   }
 
-  Subscribe(addresses = [], txTypes = []) {
+  /**
+   * @param {Array<string>} addresses
+   * @param {Object} signedData
+   * @param {?Array<string>} txTypes
+   * @return {TCaBCIClient}
+   */
+  Subscribe(addresses, signedData, txTypes = null) {
     if (!Array.isArray(addresses)) {
-      throw INVALID_ARGUMENTS
+      throw new Error(INVALID_ARGUMENTS)
+    }
+
+    if (typeof signedData !== 'object') {
+      throw new Error(INVALID_ARGUMENTS)
     }
 
     if (txTypes && !Array.isArray(addresses)) {
-      throw INVALID_ARGUMENTS
+      throw new Error(INVALID_ARGUMENTS)
     }
 
-    if (txTypes.length && txTypes.length > Object.values(TX_TYPE).length) {
-      throw INVALID_ARGUMENTS
+    if (txTypes && txTypes.length > Object.values(TX_TYPE).length) {
+      throw new Error(INVALID_ARGUMENTS)
     }
 
     if (!this.getConnected()) {
-      throw NOT_CONNECTED
+      throw new Error(NOT_CONNECTED)
     }
 
-    let addrs = []
+    let addrs = [],
+      sdata = {}
 
     if (addresses.length === 0) {
-      throw ADDRESSES_IS_EMPTY
+      throw new Error(ADDRESSES_IS_EMPTY)
     }
 
     addrs = addresses
+    sdata = signedData
 
     if (this.getSubscribeAddresses().length > 0) {
       let newAddress = []
@@ -212,26 +231,40 @@ export default class TCaBCIClient {
       addrs = newAddress
     }
 
-    const message = new Message(true, MESSAGE_TYPE.SUBSCRIBE, addrs, txTypes)
+    if (this.getSubscribedSignedData().length > 0) {
+      sdata = this.getSubscribedSignedData()
+    }
+
+    const message = new Message(
+      true,
+      MESSAGE_TYPE.SUBSCRIBE,
+      addrs,
+      sdata,
+      txTypes,
+    )
 
-    this.ws.send(message.ToJSONString())
+    this.ws.send(message.ToJSON())
     this.setSubscribeAddresses(addrs, true)
-    this.setSubscribed(true)
+      .setSubscribeSignedData(signedData)
+      .setSubscribed(true)
+
+    return this
   }
 
   Unsubscribe() {
     if (!this.getSubscribed()) {
-      throw NOT_SUBSCRIBED
+      throw new Error(NOT_SUBSCRIBED)
     }
     this.ws.send(
       new Message(
         true,
         MESSAGE_TYPE.UNSUBSCRIBE,
         this.getSubscribeAddresses(),
-      ).ToJSONString(),
+      ).ToJSON(),
     )
     this.setSubscribed(false)
     this.setSubscribeAddresses([])
+    this.setSubscribeSignedData({})
   }
 
   /**
@@ -249,15 +282,23 @@ export default class TCaBCIClient {
       .then((res) => {
         return { blocks: res.data, total_count: res.total_count }
       })
-      .catch((e) => this.handleRestError(e, BLOCK_NOT_FOUND))
+      .catch((e) => this.handleRestError(e, new Error(BLOCK_NOT_FOUND)))
   }
 
-  Tx(id) {
+  /**
+   * @param {string} id
+   * @param {string} signature
+   * @return {Promise<*>}
+   */
+  Tx(id, signature) {
     if (!id || typeof id !== 'string') {
-      return Promise.reject(INVALID_ARGUMENTS)
+      return Promise.reject(new Error(INVALID_ARGUMENTS))
     }
 
-    return this.httpClient(`/v1/tx/${id}`, { method: 'GET' })
+    return this.httpClient(`/v1/tx/${id}`, {
+      method: 'GET',
+      headers: { 'X-Signature': signature },
+    })
       .then((res) => {
         return { tx: res.data }
       })
@@ -267,6 +308,7 @@ export default class TCaBCIClient {
   /**
    * @param {?Array<string>} recipientAddrs
    * @param {?Array<string>} senderAddrs
+   * @param {?Object} signedData
    * @param {?string} typ
    * @param {?Array<string>} types
    * @param {?string} chainName
@@ -276,13 +318,14 @@ export default class TCaBCIClient {
   TxSummary({
     recipientAddrs,
     senderAddrs,
+    signedData,
     typ,
     types = null,
     chainName = null,
     chainVersion = null,
   }) {
     if (!recipientAddrs && !senderAddrs) {
-      return Promise.reject(INVALID_ARGUMENTS)
+      return Promise.reject(new Error(INVALID_ARGUMENTS))
     }
 
     return this.httpClient('/v1/tx_summary', {
@@ -292,6 +335,7 @@ export default class TCaBCIClient {
         chain_version: chainVersion ?? this.chainVersion,
         recipient_addrs: recipientAddrs,
         sender_addrs: senderAddrs,
+        signed_addrs: signedData,
         ...(types ? { types: types } : { typ: typ }),
       }),
     })
@@ -316,6 +360,7 @@ export default class TCaBCIClient {
    * @param {?number} lastOrder
    * @param {?Array<string>} recipientAddrs
    * @param {?Array<string>} senderAddrs
+   * @param {?Object} signedData
    * @param {?Array<string>} hashes
    * @param {string} typ
    * @param {?Array<string>} types
@@ -334,6 +379,7 @@ export default class TCaBCIClient {
     lastOrder,
     recipientAddrs,
     senderAddrs,
+    signedData,
     hashes,
     typ,
     types,
@@ -354,6 +400,7 @@ export default class TCaBCIClient {
         ...(lastOrder ? { last_order: lastOrder } : {}),
         ...(recipientAddrs ? { recipient_addrs: recipientAddrs } : {}),
         ...(senderAddrs ? { sender_addrs: senderAddrs } : {}),
+        ...(signedData ? { signed_addrs: signedData } : {}),
         ...(hashes ? { hashes: hashes } : {}),
         ...(limit ? { limit: limit } : {}),
         ...(offset ? { offset: offset } : {}),
@@ -497,7 +544,7 @@ export default class TCaBCIClient {
     commit = false,
   ) {
     if (Object.values(TX_TYPE).indexOf(type) < 0) {
-      throw TRANSACTION_TYPE_NOT_VALID
+      throw new Error(TRANSACTION_TYPE_NOT_VALID)
     }
 
     return this.httpClient(
@@ -519,11 +566,14 @@ export default class TCaBCIClient {
       .then((res) => {
         return { data: res.data }
       })
-      .catch((e) => this.handleRestError(e, { 400: TRANSACTION_NOT_BROADCAST }))
+      .catch((e) =>
+        this.handleRestError(e, { 400: new Error(TRANSACTION_NOT_BROADCAST) }),
+      )
   }
 
   /**
    * @param {Array<string>} addresses
+   * @param {Object} signedData
    * @param {?number} maxHeight
    * @param {?string} chainName
    * @param {?string} chainVersion
@@ -532,6 +582,7 @@ export default class TCaBCIClient {
    */
   Bulk(
     addresses = [],
+    signedData = {},
     maxHeight = null,
     chainName = null,
     chainVersion = null,
@@ -542,6 +593,7 @@ export default class TCaBCIClient {
         chain_name: chainName ?? this.chainName,
         chain_version: chainVersion ?? this.chainVersion,
         addresses: addresses,
+        signed_addrs: signedData,
         ...(maxHeight ? { max_height: maxHeight } : {}),
       }),
     })
@@ -582,7 +634,7 @@ export default class TCaBCIClient {
    */
   async connect() {
     if (this.getConnected()) {
-      return Promise.reject(ALREADY_CONNECTED)
+      return Promise.reject(new Error(ALREADY_CONNECTED))
     }
 
     const options = {
@@ -598,6 +650,7 @@ export default class TCaBCIClient {
         this.setConnected(false)
         this.setSubscribed(false)
         this.setSubscribeAddresses([], false)
+        this.setSubscribeSignedData({})
         this.callErrorCallback(event)
 
         reject(event)
@@ -613,12 +666,13 @@ export default class TCaBCIClient {
           return { status: message.data }
         }
 
-        this.callListenCallback(toJSON(message.data))
+        this.callListenCallback(!isJSON(message.data) ? message.data : toJSON(message.data))
       }
       this.ws.onclose = (event) => {
         this.setConnected(false)
         this.setSubscribed(false)
         this.setSubscribeAddresses([], false)
+        this.setSubscribeSignedData({})
         this.callCloseCallback(event)
 
         resolve(event)
@@ -646,13 +700,34 @@ export default class TCaBCIClient {
     return this.subscribedAddresses
   }
 
+  getSubscribedSignedData() {
+    return this.subscribedSignedData
+  }
+
+  /**
+   * @param {Array<string>} addresses
+   * @param {?boolean} push
+   * @return {TCaBCIClient}
+   */
   setSubscribeAddresses(addresses, push = false) {
     if (push) {
       this.subscribedAddresses.push(...addresses)
 
-      return
+      return this
     }
     this.subscribedAddresses = addresses
+
+    return this
+  }
+
+  /**
+   * @param {Object} signedData
+   * @return {TCaBCIClient}
+   */
+  setSubscribeSignedData(signedData) {
+    this.subscribedSignedData = signedData
+
+    return this
   }
 
   /**
@@ -680,6 +755,7 @@ export default class TCaBCIClient {
   /**
    * @param {Error} err
    * @param {?Object|Error} custom
+   * @throws Error
    */
   handleRestError(err, custom = null) {
     const code = err.code
@@ -692,9 +768,9 @@ export default class TCaBCIClient {
 
     switch (code) {
       case 400:
-        throw INVALID_ARGUMENTS
+        throw new Error(INVALID_ARGUMENTS)
       case 'ERR_NETWORK':
-        throw ERR_NETWORK
+        throw new Error(ERR_NETWORK)
       default:
         throw err
     }

package/client_test.js

@@ -242,7 +242,7 @@ describe('TCaBCIClient', () => {
 
       done(new Error('invalid'))
     } catch (err) {
-      unitJS.assert.equal(TRANSACTION_TYPE_NOT_VALID, err)
+      unitJS.assert.equal(TRANSACTION_TYPE_NOT_VALID, err.message)
       done()
     }
   })
@@ -268,7 +268,7 @@ describe('TCaBCIClient', () => {
         done()
       })
       .catch((err) => {
-        unitJS.assert.equal(TRANSACTION_NOT_BROADCAST, err)
+        unitJS.assert.equal(TRANSACTION_NOT_BROADCAST, err.message)
         done()
       })
   })

package/errors.js

@@ -1,16 +1,16 @@
-export const ALREADY_CONNECTED = new Error('Already connected'),
-  NOT_CONNECTED = new Error('Not connected'),
-  ERR_NETWORK = new Error('Network Error'),
-  INVALID_ARGUMENTS = new Error('Check your arguments'),
+export const ALREADY_CONNECTED = 'Already connected',
+  NOT_CONNECTED = 'Not connected',
+  ERR_NETWORK = 'Network Error',
+  INVALID_ARGUMENTS = 'Check your arguments',
   INVALID_ARGUMENT_WITH_CS = (val) => {
-    return new Error(INVALID_ARGUMENTS + ' ' + val)
+    return 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 = 'Not subscribed',
+  ALREADY_SUBSCRIBED = 'Already subscribed',
+  ADDRESSES_IS_EMPTY = 'Addresses is empty',
+  BLOCK_NOT_FOUND = 'Block does not exist',
+  TRANSACTION_TYPE_NOT_VALID = 'Transaction type is not valid',
+  TRANSACTION_NOT_BROADCAST = 'Transaction can not be broadcast'
 
 export class FetchError extends Error {
   code = -1

package/message.js

@@ -2,54 +2,69 @@ import { INVALID_ARGUMENTS, INVALID_ARGUMENT_WITH_CS } from './errors.js'
 import { MESSAGE_TYPE, TX_TYPE } from './constants.js'
 
 export default class Message {
-  #is_web = false
-  #type = ''
-  #addrs = []
-  #txTypes = []
-  constructor(isWeb, type, addrs, txTypes = []) {
-    this.#is_web = isWeb
-    this.#type = type
-    this.#addrs = addrs
-    this.#txTypes = txTypes
+  _is_web = false
+  _type = ''
+  _addrs = []
+  _signedData = {}
+  _txTypes = []
+
+  /**
+   * @param {boolean} isWeb
+   * @param {string} type
+   * @param {Array<string>} addrs
+   * @param {?Object} signedData
+   * @param {?Array<string>} txTypes
+   */
+  constructor(isWeb, type, addrs, signedData = null, txTypes = null) {
+    this._is_web = isWeb
+    this._type = type
+    if (addrs && Array.isArray(addrs)) this._addrs = addrs
+    if (typeof signedData === 'object') this._signedData = signedData
+    if (txTypes && Array.isArray(txTypes)) this._txTypes = txTypes
   }
 
-  ToJSONString() {
-    this.#validate()
+  ToJSON() {
+    this._validate()
 
     return JSON.stringify({
-      is_web: this.#is_web,
-      type: this.#type,
-      addrs: this.#addrs,
-      ...(this.#txTypes.length > 0 ? { tx_types: this.#txTypes } : {}),
+      is_web: this._is_web,
+      type: this._type,
+      addrs: this._addrs,
+      signed_addrs: this._signedData,
+      ...(this._txTypes.length > 0 ? { tx_types: this._txTypes } : {}),
     })
   }
 
-  #validate() {
-    if (typeof this.#is_web !== 'boolean') {
-      throw INVALID_ARGUMENT_WITH_CS('is_web')
+  _validate() {
+    if (typeof this._is_web !== 'boolean') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('is_web'))
+    }
+
+    if (typeof this._type !== 'string') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('type'))
     }
 
-    if (typeof this.#type !== 'string') {
-      throw INVALID_ARGUMENT_WITH_CS('type')
+    if (!Array.isArray(this._addrs)) {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('addrs'))
     }
 
-    if (!Array.isArray(this.#addrs)) {
-      throw INVALID_ARGUMENT_WITH_CS('addrs')
+    if (typeof this._signedData !== 'object') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('signedData'))
     }
 
     if (
-      [MESSAGE_TYPE.SUBSCRIBE, MESSAGE_TYPE.UNSUBSCRIBE].indexOf(this.#type) ===
+      [MESSAGE_TYPE.SUBSCRIBE, MESSAGE_TYPE.UNSUBSCRIBE].indexOf(this._type) ===
       -1
     ) {
-      throw INVALID_ARGUMENTS
+      throw new Error(INVALID_ARGUMENTS)
     }
 
-    if (this.#txTypes.length) {
+    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')
+      for (let i = 0; i < this._txTypes.length; i++) {
+        if (vals.indexOf(this._txTypes[i]) === -1) {
+          throw new Error(INVALID_ARGUMENT_WITH_CS('tx_types'))
         }
       }
 

package/package.json

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

package/transaction.js

@@ -1,19 +1,19 @@
 import { INVALID_ARGUMENT_WITH_CS } from './errors.js'
 
 export default class Transaction {
-  #id
-  #block_id
-  #height
-  #identifier
-  #version
-  #typ
-  #sender_addr
-  #recipient_addr
-  #data
-  #sign
-  #fee
-  #hash
-  #inserted_at
+  _id
+  _block_id
+  _height
+  _identifier
+  _version
+  _typ
+  _sender_addr
+  _recipient_addr
+  _data
+  _sign
+  _fee
+  _hash
+  _inserted_at
 
   constructor({
     id,
@@ -30,77 +30,77 @@ export default class Transaction {
     hash,
     inserted_at,
   }) {
-    this.#id = id
-    this.#block_id = block_id
-    this.#height = height
-    this.#identifier = identifier
-    this.#version = version
-    this.#typ = typ
-    this.#sender_addr = sender_addr
-    this.#recipient_addr = recipient_addr
-    this.#data = data
-    this.#sign = sign
-    this.#fee = fee
-    this.#hash = hash
-    this.#inserted_at = inserted_at
+    this._id = id
+    this._block_id = block_id
+    this._height = height
+    this._identifier = identifier
+    this._version = version
+    this._typ = typ
+    this._sender_addr = sender_addr
+    this._recipient_addr = recipient_addr
+    this._data = data
+    this._sign = sign
+    this._fee = fee
+    this._hash = hash
+    this._inserted_at = inserted_at
   }
 
-  ToJSONString() {
-    this.#validate()
+  ToJSON() {
+    this._validate()
 
     return JSON.stringify({
-      id: this.#id,
-      block_id: this.#block_id,
-      height: this.#height,
-      identifier: this.#identifier,
-      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,
-      inserted_at: this.#inserted_at,
+      id: this._id,
+      block_id: this._block_id,
+      height: this._height,
+      identifier: this._identifier,
+      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,
+      inserted_at: this._inserted_at,
     })
   }
 
-  #validate() {
-    if (typeof this.#id !== 'number') {
-      throw INVALID_ARGUMENT_WITH_CS('id')
+  _validate() {
+    if (typeof this._id !== 'number') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('id'))
     }
-    if (typeof this.#block_id !== 'number') {
-      throw INVALID_ARGUMENT_WITH_CS('blockID')
+    if (typeof this._block_id !== 'number') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('blockID'))
     }
-    if (typeof this.#height !== 'number') {
-      throw INVALID_ARGUMENT_WITH_CS('height')
+    if (typeof this._height !== 'number') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('height'))
     }
-    if (typeof this.#identifier !== 'string') {
-      throw INVALID_ARGUMENT_WITH_CS('identifier')
+    if (typeof this._identifier !== 'string') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('identifier'))
     }
-    if (typeof this.#version !== 'number') {
-      throw INVALID_ARGUMENT_WITH_CS('version')
+    if (typeof this._version !== 'number') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('version'))
     }
-    if (typeof this.#typ !== 'string') {
-      throw INVALID_ARGUMENT_WITH_CS('typ')
+    if (typeof this._typ !== 'string') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('typ'))
     }
-    if (typeof this.#sender_addr !== 'string') {
-      throw INVALID_ARGUMENT_WITH_CS('senderAddr')
+    if (typeof this._sender_addr !== 'string') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('senderAddr'))
     }
-    if (typeof this.#recipient_addr !== 'string') {
-      throw INVALID_ARGUMENT_WITH_CS('recipientAddr')
+    if (typeof this._recipient_addr !== 'string') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('recipientAddr'))
     }
-    if (typeof this.#data !== 'object') {
-      throw INVALID_ARGUMENT_WITH_CS('data')
+    if (typeof this._data !== 'object') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('data'))
     }
-    if (typeof this.#sign !== 'object') {
-      throw INVALID_ARGUMENT_WITH_CS('sign')
+    if (typeof this._sign !== 'object') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('sign'))
     }
-    if (typeof this.#fee !== 'number') {
-      throw INVALID_ARGUMENT_WITH_CS('fee')
+    if (typeof this._fee !== 'number') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('fee'))
     }
-    if (typeof this.#inserted_at !== 'string') {
-      throw INVALID_ARGUMENT_WITH_CS('insertedAt')
+    if (typeof this._inserted_at !== 'string') {
+      throw new Error(INVALID_ARGUMENT_WITH_CS('insertedAt'))
     }
   }
 }

package/util.js

@@ -1,6 +1,6 @@
 import { CHARACTERS } from './constants.js'
 
-export const randomString = (length) => {
+export function randomString(length) {
   let result = ''
 
   const charactersLength = CHARACTERS.length
@@ -15,6 +15,16 @@ export const randomString = (length) => {
   return result
 }
 
-export const toJSON = (data) => {
+export function toJSON(data) {
   return JSON.parse(data)
 }
+
+export function isJSON(str) {
+  try {
+    JSON.parse(str)
+  } catch (e) {
+    return false
+  }
+
+  return true
+}