Bump version to 0.14.0

Allow memos on all transaction types

HISTORY.md

@@ -1,12 +1,38 @@
-##0.13.0 (release candidate)
+##0.14.0
+**Breaking Changes**
++ [prepareOrderCancellation now takes orderCancellation specification](https://github.com/ripple/ripple-lib/commit/7f33d8a71e56289e5a5e0ead1c74f75ebcde72bc)
++ [Rename "ledgerClosed" event to "ledger" and change format](https://github.com/ripple/ripple-lib/commit/8a3d4a64db5fbf560ebf87dc62e0212513c5e18a)
+
+**Changes**
++ [Fix proxy support and add support for proxy authorization](https://github.com/ripple/ripple-lib/commit/14b840f3feca758e0384b746c94e36d8bf59b8c2)
++ [Fix trace option](https://github.com/ripple/ripple-lib/commit/af620755c53556c55eed12de4b0013ef5a349ce2)
++ [Allow memos on all transaction types](https://github.com/ripple/ripple-lib/commit/b5081344da8e66fbd3a5113cc3313325ef72a494)
++ [Add documentation for RippleAPI options](https://github.com/ripple/ripple-lib/commit/a76b554cadb9f9f918b06f8386bc29355682a1a4)
++ [Docs: more on basic types, tx types](https://github.com/ripple/ripple-lib/commit/fdbac63f466b4fd3be701d4878800d856692e26e)
++ [Docs: revised introductory material](https://github.com/ripple/ripple-lib/commit/ef2515507dbd3c6a426ab5b31332a1bdf72d5b2d)
++ [boost coverage to almost 100%](https://github.com/ripple/ripple-lib/commit/995606b1e6f3643af34d9fd442ccd31f320b03eb)
+
+##0.13.2
+
+**Changes**
++ [Fix: Specify send_max when pathfinding with a source amount](https://github.com/ripple/ripple-lib/commit/75142139184625c8b9fcc480b1825d9985337813)
+
+##0.13.1
++ [Add documentation for API events](https://github.com/ripple/ripple-lib/commit/25d1ac0c5f95cad32ea4ceebb))
+
+**Changes**
++ [Fix: Add babel-polyfill](https://github.com/ripple/ripple-lib/commit/8a53abc32f6ec6c7d50cd182492d6fb511b86704)
++ [Fix: Bump version on ripple-hashes](https://github.com/ripple/ripple-lib/commit/12e5765c64aea31b3c2fb65ff989cf01e6368f58)
+
+##0.13.0
 
 **Breaking Changes**
-+ [Removed timeout method of Request and added default timeout](https://github.com/ripple/ripple-lib/commit/634fe5683a9082e57682ff7d5c4fb9483b4af818)
-+ Add new RippleAPI interface
++ 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)
@@ -18,6 +44,10 @@
 + [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)

README.md

@@ -20,7 +20,7 @@ Install `ripple-lib` using npm:
   $ npm install ripple-lib
 ```
 
-Then see the sample code in `docs/samples`.
+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
 
@@ -28,6 +28,10 @@ Then see the sample code in `docs/samples`.
 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/`)
 
+##Generating Documentation
+
+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`.
+
 ##More Information
 
 + [Ripple Dev Portal](https://ripple.com/build/)

docs/api.html

@@ -1,358 +0,0 @@
-<html>
-<head>
-<style>
-a {
-  text-decoration: none;
-}
-.method {
-  margin-bottom: 10px;
-}
-.details {
-  font-family: "Courier New", monospace;
-  white-space: pre;
-  display: none;
-}
-</style>
-<script type="text/javascript">
-function toggle(element) {
-  var results = element.parentElement.getElementsByClassName('details');
-  if (results.length > 0) {
-    var style = results[0].style;
-    style.display = (style.display === 'block') ? 'none' : 'block';
-  }
-}
-</script>
-</head>
-<body>
-
-<h2><a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/index.js">RippleAPI</a></h2>
-
-<div class="method">
-connect()
-</div>
-
-<div class="method">
-disconnect()
-</div>
-
-<div class="method">
-isConnected()
-</div>
-
-<div class="method">
-getServerInfo()
-</div>
-
-<div class="method">
-getFee()
-</div>
-
-<div class="method">
-getLedgerVersion()
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-transaction.json">getTransaction</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/hash256.json">identifier</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/transaction-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  identifier: txhash
-  options: {minLedgerVersion: int, maxLedgerVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-transactions.json">getTransactions</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/transactions-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  options: {
-    start: txhash,
-    limit: int,
-    minLedgerVersion: int,
-    maxLedgerVersion: int,
-    earliestFirst: bool,
-    excludeFailures: bool,
-    initiated: bool,
-    counterparty: address,
-    types: [string],
-    binary: bool
-  }
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-trustlines.json">getTrustlines</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/trustlines-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  options: {counterparty: address, currency: string, limit: int, ledgerVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-balances.json">getBalances</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/trustlines-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  options: {counterparty: address, currency: string, limit: int, ledgerVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-paths.json">getPaths</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/pathfind.json">pathfind</a>
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  pathfind: {
-    source: {
-      address: address,
-      currencies: [{
-        currency: string,
-        counterparty: address
-      }]
-    },
-    destination: adjustment
-  }
-
-  adjustment = {address: address, amount: amount, tag?: int}
-  amount = {currency: string, counterparty: address, value: floatstr}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-orders.json">getOrders</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/orders-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  options: {limit: int, ledverVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-orderbook.json">getOrderbook</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/orderbook.json">orderbook</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/orders-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  orderbook: {
-    base: {
-      currency,
-      counterparty
-    },
-    counter: {
-      currency,
-      counterparty
-    }
-  }
-  options: {limit: int, ledverVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-settings.json">getSettings</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/settings-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  options: {ledgerVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/get-account-info.json">getAccountInfo</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/settings-options.json">options</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  options: {ledgerVersion: int}
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/tx.json">preparePayment</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/payment.json">payment</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/instructions.json">instructions</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  payment: {
-    source: adjustment,
-    destination: adjustment,
-    paths?: string,
-    slippage?: strfloat,
-    memos?: [{
-      type: string,
-      format: string,
-      data: string
-    }],
-    invoiceID?: hash256,
-    allowPartialPayment?: bool,
-    noDirectRipple?: bool,
-    limitQuality?: bool
-  }
-
-  adjustment = {address: address, amount: amount, tag?: int}
-  amount = {currency: string, counterparty: address, value: floatstr}
-
-  instructions: {
-    sequence: int,
-    fee: floatstr,
-    maxFee: floatstr,
-    maxLedgerVersion: int,
-    maxLedgerVersionOffset: int
-  }
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/tx.json">prepareTrustline</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/trustline.json">trustline</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/instructions.json">instructions</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  trustline: {
-    currency: string,
-    counterparty: address,
-    limit: strfloat,
-    qualityIn?: float,
-    qualityOut?: float,
-    allowRippling?: bool,
-    authorized?: bool,
-    frozen?: bool
-  }
-
-  instructions: {
-    sequence: int,
-    fee: floatstr,
-    maxFee: floatstr,
-    maxLedgerVersion: int,
-    maxLedgerVersionOffset: int
-  }
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/tx.json">prepareOrder</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/order.json">order</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/instructions.json">instructions</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  order: {
-    direction: ("buy"|"sell"),
-    quantity: amount,
-    totalPrice: amount,
-    immediateOrCancel?: bool,
-    fillOrKill?: bool,
-    passive?: bool
-  }
-
-  amount = {currency: string, counterparty: address, value: floatstr}
-
-  instructions: {
-    sequence: int,
-    fee: floatstr,
-    maxFee: floatstr,
-    maxLedgerVersion: int,
-    maxLedgerVersionOffset: int
-  }
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/tx.json">prepareOrderCancellation</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/sequence.json">sequence</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/instructions.json">instructions</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  sequence: int
-
-  instructions: {
-    sequence: int,
-    fee: floatstr,
-    maxFee: floatstr,
-    maxLedgerVersion: int,
-    maxLedgerVersionOffset: int
-  }
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/tx.json">prepareSettings</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/address.json">account</a>,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/settings.json">settings</a>[,
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/instructions.json">instructions</a>]
-)
-<a href="#" onclick="javascript:toggle(this)">+</a>
-<div class="details">
-  settings: {
-    passwordSpent: bool,
-    requireDestinationTag: bool,
-    requireAuthorization: bool,
-    disallowIncomingXRP: bool,
-    disableMasterKey: bool,
-    enableTransactionIDTracking: bool,
-    noFreeze: bool,
-    globalFreeze: bool,
-    defaultRipple: bool,
-    emailHash: hash128,
-    walletLocator: hash256,
-    walletSize: int,
-    messageKey: string,
-    domain: string,
-    transferRate: float,
-    signers: string,
-    regularKey: address
-  }
-
-  instructions: {
-    sequence: int,
-    fee: floatstr,
-    maxFee: floatstr,
-    maxLedgerVersion: int,
-    maxLedgerVersionOffset: int
-  }
-</div>
-</div>
-
-<div class="method">
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/sign.json">sign</a>(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/tx.json">txJSON</a>,
-secret)
-</div>
-
-<div class="method">
-submit(
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/schemas/blob.json">txBlob</a>
-)
-</div>
-
-<div class="method">
-generateWallet()
-</div>
-
-<a href="https://github.com/ripple/ripple-lib/blob/develop/src/api/common/errors.js">errors</a>
-</body>
-</html>

docs/src/basictypes.md.ejs

@@ -0,0 +1,55 @@
+# 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. Ripple addresses always start with the lowercase letter `r`.
+
+## Account Sequence Number
+
+Every Ripple account has a *sequence number* that is used to keep transactions in order. Every transaction must have a sequence number. A transaction can only be executed if it has the next sequence number in order, of the account sending it. 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. Be careful: JavaScript's native number format does not have sufficient precision to represent all values. XRP has different precision from other currencies.
+
+**XRP** has 6 significant digits past the decimal point. In other words, XRP cannot be divided into positive values smaller than `0.000001` (1e-6). XRP has a maximum value of `100000000000` (1e11).
+
+**Non-XRP values** have 15 decimal digits of precision, with a maximum value of `9999999999999999e80`. The smallest positive non-XRP value is `1e-81`.
+
+
+## Amount
+
+Example amount:
+
+```json
+{
+  "currency": "USD",
+  "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
+  "value": "100"
+}
+```
+
+Example XRP amount:
+```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 XRP, there is no counterparty.
+
+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,49 @@
+## Boilerplate
+
+Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI.
+
+```javascript
+const {RippleAPI} = require('ripple-lib');
+
+const api = new RippleAPI({
+  servers: ['wss://s1.ripple.com'] //Public rippled server hosted by Ripple, Inc.
+});
+api.connect().then(() => {
+  /* insert code here */
+}).then(() => {
+  return api.disconnect();
+}).catch(console.error);
+```
+
+RippleAPI is designed to work in [NodeJS](https://nodejs.org) (version `0.12.0` or greater) using [Babel](https://babeljs.io/) for [ECMAScript 6](https://babeljs.io/docs/learn-es2015/) support.
+
+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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise_).
+
+<aside class="notice">
+All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
+</aside>
+
+<aside class="notice">
+If you omit the "catch" section, errors may not be visible.
+</aside>
+
+### Parameters
+
+<%- renderSchema('input/api-options.json') %>
+
+
+### Installation ###
+
+1. Install [NodeJS](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for NodeJS, but make sure you have version `0.12.0` or higher.
+2. Use npm to install [Babel](https://babeljs.io/) globally:
+      `npm install -g babel`
+3. Use npm to install RippleAPI:
+      `npm install ripple-lib`
+
+After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using babel-node:
+      `babel-node script.js`
+
+<aside class="notice">
+Instead of using babel-node in production, we recommend using Babel to transpile to ECMAScript 5 first.
+</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
+
+## ledger
+
+This event is emitted whenever a new ledger version is validated on the connected server.
+
+### Return Value
+
+<%- renderSchema('output/ledger-event.json') %>
+
+### Example
+
+```javascript
+api.on('ledger', ledger => {
+  console.log(JSON.stringify(ledger, null, 2));
+});
+```
+
+<%- renderFixture('responses/ledger-event.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,12 @@
+# Introduction
+
+RippleAPI is the official client library to the Ripple Consensus Ledger. Currently, RippleAPI is only available in JavaScript. 
+Using RippleAPI, you can:
+
+* [Query transactions from the network](#gettransaction)
+* [Sign](#sign) transactions securely without connecting to any server
+* [Submit](#submit) transactions to the Ripple Consensus Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types)
+* [Generate a new Ripple Address](#generateaddress)
+* ... and [much more](#api-methods).
+
+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 orderCancellation = {orderSequence: 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,63 @@
+# 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](https://ripple.com/build/paths/) 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). There is a method to prepare each type of transaction:
+    * [preparePayment](#preparepayment)
+    * [prepareTrustline](#preparetrustline)
+    * [prepareOrder](#prepareorder)
+    * [prepareOrderCancellation](#prepareordercancellation)
+    * [prepareSettings](#preparesettings)
+    * [prepareSuspendedPaymentCreation](#preparesuspendedpaymentcreation)
+    * [prepareSuspendedPaymentCancellation](#preparesuspendedpaymentcancellation)
+    * [prepareSuspendedPaymentExecution](#preparesuspendedpaymentexecution)
+2. [Sign](#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) - 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.
+
+## Transaction Fees
+
+Every transaction must destroy a small amount of XRP as a cost to send the transaction. This is also called a *transaction fee*. The transaction cost is designed to increase along with the load on the Ripple network, making it very expensive to deliberately or inadvertently overload the network.
+
+You can choose the size of the fee you want to pay or let a default be used. You can get an estimate of the fee required to be included in the next ledger closing with the [getFee](#getfee) method.
+
+## Transaction Instructions
+
+Transaction instructions indicate how to execute a transaction, complementary with the [transaction specification](#transaction-specifications).
+
+<%- renderSchema("objects/instructions.json") %>
+
+We recommended that you specify a `maxLedgerVersion` 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 transaction's `maxLedgerVersion`.
+
+## Transaction ID
+
+```json
+"F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF"
+```
+
+A transaction ID is a 64-bit hexadecimal string that uniquely identifies the transaction. The transaction ID is derived from the transaction instruction and specifications, using a strong hash function.
+
+You can look up a transaction by ID using the [getTransaction](#gettransaction) method.
+
+## Transaction Memos
+
+Every transaction can optionally have an array of memos for user applications. The `memos` field in each [transaction specification](#transaction-specifications) is an array of objects with the following structure:
+
+<%- renderSchema('objects/memos.json') %>

npm-shrinkwrap.json

@@ -1,93 +1,126 @@
 {
   "name": "ripple-lib",
-  "version": "0.13.0-rc16",
-  "npm-shrinkwrap-version": "5.4.0",
-  "node-version": "v0.12.7",
+  "version": "0.14.0",
   "dependencies": {
     "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-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": "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.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.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": "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"
         }
       }
     },
     "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": {
         "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"
             }
           }
         },
         "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"
             }
           }
@@ -95,97 +128,77 @@
       }
     },
     "ripple-binary-codec": {
-      "version": "0.0.7",
-      "resolved": "https://registry.npmjs.org/ripple-binary-codec/-/ripple-binary-codec-0.0.7.tgz",
+      "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": {
-        "babel-runtime": {
-          "version": "5.8.34",
-          "resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-5.8.34.tgz",
-          "dependencies": {
-            "core-js": {
-              "version": "1.2.6",
-              "resolved": "https://registry.npmjs.org/core-js/-/core-js-1.2.6.tgz"
-            }
-          }
-        },
         "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"
-        },
-        "lodash": {
-          "version": "3.10.1",
-          "resolved": "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz"
-        },
-        "ripple-address-codec": {
-          "version": "2.0.1",
-          "resolved": "https://registry.npmjs.org/ripple-address-codec/-/ripple-address-codec-2.0.1.tgz",
-          "dependencies": {
-            "hash.js": {
-              "version": "1.0.3",
-              "resolved": "https://registry.npmjs.org/hash.js/-/hash.js-1.0.3.tgz"
-            },
-            "x-address-codec": {
-              "version": "0.7.2",
-              "resolved": "https://registry.npmjs.org/x-address-codec/-/x-address-codec-0.7.2.tgz",
-              "dependencies": {
-                "base-x": {
-                  "version": "1.0.1",
-                  "resolved": "https://registry.npmjs.org/base-x/-/base-x-1.0.1.tgz"
-                }
-              }
-            }
-          }
         }
       }
     },
     "ripple-hashes": {
-      "version": "0.0.1",
-      "resolved": "https://registry.npmjs.org/ripple-hashes/-/ripple-hashes-0.0.1.tgz",
+      "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"
             }
           }
@@ -194,32 +207,39 @@
     },
     "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"
             }
           }
@@ -228,19 +248,57 @@
     },
     "ripple-lib-transactionparser": {
       "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": {
         "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"
+        },
+        "bufferutil": {
+          "version": "1.1.0",
+          "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-rc16",
+  "version": "0.14.0",
   "license": "ISC",
   "description": "A JavaScript API for interacting with Ripple in Node.js and the browser",
   "files": [
@@ -16,16 +16,17 @@
   },
   "dependencies": {
     "ajv": "^1.4.8",
+    "babel-polyfill": "^6.2.0",
     "babel-runtime": "^5.5.4",
     "bignumber.js": "^2.0.3",
     "https-proxy-agent": "^1.0.0",
     "lodash": "^3.1.0",
     "ripple-address-codec": "^2.0.1",
-    "ripple-binary-codec": "^0.0.7",
-    "ripple-hashes": "^0.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"
+    "ws": "^0.7.1"
   },
   "devDependencies": {
     "assert-diff": "^1.0.1",
@@ -33,23 +34,28 @@
     "babel-core": "^5.8.22",
     "babel-eslint": "^4.1.3",
     "babel-loader": "^5.3.2",
-    "coveralls": "~2.10.0",
+    "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.14",
-    "gulp": "~3.8.10",
-    "gulp-bump": "~0.1.13",
-    "gulp-rename": "~1.2.0",
-    "gulp-uglify": "~1.1.0",
-    "istanbul": "~0.3.5",
+    "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",
-    "mocha": "~2.1.0",
-    "webpack": "~1.5.3",
-    "yargs": "~1.3.1"
+    "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 -D --optional runtime -d dist/npm/ src/",

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

@@ -36,7 +36,17 @@ 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
@@ -45,15 +55,15 @@ oneNode() {
 
 twoNodes() {
   case "$NODE_INDEX" in
-    0) lint && integrationtest;;
-    1) typecheck && unittest;;
+    0) doctest; lint; integrationtest;;
+    1) typecheck; unittest;;
     *) echo "ERROR: invalid usage"; exit 2;;
   esac
 }
 
 threeNodes() {
   case "$NODE_INDEX" in
-    0) lint && integrationtest;;
+    0) doctest; lint; integrationtest;;
     1) typecheck;;
     2) unittest;;
     *) echo "ERROR: invalid usage"; exit 2;;

src/common/connection.js

@@ -16,8 +16,11 @@ class Connection extends EventEmitter {
   constructor(url, options = {}) {
     super();
     this._url = url;
-    this._proxyURL = options.proxyURL;
+    this._trace = options.trace;
+    this._proxyURL = options.proxy;
+    this._proxyAuthorization = options.proxyAuthorization;
     this._authorization = options.authorization;
+    this._trustedCertificates = options.trustedCertificates;
     this._timeout = options.timeout || (20 * 1000);
     this._isReady = false;
     this._ws = null;
@@ -50,6 +53,9 @@ class Connection extends EventEmitter {
 
   _onMessage(message) {
     let parameters;
+    if (this._trace) {
+      console.log(message);
+    }
     try {
       parameters = this._parseMessage(message);
     } catch (error) {
@@ -74,6 +80,7 @@ class Connection extends EventEmitter {
   }
 
   _onUnexpectedClose() {
+    this._ws = null;
     this._isReady = false;
     this.connect().then();
   }
@@ -92,12 +99,18 @@ class Connection extends EventEmitter {
     });
   }
 
-  _createWebSocket(url, proxyURL, authorization) {
+  _createWebSocket(url, proxyURL, proxyAuthorization, authorization,
+      trustedCertificates) {
     const options = {};
     if (proxyURL !== undefined) {
       const parsedURL = parseURL(url);
       const proxyOptions = parseURL(proxyURL);
       proxyOptions.secureEndpoint = (parsedURL.protocol === 'wss:');
+      proxyOptions.secureProxy = (proxyOptions.protocol === 'https:');
+      proxyOptions.auth = proxyAuthorization;
+      if (trustedCertificates) {
+        proxyOptions.ca = trustedCertificates;
+      }
       let HttpsProxyAgent;
       try {
         HttpsProxyAgent = require('https-proxy-agent');
@@ -125,9 +138,11 @@ class Connection extends EventEmitter {
         this._ws.once('open', resolve);
       } else {
         this._ws = this._createWebSocket(this._url, this._proxyURL,
-          this._authorization);
+          this._proxyAuthorization, this._authorization,
+          this._trustedCertificates);
         this._ws.on('message', this._onMessage.bind(this));
-        this._ws.once('close', () => this._onUnexpectedClose);
+        this._onUnexpectedCloseBound = this._onUnexpectedClose.bind(this);
+        this._ws.once('close', this._onUnexpectedCloseBound);
         this._ws.once('open', () => this._onOpen().then(resolve, reject));
       }
     });
@@ -140,7 +155,7 @@ class Connection extends EventEmitter {
       } else if (this._state === WebSocket.CLOSING) {
         this._ws.once('close', resolve);
       } else {
-        this._ws.removeListener('close', this._onUnexpectedClose);
+        this._ws.removeListener('close', this._onUnexpectedCloseBound);
         this._ws.once('close', () => {
           this._ws = null;
           this._isReady = false;
@@ -182,6 +197,9 @@ class Connection extends EventEmitter {
   }
 
   _send(message) {
+    if (this._trace) {
+      console.log(message);
+    }
     return new Promise((resolve, reject) => {
       this._ws.send(message, undefined, (error, result) => {
         if (error) {

src/common/schema-validator.js

@@ -43,6 +43,7 @@ function loadSchemas() {
     require('./schemas/objects/signed-value.json'),
     require('./schemas/objects/orderbook.json'),
     require('./schemas/objects/instructions.json'),
+    require('./schemas/objects/settings.json'),
     require('./schemas/specifications/settings.json'),
     require('./schemas/specifications/payment.json'),
     require('./schemas/specifications/suspended-payment-cancellation.json'),
@@ -61,7 +62,7 @@ function loadSchemas() {
     require('./schemas/output/get-orders.json'),
     require('./schemas/output/order-change.json'),
     require('./schemas/output/prepare.json'),
-    require('./schemas/output/ledger-closed.json'),
+    require('./schemas/output/ledger-event.json'),
     require('./schemas/output/get-paths.json'),
     require('./schemas/output/get-server-info.json'),
     require('./schemas/output/get-settings.json'),

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

@@ -3,21 +3,49 @@
   "title": "api-options",
   "type": "object",
   "properties": {
-    "trace": {"type": "boolean"},
-    "feeCushion": {"$ref": "value"},
+    "trace": {
+      "type": "boolean",
+      "description": "If true, log rippled requests and responses to stdout."
+    },
+    "feeCushion": {
+      "type": "number",
+      "minimum": 1,
+      "description": "Factor to multiply estimated fee by to provide a cushion in case the required fee rises during submission of a transaction. Defaults to `1.2`."
+    },
     "servers": {
       "type": "array",
+      "description": "Array of rippled servers to connect to. Currently only one server is supported.",
       "items": {
         "type": "string",
+        "description": "URI for rippled websocket port. Must start with `wss://` or `ws://`.",
         "format": "uri",
         "pattern": "^wss?://"
       }
     },
     "proxy": {
-      "format": "uri"
+      "format": "uri",
+      "description": "URI for HTTP/HTTPS proxy to use to connect to the rippled server."
+    },
+    "timeout": {
+      "type": "integer",
+      "description": "Timeout in milliseconds before considering a request to have failed.",
+      "minimum": 1
+    },
+    "proxyAuthorization": {
+      "type": "string",
+      "description": "Username and password for HTTP basic authentication to the proxy in the format **username:password**."
     },
     "authorization": {
-      "type": "string"
+      "type": "string",
+      "description": "Username and password for HTTP basic authentication to the rippled server in the format **username:password**."
+    },
+    "trustedCertificates": {
+      "type": "array",
+      "description": "Array of PEM-formatted SSL certificates to trust when connecting to a proxy. This is useful if you want to use a self-signed certificate on the proxy server. Note: Each element must contain a single certificate; concatenated certificates are not valid.",
+      "items": {
+        "type": "string",
+        "description": "A PEM-formatted SSL certificate to trust when connecting to a proxy."
+      }
     }
   },
   "additionalProperties": false

src/common/schemas/input/prepare-order-cancellation.json

@@ -7,12 +7,12 @@
       "$ref": "address",
       "description": "The address of the account that is creating the transaction."
     },
-    "sequence": {
-      "$ref": "sequence",
-      "description": "The account sequence number of the transaction that created the order to cancel."
+    "orderCancellation": {
+      "$ref": "orderCancellation",
+      "description": "The specification of the order cancellation to prepare."
     },
     "instructions": {"$ref": "instructions"}
   },
   "additionalProperties": false,
-  "required": ["address", "sequence"]
+  "required": ["address", "orderCancellation"]
 }

src/common/schemas/objects/memos.json

@@ -1,6 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "memos",
+  "link": "transaction-memos",
   "description": "Array of memos to attach to the transaction.",
   "type": "array",
   "items": {

src/common/schemas/objects/settings.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "settingsPlusMemos",
+  "type": "object",
+  "properties": {
+    "passwordSpent": {
+      "type": "boolean",
+      "description": "Indicates that the account has used its free SetRegularKey transaction."
+    },
+    "requireDestinationTag": {
+      "type": "boolean",
+      "description": "Requires incoming payments to specify a destination tag."
+    },
+    "requireAuthorization": {
+      "type": "boolean",
+      "description": "If set, this account must individually approve other users in order for those users to hold this account’s issuances."
+    },
+    "disallowIncomingXRP": {
+      "type": "boolean",
+      "description": "Indicates that client applications should not send XRP to this account. Not enforced by rippled."
+    },
+    "disableMasterKey": {
+      "type": "boolean",
+      "description": "Disallows use of the master key to sign transactions for this account."
+    },
+    "enableTransactionIDTracking": {
+      "type": "boolean",
+      "description": "Track the ID of this account’s most recent transaction."
+    },
+    "noFreeze": {
+      "type": "boolean",
+      "description": "Permanently give up the ability to freeze individual trust lines. This flag can never be disabled after being enabled."
+    },
+    "globalFreeze": {
+      "type": "boolean",
+      "description": "Freeze all assets issued by this account."
+    },
+    "defaultRipple": {
+      "type": "boolean",
+      "description": "Enable [rippling](https://ripple.com/knowledge_center/understanding-the-noripple-flag/) on this account’s trust lines by default. (New in [rippled 0.27.3](https://github.com/ripple/rippled/releases/tag/0.27.3))"
+    },
+    "emailHash": {
+      "description": "Hash of an email address to be used for generating an avatar image. Conventionally, clients use Gravatar to display this image. Use `null` to clear.",
+      "oneOf": [
+        {"type": "null"},
+        {"$ref": "hash128"}
+      ]
+    },
+    "messageKey": {
+      "type": "string",
+      "description": "Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple."
+    },
+    "domain": {
+      "type": "string",
+      "description": " The domain that owns this account, as a hexadecimal string representing the ASCII for the domain in lowercase."
+    },
+    "transferRate": {
+      "description": " The fee to charge when users transfer this account’s issuances, represented as billionths of a unit. Use `null` to set no fee.",
+      "oneOf": [
+        {"type": "null"},
+        {"type": "number", "minimum": 1, "maximum": 4.294967295}
+      ]
+    },
+    "regularKey": {
+      "oneOf": [
+        {"$ref": "address"},
+        {"type": "null"}
+      ],
+      "description": "The public key of a new keypair, to use as the regular key to this account, as a base-58-encoded string in the same format as an account address. Use `null` to remove the regular key."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "additionalProperties": false
+}

src/common/schemas/output/get-server-info.json

@@ -93,12 +93,12 @@
         "reserveBaseXRP": {
           "type": "integer",
           "minimum": 0,
-          "description": "Minimum amount of XRP (not drops) necessary for every account to keep in reserve."
+          "description": "Minimum amount of XRP necessary for every account to keep in reserve."
         },
         "reserveIncrementXRP": {
           "type": "integer",
           "minimum": 0,
-          "description": "Amount of XRP (not drops) added to the account reserve for each object an account is responsible for in the ledger."
+          "description": "Amount of XRP added to the account reserve for each object an account is responsible for in the ledger."
         },
         "ledgerVersion": {
           "type": "integer",

src/common/schemas/output/get-settings.json

@@ -1,73 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "getSettings",
-  "type": "object",
-  "properties": {
-    "passwordSpent": {
-      "type": "boolean",
-      "description": "Indicates that the account has used its free SetRegularKey transaction."
-    },
-    "requireDestinationTag": {
-      "type": "boolean",
-      "description": "Requires incoming payments to specify a destination tag."
-    },
-    "requireAuthorization": {
-      "type": "boolean",
-      "description": "If set, this account must individually approve other users in order for those users to hold this account’s issuances."
-    },
-    "disallowIncomingXRP": {
-      "type": "boolean",
-      "description": "Indicates that client applications should not send XRP to this account. Not enforced by rippled."
-    },
-    "disableMasterKey": {
-      "type": "boolean",
-      "description": "Disallows use of the master key to sign transactions for this account."
-    },
-    "enableTransactionIDTracking": {
-      "type": "boolean",
-      "description": "Track the ID of this account’s most recent transaction."
-    },
-    "noFreeze": {
-      "type": "boolean",
-      "description": "Permanently give up the ability to freeze individual trust lines. This flag can never be disabled after being enabled."
-    },
-    "globalFreeze": {
-      "type": "boolean",
-      "description": "Freeze all assets issued by this account."
-    },
-    "defaultRipple": {
-      "type": "boolean",
-      "description": "Enable [rippling](https://ripple.com/knowledge_center/understanding-the-noripple-flag/) on this account’s trust lines by default. (New in [rippled 0.27.3](https://github.com/ripple/rippled/releases/tag/0.27.3))"
-    },
-    "emailHash": {
-      "description": "Hash of an email address to be used for generating an avatar image. Conventionally, clients use Gravatar to display this image. Use `null` to clear.",
-      "oneOf": [
-        {"type": "null"},
-        {"$ref": "hash128"}
-      ]
-    },
-    "messageKey": {
-      "type": "string",
-      "description": "Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple."
-    },
-    "domain": {
-      "type": "string",
-      "description": " The domain that owns this account, as a hexadecimal string representing the ASCII for the domain in lowercase."
-    },
-    "transferRate": {
-      "description": " The fee to charge when users transfer this account’s issuances, represented as billionths of a unit. Use `null` to set no fee.",
-      "oneOf": [
-        {"type": "null"},
-        {"type": "number", "minimum": 1, "maximum": 4.294967295}
-      ]
-    },
-    "regularKey": {
-      "oneOf": [
-        {"$ref": "address"},
-        {"type": "null"}
-      ],
-      "description": "The public key of a new keypair, to use as the regular key to this account, as a base-58-encoded string in the same format as an account address. Use `null` to remove the regular key."
-    }
-  },
-  "additionalProperties": false
+  "$ref": "settingsPlusMemos",
+  "not": {
+    "required": ["memos"]
+  }
 }

src/common/schemas/output/get-trustlines.json

@@ -34,7 +34,7 @@
       "state": {
         "properties": {
           "balance": {
-            "$ref": "value",
+            "$ref": "signedValue",
             "description": "The balance on the trustline, representing which party owes the other and by how much."
           }
         },

src/common/schemas/output/ledger-closed.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "ledgerClosed",
-  "description": "A ledgerClosed event message",
-  "type": "object",
-  "properties": {
-    "feeBase": {"type": "integer", "minimum": 0},
-    "feeReference": {"type": "integer", "minimum": 0},
-    "ledgerHash": {"$ref": "hash256"},
-    "ledgerVersion": {"$ref": "ledgerVersion"},
-    "ledgerTimestamp": {"type": "string", "format": "date-time"},
-    "reserveBase": {"type": "integer", "minimum": 0},
-    "reserveIncrement": {"type": "integer", "minimum": 0},
-    "transactionCount": {"type": "integer", "minimum": 0},
-    "validatedLedgerVersions": {"type": "string"}
-  },
-  "addtionalProperties": false,
-  "required": ["feeBase", "feeReference", "ledgerHash", "ledgerTimestamp",
-    "reserveBase", "reserveIncrement", "transactionCount",
-    "ledgerVersion", "validatedLedgerVersions"]
-}

src/common/schemas/output/ledger-event.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "ledgerEvent",
+  "description": "A ledger event message",
+  "type": "object",
+  "properties": {
+    "baseFeeXRP": {
+      "$ref": "value",
+      "description": "Base fee, in XRP."
+    },
+    "ledgerHash": {
+      "$ref": "hash256",
+      "description": "Unique hash of the ledger that was closed, as hex."
+    },
+    "ledgerVersion": {
+      "$ref": "ledgerVersion",
+      "description": "Ledger version of the ledger that closed."
+    },
+    "ledgerTimestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The time at which this ledger closed."
+    },
+    "reserveBaseXRP": {
+      "$ref": "value",
+      "description": "The minimum reserve, in drops of XRP, that is required for an account."
+    },
+    "reserveIncrementXRP": {
+      "$ref": "value",
+      "description": "The increase in account reserve that is added for each item the account owns, such as offers or trust lines."
+    },
+    "transactionCount": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Number of new transactions included in this ledger."
+    },
+    "validatedLedgerVersions": {
+      "type": "string",
+      "description": "Range of ledgers that the server has available. This may be discontiguous."
+    }
+  },
+  "addtionalProperties": false,
+  "required": ["baseFeeXRP", "ledgerHash", "ledgerTimestamp",
+    "reserveBaseXRP", "reserveIncrementXRP", "transactionCount",
+    "ledgerVersion", "validatedLedgerVersions"]
+}

src/common/schemas/specifications/order-cancellation.json

@@ -7,7 +7,8 @@
     "orderSequence": {
       "$ref": "sequence",
       "description": "The [account sequence number](#account-sequence-number) of the order to cancel."
-    }
+    },
+    "memos": {"$ref": "memos"}
   },
   "required": ["orderSequence"],
   "additionalProperties": false

src/common/schemas/specifications/order.json

@@ -33,7 +33,8 @@
       "type": "string",
       "format": "date-time",
       "description": "Time after which the offer is no longer active, as an [ISO 8601 date-time](https://en.wikipedia.org/wiki/ISO_8601)."
-    }
+    },
+    "memos": {"$ref": "memos"}
   },
   "required": ["direction", "quantity", "totalPrice"],
   "additionalProperties": false,

src/common/schemas/specifications/settings.json

@@ -2,11 +2,17 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "settings",
   "link": "settings",
-  "allOf": [
+  "$ref": "settingsPlusMemos",
+  "oneOf": [
     {
-      "$ref": "getSettings"
+      "required": ["memos"],
+      "minProperties": 2,
+      "maxProperties": 2
     },
     {
+      "not": {
+        "required": ["memos"]
+      },
       "minProperties": 1,
       "maxProperties": 1
     }

src/common/schemas/specifications/suspended-payment-execution.json

@@ -21,7 +21,7 @@
     },
     "digest": {
       "$ref": "hash256",
-      "description": "The original `digest` from the suspended payment creation transaction. This is sha256 hash of `proof` string."
+      "description": "The original `digest` from the suspended payment creation transaction. This is sha256 hash of `proof` string. It is replicated here so that the relatively expensive hashing operation can be delegated to a server without ledger history and the server with ledger history only has to do a quick comparison of the old digest with the new digest."
     },
     "proof": {
       "type": "string",

src/common/schemas/specifications/trustline.json

@@ -35,7 +35,8 @@
     "frozen": {
       "type": "boolean",
       "description": "If true, the trustline is frozen, which means that funds can only be sent to the owner."
-    }
+    },
+    "memos": {"$ref": "memos"}
   },
   "required": ["currency", "counterparty", "limit"],
   "additionalProperties": false

src/index.js

@@ -54,7 +54,8 @@ type APIOptions = {
   servers?: Array<string>,
   feeCushion?: number,
   trace?: boolean,
-  proxy?: string
+  proxy?: string,
+  timeout?: number
 }
 
 // prevent access to non-validated ledger versions
@@ -82,7 +83,7 @@ class RippleAPI extends EventEmitter {
       if (servers.length === 1) {
         this.connection = new RestrictedConnection(servers[0], options);
         this.connection.on('ledgerClosed', message => {
-          this.emit('ledgerClosed', server.formatLedgerClose(message));
+          this.emit('ledger', server.formatLedgerClose(message));
         });
         this.connection.on('error', (type, info) => {
           this.emit('error', type, info);

src/ledger/pathfind-types.js

@@ -1,55 +1,55 @@
-/* @flow */
-'use strict';
-
-import type {Amount, LaxLaxAmount, RippledAmount, Adjustment, MaxAdjustment,
-  MinAdjustment} from '../common/types.js';
-
-
-type Path = {
-  source: Adjustment | MaxAdjustment,
-  destination: Adjustment | MinAdjustment,
-  paths: string
-}
-
-export type GetPaths = Array<Path>
-
-export type PathFind = {
-  source: {
-    address: string,
-    amount?: Amount,
-    currencies?: Array<{currency: string, counterparty?:string}>
-  },
-  destination: {
-    address: string,
-    amount: LaxLaxAmount
-  }
-}
-
-export type PathFindRequest = {
-  command: string,
-  source_account: string,
-  destination_amount: RippledAmount,
-  destination_account: string,
-  source_amount?: RippledAmount,
-  source_currencies?: Array<string>
-}
-
-export type RippledPathsResponse = {
-  alternatives: Array<{
-    paths_computed: Array<Array<{
-      type: number,
-      type_hex: string,
-      account?: string,
-      issuer?: string,
-      currency?: string
-    }>>,
-    source_amount: RippledAmount
-  }>,
-  type: string,
-  destination_account: string,
-  destination_amount: RippledAmount,
-  destination_currencies?: Array<string>,
-  source_account?: string,
-  source_currencies?: Array<{currency: string}>,
-  full_reply?: boolean
-}
+/* @flow */
+'use strict';
+
+import type {Amount, LaxLaxAmount, RippledAmount, Adjustment, MaxAdjustment,
+  MinAdjustment} from '../common/types.js';
+
+
+type Path = {
+  source: Adjustment | MaxAdjustment,
+  destination: Adjustment | MinAdjustment,
+  paths: string
+}
+
+export type GetPaths = Array<Path>
+
+export type PathFind = {
+  source: {
+    address: string,
+    amount?: Amount,
+    currencies?: Array<{currency: string, counterparty?:string}>
+  },
+  destination: {
+    address: string,
+    amount: LaxLaxAmount
+  }
+}
+
+export type PathFindRequest = {
+  command: string,
+  source_account: string,
+  destination_amount: RippledAmount,
+  destination_account: string,
+  source_currencies?: Array<string>,
+  send_max?: RippledAmount
+}
+
+export type RippledPathsResponse = {
+  alternatives: Array<{
+    paths_computed: Array<Array<{
+      type: number,
+      type_hex: string,
+      account?: string,
+      issuer?: string,
+      currency?: string
+    }>>,
+    source_amount: RippledAmount
+  }>,
+  type: string,
+  destination_account: string,
+  destination_amount: RippledAmount,
+  destination_currencies?: Array<string>,
+  source_account?: string,
+  source_currencies?: Array<{currency: string}>,
+  full_reply?: boolean
+}

src/ledger/pathfind.js

@@ -46,9 +46,9 @@ function requestPathFind(connection: Connection, pathfind: PathFind): Promise {
       throw new ValidationError('Cannot specify both source.amount'
         + ' and destination.amount.value in getPaths');
     }
-    request.source_amount = toRippledAmount(pathfind.source.amount);
-    if (request.source_amount.currency && !request.source_amount.issuer) {
-      request.source_amount.issuer = pathfind.source.address;
+    request.send_max = toRippledAmount(pathfind.source.amount);
+    if (request.send_max.currency && !request.send_max.issuer) {
+      request.send_max.issuer = pathfind.source.address;
     }
   }
 

src/ledger/transactions.js

@@ -47,9 +47,6 @@ function parseAccountTxTransaction(tx) {
 }
 
 function counterpartyFilter(filters, tx: TransactionType) {
-  if (!filters.counterparty) {
-    return true;
-  }
   if (tx.address === filters.counterparty || (
     tx.specification && (
       (tx.specification.destination &&

src/server/server.js

@@ -30,13 +30,12 @@ function getFee(): Promise<number> {
 
 function formatLedgerClose(ledgerClose: Object): Object {
   return {
-    feeBase: ledgerClose.fee_base,
-    feeReference: ledgerClose.fee_ref,
+    baseFeeXRP: common.dropsToXrp(ledgerClose.fee_base),
     ledgerHash: ledgerClose.ledger_hash,
     ledgerVersion: ledgerClose.ledger_index,
     ledgerTimestamp: common.rippleTimeToISO8601(ledgerClose.ledger_time),
-    reserveBase: ledgerClose.reserve_base,
-    reserveIncrement: ledgerClose.reserve_inc,
+    reserveBaseXRP: common.dropsToXrp(ledgerClose.reserve_base),
+    reserveIncrementXRP: common.dropsToXrp(ledgerClose.reserve_inc),
     transactionCount: ledgerClose.txn_count,
     validatedLedgerVersions: ledgerClose.validated_ledgers
   };

src/transaction/order.js

@@ -1,5 +1,6 @@
 /* @flow */
 'use strict';
+const _ = require('lodash');
 const utils = require('./utils');
 const offerFlags = utils.common.txFlags.OfferCreate;
 const {validate, iso8601ToRippleTime} = utils.common;
@@ -34,6 +35,9 @@ function createOrderTransaction(account: string, order: Order): Object {
   if (order.expirationTime !== undefined) {
     txJSON.Expiration = iso8601ToRippleTime(order.expirationTime);
   }
+  if (order.memos !== undefined) {
+    txJSON.Memos = _.map(order.memos, utils.convertMemo);
+  }
   return txJSON;
 }
 

src/transaction/ordercancellation.js

@@ -1,24 +1,29 @@
 /* @flow */
 'use strict';
+const _ = require('lodash');
 const utils = require('./utils');
 const validate = utils.common.validate;
 import type {Instructions, Prepare} from './types.js';
 
 function createOrderCancellationTransaction(account: string,
-    sequence: number
+    orderCancellation: Object
 ): Object {
-  return {
+  const txJSON: Object = {
     TransactionType: 'OfferCancel',
     Account: account,
-    OfferSequence: sequence
+    OfferSequence: orderCancellation.orderSequence
   };
+  if (orderCancellation.memos !== undefined) {
+    txJSON.Memos = _.map(orderCancellation.memos, utils.convertMemo);
+  }
+  return txJSON;
 }
 
-function prepareOrderCancellation(address: string, sequence: number,
+function prepareOrderCancellation(address: string, orderCancellation: Object,
   instructions: Instructions = {}
 ): Promise<Prepare> {
-  validate.prepareOrderCancellation({address, sequence, instructions});
-  const txJSON = createOrderCancellationTransaction(address, sequence);
+  validate.prepareOrderCancellation({address, orderCancellation, instructions});
+  const txJSON = createOrderCancellationTransaction(address, orderCancellation);
   return utils.prepareTransaction(txJSON, this, instructions);
 }
 

src/transaction/payment.js

@@ -33,8 +33,10 @@ type Payment = {
 }
 
 function isXRPToXRPPayment(payment: Payment): boolean {
-  const sourceCurrency = _.get(payment, 'source.maxAmount.currency');
-  const destinationCurrency = _.get(payment, 'destination.amount.currency');
+  const sourceCurrency = _.get(payment, 'source.maxAmount.currency',
+    _.get(payment, 'source.amount.currency'));
+  const destinationCurrency = _.get(payment, 'destination.amount.currency',
+    _.get(payment, 'destination.minAmount.currency'));
   return sourceCurrency === 'XRP' && destinationCurrency === 'XRP';
 }
 

src/transaction/settings.js

@@ -93,6 +93,9 @@ function createSettingsTransaction(account: string, settings: Settings
   if (txJSON.TransferRate !== undefined) {
     txJSON.TransferRate = convertTransferRate(txJSON.TransferRate);
   }
+  if (settings.memos !== undefined) {
+    txJSON.Memos = _.map(settings.memos, utils.convertMemo);
+  }
   return txJSON;
 }
 

src/transaction/trustline.js

@@ -1,5 +1,6 @@
 /* @flow */
 'use strict';
+const _ = require('lodash');
 const utils = require('./utils');
 const validate = utils.common.validate;
 const trustlineFlags = utils.common.txFlags.TrustSet;
@@ -8,8 +9,7 @@ import type {Instructions, Prepare} from './types.js';
 import type {TrustLineSpecification} from '../ledger/trustlines-types.js';
 
 function convertQuality(quality) {
-  return quality === undefined ? undefined :
-    (new BigNumber(quality)).shift(9).truncated().toNumber();
+  return (new BigNumber(quality)).shift(9).truncated().toNumber();
 }
 
 function createTrustlineTransaction(account: string,
@@ -44,6 +44,9 @@ function createTrustlineTransaction(account: string,
     txJSON.Flags |= trustline.frozen ?
       trustlineFlags.SetFreeze : trustlineFlags.ClearFreeze;
   }
+  if (trustline.memos !== undefined) {
+    txJSON.Memos = _.map(trustline.memos, utils.convertMemo);
+  }
   return txJSON;
 }
 

test/api-test.js

@@ -1,6 +1,7 @@
 /* eslint-disable max-nested-callbacks */
 'use strict';
 const _ = require('lodash');
+const net = require('net');
 const assert = require('assert-diff');
 const setupAPI = require('./setup-api');
 const RippleAPI = require('ripple-api').RippleAPI;
@@ -15,6 +16,9 @@ const utils = RippleAPI._PRIVATE.ledgerUtils;
 const ledgerClosed = require('./fixtures/rippled/ledger-close-newer');
 const schemaValidator = RippleAPI._PRIVATE.schemaValidator;
 
+function unused() {
+}
+
 function closeLedger(connection) {
   connection._ws.emit('message', JSON.stringify(ledgerClosed));
 }
@@ -31,11 +35,247 @@ function checkResult(expected, schemaName, response) {
   return response;
 }
 
+function createServer() {
+  return new Promise((resolve, reject) => {
+    const server = net.createServer();
+    server.on('listening', function() {
+      resolve(server);
+    });
+    server.on('error', function(error) {
+      reject(error);
+    });
+    server.listen(0, '0.0.0.0');
+  });
+}
+
+
 describe('RippleAPI', function() {
   const instructions = {maxLedgerVersionOffset: 100};
   beforeEach(setupAPI.setup);
   afterEach(setupAPI.teardown);
 
+  describe('Connection', function() {
+
+    it('connection default options', function() {
+      const connection = new utils.common.Connection('url');
+      assert.strictEqual(connection._url, 'url');
+      assert(_.isUndefined(connection._proxyURL));
+      assert(_.isUndefined(connection._authorization));
+    });
+
+    it('with proxy', function(done) {
+      createServer().then((server) => {
+        const port = server.address().port;
+        const expect = 'CONNECT localhost';
+        server.on('connection', (socket) => {
+          socket.on('data', (data) => {
+            const got = data.toString('ascii', 0, expect.length);
+            assert.strictEqual(got, expect);
+            server.close();
+            done();
+          });
+        });
+
+        const options = {
+          proxy: 'ws://localhost:' + port,
+          authorization: 'authorization',
+          trustedCertificates: 'something'
+        };
+        const connection =
+          new utils.common.Connection(this.api.connection._url, options);
+        connection.connect().catch(done);
+        connection.connect().catch(done);
+      }, done);
+    });
+
+    it('Multiply disconnect calls', function() {
+      this.api.disconnect();
+      return this.api.disconnect();
+    });
+
+    it('reconnect', function() {
+      return this.api.connection.reconnect();
+    });
+
+    it('NotConnectedError', function() {
+      const connection = new utils.common.Connection('url');
+      return connection.getLedgerVersion().then(() => {
+        assert(false, 'Should throw NotConnectedError');
+      }).catch(error => {
+        assert(error instanceof this.api.errors.NotConnectedError);
+      });
+    });
+
+    it('DisconnectedError', function() {
+      this.api.connection._send = function() {
+        this._ws.close();
+      };
+      return this.api.getServerInfo().then(() => {
+        assert(false, 'Should throw DisconnectedError');
+      }).catch(error => {
+        assert(error instanceof this.api.errors.DisconnectedError);
+      });
+    });
+
+    it('TimeoutError', function() {
+      this.api.connection._send = function() {
+        return Promise.resolve({});
+      };
+      const request = {command: 'server_info'};
+      return this.api.connection.request(request, 1).then(() => {
+        assert(false, 'Should throw TimeoutError');
+      }).catch(error => {
+        assert(error instanceof this.api.errors.TimeoutError);
+      });
+    });
+
+    it('DisconnectedError on send', function() {
+      this.api.connection._ws.send = function(message, options, callback) {
+        unused(message, options);
+        callback({message: 'not connected'});
+      };
+      return this.api.getServerInfo().then(() => {
+        assert(false, 'Should throw DisconnectedError');
+      }).catch(error => {
+        assert(error instanceof this.api.errors.DisconnectedError);
+        assert.strictEqual(error.message, 'not connected');
+      });
+    });
+
+    it('ResponseFormatError', function() {
+      this.api.connection._send = function(message) {
+        const parsed = JSON.parse(message);
+        setTimeout(() => {
+          this._ws.emit('message', JSON.stringify({
+            id: parsed.id,
+            type: 'response',
+            status: 'unrecognized'
+          }));
+        }, 2);
+        return new Promise(() => {});
+      };
+      return this.api.getServerInfo().then(() => {
+        assert(false, 'Should throw ResponseFormatError');
+      }).catch(error => {
+        assert(error instanceof this.api.errors.ResponseFormatError);
+      });
+    });
+
+    it('reconnect on unexpected close ', function(done) {
+      this.api.connection.on('connected', () => {
+        done();
+      });
+
+      setTimeout(() => {
+        this.api.connection._ws.close();
+      }, 1);
+    });
+
+    it('Multiply connect calls', function() {
+      return this.api.connect().then(() => {
+        return this.api.connect();
+      });
+    });
+
+    it('hasLedgerVersion', function() {
+      return this.api.connection.hasLedgerVersion(8819951).then((result) => {
+        assert(result);
+      });
+    });
+
+    it('Cannot connect because no server', function() {
+      const connection = new utils.common.Connection();
+      return connection.connect().then(() => {
+        assert(false, 'Should throw ConnectionError');
+      }).catch(error => {
+        assert(error instanceof this.api.errors.ConnectionError);
+      });
+    });
+
+    it('connect multiserver error', function() {
+      const options = {
+        servers: ['wss://server1.com', 'wss://server2.com']
+      };
+      assert.throws(function() {
+        const api = new RippleAPI(options);
+        unused(api);
+      }, this.api.errors.RippleError);
+    });
+
+    it('connect throws error', function(done) {
+      this.api.once('error', (type, info) => {
+        assert.strictEqual(type, 'type');
+        assert.strictEqual(info, 'info');
+        done();
+      });
+      this.api.connection.emit('error', 'type', 'info');
+    });
+
+    it('connection emit stream messages', function(done) {
+      let transactionCount = 0;
+      let pathFindCount = 0;
+      this.api.connection.on('transaction', () => {
+        transactionCount++;
+      });
+      this.api.connection.on('path_find', () => {
+        pathFindCount++;
+      });
+      this.api.connection.on('1', () => {
+        assert.strictEqual(transactionCount, 1);
+        assert.strictEqual(pathFindCount, 1);
+        done();
+      });
+
+      this.api.connection._onMessage(JSON.stringify({
+        type: 'transaction'
+      }));
+      this.api.connection._onMessage(JSON.stringify({
+        type: 'path_find'
+      }));
+      this.api.connection._onMessage(JSON.stringify({
+        type: 'response', id: 1
+      }));
+    });
+
+    it('connection - invalid message id', function(done) {
+      this.api.on('error', (type, message) => {
+        assert.strictEqual(type, 'badMessage');
+        assert.strictEqual(message,
+          '{"type":"response","id":"must be integer"}');
+        done();
+      });
+      this.api.connection._onMessage(JSON.stringify({
+        type: 'response', id: 'must be integer'
+      }));
+    });
+
+    it('connection - error message', function(done) {
+      this.api.on('error', (type, message) => {
+        assert.strictEqual(type, 'slowDown');
+        assert.strictEqual(message, 'slow down');
+        done();
+      });
+      this.api.connection._onMessage(JSON.stringify({
+        error: 'slowDown', error_message: 'slow down'
+      }));
+    });
+
+    it('connection - unrecognized message type', function(done) {
+      this.api.on('error', (type, message) => {
+        assert.strictEqual(type, 'badMessage');
+        assert.strictEqual(message, '{"type":"unknown"}');
+        done();
+      });
+
+      this.api.connection._onMessage(JSON.stringify({type: 'unknown'}));
+    });
+  });
+
+  it('error inspect', function() {
+    const error = new this.api.errors.RippleError('mess', {data: 1});
+    assert.strictEqual(error.inspect(), '[RippleError(mess, { data: 1 })]');
+  });
+
   it('preparePayment', function() {
     const localInstructions = _.defaults({
       maxFee: '0.000012'
@@ -45,6 +285,40 @@ describe('RippleAPI', function() {
       _.partial(checkResult, responses.preparePayment.normal, 'prepare'));
   });
 
+  it('preparePayment - min amount xrp', function() {
+    const localInstructions = _.defaults({
+      maxFee: '0.000012'
+    }, instructions);
+    return this.api.preparePayment(
+      address, requests.preparePaymentMinAmountXRP, localInstructions).then(
+      _.partial(checkResult, responses.preparePayment.minAmountXRP, 'prepare'));
+  });
+
+  it('preparePayment - min amount xrp2xrp', function() {
+    return this.api.preparePayment(
+      address, requests.preparePaymentMinAmount, instructions).then(
+      _.partial(checkResult,
+        responses.preparePayment.minAmountXRPXRP, 'prepare'));
+  });
+
+  it('preparePayment - XRP to XRP no partial', function() {
+    assert.throws(() => {
+      this.api.preparePayment(address, requests.preparePaymentWrongPartial);
+    }, /XRP to XRP payments cannot be partial payments/);
+  });
+
+  it('preparePayment - address must match payment.source.address', function() {
+    assert.throws(() => {
+      this.api.preparePayment(address, requests.preparePaymentWrongAddress);
+    }, /address must match payment.source.address/);
+  });
+
+  it('preparePayment - wrong amount', function() {
+    assert.throws(() => {
+      this.api.preparePayment(address, requests.preparePaymentWrongAmount);
+    }, this.api.errors.ValidationError);
+  });
+
   it('preparePayment with all options specified', function() {
     return this.api.getLedgerVersion().then((ver) => {
       const localInstructions = {
@@ -73,7 +347,7 @@ describe('RippleAPI', function() {
 
   it('prepareOrder - buy order', function() {
     const request = requests.prepareOrder.buy;
-    return this.api.prepareOrder(address, request, instructions)
+    return this.api.prepareOrder(address, request)
       .then(_.partial(checkResult, responses.prepareOrder.buy, 'prepare'));
   });
 
@@ -93,7 +367,15 @@ describe('RippleAPI', function() {
   it('prepareOrderCancellation', function() {
     const request = requests.prepareOrderCancellation;
     return this.api.prepareOrderCancellation(address, request, instructions)
-      .then(_.partial(checkResult, responses.prepareOrderCancellation,
+      .then(_.partial(checkResult, responses.prepareOrder.cancellation,
+        'prepare'));
+  });
+
+  it('prepareOrderCancellation - no instructions', function() {
+    const request = requests.prepareOrderCancellation;
+    return this.api.prepareOrderCancellation(address, request)
+      .then(_.partial(checkResult,
+        responses.prepareOrder.cancellationNoInstructions,
         'prepare'));
   });
 
@@ -103,6 +385,12 @@ describe('RippleAPI', function() {
         _.partial(checkResult, responses.prepareTrustline.simple, 'prepare'));
   });
 
+  it('prepareTrustline - frozen', function() {
+    return this.api.prepareTrustline(
+      address, requests.prepareTrustline.frozen).then(
+        _.partial(checkResult, responses.prepareTrustline.frozen, 'prepare'));
+  });
+
   it('prepareTrustline - complex', function() {
     return this.api.prepareTrustline(
       address, requests.prepareTrustline.complex, instructions).then(
@@ -115,6 +403,15 @@ describe('RippleAPI', function() {
       _.partial(checkResult, responses.prepareSettings.flags, 'prepare'));
   });
 
+  it('prepareSettings - no instructions', function() {
+    return this.api.prepareSettings(
+      address, requests.prepareSettings).then(
+      _.partial(
+        checkResult,
+        responses.prepareSettings.noInstructions,
+        'prepare'));
+  });
+
   it('prepareSettings - regularKey', function() {
     const regularKey = {regularKey: 'rAR8rR8sUkBoCZFawhkWzY4Y5YoyuznwD'};
     return this.api.prepareSettings(address, regularKey, instructions).then(
@@ -167,6 +464,13 @@ describe('RippleAPI', function() {
           'prepare'));
   });
 
+  it('prepareSuspendedPaymentCreation full', function() {
+    return this.api.prepareSuspendedPaymentCreation(
+      address, requests.prepareSuspendedPaymentCreationFull).then(
+        _.partial(checkResult, responses.prepareSuspendedPaymentCreationFull,
+          'prepare'));
+  });
+
   it('prepareSuspendedPaymentExecution', function() {
     return this.api.prepareSuspendedPaymentExecution(
       address, requests.prepareSuspendedPaymentExecution, instructions).then(
@@ -174,6 +478,13 @@ describe('RippleAPI', function() {
         'prepare'));
   });
 
+  it('prepareSuspendedPaymentExecution - simple', function() {
+    return this.api.prepareSuspendedPaymentExecution(
+      address, requests.prepareSuspendedPaymentExecutionSimple).then(
+      _.partial(checkResult, responses.prepareSuspendedPaymentExecutionSimple,
+        'prepare'));
+  });
+
   it('prepareSuspendedPaymentCancellation', function() {
     return this.api.prepareSuspendedPaymentCancellation(
       address, requests.prepareSuspendedPaymentCancellation, instructions).then(
@@ -181,6 +492,13 @@ describe('RippleAPI', function() {
         'prepare'));
   });
 
+  it('prepareSuspendedPaymentCancellation with memos', function() {
+    return this.api.prepareSuspendedPaymentCancellation(
+      address, requests.prepareSuspendedPaymentCancellationMemos).then(
+      _.partial(checkResult, responses.prepareSuspendedPaymentCancellationMemos,
+        'prepare'));
+  });
+
   it('sign', function() {
     const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV';
     const result = this.api.sign(requests.sign.txJSON, secret);
@@ -218,7 +536,8 @@ describe('RippleAPI', function() {
 
     it('getBalances - limit', function() {
       const options = {
-        limit: 3
+        limit: 3,
+        ledgerVersion: 123456
       };
       const expectedResponse = responses.getBalances.slice(0, 3);
       return this.api.getBalances(address, options).then(
@@ -255,6 +574,18 @@ describe('RippleAPI', function() {
       _.partial(checkResult, responses.getBalanceSheet, 'getBalanceSheet'));
   });
 
+  it('getBalanceSheet - invalid options', function() {
+    assert.throws(() => {
+      this.api.getBalanceSheet(address, {invalid: 'options'});
+    }, this.api.errors.ValidationError);
+  });
+
+  it('getBalanceSheet - empty', function() {
+    const options = {ledgerVersion: 123456};
+    return this.api.getBalanceSheet(address, options).then(
+      _.partial(checkResult, {}, 'getBalanceSheet'));
+  });
+
   describe('getTransaction', () => {
     it('getTransaction - payment', function() {
       return this.api.getTransaction(hashes.VALID_TRANSACTION_HASH).then(
@@ -279,6 +610,15 @@ describe('RippleAPI', function() {
         'getTransaction'));
     });
 
+    it('getTransaction - sell order', function() {
+      const hash =
+        '458101D51051230B1D56E9ACAFAA34451BF65FA000F95DF6F0FF5B3A62D83FC2';
+      closeLedger(this.api.connection);
+      return this.api.getTransaction(hash).then(
+        _.partial(checkResult, responses.getTransaction.orderSell,
+        'getTransaction'));
+    });
+
     it('getTransaction - order cancellation', function() {
       const hash =
         '809335DD3B0B333865096217AA2F55A4DF168E0198080B3A090D12D88880FF0E';
@@ -456,6 +796,15 @@ describe('RippleAPI', function() {
           'getTransaction'));
     });
 
+    it('getTransaction - SuspendedPaymentCreation iou', function() {
+      const hash =
+        '144F272380BDB4F1BD92329A2178BABB70C20F59042C495E10BF72EBFB408EE2';
+      return this.api.getTransaction(hash).then(
+        _.partial(checkResult,
+          responses.getTransaction.SuspendedPaymentCreationIOU,
+          'getTransaction'));
+    });
+
     it('getTransaction - SuspendedPaymentCancellation', function() {
       const hash =
         'F346E542FFB7A8398C30A87B952668DAB48B7D421094F8B71776DA19775A3B22';
@@ -466,14 +815,46 @@ describe('RippleAPI', function() {
     });
 
     it('getTransaction - SuspendedPaymentExecution', function() {
+      const options = {
+        minLedgerVersion: 10,
+        maxLedgerVersion: 15
+      };
       const hash =
         'CC5277137B3F25EE8B86259C83CB0EAADE818505E4E9BCBF19B1AC6FD136993B';
-      return this.api.getTransaction(hash).then(
+      return this.api.getTransaction(hash, options).then(
         _.partial(checkResult,
           responses.getTransaction.suspendedPaymentExecution,
           'getTransaction'));
     });
 
+    it('getTransaction - SuspendedPaymentExecution simple', function() {
+      const hash =
+        'CC5277137B3F25EE8B86259C83CB0EAADE818505E4E9BCBF19B1AC6FD1369931';
+      return this.api.getTransaction(hash).then(
+        _.partial(checkResult,
+          responses.getTransaction.suspendedPaymentExecutionSimple,
+          'getTransaction'));
+    });
+
+    it('getTransaction - no Meta', function() {
+      const hash =
+        'AFB3ADF22F3C605E23FAEFAA185F3BD763C4692CAC490D9819D117CD33BFAA1B';
+      return this.api.getTransaction(hash).then(result => {
+        assert.deepEqual(result, responses.getTransaction.noMeta);
+      });
+    });
+
+    it('getTransaction - Unrecognized transaction type', function() {
+      const hash =
+        'AFB3ADF22F3C605E23FAEFAA185F3BD763C4692CAC490D9819D117CD33BFAA11';
+      closeLedger(this.api.connection);
+      return this.api.getTransaction(hash).then(() => {
+        assert(false, 'Unrecognized transaction type');
+      }).catch(error => {
+        assert.strictEqual(error.message, 'Unrecognized transaction type');
+      });
+    });
+
   });
 
   it('getTransactions', function() {
@@ -493,6 +874,7 @@ describe('RippleAPI', function() {
       _.partial(checkResult, expected, 'getTransactions'));
   });
 
+
   it('getTransactions - earliest first with start option', function() {
     const options = {types: ['payment', 'order'], initiated: true, limit: 2,
       start: hashes.VALID_TRANSACTION_HASH,
@@ -572,12 +954,32 @@ describe('RippleAPI', function() {
       _.partial(checkResult, responses.getTransactions, 'getTransactions'));
   });
 
+  it('getTransactions - start transaction with zero ledger version', function(
+  ) {
+    const options = {
+      start: '4FB3ADF22F3C605E23FAEFAA185F3BD763C4692CAC490D9819D117CD33BFAA13',
+      limit: 1
+    };
+    return this.api.getTransactions(address, options).then(
+      _.partial(checkResult, [], 'getTransactions'));
+  });
+
+  it('getTransactions - no options', function() {
+    return this.api.getTransactions(addresses.OTHER_ACCOUNT).then(
+      _.partial(checkResult, responses.getTransactionsOne, 'getTransactions'));
+  });
+
   it('getTrustlines', function() {
     const options = {currency: 'USD'};
     return this.api.getTrustlines(address, options).then(
       _.partial(checkResult, responses.getTrustlines, 'getTrustlines'));
   });
 
+  it('getTrustlines - ono options', function() {
+    return this.api.getTrustlines(address).then(
+      _.partial(checkResult, responses.getTrustlinesAll, 'getTrustlines'));
+  });
+
   it('generateAddress', function() {
     function random() {
       return _.fill(Array(16), 0);
@@ -586,24 +988,79 @@ describe('RippleAPI', function() {
                      responses.generateAddress);
   });
 
+  it('generateAddress invalid', function() {
+    assert.throws(() => {
+      function random() {
+        return _.fill(Array(1), 0);
+      }
+      this.api.generateAddress({entropy: random()});
+    }, this.api.errors.UnexpectedError);
+  });
+
   it('getSettings', function() {
     return this.api.getSettings(address).then(
       _.partial(checkResult, responses.getSettings, 'getSettings'));
   });
 
+  it('getSettings - options undefined', function() {
+    return this.api.getSettings(address, undefined).then(
+      _.partial(checkResult, responses.getSettings, 'getSettings'));
+  });
+
+  it('getSettings - invalid options', function() {
+    assert.throws(() => {
+      this.api.getSettings(address, {invalid: 'options'});
+    }, this.api.errors.ValidationError);
+  });
+
   it('getAccountInfo', function() {
     return this.api.getAccountInfo(address).then(
       _.partial(checkResult, responses.getAccountInfo, 'getAccountInfo'));
   });
 
+  it('getAccountInfo - options undefined', function() {
+    return this.api.getAccountInfo(address, undefined).then(
+      _.partial(checkResult, responses.getAccountInfo, 'getAccountInfo'));
+  });
+
+  it('getAccountInfo - invalid options', function() {
+    assert.throws(() => {
+      this.api.getAccountInfo(address, {invalid: 'options'});
+    }, this.api.errors.ValidationError);
+  });
+
   it('getOrders', function() {
     return this.api.getOrders(address).then(
       _.partial(checkResult, responses.getOrders, 'getOrders'));
   });
 
+  it('getOrders', function() {
+    return this.api.getOrders(address, undefined).then(
+      _.partial(checkResult, responses.getOrders, 'getOrders'));
+  });
+
+  it('getOrders - invalid options', function() {
+    assert.throws(() => {
+      this.api.getOrders(address, {invalid: 'options'});
+    }, this.api.errors.ValidationError);
+  });
+
   it('getOrderbook', function() {
-    return this.api.getOrderbook(address, requests.getOrderbook).then(
-      _.partial(checkResult, responses.getOrderbook, 'getOrderbook'));
+    return this.api.getOrderbook(address, requests.getOrderbook, undefined)
+      .then(
+        _.partial(checkResult, responses.getOrderbook, 'getOrderbook'));
+  });
+
+  it('getOrderbook - invalid options', function() {
+    assert.throws(() => {
+      this.api.getOrderbook(address, requests.getOrderbook,
+        {invalid: 'options'});
+    }, this.api.errors.ValidationError);
+  });
+
+  it('getOrderbook with XRP', function() {
+    return this.api.getOrderbook(address, requests.getOrderbookWithXRP).then(
+      _.partial(checkResult, responses.getOrderbookWithXRP, 'getOrderbook'));
   });
 
   it('getOrderbook - sorted so that best deals come first', function() {
@@ -664,6 +1121,13 @@ describe('RippleAPI', function() {
     });
   });
 
+  it('getFee default', function() {
+    this.api._feeCushion = undefined;
+    return this.api.getFee().then(fee => {
+      assert.strictEqual(fee, '0.000012');
+    });
+  });
+
   it('disconnect & isConnected', function() {
     assert.strictEqual(this.api.isConnected(), true);
     return this.api.disconnect().then(() => {
@@ -702,6 +1166,14 @@ describe('RippleAPI', function() {
       _.partial(checkResult, responses.getPaths.XrpToXrp, 'getPaths'));
   });
 
+  it('getPaths - source with issuer', function() {
+    return this.api.getPaths(requests.getPaths.issuer).then(() => {
+      assert(false, 'Should throw NotFoundError');
+    }).catch(error => {
+      assert(error instanceof this.api.errors.NotFoundError);
+    });
+  });
+
   it('getPaths - XRP 2 XRP - not enough', function() {
     return this.api.getPaths(requests.getPaths.XrpToXrpNotEnough).then(() => {
       assert(false, 'Should throw NotFoundError');
@@ -710,6 +1182,12 @@ describe('RippleAPI', function() {
     });
   });
 
+  it('getPaths - invalid PathFind', function() {
+    assert.throws(() => {
+      this.api.getPaths(requests.getPaths.invalid);
+    }, /Cannot specify both source.amount/);
+  });
+
   it('getPaths - does not accept currency', function() {
     return this.api.getPaths(requests.getPaths.NotAcceptCurrency).then(() => {
       assert(false, 'Should throw NotFoundError');
@@ -768,6 +1246,18 @@ describe('RippleAPI', function() {
     });
   });
 
+  it('getLedger - with state as hashes', function() {
+    const request = {
+      includeTransactions: true,
+      includeAllData: false,
+      includeState: true,
+      ledgerVersion: 6
+    };
+    return this.api.getLedger(request).then(
+      _.partial(checkResult, responses.getLedger.withStateAsHashes,
+        'getLedger'));
+  });
+
   it('getLedger - with settings transaction', function() {
     const request = {
       includeTransactions: true,
@@ -796,7 +1286,55 @@ describe('RippleAPI', function() {
       });
   });
 
+  it('computeLedgerHash - wrong hash', function() {
+    const request = {
+      includeTransactions: true,
+      includeState: true,
+      includeAllData: true,
+      ledgerVersion: 38129
+    };
+    return this.api.getLedger(request).then(
+      _.partial(checkResult, responses.getLedger.full, 'getLedger'))
+      .then(response => {
+        const ledger = _.assign({}, response, {
+          parentCloseTime: response.closeTime, stateHash:
+          'D9ABF622DA26EEEE48203085D4BC23B0F77DC6F8724AC33D975DA3CA492D2E44'});
+        assert.throws(() => {
+          const hash = this.api.computeLedgerHash(ledger);
+          unused(hash);
+        }, /does not match computed hash of state/);
+      });
+  });
+
+  it('RippleError with data', function() {
+    const error = new this.api.errors.RippleError('_message_', '_data_');
+    assert.strictEqual(error.toString(),
+      '[RippleError(_message_, \'_data_\')]');
+  });
+
+  it('NotFoundError default message', function() {
+    const error = new this.api.errors.NotFoundError();
+    assert.strictEqual(error.toString(),
+      '[NotFoundError(Not found)]');
+  });
+
+  it('common utils - toRippledAmount', function() {
+    const amount = {issuer: 'is', currency: 'c', value: 'v'};
+
+    assert.deepEqual(utils.common.toRippledAmount(amount), {
+      issuer: 'is', currency: 'c', value: 'v'
+    });
+  });
+
+  it('ledger utils - renameCounterpartyToIssuerInOrder', function() {
+    const order = {taker_gets: {issuer: '1'}};
+    const expected = {taker_gets: {issuer: '1'}};
+
+    assert.deepEqual(utils.renameCounterpartyToIssuerInOrder(order), expected);
+  });
+
   it('ledger utils - compareTransactions', function() {
+    assert.strictEqual(utils.compareTransactions({}, {}), 0);
     let first = {outcome: {ledgerVersion: 1, indexInLedger: 100}};
     let second = {outcome: {ledgerVersion: 1, indexInLedger: 200}};
 
@@ -896,9 +1434,9 @@ describe('RippleAPI', function() {
 
   });
 
-  it('ledgerClosed', function(done) {
-    this.api.on('ledgerClosed', message => {
-      checkResult(responses.ledgerClosed, 'ledgerClosed', message);
+  it('ledger event', function(done) {
+    this.api.on('ledger', message => {
+      checkResult(responses.ledgerEvent, 'ledgerEvent', message);
       done();
     });
     closeLedger(this.api.connection);

test/fixtures/requests/get-orderbook-with-xrp.json

@@ -0,0 +1,9 @@
+{
+  "base": {
+    "currency": "USD",
+    "counterparty": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw"
+  },
+  "counter": {
+    "currency": "XRP"
+  }
+}

test/fixtures/requests/getpaths/invalid.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "address": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J",
+    "amount": {
+      "value": "1000002",
+      "currency": "USD"
+    }
+  },
+  "destination": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "amount": {
+      "value": "1000002",
+      "currency": "USD"
+    }
+  }
+}

test/fixtures/requests/getpaths/issuer.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "address": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J",
+    "amount": {
+      "value": "1000002",
+      "currency": "USD",
+      "counterparty": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J"
+    }
+  },
+  "destination": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "amount": {
+      "currency": "USD"
+    }
+  }
+}

test/fixtures/requests/index.js

@@ -8,18 +8,30 @@ module.exports = {
   },
   prepareOrderCancellation: require('./prepare-order-cancellation'),
   preparePayment: require('./prepare-payment'),
+  preparePaymentMinAmountXRP: require('./prepare-payment-min-xrp'),
+  preparePaymentMinAmount: require('./prepare-payment-min'),
+  preparePaymentWrongAddress: require('./prepare-payment-wrong-address'),
+  preparePaymentWrongAmount: require('./prepare-payment-wrong-amount'),
+  preparePaymentWrongPartial: require('./prepare-payment-wrong-partial'),
   preparePaymentAllOptions: require('./prepare-payment-all-options'),
   preparePaymentNoCounterparty: require('./prepare-payment-no-counterparty'),
   prepareSettings: require('./prepare-settings'),
   prepareSuspendedPaymentCreation:
     require('./prepare-suspended-payment-creation'),
+  prepareSuspendedPaymentCreationFull:
+    require('./prepare-suspended-payment-creation-full'),
   prepareSuspendedPaymentExecution:
     require('./prepare-suspended-payment-execution'),
+  prepareSuspendedPaymentExecutionSimple:
+    require('./prepare-suspended-payment-execution-simple'),
   prepareSuspendedPaymentCancellation:
     require('./prepare-suspended-payment-cancellation'),
+  prepareSuspendedPaymentCancellationMemos:
+    require('./prepare-suspended-payment-cancellation-memos'),
   prepareTrustline: {
     simple: require('./prepare-trustline-simple'),
-    complex: require('./prepare-trustline')
+    complex: require('./prepare-trustline'),
+    frozen: require('./prepare-trustline-frozen.json')
   },
   sign: require('./sign'),
   signSuspended: require('./sign-suspended.json'),
@@ -31,9 +43,12 @@ module.exports = {
     NotAcceptCurrency: require('./getpaths/not-accept-currency'),
     NoPaths: require('./getpaths/no-paths'),
     NoPathsWithCurrencies: require('./getpaths/no-paths-with-currencies'),
-    sendAll: require('./getpaths/send-all')
+    sendAll: require('./getpaths/send-all'),
+    invalid: require('./getpaths/invalid'),
+    issuer: require('./getpaths/issuer')
   },
   getOrderbook: require('./get-orderbook'),
+  getOrderbookWithXRP: require('./get-orderbook-with-xrp'),
   computeLedgerHash: {
     header: require('./compute-ledger-hash'),
     transactions: require('./compute-ledger-hash-transactions')

test/fixtures/requests/prepare-order-cancellation.json

@@ -1 +1,3 @@
-23
+{
+  "orderSequence": 23
+}

test/fixtures/requests/prepare-order.json

@@ -9,5 +9,6 @@
     "currency": "XRP",
     "value": "2"
   },
-  "immediateOrCancel": true
+  "passive": true,
+  "fillOrKill": true
 }

test/fixtures/requests/prepare-payment-min-xrp.json

@@ -0,0 +1,17 @@
+{
+  "source": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "amount": {
+      "value": "0.01",
+      "currency": "USD",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    }
+  },
+  "destination": {
+    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
+    "minAmount": {
+      "value": "0.01",
+      "currency": "XRP"
+    }
+  }
+}

test/fixtures/requests/prepare-payment-min.json

@@ -0,0 +1,17 @@
+{
+  "source": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "amount": {
+      "value": "0.01",
+      "currency": "XRP",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    }
+  },
+  "destination": {
+    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
+    "minAmount": {
+      "value": "0.01",
+      "currency": "XRP"
+    }
+  }
+}

test/fixtures/requests/prepare-payment-wrong-address.json

@@ -0,0 +1,17 @@
+{
+  "source": {
+    "address": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
+    "amount": {
+      "value": "0.01",
+      "currency": "USD",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    }
+  },
+  "destination": {
+    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
+    "minAmount": {
+      "value": "0.01",
+      "currency": "XRP"
+    }
+  }
+}

test/fixtures/requests/prepare-payment-wrong-amount.json

@@ -0,0 +1,17 @@
+{
+  "source": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "maxAmount": {
+      "value": "0.01",
+      "currency": "USD",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    }
+  },
+  "destination": {
+    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
+    "minAmount": {
+      "value": "0.01",
+      "currency": "XRP"
+    }
+  }
+}

test/fixtures/requests/prepare-payment-wrong-partial.json

@@ -0,0 +1,17 @@
+{
+  "source": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "amount": {
+      "value": "0.01",
+      "currency": "XRP"
+    }
+  },
+  "destination": {
+    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
+    "minAmount": {
+      "value": "0.01",
+      "currency": "XRP"
+    }
+  },
+  "allowPartialPayment": true
+}

test/fixtures/requests/prepare-suspended-payment-cancellation-memos.json

@@ -0,0 +1,11 @@
+{
+  "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+  "suspensionSequence": 1234,
+  "memos": [
+    {
+      "type": "test",
+      "format": "plain/text",
+      "data": "texted data"
+    }
+  ]
+}

test/fixtures/requests/prepare-suspended-payment-creation-full.json

@@ -0,0 +1,28 @@
+{
+  "source": {
+    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+    "maxAmount": {
+      "value": "0.01",
+      "currency": "USD",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    },
+    "tag": 1
+  },
+  "destination": {
+    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
+    "amount": {
+      "value": "0.01",
+      "currency": "USD",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    },
+    "tag": 2
+  },
+  "digest": "8F434346648F6B96DF89DDA901C5176B10A6D83961DD3C1AC88B59B2DC327AA4",
+  "allowExecuteAfter": "2014-09-24T21:21:50.000Z",
+  "memos": [
+    {
+      "type": "test",
+      "data": "texted data"
+    }
+  ]
+}

test/fixtures/requests/prepare-suspended-payment-execution-simple.json

@@ -0,0 +1,11 @@
+{
+  "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+  "suspensionSequence": 1234,
+  "memos": [
+    {
+      "type": "test",
+      "format": "plain/text",
+      "data": "texted data"
+    }
+  ]
+}

test/fixtures/requests/prepare-trustline-frozen.json

@@ -0,0 +1,8 @@
+{
+  "currency": "BTC",
+  "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
+  "limit": "0.1",
+  "authorized": true,
+  "ripplingDisabled": false,
+  "frozen": true
+}

test/fixtures/requests/sign.json

@@ -1,5 +1,5 @@
 {
-  "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"AccountSet\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"Domain\":\"726970706C652E636F6D\",\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}",
+  "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"AccountSet\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"Domain\":\"726970706C652E636F6D\",\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23,\"SigningPubKey\":\"02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8\"}",
   "instructions": {
     "fee": "0.000012",
     "sequence": 23,

test/fixtures/responses/get-ledger-with-settings-tx.json

@@ -33,5 +33,5 @@
       }
     }
   ],
-  "rawTransactions": "[{\"Account\":\"rEGy9CxMTFGXFgUHUMreTy2FbqArabGy38\",\"Fee\":\"10\",\"Flags\":0,\"Sequence\":6478,\"SigningPubKey\":\"02CAB6F3A798712136DB5F105A98B0DE27C99AEDB68500181706B087CF1B6D0F2D\",\"TransactionType\":\"AccountSet\",\"TxnSignature\":\"304402202144BD33CC30793455B0F90954576EEE80F13C4C73538D2AEE012564C48E522E02207A8A4AD2CF2B4DB549FB2F05D38E065B5DD1EAA386310698E5247F1BB515E99F\",\"hash\":\"FEEFC959B0351156F58A2275F5A6B37B07AA85CCCE2C4AF8A1342A0196A3CD4D\",\"metaData\":{\"AffectedNodes\":[{\"ModifiedNode\":{\"FinalFields\":{\"Account\":\"rEGy9CxMTFGXFgUHUMreTy2FbqArabGy38\",\"Balance\":\"403657865\",\"Flags\":0,\"OwnerCount\":2,\"Sequence\":6479},\"LedgerEntryType\":\"AccountRoot\",\"LedgerIndex\":\"F64FAA4CAFDB9931DC06890FE30B4E29C32F7AD574FC7C3362B81265682BFAEA\",\"PreviousFields\":{\"Balance\":\"403657875\",\"Sequence\":6478},\"PreviousTxnID\":\"B257B95A637C6C396507AD0AE122161A849C701F065B67009BB939690DB74BC9\",\"PreviousTxnLgrSeq\":4181972}}],\"TransactionIndex\":0,\"TransactionResult\":\"tesSUCCESS\"}}]"
+  "rawTransactions": "[{\"Account\":\"rEGy9CxMTFGXFgUHUMreTy2FbqArabGy38\",\"Fee\":\"10\",\"ledger_index\":4181996,\"Flags\":0,\"Sequence\":6478,\"SigningPubKey\":\"02CAB6F3A798712136DB5F105A98B0DE27C99AEDB68500181706B087CF1B6D0F2D\",\"TransactionType\":\"AccountSet\",\"TxnSignature\":\"304402202144BD33CC30793455B0F90954576EEE80F13C4C73538D2AEE012564C48E522E02207A8A4AD2CF2B4DB549FB2F05D38E065B5DD1EAA386310698E5247F1BB515E99F\",\"hash\":\"FEEFC959B0351156F58A2275F5A6B37B07AA85CCCE2C4AF8A1342A0196A3CD4D\",\"metaData\":{\"AffectedNodes\":[{\"ModifiedNode\":{\"FinalFields\":{\"Account\":\"rEGy9CxMTFGXFgUHUMreTy2FbqArabGy38\",\"Balance\":\"403657865\",\"Flags\":0,\"OwnerCount\":2,\"Sequence\":6479},\"LedgerEntryType\":\"AccountRoot\",\"LedgerIndex\":\"F64FAA4CAFDB9931DC06890FE30B4E29C32F7AD574FC7C3362B81265682BFAEA\",\"PreviousFields\":{\"Balance\":\"403657875\",\"Sequence\":6478},\"PreviousTxnID\":\"B257B95A637C6C396507AD0AE122161A849C701F065B67009BB939690DB74BC9\",\"PreviousTxnLgrSeq\":4181972}}],\"TransactionIndex\":0,\"TransactionResult\":\"tesSUCCESS\"}}]"
 }

test/fixtures/responses/get-ledger-with-state-as-hashes.json

@@ -0,0 +1,20 @@
+{
+  "stateHash": "8DBB7FA4036704D96AD32A4573BEE461FDDBDCB1B6F62CB17EDB5182F52AE9F1",
+  "closeTime": "2015-11-18T11:00:30.000Z",
+  "closeTimeResolution": 30,
+  "closeFlags": 0,
+  "ledgerHash": "3D7115EDB5EC72FEF4ADDF46CA5B7770CBDECEAB3A97EA210BCC04E8C54A7CEE",
+  "ledgerVersion": 6,
+  "parentLedgerHash": "6D36AEFD3639EE22A27DDE0FA6C57525D103941F11D7FD6D91AC8D439DE2B3EE",
+  "parentCloseTime": "2015-11-18T07:53:01.000Z",
+  "totalDrops": "99999999999999964",
+  "transactionHash": "B8D716B82BFFF4186BBBE7B7341AE0E1CBD2558952408B96E925EC0A51A6AEC2",
+  "transactionHashes": [
+    "B22E27F35F3F7679F76A474E4FF8E71EFA21B313DF2FC6678037A053A00FD084"
+  ],
+  "stateHashes": [
+    "2B6AC232AA4C4BE41BF49D2459FA4A0347E1B543A4C92FCEE0821C0201E2E9A8",
+    "8B24E55376A65D68542C17F3BF446231AC7062CB43BED28817570128A1849819",
+    "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B"
+  ]
+}

test/fixtures/responses/get-orderbook-with-xrp.json

@@ -0,0 +1,44 @@
+{
+  "bids": [
+    {
+      "specification": {
+        "direction": "buy",
+        "quantity": {
+          "currency": "USD",
+          "value": "10.1",
+          "counterparty": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw"
+        },
+        "totalPrice": {
+          "currency": "XRP",
+          "value": "254391353"
+        }
+      },
+      "properties": {
+        "maker": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+        "sequence": 5,
+        "makerExchangeRate": "3.970260734451929e-8"
+      }
+    }
+  ],
+  "asks": [
+    {
+      "specification": {
+        "direction": "sell",
+        "quantity": {
+          "currency": "USD",
+          "value": "10453252347.1",
+          "counterparty": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw"
+        },
+        "totalPrice": {
+          "currency": "XRP",
+          "value": "134"
+        }
+      },
+      "properties": {
+        "maker": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+        "sequence": 6,
+        "makerExchangeRate": "0.0000780093458738806"
+      }
+    }
+  ]
+}

test/fixtures/responses/get-transaction-no-meta.json

@@ -0,0 +1,23 @@
+{
+  "type": "payment",
+  "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+  "sequence": 4,
+  "id": "AFB3ADF22F3C605E23FAEFAA185F3BD763C4692CAC490D9819D117CD33BFAA1B",
+  "specification": {
+    "source": {
+      "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
+      "maxAmount": {
+        "currency": "XRP",
+        "value": "1.112209"
+      }
+    },
+    "destination": {
+      "address": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
+      "amount": {
+        "currency": "USD",
+        "value": "0.001"
+      }
+    },
+    "paths": "[[{\"currency\":\"USD\",\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"type\":48,\"type_hex\":\"0000000000000030\"},{\"account\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"currency\":\"USD\",\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"type\":49,\"type_hex\":\"0000000000000031\"}]]"
+  }
+}

test/fixtures/responses/get-transaction-order-sell.json

@@ -0,0 +1,34 @@
+{
+  "type": "order",
+  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+  "sequence": 2,
+  "id": "458101D51051230B1D56E9ACAFAA34451BF65FA000F95DF6F0FF5B3A62D83FC2",
+  "specification": {
+    "direction": "sell",
+    "quantity": {
+      "currency": "USD",
+      "value": "10.1",
+      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
+    },
+    "totalPrice": {
+      "currency": "XRP",
+      "value": "254391353"
+    }
+  },
+  "outcome": {
+    "result": "tecUNFUNDED_OFFER",
+    "timestamp": "2015-11-18T20:56:30.000Z",
+    "fee": "0.000012",
+    "balanceChanges": {
+      "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh": [
+        {
+          "currency": "XRP",
+          "value": "-0.000012"
+        }
+      ]
+    },
+    "orderbookChanges": {},
+    "ledgerVersion": 6,
+    "indexInLedger": 0
+  }
+}

test/fixtures/responses/get-transaction-suspended-payment-create-iou.json

@@ -0,0 +1,51 @@
+{
+  "type": "suspendedPaymentCreation",
+  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+  "sequence": 10,
+  "id": "144F272380BDB4F1BD92329A2178BABB70C20F59042C495E10BF72EBFB408EE2",
+  "specification": {
+    "source": {
+      "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+      "maxAmount": {
+        "currency": "USD",
+        "value": "2"
+      },
+      "tag": 1
+    },
+    "destination": {
+      "address": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw",
+      "amount": {
+        "currency": "USD",
+        "value": "2",
+        "counterparty": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"
+      },
+      "tag": 2
+    },
+    "memos": [
+      {
+        "type": "x2",
+        "format": "text/plain",
+        "data": "mema data"
+      }
+    ],
+    "digest": "8F434346648F6B96DF89DDA901C5176B10A6D83961DD3C1AC88B59B2DC327AA4",
+    "allowCancelAfter": "2015-11-16T06:53:42.000Z",
+    "allowExecuteAfter": "2015-11-16T06:47:42.000Z"
+  },
+  "outcome": {
+    "result": "tesSUCCESS",
+    "timestamp": "2015-11-16T06:43:00.000Z",
+    "fee": "0.000012",
+    "balanceChanges": {
+      "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh": [
+        {
+          "currency": "XRP",
+          "value": "-0.000014"
+        }
+      ]
+    },
+    "orderbookChanges": {},
+    "ledgerVersion": 15,
+    "indexInLedger": 0
+  }
+}

test/fixtures/responses/get-transaction-suspended-payment-execution-simple.json

@@ -0,0 +1,34 @@
+{
+  "type": "suspendedPaymentExecution",
+  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+  "sequence": 6,
+  "id": "CC5277137B3F25EE8B86259C83CB0EAADE818505E4E9BCBF19B1AC6FD1369931",
+  "specification": {
+    "owner": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+    "suspensionSequence": 5,
+    "method": 1,
+    "digest": "632F2F3E437AE720C397994A985B5D21FE186DE61523A9CA3E8709CC581671A1"
+  },
+  "outcome": {
+    "result": "tesSUCCESS",
+    "timestamp": "2015-11-17T01:47:40.000Z",
+    "fee": "0.000012",
+    "balanceChanges": {
+      "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh": [
+        {
+          "currency": "XRP",
+          "value": "-0.000012"
+        }
+      ],
+      "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw": [
+        {
+          "currency": "XRP",
+          "value": "10.000043"
+        }
+      ]
+    },
+    "orderbookChanges": {},
+    "ledgerVersion": 14,
+    "indexInLedger": 0
+  }
+}

test/fixtures/responses/get-transactions-one.json

@@ -0,0 +1,27 @@
+[
+  {
+    "type": "settings",
+    "address": "r9UHu5CWni1qRY7Q4CfFZLGvXo2pGQy96b",
+    "sequence": 491,
+    "id": "D868CFF0DF8C8AAF205404460EA764ACB3B8862527FA414BC8C1CA9A45B1F276",
+    "specification": {
+      "domain": "ripple.com"
+    },
+    "outcome": {
+      "result": "tesSUCCESS",
+      "timestamp": "2015-10-23T02:07:00.000Z",
+      "fee": "0.012",
+      "balanceChanges": {
+        "r9UHu5CWni1qRY7Q4CfFZLGvXo2pGQy96b": [
+          {
+            "currency": "XRP",
+            "value": "-0.012"
+          }
+        ]
+      },
+      "orderbookChanges": {},
+      "ledgerVersion": 16635149,
+      "indexInLedger": 4
+    }
+  }
+]

test/fixtures/responses/get-trustlines-all.json

@@ -0,0 +1,333 @@
+[
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "ASP",
+      "counterparty": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z"
+    },
+    "counterparty": {
+      "limit": "10"
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "XAU",
+      "counterparty": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
+      "ripplingDisabled": true,
+      "frozen": true
+    },
+    "counterparty": {
+      "limit": "0",
+      "ripplingDisabled": true
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "5",
+      "currency": "USD",
+      "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
+      "ripplingDisabled": true,
+      "frozen": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "2.497605752725159"
+    }
+  },
+  {
+    "specification": {
+      "limit": "1000",
+      "currency": "MXN",
+      "counterparty": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4"
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "481.992867407479"
+    }
+  },
+  {
+    "specification": {
+      "limit": "1",
+      "currency": "EUR",
+      "counterparty": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "0.793598266778297"
+    }
+  },
+  {
+    "specification": {
+      "limit": "3",
+      "currency": "CNY",
+      "counterparty": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "3",
+      "currency": "DYM",
+      "counterparty": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E"
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "1.294889190631542"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "CHF",
+      "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "0.3488146605801446"
+    }
+  },
+  {
+    "specification": {
+      "limit": "3",
+      "currency": "BTC",
+      "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "2.114103174931847"
+    }
+  },
+  {
+    "specification": {
+      "limit": "5000",
+      "currency": "USD",
+      "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "BTC",
+      "counterparty": "rpgKWEmNqSDAGFhy5WDnsyPqfQxbWxKeVd"
+    },
+    "counterparty": {
+      "limit": "10"
+    },
+    "state": {
+      "balance": "-0.00111"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "BTC",
+      "counterparty": "rBJ3YjwXi2MGbg7GVLuTXUWQ8DjL7tDXh4"
+    },
+    "counterparty": {
+      "limit": "10"
+    },
+    "state": {
+      "balance": "-0.1010780000080207"
+    }
+  },
+  {
+    "specification": {
+      "limit": "1",
+      "currency": "USD",
+      "counterparty": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun"
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "1"
+    }
+  },
+  {
+    "specification": {
+      "limit": "100",
+      "currency": "CNY",
+      "counterparty": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "8.07619790068559"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "JPY",
+      "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "7.292695098901099"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "AUX",
+      "counterparty": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0",
+      "ripplingDisabled": true
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "1",
+      "currency": "USD",
+      "counterparty": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "100",
+      "currency": "EUR",
+      "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "12.41688780720394"
+    }
+  },
+  {
+    "specification": {
+      "limit": "500",
+      "currency": "USD",
+      "counterparty": "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "35"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "JOE",
+      "counterparty": "rwUVoVMSURqNyvocPCcvLu3ygJzZyw8qwp"
+    },
+    "counterparty": {
+      "limit": "50",
+      "ripplingDisabled": true
+    },
+    "state": {
+      "balance": "-5"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "USD",
+      "counterparty": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2"
+    },
+    "counterparty": {
+      "limit": "100",
+      "ripplingDisabled": true
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "JOE",
+      "counterparty": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2"
+    },
+    "counterparty": {
+      "limit": "100",
+      "ripplingDisabled": true
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "10.01037626125837",
+      "currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000",
+      "counterparty": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
+      "ripplingDisabled": true
+    },
+    "counterparty": {
+      "limit": "0"
+    },
+    "state": {
+      "balance": "0"
+    }
+  },
+  {
+    "specification": {
+      "limit": "0",
+      "currency": "USD",
+      "counterparty": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF",
+      "frozen": true
+    },
+    "counterparty": {
+      "limit": "1"
+    },
+    "state": {
+      "balance": "0"
+    }
+  }
+]

test/fixtures/responses/index.js

@@ -6,6 +6,7 @@ module.exports = {
   getBalances: require('./get-balances.json'),
   getBalanceSheet: require('./get-balance-sheet.json'),
   getOrderbook: require('./get-orderbook.json'),
+  getOrderbookWithXRP: require('./get-orderbook-with-xrp.json'),
   getOrders: require('./get-orders.json'),
   getPaths: {
     XrpToUsd: require('./get-paths.json'),
@@ -20,6 +21,8 @@ module.exports = {
     orderWithExpirationCancellation:
       require('./get-transaction-order-with-expiration-cancellation.json'),
     order: require('./get-transaction-order.json'),
+    orderSell: require('./get-transaction-order-sell.json'),
+    noMeta: require('./get-transaction-no-meta.json'),
     payment: require('./get-transaction-payment.json'),
     settings: require('./get-transaction-settings.json'),
     trustline: require('./get-transaction-trustline-set.json'),
@@ -31,26 +34,37 @@ module.exports = {
     notValidated: require('./get-transaction-not-validated.json'),
     suspendedPaymentCreation:
       require('./get-transaction-suspended-payment-create.json'),
+    SuspendedPaymentCreationIOU:
+      require('./get-transaction-suspended-payment-create-iou.json'),
     suspendedPaymentCancellation:
       require('./get-transaction-suspended-payment-cancellation.json'),
     suspendedPaymentExecution:
-      require('./get-transaction-suspended-payment-execution.json')
+      require('./get-transaction-suspended-payment-execution.json'),
+    suspendedPaymentExecutionSimple:
+      require('./get-transaction-suspended-payment-execution-simple.json')
   },
   getTransactions: require('./get-transactions.json'),
+  getTransactionsOne: require('./get-transactions-one.json'),
   getTrustlines: require('./get-trustlines.json'),
+  getTrustlinesAll: require('./get-trustlines-all.json'),
   getLedger: {
     header: require('./get-ledger'),
     full: require('./get-ledger-full'),
-    withSettingsTx: require('./get-ledger-with-settings-tx')
+    withSettingsTx: require('./get-ledger-with-settings-tx'),
+    withStateAsHashes: require('./get-ledger-with-state-as-hashes')
   },
-  prepareOrderCancellation: require('./prepare-order-cancellation.json'),
   prepareOrder: {
     buy: require('./prepare-order.json'),
     sell: require('./prepare-order-sell.json'),
-    expiration: require('./prepare-order-expiration')
+    expiration: require('./prepare-order-expiration'),
+    cancellation: require('./prepare-order-cancellation.json'),
+    cancellationNoInstructions:
+      require('./prepare-order-cancellation-no-instructions.json')
   },
   preparePayment: {
     normal: require('./prepare-payment.json'),
+    minAmountXRP: require('./prepare-payment-min-amont-xrp.json'),
+    minAmountXRPXRP: require('./prepare-payment-min-amont-xrp-xrp.json'),
     allOptions: require('./prepare-payment-all-options.json'),
     noCounterparty: require('./prepare-payment-no-counterparty.json'),
     minAmount: require('./prepare-payment-min-amount.json')
@@ -62,20 +76,28 @@ module.exports = {
     flagSet: require('./prepare-settings-flag-set.json'),
     flagClear: require('./prepare-settings-flag-clear.json'),
     setTransferRate: require('./prepare-settings-set-transfer-rate.json'),
-    fieldClear: require('./prepare-settings-field-clear.json')
+    fieldClear: require('./prepare-settings-field-clear.json'),
+    noInstructions: require('./prepare-settings-no-instructions.json')
   },
   prepareSuspendedPaymentCreation:
     require('./prepare-suspended-payment-creation'),
+  prepareSuspendedPaymentCreationFull:
+    require('./prepare-suspended-payment-creation-full'),
   prepareSuspendedPaymentExecution:
     require('./prepare-suspended-payment-execution'),
+  prepareSuspendedPaymentExecutionSimple:
+    require('./prepare-suspended-payment-execution-simple'),
   prepareSuspendedPaymentCancellation:
     require('./prepare-suspended-payment-cancellation'),
+  prepareSuspendedPaymentCancellationMemos:
+    require('./prepare-suspended-payment-cancellation-memos'),
   prepareTrustline: {
     simple: require('./prepare-trustline-simple.json'),
+    frozen: require('./prepare-trustline-frozen.json'),
     complex: require('./prepare-trustline.json')
   },
   sign: require('./sign.json'),
   signSuspended: require('./sign-suspended.json'),
   submit: require('./submit.json'),
-  ledgerClosed: require('./ledger-closed.json')
+  ledgerEvent: require('./ledger-event.json')
 };

test/fixtures/responses/ledger-event.json

@@ -1,11 +1,10 @@
 {
-  "feeBase": 10,
-  "feeReference": 10,
+  "baseFeeXRP": "0.00001",
   "ledgerVersion": 14804627,
   "ledgerHash": "9141FA171F2C0CE63E609466AF728FF66C12F7ACD4B4B50B0947A7F3409D593A",
   "ledgerTimestamp": "2015-07-23T05:50:40.000Z",
-  "reserveBase": 20000000,
-  "reserveIncrement": 5000000,
+  "reserveBaseXRP": "20",
+  "reserveIncrementXRP": "5",
   "transactionCount": 19,
   "validatedLedgerVersions": "13983423-14804627"
 }

test/fixtures/responses/prepare-order-cancellation-no-instructions.json

@@ -0,0 +1,8 @@
+{
+  "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"OfferCancel\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"OfferSequence\":23,\"LastLedgerSequence\":8819954,\"Fee\":\"12\",\"Sequence\":23}",
+  "instructions": {
+    "fee": "0.000012",
+    "sequence": 23,
+    "maxLedgerVersion": 8819954
+  }
+}