radr-lib v0.0.1

#radr-lib

A JavaScript API for interacting with Radr in Node.js and the browser

###Features

• Connect to a radrd server in JavaScript (Node.js or browser)
• Issue radrd API requests
• Listen to events on the Radr network (transaction, ledger, etc.)
• Sign and submit transactions to the Radr network

###In this file

1. Installation
2. Quick start
3. Running tests

###Additional documentation

1. Guides
2. API Reference
3. Wiki

###Also see

• The Radr wiki
• radr.biz

##Installation

Via npm for Node.js

  $ npm install radr-lib

Via bower (for browser use)

  $ bower install radr

See the bower-radr repo for additional bower instructions

Building radr-lib for browser environments

radr-lib uses Gulp to generate browser builds. These steps will generate minified and non-minified builds of radr-lib in the build/ directory.

  $ git clone https://github.com/radr/radr-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 as ledgerClose. Only radr.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 radrd

/* Loading radr-lib with Node.js */
var Remote = require('radr-lib').Remote;

/* Loading radr-lib in a webpage */
// var Remote = radr.Remote;

var remote = new Remote({
  // see the API Reference for available options
  servers: [ 'wss://s1.radr.biz:443' ]
});

remote.connect(function() {
  /* remote connected */
  remote.requestServerInfo(function(err, info) {
    // process err and info
  });
});

##Running tests

1. Clone the repository

2. cd into the repository and install dependencies with npm install

3. npm test

Generating code coverage

radr-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/.