98f40abfc3
See: https://ripple.com/build/rippled-apis/#ledger-entry Rippled request ```js { "id": 1, "command": "ledger_entry", "type": "offer", "offer": {"account": "rEQWVz1qN4DWw5J17s3DgXQzUuVYDSpK6M", "seq":5 }, "ledger_index": 10850610 } ``` Response ```js { "id": 7, "status": "success", "type": "response", "result": { "index": "F9DCCD26C770952D216085BF97D7E225F6A8B578ABD066AA92D7D06144B535EE", "ledger_index": 10850610, "node": { "Account": "rEQWVz1qN4DWw5J17s3DgXQzUuVYDSpK6M", "BookDirectory": "CF8D13399C6ED20BA82740CFA78E928DC8D498255249BA6351038D7EA4C68000", "BookNode": "0000000000000000", "Flags": 131072, "LedgerEntryType": "Offer", "OwnerNode": "0000000000000000", "PreviousTxnID": "64FAB660F9F5D9E7183E977701930AD09F372129C56E1685B68A914D8A43CA41", "PreviousTxnLgrSeq": 10850602, "Sequence": 5, "TakerGets": "1000000", "TakerPays": { "currency": "USD", "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", "value": "100" }, "index": "F9DCCD26C770952D216085BF97D7E225F6A8B578ABD066AA92D7D06144B535EE" }, "validated": false } } ```
#ripple-lib
A JavaScript API for interacting with Ripple in Node.js and the browser
###Features
- Connect to a rippled server in JavaScript (Node.js or browser)
- Issue rippled API requests
- Listen to events on the Ripple network (transaction, ledger, etc.)
- Sign and submit transactions to the Ripple network
###In this file
###Additional documentation
###Also see
##Installation
Via npm for Node.js
$ npm install ripple-lib
Via bower (for browser use)
$ bower install ripple
See the bower-ripple repo for additional bower instructions
Building ripple-lib for browser environments
ripple-lib uses Gulp to generate browser builds. These steps will generate minified and non-minified builds of ripple-lib in the build/ directory.
$ git clone https://github.com/ripple/ripple-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-coreContains the functionality to make requests and listen for events such asledgerClose. Onlyripple.Remoteis 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 rippled
/* 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
servers: [ 'wss://s1.ripple.com:443' ]
});
remote.connect(function() {
/* remote connected */
remote.requestServerInfo(function(err, info) {
// process err and info
});
});
##Running tests
-
Clone the repository
-
cdinto the repository and install dependencies withnpm install -
npm test
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/.