@tchain/tcabci-read-js-client 2.7.0 → 2.7.2

package/breaker.d.ts

@@ -0,0 +1,3 @@
+export declare class Breaker {
+  execute(fn: () => Promise<any>): Promise<any>
+}

package/breaker.js

@@ -0,0 +1,50 @@
+import {
+  ConsecutiveBreaker,
+  ExponentialBackoff,
+  retry,
+  handleType,
+  circuitBreaker,
+  wrap,
+} from 'cockatiel'
+import { FetchError } from './errors.js'
+
+export class Breaker {
+  _options = {
+    halfOpenAfter: 10 * 1000,
+    breaker: new ConsecutiveBreaker(10),
+  }
+  _retryPolicy = retry(
+    handleType(FetchError, (err) =>
+      [502, 503, 504].includes(err.status),
+    ).orType(Error, (err) => {
+      return err.message.toLowerCase().search('failed to fetch') > -1
+    }),
+    {
+      maxAttempts: 10,
+      backoff: new ExponentialBackoff({
+        initialDelay: 500,
+        maxDelay: 15000,
+      }),
+    },
+  )
+  _circuitBreakerPolicy = circuitBreaker(
+    handleType(FetchError, (err) =>
+      [502, 503, 504].includes(err.status),
+    ).orType(Error, (err) => {
+      return err.message.toLowerCase().search('failed to fetch') > -1
+    }),
+    this._options,
+  )
+  _retryWithBreaker = wrap(this._retryPolicy, this._circuitBreakerPolicy)
+  constructor() {}
+
+  /**
+   * @param {function} fn
+   * @return {Promise<*>}
+   */
+  execute(fn) {
+    return this._retryWithBreaker.execute(fn).catch((err) => {
+      return Promise.reject(err)
+    })
+  }
+}

package/client.js

@@ -1,8 +1,6 @@
 import {
-  FetchError,
   ALREADY_CONNECTED,
   BLOCK_NOT_FOUND,
-  ERR_NETWORK,
   INVALID_ARGUMENT_WITH_CS,
   INVALID_ARGUMENTS,
   NOT_CONNECTED,
@@ -23,6 +21,7 @@ import { Options } from './websocketOptions.js'
 import { TWebSocket } from './websocket.js'
 import { Transaction, TX_TYPE_LIST } from './transaction.js'
 import { Block } from './block.js'
+import { HTTP } from './http.js'
 
 /**
  * @callback SuccessCallback
@@ -51,13 +50,14 @@ import { Block } from './block.js'
  */
 
 export default class TCaBCIClient {
+  _httpClient = new HTTP()
   _subscribed = false
   _subscribedAddresses = []
   _SubscribedSignedData = {}
   _connected = false
   _chainName = 'transferchain'
   _chainVersion = 'v1'
-  _version = `v2.7.0`
+  _version = `v2.7.2`
   /**
    * @type {?SuccessCallback}
    */
@@ -110,6 +110,7 @@ export default class TCaBCIClient {
 
       this._readNodeAddress = readNodeAddresses[0]
       this._readNodeWSAddress = readNodeAddresses[1]
+      this._httpClient.setBaseURL(readNodeAddresses[0])
     }
 
     this._options = new Options(this._readNodeWSAddress)
@@ -309,12 +310,13 @@ export default class TCaBCIClient {
    * @return {Promise<{blocks: Transaction[], total_count: number}>}
    */
   LastBlock(chainName = null, chainVersion = null) {
-    return this._httpClient(
-      `/v1/blocks?chain_name=${chainName ?? this._chainName}&chain_version=${chainVersion ?? this._chainVersion}&limit=1&offset=0`,
-      {
-        method: 'GET',
-      },
-    )
+    return this._httpClient
+      .request(
+        `/v1/blocks?chain_name=${chainName ?? this._chainName}&chain_version=${chainVersion ?? this._chainVersion}&limit=1&offset=0`,
+        {
+          method: 'GET',
+        },
+      )
       .then((res) => {
         const data = []
 
@@ -326,7 +328,7 @@ export default class TCaBCIClient {
 
         return { blocks: data, total_count: res.total_count }
       })
-      .catch((e) => this._handleRestError(e, new Error(BLOCK_NOT_FOUND)))
+      .catch((e) => this._httpClient.handleError(e, new Error(BLOCK_NOT_FOUND)))
   }
 
   /**
@@ -339,17 +341,18 @@ export default class TCaBCIClient {
       return Promise.reject(new Error(INVALID_ARGUMENTS))
     }
 
-    return this._httpClient(`/v1/tx/${id}`, {
-      method: 'GET',
-      headers: { 'X-Signature': signature },
-    })
+    return this._httpClient
+      .request(`/v1/tx/${id}`, {
+        method: 'GET',
+        headers: { 'X-Signature': signature },
+      })
       .then((res) => {
         const { transaction, error } = Transaction.FromObject(res.data)
         if (error) return Promise.reject(error)
 
         return { tx: transaction }
       })
-      .catch((e) => this._handleRestError(e))
+      .catch((e) => this._httpClient.handleError(e))
   }
 
   /**
@@ -383,17 +386,18 @@ export default class TCaBCIClient {
       return Promise.reject(new Error(INVALID_ARGUMENTS))
     }
 
-    return this._httpClient('/v1/tx_summary', {
-      method: 'POST',
-      body: JSON.stringify({
-        chain_name: chainName ?? this._chainName,
-        chain_version: chainVersion ?? this._chainVersion,
-        recipient_addrs: recipientAddrs,
-        sender_addrs: senderAddrs,
-        signed_addrs: signedData,
-        ...(types ? { types: types } : { typ: typ }),
-      }),
-    })
+    return this._httpClient
+      .request('/v1/tx_summary', {
+        method: 'POST',
+        body: JSON.stringify({
+          chain_name: chainName ?? this._chainName,
+          chain_version: chainVersion ?? this._chainVersion,
+          recipient_addrs: recipientAddrs,
+          sender_addrs: senderAddrs,
+          signed_addrs: signedData,
+          ...(types ? { types: types } : { typ: typ }),
+        }),
+      })
       .then((res) => {
         let firstTransaction, lastTransaction
 
@@ -423,7 +427,7 @@ export default class TCaBCIClient {
           total_count: res.total_count,
         }
       })
-      .catch((e) => this._handleRestError(e))
+      .catch((e) => this._httpClient.handleError(e))
   }
 
   /**
@@ -463,25 +467,26 @@ export default class TCaBCIClient {
     chainName = null,
     chainVersion = null,
   }) {
-    return this._httpClient('/v1/tx_search/p', {
-      method: 'POST',
-      body: JSON.stringify({
-        chain_name: chainName ?? this._chainName,
-        chain_version: chainVersion ?? this._chainVersion,
-        height: `${heightOperator} ${height}`,
-        ...(maxHeight ? { max_height: maxHeight } : {}),
-        ...(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 } : {}),
-        ...(orderField ? { order_field: orderField } : {}),
-        ...(orderBy ? { order_by: orderBy } : {}),
-        ...(types ? { types: types } : typ ? { typ: typ } : {}),
-      }),
-    })
+    return this._httpClient
+      .request('/v1/tx_search/p', {
+        method: 'POST',
+        body: JSON.stringify({
+          chain_name: chainName ?? this._chainName,
+          chain_version: chainVersion ?? this._chainVersion,
+          height: `${heightOperator} ${height}`,
+          ...(maxHeight ? { max_height: maxHeight } : {}),
+          ...(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 } : {}),
+          ...(orderField ? { order_field: orderField } : {}),
+          ...(orderBy ? { order_by: orderBy } : {}),
+          ...(types ? { types: types } : typ ? { typ: typ } : {}),
+        }),
+      })
       .then((res) => {
         const data = []
 
@@ -496,7 +501,7 @@ export default class TCaBCIClient {
           total_count: res.total_count,
         }
       })
-      .catch((e) => this._handleRestError(e))
+      .catch((e) => this._httpClient.handleError(e))
   }
 
   /**
@@ -642,9 +647,8 @@ export default class TCaBCIClient {
       throw new Error(TRANSACTION_TYPE_NOT_VALID)
     }
 
-    return this._httpClient(
-      commit ? '/v1/tx/commit' : sync ? '/v1/tx/sync' : '/v1/tx',
-      {
+    return this._httpClient
+      .request(commit ? '/v1/tx/commit' : sync ? '/v1/tx/sync' : '/v1/tx', {
         method: 'POST',
         body: JSON.stringify({
           id,
@@ -658,13 +662,14 @@ export default class TCaBCIClient {
           sign,
           fee,
         }),
-      },
-    )
+      })
       .then((res) => {
         return { data: res.data }
       })
       .catch((e) =>
-        this._handleRestError(e, { 400: new Error(TRANSACTION_NOT_BROADCAST) }),
+        this._httpClient.handleError(e, {
+          400: new Error(TRANSACTION_NOT_BROADCAST),
+        }),
       )
   }
 
@@ -684,7 +689,7 @@ export default class TCaBCIClient {
     chainName = null,
     chainVersion = null,
   ) {
-    return this._httpClient('/v1/bulk_tx', {
+    return this._httpClient.request('/v1/bulk_tx', {
       method: 'POST',
       body: JSON.stringify({
         chain_name: chainName ?? this._chainName,
@@ -840,69 +845,4 @@ export default class TCaBCIClient {
       if (this._listenCb) this._listenCb(null, transaction, null)
     }
   }
-
-  /**
-   * @param {string} uri
-   * @param {RequestInit} req
-   * @return {Promise<Record<string, any>>}
-   */
-  _httpClient(uri, req) {
-    req.cache = 'no-cache'
-    req.headers = {
-      Client: `tcabaci-read-js-client/${this._version}`,
-    }
-    req.priority = 'high'
-
-    return fetch(this._readNodeAddress + uri, req).then((response) =>
-      this._handleRestResponse(response),
-    )
-  }
-
-  /**
-   * @param {Response} response
-   * @return {Promise<*>}
-   */
-  async _handleRestResponse(response) {
-    if (response.status >= 200 && response.status < 400) {
-      return response.json()
-    }
-
-    try {
-      const data = JSON.parse(await response.text())
-
-      return Promise.reject(
-        new FetchError(data.message)
-          .setStatus(response.status)
-          .setResponse(data),
-      )
-    } catch (e) {
-      return Promise.reject(
-        new FetchError(response.statusText).setOriginError(e),
-      )
-    }
-  }
-
-  /**
-   * @param {Error} err
-   * @param {?Object|Error} custom
-   * @throws Error
-   */
-  _handleRestError(err, custom = null) {
-    const code = err.code
-
-    if (custom && typeof custom === 'object' && custom[code]) {
-      throw custom[code]
-    } else if (custom instanceof Error) {
-      throw custom
-    }
-
-    switch (code) {
-      case 400:
-        throw new Error(INVALID_ARGUMENTS)
-      case 'ERR_NETWORK':
-        throw new Error(ERR_NETWORK)
-      default:
-        throw err
-    }
-  }
 }

package/errors.js

@@ -12,6 +12,24 @@ export const ALREADY_CONNECTED = 'Already connected',
   TRANSACTION_TYPE_NOT_VALID = 'Transaction type is not valid',
   TRANSACTION_NOT_BROADCAST = 'Transaction can not be broadcast'
 
+export class CopiedError extends Error {
+  originName
+  originError
+  originStack
+
+  /**
+   * @param {Error} err
+   */
+  constructor(err) {
+    super(err.message)
+    this.name = 'CopiedError'
+    this.originName = err.name
+    this.originError = err
+    this.stack = err.stack
+    this.originStack = err.stack
+  }
+}
+
 export class FetchError extends Error {
   status = -1
   response

package/http.d.ts

@@ -0,0 +1,9 @@
+import { Request } from 'express'
+
+export declare class HTTP {
+  constructor(baseURL: string)
+  setBaseURL(baseURL: string): HTTP
+  request(uri: string, req: Request): Promise<Record<string, any>>
+  handleResponse(response: Response): Promise<any>
+  handleError(err: Error, custom: Record<string, any>|Error): Promise<any>
+}

package/http.js

@@ -0,0 +1,81 @@
+import { ERR_NETWORK, FetchError, INVALID_ARGUMENTS } from './errors.js'
+import { Breaker } from './breaker.js'
+
+export class HTTP {
+  _baseURL
+  _version = 'v2.7.1'
+  _breaker = new Breaker()
+  constructor(baseURL = null) {
+    this._baseURL = baseURL
+  }
+  setBaseURL(baseURL) {
+    this._baseURL = baseURL
+    return this
+  }
+  /**
+   * @param {string} uri
+   * @param {RequestInit} req
+   * @return {Promise<Record<string, any>>}
+   */
+  async request(uri, req) {
+    req.cache = 'no-cache'
+    req.headers = {
+      Client: `tcabaci-read-js-client/${this._version}`,
+    }
+    req.priority = 'high'
+
+    return this._breaker
+      .execute(() => {
+        return fetch(this._baseURL + uri, req)
+      })
+      .then((response) => this.handleResponse(response))
+  }
+
+  /**
+   * @param {Response} response
+   * @return {Promise<*>}
+   */
+  async handleResponse(response) {
+    if (response.status >= 200 && response.status < 400) {
+      return response.json()
+    }
+
+    try {
+      const data = JSON.parse(await response.text())
+
+      return Promise.reject(
+        new FetchError(data.message)
+          .setStatus(response.status)
+          .setResponse(data),
+      )
+    } catch (e) {
+      return Promise.reject(
+        new FetchError(response.statusText).setOriginError(e),
+      )
+    }
+  }
+
+  /**
+   * @param {Error} err
+   * @param {?Object|Error} custom
+   * @return {Promise<Error>}
+   */
+  async handleError(err, custom = null) {
+    const code = err.code
+
+    if (custom && typeof custom === 'object' && custom[code]) {
+      return Promise.reject(custom[code])
+    } else if (custom instanceof Error) {
+      return Promise.reject(custom)
+    }
+
+    switch (code) {
+      case 400:
+        return Promise.reject(new Error(INVALID_ARGUMENTS))
+      case 'ERR_NETWORK':
+        return Promise.reject(new Error(ERR_NETWORK))
+      default:
+        return Promise.reject(err)
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tchain/tcabci-read-js-client",
-  "version": "2.7.0",
+  "version": "2.7.2",
   "description": "TransferChain Fastest Read Network WebSocket Client",
   "main": "client.js",
   "type": "module",
@@ -11,6 +11,8 @@
   "files": [
     "*.d.ts",
     "constants.js",
+    "breaker.js",
+    "http.js",
     "block.js",
     "client.js",
     "errors.js",
@@ -30,19 +32,20 @@
     "@eslint/js": "^10.0.1",
     "@types/chai": "^5.2.3",
     "chai": "^6.2.2",
-    "eslint": "^10.2.0",
+    "eslint": "^10.5.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-prettier": "^5.5.6",
     "esm": "^3.2.25",
     "express": "^5.2.1",
     "globals": "^16.5.0",
-    "mocha": "^11.7.5",
+    "mocha": "^11.7.6",
     "nyc": "^17.1.0",
-    "prettier": "^3.8.3",
+    "prettier": "^3.8.4",
     "unit.js": "^2.1.1",
-    "ws": "^8.20.0"
+    "ws": "^8.21.0"
   },
   "dependencies": {
+    "cockatiel": "^3.2.1",
     "reconnecting-websocket": "^4.4.0"
   },
   "scripts": {

package/websocketOptions.js

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