README.md

TCABCI Read Node Javascript WebSocket Client

TransferChain Fastest Read Network WebSocket Client Read Node Address: https://read-node-01.transferchain.io Read Node WebSocket Address: wss://read-node-01.transferchain.io/ws

Networks

• transferchain - v1
• medusa - v2 (new blocks)

Installation

$ npm i @tchain/tcabci-read-js-client

Example

Subscribe, Listen and Unsubscribe Example

import TCaBCIClient from '@tchain/tcabci-read-js-client'

const client = new TCaBCIClient()
// OR
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()

client.Subscribe(['<your-public-address-one>', '<your-public-address-two>'])

client.SetListenCallback(() => {
  // If a transaction has been sent to your addresses, the callback you set here will be called.
})

client.SetErrorCallback(() => {
  // If network errors will be called.
})

client.SetCloseCallback(() => {
  // If server side close will be called.
})

client.Unsubscribe()
client.Stop()

License

tcabci-read-js-client is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.