wax-ws-rpc-js

JavaScript client SDK for WAX WebSocket RPC.

Installation

NPM

The official distribution package can be found at npm.

npm install wax-ws-rpc-js

Import

ES Modules

Importing using ESM syntax is supported using TypeScript, webpack

import { WebsocketJsonRpc } from "wax-ws-rpc-js";

CommonJS

Importing using commonJS syntax is supported by Node.js

const { WebsocketJsonRpc } = require("wax-ws-rpc-js");

Basic Usage

default config

const rpc = new WebsocketJsonRpc('ws://localhost:3000');

custom config

const rpc = new WebsocketJsonRpc('ws://localhost:3000', {
  autoConnect: true,
  autoReconnect: true,
  reconnectInterval: 3000,
  maxRetries: 10,
  requestTimeOut: 3000
});

Chain API Request

const info = await rpc.get_info();

const table_rows = await rpc.get_table_rows({ 
  "json": true, 
  "code": "eosio.token", 
  "scope": "eosio.saving", 
  "table": "accounts" 
});

const account = await rpc.get_account("eosio");

Table Deltas

let unsubscribe_eosio_token = rpc.subscribeTable('eosio.token', 'eosio.stake', 'accounts', (msg) => {
    console.log('Balance Updated:', msg);

    // example response
    // {
    //   action: "UPDATE",
    //   code: "eosio.token",
    //   data: {
    //     balance: "1102920036.56360517 WAX",
    //   },
    //   old_data: {
    //     balance: "1102920036.56360115 WAX",
    //   },
    //   payer: "eosio.stake",
    //   primary_key: 5783895,
    //   scope: "eosio.stake",
    //   table: "accounts",
    //   type: "table_delta",
    // }
});

Action Trace

const unsubscribe_eosio_token = rpc.subscribeTrace('eosio.token::transfer', (msg) => {
    console.log(msg);

    // example response
    // {
    //   block_num: 416203521,
    //   block_time: "2026-01-28T06:47:32.000Z",
    //   cpu_usage_us: 620,
    //   net_usage: 176,
    //   receiver: "eosio.token",
    //   trace: {
    //     account: "eosio.token",
    //     authorization: [
    //       {
    //         actor: "oouso.gm",
    //         permission: "active",
    //       }
    //     ],
    //     data: {
    //       from: "oouso.gm",
    //       memo: "stake bandwidth",
    //       quantity: "0.00000015 WAX",
    //       to: "eosio.stake",
    //     },
    //     name: "transfer",
    //   },
    //   tx_id: "d9d0320a743d8c380dbf71839fa52547f010fc578ec389ecdca3dec16b2c48bc",
    //   type: "action_trace",
    // }
});

Using With wharfkit APIClient

import { WebSocketProvider } from 'wax-ws-rpc-js';
import { APIClient } from '@wharfkit/antelope';

const waxApiClient = new APIClient({
  provider: new WebSocketProvider("ws://localhost:3000", "https://wax.greymass.com")
});

const info = await waxApiClient.v1.chain.get_info();

const table_rows = await waxApiClient.v1.chain.get_table_rows({ 
  "json": true, 
  "code": "eosio.token", 
  "scope": "eosio.saving", 
  "table": "accounts" 
});

const account = await waxApiClient.v1.chain.get_account("eosio");

const actions = await waxApiClient.v1.history.get_actions("eosio");

Using With eosjs

import { Api } from 'eosjs';
import { JsSignatureProvider } from 'eosjs/dist/eosjs-jssig';
import { WebsocketJsonRpc } from 'wax-ws-rpc-js';

const defaultPrivateKey = "5Hpu95MCJsYWzMMkhWR7bxjxJtEZ3JqLNeBCTiNT2XdPkSSCCkD";
const signatureProvider = new JsSignatureProvider([defaultPrivateKey]);

const rpc = new WebsocketJsonRpc('ws://localhost:3000');
const api = new Api({ 
  rpc, 
  signatureProvider, 
  textDecoder: new TextDecoder(), 
  textEncoder: new TextEncoder() 
});

const result = await api.transact({
  actions: [
    {
      account: 'eosio.token',
      name: 'transfer',
      authorization: [
        {
          actor: 'account1',
          permission: 'active',
        }
      ],
      data: {
        from: 'account1',
        to: 'account2',
        quantity: '1.00000000 WAX',
        memo: "(>'.')> <('.'<)"
      },
    }
  ]
}, {
    blocksBehind: 3,
    expireSeconds: 30,
});
console.dir(result, { depth: null });