@tchain/tcabci-read-js-client 1.0.1 → 1.0.3

package/README.md

@@ -7,7 +7,7 @@ Read Node WebSocket Address: [wss://read-node-01.transferchain.io/ws](wss://read
 ## Installation
 
 ```shell
-$ npm install tcabci-read-js-client 
+$ npm i @tchain/tcabci-read-js-client
 ```
 
 ## Example
@@ -15,6 +15,8 @@ $ npm install tcabci-read-js-client
 **Subscribe, Listen and Unsubscribe Example**
 
 ```js
+const tcAbciClient = require("@tchain/tcabci-read-js-client")
+
 const client = new tcAbciClient()
 
 client.Start()

package/client.js

@@ -4,9 +4,11 @@ const {
     INVALID_ARGUMENTS,
     NOT_SUBSCRIBED,
     ADDRESSES_IS_EMPTY,
-    BLOCK_NOT_FOUND
+    BLOCK_NOT_FOUND,
+    TRANSACTION_TYPE_NOT_VALID,
+    TRANSACTION_NOT_BROADCAST
 } = require("./errors")
-const {MESSAGE_TYPE, READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS} = require("./constants")
+const {MESSAGE_TYPE, READ_NODE_ADDRESS, READ_NODE_WS_ADDRESS, TX_TYPE} = require("./constants")
 const Transaction = require("./transaction")
 const Message = require("./message")
 const {toJSON} = require("./util")
@@ -137,6 +139,26 @@ class TCAbciClient {
             subscribed: this.#subscribed,
         }
     }
+    Broadcast({id, version, type, data, sender_addr, recipient_addr, sign, fee}) {
+        if(Object.values(TX_TYPE).indexOf(type) < 0) {
+            throw TRANSACTION_TYPE_NOT_VALID
+        }
+
+        return this.#httpClient.post(
+            "/v1/broadcast",
+            {
+                id,
+                version,
+                type,
+                data,
+                sender_addr,
+                recipient_addr,
+                sign,
+                fee
+            }
+        ).then(res => { return { data: res.data.data } })
+            .catch(e => { throw TRANSACTION_NOT_BROADCAST })
+    }
 
     #wsClient() {
         if (typeof window !== "undefined") {

package/client_test.js

@@ -1,6 +1,7 @@
 const tcAbciClient = require("./client")
 const unitJS = require("unit.js")
-const {INVALID_ARGUMENTS, INVALID_URL} = require("./errors")
+const {INVALID_ARGUMENTS, INVALID_URL, TRANSACTION_TYPE_NOT_VALID} = require("./errors")
+const { TX_TYPE } = require("./constants")
 const {randomString} = require("./util")
 
 describe("TCAbciClient TESTS", () => {
@@ -70,13 +71,13 @@ describe("TCAbciClient TESTS", () => {
 
     it('should return transaction search result',(done) => {
         const client = new tcAbciClient()
-        client.TxSearch({ 
+        client.TxSearch({
                 heightOperator: ">=",
                 height: 0,
                 recipientAddrs: ["2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN"],
                 limit: 1,
                 offset: 0,
-                orderBy: "ASC" 
+                orderBy: "ASC"
             })
             .then(data => {
                 unitJS.value(data.txs).hasLength(1)
@@ -88,4 +89,40 @@ describe("TCAbciClient TESTS", () => {
             })
     })
 
+    it('should not broadcast transaction if type is incorrect',(done) => {
+        const client = new tcAbciClient()
+        try {
+            client.Broadcast({
+                type: "dummy type",
+                data: "",
+                sender_addr: "",
+                recipient_addr: ""
+            })
+        } catch (err) {
+            unitJS.assert.equal(TRANSACTION_TYPE_NOT_VALID, err)
+            done()
+        }
+    })
+
+    it('should not broadcast transaction',(done) => {
+        const client = new tcAbciClient()
+        client.Broadcast({
+            id: "dummy id",
+            version: 0,
+            type: TX_TYPE.TX_TYPE_ADDRESS,
+            data: btoa(JSON.stringify({data: ""})),
+            sender_addr: "2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN",
+            recipient_addr: "2mSCzresfg8Gwu7LZ9k9BTWkQAcQEkvYHFUSCZE2ubM4QV89PTeSYwQDqBas3ykq2emHEK6VRvxdgoe1vrhBbQGN",
+            sign: btoa("dummy sign"),
+            fee: 0
+        })
+            .then(data => {
+                unitJS.assert.notEqual(data.data.hash, "")
+                done()
+            })
+            .catch(err => {
+                done(err)
+            })
+    })
+
 })

package/constants.js

@@ -5,5 +5,29 @@ module.exports = {
     },
     CHARACTERS: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789",
     READ_NODE_ADDRESS: "https://read-node-01.transferchain.io",
-    READ_NODE_WS_ADDRESS: "wss://read-node-01.transferchain.io/ws"
+    READ_NODE_WS_ADDRESS: "wss://read-node-01.transferchain.io/ws",
+    TX_TYPE: {
+        TX_TYPE_MASTER: "initial_storage",
+        TX_TYPE_ADDRESS: "interim_storage",
+        TX_TYPE_ADDRESSES: "interim_storages",
+        TX_TYPE_MESSAGE: "message",
+        TX_TYPE_MESSAGE_SENT: "inherit_message",
+        TX_TYPE_MESSAGE_THREAD_DELETE: "inherit_message_recv",
+        TX_TYPE_TRANSFER: "transfer",
+        TX_TYPE_TRANSFER_CANCEL: "transfer_Cancel",
+        TX_TYPE_TRANSFER_SENT: "transfer_sent",
+        TX_TYPE_TRANSFER_RECEIVE_DELETE: "transfer_receive_delete",
+        TX_TYPE_STORAGE: "storage",
+        TX_TYPE_STORAGE_DELETE: "storage_delete",
+        TX_TYPE_BACKUP: "backup",
+        TX_TYPE_CONTACT: "interim_message",
+        TX_TYPE_FILE_VIRTUAL: "fs_virt",
+        TX_TYPE_FILE_FS: "fs_real",
+        TX_TYPE_RFILE_VIRTUAL: "fs_rvirt",
+        TX_TYPE_RFILE_FS: "fs_rreal",
+        TX_TYPE_REQUEST: "request",
+        TX_TYPE_REQUEST_IN: "request_in",
+        TX_TYPE_REQUEST_UPLOAD: "request_upload",
+        TX_TYPE_REQUEST_CANCEL: "request_Cancel"
+    }
 }

package/errors.js

@@ -8,5 +8,7 @@ module.exports = {
     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")
+    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")
 }

package/package.json

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