Home

Awesome

demux-js-bitshares

Demux BitShares is a Demux plugin for sourcing Bitshares blockchain events to deterministically update queryable datastores and trigger side effects.

Overview

The default implementation BitsharesActionReader uses BitShares get_block API to retrieve blocks one by one from the a BitShares core API node. Using this approach virtual operations like fill_order are not available, and synchronization time is very long.

To avoid those issues, an alternative implementation BitsharesElasticSearchActionReader uses ElasticSearch as backend, this requires a node with ElasticSearch Bitshares plugin activated, and demux-bitshares 1.1+.

Installation

# Using yarn
yarn add demux-bitshares

# Using npm
npm install demux-bitshares --save

Example

// Let's read from a BitShares core node
const { BitsharesActionReader } = require("demux-bitshares")

// Assuming you've created your own subclass of AbstractActionHandler
const MyActionHandler = require("./MyActionHandler")

// Ties everything together in a polling loop
const  { BaseActionWatcher } = require("demux")

// Import Updaters and Effects, which are arrays of objects:
// [ { actionType: string, (updater|effect): function }, ... ] 
const updaters = require("./updaters")
const effects = require("./effects")

const actionReader = new BitsharesActionReader(
  "http://some-bitshares-endpoint:9080", // Locally hosted node needed for reasonable indexing speed
  12345678, // First block to retrieve relevant to this application.
)

const actionHandler = new MyActionHandler(
  updaters,
  effects,
)

const actionWatcher = new BaseActionWatcher(
  actionReader,
  actionHandler,
  1500, // Poll at twice the block interval for less latency
)

actionWatcher.watch() // Start watch loop

For more complete examples, see the examples directory.

Virtual operations

By default in Bitshares block, implicit operations like fill_order are not included. Those are called 'virtual operations'. To retrieve virtual operations you can use an ElasticSearch backend instead of an Bitshares API node. Use BitsharesElasticSearchActionReader to do so:

const actionReader = new BitsharesElasticSearchActionReader(
  {
    host: "https://some-es-bitshares-cluster/", // ES cluster to connect to.
    httpAuth: "user:password" // Credentials to ES.
  },
  28999264, // First block to retrieve relevant to this application.
)

You can get the full configuration options to connect to the ElasticSearch cluster here.

Possible improvements: