2ab2-ws-js 中文文档教程
GrapheneJS WebSocket interface (graphenejs-ws)
用于 node.js 和浏览器的纯 JavaScript Bitshares/Graphene websocket 库。 用于通过公共 api 轻松连接到基于石墨烯的区块链并从中获取数据。
原始实现归功于 jcalfeee。
Setup
这个库可以通过 npm 获得:
npm install graphenejs-ws
Usage
浏览器包在 /build/ 中提供,出于测试目的,您可以从 rawgit 访问它:
<script type="text/javascript" src="https://cdn.rawgit.com/svk31/graphenejs-ws/build/graphenejs-ws.js" />
变量 grapheneWS 将在 window.xml 中可用。
/browserify 上下文中使用,请参阅下面的示例,了解如何打开与 Openledger API 的 websocket 连接并订阅任何对象更新:
var {Apis} = require("graphenejs-ws");
Apis.instance("wss://bitshares.openledger.info/ws").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);
}
要在webpack 关于区块链的变化。 这是非常强大的,可用于监听特定帐户、资产或大多数其他任何内容的更新,因为所有状态更改都是通过对象更新发生的。
Tests
测试显示了几个用例,要运行,只需键入 npm run test
。 测试需要运行本地见证节点以及活动的互联网连接。
GrapheneJS WebSocket interface (graphenejs-ws)
Pure JavaScript Bitshares/Graphene websocket library for node.js and browsers. be use to easily connect to and obtain data from a Graphene based blockchain via public apis.
Credit for the original implementation goes to jcalfeee.
Setup
This library can be obtained through npm:
npm install graphenejs-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/svk31/graphenejs-ws/build/graphenejs-ws.js" />
A variable grapheneWS 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("graphenejs-ws");
Apis.instance("wss://bitshares.openledger.info/ws").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. This is very powerful and can be used to listen to updates for specific accounts, assets or most anything else, as all state changes happens through object updates.
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.