karmajs-ws v1.0.0

Karma websocket interface (karmajs-ws)

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

Credit for the original implementation goes to jcalfeee.

Setup

This library can be obtained through npm:

npm install karmajs-ws

Usage

Several examples are available in the /examples folder, and the tests in /test also show how to use the library.

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

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

A variable karma_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("karmajs-ws");
Apis.connect("wss://node.karma.red").then(res => {
  console.log("connected to:", res);
  Apis.database.set_block_applied_callback(updateListener);
});

function updateListener(object) {
  console.log("set_block_applied_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.

Witness node endpoints

This is a non-exhaustive list of endpoints available from the witness_node executable, which provides the API server of Bitshares.

database_api

https://github.com/grapheneLab/karma-core/blob/master/libraries/app/database_api.cpp

Usage examples Apis.database.method(params) Apis.database.get_objects(["1.3.0", "2.0.0", "2.1.0"])

Objects

Subscriptions

Blocks and transactions

Globals

Keys

Accounts

Assets

Markets / feeds