bluzelle-lib v0.13.0-rc15
#bluzelle-lib
A JavaScript API for interacting with Bluzelle in Node.js and the browser
###Features
- Connect to a bluzelled server in JavaScript (Node.js or browser)
- Issue bluzelled API requests
- Listen to events on the Bluzelle network (transaction, ledger, etc.)
- Sign and submit transactions to the Bluzelle network
###In this file
###Additional documentation
###Also see
##Installation
Via npm for Node.js
$ npm install bluzelle-lib
Via bower (for browser use)
$ bower install bluzelle
See the bower-bluzelle repo for additional bower instructions.
Building bluzelle-lib for browser environments
bluzelle-lib uses Gulp to generate browser builds. These steps will generate minified and non-minified builds of bluzelle-lib in the build/
directory.
$ git clone https://github.com/bluzelle/bluzelle-lib
$ npm install
$ npm run build
Restricted browser builds
You may generate browser builds that contain a subset of features. To do this, run ./node_modules/.bin/gulp build-<name>
build-core
Contains the functionality to make requests and listen for events such asledgerClose
. Onlybluzelle.Remote
is currently exposed. Advanced features like transaction submission and orderbook tracking are excluded from this build.
##Quick start
Remote.js
(remote.js) is the point of entry for interacting with bluzelled
/* Loading bluzelle-lib with Node.js */
var Remote = require('bluzelle-lib').Remote;
/* Loading bluzelle-lib in a webpage */
// var Remote = bluzelle.Remote;
var remote = new Remote({
// see the API Reference for available options
servers: [ 'wss://s1.bluzelle.com:443' ]
});
remote.connect(function() {
/* remote connected */
remote.requestServerInfo(function(err, info) {
// process err and info
});
});
##Running tests
Clone the repository
cd
into the repository and install dependencies withnpm install
npm test
Generating code coverage
bluzelle-lib uses istanbul
to generate code coverage. To create a code coverage report, run npm test --coverage
. The report will be created in coverage/lcov-report/
.
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago