Skip to main content

Websockets

WebSocketClient​

Fluid.js comes with WebSocketClient, which abstracts a subscription to Tendermint RPC's WebSocket endpoint. This requires access to a Fluid node's RPC server, which may require privileged access as it exposes functions that can kill a node's operation. With LocalTerra, the WebSocket endpoint can be accessed at ws://localhost:26657/websocket.


_23
import { LocalTerra, WebSocketClient } from '@terra-money/terra.js';
_23
_23
const wsclient = new WebSocketClient('ws://localhost:26657/websocket');
_23
_23
const terra = new LocalTerra();
_23
_23
let count = 0;
_23
wsclient.subscribe('NewBlock', {}, (_) => {
_23
console.log(count);
_23
count += 1;
_23
_23
if (count === 3) {
_23
wsclient.destroy();
_23
}
_23
});
_23
_23
// send tracker
_23
wsclient.subscribe('Tx', { 'message.action': '/cosmos.bank.v1beta1.MsgSend' }, data => {
_23
console.log('Send occured!');
_23
console.log(data.value);
_23
});
_23
_23
wsclient.start();

Supported Events​

You can subscribe to the following recognized Tendermint events:

  • CompleteProposal
  • Evidence
  • Lock
  • NewBlock
  • NewBlockHeader
  • NewRound
  • NewRoundStep
  • Polka
  • Relock
  • TimeoutPropose
  • TimeoutWait
  • Tx
  • Unlock
  • ValidatorSetUpdates
  • ValidBlock
  • Vote

Query​

Use the following syntax to specify the Tendermint query:


_12
type TendermintQueryOperand = string | number | Date;
_12
_12
interface TendermintQuery {
_12
[k: string]:
_12
| TendermintQueryOperand
_12
| ['>', number | Date]
_12
| ['<', number | Date]
_12
| ['<=', number | Date]
_12
| ['>=', number | Date]
_12
| ['CONTAINS', string]
_12
| ['EXISTS'];
_12
}

The following shows an example of how to construct a TendermintQuery and use it for a subscription:


_10
const tmQuery = {
_10
"message.action": "/cosmos.bank.v1beta1.MsgSend",
_10
"tx.timestamp": [">=", new Date()],
_10
"store_code.abc": ["EXISTS"],
_10
"abc.xyz": ["CONTAINS", "terra1..."]
_10
};
_10
_10
wsclient.subscribe('Tx', tmQuery, (data) => {
_10
// do something with data ...
_10
});

The resultant query will be:

tm.event='Tx' AND message.action='/cosmos.bank.v1beta1.MsgSend' tx.timestamp >= 2020-12-12 AND store_code.abc EXISTS AND abc.xyz CONTAINS 'terra1...'

subscribeTx​

It is a common use case to subscribe to transactions with a Tendermint query, such as listening for when specific addresses send or receive funds, or when specific events are triggered from within smart contracts. However, it is hard to extract data because the transaction result is encoded in Base64 Amino encoding. If you use subscribeTx, Fluid.js will automatically inject the txhash into the resultant data value so you can more easily look up the transaction to decode it using LCDClient.


_8
// swap tracker
_8
wsclient.subscribeTx({ 'message.action': 'swap' }, async data => {
_8
console.log('Swap occured!');
_8
const txInfo = await terra.tx.txInfo(data.value.TxResult.txhash);
_8
if (txInfo.logs) {
_8
console.log(txInfo.logs[0].eventsByType);
_8
}
_8
});