Mainnet
wss://eosws.mainnet.eoscanada.com/v1/stream?token=[API TOKEN]
Kylin
wss://eosws.kylin.eoscanada.com/v1/stream?token=[API TOKEN]
npm
$ npm install --save eosws
import WebSocket from "ws";
import { get_actions, parse_actions } from "eosws";
const API_TOKEN = "eyJ...IBg";
const origin = "https://example.com";
const ws = new WebSocket(`wss://<SERVER>/v1/stream?token=${API_TOKEN}`, {origin});
ws.onopen = () => {
ws.send(get_actions("eosio.token", "transfer"));
};
ws.onmessage = (message) => {
const actions = parse_actions(message.data);
if (actions) {
const { from, to, quantity, memo } = actions.data.trace.act.data;
console.log(from , to, quantity, memo);
}
};
import { get_table_rows, parse_table_rows } from "eosws";
ws.onopen = () => {
ws.send(get_table_rows("eosio", "eosio", "voters"));
};
ws.onmessage = (message) => {
const table = parse_table_rows<Voters>(message.data, voters_req_id);
if (table) {
const {owner, producers, last_vote_weight} = table.data.row;
console.log(owner, producers, last_vote_weight);
}
};
- WebSockets (https://github.com/websockets/ws)
- Socket.io (https://github.com/socketio/socket.io)
- Push Irreversible Transaction (https://youtu.be/dO-Le3TTim0?t=34m6s)
Get Actions
account
string Accountaction_name
string Action Namereceiver
string? Receiveroptions
(optional, default{}
)
ws.send(get_actions("eosio.token", "transfer"));
Returns string Message for ws.send
Get Table Deltas
code
string Codescope
string Scopetable_name
string Table Nameoptions
object Optional parameters (optional, default{}
)
ws.send(get_table_rows("eosio", "eosio", "global"));
Returns string Message for ws.send
Unlisten to WebSocket based on request id
req_id
string Request ID
ws.send(unlisten("req123"));
Generate Req ID
generateReqId() // => req123
Returns string Request ID
Parse Actions from get_actions
from WebSocket onmessage
listener
data
WebSocketData WebSocket Data from message eventreq_id
string? Request ID
const actions = parse_actions<any>(message);
Returns ActionTrace Action Trace
Parse Table Deltas from get_table_rows
from WebSocket onmessage
listener
data
WebSocketData WebSocket Data from message eventreq_id
string? Request ID
const table_deltas = parse_table_rows<any>(message);
Returns ActionTrace Action Trace
Parse Ping from WebSocket onmessage
listener
data
WebSocketData WebSocket Data from message event
const ping = parse_ping(message);
Returns Ping Ping