Bump version to 0.13.1

Add babel-polyfill

.flowconfig

@@ -1,9 +1,9 @@
 [ignore]
-.*/src/api/.*
-.*/src/core/.*
-.*/dist/.*
-.*/test/fixtures/.*
+.*/ripple-lib/src/.*
+.*/ripple-lib/dist/.*
+.*/ripple-lib/test/fixtures/.*
 .*/node_modules/flow-bin/.*
+.*/node_modules/webpack/.*
 
 [include]
 ./node_modules/

.travis.yml

@@ -1,9 +0,0 @@
-sudo: false       # use faster docker containers
-language: node_js
-node_js:
-  - "0.12"
-before_script:
-  - sh -c "git log | head -12"
-script: bin/ci.sh
-notifications:
-  email: false

Gulpfile.js

@@ -26,6 +26,9 @@ function webpackConfig(extension, overrides) {
         test: /\.js$/,
         exclude: /node_modules/,
         loader: 'babel-loader?optional=runtime'
+      }, {
+        test: /\.json/,
+        loader: 'json-loader'
       }]
     }
   };

HISTORY.md

@@ -1,3 +1,39 @@
+##0.13.0
+
+**Breaking Changes**
++ Add new RippleAPI interface and delete old API
+    - [RippleAPI README and samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
+    - [Method documentation](https://rawgit.com/ripple/ripple-lib/develop/docs/api.html)
+
+**Changes**
++ [Removed timeout method of Request and added default timeout](https://github.com/ripple/ripple-lib/commit/634fe5683a9082e57682ff7d5c4fb9483b4af818)
++ [Add Remote.closeCurrentPathFind function, so current pathfind can be properly closed](https://github.com/ripple/ripple-lib/commit/e99010f363fc7cbe7fd547d3ca5b32ea083c44e6)
++ [Implement Balance Sheet API](https://github.com/ripple/ripple-lib/pull/579)
++ [Fix bugs in orderbook subscription](https://github.com/ripple/ripple-lib/commit/7404795dc64a85216148de7bc3ca7da7b33f4490)
++ [Fix crash due to rippled slowDown error](https://github.com/ripple/ripple-lib/commit/84838b2e9f6969b593b8462a62a6b8f516ada937)
++ [Fix: Emit error events and return error on pathfind](https://github.com/ripple/ripple-lib/commit/1ccbaf677631a1944eb05d90f7afc5f3690a03dd)
++ [Deprecate core and remove snake case method copying](https://github.com/ripple/ripple-lib/commit/fb8dc44ec1d49bb05cd0cdbe6dd4ab211195868a)
+
++ [Fix RangeSet for validated_ledger as single ledger](https://github.com/ripple/ripple-lib/commit/9f9e76f8b933201651af59307135f67cfa7d60e8)
++ [Fix bug where the paths would be set with an empty array](https://github.com/ripple/ripple-lib/commit/83874ec0962da311b76f2385623e51c68bc39035)
++ [Fix reserve calculation](https://github.com/ripple/ripple-lib/commit/52879febb92d876f01f2e4d70871baa07af631fb)
+
+##0.12.9
+
++ [OrderBook performance optimizations](https://github.com/ripple/ripple-lib/commit/3e17d91edf36745f6b6c09b0ad88971b7775f6ab)
+
+##0.12.7 and 0.12.8
+
++ [Improve performance of orderbook](https://github.com/ripple/ripple-lib/commit/c745faaaf0956ca98448a754b4fe97fb50574fc7)
+
++ [Remove Firefox warning about prototype overwrite](https://github.com/ripple/ripple-lib/commit/0c62fa21123b220b066871e1c41a3b4fe6f51885)
+
++ [Fix compare bug in Amount class](https://github.com/ripple/ripple-lib/commit/806547dd154e1b0bf252e8a74ad3ac6aa8a97660)
+
+##0.12.6
+
++ [Fix webpack require failure due to "./" notation](https://github.com/ripple/ripple-lib/commit/8d9746d7b10be203ee613df523c2522012ff1baf)
+
 ##0.12.15
 
 + [Add offer autobridging](https://github.com/ripple/ripple-lib/commit/c7bbce83719c1e8c6a4fae5ca850e7515db1a4a5)

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012,2013,2014 Ripple Labs Inc.
+Copyright (c) 2012-2015 Ripple Labs Inc.
 
 Permission to use, copy, modify, and distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
@@ -11,42 +11,3 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
---------------------------------------
-
-Some code from Tom Wu:
-This software is covered under the following copyright:
-
-Copyright (c) 2003-2005  Tom Wu
-All Rights Reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
-EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
-WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
-
-IN NO EVENT SHALL TOM WU BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
-INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER
-RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF
-THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT
-OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-In addition, the following condition applies:
-
-All redistributions must retain an intact copy of this copyright notice
-and disclaimer.
-
-Address all questions regarding this license to:
-
-  Tom Wu
-  tjw@cs.Stanford.EDU

README.md

@@ -2,7 +2,7 @@
 
 A JavaScript API for interacting with Ripple in Node.js and the browser
 
-[![Build Status](https://travis-ci.org/ripple/ripple-lib.svg?branch=develop)](https://travis-ci.org/ripple/ripple-lib) [![Coverage Status](https://coveralls.io/repos/ripple/ripple-lib/badge.png?branch=develop)](https://coveralls.io/r/ripple/ripple-lib?branch=develop)
+[![Circle CI](https://circleci.com/gh/ripple/ripple-lib/tree/develop.svg?style=svg)](https://circleci.com/gh/ripple/ripple-lib/tree/develop) [![Coverage Status](https://coveralls.io/repos/ripple/ripple-lib/badge.png?branch=develop)](https://coveralls.io/r/ripple/ripple-lib?branch=develop)
 
 [![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib)
 
@@ -13,88 +13,25 @@ A JavaScript API for interacting with Ripple in Node.js and the browser
 + Listen to events on the Ripple network (transaction, ledger, etc.)
 + Sign and submit transactions to the Ripple network
 
-###In this file
-
-1. [Installation](#installation)
-2. [Quick start](#quick-start)
-3. [Running tests](#running-tests)
-
-###Additional documentation
-
-1. [Guides](docs/GUIDES.md)
-2. [API Reference](docs/REFERENCE.md)
-3. [Wiki](https://ripple.com/wiki/Ripple_JavaScript_library)
-
-###Also see
-
-+ [The Ripple wiki](https://ripple.com/wiki)
-+ [ripple.com](https://ripple.com)
-
-##Installation
-
-**Via npm for Node.js**
+##Getting Started
 
+Install `ripple-lib` using npm:
 ```
   $ npm install ripple-lib
 ```
 
-**Via bower (for browser use)**
-
-```
-  $ bower install ripple
-```
-
-See the [bower-ripple repo](https://github.com/ripple/bower-ripple) 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-core` Contains the functionality to make requests and listen for events such as `ledgerClose`. Only `ripple.Remote` is currently exposed. Advanced features like transaction submission and orderbook tracking are excluded from this build.
-
-##Quick start
-
-`Remote.js` ([remote.js](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/remote.js)) is the point of entry for interacting with rippled
-
-```js
-/* 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
-  });
-});
-```
+Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md) and [code samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
 
 ##Running tests
 
 1. Clone the repository
-
 2. `cd` into the repository and install dependencies with `npm install`
+3. `npm test` or `npm test --coverage` (`istanbul` will create coverage reports in coverage/lcov-report/`)
 
-3. `npm test`
+##Generating Documentation
 
-**Generating code coverage**
+The continuous integration tests require that the documentation stays up-to-date. If you make changes the the JSON schemas, fixtures, or documentation sources, you must update the documentation by running `npm run docgen`.
 
-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/`.
+##More Information
+
++ [Ripple Dev Portal](https://ripple.com/build/)

bin/ci.sh

@@ -1,52 +0,0 @@
-#!/bin/bash -ex
-
-NODE_INDEX="$1"
-TOTAL_NODES="$2"
-
-typecheck() {
-  npm install -g flow-bin
-  npm run typecheck
-}
-
-lint() {
-  REPO_URL="https://raw.githubusercontent.com/ripple/javascript-style-guide"
-  curl "$REPO_URL/es6/eslintrc" > ./eslintrc
-  echo "plugins: [flowtype]" >> ./eslintrc
-  node_modules/.bin/eslint --reset -c ./eslintrc $(git --no-pager diff --name-only -M100% --diff-filter=AM --relative $(git merge-base FETCH_HEAD origin/HEAD) FETCH_HEAD | grep "\.js$")
-}
-
-unittest() {
-  npm test --coverage
-  npm run coveralls
-}
-
-oneNode() {
-  lint
-  typecheck
-  unittest
-}
-
-twoNodes() {
-  case "$NODE_INDEX" in
-    0) lint && unittest;;
-    1) typecheck;;
-    *) echo "ERROR: invalid usage"; exit 2;;
-  esac
-}
-
-threeNodes() {
-  case "$NODE_INDEX" in
-    0) lint;;
-    1) typecheck;;
-    2) unittest;;
-    *) echo "ERROR: invalid usage"; exit 2;;
-  esac
-}
-
-case "$TOTAL_NODES" in
-  "") oneNode;;
-  1) oneNode;;
-  2) twoNodes;;
-  3) threeNodes;;
-  *) echo "ERROR: invalid usage"; exit 2;;
-esac

bin/decode_binary.js

@@ -1,52 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable no-var */
-'use strict';
-var SerializedObject = require('..').SerializedObject;
-
-function main() {
-  var argv = process.argv.slice(2);
-  var blob = argv.shift();
-
-  if (blob === '-') {
-    read_input(ready);
-  } else {
-    ready(blob);
-  }
-}
-
-function read_input(callback) {
-  var tx_json = '';
-  process.stdin.on('data', function(data) {
-    tx_json += data;
-  });
-  process.stdin.on('end', callback);
-  process.stdin.resume();
-}
-
-function ready(blob) {
-  var valid_arguments = blob;
-
-  if (!valid_arguments) {
-    console.error('Invalid arguments\n');
-    print_usage();
-  } else {
-    decode(blob);
-  }
-}
-
-function print_usage() {
-  /* eslint-disable max-len */
-  console.log(
-    'Usage: decode_binary.js <hex_blob>\n\n',
-    'Example: decode_binary.js 120000240000000161D6871AFD498D00000000000000000000000000005553440000000000550FC62003E785DC231A1058A05E56E3F09CF4E668400000000000000A732102AE75B908F0A95F740A7BFA96057637E5C2170BC8DAD13B2F7B52AE75FAEBEFCF811450F97A072F1C4357F1AD84566A609479D927C9428314550FC62003E785DC231A1058A05E56E3F09CF4E6'
-  );
-  /* eslint-enable max-len */
-}
-
-function decode(blob) {
-  var buffer = new SerializedObject(blob);
-  console.log(buffer.to_json());
-}
-
-main();
-// vim:sw=2:sts=2:ts=8:et

bin/rsign.js

@@ -1,97 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable no-var */
-'use strict';
-var Transaction = require('..').Transaction;
-
-function read_input(callback) {
-  var stdin = '';
-  process.stdin.on('data', function(data) {
-    stdin += data;
-  });
-  process.stdin.on('end', function() {
-    callback(stdin);
-  });
-  process.stdin.resume();
-}
-
-function print_usage() {
-  console.log(
-    'Usage: rsign.js <secret> <json>\n\n',
-    'Example: rsign.js ssq55ueDob4yV3kPVnNQLHB6icwpC', '\'' +
-    JSON.stringify({
-      TransactionType: 'Payment',
-      Account: 'r3P9vH81KBayazSTrQj6S25jW6kDb779Gi',
-      Destination: 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV',
-      Amount: '200000000',
-      Fee: '10',
-      Sequence: 1
-    }) + '\''
-  );
-}
-
-function sign_transaction(tx_json_object, secret, verbose) {
-  var tx = new Transaction();
-
-  tx.tx_json = tx_json_object;
-  tx._secret = secret;
-  tx.complete();
-
-  var unsigned_blob = tx.serialize().to_hex();
-  var unsigned_hash = tx.signingHash();
-  tx.sign();
-
-  if (verbose) {
-    var sim = { };
-    sim.tx_blob = tx.serialize().to_hex();
-    sim.tx_json = tx.tx_json;
-    sim.tx_signing_hash = unsigned_hash;
-    sim.tx_unsigned = unsigned_blob;
-    console.log(JSON.stringify(sim, null, 2));
-  } else {
-    console.log(tx.serialize().to_hex());
-  }
-}
-
-function ready(tx_json, secret, verbose) {
-  if (!(tx_json && secret)) {
-    console.error('Invalid arguments\n');
-    print_usage();
-    return;
-  }
-
-  var tx_json_object;
-  try {
-    tx_json_object = JSON.parse(tx_json);
-  } catch(exception) {
-    console.error('Invalid JSON\n');
-    print_usage();
-    return;
-  }
-  sign_transaction(tx_json_object, secret, verbose);
-}
-
-function main() {
-  var argv = process.argv.slice(2);
-  var verbose;
-  var secret;
-  var tx_json;
-
-  if (~argv.indexOf('-v')) {
-    argv.splice(argv.indexOf('-v'), 1);
-    verbose = true;
-  }
-
-  secret = argv.shift();
-  tx_json = argv.shift();
-
-  if (tx_json === '-') {
-    read_input(function(stdin) {
-      ready(stdin, secret, verbose);
-    });
-  } else {
-    ready(tx_json, secret, verbose);
-  }
-}
-
-main();
-// vim:sw=2:sts=2:ts=8:et

bin/validate_address.js

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable no-var */
-'use strict';
-var UInt160 = require('..').UInt160;
-
-function main() {
-  var address = process.argv[2];
-
-  if (address === '-') {
-    readInput(validateAddress);
-  } else {
-    validateAddress(address);
-  }
-}
-
-function readInput(callback) {
-  var result = '';
-  process.stdin.resume();
-  process.stdin.setEncoding('utf8');
-  process.stdin.on('data', function(data) {
-    result += data;
-  });
-  process.stdin.on('end', function() {
-    callback(result);
-  });
-}
-
-function validateAddress(address) {
-  process.stdout.write((UInt160.is_valid(address.trim()) ? '0' : '1') + '\r\n');
-}
-
-main();

circle.yml

@@ -3,5 +3,5 @@ machine:
     version: 0.12.0
 test:
   override:
-    - bin/ci.sh "$CIRCLE_NODE_INDEX" "$CIRCLE_NODE_TOTAL":
+    - scripts/ci.sh "$CIRCLE_NODE_INDEX" "$CIRCLE_NODE_TOTAL":
         parallel: true

docs/BUILD.md

@@ -1,20 +0,0 @@
-Using Flow typechecking
-=======================
-
-Stage 1
--------
-1. Add /* @flow */ to the top of a file you want to typecheck
-2. Run `gulp typecheck` to generate a list of warnings
-
-Stage 2
--------
-When all source files have the /* @flow */ header and all warnings have been
-addressed, remove the `weak: true` option from Gulpfile.js, run
-`gulp typecheck` and remove all the additional warnings.
-
-Stage 3
--------
-Add type annotations to the source code and run `gulp strip` to strip
-the type annotations and write the output to the `out` directory. After
-type annotations are added, the program must be run from the `out` directory
-because Node does not understand the annotations

docs/GUIDES.md

@@ -1,252 +0,0 @@
-#Guides
-
-This file provides step-by-step walkthroughs for some of the most common usages of `ripple-lib`.
-
-###In this document
-
-1. [Connecting to the Ripple network with `Remote`](GUIDES.md#connecting-to-the-ripple-network)
-2. [Using `Remote` functions and `Request` objects](GUIDES.md#sending-rippled-API-requests)
-3. [Listening to the network](GUIDES.md#listening-to-the-network)
-4. [Submitting a payment to the network](GUIDES.md#submitting-a-payment-to-the-network)
-   * [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees)
-5. [Submitting a trade offer to the network](GUIDES.md#submitting-a-trade-offer-to-the-network)
-
-###Also see
-
-1. [The ripple-lib README](../README.md)
-2. [The ripple-lib API Reference](REFERENCE.md)
-
-##Connecting to the Ripple network
-
-1. [Get ripple-lib](../README.md#installation)
-2. Load the ripple-lib module into a Node.js file or webpage:
-  ```js
-  /* Loading ripple-lib with Node.js */
-  var Remote = require('ripple-lib').Remote;
-
-  /* Loading ripple-lib in a webpage */
-  // var Remote = ripple.Remote;
-  ```
-3. Create a new `Remote` and connect to the network:
-  ```js
-
-  var options = {
-    trace :         false,
-    trusted:        true,
-    local_signing:  true,
-    servers: [
-      { host: 's-west.ripple.com', port: 443, secure: true }
-    ]
-  };
-
-  var remote = new Remote(options);
-
-  remote.connect(function(err, res) {
-    /* remote connected, use some remote functions here */
-  });
-  ```
-  __NOTE:__ See the API Reference for available [`Remote` options](REFERENCE.md#1-remote-options)
-
-4. You're connected! Read on to see what to do now.
-
-##Generating a new Ripple Wallet
-
-  ```js
-    var ripple = require('ripple-lib');
-
-    // subscribing to a server allows for more entropy
-    var remote = new ripple.Remote({
-      servers: [
-        { host: 's1.ripple.com', port: 443, secure: true }
-      ]
-    });
-
-    remote.connect(function(err, res) {
-     /* remote connected */
-    });
-
-    // Wait for randomness to have been added.
-    // The entropy of the random generator is increased
-    // by random data received from a rippled
-    remote.once('random', function(err, info) {
-      var wallet = ripple.Wallet.generate();
-      console.log(wallet);
-      // { address: 'rEf4sbVobiiDGExrNj2PkNHGMA8eS6jWh3',
-      //   secret: 'shFh4a38EZpEdZxrLifEnVPAoBRce' }
-    });
-  ```
-
-
-##Sending rippled API requests
-
-`Remote` contains functions for constructing a `Request` object.
-
-A `Request` is an `EventEmitter` so you can listen for success or failure events -- or, instead, you can provide a callback.
-
-Here is an example, using [requestServerInfo](https://ripple.com/wiki/JSON_Messages#server_info).
-
-+ Constructing a `Request` with event listeners
-```js
-var request = remote.requestServerInfo();
-
-request.on('success', function onSuccess(res) {
-  //handle success
-});
-
-request.on('error', function onError(err) {
-  //handle error
-});
-
-request.request();
-```
-
-+ Using a callback:
-```js
-remote.request('server_info', function(err, res) {
-  if (err) {
-    //handle error
-  } else {
-    //handle success
-  }
-});
-```
-
-__NOTE:__ See the API Reference for available [`Remote` functions](REFERENCE.md#2-remote-functions)
-
-
-##Listening to the network
-
-See the [wiki](https://ripple.com/wiki/JSON_Messages#subscribe) for details on subscription requests.
-
-```js
- /* 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({options});
-
-  remote.connect(function() {
-    var remote = new Remote({
-      // see the API Reference for available options
-      servers: [ 'wss://s1.ripple.com:443' ]
-    });
-
-    remote.connect(function() {
-      console.log('Remote connected');
-
-      var streams = [
-        'ledger',
-        'transactions'
-      ];
-
-      var request = remote.requestSubscribe(streams);
-
-      request.on('error', function(error) {
-        console.log('request error: ', error);
-      });
-
-
-      // the `ledger_closed` and `transaction` will come in on the remote
-      // since the request for subscribe is finalized after the success return
-      // the streaming events will still come in, but not on the initial request
-      remote.on('ledger_closed', function(ledger) {
-        console.log('ledger_closed: ', JSON.stringify(ledger, null, 2));
-      });
-
-      remote.on('transaction', function(transaction) {
-        console.log('transaction: ', JSON.stringify(transaction, null, 2));
-      });
-
-      remote.on('error', function(error) {
-        console.log('remote error: ', error);
-      });
-
-      // fire the request
-      request.request();
-    });
-  });
-```
-* https://ripple.com/wiki/RPC_API#transactions_stream_messages
-* https://ripple.com/wiki/RPC_API#ledger_stream_messages
-
-##Submitting a payment to the network
-
-Submitting a payment transaction to the Ripple network involves connecting to a `Remote`, creating a transaction, signing it with the user's secret, and submitting it to the `rippled` server. Note that the `Amount` module is used to convert human-readable amounts like '1 XRP' or '10.50 USD' to the type of Amount object used by the Ripple network.
-
-```js
-/* Loading ripple-lib Remote and Amount modules in Node.js */
-var Remote = require('ripple-lib').Remote;
-var Amount = require('ripple-lib').Amount;
-
-/* Loading ripple-lib Remote and Amount modules in a webpage */
-// var Remote = ripple.Remote;
-// var Amount = ripple.Amount;
-
-var MY_ADDRESS = 'rrrMyAddress';
-var MY_SECRET  = 'secret';
-var RECIPIENT  = 'rrrRecipient';
-var AMOUNT     = Amount.from_human('1 USD').set_issuer('rrrIssuer');
-
-var remote = new Remote({ /* Remote options */ });
-
-remote.connect(function() {
-  remote.setSecret(MY_ADDRESS, MY_SECRET);
-
-  var transaction = remote.createTransaction('Payment', {
-    account: MY_ADDRESS,
-    destination: RECIPIENT,
-    amount: AMOUNT
-  });
-
-  transaction.submit(function(err, res) {
-    /* handle submission errors / success */
-  });
-});
-```
-
-###A note on transaction fees
-
-A full description of network transaction fees can be found on the [Ripple Wiki](https://ripple.com/wiki/Transaction_Fee).
-
-In short, transaction fees are very small amounts (on the order of ~10) of [XRP drops](https://ripple.com/wiki/Ripple_credits#Notes_on_drops) spent and destroyed with every transaction. They are largely used to account for network load and prevent spam. With `ripple-lib`, transaction fees are calculated locally by default and the fee you are willing to pay is submitted along with your transaction.
-
-Since the fee required for a transaction may change between the time when the original fee was calculated and the time when the transaction is submitted, it is wise to use the [`fee_cushion`](REFERENCE.md#1-remote-options) to ensure that the transaction will go through. For example, suppose the original fee calculated for a transaction was 10 XRP drops but at the instant the transaction is submitted the server is experiencing a higher load and it has raised its minimum fee to 12 XRP drops. Without a `fee_cusion`, this transaction would not be processed by the server, but with a `fee_cusion` of, say, 1.5 it would be processed and you would just pay the 2 extra XRP drops.
-
-The [`max_fee`](REFERENCE.md#1-remote-options) option can be used to avoid submitting a transaction to a server that is charging unreasonably high fees.
-
-
-##Submitting a trade offer to the network
-
-Submitting a trade offer to the network is similar to submitting a payment transaction. Here is an example offering to sell 1 USD in exchange for 100 XRP:
-
-```js
-/* Loading ripple-lib Remote and Amount modules in Node.js */
-var Remote = require('ripple-lib').Remote;
-var Amount = require('ripple-lib').Amount;
-
-/* Loading ripple-lib Remote and Amount modules in a webpage */
-// var Remote = ripple.Remote;
-// var Amount = ripple.Amount;
-
-var MY_ADDRESS = 'rrrMyAddress';
-var MY_SECRET  = 'secret';
-var GATEWAY = 'rrrGateWay';
-
-var remote = new Remote({ /* Remote options */ });
-
-remote.connect(function() {
-  remote.setSecret(MY_ADDRESS, MY_SECRET);
-
-  var transaction = remote.createTransaction('OfferCreate', {
-    account: MY_ADDRESS,
-    taker_pays: '100',
-    taker_gets: '1/USD/' + GATEWAY
-  });
-
-  transaction.submit(function(err, res) {
-    /* handle submission errors / success */
-  });
-});
-```

docs/REFERENCE.md

@@ -1,354 +0,0 @@
-#API Reference
-
-__(More examples coming soon!)__
-
-###In this document:
-
-1. [`Remote` options](REFERENCE.md#remote-options)
-2. [`Request` constructors](REFERENCE.md#request-constructor-functions)
-  + [Server requests](REFERENCE.md#server-requests)
-  + [Ledger requests](REFERENCE.md#ledger-requests)
-  + [Transaction requests](REFERENCE.md#transaction-requests)
-  + [Account requests](REFERENCE.md#account-requests)
-  + [Orderbook requests](REFERENCE.md#orderbook-requests)
-  + [Transaction requests](REFERENCE.md#transaction-requests)
-3. [`Transaction` constructors](REFERENCE.md#transaction-constructors)
-  + [Transaction events](REFERENCE.md#transaction-events)
-
-###Also see:
-
-1. [The ripple-lib README](../README.md)
-2. [The ripple-lib GUIDES](GUIDES.md)a
-
-#Remote options
-
-```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
-
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
-
-var options = { };
-
-var remote = new Remote(options);
-```
-
-A new `Remote` can be created with the following options:
-
-+ `trace` *boolean default: false* Log all of the events emitted
-+ `max_listeners` *number default: 0* Set maxListeners for servers
-+ `trusted` *boolean default: false*, if remote is trusted (boolean)
-+ `local_signing` *boolean default: true*
-+ `local_fee` *boolean default: true* Set whether the transaction fee range will be set locally, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `fee_cushion` *number default: 1.2* Extra fee multiplier to account for async fee changes, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `max_fee` *number default: Infinity* Maximum acceptable transaction fee, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees)
-+ `servers` *array* Array of server objects of the following form:
-
-```js
-{
-  host:    <string>,
-  port:    <number>,
-  secure:  <boolean>
-}
-```
-
-or
-
-```js
- 'wss://host:port'
-```
-
-#Request constructor functions
-
-Some requests have helper methods to construct the requests object and set properties on the message object. These will often be the more used requests and the helper methods is the preferred way of constructing these requests.
-Other request can still be made, but the type will have to be passed in directly to request constructor. See examples below.
-
-If the method is camelCased and starts with `request`, it's a helper method that wraps the request constructor.
-
-##Server requests
-
-**[requestServerInfo([callback])](https://ripple.com/wiki/JSON_Messages#server_info)**
-
-Returns information about the state of the server. If you are connected to multiple servers and want to select by a particular host, use `request.setServer`. Example:
-
-```js
-var request = remote.requestServerInfo();
-
-request.setServer('wss://s1.ripple.com');
-
-request.request(function(err, res) {
-
-});
-```
-**[requestPeers([callback])](https://ripple.com/wiki/JSON_Messages#peers)**
-
-**[requestConnect(ip, port, [callback])](https://ripple.com/wiki/JSON_Messages#connect)**
-
-**[unl_list([callback])](https://ripple.com/wiki/JSON_Messages#unl_list)**
-
-```js
-var request = remote.request('un_list');
-
-request.setServer('wss://s1.ripple.com');
-
-request.request(function(err, res) {
-
-});
-```
-
-**[unl_add(addr, comment, [callback])](https://ripple.com/wiki/JSON_Messages#unl_add)**
-
-**[unl_delete(node, [callback])](https://ripple.com/wiki/JSON_Messages#unl_delete)**
-
-
-
-##Ledger requests
-
-**[requestLedger([opts], [callback])](https://ripple.com/wiki/JSON_Messages#ledger)**
-
-**[requestLedgerHeader([callback])](https://wiki.ripple.com/JSON_Messages#ledger_data)**
-
-**[requestLedgerCurrent([callback])](https://ripple.com/wiki/JSON_Messages#ledger_current)**
-
-**[requestLedgerEntry(type, [callback])](https://ripple.com/wiki/JSON_Messages#ledger_entry)**
-
-**[requestSubscribe([streams], [callback])](https://ripple.com/wiki/JSON_Messages#subscribe)**
-
-Start receiving selected streams from the server.
-
-**[requestUnsubscribe([streams], [callback])](https://ripple.com/wiki/JSON_Messages#unsubscribe)**
-
-Stop receiving selected streams from the server.
-
-##Account requests
-
-**[requestAccountInfo(options, [callback])](https://ripple.com/wiki/JSON_Messages#account_info)**
-
-Return information about the specified account.
-
-```
-var options = {
-  account: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B',
-  ledger: 'validated'
-};
-
-var request = remote.requestAccountInfo(options, function(err, info) {
-  /* process info */
-});
-
-
-// response
-{
-  ledger_current_index: <number>,
-  account_data: {
-    Account:            <string>,
-    Balance:            <number>,
-    Flags:              <number>,
-    LedgerEntryType:    <string>,
-    OwnerCount:         <number>,
-    PreviousTxnID:      <string>,
-    PreviousTxnLgrSeq:  <number>,
-    Sequence:           <number> ,
-    index:              <string>
-  }
-}
-```
-
-**[requestAccountLines(options, [callback])](https://ripple.com/wiki/JSON_Messages#account_lines)**
-
-**[requestAccountOffers(options, [callback])](https://ripple.com/wiki/JSON_Messages#account_offers)**
-
-Return the specified account's outstanding offers.
-
-Requests for both `account_lines` and `account_offers` support paging. The amount of results per response can be configured with the `limit`.
-The responses can be paged through by using the `marker`.
-
-```
-// A valid `ledger_index` or `ledger_hash` is required to provide a reliable result.
-// Results can change between ledger closes, so the provided ledger will be used as base.
-var options = {
-    account: < rippleAccount >,
-    limit: < Number between 10 and 400 >,
-    ledger: < valid ledger_index or ledger_hash >
-}
-
-// The `marker` comes back in an account request if there are more results than are returned 
-// in the current response. The amount of results per response are determined by the `limit`.
-if (marker) {
-    options.marker = < marker >;
-}
-
-var request = remote.requestAccountOffers(options);
-```
-
-
-**[requestAccountTransactions(options, [callback])](https://ripple.com/wiki/JSON_Messages#account_tx)**
-
-Fetch a list of transactions that applied to this account.
-
-Options:
-
-+ `account`
-+ `ledger_index_min`
-+ `ledger_index_max`
-+  `binary` *false*
-+ `count` *false*
-+  `descending` *false*
-+  `offset` *0*
-+  `limit`
-+ `forward` *false*
-+ `fwd_marker`
-+ `rev_marker`
-
-**[requestWalletAccounts(seed, [callback])](https://ripple.com/wiki/JSON_Messages#wallet_accounts)**
-
-Return a list of accounts for a wallet. *Requires trusted remote*
-
-**requestAccountBalance(account, [ledger], [callback])**
-
-Get the balance for an account. Returns an [Amount](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/amount.js) object.
-
-**requestAccountFlags(account, [ledger], [callback])**
-
-Return the flags for an account.
-
-**requestOwnerCount(account, [ledger], [callback])**
-
-Return the owner count for an account.
-
-**requestRippleBalance(account, issuer, currency, [ledger], [callback])**
-
-Return a request to get a ripple balance
-
-##Orderbook requests
-
-**[requestBookOffers(options, [callback])](https://ripple.com/wiki/JSON_Messages#book_offers)**
-
-Return the offers for an order book, also called a *snapshot*
-
-```js
-var options = {
-  gets: {
-    issuer: < issuer >,
-    currency: < currency >
-  },
-  pays: {
-    issuer: < issuer >,
-    currency: < currency >
-  },
-  limit: < limit >
-};
-
-var request = remote.requestBookOffers(options);
-
-request.request(function(err, offers) {
-  //handle offers
-});
-```
-
-##Transaction requests
-
-**[requestTransactionEntry(hash, [ledger_hash], [callback])](https://ripple.com/wiki/JSON_Messages#transaction_entry)**
-
-Searches a particular ledger for a transaction hash. Default ledger is the open ledger.
-
-**[requestTransaction(hash, [callback])](https://ripple.com/wiki/JSON_Messages#tx)**
-
-Searches ledger history for validated transaction hashes.
-
-**[requestSign(secret, tx_json, [callback])](https://ripple.com/wiki/JSON_Messages#sign)**
-
-Sign a transaction. *Requires trusted remote*
-
-**[requestSubmit([callback])](https://ripple.com/wiki/JSON_Messages#submit)**
-
-Submit a transaction to the network. This command is used internally to submit transactions with a greater degree of reliability. See [Submitting a payment to the network](GUIDES.md#3-submitting-a-payment-to-the-network) for details.
-
-**[pathFind(src_account, dst_account, dst_amount, src_currencies)](https://ripple.com/wiki/JSON_Messages#path_find)**
-
-#Transaction constructors
-
-Use `remote.createTransaction('TransactionType', [options])` to construct a transaction. To submit, use `transaction.submit([callback])`.
-
-**Payment**
-
-```js
-var transaction = remote.createTransaction('Payment', {
-  account: MY_ADDRESS,
-  destination: DEST_ADDRESS,
-  amount: AMOUNT
-});
-```
-
-**AccountSet**
-
-```js
-var transaction = remote.createTransaction('AccountSet', {
-  account: MY_ADDRESS,
-  set: 'RequireDest',
-  clear: 'RequireAuth'
-});
-```
-
-**TrustSet**
-
-```js
-var transaction = remote.createTransaction('TrustSet', {
-  account: MY_ADDRESS,
-  limit: '1/USD/rrrrrrrrrrrrrrrrrrrrBZbvji'
-});
-```
-
-**OfferCreate**
-
-```js
-var transaction = remote.createTransaction('OfferCreate', {
-  account: MY_ADDRESS,
-  taker_pays: '1',
-  taker_gets: '1/USD/rrrrrrrrrrrrrrrrrrrrBZbvji'
-});
-```
-
-##Transaction events
-
-[Transaction](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/transaction.js) objects are EventEmitters. They may emit the following events.
-
-+ `final` Transaction has erred or succeeded. This event indicates that the transaction has finished processing.
-+ `error` Transaction has erred. This event is a final state.
-+ `success` Transaction succeeded. This event is a final state.
-+ `presubmit` Immediately before transaction is submitted
-+ `postsubmit` Immediately after transaction is submitted
-+ `submitted` Transaction has been submitted to the network. The submission may result in a remote error or success.
-+ `resubmitted` Transaction is beginning resubmission.
-+ `proposed` Transaction has been submitted *successfully* to the network. The transaction at this point is awaiting validation in a ledger.
-+ `timeout` Transaction submission timed out. The transaction will be resubmitted.
-+ `fee_adjusted` Transaction fee has been adjusted during its pending state. The transaction fee will only be adjusted if the remote is configured for local fees, which it is by default.
-+ `abort` Transaction has been aborted. Transactions are only aborted by manual calls to `#abort`.
-+ `missing` Four ledgers have closed without detecting validated transaction
-+ `lost` Eight ledgers have closed without detecting validated transaction. Consider the transaction lost and err/finalize.
-
-##Complete payment example
-
-```js
-remote.setSecret(MY_ADDRESS, MY_SECRET);
-
-var transaction = remote.createTransaction('Payment', {
-  account: MY_ADDRESS,
-  destination: DEST_ADDRESS,
-  amount: AMOUNT
-});
-
-transaction.on('resubmitted', function() {
-  // initial submission failed, resubmitting
-});
-
-transaction.submit(function(err, res) {
- // submission has finalized with either an error or success.
- // the transaction will not be retried after this point
-});
-```
-
-#Amount objects
-
-Coming Soon

docs/VAULTCLIENT.md

@@ -1,168 +0,0 @@
-ripple-vault-client
-===================
-
-A javascript / http client to interact with Ripple Vault servers.
-
-The purpose of this tool is to enable applications in any javascript
-environment to login with the ripple vault and access the decrypted
-data stored using credentials originally obtained at ripple.com
-     
-        
-## Vault Client Usage
-
-    vaultClient = new ripple.VaultClient(domain);
-    
-    vaultClient.getAuthInfo(username, callback);
-    
-    vaultClient.getRippleName(address, url, callback);
-
-    vaultClient.exists(username, callback);
-    
-        
-
-    vaultClient.login(username, password, callback);
-
-    vaultClient.relogin(id, cryptKey, callback);
-
-    vaultClient.unlock(username, password, encryptSecret, callback);
-
-    vaultClient.loginAndUnlock(username, password, callback);
-    
-    
-    
-    vaultClient.register(options, callback);
-    
-    vaultClient.deleteBlob(options, callback);
-    
-    vaultClient.recoverBlob(options, callback);
-        
-    vaultClient.rename(options, callback);
-    
-    vaultClient.changePassword(options, callback);
-     
-    vaultClient.verify(username, token, callback);
-    
-    vaultClient.resendEmail(options, callback);
-    
-    vaultClient.updateProfile(options, fn);
-    
-
-# Blob Methods
-    
-    blob.encrypt();
-    
-    blob.decrypt(encryptedBlob);
-    
-    blob.encryptSecret(encryptionKey);
-    
-    blob.decryptSecret(encryptionKey, secret);
-    
-    blob.set(pointer, value, callback);
-    
-    blob.unset(pointer, callback);
-    
-    blob.extend(pointer, value, callback);
-    
-    blob.unshift(pointer, value, callback);
-    
-    blob.filter(pointer, field, value, subcommands, callback);
-    
-    
-## Identity Vault
-
-  The identity vault stores identity information inside the encrypted 
-  blob vault.  The identity fields can be additionally encrypted with the 
-  unlock key, that encrypts the secret, for added security. Methods are 
-  accessed from the 'identity' property of the blob object.
-
-
-# Identity fields
-  + name
-  + entityType (individual, corporation, organization)
-  + email
-  + phone
-  + address
-    + contact
-    + line1
-    + line2
-    + city
-    + postalCode
-    + region - state/province/region
-    + country
-  + nationalID
-    + number
-    + type (ssn, taxID, passport, driversLicense, other)
-    + country - issuing country
-  + birthday
-  + birthplace
-  
-  
-# Identity Methods
-
-    blob.identity.set(pointer, key, value, callback);
-    
-    blob.identity.unset(pointer, key, callback);
-    
-    blob.identity.get(pointer, key);
-    
-    blob.identity.getAll(key);
-    
-    blob.identity.getFullAddress(key);  //get text string of full address
-    
-
-## Spec Tests
-
-Run `npm test` to test the high-level behavior specs 
-
-  Ripple Txt
-    ✓ should get the content of a ripple.txt file from a given domain 
-    ✓ should get currencies from a ripple.txt file for a given domain
-    ✓ should get the domain from a given url 
-
-  AuthInfo
-    ✓ should get auth info 
-
-  VaultClient
-    #initialization
-      ✓ should be initialized with a domain 
-      ✓ should default to ripple.com without a domain 
-    #exists
-      ✓ should determine if a username exists on the domain 
-    #login
-      ✓ with username and password should retrive the blob, crypt key, and id
-    #relogin
-      ✓ should retrieve the decrypted blob with blob vault url, id, and crypt key 
-    #unlock
-      ✓ should access the wallet secret using encryption secret, username and password
-    #loginAndUnlock
-      ✓ should get the decrypted blob and decrypted secret given name and password
-    #register
-      ✓ should create a new blob
-    #deleteBlob
-      ✓ should remove an existing blob
-    #updateProfile
-      ✓ should update profile parameters associated with a blob 
-
-  Blob
-    ✓ #set 
-    ✓ #extend 
-    ✓ #unset 
-    ✓ #unshift 
-    ✓ #filter 
-    ✓ #consolidate 
-    #rename
-      ✓ should change the username of a blob
-    #changePassword
-      ✓ should change the password and keys of a blob
-    #recoverBlob
-      ✓ should recover the blob given a username and secret
-    #verifyEmail
-      ✓ should verify an email given a username and token 
-    #resendVerifcationEmail
-      ✓ should resend a verification given options
-    identity
-      ✓ #identity_set 
-      ✓ #identity_get 
-      ✓ #identity_getAll 
-      ✓ #identity_getFullAddress 
-      ✓ #identity_unset 

docs/samples/README

@@ -0,0 +1,3 @@
+Usage:
+babel-node balances.js
+babel-node payment.js (requires setting address and secret in source file first)

docs/samples/balances.js

@@ -0,0 +1,12 @@
+'use strict';
+const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib')
+
+const api = new RippleAPI({servers: ['wss://s1.ripple.com:443']});
+const address = 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV';
+
+api.connect().then(() => {
+  api.getBalances(address).then(balances => {
+    console.log(JSON.stringify(balances, null, 2));
+    process.exit();
+  });
+});

docs/samples/payment.js

@@ -0,0 +1,45 @@
+'use strict';
+const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib')
+
+const address = 'INSERT ADDRESS HERE';
+const secret = 'INSERT SECRET HERE';
+
+const api = new RippleAPI({servers: ['wss://s1.ripple.com:443']});
+const instructions = {maxLedgerVersionOffset: 5};
+
+const payment = {
+  source: {
+    address: address,
+    amount: {
+      value: '0.01',
+      currency: 'XRP'
+    }
+  },
+  destination: {
+    address: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc',
+    amount: {
+      value: '0.01',
+      currency: 'XRP'
+    }
+  }
+};
+
+function quit(message) {
+  console.log(message);
+  process.exit(0);
+}
+
+function fail(message) {
+  console.error(message);
+  process.exit(1);
+}
+
+api.connect().then(() => {
+  console.log('Connected...');
+  return api.preparePayment(address, payment, instructions).then(prepared => {
+    console.log('Payment transaction prepared...');
+    const {signedTransaction} = api.sign(prepared.txJSON, secret);
+    console.log('Payment transaction signed...');
+    api.submit(signedTransaction).then(quit, fail);
+  });
+}).catch(fail);

docs/src/basictypes.md.ejs

@@ -0,0 +1,49 @@
+# Basic Types
+
+## Ripple Address
+
+```json
+"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
+```
+
+Every Ripple account has an *address*, which is a base58-encoding of a hash of the account's public key.
+
+## Account Sequence Number
+
+Every Ripple account has a *sequence number* that is used to order transactions. Every transaction must have a sequence number and transaction can only be executed in order by sequence number. This prevents one transaction from executing twice and transactions executing out of order. The sequence number starts at `1` and increments for each transaction that the account makes.
+
+## Currency
+
+Currencies are represented as either 3-character currency codes or 40-character uppercase hexadecimal strings. We recommend using uppercase [ISO 4217 Currency Codes](http://www.xe.com/iso4217.php) only. The string "XRP" is disallowed on trustlines because it is reserved for the Ripple native currency. The following characters are permitted: all uppercase and lowercase letters, digits, as well as the symbols `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `<`, `>`, `(`, `)`, `{`, `}`, `[`, `]`, and `|`.
+
+## Value
+A *value* is a quantity of a currency represented as a decimal string (string encoding is used because javascript numbers do not have sufficient precision).
+
+An XRP value has 6 significant digits past the decimal point. A non-XRP value has 16 total digits of precision.
+
+## Amount
+
+```json
+{
+  "currency": "USD",
+  "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
+  "value": "100"
+}
+```
+
+```json
+{
+  "currency": "XRP",
+  "value": "2000"
+}
+```
+
+An *amount* is data structure representing a currency, a quantity of that currency, and the counterparty on the trustline that holds the value (for all currencies besides "XRP").
+
+A *lax amount* allows the counterparty to be omitted for all currencies. If the counterparty is not specified in an amount within a transaction specification, then any counterparty may be used for that amount.
+
+A *lax lax amount* allows either or both the counterparty and value to be omitted.
+
+A *balance* is an amount than can have a negative value.
+
+<%- renderSchema('objects/amount-base.json') %>

docs/src/boilerplate.md.ejs

@@ -0,0 +1,34 @@
+## Boilerplate
+
+```javascript
+const {RippleAPI} = require('ripple-lib');
+
+const api = new RippleAPI({
+  servers: ['wss://s1.ripple.com']
+});
+api.connect().then(() => {
+  /* insert code here */
+}).then(() => {
+  return api.disconnect();
+}).catch(console.error);
+```
+
+To get started, first install [nodejs](https://nodejs.org) version `0.12.0` or greater, then:
+
+`npm install -g babel`
+
+`npm install ripple-lib`
+
+Then create a script based on the boilerplate shown here and run with:
+
+`babel-node script.js`
+
+The code samples in this documentation are written in ES6, but `RippleAPI` will work with ES5 also. Regardless of whether you use ES5 or ES6, the methods that return promises will return ES6-style promises.
+
+<aside class="notice">
+All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
+</aside>
+
+<aside class="notice">
+Dont forget the "catch" or errors may not be visible.
+</aside>

docs/src/computeLedgerHash.md.ejs

@@ -0,0 +1,28 @@
+## computeLedgerHash
+
+`computeLedgerHash(ledger: Object): string`
+
+Compute the hash of a ledger.
+
+### Parameters
+
+<aside class="notice">
+The parameter to this method has the same structure as the return value of getLedger.
+</aside>
+
+<%- renderSchema('input/compute-ledger-hash.json') %>
+
+### Return Value
+
+This method returns an uppercase hexadecimal string representing the hash of the ledger.
+
+### Example
+
+```javascript
+const ledger = <%- importFile('test/fixtures/requests/compute-ledger-hash.json') %>;
+return api.computeLedgerHash(ledger);
+```
+
+```json
+"F4D865D83EB88C1A1911B9E90641919A1314F36E1B099F8E95FE3B7C77BE3349"
+```

docs/src/connect.md.ejs

@@ -0,0 +1,17 @@
+## connect
+
+`connect(): Promise<void>`
+
+Tells the RippleAPI instance to connect to its server(s).
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns a promise that resolves with a void value when a connection is established.
+
+### Example
+
+See [Boilerplate](#boilerplate) for code sample.

docs/src/disconnect.md.ejs

@@ -0,0 +1,17 @@
+## disconnect
+
+`disconnect(): Promise<void>`
+
+Tells the RippleAPI instance to disconnect from its server(s).
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns a promise that resolves with a void value when a connection is destroyed.
+
+### Example
+
+See [Boilerplate](#boilerplate) for code sample

docs/src/events.md.ejs

@@ -0,0 +1,39 @@
+# API Events
+
+## ledgerClosed
+
+This event is emitted whenever a new ledger version is validated on the connected server.
+
+### Return Value
+
+<%- renderSchema('output/ledger-closed.json') %>
+
+### Example
+
+```javascript
+api.on('ledgerClosed', ledger => {
+  console.log(JSON.stringify(ledger, null, 2));
+});
+```
+
+<%- renderFixture('responses/ledger-closed.json') %>
+
+## error
+
+This event is emitted when there is an error on the connection to the server.
+
+### Return Value
+
+The first parameter is a string indicating the error type, which may be `badMessage` (meaning that rippled returned a malformed message), or one of the [rippled Universal Errors](https://ripple.com/build/rippled-apis/#universal-errors). The second parameter is a message explaining the error, or the message that caused the error in the case of `badMessage`.
+
+### Example
+
+```javascript
+api.on('error', (errorCode, errorMessage) => {
+  console.log(errorCode + ': ' + errorMessage);
+});
+```
+
+```
+tooBusy: The server is too busy to help you now.
+```

docs/src/generateAddress.md.ejs

@@ -0,0 +1,24 @@
+## generateAddress
+
+`generateAddress(): {address: string, secret: string}`
+
+Generate a new Ripple address and corresponding secret.
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns an object with the following structure:
+
+<%- renderSchema('output/generate-address.json') %>
+
+### Example
+
+```javascript
+return api.generateAddress()
+  .then(result => {/* ... */});
+```
+
+<%- renderFixture('responses/generate-address.json') %>

docs/src/getAccountInfo.md.ejs

@@ -0,0 +1,25 @@
+## getAccountInfo
+
+`getAccountInfo(address: string, options: Object): Promise<Object>`
+
+Returns information for the specified account. Note: For account data that is modifiable by the user, see [getSettings](#getsettings).
+
+### Parameters
+
+<%- renderSchema('input/get-account-info.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<%- renderSchema('output/get-account-info.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getAccountInfo(address).then(info =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/get-account-info.json') %>

docs/src/getBalanceSheet.md.ejs

@@ -0,0 +1,25 @@
+## getBalanceSheet
+
+`getBalanceSheet(address: string, options: Object): Promise<Object>`
+
+Returns aggregate balances by currency plus a breakdown of assets and obligations for a specified account.
+
+### Parameters
+
+<%- renderSchema('input/get-balance-sheet.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of objects with the following structure:
+
+<%- renderSchema('output/get-balance-sheet.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getBalanceSheet(address).then(balanceSheet =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/get-balance-sheet.json') %>

docs/src/getBalances.md.ejs

@@ -0,0 +1,25 @@
+## getBalances
+
+`getBalances(address: string, options: Object): Promise<Array<Object>>`
+
+Returns balances for a specified account.
+
+### Parameters
+
+<%- renderSchema('input/get-balances.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of objects with the following structure:
+
+<%- renderSchema('output/get-balances.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getBalances(address).then(balances =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/get-balances.json') %>

docs/src/getFee.md.ejs

@@ -0,0 +1,23 @@
+## getFee
+
+`getFee(): Promise<number>`
+
+Returns the estimated transaction fee for the server(s) the RippleAPI instance is connected to.
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns a promise that resolves with a floating point value representing the estimated fee to submit a transaction, expressed in XRP.
+
+### Example
+
+```javascript
+return api.getFee().then(fee => {/* ... */});
+```
+
+```json
+0.012
+```

docs/src/getLedger.md.ejs

@@ -0,0 +1,24 @@
+## getLedger
+
+`getLedger(options: Object): Promise<Object>`
+
+Returns header information for the specified ledger (or the most recent validated ledger if no ledger is specified). Optionally, all the transactions that were validated in the ledger or the account state information can be returned with the ledger header.
+
+### Parameters
+
+<%- renderSchema('input/get-ledger.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<%- renderSchema('output/get-ledger.json') %>
+
+### Example
+
+```javascript
+return api.getLedger()
+  .then(ledger => {/* ... */});
+```
+
+<%- renderFixture('responses/get-ledger.json') %>

docs/src/getLedgerVersion.md.ejs

@@ -0,0 +1,26 @@
+## getLedgerVersion
+
+`getLedgerVersion(): Promise<number>`
+
+Returns the most recent validated ledger version number known to the connected server.
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns a promise that resolves with a positive integer representing the most recent validated ledger version number known to the connected server.
+
+### Example
+
+```javascript
+return api.getLedgerVersion().then(ledgerVersion => {
+  /* ... */
+});
+```
+
+```json
+16869039
+```
+

docs/src/getOrderbook.md.ejs

@@ -0,0 +1,26 @@
+## getOrderbook
+
+`getOrderbook(address: string, orderbook: Object, options: Object): Promise<Object>`
+
+Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book.
+
+### Parameters
+
+<%- renderSchema('input/get-orderbook.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure (Note: the structures of `bids` and `asks` are identical):
+
+<%- renderSchema('output/get-orderbook.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const orderbook = <%- importFile('test/fixtures/requests/get-orderbook.json') %>;
+return api.getOrderbook(address, orderbook)
+  .then(orderbook => {/* ... */});
+```
+
+<%- renderFixture('responses/get-orderbook.json') %>

docs/src/getOrders.md.ejs

@@ -0,0 +1,25 @@
+## getOrders
+
+`getOrders(address: string, options: Object): Promise<Array<Object>>`
+
+Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book.
+
+### Parameters
+
+<%- renderSchema('input/get-orders.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of objects with the following structure:
+
+<%- renderSchema('output/get-orders.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getOrders(address).then(orders =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/get-orders.json') %>

docs/src/getPaths.md.ejs

@@ -0,0 +1,25 @@
+## getPaths
+
+`getPaths(pathfind: Object): Promise<Array<Object>>`
+
+Finds paths to send a payment. Paths are options for how to route a payment.
+
+### Parameters
+
+<%- renderSchema("input/get-paths.json") %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of objects with the following structure:
+
+<%- renderSchema("output/get-paths.json") %>
+
+### Example
+
+```javascript
+const pathfind = <%- importFile('test/fixtures/requests/getpaths/normal.json') %>;
+return api.getPaths(pathfind)
+  .then(paths => {/* ... */});
+```
+
+<%- renderFixture("responses/get-paths.json") %>

docs/src/getServerInfo.md.ejs

@@ -0,0 +1,23 @@
+## getServerInfo
+
+`getServerInfo(): Promise<object>`
+
+Get status information about the server that the RippleAPI instance is connected to.
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<%- renderSchema('output/get-server-info.json') %>
+
+### Example
+
+```javascript
+return api.getServerInfo().then(info => {/* ... */});
+```
+
+<%- renderFixture('responses/get-server-info.json') %>

docs/src/getSettings.md.ejs

@@ -0,0 +1,25 @@
+## getSettings
+
+`getSettings(address: string, options: Object): Promise<Object>`
+
+Returns settings for the specified account. Note: For account data that is not modifiable by the user, see [getAccountInfo](#getaccountinfo).
+
+### Parameters
+
+<%- renderSchema('input/get-settings.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of objects with the following structure (Note: all fields are optional as they will not be shown if they are set to their default value):
+
+<%- renderSchema('output/get-settings.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getSettings(address).then(settings =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/get-settings.json') %>

docs/src/getTransaction.md.ejs

@@ -0,0 +1,26 @@
+## getTransaction
+
+`getTransaction(id: string, options: Object): Promise<Object>`
+
+Retrieves a transaction by its [Transaction ID](#transaction-id).
+
+### Parameters
+
+<%- renderSchema('input/get-transaction.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with a transaction object containing the following fields.
+
+<%- renderSchema('output/get-transaction.json') %>
+
+### Example
+
+```javascript
+const id = '01CDEAA89BF99D97DFD47F79A0477E1DCC0989D39F70E8AACBFE68CC83BD1E94';
+return api.getTransaction(id).then(transaction => {
+  /* ... */
+});
+```
+
+<%- renderFixture('responses/get-transaction-payment.json') %>

docs/src/getTransactions.md.ejs

@@ -0,0 +1,24 @@
+## getTransactions
+
+`getTransactions(address: string, options: Object): Promise<Array<Object>>`
+
+Retrieves historical transactions of an account.
+
+### Parameters
+
+<%- renderSchema('input/get-transactions.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of transaction object in the same format as [getTransaction](#gettransaction).
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getTransactions(address).then(transaction => {
+  /* ... */
+});
+```
+
+<%- renderFixture('responses/get-transactions.json') %>

docs/src/getTrustlines.md.ejs

@@ -0,0 +1,25 @@
+## getTrustlines
+
+`getTrustlines(address: string, options: Object): Promise<Array<Object>>`
+
+Returns trustlines for a specified account.
+
+### Parameters
+
+<%- renderSchema("input/get-trustlines.json") %>
+
+### Return Value
+
+This method returns a promise that resolves with an array of objects with the following structure.
+
+<%- renderSchema("output/get-trustlines.json") %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+return api.getTrustlines(address).then(trustlines =>
+  {/* ... */});
+```
+
+<%- renderFixture("responses/get-trustlines.json") %>

docs/src/index.md.ejs

@@ -0,0 +1,36 @@
+<% include introduction.md.ejs %>
+<% include boilerplate.md.ejs %>
+<% include basictypes.md.ejs %>
+<% include transactions.md.ejs %>
+<% include specifications.md.ejs %>
+<% include methods.md.ejs %>
+<% include connect.md.ejs %>
+<% include disconnect.md.ejs %>
+<% include isConnected.md.ejs %>
+<% include getServerInfo.md.ejs %>
+<% include getFee.md.ejs %>
+<% include getLedgerVersion.md.ejs %>
+<% include getTransaction.md.ejs %>
+<% include getTransactions.md.ejs %>
+<% include getTrustlines.md.ejs %>
+<% include getBalances.md.ejs %>
+<% include getBalanceSheet.md.ejs %>
+<% include getPaths.md.ejs %>
+<% include getOrders.md.ejs %>
+<% include getOrderbook.md.ejs %>
+<% include getSettings.md.ejs %>
+<% include getAccountInfo.md.ejs %>
+<% include getLedger.md.ejs %>
+<% include preparePayment.md.ejs %>
+<% include prepareTrustline.md.ejs %>
+<% include prepareOrder.md.ejs %>
+<% include prepareOrderCancellation.md.ejs %>
+<% include prepareSettings.md.ejs %>
+<% include prepareSuspendedPaymentCreation.md.ejs %>
+<% include prepareSuspendedPaymentCancellation.md.ejs %>
+<% include prepareSuspendedPaymentExecution.md.ejs %>
+<% include sign.md.ejs %>
+<% include submit.md.ejs %>
+<% include generateAddress.md.ejs %>
+<% include computeLedgerHash.md.ejs %>
+<% include events.md.ejs %>

docs/src/introduction.md.ejs

@@ -0,0 +1,5 @@
+# Introduction
+
+RippleAPI allows you to query and submit transactions to a node on the Ripple network.
+
+RippleAPI only provides access to *validated*, *immutable* transaction data.

docs/src/isConnected.md.ejs

@@ -0,0 +1,23 @@
+## isConnected
+
+`isConnected(): boolean`
+
+Checks if the RippleAPI instance is connected to its server(s).
+
+### Parameters
+
+This method has no parameters.
+
+### Return Value
+
+This method returns `true` if connected and `false` if not connected.
+
+### Example
+
+```javascript
+return api.isConnected();
+```
+
+```json
+true
+```

docs/src/methods.md.ejs

@@ -0,0 +1 @@
+# API Methods

docs/src/prepareOrder.md.ejs

@@ -0,0 +1,30 @@
+## prepareOrder
+
+`prepareOrder(address: string, order: Object, instructions: Object): Promise<Object>`
+
+Prepare an order transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema('input/prepare-order.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare" methods have the same return type.
+</aside>
+
+<%- renderSchema('output/prepare.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const order = <%- importFile('test/fixtures/requests/prepare-order.json') %>;
+return api.prepareOrder(address, order)
+  .then(prepared => {/* ... */});
+```
+
+<%- renderFixture('responses/prepare-order.json') %>

docs/src/prepareOrderCancellation.md.ejs

@@ -0,0 +1,30 @@
+## prepareOrderCancellation
+
+`prepareOrderCancellation(address: string, sequence: number, instructions: Object): Promise<Object>`
+
+Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema("input/prepare-order-cancellation.json") %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare" methods have the same return type.
+</aside>
+
+<%- renderSchema("output/prepare.json") %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const sequence = 123;
+return api.prepareOrderCancellation(address, sequence)
+  .then(prepared => {/* ... */});
+```
+
+<%- renderFixture("responses/prepare-order-cancellation.json") %>

docs/src/preparePayment.md.ejs

@@ -0,0 +1,30 @@
+## preparePayment
+
+`preparePayment(address: string, payment: Object, instructions: Object): Promise<Object>`
+
+Prepare a payment transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema("input/prepare-payment.json") %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare*" methods have the same return type.
+</aside>
+
+<%- renderSchema("output/prepare.json") %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const payment = <%- importFile('test/fixtures/requests/prepare-payment.json') %>;
+return api.preparePayment(address, payment).then(prepared =>
+  {/* ... */});
+```
+
+<%- renderFixture("responses/prepare-payment.json") %>

docs/src/prepareSettings.md.ejs

@@ -0,0 +1,30 @@
+## prepareSettings
+
+`prepareSettings(address: string, settings: Object, instructions: Object): Promise<Object>`
+
+Prepare a settings transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema('input/prepare-settings.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare*" methods have the same return type.
+</aside>
+
+<%- renderSchema('output/prepare.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const settings = <%- importFile('test/fixtures/requests/prepare-settings.json') %>;
+return api.prepareSettings(address, settings)
+  .then(prepared => {/* ... */});
+```
+
+<%- renderFixture('requests/prepare-settings.json') %>

docs/src/prepareSuspendedPaymentCancellation.md.ejs

@@ -0,0 +1,30 @@
+## prepareSuspendedPaymentCancellation
+
+`prepareSuspendedPaymentCancellation(address: string, suspendedPaymentCancellation: Object, instructions: Object): Promise<Object>`
+
+Prepare a suspended payment cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema('input/prepare-suspended-payment-cancellation.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare*" methods have the same return type.
+</aside>
+
+<%- renderSchema('output/prepare.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const suspendedPaymentCancellation = <%- importFile('test/fixtures/requests/prepare-suspended-payment-cancellation.json') %>;
+return api.prepareSuspendedPaymentCancellation(address, suspendedPaymentCancellation).then(prepared =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/prepare-suspended-payment-cancellation.json') %>

docs/src/prepareSuspendedPaymentCreation.md.ejs

@@ -0,0 +1,30 @@
+## prepareSuspendedPaymentCreation
+
+`prepareSuspendedPaymentCreation(address: string, suspendedPaymentCreation: Object, instructions: Object): Promise<Object>`
+
+Prepare a suspended payment creation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema('input/prepare-suspended-payment-creation.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare*" methods have the same return type.
+</aside>
+
+<%- renderSchema('output/prepare.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const suspendedPaymentCreation = <%- importFile('test/fixtures/requests/prepare-suspended-payment-creation.json') %>;
+return api.prepareSuspendedPaymentCreation(address, suspendedPaymentCreation).then(prepared =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/prepare-suspended-payment-creation.json') %>

docs/src/prepareSuspendedPaymentExecution.md.ejs

@@ -0,0 +1,30 @@
+## prepareSuspendedPaymentExecution
+
+`prepareSuspendedPaymentExecution(address: string, suspendedPaymentExecution: Object, instructions: Object): Promise<Object>`
+
+Prepare a suspended payment execution transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema('input/prepare-suspended-payment-execution.json') %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare*" methods have the same return type.
+</aside>
+
+<%- renderSchema('output/prepare.json') %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const suspendedPaymentExecution = <%- importFile('test/fixtures/requests/prepare-suspended-payment-execution.json') %>;
+return api.prepareSuspendedPaymentExecution(address, suspendedPaymentExecution).then(prepared =>
+  {/* ... */});
+```
+
+<%- renderFixture('responses/prepare-suspended-payment-execution.json') %>

docs/src/prepareTrustline.md.ejs

@@ -0,0 +1,30 @@
+## prepareTrustline
+
+`prepareTrustline(address: string, trustline: Object, instructions: Object): Promise<Object>`
+
+Prepare a trustline transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema("input/prepare-trustline.json") %>
+
+### Return Value
+
+This method returns a promise that resolves with an object with the following structure:
+
+<aside class="notice">
+All "prepare*" methods have the same return type.
+</aside>
+
+<%- renderSchema("output/prepare.json") %>
+
+### Example
+
+```javascript
+const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
+const trustline = <%- importFile('test/fixtures/requests/prepare-trustline.json') %>;
+return api.preparePayment(address, trustline).then(prepared =>
+  {/* ... */});
+```
+
+<%- renderFixture("responses/prepare-trustline.json") %>

docs/src/sign.md.ejs

@@ -0,0 +1,25 @@
+## sign
+
+`sign(txJSON: string, secret: string): {signedTransaction: string, id: string}`
+
+Sign a prepared transaction. The signed transaction must subsequently be [submitted](#submit).
+
+### Parameters
+
+<%- renderSchema("input/sign.json") %>
+
+### Return Value
+
+This method returns an object with the following structure:
+
+<%- renderSchema("output/sign.json") %>
+
+### Example
+
+```javascript
+const txJSON = '{"Flags":2147483648,"TransactionType":"AccountSet","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Domain":"726970706C652E636F6D","LastLedgerSequence":8820051,"Fee":"12","Sequence":23}';
+const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV';
+return api.sign(txJSON, secret);
+```
+
+<%- renderFixture("responses/sign.json") %>

docs/src/specifications.md.ejs

@@ -0,0 +1,83 @@
+# Transaction Specifications
+
+A *transaction specification* specifies what a transaction should do. Each [Transaction Type](#transaction-types) has its own type of specification.
+
+## Payment
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/payment.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-payment.json') %>
+
+## Trustline
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/trustline.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-trustline.json') %>
+
+## Order
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/order.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-order.json') %>
+
+## Order Cancellation
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/order-cancellation.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-order-cancellation.json') %>
+
+## Settings
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('output/get-settings.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-settings.json') %>
+
+## Suspended Payment Creation
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/suspended-payment-creation.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-suspended-payment-creation.json') %>
+
+## Suspended Payment Cancellation
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/suspended-payment-cancellation.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-suspended-payment-cancellation.json') %>
+
+## Suspended Payment Execution
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/suspended-payment-execution.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-suspended-payment-execution.json') %>

docs/src/submit.md.ejs

@@ -0,0 +1,25 @@
+## submit
+
+`submit(signedTransaction: string): Promise<Object>`
+
+Submits a signed transaction. The transaction is not guaranteed to succeed; it must be verified with [getTransaction](#gettransaction).
+
+### Parameters
+
+<%- renderSchema('input/submit.json') %>
+
+### Return Value
+
+This method returns an object with the following structure:
+
+<%- renderSchema('output/submit.json') %>
+
+### Example
+
+```javascript
+const signedTransaction = '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100BDE09A1F6670403F341C21A77CF35BA47E45CDE974096E1AA5FC39811D8269E702203D60291B9A27F1DCABA9CF5DED307B4F23223E0B6F156991DB601DFB9C41CE1C770A726970706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304';
+return api.submit(signedTransaction)
+  .then(result => {/* ... */});
+```
+
+<%- renderFixture('responses/submit.json') %>

docs/src/transactions.md.ejs

@@ -0,0 +1,45 @@
+# Transaction Overview
+
+## Transaction Types
+
+A transaction type is specified by the strings in the first column in the table below.
+
+Type | Description
+---- | -----------
+[payment](#payment) | A `payment` transaction represents a transfer of value from one account to another. Depending on the path taken, additional exchanges of value may occur atomically to facilitate the payment.
+[order](#order) | An `order` transaction creates a limit order. It defines an intent to exchange currencies, and creates an order in the Ripple Consensus Ledger's order book if not completely fulfilled when placed. Orders can be partially fulfilled.
+[orderCancellation](#order-cancellation) | An `orderCancellation` transaction cancels an order in the Ripple Consensus Ledger's order book.
+[trustline](#trustline) | A `trustline` transactions creates or modifies a trust line between two accounts.
+[settings](#settings) | A `settings` transaction modifies the settings of an account in the Ripple Consensus Ledger.
+[suspendedPaymentCreation](#suspended-payment-creation) | A `suspendedPaymentCreation` transaction creates a suspended payment on the ledger, which locks XRP until a cryptographic condition is met or it expires. It is like an escrow service where the Ripple network acts as the escrow agent.
+[suspendedPaymentCancellation](#suspended-payment-cancellation) | A `suspendedPaymentCancellation` transaction unlocks the funds in a suspended payment and sends them back to the creator of the suspended payment, but it will only work after the suspended payment expires.
+[suspendedPaymentExecution](#suspended-payment-execution) | A `suspendedPaymentExecution` transaction unlocks the funds in a suspended payment and sends them to the destination of the suspended payment, but it will only work if the cryptographic condition is provided.
+
+## Transaction Flow
+
+Executing a transaction with `RippleAPI` requires the following four steps:
+
+1. prepare - Create an unsigned transaction based on a [specification](#transaction-specifications) and [instructions](#transaction-instructions).
+2. sign - Cryptographically sign the transaction locally and save the [transaction ID](#transaction-id). Signing is how the owner of an account authorizes a transaction to take place.
+3. submit - Submit the transaction to the connected server.
+4. verify - Verify that the transaction got validated by querying with [getTransaction](#gettransaction). This is necessary because transactions may fail even if they were successfully submitted. It is recommended that you specify a `maxLedgerVersion` in the instructions when preparing a transaction because without it there is no way to know that a failed transaction will never succeeed in the future. It is impossible for a transaction to succeed after the network ledger version exceeds the `maxLedgerVersion` provided in the transaction instructions.
+
+## Transaction Fees
+
+Every transaction requires a *fee* to be paid in XRP. The fee is destroyed; it is not sent to any other party. The purpose of the fee is to prevent denial of service attacks on the Ripple network.
+
+You can choose the size of the fee you want to pay or let a default be used. The fee is like a bid in an auction for slots in the next ledger closing. If the fee you choose is too low, your transaction will not be included in the next ledger closing. You can get an estimate of the fee required to be included in the next ledger closing with the [getFee](#getfee) method.
+
+## Transaction Instructions
+
+Transactions instructions indicates how to execute a transaction, complementary with the [transaction specification](#transaction-specifications).
+
+<%- renderSchema("objects/instructions.json") %>
+
+## Transaction ID
+
+```json
+"F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF"
+```
+
+A hash of the transaction that can be used to identify it. A transaction can be looked up by its ID using the [getTransaction](#gettransaction) method.

npm-shrinkwrap.json

@@ -1,161 +1,301 @@
 {
   "name": "ripple-lib",
-  "version": "0.13.0-rc1",
-  "npm-shrinkwrap-version": "5.4.0",
-  "node-version": "v0.12.6",
+  "version": "0.13.1",
   "dependencies": {
-    "async": {
-      "version": "0.9.2",
-      "resolved": "https://registry.npmjs.org/async/-/async-0.9.2.tgz"
+    "ajv": {
+      "version": "1.4.8",
+      "from": "https://registry.npmjs.org/ajv/-/ajv-1.4.8.tgz",
+      "resolved": "https://registry.npmjs.org/ajv/-/ajv-1.4.8.tgz",
+      "dependencies": {
+        "json-stable-stringify": {
+          "version": "1.0.0",
+          "from": "https://registry.npmjs.org/json-stable-stringify/-/json-stable-stringify-1.0.0.tgz",
+          "resolved": "https://registry.npmjs.org/json-stable-stringify/-/json-stable-stringify-1.0.0.tgz",
+          "dependencies": {
+            "jsonify": {
+              "version": "0.0.0",
+              "from": "https://registry.npmjs.org/jsonify/-/jsonify-0.0.0.tgz",
+              "resolved": "https://registry.npmjs.org/jsonify/-/jsonify-0.0.0.tgz"
+            }
+          }
+        }
+      }
     },
-    "babel-runtime": {
-      "version": "5.8.3",
-      "resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-5.8.3.tgz",
+    "babel-polyfill": {
+      "version": "6.2.0",
+      "from": "babel-polyfill@*",
+      "resolved": "https://registry.npmjs.org/babel-polyfill/-/babel-polyfill-6.2.0.tgz",
       "dependencies": {
         "core-js": {
-          "version": "0.9.18",
-          "resolved": "https://registry.npmjs.org/core-js/-/core-js-0.9.18.tgz"
+          "version": "1.2.6",
+          "from": "core-js@>=1.0.1 <2.0.0",
+          "resolved": "https://registry.npmjs.org/core-js/-/core-js-1.2.6.tgz"
+        },
+        "babel-regenerator-runtime": {
+          "version": "6.2.0",
+          "from": "babel-regenerator-runtime@>=6.2.0 <7.0.0",
+          "resolved": "https://registry.npmjs.org/babel-regenerator-runtime/-/babel-regenerator-runtime-6.2.0.tgz"
+        }
+      }
+    },
+    "babel-runtime": {
+      "version": "5.8.29",
+      "from": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-5.8.29.tgz",
+      "resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-5.8.29.tgz",
+      "dependencies": {
+        "core-js": {
+          "version": "1.2.3",
+          "from": "https://registry.npmjs.org/core-js/-/core-js-1.2.3.tgz",
+          "resolved": "https://registry.npmjs.org/core-js/-/core-js-1.2.3.tgz"
         }
       }
     },
     "bignumber.js": {
-      "version": "2.0.7",
-      "resolved": "https://registry.npmjs.org/bignumber.js/-/bignumber.js-2.0.7.tgz"
-    },
-    "extend": {
-      "version": "1.2.1",
-      "resolved": "https://registry.npmjs.org/extend/-/extend-1.2.1.tgz"
+      "version": "2.1.0",
+      "from": "bignumber.js@>=2.0.3 <3.0.0",
+      "resolved": "https://registry.npmjs.org/bignumber.js/-/bignumber.js-2.1.0.tgz"
     },
     "https-proxy-agent": {
       "version": "1.0.0",
+      "from": "https-proxy-agent@>=1.0.0 <2.0.0",
       "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-1.0.0.tgz",
       "dependencies": {
         "agent-base": {
-          "version": "2.0.0",
-          "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-2.0.0.tgz",
+          "version": "2.0.1",
+          "from": "agent-base@>=2.0.0 <3.0.0",
+          "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-2.0.1.tgz",
           "dependencies": {
             "semver": {
-              "version": "4.3.6",
-              "resolved": "https://registry.npmjs.org/semver/-/semver-4.3.6.tgz"
+              "version": "5.0.3",
+              "from": "semver@>=5.0.1 <5.1.0",
+              "resolved": "https://registry.npmjs.org/semver/-/semver-5.0.3.tgz"
             }
           }
         },
         "debug": {
           "version": "2.2.0",
+          "from": "debug@>=2.0.0 <3.0.0",
           "resolved": "https://registry.npmjs.org/debug/-/debug-2.2.0.tgz",
           "dependencies": {
             "ms": {
               "version": "0.7.1",
+              "from": "ms@0.7.1",
               "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.1.tgz"
             }
           }
         },
         "extend": {
           "version": "3.0.0",
+          "from": "extend@>=3.0.0 <4.0.0",
           "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.0.tgz"
         }
       }
     },
-    "is-my-json-valid": {
-      "version": "2.12.0",
-      "resolved": "https://registry.npmjs.org/is-my-json-valid/-/is-my-json-valid-2.12.0.tgz",
+    "lodash": {
+      "version": "3.10.1",
+      "from": "lodash@>=3.1.0 <4.0.0",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz"
+    },
+    "ripple-address-codec": {
+      "version": "2.0.1",
+      "from": "ripple-address-codec@>=2.0.1 <3.0.0",
+      "resolved": "https://registry.npmjs.org/ripple-address-codec/-/ripple-address-codec-2.0.1.tgz",
       "dependencies": {
-        "generate-function": {
-          "version": "2.0.0",
-          "resolved": "https://registry.npmjs.org/generate-function/-/generate-function-2.0.0.tgz"
-        },
-        "generate-object-property": {
-          "version": "1.2.0",
-          "resolved": "https://registry.npmjs.org/generate-object-property/-/generate-object-property-1.2.0.tgz",
+        "hash.js": {
+          "version": "1.0.3",
+          "from": "hash.js@>=1.0.3 <2.0.0",
+          "resolved": "https://registry.npmjs.org/hash.js/-/hash.js-1.0.3.tgz",
           "dependencies": {
-            "is-property": {
-              "version": "1.0.2",
-              "resolved": "https://registry.npmjs.org/is-property/-/is-property-1.0.2.tgz"
+            "inherits": {
+              "version": "2.0.1",
+              "from": "inherits@>=2.0.1 <3.0.0",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
             }
           }
         },
-        "jsonpointer": {
-          "version": "1.1.0",
-          "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-1.1.0.tgz"
-        },
-        "xtend": {
-          "version": "4.0.0",
-          "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.0.tgz"
+        "x-address-codec": {
+          "version": "0.7.2",
+          "from": "x-address-codec@>=0.7.0 <0.8.0",
+          "resolved": "https://registry.npmjs.org/x-address-codec/-/x-address-codec-0.7.2.tgz",
+          "dependencies": {
+            "base-x": {
+              "version": "1.0.1",
+              "from": "base-x@>=1.0.1 <2.0.0",
+              "resolved": "https://registry.npmjs.org/base-x/-/base-x-1.0.1.tgz"
+            }
+          }
         }
       }
     },
-    "lodash": {
-      "version": "3.10.0",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-3.10.0.tgz"
+    "ripple-binary-codec": {
+      "version": "0.1.0",
+      "from": "ripple-binary-codec@0.1.0",
+      "resolved": "https://registry.npmjs.org/ripple-binary-codec/-/ripple-binary-codec-0.1.0.tgz",
+      "dependencies": {
+        "bn.js": {
+          "version": "3.3.0",
+          "from": "bn.js@>=3.2.0 <4.0.0",
+          "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-3.3.0.tgz"
+        },
+        "create-hash": {
+          "version": "1.1.2",
+          "from": "create-hash@>=1.1.2 <2.0.0",
+          "resolved": "https://registry.npmjs.org/create-hash/-/create-hash-1.1.2.tgz",
+          "dependencies": {
+            "cipher-base": {
+              "version": "1.0.2",
+              "from": "cipher-base@>=1.0.1 <2.0.0",
+              "resolved": "https://registry.npmjs.org/cipher-base/-/cipher-base-1.0.2.tgz"
+            },
+            "ripemd160": {
+              "version": "1.0.1",
+              "from": "ripemd160@>=1.0.0 <2.0.0",
+              "resolved": "https://registry.npmjs.org/ripemd160/-/ripemd160-1.0.1.tgz"
+            },
+            "sha.js": {
+              "version": "2.4.4",
+              "from": "sha.js@>=2.3.6 <3.0.0",
+              "resolved": "https://registry.npmjs.org/sha.js/-/sha.js-2.4.4.tgz"
+            }
+          }
+        },
+        "decimal.js": {
+          "version": "4.0.3",
+          "from": "decimal.js@>=4.0.2 <5.0.0",
+          "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-4.0.3.tgz"
+        },
+        "inherits": {
+          "version": "2.0.1",
+          "from": "inherits@>=2.0.1 <3.0.0",
+          "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+        }
+      }
     },
-    "lru-cache": {
-      "version": "2.5.2",
-      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-2.5.2.tgz"
+    "ripple-hashes": {
+      "version": "0.1.0",
+      "from": "ripple-hashes@0.1.0",
+      "resolved": "https://registry.npmjs.org/ripple-hashes/-/ripple-hashes-0.1.0.tgz",
+      "dependencies": {
+        "create-hash": {
+          "version": "1.1.2",
+          "from": "create-hash@>=1.1.2 <2.0.0",
+          "resolved": "https://registry.npmjs.org/create-hash/-/create-hash-1.1.2.tgz",
+          "dependencies": {
+            "cipher-base": {
+              "version": "1.0.2",
+              "from": "cipher-base@>=1.0.1 <2.0.0",
+              "resolved": "https://registry.npmjs.org/cipher-base/-/cipher-base-1.0.2.tgz"
+            },
+            "inherits": {
+              "version": "2.0.1",
+              "from": "inherits@>=2.0.1 <3.0.0",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+            },
+            "ripemd160": {
+              "version": "1.0.1",
+              "from": "ripemd160@>=1.0.0 <2.0.0",
+              "resolved": "https://registry.npmjs.org/ripemd160/-/ripemd160-1.0.1.tgz"
+            },
+            "sha.js": {
+              "version": "2.4.4",
+              "from": "sha.js@>=2.3.6 <3.0.0",
+              "resolved": "https://registry.npmjs.org/sha.js/-/sha.js-2.4.4.tgz"
+            }
+          }
+        }
+      }
+    },
+    "ripple-keypairs": {
+      "version": "0.10.0",
+      "from": "ripple-keypairs@>=0.10.0 <0.11.0",
+      "resolved": "https://registry.npmjs.org/ripple-keypairs/-/ripple-keypairs-0.10.0.tgz",
+      "dependencies": {
+        "bn.js": {
+          "version": "3.3.0",
+          "from": "bn.js@>=3.1.1 <4.0.0",
+          "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-3.3.0.tgz"
+        },
+        "brorand": {
+          "version": "1.0.5",
+          "from": "brorand@>=1.0.5 <2.0.0",
+          "resolved": "https://registry.npmjs.org/brorand/-/brorand-1.0.5.tgz"
+        },
+        "elliptic": {
+          "version": "5.2.1",
+          "from": "elliptic@>=5.1.0 <6.0.0",
+          "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-5.2.1.tgz",
+          "dependencies": {
+            "inherits": {
+              "version": "2.0.1",
+              "from": "inherits@>=2.0.1 <3.0.0",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+            }
+          }
+        },
+        "hash.js": {
+          "version": "1.0.3",
+          "from": "hash.js@>=1.0.3 <2.0.0",
+          "resolved": "https://registry.npmjs.org/hash.js/-/hash.js-1.0.3.tgz",
+          "dependencies": {
+            "inherits": {
+              "version": "2.0.1",
+              "from": "inherits@>=2.0.1 <3.0.0",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+            }
+          }
+        }
+      }
     },
     "ripple-lib-transactionparser": {
-      "version": "0.3.2",
-      "resolved": "https://registry.npmjs.org/ripple-lib-transactionparser/-/ripple-lib-transactionparser-0.3.2.tgz",
-      "dependencies": {
-        "bignumber.js": {
-          "version": "1.4.1",
-          "resolved": "https://registry.npmjs.org/bignumber.js/-/bignumber.js-1.4.1.tgz"
-        }
-      }
-    },
-    "ripple-wallet-generator": {
-      "version": "1.0.3",
-      "resolved": "https://registry.npmjs.org/ripple-wallet-generator/-/ripple-wallet-generator-1.0.3.tgz"
-    },
-    "simple-asyncify": {
-      "version": "0.1.0",
-      "resolved": "https://registry.npmjs.org/simple-asyncify/-/simple-asyncify-0.1.0.tgz"
-    },
-    "sjcl-extended": {
-      "version": "1.0.3",
-      "resolved": "git://github.com/ripple/sjcl-extended.git#d8cf8b22e7d97193c54e1f65113e3edcf200ca17",
-      "dependencies": {
-        "sjcl": {
-          "version": "1.0.3",
-          "resolved": "https://registry.npmjs.org/sjcl/-/sjcl-1.0.3.tgz"
-        }
-      }
+      "version": "0.6.0",
+      "from": "ripple-lib-transactionparser@>=0.6.0 <0.7.0",
+      "resolved": "https://registry.npmjs.org/ripple-lib-transactionparser/-/ripple-lib-transactionparser-0.6.0.tgz"
     },
     "ws": {
       "version": "0.7.2",
+      "from": "ws@>=0.7.1 <0.8.0",
       "resolved": "https://registry.npmjs.org/ws/-/ws-0.7.2.tgz",
       "dependencies": {
-        "bufferutil": {
-          "version": "1.1.0",
-          "resolved": "https://registry.npmjs.org/bufferutil/-/bufferutil-1.1.0.tgz",
-          "dependencies": {
-            "bindings": {
-              "version": "1.2.1",
-              "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.2.1.tgz"
-            },
-            "nan": {
-              "version": "1.8.4",
-              "resolved": "https://registry.npmjs.org/nan/-/nan-1.8.4.tgz"
-            }
-          }
-        },
         "options": {
           "version": "0.0.6",
+          "from": "options@>=0.0.5",
           "resolved": "https://registry.npmjs.org/options/-/options-0.0.6.tgz"
         },
         "ultron": {
           "version": "1.0.2",
+          "from": "ultron@>=1.0.0 <1.1.0",
           "resolved": "https://registry.npmjs.org/ultron/-/ultron-1.0.2.tgz"
         },
-        "utf-8-validate": {
+        "bufferutil": {
           "version": "1.1.0",
-          "resolved": "https://registry.npmjs.org/utf-8-validate/-/utf-8-validate-1.1.0.tgz",
+          "from": "bufferutil@>=1.1.0 <1.2.0",
+          "resolved": "https://registry.npmjs.org/bufferutil/-/bufferutil-1.1.0.tgz",
           "dependencies": {
             "bindings": {
               "version": "1.2.1",
+              "from": "bindings@>=1.2.0 <1.3.0",
               "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.2.1.tgz"
             },
             "nan": {
               "version": "1.8.4",
+              "from": "nan@>=1.8.0 <1.9.0",
+              "resolved": "https://registry.npmjs.org/nan/-/nan-1.8.4.tgz"
+            }
+          }
+        },
+        "utf-8-validate": {
+          "version": "1.1.0",
+          "from": "utf-8-validate@>=1.1.0 <1.2.0",
+          "resolved": "https://registry.npmjs.org/utf-8-validate/-/utf-8-validate-1.1.0.tgz",
+          "dependencies": {
+            "bindings": {
+              "version": "1.2.1",
+              "from": "bindings@>=1.2.0 <1.3.0",
+              "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.2.1.tgz"
+            },
+            "nan": {
+              "version": "1.8.4",
+              "from": "nan@>=1.8.0 <1.9.0",
               "resolved": "https://registry.npmjs.org/nan/-/nan-1.8.4.tgz"
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ripple-lib",
-  "version": "0.13.0-rc1",
+  "version": "0.13.1",
   "license": "ISC",
   "description": "A JavaScript API for interacting with Ripple in Node.js and the browser",
   "files": [
@@ -15,50 +15,56 @@
     "test": "test"
   },
   "dependencies": {
-    "async": "~0.9.0",
+    "ajv": "^1.4.8",
+    "babel-polyfill": "^6.2.0",
     "babel-runtime": "^5.5.4",
     "bignumber.js": "^2.0.3",
-    "extend": "~1.2.1",
     "https-proxy-agent": "^1.0.0",
-    "is-my-json-valid": "^2.12.0",
     "lodash": "^3.1.0",
-    "lru-cache": "~2.5.0",
-    "ripple-lib-transactionparser": "^0.3.2",
-    "ripple-wallet-generator": "^1.0.3",
-    "simple-asyncify": "^0.1.0",
-    "sjcl-extended": "ripple/sjcl-extended#1.0.3",
-    "ws": "~0.7.1"
+    "ripple-address-codec": "^2.0.1",
+    "ripple-binary-codec": "^0.1.0",
+    "ripple-hashes": "^0.1.0",
+    "ripple-keypairs": "^0.10.0",
+    "ripple-lib-transactionparser": "^0.6.0",
+    "ws": "^0.7.1"
   },
   "devDependencies": {
     "assert-diff": "^1.0.1",
-    "babel": "^5.5.4",
-    "babel-core": "^5.5.4",
-    "babel-eslint": "^3.1.23",
-    "babel-loader": "^5.0.0",
-    "coveralls": "~2.10.0",
-    "eslint": "^0.24.0",
+    "babel": "^5.8.21",
+    "babel-core": "^5.8.22",
+    "babel-eslint": "^4.1.3",
+    "babel-loader": "^5.3.2",
+    "coveralls": "^2.10.0",
+    "doctoc": "^0.15.0",
+    "ejs": "^2.3.4",
+    "eslint": "^1.3.0",
     "eslint-plugin-flowtype": "^1.0.0",
     "eventemitter2": "^0.4.14",
-    "flow-bin": "^0.13.1",
-    "gulp": "~3.8.10",
-    "gulp-bump": "~0.1.13",
-    "gulp-rename": "~1.2.0",
-    "gulp-uglify": "~1.1.0",
-    "istanbul": "~0.3.5",
-    "mocha": "~2.1.0",
-    "webpack": "~1.5.3",
-    "yargs": "~1.3.1"
+    "flow-bin": "^0.14",
+    "gulp": "^3.8.10",
+    "gulp-bump": "^0.1.13",
+    "gulp-rename": "^1.2.0",
+    "gulp-uglify": "^1.1.0",
+    "istanbul": "^0.3.5",
+    "json-loader": "^0.5.2",
+    "json-schema-to-markdown-table": "^0.4.0",
+    "mocha": "^2.1.0",
+    "webpack": "^1.5.3",
+    "yargs": "^1.3.1"
   },
   "scripts": {
     "build": "gulp",
+    "doctoc": "doctoc docs/index.md --title '# RippleAPI Reference' --github --maxlevel 2",
+    "docgen": "node --harmony scripts/build_docs.js",
     "clean": "rm -rf dist/npm && rm -rf build/flow",
     "typecheck": "babel --optional runtime --blacklist flow -d build/flow/ src/ && flow check",
-    "compile": "babel --optional runtime -d dist/npm/ src/ && cp -r src/api/common/schemas/ dist/npm/api/common/schemas/",
-    "compile-with-source-maps": "babel --optional runtime -s -t -d dist/npm/ src/",
+    "compile": "babel -D --optional runtime -d dist/npm/ src/",
+    "watch": "babel -w -D --optional runtime -d dist/npm/ src/",
+    "compile-with-source-maps": "babel -D --optional runtime -s -t -d dist/npm/ src/",
     "prepublish": "npm run clean && npm run compile",
     "test": "istanbul test _mocha",
     "coveralls": "cat ./coverage/lcov.info | coveralls",
-    "lint": "if ! [ -f eslintrc ]; then curl -o eslintrc 'https://raw.githubusercontent.com/ripple/javascript-style-guide/es6/eslintrc'; echo 'plugins:\n  - flowtype' >> eslintrc; fi; eslint --reset -c eslintrc src/",
+    "lint": "if ! [ -f eslintrc ]; then curl -o eslintrc 'https://raw.githubusercontent.com/ripple/javascript-style-guide/es6/eslintrc'; echo 'parser: babel-eslint' >> eslintrc; fi; eslint -c eslintrc src/",
     "perf": "./scripts/perf_test.sh"
   },
   "repository": {

scripts/build_docs.js

@@ -0,0 +1,51 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+const execSync = require('child_process').execSync;
+const ejs = require('ejs');
+const renderFromPaths =
+  require('json-schema-to-markdown-table').renderFromPaths;
+const ROOT = path.dirname(path.normalize(__dirname));
+
+function strip(string) {
+  return string.replace(/^\s+|\s+$/g, '');
+}
+
+function importFile(relativePath) {
+  const absolutePath = path.join(ROOT, relativePath);
+  return strip(fs.readFileSync(absolutePath).toString('utf-8'));
+}
+
+function renderFixture(fixtureRelativePath) {
+  const json = importFile(path.join('test', 'fixtures', fixtureRelativePath));
+  return '\n```json\n' + json + '\n```\n';
+}
+
+function renderSchema(schemaRelativePath) {
+  const schemasPath = path.join(ROOT, 'src', 'common', 'schemas');
+  const schemaPath = path.join(schemasPath, schemaRelativePath);
+  return renderFromPaths(schemaPath, schemasPath);
+}
+
+function main() {
+  const locals = {
+    importFile: importFile,
+    renderFixture: renderFixture,
+    renderSchema: renderSchema
+  };
+
+  const indexPath = path.join(ROOT, 'docs', 'src', 'index.md.ejs');
+  ejs.renderFile(indexPath, locals, function(error, output) {
+    if (error) {
+      console.error(error);
+      process.exit(1);
+    } else {
+      const outputPath = path.join(ROOT, 'docs', 'index.md');
+      fs.writeFileSync(outputPath, output);
+      execSync('npm run doctoc', {cwd: ROOT});
+      process.exit(0);
+    }
+  });
+}
+
+main();

scripts/ci.sh

@@ -0,0 +1,79 @@
+#!/bin/bash -ex
+
+NODE_INDEX="$1"
+TOTAL_NODES="$2"
+
+typecheck() {
+  npm install -g flow-bin
+  flow --version
+  npm run typecheck
+}
+
+lint() {
+  echo "eslint $(node_modules/.bin/eslint --version)"
+  npm list babel-eslint | grep babel-eslint
+  REPO_URL="https://raw.githubusercontent.com/ripple/javascript-style-guide"
+  curl "$REPO_URL/es6/eslintrc" > ./eslintrc
+  echo "parser: babel-eslint" >> ./eslintrc
+  node_modules/.bin/eslint -c ./eslintrc $(git --no-pager diff --name-only -M100% --diff-filter=AM --relative $(git merge-base FETCH_HEAD origin/HEAD) FETCH_HEAD | grep "\.js$")
+}
+
+unittest() {
+  # test "src"
+  npm test --coverage
+  npm run coveralls
+
+  # test compiled version in "dist/npm"
+  babel -D --optional runtime --ignore "**/node_modules/**" -d test-compiled/ test/
+  echo "--reporter spec --timeout 5000 --slow 500" > test-compiled/mocha.opts
+  mkdir -p test-compiled/node_modules
+  ln -nfs ../../dist/npm test-compiled/node_modules/ripple-api
+  mocha --opts test-compiled/mocha.opts test-compiled
+  rm -rf test-compiled
+}
+
+integrationtest() {
+  mocha test/integration/integration-test.js
+}
+
+doctest() {
+  mv docs/index.md docs/index.md.save
+  npm run docgen
+  mv docs/index.md docs/index.md.test
+  mv docs/index.md.save docs/index.md
+  cmp docs/index.md docs/index.md.test
+  rm docs/index.md.test
+}
+
+oneNode() {
+  doctest
+  lint
+  typecheck
+  unittest
+  integrationtest
+}
+
+twoNodes() {
+  case "$NODE_INDEX" in
+    0) doctest; lint; integrationtest;;
+    1) typecheck; unittest;;
+    *) echo "ERROR: invalid usage"; exit 2;;
+  esac
+}
+
+threeNodes() {
+  case "$NODE_INDEX" in
+    0) doctest; lint; integrationtest;;
+    1) typecheck;;
+    2) unittest;;
+    *) echo "ERROR: invalid usage"; exit 2;;
+  esac
+}
+
+case "$TOTAL_NODES" in
+  "") oneNode;;
+  1) oneNode;;
+  2) twoNodes;;
+  3) threeNodes;;
+  *) echo "ERROR: invalid usage"; exit 2;;
+esac

scripts/modpow.js

@@ -1,44 +0,0 @@
-var Benchmark;
-try {
-  Benchmark = require('benchmark');
-} catch (e) {
-  console.error("Please install Benchmark.js: npm install benchmark");
-  process.exit(1);
-}
-
-var sjcl = require('../build/sjcl');
-var jsbn = require('../src/js/jsbn/jsbn');
-
-var base = "3f70f29d3f3ae354a6d2536ceafba83cfc787cd91e7acd2b6bde05e62beb8295ae18e3f786726f8d034bbc15bf8331df959f59d431736d5f306aaba63dacec279484e39d76db9b527738072af15730e8b9956a64e8e4dbe868f77d1414a8a8b8bf65380a1f008d39c5fabe1a9f8343929342ab7b4f635bdc52532d764701ff3d8072c475c012ff0c59373e8bc423928d99f58c3a6d9f6ab21ee20bc8e8818fc147db09f60c81906f2c6f73dc69725f075853a89f0cd02a30a8dd86b660ccdeffc292f398efb54088c822774445a6afde471f7dd327ef9996296898a5747726ccaeeceeb2e459df98b4128cb5ab8c7cd20c563f960a1aa770f3c81f13f967b6cc";
-var exponent = "322e393f76a1c22b147e7d193c00c023afb7c1500b006ff1bc1cc8d391fc38bd";
-var modulus = "c7f1bc1dfb1be82d244aef01228c1409c198894eca9e21430f1669b4aa3864c9f37f3d51b2b4ba1ab9e80f59d267fda1521e88b05117993175e004543c6e3611242f24432ce8efa3b81f0ff660b4f91c5d52f2511a6f38181a7bf9abeef72db056508bbb4eeb5f65f161dd2d5b439655d2ae7081fcc62fdcb281520911d96700c85cdaf12e7d1f15b55ade867240722425198d4ce39019550c4c8a921fc231d3e94297688c2d77cd68ee8fdeda38b7f9a274701fef23b4eaa6c1a9c15b2d77f37634930386fc20ec291be95aed9956801e1c76601b09c413ad915ff03bfdc0b6b233686ae59e8caf11750b509ab4e57ee09202239baee3d6e392d1640185e1cd";
-var expected = "5b3823974b3eda87286d3f38499de290bd575d8b02f06720acacf3d50950f9ca0ff6b749f3be03913ddca0b291e0b263bdab6c9cb97e4ab47ee9c235ff20931a8ca358726fab93614e2c549594f5c50b1c979b34f840b6d4fc51d6feb2dd072995421d17862cb405e040fc1ed662a3245a1f97bbafa6d1f7f76c7db6a802e3037acdf01ab5053f5da518d6753477193b9c25e1720519dcb9e2f6e70d5786656d356151845a49861dfc40187eff0e85cd18b1f3f3b97c476472edfa090b868b2388edfffecc521c20df8cebb8aacfb3669b020330dd6ea64b2a3067a972b8f249bccc19347eff43893e916f0949bd5789a5cce0f8b7cd87cece909d679345c0d4";
-
-var BigInteger = jsbn.BigInteger;
-var jsbnBase = new BigInteger(base, 16);
-var jsbnExponent = new BigInteger(exponent, 16);
-var jsbnModulus = new BigInteger(modulus, 16);
-
-var bn = sjcl.bn;
-var sjclBase = new bn(base);
-var sjclExponent = new bn(exponent);
-var sjclModulus = new bn(modulus);
-
-var suite = new Benchmark.Suite;
-
-// add tests
-suite.add('jsbn#modPow', function() {
-  jsbnBase.modPow(jsbnExponent, jsbnModulus);
-});
-suite.add('sjcl#powermodMontgomery', function() {
-  sjclBase.powermodMontgomery(sjclExponent, sjclModulus);
-});
-suite.on('cycle', function(event) {
-  console.log(String(event.target));
-});
-suite.on('complete', function() {
-  console.log('Fastest is ' + this.filter('fastest').pluck('name'));
-});
-// run async
-console.log("Running benchmark...");
-suite.run({ 'async': false });

scripts/perf_test.sh

@@ -1,11 +0,0 @@
-#!/bin/sh
-URL="https://www.dropbox.com/s/a0gy7vbb86eeqlq/ledger-full-1000000.json?dl=1"
-DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
-DEST="$DIR/cache/ledger-full-1000000.json"
-if [ ! -e "$DEST" ]
-then
-  echo "Downloading test data..."
-  mkdir -p "$DIR/cache"
-  curl -L "$URL" > "$DEST"
-fi
-npm run compile && time node "$DIR/verify_ledger_json.js" "$DEST"

scripts/publish

@@ -26,7 +26,7 @@ gulp bower
 exit_on_error
 
 cd dist/bower
-version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc[0-9])?')
+version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc([0-9])+)?')
 echo "version: $version"
 git add ripple.js ripple-debug.js ripple-min.js bower.json
 exit_on_error
@@ -40,4 +40,4 @@ exit_on_error
 git push origin master
 git push --tags origin master
 
-cd ..
+cd ../..

scripts/publish_rc

@@ -26,7 +26,7 @@ gulp bower
 exit_on_error
 
 cd dist/bower
-version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc[0-9])?')
+version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc([0-9])+)?')
 echo "version: $version"
 git add ripple.js ripple-debug.js ripple-min.js bower.json
 exit_on_error
@@ -40,4 +40,4 @@ exit_on_error
 git push origin master
 git push --tags origin master
 
-cd ..
+cd ../..

scripts/verify_ledger_json.js

@@ -1,66 +0,0 @@
-/* eslint-disable no-var */
-'use strict';
-
-var fs = require('fs');
-var Amount = require('../dist/npm').Amount;
-var Ledger = require('../dist/npm').Ledger;
-
-function parse_options(from, flags) {
-  var argv = from.slice(),
-      opts_ = {argv: argv};
-
-  flags.forEach(function(f) {
-    // Do we have the flag?
-    var flag_index = argv.indexOf('--' + f);
-    // normalize the name of the flag
-    var flag = f.replace('-', '_');
-    // opts_ has Boolean value for normalized flag key
-    opts_[flag] = flag_index !== -1;
-    if (opts_[flag]) {
-      // remove the flag from the argv
-      argv.splice(flag_index, 1);
-    }
-  });
-  return opts_;
-}
-
-var opts = parse_options(process.argv.slice(2), // remove `node` and `this.js`
-                        ['sanity-test']);
-
-if (opts.argv.length < 1) {
-  console.error('Usage: scripts/verify_ledger_json path/to/ledger.json');
-  console.error('       optional: --sanity-test (json>binary>json>binary)');
-  process.exit(1);
-}
-
-var json = fs.readFileSync(opts.argv[0], 'utf-8');
-var ledger = Ledger.from_json(JSON.parse(json));
-
-// This will serialize each accountState object to binary and then back to json
-// before finally serializing for hashing. This is mostly to expose any issues
-// with ripple-libs binary <--> json codecs.
-if (opts.sanity_test) {
-  console.log('All accountState nodes will be processed from ' +
-              'json->binary->json->binary. This may take some time ' +
-              'with large ledgers.');
-}
-
-// To recompute the hashes of some ledgers, we must allow values that slipped in
-// before strong policies were in place.
-Amount.strict_mode = false;
-
-console.log('Transaction hash in header:    ' +
-             ledger.ledger_json.transaction_hash);
-console.log('Calculated transaction hash:   ' +
-             ledger.calc_tx_hash().to_hex());
-
-console.log('Account state hash in header:  ' +
-             ledger.ledger_json.account_hash);
-
-if (ledger.ledger_json.accountState) {
-  console.log('Calculated account state hash: ' +
-               ledger.calc_account_hash({sanity_test: opts.sanity_test})
-                                                      .to_hex());
-} else {
-  console.log('Ledger has no accountState');
-}

src/api/common/constants.js

@@ -1,44 +0,0 @@
-'use strict';
-const core = require('./utils').core;
-const flagIndices = core.Transaction.set_clear_flags.AccountSet;
-const flags = core.Remote.flags.account_root;
-
-const AccountFlags = {
-  passwordSpent: flags.PasswordSpent,
-  requireDestinationTag: flags.RequireDestTag,
-  requireAuthorization: flags.RequireAuth,
-  disallowIncomingXRP: flags.DisallowXRP,
-  disableMasterKey: flags.DisableMaster,
-  noFreeze: flags.NoFreeze,
-  globalFreeze: flags.GlobalFreeze,
-  defaultRipple: flags.DefaultRipple
-};
-
-const AccountFlagIndices = {
-  requireDestinationTag: flagIndices.asfRequireDest,
-  requireAuthorization: flagIndices.asfRequireAuth,
-  disallowIncomingXRP: flagIndices.asfDisallowXRP,
-  disableMasterKey: flagIndices.asfDisableMaster,
-  enableTransactionIDTracking: flagIndices.asfAccountTxnID,
-  noFreeze: flagIndices.asfNoFreeze,
-  globalFreeze: flagIndices.asfGlobalFreeze,
-  defaultRipple: flagIndices.asfDefaultRipple
-};
-
-const AccountFields = {
-  EmailHash: {name: 'emailHash', encoding: 'hex',
-              length: 32, defaults: '0'},
-  WalletLocator: {name: 'walletLocator', encoding: 'hex',
-                  length: 64, defaults: '0'},
-  WalletSize: {name: 'walletSize', defaults: 0},
-  MessageKey: {name: 'messageKey'},
-  Domain: {name: 'domain', encoding: 'hex'},
-  TransferRate: {name: 'transferRate', defaults: 0},
-  Signers: {name: 'signers'}
-};
-
-module.exports = {
-  AccountFields,
-  AccountFlagIndices,
-  AccountFlags
-};

src/api/common/errors.js

@@ -1,89 +0,0 @@
-/* eslint-disable valid-jsdoc */
-'use strict';
-
-/**
- * Base class for all errors
- */
-function RippleError(message) {
-  this.message = message;
-}
-RippleError.prototype = new Error();
-RippleError.prototype.name = 'RippleError';
-
-function ValidationError(message) {
-  this.message = message;
-}
-ValidationError.prototype = new RippleError();
-ValidationError.prototype.name = 'ValidationError';
-
-/**
- * Timeout, disconnects and too busy
- */
-function NetworkError(message) {
-  this.message = message;
-}
-NetworkError.prototype = new RippleError();
-NetworkError.prototype.name = 'NetworkError';
-
-/**
- * Failed transactions, no paths found, not enough balance, etc.
- */
-function RippledNetworkError(message) {
-  this.message = message !== undefined ? message : 'Cannot connect to rippled';
-}
-RippledNetworkError.prototype = new NetworkError();
-
-/**
- * Failed transactions, no paths found, not enough balance, etc.
- */
-function TransactionError(message) {
-  this.message = message;
-}
-TransactionError.prototype = new RippleError();
-TransactionError.prototype.name = 'TransactionError';
-
-/**
- * Asset could not be found
- */
-function NotFoundError(message) {
-  this.message = message;
-}
-NotFoundError.prototype = new RippleError();
-NotFoundError.prototype.name = 'NotFoundError';
-
-function MissingLedgerHistoryError(message) {
-  this.message = message ||
-    'Server is missing ledger history in the specified range';
-}
-MissingLedgerHistoryError.prototype = new RippleError();
-MissingLedgerHistoryError.prototype.name = 'MissingLedgerHistoryError';
-
-/**
- * Request timed out
- */
-function TimeOutError(message) {
-  this.message = message;
-}
-TimeOutError.prototype = new RippleError();
-TimeOutError.prototype.name = 'TimeOutError';
-
-/**
- * API logic failed to do what it intended
- */
-function ApiError(message) {
-  this.message = message;
-}
-ApiError.prototype = new RippleError();
-ApiError.prototype.name = 'ApiError';
-
-module.exports = {
-  ValidationError: ValidationError,
-  NetworkError: NetworkError,
-  TransactionError: TransactionError,
-  RippledNetworkError: RippledNetworkError,
-  NotFoundError: NotFoundError,
-  MissingLedgerHistoryError: MissingLedgerHistoryError,
-  TimeOutError: TimeOutError,
-  ApiError: ApiError,
-  RippleError: RippleError
-};

src/api/common/index.js

@@ -1,15 +0,0 @@
-'use strict';
-const utils = require('./utils');
-
-module.exports = {
-  core: utils.core,
-  constants: require('./constants'),
-  errors: require('./errors'),
-  validate: require('./validate'),
-  dropsToXrp: utils.dropsToXrp,
-  xrpToDrops: utils.xrpToDrops,
-  toRippledAmount: utils.toRippledAmount,
-  wrapCatch: utils.wrapCatch,
-  composeAsync: utils.composeAsync,
-  convertExceptions: utils.convertExceptions
-};

src/api/common/schema-validator.js

@@ -1,63 +0,0 @@
-'use strict';
-const _ = require('lodash');
-const fs = require('fs');
-const path = require('path');
-const validator = require('is-my-json-valid');
-const core = require('./utils').core;
-const ValidationError = require('./errors').ValidationError;
-
-let SCHEMAS = {};
-
-function isValidAddress(address) {
-  return core.UInt160.is_valid(address);
-}
-
-function isValidLedgerHash(ledgerHash) {
-  return core.UInt256.is_valid(ledgerHash);
-}
-
-function loadSchema(filepath) {
-  try {
-    return JSON.parse(fs.readFileSync(filepath, 'utf8'));
-  } catch (e) {
-    throw new Error('Failed to parse schema: ' + filepath);
-  }
-}
-
-function endsWith(str, suffix) {
-  return str.indexOf(suffix, str.length - suffix.length) !== -1;
-}
-
-function loadSchemas(dir) {
-  const filenames = fs.readdirSync(dir).filter(name => endsWith(name, '.json'));
-  const schemas = filenames.map(name => loadSchema(path.join(dir, name)));
-  return _.indexBy(schemas, 'title');
-}
-
-function formatSchemaError(error) {
-  return error.field + ' ' + error.message
-    + (error.value ? ' (' + JSON.stringify(error.value) + ')' : '');
-}
-
-function formatSchemaErrors(errors) {
-  return errors.map(formatSchemaError).join(', ');
-}
-
-function schemaValidate(schemaName, object) {
-  const formats = {address: isValidAddress,
-                   ledgerHash: isValidLedgerHash};
-  const options = {schemas: SCHEMAS, formats: formats,
-                   verbose: true, greedy: true};
-  const schema = SCHEMAS[schemaName];
-  if (schema === undefined) {
-    throw new Error('schema not found for: ' + schemaName);
-  }
-  const validate = validator(schema, options);
-  const isValid = validate(object);
-  if (!isValid) {
-    throw new ValidationError(formatSchemaErrors(validate.errors));
-  }
-}
-
-SCHEMAS = loadSchemas(path.join(__dirname, './schemas'));
-module.exports = schemaValidate;

src/api/common/schemas/cancellation.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "cancellation",
-  "type": "object",
-  "properties": {
-    "orderSequence": {"$ref": "sequence"}
-  },
-  "required": ["orderSequence"],
-  "additionalProperties": false
-}

src/api/common/schemas/memo.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "memo",
-  "description": "Memo objects represent arbitrary data that can be included in a transaction",
-  "type": "object",
-  "properties": {
-    "type": {
-      "pattern": "^[A-Za-z0-9\\-._~:/?#[\\]@!$&'()*+,;=%]*$"
-    },
-    "format": {
-      "pattern": "^[A-Za-z0-9\\-._~:/?#[\\]@!$&'()*+,;=%]*$"
-    },
-    "data": {
-      "type": "string"
-    }
-  },
-  "additionalProperties": false,
-  "anyOf": [
-    {"required": ["data"]},
-    {"required": ["type"]}
-  ]
-}

src/api/common/schemas/order.json

@@ -1,25 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "order",
-  "type": "object",
-  "properties": {
-    "direction": {
-      "type": "string",
-      "enum": ["buy", "sell"]
-    },
-    "quantity": {"$ref": "amount"},
-    "totalPrice": {"$ref": "amount"},
-    "immediateOrCancel": {"type": "boolean"},
-    "fillOrKill": {"type": "boolean"},
-    "passive": {
-      "description": "If enabled, the offer will not consume offers that exactly match it, and instead becomes an Offer node in the ledger. It will still consume offers that cross it.",
-      "type": "boolean"
-    }
-  },
-  "required": ["direction", "quantity", "totalPrice"],
-  "additionalProperties": false,
-  "not": {
-    "description": "immediateOrCancel and fillOrKill are mutually exclusive",
-    "required": ["immediateOrCancel", "fillOrKill"]
-  }
-}

src/api/common/schemas/orders-options.json

@@ -1,14 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "orders-options",
-  "description": "Options for getOrders and getOrderbook",
-  "type": "object",
-  "properties": {
-    "limit": {
-      "type": "integer",
-      "minimum": 1
-    },
-    "ledgerVersion": {"$ref": "ledgerVersion"}
-  },
-  "additionalProperties": false
-}

src/api/common/schemas/pathfind.json

@@ -1,31 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "pathfind",
-  "type": "object",
-  "properties": {
-    "source": {
-      "type": "object",
-      "properties": {
-        "address": {"$ref": "address"},
-        "currencies": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "currency": {"$ref": "currency"},
-              "counterparty": {"$ref": "address"}
-            },
-            "required": ["currency"],
-            "additionalProperties": false
-          },
-          "uniqueItems": true
-        }
-      },
-      "additionalProperties": false,
-      "required": ["address"]
-    },
-    "destination": {"$ref": "adjustment"}
-  },
-  "required": ["source", "destination"],
-  "additionalProperties": false
-}

src/api/common/schemas/quality.json

@@ -1,8 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "quality",
-  "description": "Ratio for incoming/outgoing transit fees represented in billionths. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio.",
-  "type": "integer",
-  "minimum": 0,
-  "maximum": 1000000000
-}

src/api/common/schemas/settings-options.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "settings-options",
-  "description": "Options for getSettings and getAccountInfo",
-  "type": "object",
-  "properties": {
-    "ledgerVersion": {"$ref": "ledgerVersion"}
-  },
-  "additionalProperties": false
-}

src/api/common/schemas/settings.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "settings",
-  "type": "object",
-  "properties": {
-    "passwordSpent": {"type": "boolean"},
-    "requireDestinationTag": {"type": "boolean"},
-    "requireAuthorization": {"type": "boolean"},
-    "disallowIncomingXRP": {"type": "boolean"},
-    "disableMasterKey": {"type": "boolean"},
-    "enableTransactionIDTracking": {"type": "boolean"},
-    "noFreeze": {"type": "boolean"},
-    "globalFreeze": {"type": "boolean"},
-    "defaultRipple": {"type": "boolean"},
-    "emailHash": {"$ref": "hash128"},
-    "walletLocator": {"$ref": "hash256"},
-    "walletSize": {"type": "integer"},
-    "messageKey": {"type": "string"},
-    "domain": {"type": "string"},
-    "transferRate": {"type": "integer"},
-    "signers": {"type": "string"},
-    "regularKey": {"$ref": "address"}
-  },
-  "minProperties": 1,
-  "maxProperties": 1,
-  "additionalProperties": false
-}

src/api/common/schemas/timestamp.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "timestamp",
-  "description": "An ISO 8601 combined date and time timestamp",
-  "type": "string",
-  "pattern": "^$|^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9](Z|[+](2[0-3]|[01][0-9]):[0-5][0-9])$"
-}

src/api/common/schemas/transaction-options.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "transaction-options",
-  "description": "Options for getTransaction",
-  "type": "object",
-  "properties": {
-    "minLedgerVersion": {"$ref": "ledgerVersion"},
-    "maxLedgerVersion": {"$ref": "ledgerVersion"}
-  },
-  "additionalProperties": false
-}

src/api/common/schemas/transactions-options.json

@@ -1,40 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "transactions-options",
-  "description": "Options for getTransactions",
-  "type": "object",
-  "properties": {
-    "start": {"$ref": "hash256"},
-    "limit": {
-      "type": "integer",
-      "minimum": 1
-    },
-    "minLedgerVersion": {"$ref": "ledgerVersion"},
-    "maxLedgerVersion": {"$ref": "ledgerVersion"},
-    "earliestFirst": {"type": "boolean"},
-    "excludeFailures": {"type": "boolean"},
-    "initiated": {"type": "boolean"},
-    "counterparty": {"$ref": "address"},
-    "types": {
-      "type": "array",
-      "items": {
-        "enum": [
-          "payment",
-          "trustline",
-          "order",
-          "orderCancellation",
-          "settings"
-        ]
-      }
-    },
-    "binary": {"type": "boolean"}
-  },
-  "additionalProperties": false,
-  "not": {
-    "anyOf": [
-      {"required": ["incoming", "outgoing"]},
-      {"required": ["start", "minLedgerVersion"]},
-      {"required": ["start", "maxLedgerVersion"]}
-    ]
-  }
-}

src/api/common/schemas/trustline.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "trustline",
-  "type": "object",
-  "properties": {
-    "currency": {"$ref": "currency"},
-    "counterparty": {"$ref": "address"},
-    "limit": {"$ref": "value"},
-    "qualityIn": {"$ref": "quality"},
-    "qualityOut": {"$ref": "quality"},
-    "allowRippling": {"type": "boolean"},
-    "authorized": {"type": "boolean"},
-    "frozen": {"type": "boolean"}
-  },
-  "required": ["currency", "counterparty", "limit"],
-  "additionalProperties": false
-}

src/api/common/utils.js

@@ -1,71 +0,0 @@
-'use strict';
-const BigNumber = require('bignumber.js');
-const core = require('../../core');
-const errors = require('./errors');
-
-function dropsToXrp(drops) {
-  return (new BigNumber(drops)).dividedBy(1000000.0).toString();
-}
-
-function xrpToDrops(xrp) {
-  return (new BigNumber(xrp)).times(1000000.0).floor().toString();
-}
-
-function toRippledAmount(amount) {
-  if (amount.currency === 'XRP') {
-    return xrpToDrops(amount.value);
-  }
-  return {
-    currency: amount.currency,
-    issuer: amount.counterparty ? amount.counterparty : amount.issuer,
-    value: amount.value
-  };
-}
-
-function wrapCatch(asyncFunction: () => void): () => void {
-  return function() {
-    try {
-      asyncFunction.apply(this, arguments);
-    } catch (error) {
-      const callback = arguments[arguments.length - 1];
-      callback(error);
-    }
-  };
-}
-
-function composeAsync(wrapper, callback) {
-  return function(error, data) {
-    if (error) {
-      callback(error);
-      return;
-    }
-    let result;
-    try {
-      result = wrapper(data);
-    } catch (exception) {
-      callback(exception);
-      return;
-    }
-    callback(null, result);
-  };
-}
-
-function convertExceptions(f) {
-  return function() {
-    try {
-      return f.apply(this, arguments);
-    } catch (error) {
-      throw new errors.ApiError(error.message);
-    }
-  };
-}
-
-module.exports = {
-  core,
-  dropsToXrp,
-  xrpToDrops,
-  toRippledAmount,
-  wrapCatch,
-  composeAsync,
-  convertExceptions
-};

src/api/common/validate.js

@@ -1,65 +0,0 @@
-'use strict';
-const _ = require('lodash');
-const core = require('./utils').core;
-const ValidationError = require('./errors').ValidationError;
-const schemaValidate = require('./schema-validator');
-
-function error(text) {
-  return new ValidationError(text);
-}
-
-function validateAddressAndSecret(obj) {
-  const address = obj.address;
-  const secret = obj.secret;
-  schemaValidate('address', address);
-  if (!secret) {
-    throw error('Parameter missing: secret');
-  }
-  try {
-    if (!core.Seed.from_json(secret).get_key(address)) {
-      throw error('secret does not match address');
-    }
-  } catch (exception) {
-    throw error('secret does not match address');
-  }
-}
-
-function validateLedgerRange(options) {
-  if (!_.isUndefined(options.minLedgerVersion)
-      && !_.isUndefined(options.maxLedgerVersion)) {
-    if (Number(options.minLedgerVersion) > Number(options.maxLedgerVersion)) {
-      throw error('minLedgerVersion must not be greater than maxLedgerVersion');
-    }
-  }
-}
-
-function validateOptions(schema, options) {
-  schemaValidate(schema, options);
-  validateLedgerRange(options);
-}
-
-module.exports = {
-  address: _.partial(schemaValidate, 'address'),
-  addressAndSecret: validateAddressAndSecret,
-  currency: _.partial(schemaValidate, 'currency'),
-  identifier: _.partial(schemaValidate, 'hash256'),
-  sequence: _.partial(schemaValidate, 'sequence'),
-  order: _.partial(schemaValidate, 'order'),
-  orderbook: _.partial(schemaValidate, 'orderbook'),
-  payment: _.partial(schemaValidate, 'payment'),
-  pathfind: _.partial(schemaValidate, 'pathfind'),
-  settings: _.partial(schemaValidate, 'settings'),
-  trustline: _.partial(schemaValidate, 'trustline'),
-  txJSON: _.partial(schemaValidate, 'tx'),
-  blob: _.partial(schemaValidate, 'blob'),
-  getTransactionsOptions: _.partial(validateOptions, 'transactions-options'),
-  getSettingsOptions: _.partial(validateOptions, 'settings-options'),
-  getAccountInfoOptions: _.partial(validateOptions, 'settings-options'),
-  getTrustlinesOptions: _.partial(validateOptions, 'trustlines-options'),
-  getBalancesOptions: _.partial(validateOptions, 'trustlines-options'),
-  getOrdersOptions: _.partial(validateOptions, 'orders-options'),
-  getOrderbookOptions: _.partial(validateOptions, 'orders-options'),
-  getTransactionOptions: _.partial(validateOptions, 'transaction-options'),
-  options: _.partial(validateOptions, 'options'),
-  instructions: _.partial(schemaValidate, 'instructions')
-};

src/api/index.js

@@ -1,68 +0,0 @@
-/* @flow */
-
-'use strict';
-const _ = require('lodash');
-const core = require('./common').core;
-const server = require('./server/server');
-const connect = server.connect;
-const disconnect = server.disconnect;
-const getServerInfo = server.getServerInfo;
-const getFee = server.getFee;
-const isConnected = server.isConnected;
-const getLedgerVersion = server.getLedgerVersion;
-const getTransaction = require('./ledger/transaction');
-const getTransactions = require('./ledger/transactions');
-const getTrustlines = require('./ledger/trustlines');
-const getBalances = require('./ledger/balances');
-const getPaths = require('./ledger/pathfind');
-const getOrders = require('./ledger/orders');
-const getOrderbook = require('./ledger/orderbook');
-const getSettings = require('./ledger/settings');
-const getAccountInfo = require('./ledger/accountinfo');
-const preparePayment = require('./transaction/payment');
-const prepareTrustline = require('./transaction/trustline');
-const prepareOrder = require('./transaction/order');
-const prepareOrderCancellation = require('./transaction/ordercancellation');
-const prepareSettings = require('./transaction/settings');
-const sign = require('./transaction/sign');
-const submit = require('./transaction/submit');
-const errors = require('./common').errors;
-const convertExceptions = require('./common').convertExceptions;
-const generateWallet = convertExceptions(core.Wallet.generate);
-
-function RippleAPI(options: {}) {
-  const _options = _.assign({}, options, {automatic_resubmission: false});
-  this.remote = new core.Remote(_options);
-}
-
-RippleAPI.prototype = {
-  connect,
-  disconnect,
-  isConnected,
-  getServerInfo,
-  getFee,
-  getLedgerVersion,
-
-  getTransaction,
-  getTransactions,
-  getTrustlines,
-  getBalances,
-  getPaths,
-  getOrders,
-  getOrderbook,
-  getSettings,
-  getAccountInfo,
-
-  preparePayment,
-  prepareTrustline,
-  prepareOrder,
-  prepareOrderCancellation,
-  prepareSettings,
-  sign,
-  submit,
-
-  generateWallet,
-  errors
-};
-
-module.exports = RippleAPI;

src/api/ledger/accountinfo.js

@@ -1,34 +0,0 @@
-/* @flow */
-
-'use strict';
-const utils = require('./utils');
-const removeUndefined = require('./parse/utils').removeUndefined;
-const validate = utils.common.validate;
-const composeAsync = utils.common.composeAsync;
-
-function formatAccountInfo(response) {
-  const data = response.account_data;
-  return removeUndefined({
-    sequence: data.Sequence,
-    xrpBalance: utils.common.dropsToXrp(data.Balance),
-    ownerCount: data.OwnerCount,
-    previousInitiatedTransactionID: data.AccountTxnID,
-    previousAffectingTransactionID: data.PreviousTxnID,
-    previousAffectingTransactionLedgerVersion: data.PreviousTxnLgrSeq
-  });
-}
-
-function getAccountInfo(account, options, callback) {
-  validate.address(account);
-  validate.getAccountInfoOptions(options);
-
-  const request = {
-    account: account,
-    ledger: options.ledgerVersion
-  };
-
-  this.remote.requestAccountInfo(request,
-    composeAsync(formatAccountInfo, callback));
-}
-
-module.exports = utils.wrapCatch(getAccountInfo);

src/api/ledger/balances.js

@@ -1,39 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const async = require('async');
-const utils = require('./utils');
-const getTrustlines = require('./trustlines');
-const validate = utils.common.validate;
-const composeAsync = utils.common.composeAsync;
-
-function getTrustlineBalanceAmount(trustline) {
-  return {
-    currency: trustline.specification.currency,
-    counterparty: trustline.specification.counterparty,
-    value: trustline.state.balance
-  };
-}
-
-function formatBalances(balances) {
-  const xrpBalance = {
-    currency: 'XRP',
-    value: balances.xrp
-  };
-  return [xrpBalance].concat(
-    balances.trustlines.map(getTrustlineBalanceAmount));
-}
-
-function getBalances(account, options, callback) {
-  validate.address(account);
-  validate.getBalancesOptions(options);
-
-  const ledgerVersion = options.ledgerVersion
-                      || this.remote.getLedgerSequence();
-  async.parallel({
-    xrp: _.partial(utils.getXRPBalance, this.remote, account, ledgerVersion),
-    trustlines: _.partial(getTrustlines.bind(this), account, options)
-  }, composeAsync(formatBalances, callback));
-}
-
-module.exports = utils.wrapCatch(getBalances);

src/api/ledger/orders.js

@@ -1,36 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const utils = require('./utils');
-const validate = utils.common.validate;
-const composeAsync = utils.common.composeAsync;
-const parseAccountOrder = require('./parse/account-order');
-
-function requestAccountOffers(remote, address, ledgerVersion, options,
-    marker, limit, callback) {
-  remote.requestAccountOffers({
-    account: address,
-    marker: marker,
-    limit: utils.clamp(limit, 10, 400),
-    ledger: ledgerVersion
-  },
-  composeAsync((data) => ({
-    marker: data.marker,
-    results: data.offers.map(_.partial(parseAccountOrder, address))
-  }), callback));
-}
-
-function getOrders(account, options, callback) {
-  validate.address(account);
-  validate.getOrdersOptions(options);
-
-  const ledgerVersion = options.ledgerVersion
-                      || this.remote.getLedgerSequence();
-  const getter = _.partial(requestAccountOffers, this.remote, account,
-                           ledgerVersion, options);
-  utils.getRecursive(getter, options.limit,
-    composeAsync((orders) => _.sortBy(orders,
-      (order) => order.properties.sequence), callback));
-}
-
-module.exports = utils.wrapCatch(getOrders);

src/api/ledger/parse/pathfind.js

@@ -1,28 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const parseAmount = require('./amount');
-
-function parsePaths(paths) {
-  return paths.map(steps => steps.map(step =>
-    _.omit(step, ['type', 'type_hex'])));
-}
-
-function parsePathfind(sourceAddress: string,
-    destinationAmount: Object, pathfindResult: Object): Object {
-  return pathfindResult.alternatives.map(function(alternative) {
-    return {
-      source: {
-        address: sourceAddress,
-        amount: parseAmount(alternative.source_amount)
-      },
-      destination: {
-        address: pathfindResult.destination_account,
-        amount: destinationAmount
-      },
-      paths: JSON.stringify(parsePaths(alternative.paths_computed))
-    };
-  });
-}
-
-module.exports = parsePathfind;

src/api/ledger/pathfind.js

@@ -1,116 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const async = require('async');
-const BigNumber = require('bignumber.js');
-const utils = require('./utils');
-const validate = utils.common.validate;
-const parsePathfind = require('./parse/pathfind');
-const NotFoundError = utils.common.errors.NotFoundError;
-const composeAsync = utils.common.composeAsync;
-
-type PathFindParams = {
-  src_currencies?: Array<string>, src_account: string, dst_amount: string,
-  dst_account?: string
-}
-
-function addParams(params: PathFindParams, result: {}) {
-  return _.assign({}, result, {
-    source_account: params.src_account,
-    source_currencies: params.src_currencies,
-    destination_amount: params.dst_amount
-  });
-}
-
-type PathFind = {
-  source: {address: string, currencies: Array<string>},
-  destination: {address: string, amount: string}
-}
-
-function requestPathFind(remote, pathfind: PathFind, callback) {
-  const params: PathFindParams = {
-    src_account: pathfind.source.address,
-    dst_account: pathfind.destination.address,
-    dst_amount: utils.common.toRippledAmount(pathfind.destination.amount)
-  };
-  if (typeof params.dst_amount === 'object' && !params.dst_amount.issuer) {
-    // Convert blank issuer to sender's address
-    // (Ripple convention for 'any issuer')
-    // https://ripple.com/build/transactions/
-    //     #special-issuer-values-for-sendmax-and-amount
-    // https://ripple.com/build/ripple-rest/#counterparties-in-payments
-    params.dst_amount.issuer = params.dst_account;
-  }
-  if (pathfind.source.currencies && pathfind.source.currencies.length > 0) {
-    params.src_currencies = pathfind.source.currencies.map(amount =>
-      _.omit(utils.common.toRippledAmount(amount), 'value'));
-  }
-
-  remote.requestRipplePathFind(params,
-    composeAsync(_.partial(addParams, params), callback));
-}
-
-function addDirectXrpPath(paths, xrpBalance) {
-  // Add XRP "path" only if the source acct has enough XRP to make the payment
-  const destinationAmount = paths.destination_amount;
-  if ((new BigNumber(xrpBalance)).greaterThanOrEqualTo(destinationAmount)) {
-    paths.alternatives.unshift({
-      paths_computed: [],
-      source_amount: paths.destination_amount
-    });
-  }
-  return paths;
-}
-
-function isRippledIOUAmount(amount) {
-  // rippled XRP amounts are specified as decimal strings
-  return (typeof amount === 'object') &&
-    amount.currency && (amount.currency !== 'XRP');
-}
-
-function conditionallyAddDirectXRPPath(remote, address, paths, callback) {
-  if (isRippledIOUAmount(paths.destination_amount)
-      || !_.includes(paths.destination_currencies, 'XRP')) {
-    callback(null, paths);
-  } else {
-    utils.getXRPBalance(remote, address, undefined,
-      composeAsync(_.partial(addDirectXrpPath, paths), callback));
-  }
-}
-
-function formatResponse(pathfind, paths) {
-  if (paths.alternatives && paths.alternatives.length > 0) {
-    const address = pathfind.source.address;
-    return parsePathfind(address, pathfind.destination.amount, paths);
-  }
-  if (!_.includes(paths.destination_currencies,
-      pathfind.destination.amount.currency)) {
-    throw new NotFoundError('No paths found. ' +
-      'The destination_account does not accept ' +
-      pathfind.destination.amount.currency + ', they only accept: ' +
-      paths.destination_currencies.join(', '));
-  } else if (paths.source_currencies && paths.source_currencies.length > 0) {
-    throw new NotFoundError('No paths found. Please ensure' +
-      ' that the source_account has sufficient funds to execute' +
-      ' the payment in one of the specified source_currencies. If it does' +
-      ' there may be insufficient liquidity in the network to execute' +
-      ' this payment right now');
-  } else {
-    throw new NotFoundError('No paths found.' +
-      ' Please ensure that the source_account has sufficient funds to' +
-      ' execute the payment. If it does there may be insufficient liquidity' +
-      ' in the network to execute this payment right now');
-  }
-}
-
-function getPaths(pathfind, callback) {
-  validate.pathfind(pathfind);
-
-  const address = pathfind.source.address;
-  async.waterfall([
-    _.partial(requestPathFind, this.remote, pathfind),
-    _.partial(conditionallyAddDirectXRPPath, this.remote, address)
-  ], composeAsync(_.partial(formatResponse, pathfind), callback));
-}
-
-module.exports = utils.wrapCatch(getPaths);

src/api/ledger/settings.js

@@ -1,40 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const utils = require('./utils');
-const validate = utils.common.validate;
-const parseFields = require('./parse/fields');
-const composeAsync = utils.common.composeAsync;
-const AccountFlags = utils.common.constants.AccountFlags;
-
-function parseFlags(value) {
-  const settings = {};
-  for (const flagName in AccountFlags) {
-    if (value & AccountFlags[flagName]) {
-      settings[flagName] = true;
-    }
-  }
-  return settings;
-}
-
-function formatSettings(response) {
-  const data = response.account_data;
-  const parsedFlags = parseFlags(data.Flags);
-  const parsedFields = parseFields(data);
-  return _.assign({}, parsedFlags, parsedFields);
-}
-
-function getSettings(account, options, callback) {
-  validate.address(account);
-  validate.getSettingsOptions(options);
-
-  const request = {
-    account: account,
-    ledger: options.ledgerVersion
-  };
-
-  this.remote.requestAccountInfo(request,
-    composeAsync(formatSettings, callback));
-}
-
-module.exports = utils.wrapCatch(getSettings);

src/api/ledger/transaction.js

@@ -1,67 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const async = require('async');
-const utils = require('./utils');
-const parseTransaction = require('./parse/transaction');
-const validate = utils.common.validate;
-const errors = utils.common.errors;
-
-function attachTransactionDate(remote, tx, callback) {
-  if (tx.date) {
-    callback(null, tx);
-    return;
-  }
-  if (!tx.ledger_index) {
-    callback(new errors.NotFoundError('ledger_index not found in tx'));
-    return;
-  }
-
-  remote.requestLedger(tx.ledger_index, (error, data) => {
-    if (error) {
-      callback(new errors.NotFoundError('Transaction ledger not found'));
-    } else if (typeof data.ledger.close_time === 'number') {
-      callback(null, _.assign({date: data.ledger.close_time}, tx));
-    } else {
-      callback(new errors.ApiError('Ledger missing close_time'));
-    }
-  });
-}
-
-function isTransactionInRange(tx, options) {
-  return (!options.minLedgerVersion
-          || tx.ledger_index >= options.minLedgerVersion)
-      && (!options.maxLedgerVersion
-          || tx.ledger_index <= options.maxLedgerVersion);
-}
-
-function getTransaction(identifier, options, callback) {
-  validate.identifier(identifier);
-  validate.getTransactionOptions(options);
-
-  const remote = this.remote;
-  const maxLedgerVersion = Math.min(options.maxLedgerVersion,
-    remote.getLedgerSequence());
-
-  function callbackWrapper(error, tx) {
-    if (error instanceof errors.NotFoundError
-        && !utils.hasCompleteLedgerRange(remote,
-            options.minLedgerVersion, maxLedgerVersion)) {
-      callback(new errors.MissingLedgerHistoryError('Transaction not found,'
-        + ' but the server\'s ledger history is incomplete'));
-    } else if (!error && !isTransactionInRange(tx, options)) {
-      callback(new errors.NotFoundError('Transaction not found'));
-    } else if (error) {
-      callback(error);
-    } else {
-      callback(error, parseTransaction(tx));
-    }
-  }
-
-  async.waterfall([
-    _.partial(remote.requestTx.bind(remote), {hash: identifier, binary: false}),
-    _.partial(attachTransactionDate, remote)
-  ], callbackWrapper);
-}
-
-module.exports = utils.wrapCatch(getTransaction);

src/api/ledger/transactions.js

@@ -1,123 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const utils = require('./utils');
-const parseTransaction = require('./parse/transaction');
-const getTransaction = require('./transaction');
-const validate = utils.common.validate;
-const composeAsync = utils.common.composeAsync;
-
-function parseAccountTxTransaction(tx) {
-  // rippled uses a different response format for 'account_tx' than 'tx'
-  tx.tx.meta = tx.meta;
-  tx.tx.validated = tx.validated;
-  return parseTransaction(tx.tx);
-}
-
-function transactionFilter(address, filters, tx) {
-  if (filters.excludeFailures && tx.outcome.result !== 'tesSUCCESS') {
-    return false;
-  }
-  if (filters.types && !_.includes(filters.types, tx.type)) {
-    return false;
-  }
-  if (filters.initiated === true && tx.address !== address) {
-    return false;
-  }
-  if (filters.initiated === false && tx.address === address) {
-    return false;
-  }
-  if (filters.counterparty && tx.address !== filters.counterparty
-      && tx.Destination !== filters.counterparty) {
-    return false;
-  }
-  return true;
-}
-
-function orderFilter(options, tx) {
-  return !options.startTx || (options.earliestFirst ?
-    utils.compareTransactions(tx, options.startTx) > 0 :
-    utils.compareTransactions(tx, options.startTx) < 0);
-}
-
-function getAccountTx(remote, address, options, marker, limit, callback) {
-  const params = {
-    account: address,
-    ledger_index_min: options.minLedgerVersion || -1,
-    ledger_index_max: options.maxLedgerVersion || -1,
-    forward: options.earliestFirst,
-    binary: options.binary,
-    limit: utils.clamp(limit, 10, 400),
-    marker: marker
-  };
-
-  remote.requestAccountTx(params, (error, data) => {
-    return error ? callback(error) : callback(null, {
-      marker: data.marker,
-      results: data.transactions
-        .filter((tx) => tx.validated)
-        .map(parseAccountTxTransaction)
-        .filter(_.partial(transactionFilter, address, options))
-        .filter(_.partial(orderFilter, options))
-    });
-  });
-}
-
-function checkForLedgerGaps(remote, options, transactions) {
-  let {minLedgerVersion, maxLedgerVersion} = options;
-
-  // if we reached the limit on number of transactions, then we can shrink
-  // the required ledger range to only guarantee that there are no gaps in
-  // the range of ledgers spanned by those transactions
-  if (options.limit && transactions.length === options.limit) {
-    if (options.earliestFirst) {
-      maxLedgerVersion = _.last(transactions).outcome.ledgerVersion;
-    } else {
-      minLedgerVersion = _.last(transactions).outcome.ledgerVersion;
-    }
-  }
-
-  if (!utils.hasCompleteLedgerRange(remote, minLedgerVersion,
-      maxLedgerVersion)) {
-    throw new utils.common.errors.MissingLedgerHistoryError();
-  }
-}
-
-function formatResponse(remote, options, transactions) {
-  const compare = options.earliestFirst ? utils.compareTransactions :
-    _.rearg(utils.compareTransactions, 1, 0);
-  const sortedTransactions = transactions.sort(compare);
-  checkForLedgerGaps(remote, options, sortedTransactions);
-  return sortedTransactions;
-}
-
-function getTransactionsInternal(remote, address, options, callback) {
-  const getter = _.partial(getAccountTx, remote, address, options);
-  const format = _.partial(formatResponse, remote, options);
-  utils.getRecursive(getter, options.limit, composeAsync(format, callback));
-}
-
-function getTransactions(address, options, callback) {
-  validate.address(address);
-  validate.getTransactionsOptions(options);
-
-  const defaults = {maxLedgerVersion: this.remote.getLedgerSequence()};
-  if (options.start) {
-    getTransaction.bind(this)(options.start, {}, (error, tx) => {
-      if (error) {
-        callback(error);
-        return;
-      }
-      const ledgerVersion = tx.outcome.ledgerVersion;
-      const bound = options.earliestFirst ?
-        {minLedgerVersion: ledgerVersion} : {maxLedgerVersion: ledgerVersion};
-      const newOptions = _.assign(defaults, options, {startTx: tx}, bound);
-      getTransactionsInternal(this.remote, address, newOptions, callback);
-    });
-  } else {
-    const newOptions = _.assign(defaults, options);
-    getTransactionsInternal(this.remote, address, newOptions, callback);
-  }
-}
-
-module.exports = utils.wrapCatch(getTransactions);

src/api/ledger/trustlines.js

@@ -1,45 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const utils = require('./utils');
-const validate = utils.common.validate;
-const parseAccountTrustline = require('./parse/account-trustline');
-
-function currencyFilter(currency, trustline) {
-  return currency === null || trustline.specification.currency === currency;
-}
-
-function getAccountLines(remote, address, ledgerVersion, options, marker, limit,
-    callback) {
-  const requestOptions = {
-    account: address,
-    ledger: ledgerVersion,
-    marker: marker,
-    limit: utils.clamp(limit, 10, 400),
-    peer: options.counterparty
-  };
-
-  remote.requestAccountLines(requestOptions, (error, data) => {
-    return error ? callback(error) :
-      callback(null, {
-        marker: data.marker,
-        results: data.lines.map(parseAccountTrustline)
-          .filter(_.partial(currencyFilter, options.currency || null))
-      });
-  });
-}
-
-function getTrustlines(account: string, options: {currency: string,
-    counterparty: string, limit: number, ledgerVersion: number},
-    callback: () => void): void {
-  validate.address(account);
-  validate.getTrustlinesOptions(options);
-
-  const ledgerVersion = options.ledgerVersion
-                      || this.remote.getLedgerSequence();
-  const getter = _.partial(getAccountLines, this.remote, account,
-                           ledgerVersion, options);
-  utils.getRecursive(getter, options.limit, callback);
-}
-
-module.exports = utils.wrapCatch(getTrustlines);

src/api/ledger/utils.js

@@ -1,98 +0,0 @@
-'use strict';
-const _ = require('lodash');
-const assert = require('assert');
-const common = require('../common');
-const dropsToXrp = common.dropsToXrp;
-const composeAsync = common.composeAsync;
-
-function clamp(value, min, max) {
-  assert(min <= max, 'Illegal clamp bounds');
-  return Math.min(Math.max(value, min), max);
-}
-
-function getXRPBalance(remote, address, ledgerVersion, callback) {
-  remote.requestAccountInfo({account: address, ledger: ledgerVersion},
-    composeAsync((data) => dropsToXrp(data.account_data.Balance), callback));
-}
-
-// If the marker is omitted from a response, you have reached the end
-// getter(marker, limit, callback), callback(error, {marker, results})
-function getRecursiveRecur(getter, marker, limit, callback) {
-  getter(marker, limit, (error, data) => {
-    if (error) {
-      return callback(error);
-    }
-    const remaining = limit - data.results.length;
-    if (remaining > 0 && data.marker !== undefined) {
-      getRecursiveRecur(getter, data.marker, remaining, (_error, results) => {
-        return _error ? callback(_error) :
-          callback(null, data.results.concat(results));
-      });
-    } else {
-      return callback(null, data.results.slice(0, limit));
-    }
-  });
-}
-
-function getRecursive(getter, limit, callback) {
-  getRecursiveRecur(getter, undefined, limit || Infinity, callback);
-}
-
-function renameCounterpartyToIssuer(amount) {
-  if (amount === undefined) {
-    return undefined;
-  }
-  const issuer = amount.counterparty === undefined ?
-    amount.issuer : amount.counterparty;
-  const withIssuer = _.assign({}, amount, {issuer: issuer});
-  return _.omit(withIssuer, 'counterparty');
-}
-
-function renameCounterpartyToIssuerInOrder(order) {
-  const taker_gets = renameCounterpartyToIssuer(order.taker_gets);
-  const taker_pays = renameCounterpartyToIssuer(order.taker_pays);
-  const changes = {taker_gets: taker_gets, taker_pays: taker_pays};
-  return _.assign({}, order, _.omit(changes, _.isUndefined));
-}
-
-function signum(num) {
-  return (num === 0) ? 0 : (num > 0 ? 1 : -1);
-}
-
-/**
- *  Order two rippled transactions based on their ledger_index.
- *  If two transactions took place in the same ledger, sort
- *  them based on TransactionIndex
- *  See: https://ripple.com/build/transactions/
- *
- *  @param {Object} first
- *  @param {Object} second
- *  @returns {Number} [-1, 0, 1]
- */
-
-function compareTransactions(first, second) {
-  if (first.ledgerVersion === second.ledgerVersion) {
-    return signum(Number(first.indexInLedger) - Number(second.indexInLedger));
-  }
-  return Number(first.ledgerVersion) < Number(second.ledgerVersion) ? -1 : 1;
-}
-
-function hasCompleteLedgerRange(remote, minLedgerVersion, maxLedgerVersion) {
-  const firstLedgerVersion = 32570; // earlier versions have been lost
-  return remote.getServer().hasLedgerRange(
-    minLedgerVersion || firstLedgerVersion,
-    maxLedgerVersion || remote.getLedgerSequence());
-}
-
-module.exports = {
-  getXRPBalance,
-  compareTransactions,
-  renameCounterpartyToIssuer,
-  renameCounterpartyToIssuerInOrder,
-  getRecursive,
-  hasCompleteLedgerRange,
-  wrapCatch: common.wrapCatch,
-  clamp: clamp,
-  common: common
-};
-

src/api/server/server.js

@@ -1,53 +0,0 @@
-/* @flow */
-
-'use strict';
-
-const common = require('../common');
-
-// If a ledger is not received in this time, consider the connection offline
-const CONNECTION_TIMEOUT = 1000 * 30;
-
-function connect(callback: (err: any, data: any) => void): void {
-  this.remote.connect(callback);
-}
-
-function disconnect(callback: (err: any, data: any) => void): void {
-  this.remote.disconnect(callback);
-}
-
-function isUpToDate(remote): boolean {
-  const server = remote.getServer();
-  return Boolean(server) && (remote._stand_alone
-    || (Date.now() - server._lastLedgerClose) <= CONNECTION_TIMEOUT);
-}
-
-function isConnected(): boolean {
-  return Boolean(this.remote._ledger_current_index) && isUpToDate(this.remote);
-}
-
-function getServerInfo(callback: (err: any, data: any) => void): void {
-  this.remote.requestServerInfo((error, response) => {
-    if (error) {
-      callback(new common.errors.RippledNetworkError(error.message));
-    } else {
-      callback(null, response.info);
-    }
-  });
-}
-
-function getFee(): number {
-  return common.dropsToXrp(this.remote.createTransaction()._computeFee());
-}
-
-function getLedgerVersion(): number {
-  return this.remote.getLedgerSequence();
-}
-
-module.exports = {
-  connect,
-  disconnect,
-  isConnected,
-  getServerInfo,
-  getFee,
-  getLedgerVersion
-};

src/api/transaction/order.js

@@ -1,38 +0,0 @@
-/* @flow */
-'use strict';
-const utils = require('./utils');
-const validate = utils.common.validate;
-const Transaction = utils.common.core.Transaction;
-
-const OfferCreateFlags = {
-  passive: {set: 'Passive'},
-  immediateOrCancel: {set: 'ImmediateOrCancel'},
-  fillOrKill: {set: 'FillOrKill'}
-};
-
-function createOrderTransaction(account, order) {
-  validate.address(account);
-  validate.order(order);
-
-  const transaction = new Transaction();
-  const takerPays = utils.common.toRippledAmount(order.direction === 'buy' ?
-    order.quantity : order.totalPrice);
-  const takerGets = utils.common.toRippledAmount(order.direction === 'buy' ?
-    order.totalPrice : order.quantity);
-
-  transaction.offerCreate(account, takerPays, takerGets);
-
-  utils.setTransactionBitFlags(transaction, order, OfferCreateFlags);
-  if (order.direction === 'sell') {
-    transaction.setFlags('Sell');
-  }
-
-  return transaction;
-}
-
-function prepareOrder(account, order, instructions, callback) {
-  const transaction = createOrderTransaction(account, order);
-  utils.createTxJSON(transaction, this.remote, instructions, callback);
-}
-
-module.exports = utils.wrapCatch(prepareOrder);

src/api/transaction/ordercancellation.js

@@ -1,21 +0,0 @@
-/* @flow */
-'use strict';
-const utils = require('./utils');
-const validate = utils.common.validate;
-const Transaction = utils.common.core.Transaction;
-
-function createOrderCancellationTransaction(account, sequence) {
-  validate.address(account);
-  validate.sequence(sequence);
-
-  const transaction = new Transaction();
-  transaction.offerCancel(account, sequence);
-  return transaction;
-}
-
-function prepareOrderCancellation(account, sequence, instructions, callback) {
-  const transaction = createOrderCancellationTransaction(account, sequence);
-  utils.createTxJSON(transaction, this.remote, instructions, callback);
-}
-
-module.exports = utils.wrapCatch(prepareOrderCancellation);

src/api/transaction/payment.js

@@ -1,93 +0,0 @@
-/* @flow */
-'use strict';
-const _ = require('lodash');
-const BigNumber = require('bignumber.js');
-const utils = require('./utils');
-const validate = utils.common.validate;
-const toRippledAmount = utils.common.toRippledAmount;
-const Transaction = utils.common.core.Transaction;
-
-function isSendMaxAllowed(payment) {
-  const srcAmt = payment.source.amount;
-  const dstAmt = payment.destination.amount;
-
-  // Don't set SendMax for XRP->XRP payment
-  // temREDUNDANT_SEND_MAX removed in:
-  // https://github.com/ripple/rippled/commit/
-  //  c522ffa6db2648f1d8a987843e7feabf1a0b7de8/
-  return srcAmt && !(srcAmt.currency === 'XRP' && dstAmt.currency === 'XRP');
-}
-
-function isIOUWithoutCounterparty(amount) {
-  return amount && amount.currency !== 'XRP'
-    && amount.counterparty === undefined;
-}
-
-function applyAnyCounterpartyEncoding(payment) {
-  // Convert blank counterparty to sender or receiver's address
-  //   (Ripple convention for 'any counterparty')
-  // https://ripple.com/build/transactions/
-  //    #special-issuer-values-for-sendmax-and-amount
-  // https://ripple.com/build/ripple-rest/#counterparties-in-payments
-  if (isIOUWithoutCounterparty(payment.source.amount)) {
-    payment.source.amount.counterparty = payment.source.address;
-  }
-  if (isIOUWithoutCounterparty(payment.destination.amount)) {
-    payment.destination.amount.counterparty = payment.destination.address;
-  }
-}
-
-function createPaymentTransaction(account, payment) {
-  applyAnyCounterpartyEncoding(payment);
-  validate.address(account);
-  validate.payment(payment);
-
-  const transaction = new Transaction();
-  transaction.payment({
-    from: payment.source.address,
-    to: payment.destination.address,
-    amount: toRippledAmount(payment.destination.amount)
-  });
-
-  if (payment.invoiceID) {
-    transaction.invoiceID(payment.invoiceID);
-  }
-  if (payment.source.tag) {
-    transaction.sourceTag(payment.source.tag);
-  }
-  if (payment.destination.tag) {
-    transaction.destinationTag(payment.destination.tag);
-  }
-  if (payment.paths) {
-    transaction.paths(JSON.parse(payment.paths));
-  }
-  if (payment.memos) {
-    _.forEach(payment.memos, memo =>
-      transaction.addMemo(memo.type, memo.format, memo.data)
-    );
-  }
-  if (payment.allowPartialPayment) {
-    transaction.setFlags(['PartialPayment']);
-  }
-  if (payment.noDirectRipple) {
-    transaction.setFlags(['NoRippleDirect']);
-  }
-  if (payment.limitQuality) {
-    transaction.setFlags(['LimitQuality']);
-  }
-  if (isSendMaxAllowed(payment)) {
-    const maxValue = new BigNumber(payment.source.amount.value)
-      .plus(payment.source.slippage || 0).toString();
-    const maxAmount = _.assign({}, payment.source.amount, {value: maxValue});
-    transaction.sendMax(toRippledAmount(maxAmount));
-  }
-
-  return transaction;
-}
-
-function preparePayment(account, payment, instructions, callback) {
-  const transaction = createPaymentTransaction(account, payment);
-  utils.createTxJSON(transaction, this.remote, instructions, callback);
-}
-
-module.exports = utils.wrapCatch(preparePayment);

src/api/transaction/sign.js

@@ -1,68 +0,0 @@
-/* @flow */
-'use strict';
-const utils = require('./utils');
-const core = utils.common.core;
-const validate = utils.common.validate;
-
-/**
- * These prefixes are inserted before the source material used to
- * generate various hashes. This is done to put each hash in its own
- * "space." This way, two different types of objects with the
- * same binary data will produce different hashes.
- *
- * Each prefix is a 4-byte value with the last byte set to zero
- * and the first three bytes formed from the ASCII equivalent of
- * some arbitrary string. For example "TXN".
- */
-const HASH_TX_ID = 0x54584E00; // 'TXN'
-const HASH_TX_SIGN = 0x53545800; // 'STX'
-const HASH_TX_SIGN_TESTNET = 0x73747800; // 'stx'
-
-function getKeyPair(address, secret) {
-  return core.Seed.from_json(secret).get_key(address);
-}
-
-function getPublicKeyHex(keypair) {
-  return keypair.to_hex_pub();
-}
-
-function serialize(txJSON) {
-  return core.SerializedObject.from_json(txJSON);
-}
-
-function hashSerialization(serialized, prefix) {
-  return serialized.hash(prefix || HASH_TX_ID).to_hex();
-}
-
-function hashJSON(txJSON, prefix) {
-  return hashSerialization(serialize(txJSON), prefix);
-}
-
-function signingHash(txJSON, isTestNet=false) {
-  return hashJSON(txJSON, isTestNet ? HASH_TX_SIGN_TESTNET : HASH_TX_SIGN);
-}
-
-function computeSignature(txJSON, keypair) {
-  const signature = keypair.sign(signingHash(txJSON));
-  return core.sjcl.codec.hex.fromBits(signature).toUpperCase();
-}
-
-function sign(txJSON: {Account: string; SigningPubKey: string,
-    TxnSignature: string}, secret: string):
-    {signedTransaction: string; id: string} {
-  validate.txJSON(txJSON);
-  validate.addressAndSecret({address: txJSON.Account, secret: secret});
-
-  const keypair = getKeyPair(txJSON.Account, secret);
-  if (txJSON.SigningPubKey === undefined) {
-    txJSON.SigningPubKey = getPublicKeyHex(keypair);
-  }
-  txJSON.TxnSignature = computeSignature(txJSON, keypair);
-  const serialized = serialize(txJSON);
-  return {
-    signedTransaction: serialized.to_hex(),
-    id: hashSerialization(serialized, HASH_TX_ID)
-  };
-}
-
-module.exports = sign;

src/api/transaction/submit.js

@@ -1,15 +0,0 @@
-/* @flow */
-'use strict';
-const utils = require('./utils');
-const validate = utils.common.validate;
-const Request = utils.common.core.Request;
-
-function submit(tx_blob: string,
-    callback: (err: any, data: any) => void): void {
-  validate.blob(tx_blob);
-  const request = new Request(this.remote, 'submit');
-  request.message.tx_blob = tx_blob;
-  request.request(null, callback);
-}
-
-module.exports = submit;