#THIS IS A TEST FORK FOR WORKING WITH RIPPLE-GIT-BOT
##Test commits:
- commit one
- commit two
#The Ripple JavaScript Library
ripple-lib
connects to the Ripple network via the WebSocket protocol and runs in Node.js as well as in the browser.
###Use ripple-lib for:
- Connecting to a local or remote rippled in JavaScript (Node.js or browser)
- Issuing rippled API requests
- Listening to events on the Ripple network (transaction, ledger, etc.)
- Signing and submitting transactions to the Ripple network
###In this file:
- Overview
- Getting
ripple-lib
- Quickstart
- Running tests
###For additional documentation see:
- The
ripple-lib
Guides (docs/GUIDES.md) - The
ripple-lib
API Reference (docs/REFERENCE.md) - https://ripple.com/wiki/Ripple_JavaScript_library
###Also see:
##Getting ripple-lib
Via npm for Node.js
$ npm install ripple-lib
Build from the source using grunt
$ git clone https://github.com/ripple/ripple-lib
$ npm install
$ grunt
Then use the minified build/ripple-*-min.js
in your webpage
##Quickstart
Remote
(remote.js) is the module responsible for managing connections to rippled
servers:
/* Loading ripple-lib with Node.js */
var Remote = require('ripple-lib').Remote;
/* Loading ripple-lib in a webpage */
// var Remote = ripple.Remote;
var remote = new Remote({
// see the API Reference for available options
trusted: true,
local_signing: true,
local_fee: true,
fee_cushion: 1.5,
servers: [
{
host: 's1.ripple.com'
, port: 443
, secure: true
}
]
});
remote.connect(function() {
/* remote connected */
// see the API Reference for available functions
});
See The ripple-lib
Guides and The ripple-lib
API Reference for walkthroughs and details about all of the available functions and options.
##Running tests
-
Clone the repository
-
cd
into the repository and install dependencies withnpm install
-
npm test
ormake test
ornode_modules\.bin\mocha test\*-test.js
Generating code coverage
ripple-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/
.