https://github.com/bitshares/bitsharesjs-ws

Javascript websocket interface for BitShares
https://github.com/bitshares/bitsharesjs-ws

bitshares blockchain javascript js-library reactjs websocket

Last synced: about 2 months ago
JSON representation

Javascript websocket interface for BitShares

• Host: GitHub
• URL: https://github.com/bitshares/bitsharesjs-ws
• Owner: bitshares
• License: mit
• Created: 2017-01-19T13:57:49.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-03-16T00:06:48.000Z (6 months ago)
• Last Synced: 2024-04-15T01:59:12.610Z (5 months ago)
• Topics: bitshares, blockchain, javascript, js-library, reactjs, websocket
• Language: JavaScript
• Homepage:
• Size: 1.43 MB
• Stars: 30
• Watchers: 15
• Forks: 117
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bitshares - bitsharesjs-ws - used by reference wallet. (Libraries / JavaScript Libraries)

README

        
# Bitshares websocket interface (bitsharesjs-ws)

Pure JavaScript Bitshares 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](https://github.com/jcalfee).

[![npm version](https://img.shields.io/npm/v/bitsharesjs-ws.svg?style=flat-square)](https://www.npmjs.com/package/bitsharesjs-ws)

[![npm downloads](https://img.shields.io/npm/dm/bitsharesjs-ws.svg?style=flat-square)](https://www.npmjs.com/package/bitsharesjs-ws)

## Setup

This library can be obtained through npm:

```

npm install bitsharesjs-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:

```

```

A variable bitshares_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("bitsharesjs-ws");

Apis.instance("wss://bitshares.openledger.info/ws", true).init_promise.then((res) => {

    console.log("connected to:", res[0].network);

    Apis.db.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.

# Witness node endpoints

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

## Public API 

Please see all available methods in the [official documentation](http://dev.bitshares.works/en/master/api/blockchain_api.html).

### Database API

To access the [Database API](http://dev.bitshares.works/en/master/api/blockchain_api/database.html), you can use the `Apis.db` object.

__Usage example__

`Apis.db.get_objects(["1.3.0", "2.0.0", "2.1.0"])`

### History API

To access the [Account History API](http://dev.bitshares.works/en/master/api/blockchain_api/history.html), you can use the `Apis.history` object.

__Usage example__

`Apis.history.get_account_history("1.2.849826", "1.11.0", 10, "1.11.0")`

## Tests

The tests show several use cases, to run, simply type `npm run test`. The tests require a local witness node to be running, as well as an active internet connection.