bft-tendermint v3.1.2

tendermint

A JS RPC client for Tendermint nodes.

usage

First, make sure you've set up a tendermint node and ABCI application

then:

npm install tendermint

let Tendermint = require('tendermint')


// a websocket uri is required to subscribe to events:
const NODE_URI = 'ws://localhost:46657'
let client = Tendermint(NODE_URI)

// let's just log new blocks:
client.subscribe({ event: 'NewBlock' }, (err, event) => {
  console.log(event)
  /*
    {
      name: 'NewBlock',
      data: {
        type: 'new_block',
        data: {
          block: [
            {
              txs: []
            }
          ]
        }
      }
    } 
  */
})

the following methods are available on the client object, each accepting a nodeback as the last argument:

- subscribe
- unsubscribe

- status
- netInfo
- dialSeeds
- blockchain
- genesis
- block
- validators
- dumpConsensusState
- broadcastTxCommit
- broadcastTxSync
- broadcastTxSync
- unconfirmedTxs
- numUnconfirmedTxs

- abciQuery
- abciInfo
- abciProof

- unsafeFlushMempool
- unsafeSetConfig
- unsafeStartCpuProfiler
- unsafeStopCpuProfiler
- unsafeWriteHeapProfile

more detailed docs about arguments to each method coming soon.