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

package/README.md

@@ -4,6 +4,11 @@ TransferChain Fastest Read Network WebSocket Client
 Read Node Address: [https://read-node-01.transferchain.io](https://read-node-01.transferchain.io)
 Read Node WebSocket Address: [wss://read-node-01.transferchain.io/ws](wss://read-node-01.transferchain.io/ws)
 
+## Networks
+
+- transferchain - v1
+- medusa - v2 (new blocks)
+
 ## Installation
 
 ```shell
@@ -23,6 +28,17 @@ const client = new TCaBCIClient([
   'https://read-node-01.transferchain.io',
   'wss://read-node-01.transferchain.io/ws',
 ])
+// OR
+// With addresses and WebSocket library and network name, version
+const client = new TCaBCIClient(
+  [
+    'https://read-node-01.transferchain.io',
+    'wss://read-node-01.transferchain.io/ws',
+  ],
+  WebSocket,
+  'transferchain',
+  'v1',
+)
 
 client.Start()
 

package/client.js

@@ -20,7 +20,6 @@ import {
 import Message from './message.js'
 import { toJSON } from './util.js'
 
-
 /**
  * @callback successCallback
  * @param {Event} event
@@ -45,7 +44,9 @@ export default class TCaBCIClient {
   subscribed = false
   subscribedAddresses = []
   connected = false
-  version = 'v2.2.2'
+  chainName = 'transferchain'
+  chainVersion = 'v1'
+  version = 'v2.3.0'
   /**
    * @type {?successCallback}
    */
@@ -70,8 +71,15 @@ export default class TCaBCIClient {
   /**
    * @param {Array<String>} readNodeAddresses
    * @param {WebSocket} wsLibrary
+   * @param {?string} chainName
+   * @param {?string} chainVersion
    */
-  constructor(readNodeAddresses = [], wsLibrary) {
+  constructor(
+    readNodeAddresses = [],
+    wsLibrary,
+    chainName = null,
+    chainVersion = null,
+  ) {
     if (!wsLibrary) throw INVALID_ARGUMENTS
     this.wsLibrary = wsLibrary
 
@@ -82,6 +90,9 @@ export default class TCaBCIClient {
       if (!readNodeAddresses[0].startsWith('http')) throw INVALID_ARGUMENTS
       if (!readNodeAddresses[1].startsWith('ws')) throw INVALID_ARGUMENTS
     }
+
+    if (chainName) this.chainName = chainName
+    if (chainVersion) this.chainVersion = chainVersion
   }
 
   /**
@@ -224,26 +235,52 @@ export default class TCaBCIClient {
   }
 
   /**
+   * @param {?string} chainName
+   * @param {?string} chainVersion
    * @return {Promise<any>}
    */
-  LastBlock() {
-    return this.httpClient('/v1/blocks?limit=1&offset=0', {
-      method: 'GET',
-    })
+  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',
+      },
+    )
       .then((res) => {
         return { blocks: res.data, total_count: res.total_count }
       })
       .catch((e) => this.handleRestError(e, BLOCK_NOT_FOUND))
   }
 
+  Tx(id) {
+    if (!id || typeof id !== 'string') {
+      return Promise.reject(INVALID_ARGUMENTS)
+    }
+
+    return this.httpClient(`/v1/tx/${id}`, { method: 'GET' })
+      .then((res) => {
+        return { tx: res.data }
+      })
+      .catch((e) => this.handleRestError(e))
+  }
+
   /**
    * @param {?Array<string>} recipientAddrs
    * @param {?Array<string>} senderAddrs
    * @param {?string} typ
-   * @param {?Array<string>}
+   * @param {?Array<string>} types
+   * @param {?string} chainName
+   * @param {?string} chainVersion
    * @return {Promise<any>}
    */
-  TxSummary({ recipientAddrs, senderAddrs, typ, types }) {
+  TxSummary({
+    recipientAddrs,
+    senderAddrs,
+    typ,
+    types = null,
+    chainName = null,
+    chainVersion = null,
+  }) {
     if (!recipientAddrs && !senderAddrs) {
       return Promise.reject(INVALID_ARGUMENTS)
     }
@@ -251,6 +288,8 @@ export default class TCaBCIClient {
     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,
         ...(types ? { types: types } : { typ: typ }),
@@ -258,6 +297,8 @@ export default class TCaBCIClient {
     })
       .then((res) => {
         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,
           last_block_height: res.data.last_block_height,
@@ -282,6 +323,8 @@ export default class TCaBCIClient {
    * @param {number} offset
    * @param {string} orderField
    * @param {string} orderBy
+   * @param {?string} chainName
+   * @param {?string} chainVersion
    * @return {Promise<any>}
    */
   TxSearch({
@@ -298,10 +341,14 @@ export default class TCaBCIClient {
     offset,
     orderField,
     orderBy,
+    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 } : {}),
@@ -326,6 +373,8 @@ export default class TCaBCIClient {
 
   Status() {
     return {
+      chain_name: this.chainName,
+      chain_version: this.chainVersion,
       connected: this.connected,
       subscribed: this.subscribed,
     }
@@ -342,7 +391,7 @@ export default class TCaBCIClient {
    * @param {number} fee
    * @return {Promise<any>}
    */
-  Broadcast({
+  BroadcastCommit({
     id,
     version,
     type,
@@ -352,13 +401,45 @@ export default class TCaBCIClient {
     sign,
     fee,
   }) {
-    if (Object.values(TX_TYPE).indexOf(type) < 0) {
-      throw TRANSACTION_TYPE_NOT_VALID
-    }
+    return this.broadcast(
+      {
+        id,
+        version,
+        type,
+        data,
+        sender_addr,
+        recipient_addr,
+        sign,
+        fee,
+      },
+      false,
+      true,
+    )
+  }
 
-    return this.httpClient('/v1/tx', {
-      method: 'POST',
-      body: JSON.stringify({
+  /**
+   * @param {string} id
+   * @param {number} version
+   * @param {string} type
+   * @param {string} data
+   * @param {string} sender_addr
+   * @param {string} recipient_addr
+   * @param {string} sign
+   * @param {number} fee
+   * @return {Promise<any>}
+   */
+  BroadcastSync({
+    id,
+    version,
+    type,
+    data,
+    sender_addr,
+    recipient_addr,
+    sign,
+    fee,
+  }) {
+    return this.broadcast(
+      {
         id,
         version,
         type,
@@ -367,8 +448,74 @@ export default class TCaBCIClient {
         recipient_addr,
         sign,
         fee,
-      }),
-    })
+      },
+      true,
+      false,
+    )
+  }
+
+  /**
+   * @param {string} id
+   * @param {number} version
+   * @param {string} type
+   * @param {string} data
+   * @param {string} sender_addr
+   * @param {string} recipient_addr
+   * @param {string} sign
+   * @param {number} fee
+   * @return {Promise<any>}
+   */
+  Broadcast({
+    id,
+    version,
+    type,
+    data,
+    sender_addr,
+    recipient_addr,
+    sign,
+    fee,
+  }) {
+    return this.broadcast(
+      {
+        id,
+        version,
+        type,
+        data,
+        sender_addr,
+        recipient_addr,
+        sign,
+        fee,
+      },
+      false,
+      false,
+    )
+  }
+
+  broadcast(
+    { id, version, type, data, sender_addr, recipient_addr, sign, fee },
+    sync = false,
+    commit = false,
+  ) {
+    if (Object.values(TX_TYPE).indexOf(type) < 0) {
+      throw TRANSACTION_TYPE_NOT_VALID
+    }
+
+    return this.httpClient(
+      commit ? '/v1/tx/commit' : sync ? '/v1/tx/sync' : '/v1/tx',
+      {
+        method: 'POST',
+        body: JSON.stringify({
+          id,
+          version,
+          type,
+          data,
+          sender_addr,
+          recipient_addr,
+          sign,
+          fee,
+        }),
+      },
+    )
       .then((res) => {
         return { data: res.data }
       })
@@ -378,13 +525,22 @@ export default class TCaBCIClient {
   /**
    * @param {Array<string>} addresses
    * @param {?number} maxHeight
+   * @param {?string} chainName
+   * @param {?string} chainVersion
    * @return {Promise<*>}
    * @constructor
    */
-  Bulk(addresses = [], maxHeight = null) {
+  Bulk(
+    addresses = [],
+    maxHeight = null,
+    chainName = null,
+    chainVersion = null,
+  ) {
     return this.httpClient('/v1/bulk_tx', {
       method: 'POST',
       body: JSON.stringify({
+        chain_name: chainName ?? this.chainName,
+        chain_version: chainVersion ?? this.chainVersion,
         addresses: addresses,
         ...(maxHeight ? { max_height: maxHeight } : {}),
       }),
@@ -421,7 +577,6 @@ export default class TCaBCIClient {
     if (this.listenCb) this.listenCb(message)
   }
 
-
   /**
    * @return {Promise<Event>}
    */

package/client_test.js

@@ -21,7 +21,7 @@ import {
 
 describe('TCaBCIClient', () => {
   it('start with valid parameters', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Start()
@@ -38,7 +38,12 @@ describe('TCaBCIClient', () => {
   })
 
   it('start with valid parameters and read node addresses', (done) => {
-    const client = new TCaBCIClient([READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS], WebSocket)
+    const client = new TCaBCIClient(
+      [READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS],
+      WebSocket,
+      'transferchain',
+      'v1',
+    )
 
     client
       .Start()
@@ -55,7 +60,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('reconnect with start and valid parameters', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Start()
@@ -71,13 +76,18 @@ describe('TCaBCIClient', () => {
         unitJS.assert.equal(c2, false)
         unitJS.assert.equal(b2, false)
 
-        setTimeout((client, done) => {
-          const { connected, subscribed } = client.Status()
-
-          unitJS.assert.equal(connected, true)
-          unitJS.assert.equal(subscribed, false)
-          done()
-        }, 3100, client, done)
+        setTimeout(
+          (client, done) => {
+            const { connected, subscribed } = client.Status()
+
+            unitJS.assert.equal(connected, true)
+            unitJS.assert.equal(subscribed, false)
+            done()
+          },
+          3100,
+          client,
+          done,
+        )
       })
       .catch((err) => {
         done(err)
@@ -85,7 +95,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('subscribe with valid parameters', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Start()
@@ -110,7 +120,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('should error subscribe with invalid tx type parameter', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Start()
@@ -129,7 +139,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('unsubscribe with valid parameters', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Start()
@@ -158,7 +168,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('last block', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .LastBlock()
@@ -173,7 +183,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('transaction search result', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .TxSearch({
@@ -197,7 +207,7 @@ describe('TCaBCIClient', () => {
   })
   //
   it('transaction summary result', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .TxSummary({
@@ -220,7 +230,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('should error not broadcast transaction if type is incorrect', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     try {
       client.Broadcast({
@@ -238,7 +248,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('should error not broadcast transaction', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Broadcast({
@@ -264,7 +274,7 @@ describe('TCaBCIClient', () => {
   })
 
   it('should error in bulk tx if addresses count is zero', (done) => {
-    const client = new TCaBCIClient([], WebSocket)
+    const client = new TCaBCIClient([], WebSocket, 'transferchain', 'v1')
 
     client
       .Bulk([])
@@ -286,7 +296,7 @@ describe('TCaBCIClient', () => {
       )
     }
 
-    const client = new TCaBCIClient(null, WebSocket)
+    const client = new TCaBCIClient(null, WebSocket, 'transferchain', 'v1')
 
     client
       .Bulk(addresses)

package/errors_test.js

@@ -2,7 +2,7 @@ import { FetchError } from './errors.js'
 import unitJS from 'unit.js'
 
 describe('Errors', () => {
-  it('FetchError',  () => {
+  it('FetchError', () => {
     const err = new FetchError('err1').setCode(1)
 
     unitJS.assert.equal(err.message, 'err1')

package/package.json

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