Skip to content

Javascript websocket interface for GXB

License

Notifications You must be signed in to change notification settings

gxchain/gxbjs-ws

This branch is 25 commits ahead of, 147 commits behind bitshares/bitsharesjs-ws:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

607e778 · Jun 10, 2020

History

40 Commits
Nov 12, 2018
Jun 10, 2020
Dec 14, 2018
Jan 19, 2017
Jun 10, 2020
Sep 30, 2018
Mar 29, 2017
Jan 19, 2017
Oct 18, 2018
Jun 10, 2020
Jun 10, 2020

Repository files navigation

GXChain websocket interface (gxbjs-ws)

Pure JavaScript GXChain websocket library for node.js and browsers. Can be used to easily connect to and obtain data from the GXB blockchain via public apis or local nodes.

Credit for the original implementation goes to jcalfee.

npm version npm downloads

Setup

This library can be obtained through npm:

npm install gxbjs-ws

Usage

Browser bundles are provided in /build/, for testing purposes you can access this from rawgit:

<script type="text/javascript" src="https://cdn.rawgit.com/gxchain/gxbjs-ws/build/gxbjs-ws.js" />

A variable gxbjs_ws will be available in window.

For use in a webpack/browserify context, see the example below for how to open a websocket connection to the Openledger API and subscribe to any object updates:

var {Apis} = require("gxbjs-ws");
Apis.instance("wss://node1.gxb.io",true).init_promise.then((res) => {
    console.log("connected to:", res[0].network);
    Apis.instance().db_api().exec( "set_subscribe_callback", [ updateListener, true ] )
});

function updateListener(object) {
    console.log("set_subscribe_callback:\n", object);
}

The set_subscribe_callback callback (updateListener) will be called whenever an object on the blockchain changes or is removed. This is very powerful and can be used to listen to updates for specific accounts, assets or most anything else, as all state changes happen through object updates. Be aware though that you will receive quite a lot of data this way.

About

Javascript websocket interface for GXB

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%