Merge branch 'develop'

Bump version to 0.13.0

.flowconfig

@@ -0,0 +1,14 @@
+[ignore]
+.*/ripple-lib/src/.*
+.*/ripple-lib/dist/.*
+.*/ripple-lib/test/fixtures/.*
+.*/node_modules/flow-bin/.*
+.*/node_modules/webpack/.*
+
+[include]
+./node_modules/
+
+[libs]
+
+[options]
+module.system=node

.gitignore

@@ -17,7 +17,7 @@
 
 # Ignore object files.
 *.o
-build/ripple*.js
+build/
 tags
 bin/rippled
 Debug/*.*
@@ -25,6 +25,7 @@ Release/*.*
 
 # Ignore locally installed node_modules
 node_modules
+!test/node_modules
 
 # Ignore tmp directory.
 tmp
@@ -51,4 +52,12 @@ test/config.js
 npm-debug.log
 
 # Ignore dist folder, build for bower
-dist/
+dist/
+
+# Ignore flow output directory
+out/
+
+# Ignore perf test cache
+scripts/cache
+
+eslintrc

.npmignore

@@ -1,3 +1,4 @@
-deploy
 lib-cov
 coverage.html
+src
+dist/bower

.travis.yml

@@ -1,13 +0,0 @@
-language: node_js
-node_js:
-  - "0.10"
-script: npm test --coverage
-after_success:
-- npm run coveralls
-notifications:
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/d1ec4245f90231619d30
-    on_success: change  # options: [always|never|change] default: always
-    on_failure: always  # options: [always|never|change] default: always
-    on_start: false     # default: false

Gulpfile.js

@@ -1,163 +1,129 @@
+/* eslint-disable no-var, no-param-reassign */
+/* these eslint rules are disabled because gulp does not support babel yet */
+'use strict';
+var _ = require('lodash');
 var gulp = require('gulp');
-var concat = require('gulp-concat');
 var uglify = require('gulp-uglify');
 var rename = require('gulp-rename');
 var webpack = require('webpack');
-var jshint = require('gulp-jshint');
-var map = require('map-stream');
 var bump = require('gulp-bump');
 var argv = require('yargs').argv;
-//var header = require('gulp-header');
 
 var pkg = require('./package.json');
 
-var banner = '/*! <%= pkg.name %> - v<%= pkg.version %> - '
-+ '<%= new Date().toISOString() %>\n'
-+ '<%= pkg.homepage ? "* " + pkg.homepage + "\n" : "" %>'
-+ '* Copyright (c) <%= new Date().getFullYear() %> <%= pkg.author.name %>;'
-+ ' Licensed <%= pkg.license %> */'
-
-var sjclSrc = [
-  'src/js/sjcl/core/sjcl.js',
-  'src/js/sjcl/core/aes.js',
-  'src/js/sjcl/core/bitArray.js',
-  'src/js/sjcl/core/codecString.js',
-  'src/js/sjcl/core/codecHex.js',
-  'src/js/sjcl/core/codecBase64.js',
-  'src/js/sjcl/core/codecBytes.js',
-  'src/js/sjcl/core/sha256.js',
-  'src/js/sjcl/core/sha512.js',
-  'src/js/sjcl/core/sha1.js',
-  'src/js/sjcl/core/ccm.js',
-  // 'src/js/sjcl/core/cbc.js',
-  // 'src/js/sjcl/core/ocb2.js',
-  'src/js/sjcl/core/hmac.js',
-  'src/js/sjcl/core/pbkdf2.js',
-  'src/js/sjcl/core/random.js',
-  'src/js/sjcl/core/convenience.js',
-  'src/js/sjcl/core/bn.js',
-  'src/js/sjcl/core/ecc.js',
-  'src/js/sjcl/core/srp.js',
-  'src/js/sjcl-custom/sjcl-ecc-pointextras.js',
-  'src/js/sjcl-custom/sjcl-secp256k1.js',
-  'src/js/sjcl-custom/sjcl-ripemd160.js',
-  'src/js/sjcl-custom/sjcl-extramath.js',
-  'src/js/sjcl-custom/sjcl-montgomery.js',
-  'src/js/sjcl-custom/sjcl-validecc.js',
-  'src/js/sjcl-custom/sjcl-ecdsa-canonical.js',
-  'src/js/sjcl-custom/sjcl-ecdsa-der.js',
-  'src/js/sjcl-custom/sjcl-ecdsa-recoverablepublickey.js',
-  'src/js/sjcl-custom/sjcl-jacobi.js'
-];
-
-gulp.task('concat-sjcl', function() {
-  return gulp.src(sjclSrc)
-  .pipe(concat('sjcl.js'))
-  .pipe(gulp.dest('./build/'));
-});
-
-gulp.task('build', [ 'concat-sjcl' ], function(callback) {
-  webpack({
+function webpackConfig(extension, overrides) {
+  overrides = overrides || {};
+  var defaults = {
     cache: true,
-    entry: './src/js/ripple/index.js',
+    entry: './src/index.js',
     output: {
       library: 'ripple',
       path: './build/',
-      filename: [ 'ripple-', '.js' ].join(pkg.version)
+      filename: ['ripple-', extension].join(pkg.version)
     },
-  }, callback);
+    module: {
+      loaders: [{
+        test: /\.js$/,
+        exclude: /node_modules/,
+        loader: 'babel-loader?optional=runtime'
+      }, {
+        test: /\.json/,
+        loader: 'json-loader'
+      }]
+    }
+  };
+  return _.assign({}, defaults, overrides);
+}
+
+gulp.task('build', function(callback) {
+  webpack(webpackConfig('.js'), callback);
 });
 
-gulp.task('bower-build', [ 'build' ], function(callback) {
-  return gulp.src([ './build/ripple-', '.js' ].join(pkg.version))
+gulp.task('build-min', ['build'], function() {
+  return gulp.src(['./build/ripple-', '.js'].join(pkg.version))
+  .pipe(uglify())
+  .pipe(rename(['ripple-', '-min.js'].join(pkg.version)))
+  .pipe(gulp.dest('./build/'));
+});
+
+gulp.task('build-debug', function(callback) {
+  var configOverrides = {debug: true, devtool: 'eval'};
+  webpack(webpackConfig('-debug.js', configOverrides), callback);
+});
+
+/**
+ * Generate a WebPack external for a given unavailable module which replaces
+ * that module's constructor with an error-thrower
+ */
+
+function buildUseError(cons) {
+  return ('var {<CONS>:function(){throw new Error('
+          + '"Class is unavailable in this build: <CONS>")}}')
+          .replace(new RegExp('<CONS>', 'g'), cons);
+}
+
+gulp.task('build-core', function(callback) {
+  var configOverrides = {
+    cache: false,
+    entry: './src/remote.js',
+    externals: [{
+      './transaction': buildUseError('Transaction'),
+      './orderbook': buildUseError('OrderBook'),
+      './account': buildUseError('Account'),
+      './serializedobject': buildUseError('SerializedObject')
+    }],
+    plugins: [
+      new webpack.optimize.UglifyJsPlugin()
+    ]
+  };
+  webpack(webpackConfig('-core.js', configOverrides), callback);
+});
+
+gulp.task('bower-build', ['build'], function() {
+  return gulp.src(['./build/ripple-', '.js'].join(pkg.version))
   .pipe(rename('ripple.js'))
-  .pipe(gulp.dest('./dist/'));
+  .pipe(gulp.dest('./dist/bower'));
 });
 
-gulp.task('bower-build-min', [ 'build-min' ], function(callback) {
-  return gulp.src([ './build/ripple-', '-min.js' ].join(pkg.version))
+gulp.task('bower-build-min', ['build-min'], function() {
+  return gulp.src(['./build/ripple-', '-min.js'].join(pkg.version))
   .pipe(rename('ripple-min.js'))
-  .pipe(gulp.dest('./dist/'));
+  .pipe(gulp.dest('./dist/bower'));
 });
 
-gulp.task('bower-build-debug', [ 'build-debug' ], function(callback) {
-  return gulp.src([ './build/ripple-', '-debug.js' ].join(pkg.version))
+gulp.task('bower-build-debug', ['build-debug'], function() {
+  return gulp.src(['./build/ripple-', '-debug.js'].join(pkg.version))
   .pipe(rename('ripple-debug.js'))
-  .pipe(gulp.dest('./dist/'));
+  .pipe(gulp.dest('./dist/bower'));
 });
 
 gulp.task('bower-version', function() {
-  gulp.src('./dist/bower.json')
+  gulp.src('./dist/bower/bower.json')
   .pipe(bump({version: pkg.version}))
-  .pipe(gulp.dest('./dist/'));
+  .pipe(gulp.dest('./dist/bower'));
+});
+
+gulp.task('bower', ['bower-build', 'bower-build-min', 'bower-build-debug',
+                    'bower-version']);
+
+gulp.task('watch', function() {
+  gulp.watch('src/*', ['build-debug']);
 });
 
 gulp.task('version-bump', function() {
   if (!argv.type) {
-    throw new Error("No type found, pass it in using the --type argument");
+    throw new Error('No type found, pass it in using the --type argument');
   }
+
   gulp.src('./package.json')
-  .pipe(bump({type:argv.type}))
+  .pipe(bump({type: argv.type}))
   .pipe(gulp.dest('./'));
 });
 
 gulp.task('version-beta', function() {
   gulp.src('./package.json')
-  .pipe(bump({version: pkg.version+'-beta'}))
+  .pipe(bump({version: pkg.version + '-beta'}))
   .pipe(gulp.dest('./'));
 });
 
-gulp.task('build-min', [ 'build' ], function(callback) {
-  return gulp.src([ './build/ripple-', '.js' ].join(pkg.version))
-  .pipe(uglify())
-  .pipe(rename([ 'ripple-', '-min.js' ].join(pkg.version)))
-  .pipe(gulp.dest('./build/'));
-});
-
-gulp.task('build-debug', [ 'concat-sjcl' ], function(callback) {
-  webpack({
-    cache: true,
-    entry: './src/js/ripple/index.js',
-    output: {
-      library: 'ripple',
-      path: './build/',
-      filename: [ 'ripple-', '-debug.js' ].join(pkg.version)
-    },
-    debug: true,
-    devtool: 'eval'
-  }, callback);
-});
-
-gulp.task('lint', function() {
-  gulp.src('src/js/ripple/*.js')
-  .pipe(jshint())
-  .pipe(map(function(file, callback) {
-    if (!file.jshint.success) {
-      console.log('\nIn', file.path);
-
-      file.jshint.results.forEach(function(err) {
-        if (err && err.error) {
-          var col1 = err.error.line + ':' + err.error.character;
-          var col2 = '[' + err.error.reason + ']';
-          var col3 = '(' + err.error.code + ')';
-
-          while (col1.length < 8) {
-            col1 += ' ';
-          }
-
-          console.log('  ' + [ col1, col2, col3 ].join(' '));
-        }
-      });
-    }
-
-    callback(null, file);
-  }));
-});
-
-gulp.task('watch', function() {
-  gulp.watch('src/js/ripple/*', [ 'build-debug' ]);
-});
-
-gulp.task('default', [ 'concat-sjcl', 'build', 'build-debug', 'build-min' ]);
-
-gulp.task('bower', ['bower-build', 'bower-build-min', 'bower-build-debug', 'bower-version']);
+gulp.task('default', ['build', 'build-debug', 'build-min']);

HISTORY.md

@@ -1,3 +1,329 @@
+##0.13.0
+
+**Breaking Changes**
++ Add new RippleAPI interface and delete old API
+    - [RippleAPI README and samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
+    - [Method documentation](https://rawgit.com/ripple/ripple-lib/develop/docs/api.html)
+
+**Changes**
++ [Removed timeout method of Request and added default timeout](https://github.com/ripple/ripple-lib/commit/634fe5683a9082e57682ff7d5c4fb9483b4af818)
++ [Add Remote.closeCurrentPathFind function, so current pathfind can be properly closed](https://github.com/ripple/ripple-lib/commit/e99010f363fc7cbe7fd547d3ca5b32ea083c44e6)
++ [Implement Balance Sheet API](https://github.com/ripple/ripple-lib/pull/579)
++ [Fix bugs in orderbook subscription](https://github.com/ripple/ripple-lib/commit/7404795dc64a85216148de7bc3ca7da7b33f4490)
++ [Fix crash due to rippled slowDown error](https://github.com/ripple/ripple-lib/commit/84838b2e9f6969b593b8462a62a6b8f516ada937)
++ [Fix: Emit error events and return error on pathfind](https://github.com/ripple/ripple-lib/commit/1ccbaf677631a1944eb05d90f7afc5f3690a03dd)
++ [Deprecate core and remove snake case method copying](https://github.com/ripple/ripple-lib/commit/fb8dc44ec1d49bb05cd0cdbe6dd4ab211195868a)
+
++ [Fix RangeSet for validated_ledger as single ledger](https://github.com/ripple/ripple-lib/commit/9f9e76f8b933201651af59307135f67cfa7d60e8)
++ [Fix bug where the paths would be set with an empty array](https://github.com/ripple/ripple-lib/commit/83874ec0962da311b76f2385623e51c68bc39035)
++ [Fix reserve calculation](https://github.com/ripple/ripple-lib/commit/52879febb92d876f01f2e4d70871baa07af631fb)
+
+##0.12.9
+
++ [OrderBook performance optimizations](https://github.com/ripple/ripple-lib/commit/3e17d91edf36745f6b6c09b0ad88971b7775f6ab)
+
+##0.12.7 and 0.12.8
+
++ [Improve performance of orderbook](https://github.com/ripple/ripple-lib/commit/c745faaaf0956ca98448a754b4fe97fb50574fc7)
+
++ [Remove Firefox warning about prototype overwrite](https://github.com/ripple/ripple-lib/commit/0c62fa21123b220b066871e1c41a3b4fe6f51885)
+
++ [Fix compare bug in Amount class](https://github.com/ripple/ripple-lib/commit/806547dd154e1b0bf252e8a74ad3ac6aa8a97660)
+
+##0.12.6
+
++ [Fix webpack require failure due to "./" notation](https://github.com/ripple/ripple-lib/commit/8d9746d7b10be203ee613df523c2522012ff1baf)
+
+##0.12.15
+
++ [Add offer autobridging](https://github.com/ripple/ripple-lib/commit/c7bbce83719c1e8c6a4fae5ca850e7515db1a4a5)
+
++ [Prevent crash when listening for "model" events on the OrderBook class](https://github.com/ripple/ripple-lib/commit/5824c3cb7cb6bd834d6e037f69943aebf3d83351)
+
++ [Fix empty order edgecase](https://github.com/ripple/ripple-lib/commit/64809d9ae23dc24f47accd4b4788b48f49880d3e)
+
++ [Fix AutobridgeCalculator (RT-3445)](https://github.com/ripple/ripple-lib/commit/1fff5ea6dcbcee856536df26f3b9cf1aec3c3b55)
+
++ [Update sjcl and delete custom ripemd160, montgomery, and jacobi](https://github.com/ripple/ripple-lib/commit/50cda426eb83599c38c0b725e1524a01fc415da2)
+
++ [Fix transaction summary for transactions that fail with remoteError](https://github.com/ripple/ripple-lib/commit/5e714f6143464d7912f42537acaa553b88eaf6dc)
+
++ [Fix serializedobject append for excessively large bytes length](https://github.com/ripple/ripple-lib/commit/e93f1ab6f4aaad347450aee75a169af0faa2121c)
+
++ [Switch to sjcl npm module](https://github.com/ripple/ripple-lib/commit/9a502580fd89ec6a9aa55f4e5847f6a4a2cb5bba)
+
++ [Add babel transpiler](https://github.com/ripple/ripple-lib/commit/398f8d001f758bf575b959537a17e79e4042d17b)
+
++ [Remove unused float.js and wallet.js](https://github.com/ripple/ripple-lib/commit/d4a4b5f4fbbf09677a59ce81bace35c6426a2fda)
+
++ [Remove config singleton to reduce global state](https://github.com/ripple/ripple-lib/commit/c655c2a20ee5d150a4b5a1b6717b9fb81f636025)
+
+##0.12.4
+
++ [Improve entropy security](https://github.com/ripple/ripple-lib/commit/c7ba822320880037796f57876d1abb4e525648ed)
+
++ [Remove unused crypt.js file](https://github.com/ripple/ripple-lib/commit/1f68eba1461bca03a4d22872450d15ae5a185334)
+
+##0.12.3
+
++ [Add getLedgerSequence to Remote](https://github.com/ripple/ripple-lib/commit/d09548d04d3238fca653d482ec1d5faa7254559a)
+
++ [Improve randomness when generating ECDSA signatures](https://github.com/ripple/ripple-lib/commit/fe7e30b737ead6e71adfa466f5835ba546feab31)
+
++ [Improve SerializedObject.append performance](https://github.com/ripple/ripple-lib/commit/f7c35b118ebba549a64bcaa1a0629385ec6dbf6f)
+
++ [Add `Amount.scale`. Multiply an amount’s value by a scale factor](https://github.com/ripple/ripple-lib/commit/74dac97b368493056474468520f05671f458a69f)
+
+
+##0.12.2
+
++ [Check that stack trace is available, fixes logging in browser](https://github.com/ripple/ripple-lib/commit/53cae3a66d48e88e8a6bbb96d6489ce7b9e22975)
+
+
+##0.12.1
+
+**Breaking Changes**
+
++ [Removed support for parsing native amounts in floating point format](https://github.com/ripple/ripple-lib/commit/e80cd1ff55deae9cd5b0ae85be957f86856b887e)
+
+
+**Changes**
+
++ [Fix taker pays funded calculation](https://github.com/ripple/ripple-lib/commit/5af824f5cf46c7b9caa58ee0a757bf854d26c8dc)
+
++ [Fix order funded amount calculation](https://github.com/ripple/ripple-lib/commit/b2cdb1a6aed968b1f306e8dadbd4b7ca37e5aa03)
+
++ [Fix handling of quality in order book](https://github.com/ripple/ripple-lib/commit/2a5a8b498da60df738ba18d5c265f34771e8a1af)
+
++ [Fix currency parsing of non-alphanumeric and no-currency currencies](https://github.com/ripple/ripple-lib/commit/2166bb2e88eae8d5f1aba77338f69e8a9edf6a6f)
+
++ [Add Amount.strict_mode for toggling range validation](https://github.com/ripple/ripple-lib/commit/b5ed8f59a7dab1a17491618b8d9193646c314fb4)
+
++ [Add filename and line number to log, use log.warn() for deprecations](https://github.com/ripple/ripple-lib/commit/90329d3d73f1a76675063655b407513e32dc048b)
+
++ [Add GlobalFreeze and NoFreeze flags](https://github.com/ripple/ripple-lib/commit/e2ed2bdbf6f01c7d4d690c2cf0b83fba94558dd7)
+
++ [Fix handling of falsy parameters in requestLedger](https://github.com/ripple/ripple-lib/commit/6023efed41b7812b3bab660a1c0dc9f0a21000b9)
+
++ [Fix Base:decode](https://github.com/ripple/ripple-lib/commit/719f39c01c6941d9a650aa94f95617793dd53ea0)
+
++ [Fix Amount: clone in ratio_human, product_human](https://github.com/ripple/ripple-lib/commit/19e17a8431550cf156b1ad669a19dedfe4e28e4a)
+
++ [Fix Amount.to_human for very small numbers](https://github.com/ripple/ripple-lib/commit/6abfa759aa09d68074ac558d96c4b126a7cd1719)
+
++ [Refactor base conversion](https://github.com/ripple/ripple-lib/commit/f2b63fa4a80663eb29472bc6bb1aea8159f1f205)
+
++ [Update binary transaction format](https://github.com/ripple/ripple-lib/commit/8e134918fb4c22983320a3102f955e4568bb1dfb)
+
++ [Add DefaultRipple account flag](https://github.com/ripple/ripple-lib/commit/3e249902c4cf25b4da5e75048c84ae391be83b10)
+
++ [Remove `Features` field requirement in `SetFee` transaction format](https://github.com/ripple/ripple-lib/commit/a20a649013646710c078d4ce1e210f87c7fe74fe)
+
++ [Remove `RegularKey` field requirement in `SetRegularKey` transaction format](https://github.com/ripple/ripple-lib/commit/c275174f27877ba8f389eb4efe969feb514d6e46)
+
+
+##0.12.0
+
+**Breaking Changes**
+
++ REMOVED Remote storage interface
++ REMOVED Remote `ping` configuration
++ REMOVED Old/deprecated Remote server configuration (websocket_ip, websocket_port)
++ REMOVED browser `online` reconnect listener
+    - [Cleanup, deprecations - 2833a7b6](https://github.com/ripple/ripple-lib/commit/2833a7b66e696dab427464625077f9b93092d0d5)
+
++ Remove `jsbn` and use `bignumber.js` instead for big number math
++ The `allow_nan` flag has been removed. Results for invalid amounts will always be `NaN`
+    - [Refactor to use bignumber.js - d025b4a0](https://github.com/ripple/ripple-lib/commit/d025b4a0c3a98a6de27a1bee9573c85347bcd66b)
+    - [Handle invalid input in parse_human - c8f18c8c](https://github.com/ripple/ripple-lib/commit/c8f18c8c8590b7b48e370e0325b6677b7720294f)
+    - [Check for null in isNumber - b86790c8](https://github.com/ripple/ripple-lib/commit/b86790c8543c239a532fd7697d4652829019d385)
+    - [Cleanup amount.js - d0fb291c](https://github.com/ripple/ripple-lib/commit/d0fb291c4e330193a244902156f1d74730da357d)
+
+
+**Changes**
+
++ [Add deprecation warnings to request constructors. The first argument to request constructor functions should be an object containing request properties](https://github.com/ripple/ripple-lib/commit/35d76b3520934285f80059c1badd6c522539104c)
+
++ [Fix taker_gets_funded exceeding offer.TakerGets](https://github.com/ripple/ripple-lib/commit/b19ecb4482b589d575382b7a5d0480b963383bb1)
+
++ [Fix unsymmetric memo serializing](https://github.com/ripple/ripple-lib/commit/1ed36fabdbd54f4d31078c2b0eaa3becc0fe2821)
+
++ [Fix IOU value passed to `Amount.from_json()`](https://github.com/ripple/ripple-lib/commit/fd1b64393dffb3d1819cd40b8d43df43a4db042d)
+
++ [Update transaction binary parsing to account for XRP delivered amounts](https://github.com/ripple/ripple-lib/commit/35a346a674e6ee1e1e495db93700d55984efc7dd)
+
++ [Bumped dependencies](https://github.com/ripple/ripple-lib/commit/f9bc7cc746b44b24b61bbe260ae2e9d9617286da)
+
+
+
+##0.11.0
+
++ [Track the funded status of an order based on cumulative account orders](https://github.com/ripple/ripple-lib/commit/67d39737a4d5e0fcd9d9b47b9083ee00e5a9e652) and [67d3973](https://github.com/ripple/ripple-lib/commit/b6b99dde022e1e14c4797e454b1d7fca50e49482)
+
++ Remove blobvault client from ripple-lib, use the [`ripple-vault-client`](https://github.com/ripple/ripple-vault-client) instead [9b3d62b7](https://github.com/ripple/ripple-lib/commit/9b3d62b765c4c25beae6eb0fa57ef3a07f2581b1)
+
++ [Add support for `ledger` option in requestBookOffers](https://github.com/ripple/ripple-lib/commit/34c0677c453c409ef0a5b351959abdc176d3bacb)
+
++ [Add support for `limit` option in requestBookOffers](https://github.com/ripple/ripple-lib/commit/d1d4452217c878d0b377d24830b4cd8b3162f6e0)
+
++ [Add `ledgerSelect` request constructor in `Remote`](https://github.com/ripple/ripple-lib/commit/98f40abfc3aa74dec5067a2d90002756cc8acd01)
+
++ [Default to binary data for commands that accept the binary flag](https://github.com/ripple/ripple-lib/commit/7cb113fcbcfc1e3e9830a999148b3e78df3387cc)
+
++ [Fix metadata account check](https://github.com/ripple/ripple-lib/commit/3f61598d6c87e3cc877af60e2d515f9eff73dfe1)
+
++ [Double check `tes` code before emitting `success`](https://github.com/ripple/ripple-lib/commit/97a8c874903eb7309d8f755955ac80872f670582)
+
++ [Decrease redundancy in binary account_tx parsing](https://github.com/ripple/ripple-lib/commit/0aba638e6e7f4f6e22cb6424eed3897ebad90a5a)
+
++ [Abort server connection on unrecoverable TLS error](https://github.com/ripple/ripple-lib/commit/000a2ea00c57157044aeca0fb3f24b37669b163c)
+
++ [Fix complete ledgers check on subscription that is not initial](https://github.com/ripple/ripple-lib/commit/89de91301e682a46dc60aaacc7ae152e8fe1b7c7)
+
+
+##0.10.0
+
++ [Transaction changes](https://github.com/ripple/ripple-lib/pull/221)
+
++ **Important** `tef*` and `tel*` and errors will no longer be presented as
+final. Rather than considering these errors final, ripple-lib will wait until
+the `LastLedgerSequence` specified in the transaction is exceeded.  This makes
+failures more definitive, and ensures that no transaction will resubmit
+indefinitely.
+
++ A new, final tej-class error is introduced to account for transactions that
+are locally determined to have expired: `tejMaxLedger`.
+
++ [Allow per transaction fees to be set, `transaction.setFixedFee()`](https://github.com/ripple/ripple-lib/commit/9b22f279bcbe60ee6bcf4b7fa60a48e9c197a828)
+
++ [Improve memo support](https://github.com/ripple/ripple-lib/commit/1704ac4ae144c0ce54afad86f644c75a632080b1)
+    - Add `MemoFormat` property for memo
+    - Enforce `MemoFormat` and `MemoType` to be valid ASCII
+    - Support `text` and `json` MemoFormat
+
++ [Update jscl library](https://github.com/ripple/ripple-lib/commit/3204998fcb6f31d6c90532a737a4adb8a1e420f6)
+    - Improved entropy by taking advantage of platform crypto
+    - Use jscl's k256 curve instead of altering the c256 curve with k256 configuration
+    - **deprecated:** the c256 curve is linked to the k256 curve to provide backwards compatibility, this link will be removed in the future
+
++ [Fix empty queue check on reconnect](https://github.com/ripple/ripple-lib/commit/3c21994adcf72d1fbd87d453ceb917f9ad6df4ec)
+
+##0.9.4
+
++ [Normalize offers from book_offers and transaction stream](https://github.com/ripple/ripple-lib/commit/86ed24b94cf7c8929c87db3a63e9bbea7f767e9c)
+
++ [Fix: Amount.to_human() precision rounding](https://github.com/ripple/ripple-lib/commit/e371cc2c3ceccb3c1cfdf18b98d80093147dd8b2)
+
++ [Fix: fractional drops in funded taker_pays setter](https://github.com/ripple/ripple-lib/commit/0d7fc0a573a144caac15dd13798b23eeb1f95fb4)
+
+##0.9.3
+
++ [Change `presubmit` to emit immediately before transaction submit](https://github.com/ripple/ripple-lib/commit/7a1feaa89701bf861ab31ebd8ffdc8d8d1474e29)
+
++ [Add a "core" browser build of ripple-lib which has a subset of features and smaller file size](https://github.com/ripple/ripple-lib/pull/205)
+
++ [Update binformat with missing fields from rippled](https://github.com/ripple/ripple-lib/commit/cae980788efb00191bfd0988ed836d60cdf7a9a2)
+
++ [Wait for transaction validation before returning `tec` error](https://github.com/ripple/ripple-lib/commit/6bdd4b2670906588852fc4dda457607b4aac08e4)
+
++ [Change default `max_fee` on `Remote` to `1 XRP`](https://github.com/ripple/ripple-lib/commit/d6b1728c23ff85c3cc791bed6982a750641fd95f)
+
++ [Fix: Request ledger_accept should return the Remote](https://github.com/ripple/ripple-lib/pull/209)
+
+##0.9.2
+
++ [**Breaking change**: Change accountRequest method signature](https://github.com/ripple/ripple-lib/commit/6f5d1104aa3eb440c518ec4f39e264fdce15fa15)
+
++ [Add paging behavior for account requests, `account_lines` and `account_offers`](https://github.com/ripple/ripple-lib/commit/722f4e175dbbf378e51b49142d0285f87acb22d7)
+
++ [Add max_fee setter to transactions to set max fee the submitter is willing to pay] (https://github.com/ripple/ripple-lib/commit/24587fab9c8ad3840d7aa345a7037b48839e09d7)
+
++ [Fix: cap IOU Amounts to their max and min value] (https://github.com/ripple/ripple-lib/commit/f05941fbc46fdb7c6fe7ad72927af02d527ffeed)
+
+Example on how to use paging with `account_offers`:
+```
+// A valid `ledger_index` or `ledger_hash` is required to provide a reliable result.
+// Results can change between ledger closes, so the provided ledger will be used as base.
+var options = {
+    account: < rippleAccount >,
+    limit: < Number between 10 and 400 >,
+    ledger: < valid ledger_index or ledger_hash >
+}
+
+// The `marker` comes back in an account request if there are more results than are returned
+// in the current response. The amount of results per response are determined by the `limit`.
+if (marker) {
+    options.marker = < marker >;
+}
+
+var request = remote.requestAccountOffers(options);
+```
+
+[Full working example](https://github.com/geertweening/ripple-lib-scripts/blob/master/account_offers_paging.js)
+
+
+##0.9.1
+
++ Switch account requests to use ledgerSelect rather than ledgerChoose ([278df90](https://github.com/ripple/ripple-lib/commit/278df9025a20228de22379a53c76ca12d40fa591))
+
++ **Deprecated** setting `ident` and `account_index` on account requests ([278df90](https://github.com/ripple/ripple-lib/commit/278df9025a20228de22379a53c76ca12d40fa591))
+
++ Change initial account transaction sequence to 1 ([a3c1d06](https://github.com/ripple/ripple-lib/commit/a3c1d06eba883dc84fe2bfe700e4309795c84cac))
+
++ Fix: instance transaction withoute remote ([d3b6b81](https://github.com/ripple/ripple-lib/commit/d3b6b8127c7b01e416b400c25abf1719bdd008ca))
+
++ Fix: account root request ledger argument ([bc1f9f8](https://github.com/ripple/ripple-lib/commit/bc1f9f8a286b187d36ebaf552694e31e73742293))
+
++ Fix: rsign.js local signing and example ([d3b6b81](https://github.com/ripple/ripple-lib/commit/d3b6b8127c7b01e416b400c25abf1719bdd008ca) and [f1004c6](https://github.com/ripple/ripple-lib/commit/f1004c6db2a0ce59bbabbb8f2b355a9fd9995fd8))
+
+
+##0.9.0
+
++ Add routes to the vault client for KYC attestations ([ed2da574](https://github.com/ripple/ripple-lib/commit/ed2da57475acf5e9d2cf3373858f4274832bd83f))
+
++ Currency: add `show_interest` flag to show or hide interest in `Currency.to_human()` and `Currency.to_json()` [Example use in tests](https://github.com/ripple/ripple-lib/blob/947ec3edc2e7c8f1ef097e496bf552c74366e749/test/currency-test.js#L123)
+
++ Configurable maxAttempts for transaction submission ([d107092](https://github.com/ripple/ripple-lib/commit/d10709254061e9e4416d2cb78b5cac1ec0d7ffa5))
+
++ Binformat: added missing TransactionResult options ([6abed8d](https://github.com/ripple/ripple-lib/commit/6abed8dd5311765b2eb70505dadbdf5121439ca8))
+
++ **Breaking change:** make maxLoops in seed.get_key optional. [Example use in tests](https://github.com/ripple/ripple-lib/blob/23e473b6886c457781949c825b3ff48b3984e51f/test/seed-test.js) ([23e473b](https://github.com/ripple/ripple-lib/commit/23e473b6886c457781949c825b3ff48b3984e51f))
+
++ Shrinkwrap packages for dependency locking ([2dcd5f9](2dcd5f94fbc71200eb08a5044c76ef94f7971913))
+
++ Fix: Amount.to_human() precision bugs ([4be209e](https://github.com/ripple/ripple-lib/commit/4be209e286b5b209bec7bcd1212098985e15ff2f) and [7708c64](https://github.com/ripple/ripple-lib/commit/7708c64576e70ce3ac190442daceb30e4446aab7))
+
++ Fix: change handling of requestLedger options ([57b7030](https://github.com/ripple/ripple-lib/commit/57b70300f5f0c7534ede118ddbb5d8762668a4f8))
+
+
+##0.8.2
+
++ Currency: Allow mixed letters and numbers in currencies
+
++ Deprecate account_tx map/reduce/filterg
+
++ Fix: correct requestLedger arguments
+
++ Fix: missing subscription on error events for some server methods
+
++ Fix: orderbook reset on reconnect
+
++ Fix: ripple-lib crashing. Add potential missing error handlers
+
+
+##0.8.1
+
++ Wallet: Add Wallet class that generates wallets
+
++ Make npm test runnable in Windows.
+
++ Fix several stability issues, see merged PR's for details
+
++ Fix bug in Amount.to_human_full()
+
++ Fix undefined fee states when connecting to a rippled that is syncing
+
+
 ##0.8.0
 
 + Orderbook: Added tracking of offer funds for determining when offers are not funded

LICENSE

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

README.md

@@ -1,85 +1,37 @@
 #ripple-lib
 
-JavaScript client for [rippled](https://github.com/ripple/rippled)
+A JavaScript API for interacting with Ripple in Node.js and the browser
 
-[![Build Status](https://travis-ci.org/ripple/ripple-lib.svg?branch=develop)](https://travis-ci.org/ripple/ripple-lib) [![Coverage Status](https://coveralls.io/repos/ripple/ripple-lib/badge.png?branch=develop)](https://coveralls.io/r/ripple/ripple-lib?branch=develop)
+[![Circle CI](https://circleci.com/gh/ripple/ripple-lib/tree/develop.svg?style=svg)](https://circleci.com/gh/ripple/ripple-lib/tree/develop) [![Coverage Status](https://coveralls.io/repos/ripple/ripple-lib/badge.png?branch=develop)](https://coveralls.io/r/ripple/ripple-lib?branch=develop)
 
 [![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib)
 
 ###Features
 
 + Connect to a rippled server in JavaScript (Node.js or browser)
-+ Issue [rippled API](https://ripple.com/wiki/JSON_Messages) requests
++ Issue [rippled API](https://ripple.com/build/rippled-apis/) requests
 + Listen to events on the Ripple network (transaction, ledger, etc.)
 + Sign and submit transactions to the Ripple network
 
-###In this file
-
-1. [Installation](README.md#installation)
-2. [Quickstart](README.md#quickstart)
-3. [Running tests](https://github.com/ripple/ripple-lib#running-tests)
-
-###Additional documentation
-
-1. [Guides](docs/GUIDES.md)
-2. [API Reference](docs/REFERENCE.md)
-3. [Wiki](https://ripple.com/wiki/Ripple_JavaScript_library)
-
-###Also see
-
-+ [The Ripple wiki](https://ripple.com/wiki)
-+ [ripple.com](https://ripple.com)
-
-##Installation
-
-**Via npm for Node.js**
+##Getting Started
 
+Install `ripple-lib` using npm:
 ```
   $ npm install ripple-lib
 ```
 
-**Building ripple-lib for browser use**
-
-```
-  $ git clone https://github.com/ripple/ripple-lib
-  $ npm install
-  $ npm run build
-```
-
-Then use the minified `build/ripple-*-min.js` in your webpage
-
-##Quickstart
-
-`Remote.js` ([remote.js](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/remote.js)) is the point of entry for interacting with rippled
-
-```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
-
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
-
-var remote = new Remote({
-  // see the API Reference for available options
-  servers: [ 'wss://s1.ripple.com:443' ]
-});
-
-remote.connect(function() {
-  /* remote connected */
-  remote.request('server_info', function(err, info) {
-
-  });
-});
-```
+Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md) and [code samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
 
 ##Running tests
 
 1. Clone the repository
-
 2. `cd` into the repository and install dependencies with `npm install`
+3. `npm test` or `npm test --coverage` (`istanbul` will create coverage reports in coverage/lcov-report/`)
 
-3. `npm test` or `node_modules\.bin\mocha test\*-test.js`
+##Generating Documentation
 
-**Generating code coverage**
+The continuous integration tests require that the documentation stays up-to-date. If you make changes the the JSON schemas, fixtures, or documentation sources, you must update the documentation by running `npm run docgen`.
 
-ripple-lib uses `istanbul` to generate code coverage. To create a code coverage report, run `npm test --coverage`. The report will be created in `coverage/lcov-report/`.
+##More Information
+
++ [Ripple Dev Portal](https://ripple.com/build/)

bench/modpow.js

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

bin/decode_binary.js

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

bin/rsign.js

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

bin/validate_address.js

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

circle.yml

@@ -0,0 +1,7 @@
+machine:
+  node:
+    version: 0.12.0
+test:
+  override:
+    - scripts/ci.sh "$CIRCLE_NODE_INDEX" "$CIRCLE_NODE_TOTAL":
+        parallel: true

deploy/start rippled.bat

@@ -1,3 +0,0 @@
-start newcoin
-sleep 4
-start index.html

docs/GUIDES.md

@@ -1,203 +0,0 @@
-#Guides
-
-This file provides step-by-step walkthroughs for some of the most common usages of `ripple-lib`.
-
-###In this document
-
-1. [Connecting to the Ripple network with `Remote`](GUIDES.md#connecting-to-the-ripple-network)
-2. [Using `Remote` functions and `Request` objects](GUIDES.md#sending-rippled-API-requests)
-3. [Listening to the network](GUIDES.md#listening-to-the-network)
-4. [Submitting a payment to the network](GUIDES.md#submitting-a-payment-to-the-network)
-   * [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees)
-5. [Submitting a trade offer to the network](GUIDES.md#submitting-a-trade-offer-to-the-network)
-
-###Also see
-
-1. [The ripple-lib README](../README.md)
-2. [The ripple-lib API Reference](REFERENCE.md)
-
-##Connecting to the Ripple network
-
-1. [Get ripple-lib](README.md#getting-ripple-lib)
-2. Load the ripple-lib module into a Node.js file or webpage:
-  ```js
-  /* Loading ripple-lib with Node.js */
-  var Remote = require('ripple-lib').Remote;
-
-  /* Loading ripple-lib in a webpage */
-  // var Remote = ripple.Remote;
-  ```
-3. Create a new `Remote` and connect to the network:
-  ```js
-  var remote = new Remote({options});
-
-  remote.connect(function() {
-    /* remote connected, use some remote functions here */
-  });
-  ```
-  __NOTE:__ See the API Reference for available [`Remote` options](REFERENCE.md#1-remote-options)
-
-4. You're connected! Read on to see what to do now.
-
-
-##Sending rippled API requests
-
-`Remote` contains functions for constructing a `Request` object. 
-
-A `Request` is an `EventEmitter` so you can listen for success or failure events -- or, instead, you can provide a callback.
-
-Here is an example, using [request_server_info](https://ripple.com/wiki/JSON_Messages#server_info).
-
-+ Constructing a `Request` with event listeners
-```js
-var request = remote.request('server_info');
-
-request.on('success', function onSuccess(res) {
-  //handle success
-});
-
-request.on('error', function onError(err) {
-  //handle error
-});
-
-request.request();
-```
-
-+ Using a callback:
-```js
-remote.request('server_info', function(err, res) {
-  if (err) {
-    //handle error
-  } else {
-    //handle success
-  }
-});
-```
-
-__NOTE:__ See the API Reference for available [`Remote` functions](REFERENCE.md#2-remote-functions)
-
-
-##Listening to the network
-
-See the [wiki](https://ripple.com/wiki/JSON_Messages#subscribe) for details on subscription requests.
-
-```js
- /* Loading ripple-lib with Node.js */
-  var Remote = require('ripple-lib').Remote;
-
-  /* Loading ripple-lib in a webpage */
-  // var Remote = ripple.Remote;
-
-  var remote = new Remote({options});
-
-  remote.connect(function() {
-    var request = remote.request('subscribe');
-
-    request.addStream('ledger'); //remote will emit `ledger_closed`
-    request.addStream('transactions'); //remote will emit `transaction`
-
-    request.on('ledger_closed', function onLedgerClosed(ledgerData) {
-	//handle ledger
-    });
-
-    remote.on('transaction', function onTransacstion(transaction) {
-	//handle transaction
-    });
-
-    remote.request(function(err) {
-      	if (err) {
-	} else {
-	}
-    });
-  });
-```
-* https://ripple.com/wiki/RPC_API#transactions_stream_messages
-* https://ripple.com/wiki/RPC_API#ledger_stream_messages
-
-##Submitting a payment to the network
-
-Submitting a payment transaction to the Ripple network involves connecting to a `Remote`, creating a transaction, signing it with the user's secret, and submitting it to the `rippled` server. Note that the `Amount` module is used to convert human-readable amounts like '1XRP' or '10.50USD' to the type of Amount object used by the Ripple network.
-
-```js
-/* Loading ripple-lib Remote and Amount modules in Node.js */ 
-var Remote = require('ripple-lib').Remote;
-var Amount = require('ripple-lib').Amount;
-
-/* Loading ripple-lib Remote and Amount modules in a webpage */
-// var Remote = ripple.Remote;
-// var Amount = ripple.Amount;
-
-var MY_ADDRESS = 'rrrMyAddress';
-var MY_SECRET  = 'secret';
-var RECIPIENT  = 'rrrRecipient';
-var AMOUNT     = Amount.from_human('1XRP');
-
-var remote = new Remote({ /* Remote options */ });
-
-remote.connect(function() {
-  remote.setSecret(MY_ADDRESS, MY_SECRET);
-
-  var transaction = remote.createTransaction('Payment', {
-    account: MY_ADDRESS, 
-    destination: RECIPIENT, 
-    amount: AMOUNT
-  });
-
-  transaction.submit(function(err, res) {
-    /* handle submission errors / success */
-  });
-});
-```
-
-###A note on transaction fees
-
-A full description of network transaction fees can be found on the [Ripple Wiki](https://ripple.com/wiki/Transaction_Fee).
-
-In short, transaction fees are very small amounts (on the order of ~10) of [XRP drops](https://ripple.com/wiki/Ripple_credits#Notes_on_drops) spent and destroyed with every transaction. They are largely used to account for network load and prevent spam. With `ripple-lib`, transaction fees are calculated locally by default and the fee you are willing to pay is submitted along with your transaction.
-
-Since the fee required for a transaction may change between the time when the original fee was calculated and the time when the transaction is submitted, it is wise to use the [`fee_cushion`](REFERENCE.md#1-remote-options) to ensure that the transaction will go through. For example, suppose the original fee calculated for a transaction was 10 XRP drops but at the instant the transaction is submitted the server is experiencing a higher load and it has raised its minimum fee to 12 XRP drops. Without a `fee_cusion`, this transaction would not be processed by the server, but with a `fee_cusion` of, say, 1.5 it would be processed and you would just pay the 2 extra XRP drops.
-
-The [`max_fee`](REFERENCE.md#1-remote-options) option can be used to avoid submitting a transaction to a server that is charging unreasonably high fees.
-
-
-##4. Submitting a trade offer to the network
-
-Submitting a trade offer to the network is similar to submitting a payment transaction. Here is an example for a trade that expires in 24 hours where you are offering to sell 1 USD in exchange for 100 XRP:
-
-```js
-/* Loading ripple-lib Remote and Amount modules in Node.js */ 
-var Remote = require('ripple-lib').Remote;
-var Amount = require('ripple-lib').Amount;
-
-/* Loading ripple-lib Remote and Amount modules in a webpage */
-// var Remote = ripple.Remote;
-// var Amount = ripple.Amount;
-
-var MY_ADDRESS = 'rrrMyAddress';
-var MY_SECRET  = 'secret';
-
-var BUY_AMOUNT = Amount.from_human('100XRP');
-var SELL_AMOUNT = Amount.from_human('1USD');
-
-// EXPIRATION must be a Date object, leave undefined to submit offer that won't expire
-var now = new Date();
-var tomorrow = new Date(now.getTime() + (24 * 60 * 60 * 1000));
-var EXPIRATION = tomorrow;
-
-var remote = new Remote({ /* Remote options */ });
-
-remote.connect(function() {
-  remote.setSecret(MY_ADDRESS, MY_SECRET);
-
-  var transaction = remote.createTransaction('OfferCreate', {
-    account: MY_ADDRESS, 
-    buy: BUY_AMOUNT, 
-    sell: SELL_AMOUNT, 
-    expiration: EXPIRATION
-  });
-
-  transaction.submit(function(err, res) {
-    /* handle submission errors / success */
-  });
-});
-```

docs/REFERENCE.md

@@ -1,302 +0,0 @@
-#API Reference
-
-__(More examples coming soon!)__
-
-###In this document:
-
-1. [`Remote` options](REFERENCE.md#remote-options)
-2. [`Request` constructors](REFERENCE.md#request-constructor-functions)
-  + [Server requests](REFERENCE.md#server-requests)
-  + [Ledger requests](REFERENCE.md#ledger-requests)
-  + [Transaction requests](REFERENCE.md#transaction-requests)
-  + [Account requests](REFERENCE.md#account-requests)
-  + [Orderbook requests](REFERENCE.md#orderbook-requests)
-  + [Transaction requests](REFERENCE.md#transaction-requests)
-3. [`Transaction` constructors](REFERENCE.md#transaction-constructors)
-  + [Transaction events](REFERENCE.md#transaction-events)
-
-###Also see:
-
-1. [The ripple-lib README](../README.md)
-2. [The ripple-lib GUIDES](GUIDES.md)
-
-#Remote options
-
-```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
-
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
-
-var options = { };
-
-var remote = new Remote(options);
-```
-
-A new `Remote` can be created with the following options:
-
-+ `trace` *boolean default: false* Log all of the events emitted
-+ `max_listeners` *number default: 0* Set maxListeners for servers
-+ `trusted` *boolean default: false*, if remote is trusted (boolean)
-+ `local_signing` *boolean default: true*
-+ `local_fee` *boolean default: true* Set whether the transaction fee range will be set locally, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `fee_cushion` *number default: 1.2* Extra fee multiplier to account for async fee changes, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `max_fee` *number default: Infinity* Maximum acceptable transaction fee, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees)
-+ `servers` *array* Array of server objects of the following form:
-
-```js
-{
-  host:    <string>,
-  port:    <number>,
-  secure:  <boolean>
-}
-```
-
-or
-
-```js
- 'wss://host:port'
-```
-
-#Request constructor functions
-
-##Server requests
-
-**[server_info([callback])](https://ripple.com/wiki/JSON_Messages#server_info)**
-
-Returns information about the state of the server. If you are connected to multiple servers and want to select by a particular host, use `request.setServer`. Example:
-
-```js
-var request = remote.request('server_info');
-
-request.setServer('wss://s1.ripple.com');
-
-request.request(function(err, res) {
-
-});
-```
-
-**[unl_list([callback])](https://ripple.com/wiki/JSON_Messages#unl_list)**
-
-**[unl_add(addr, comment, [callback])](https://ripple.com/wiki/JSON_Messages#unl_add)**
-
-**[unl_delete(node, [callback])](https://ripple.com/wiki/JSON_Messages#unl_delete)**
-
-**[requestPeers([callback])](https://ripple.com/wiki/JSON_Messages#peers)**
-
-
-**[connect(ip, port, [callback])](https://ripple.com/wiki/JSON_Messages#connect)**
-
-##Ledger requests
-
-**[ledger(ledger, [opts], [callback])](https://ripple.com/wiki/JSON_Messages#ledger)**
-
-**ledger_header([callback])**
-
-**[ledger_current([callback])](https://ripple.com/wiki/JSON_Messages#ledger_current)**
-
-**[ledger_entry(type, [callback])](https://ripple.com/wiki/JSON_Messages#ledger_entry)**
-
-**[subscribe([streams], [callback])](https://ripple.com/wiki/JSON_Messages#subscribe)**
-
-Start receiving selected streams from the server.
-
-**[unsubscribe([streams], [callback])](https://ripple.com/wiki/JSON_Messages#unsubscribe)**
-
-Stop receiving selected streams from the server.
-
-##Account requests
-
-**[account_info(account, [callback])](https://ripple.com/wiki/JSON_Messages#account_info)**
-
-Return information about the specified account.
-
-```
-{
-  ledger_current_index: <number>,
-  account_data: {
-    Account:            <string>,
-    Balance:            <number>,
-    Flags:              <number>,
-    LedgerEntryType:    <string>,
-    OwnerCount:         <number>,
-    PreviousTxnID:      <string>,
-    PreviousTxnLgrSeq:  <number>,
-    Sequence:           <number> ,
-    index:              <string>
-  }
-}
-```
-
-**[account_lines(accountID, [account_index], [ledger], [callback])](https://ripple.com/wiki/JSON_Messages#account_lines)**
-
-**[account_offers(accountID, [account_index], [ledger], [callback])](https://ripple.com/wiki/JSON_Messages#account_offers)**
-
-Return the specified account's outstanding offers.
-
-**[account_tx(options, [callback])](https://ripple.com/wiki/JSON_Messages#account_tx)**
-
-Fetch a list of transactions that applied to this account.
-
-Options:
-
-+ `account`
-+ `ledger_index_min`
-+ `ledger_index_max`
-+  `binary` *false*
-+ `count` *false*
-+  `descending` *false*
-+  `offset` *0*
-+  `limit`
-+ `forward` *false*
-+ `fwd_marker`
-+ `rev_marker`
-
-**[wallet_accounts(seed, [callback])](https://ripple.com/wiki/JSON_Messages#wallet_accounts)**
-
-Return a list of accounts for a wallet. *Requires trusted remote*
-
-**account_balance(account, [ledger], [callback])**
-
-Get the balance for an account. Returns an [Amount](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/amount.js) object.
-
-**account_flags(account, [ledger], [callback])**
-
-Return the flags for an account.
-
-**owner_count(account, [ledger], [callback])**
-
-Return the owner count for an account.
-
-**ripple_balance(account, issuer, currency, [ledger], [callback])**
-
-Return a request to get a ripple balance
-
-##Orderbook requests
-
-**[book_offers(options, [callback])](https://ripple.com/wiki/JSON_Messages#book_offers)**
-
-Return the offers for an order book, also called a *snapshot*
-
-```js
-var request = remote.request('book_offers', {
-  taker_gets: {
-    'currency':'XRP'
-  },
-  taker_pays: {
-    'currency':'USD',
-    'issuer': 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
-  }
-});
-
-request.request(function(err, offers) {
-  //handle offers
-});
-```
-
-##Transaction requests
-
-**[transaction_entry(hash, [ledger_hash], [callback])](https://ripple.com/wiki/JSON_Messages#transaction_entry)**
-
-Searches a particular ledger for a transaction hash. Default ledger is the open ledger.
-
-**[tx(hash, [callback])](https://ripple.com/wiki/JSON_Messages#tx)**
-
-Searches ledger history for validated transaction hashes.
-
-**[sign(secret, tx_json, [callback])](https://ripple.com/wiki/JSON_Messages#sign)**
-
-Sign a transaction. *Requires trusted remote*
-
-**[submit([callback])](https://ripple.com/wiki/JSON_Messages#submit)**
-
-Submit a transaction to the network. This command is used internally to submit transactions with a greater degree of reliability. See [Submitting a payment to the network](GUIDES.md#3-submitting-a-payment-to-the-network) for details.
-
-**[ripple_path_find(src_account, dst_account, dst_amount, src_currencies, [callback])](https://ripple.com/wiki/JSON_Messages#path_find)**
-
-#Transaction constructors
-
-Use `remote.createTransaction('TransactionType', [options])` to construct a transaction. To submit, use `transaction.submit([callback])`.
-
-**Payment**
-
-```js
-var transaction = remote.createTransaction('Payment', {
-  account: MY_ADDRESS,
-  destination: DEST_ADDRESS,
-  amount: AMOUNT
-});
-```
-
-**AccountSet**
-
-```js
-var transaction = remote.createTransaction('AccountSet', {
-  account: MY_ADDRESS,
-  set: 'RequireDest',
-  clear: 'RequireAuth'
-});
-```
-
-**TrustSet**
-
-```js
-var transaction = remote.createTransaction('TrustSet', {
-  account: MY_ADDRESS,
-  limit: '1/USD/rrrrrrrrrrrrrrrrrrrrBZbvji'
-});
-```
-
-**OfferCreate**
-
-```js
-var transaction = remote.createTransaction('OfferCreate', {
-  account: MY_ADDRESS,
-  taker_pays: '1',
-  taker_gets: '1/USD/rrrrrrrrrrrrrrrrrrrrBZbvji'
-});
-```
-
-##Transaction events
-
-[Transaction](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/transaction.js) objects are EventEmitters. They may emit the following events.
-
-+ `final` Transaction has erred or succeeded. This event indicates that the transaction has finished processing.
-+ `error` Transaction has erred. This event is a final state.
-+ `success` Transaction succeeded. This event is a final state.
-+ `presubmit` Immediately before transaction is submitted
-+ `postsubmit` Immediately after transaction is submitted
-+ `submitted` Transaction has been submitted to the network. The submission may result in a remote error or success.
-+ `resubmitted` Transaction is beginning resubmission.
-+ `proposed` Transaction has been submitted *successfully* to the network. The transaction at this point is awaiting validation in a ledger.
-+ `timeout` Transaction submission timed out. The transaction will be resubmitted.
-+ `fee_adjusted` Transaction fee has been adjusted during its pending state. The transaction fee will only be adjusted if the remote is configured for local fees, which it is by default.
-+ `abort` Transaction has been aborted. Transactions are only aborted by manual calls to `#abort`.
-+ `missing` Four ledgers have closed without detecting validated transaction
-+ `lost` Eight ledgers have closed without detecting validated transaction. Consider the transaction lost and err/finalize.
-
-##Complete payment example
-
-```js
-remote.setSecret(MY_ADDRESS, MY_SECRET);
-
-var transaction = remote.createTransaction('Payment', {
-  account: MY_ADDRESS,
-  destination: DEST_ADDRESS,
-  amount: AMOUNT
-});
-
-transaction.on('resubmitted', function() {
-  // initial submission failed, resubmitting
-});
-
-transaction.submit(function(err, res) {
- // submission has finalized with either an error or success.
- // the transaction will not be retried after this point
-});
-```
-
-#Amount objects
-
-Coming Soon

docs/VAULTCLIENT.md

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

docs/samples/README

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

docs/samples/balances.js

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

docs/samples/payment.js

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

docs/src/basictypes.md.ejs

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

docs/src/boilerplate.md.ejs

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

docs/src/computeLedgerHash.md.ejs

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

docs/src/connect.md.ejs

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

docs/src/disconnect.md.ejs

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

docs/src/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,35 @@
+<% 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 %>

docs/src/introduction.md.ejs

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

docs/src/isConnected.md.ejs

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

docs/src/methods.md.ejs

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

docs/src/prepareOrder.md.ejs

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

docs/src/prepareOrderCancellation.md.ejs

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

docs/src/preparePayment.md.ejs

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

docs/src/prepareSettings.md.ejs

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

docs/src/prepareSuspendedPaymentCancellation.md.ejs

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

docs/src/prepareSuspendedPaymentCreation.md.ejs

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

docs/src/prepareSuspendedPaymentExecution.md.ejs

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

docs/src/prepareTrustline.md.ejs

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

docs/src/sign.md.ejs

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

docs/src/specifications.md.ejs

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

docs/src/submit.md.ejs

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

docs/src/transactions.md.ejs

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

npm-shrinkwrap.json

@@ -0,0 +1,248 @@
+{
+  "name": "ripple-lib",
+  "version": "0.13.0",
+  "npm-shrinkwrap-version": "5.4.0",
+  "node-version": "v0.12.7",
+  "dependencies": {
+    "ajv": {
+      "version": "1.4.8",
+      "resolved": "https://registry.npmjs.org/ajv/-/ajv-1.4.8.tgz",
+      "dependencies": {
+        "json-stable-stringify": {
+          "version": "1.0.0",
+          "resolved": "https://registry.npmjs.org/json-stable-stringify/-/json-stable-stringify-1.0.0.tgz",
+          "dependencies": {
+            "jsonify": {
+              "version": "0.0.0",
+              "resolved": "https://registry.npmjs.org/jsonify/-/jsonify-0.0.0.tgz"
+            }
+          }
+        }
+      }
+    },
+    "babel-runtime": {
+      "version": "5.8.29",
+      "resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-5.8.29.tgz",
+      "dependencies": {
+        "core-js": {
+          "version": "1.2.3",
+          "resolved": "https://registry.npmjs.org/core-js/-/core-js-1.2.3.tgz"
+        }
+      }
+    },
+    "bignumber.js": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/bignumber.js/-/bignumber.js-2.1.0.tgz"
+    },
+    "https-proxy-agent": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-1.0.0.tgz",
+      "dependencies": {
+        "agent-base": {
+          "version": "2.0.1",
+          "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-2.0.1.tgz",
+          "dependencies": {
+            "semver": {
+              "version": "5.0.3",
+              "resolved": "https://registry.npmjs.org/semver/-/semver-5.0.3.tgz"
+            }
+          }
+        },
+        "debug": {
+          "version": "2.2.0",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-2.2.0.tgz",
+          "dependencies": {
+            "ms": {
+              "version": "0.7.1",
+              "resolved": "https://registry.npmjs.org/ms/-/ms-0.7.1.tgz"
+            }
+          }
+        },
+        "extend": {
+          "version": "3.0.0",
+          "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.0.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",
+          "dependencies": {
+            "inherits": {
+              "version": "2.0.1",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.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-binary-codec": {
+      "version": "0.0.7",
+      "resolved": "https://registry.npmjs.org/ripple-binary-codec/-/ripple-binary-codec-0.0.7.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",
+          "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-3.3.0.tgz"
+        },
+        "create-hash": {
+          "version": "1.1.2",
+          "resolved": "https://registry.npmjs.org/create-hash/-/create-hash-1.1.2.tgz",
+          "dependencies": {
+            "cipher-base": {
+              "version": "1.0.2",
+              "resolved": "https://registry.npmjs.org/cipher-base/-/cipher-base-1.0.2.tgz"
+            },
+            "ripemd160": {
+              "version": "1.0.1",
+              "resolved": "https://registry.npmjs.org/ripemd160/-/ripemd160-1.0.1.tgz"
+            },
+            "sha.js": {
+              "version": "2.4.4",
+              "resolved": "https://registry.npmjs.org/sha.js/-/sha.js-2.4.4.tgz"
+            }
+          }
+        },
+        "decimal.js": {
+          "version": "4.0.3",
+          "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-4.0.3.tgz"
+        },
+        "inherits": {
+          "version": "2.0.1",
+          "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",
+      "dependencies": {
+        "create-hash": {
+          "version": "1.1.2",
+          "resolved": "https://registry.npmjs.org/create-hash/-/create-hash-1.1.2.tgz",
+          "dependencies": {
+            "cipher-base": {
+              "version": "1.0.2",
+              "resolved": "https://registry.npmjs.org/cipher-base/-/cipher-base-1.0.2.tgz"
+            },
+            "inherits": {
+              "version": "2.0.1",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+            },
+            "ripemd160": {
+              "version": "1.0.1",
+              "resolved": "https://registry.npmjs.org/ripemd160/-/ripemd160-1.0.1.tgz"
+            },
+            "sha.js": {
+              "version": "2.4.4",
+              "resolved": "https://registry.npmjs.org/sha.js/-/sha.js-2.4.4.tgz"
+            }
+          }
+        }
+      }
+    },
+    "ripple-keypairs": {
+      "version": "0.10.0",
+      "resolved": "https://registry.npmjs.org/ripple-keypairs/-/ripple-keypairs-0.10.0.tgz",
+      "dependencies": {
+        "bn.js": {
+          "version": "3.3.0",
+          "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-3.3.0.tgz"
+        },
+        "brorand": {
+          "version": "1.0.5",
+          "resolved": "https://registry.npmjs.org/brorand/-/brorand-1.0.5.tgz"
+        },
+        "elliptic": {
+          "version": "5.2.1",
+          "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-5.2.1.tgz",
+          "dependencies": {
+            "inherits": {
+              "version": "2.0.1",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+            }
+          }
+        },
+        "hash.js": {
+          "version": "1.0.3",
+          "resolved": "https://registry.npmjs.org/hash.js/-/hash.js-1.0.3.tgz",
+          "dependencies": {
+            "inherits": {
+              "version": "2.0.1",
+              "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz"
+            }
+          }
+        }
+      }
+    },
+    "ripple-lib-transactionparser": {
+      "version": "0.6.0",
+      "resolved": "https://registry.npmjs.org/ripple-lib-transactionparser/-/ripple-lib-transactionparser-0.6.0.tgz"
+    },
+    "ws": {
+      "version": "0.7.2",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-0.7.2.tgz",
+      "dependencies": {
+        "options": {
+          "version": "0.0.6",
+          "resolved": "https://registry.npmjs.org/options/-/options-0.0.6.tgz"
+        },
+        "ultron": {
+          "version": "1.0.2",
+          "resolved": "https://registry.npmjs.org/ultron/-/ultron-1.0.2.tgz"
+        }
+      }
+    }
+  }
+}

package.json

@@ -1,46 +1,70 @@
 {
   "name": "ripple-lib",
-  "version": "0.8.0-rc3",
-  "description": "Ripple JavaScript client library",
+  "version": "0.13.0",
+  "license": "ISC",
+  "description": "A JavaScript API for interacting with Ripple in Node.js and the browser",
   "files": [
-    "src/js/*",
+    "dist/npm/*",
     "bin/*",
     "build/*",
     "test/*",
-    "Makefile",
     "Gulpfile.js"
   ],
-  "main": "src/js/ripple",
+  "main": "dist/npm/",
   "directories": {
     "test": "test"
   },
   "dependencies": {
-    "async": "~0.8.0",
-    "ws": "~0.4.31",
-    "extend": "~1.2.1",
-    "lru-cache": "~2.5.0",
-    "superagent": "^0.18.0",
-    "gulp-bump": "~0.1.10"
+    "ajv": "^1.4.8",
+    "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.1.0",
+    "ripple-hashes": "^0.0.1",
+    "ripple-keypairs": "^0.10.0",
+    "ripple-lib-transactionparser": "^0.6.0",
+    "ws": "^0.7.1"
   },
   "devDependencies": {
-    "mocha": "~1.14.0",
-    "gulp": "~3.6.2",
-    "gulp-concat": "~2.2.0",
-    "gulp-jshint": "~1.5.5",
-    "gulp-uglify": "~0.3.0",
-    "gulp-rename": "~1.2.0",
-    "webpack": "~1.1.11",
-    "map-stream": "~0.1.0",
-    "istanbul": "~0.2.10",
-    "coveralls": "~2.10.0",
-    "nock": "^0.34.1",
-    "yargs": "~1.3.1"
+    "assert-diff": "^1.0.1",
+    "babel": "^5.8.21",
+    "babel-core": "^5.8.22",
+    "babel-eslint": "^4.1.3",
+    "babel-loader": "^5.3.2",
+    "coveralls": "^2.10.0",
+    "doctoc": "^0.15.0",
+    "ejs": "^2.3.4",
+    "eslint": "^1.3.0",
+    "eslint-plugin-flowtype": "^1.0.0",
+    "eventemitter2": "^0.4.14",
+    "flow-bin": "^0.14",
+    "gulp": "^3.8.10",
+    "gulp-bump": "^0.1.13",
+    "gulp-rename": "^1.2.0",
+    "gulp-uglify": "^1.1.0",
+    "istanbul": "^0.3.5",
+    "json-loader": "^0.5.2",
+    "json-schema-to-markdown-table": "^0.4.0",
+    "mocha": "^2.1.0",
+    "webpack": "^1.5.3",
+    "yargs": "^1.3.1"
   },
   "scripts": {
-    "build": "node_modules/.bin/gulp",
-    "pretest": "node_modules/.bin/gulp concat-sjcl",
-    "test": "./node_modules/.bin/istanbul test -x build/sjcl.js -x src/js/jsbn/* ./node_modules/.bin/_mocha -- --reporter spec test/*-test.js",
-    "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls"
+    "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/",
+    "watch": "babel -w -D --optional runtime -d dist/npm/ src/",
+    "compile-with-source-maps": "babel -D --optional runtime -s -t -d dist/npm/ src/",
+    "prepublish": "npm run clean && npm run compile",
+    "test": "istanbul test _mocha",
+    "coveralls": "cat ./coverage/lcov.info | coveralls",
+    "lint": "if ! [ -f eslintrc ]; then curl -o eslintrc 'https://raw.githubusercontent.com/ripple/javascript-style-guide/es6/eslintrc'; echo 'parser: babel-eslint' >> eslintrc; fi; eslint -c eslintrc src/",
+    "perf": "./scripts/perf_test.sh"
   },
   "repository": {
     "type": "git",
@@ -48,6 +72,6 @@
   },
   "readmeFilename": "README.md",
   "engines": {
-    "node": ">=0.10.0"
+    "node": ">=0.12.0"
   }
 }

scripts/build_docs.js

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

scripts/ci.sh

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

scripts/publish

@@ -0,0 +1,43 @@
+echo "PUBLISH"
+
+function exit_on_error {
+  res=$?
+  [[ ${res:-99} -eq 0 ]] || exit $res
+}
+
+rm -rf build
+
+npm install
+gulp
+npm test
+exit_on_error
+
+echo ""
+echo "publish to npm"
+npm publish
+exit_on_error
+
+rm -rf dist/bower
+echo ""
+echo "publish to bower"
+
+git clone git@github.com:ripple/bower-ripple.git dist/bower
+gulp bower
+exit_on_error
+
+cd dist/bower
+version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc([0-9])+)?')
+echo "version: $version"
+git add ripple.js ripple-debug.js ripple-min.js bower.json
+exit_on_error
+
+git commit -m "[TASK] add v$version"
+exit_on_error
+
+git tag "v$version"
+exit_on_error
+
+git push origin master
+git push --tags origin master
+
+cd ../..

scripts/publish_rc

@@ -0,0 +1,43 @@
+echo "PUBLISH RELEASE CANDIDATE"
+
+function exit_on_error {
+  res=$?
+  [[ ${res:-99} -eq 0 ]] || exit $res
+}
+
+rm -rf build
+
+npm install
+gulp
+npm test
+exit_on_error
+
+echo ""
+echo "publish rc to npm"
+npm publish --tag beta
+exit_on_error
+
+rm -rf dist/bower
+echo ""
+echo "publish to bower"
+
+git clone git@github.com:ripple/bower-ripple.git dist/bower
+gulp bower
+exit_on_error
+
+cd dist/bower
+version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc([0-9])+)?')
+echo "version: $version"
+git add ripple.js ripple-debug.js ripple-min.js bower.json
+exit_on_error
+
+git commit -m "[TASK] add v$version"
+exit_on_error
+
+git tag "v$version"
+exit_on_error
+
+git push origin master
+git push --tags origin master
+
+cd ../..

scripts/publish_to_bower

@@ -0,0 +1,12 @@
+rm -rf dist/bower
+git clone git@github.com:ripple/bower-ripple.git dist/bower
+gulp bower
+cd dist/bower
+version=$(cat bower.json | grep -Eo '([0-9]\.?)+(-rc[0-9])?')
+echo "version: $version"
+git add ripple.js ripple-debug.js ripple-min.js bower.json
+git commit -m "[TASK] add v$version"
+git tag "v$version"
+git push origin master
+git push --tags origin master
+cd ..

scripts/verify_ledger_json.js

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

src/common/connection.js

@@ -0,0 +1,256 @@
+'use strict';
+const {EventEmitter} = require('events');
+const WebSocket = require('ws');
+const parseURL = require('url').parse;
+const RangeSet = require('./rangeset').RangeSet;
+const {RippledError, DisconnectedError, NotConnectedError,
+  TimeoutError, ResponseFormatError, ConnectionError} = require('./errors');
+
+function isStreamMessageType(type) {
+  return type === 'ledgerClosed' ||
+         type === 'transaction' ||
+         type === 'path_find';
+}
+
+class Connection extends EventEmitter {
+  constructor(url, options = {}) {
+    super();
+    this._url = url;
+    this._proxyURL = options.proxyURL;
+    this._authorization = options.authorization;
+    this._timeout = options.timeout || (20 * 1000);
+    this._isReady = false;
+    this._ws = null;
+    this._ledgerVersion = null;
+    this._availableLedgerVersions = new RangeSet();
+    this._nextRequestID = 1;
+  }
+
+  // return value is array of arguments to Connection.emit
+  _parseMessage(message) {
+    const data = JSON.parse(message);
+    if (data.type === 'response') {
+      if (!(Number.isInteger(data.id) && data.id >= 0)) {
+        throw new ResponseFormatError('valid id not found in response');
+      }
+      return [data.id.toString(), data];
+    } else if (isStreamMessageType(data.type)) {
+      if (data.type === 'ledgerClosed') {
+        this._ledgerVersion = Number(data.ledger_index);
+        this._availableLedgerVersions.reset();
+        this._availableLedgerVersions.parseAndAddRanges(
+          data.validated_ledgers);
+      }
+      return [data.type, data];
+    } else if (data.type === undefined && data.error) {
+      return ['error', data.error, data.error_message];  // e.g. slowDown
+    }
+    throw new ResponseFormatError('unrecognized message type: ' + data.type);
+  }
+
+  _onMessage(message) {
+    let parameters;
+    try {
+      parameters = this._parseMessage(message);
+    } catch (error) {
+      this.emit('error', 'badMessage', message);
+      return;
+    }
+    // we don't want this inside the try/catch or exceptions in listener
+    // will be caught
+    this.emit.apply(this, parameters);
+  }
+
+  get _state() {
+    return this._ws ? this._ws.readyState : WebSocket.CLOSED;
+  }
+
+  get _shouldBeConnected() {
+    return this._ws !== null;
+  }
+
+  isConnected() {
+    return this._state === WebSocket.OPEN && this._isReady;
+  }
+
+  _onUnexpectedClose() {
+    this._isReady = false;
+    this.connect().then();
+  }
+
+  _onOpen() {
+    const request = {
+      command: 'subscribe',
+      streams: ['ledger']
+    };
+    return this.request(request).then(response => {
+      this._ledgerVersion = Number(response.ledger_index);
+      this._availableLedgerVersions.parseAndAddRanges(
+        response.validated_ledgers);
+      this._isReady = true;
+      this.emit('connected');
+    });
+  }
+
+  _createWebSocket(url, proxyURL, authorization) {
+    const options = {};
+    if (proxyURL !== undefined) {
+      const parsedURL = parseURL(url);
+      const proxyOptions = parseURL(proxyURL);
+      proxyOptions.secureEndpoint = (parsedURL.protocol === 'wss:');
+      let HttpsProxyAgent;
+      try {
+        HttpsProxyAgent = require('https-proxy-agent');
+      } catch (error) {
+        throw new Error('"proxy" option is not supported in the browser');
+      }
+      options.agent = new HttpsProxyAgent(proxyOptions);
+    }
+    if (authorization !== undefined) {
+      const base64 = new Buffer(authorization).toString('base64');
+      options.headers = {Authorization: `Basic ${base64}`};
+    }
+    return new WebSocket(url, options);
+  }
+
+  connect() {
+    return new Promise((resolve, reject) => {
+      if (!this._url) {
+        reject(new ConnectionError(
+          'Cannot connect because no server was specified'));
+      }
+      if (this._state === WebSocket.OPEN) {
+        resolve();
+      } else if (this._state === WebSocket.CONNECTING) {
+        this._ws.once('open', resolve);
+      } else {
+        this._ws = this._createWebSocket(this._url, this._proxyURL,
+          this._authorization);
+        this._ws.on('message', this._onMessage.bind(this));
+        this._ws.once('close', () => this._onUnexpectedClose);
+        this._ws.once('open', () => this._onOpen().then(resolve, reject));
+      }
+    });
+  }
+
+  disconnect() {
+    return new Promise(resolve => {
+      if (this._state === WebSocket.CLOSED) {
+        resolve();
+      } else if (this._state === WebSocket.CLOSING) {
+        this._ws.once('close', resolve);
+      } else {
+        this._ws.removeListener('close', this._onUnexpectedClose);
+        this._ws.once('close', () => {
+          this._ws = null;
+          this._isReady = false;
+          resolve();
+        });
+        this._ws.close();
+      }
+    });
+  }
+
+  reconnect() {
+    return this.disconnect().then(() => this.connect());
+  }
+
+  _whenReady(promise) {
+    return new Promise((resolve, reject) => {
+      if (!this._shouldBeConnected) {
+        reject(new NotConnectedError());
+      } else if (this._state === WebSocket.OPEN && this._isReady) {
+        promise.then(resolve, reject);
+      } else {
+        this.once('connected', () => promise.then(resolve, reject));
+      }
+    });
+  }
+
+  getLedgerVersion() {
+    return this._whenReady(Promise.resolve(this._ledgerVersion));
+  }
+
+  hasLedgerVersions(lowLedgerVersion, highLedgerVersion) {
+    return this._whenReady(Promise.resolve(
+      this._availableLedgerVersions.containsRange(
+        lowLedgerVersion, highLedgerVersion || this._ledgerVersion)));
+  }
+
+  hasLedgerVersion(ledgerVersion) {
+    return this.hasLedgerVersions(ledgerVersion, ledgerVersion);
+  }
+
+  _send(message) {
+    return new Promise((resolve, reject) => {
+      this._ws.send(message, undefined, (error, result) => {
+        if (error) {
+          reject(new DisconnectedError(error.message));
+        } else {
+          resolve(result);
+        }
+      });
+    });
+  }
+
+  request(request, timeout) {
+    return new Promise((resolve, reject) => {
+      if (!this._shouldBeConnected) {
+        reject(new NotConnectedError());
+      }
+
+      let timer = null;
+      const self = this;
+      const id = this._nextRequestID;
+      this._nextRequestID += 1;
+      const eventName = id.toString();
+
+      function onDisconnect() {
+        clearTimeout(timer);
+        self.removeAllListeners(eventName);
+        reject(new DisconnectedError());
+      }
+
+      function cleanup() {
+        clearTimeout(timer);
+        self.removeAllListeners(eventName);
+        if (self._ws !== null) {
+          self._ws.removeListener('close', onDisconnect);
+        }
+      }
+
+      function _resolve(response) {
+        cleanup();
+        resolve(response);
+      }
+
+      function _reject(error) {
+        cleanup();
+        reject(error);
+      }
+
+      this.once(eventName, response => {
+        if (response.status === 'error') {
+          _reject(new RippledError(response.error));
+        } else if (response.status === 'success') {
+          _resolve(response.result);
+        } else {
+          _reject(new ResponseFormatError(
+            'unrecognized status: ' + response.status));
+        }
+      });
+
+      this._ws.once('close', onDisconnect);
+
+      // JSON.stringify automatically removes keys with value of 'undefined'
+      const message = JSON.stringify(Object.assign({}, request, {id}));
+
+      this._whenReady(this._send(message)).then(() => {
+        const delay = timeout || this._timeout;
+        timer = setTimeout(() => _reject(new TimeoutError()), delay);
+      }).catch(_reject);
+    });
+  }
+}
+
+module.exports = Connection;

src/common/constants.js

@@ -0,0 +1,49 @@
+'use strict';
+const flagIndices = require('./txflags').txFlagIndices.AccountSet;
+
+const accountRootFlags = {
+  PasswordSpent: 0x00010000, // password set fee is spent
+  RequireDestTag: 0x00020000, // require a DestinationTag for payments
+  RequireAuth: 0x00040000, // require a authorization to hold IOUs
+  DisallowXRP: 0x00080000, // disallow sending XRP
+  DisableMaster: 0x00100000,  // force regular key
+  NoFreeze: 0x00200000, // permanently disallowed freezing trustlines
+  GlobalFreeze: 0x00400000, // trustlines globally frozen
+  DefaultRipple: 0x00800000
+};
+
+const AccountFlags = {
+  passwordSpent: accountRootFlags.PasswordSpent,
+  requireDestinationTag: accountRootFlags.RequireDestTag,
+  requireAuthorization: accountRootFlags.RequireAuth,
+  disallowIncomingXRP: accountRootFlags.DisallowXRP,
+  disableMasterKey: accountRootFlags.DisableMaster,
+  noFreeze: accountRootFlags.NoFreeze,
+  globalFreeze: accountRootFlags.GlobalFreeze,
+  defaultRipple: accountRootFlags.DefaultRipple
+};
+
+const AccountFlagIndices = {
+  requireDestinationTag: flagIndices.asfRequireDest,
+  requireAuthorization: flagIndices.asfRequireAuth,
+  disallowIncomingXRP: flagIndices.asfDisallowXRP,
+  disableMasterKey: flagIndices.asfDisableMaster,
+  enableTransactionIDTracking: flagIndices.asfAccountTxnID,
+  noFreeze: flagIndices.asfNoFreeze,
+  globalFreeze: flagIndices.asfGlobalFreeze,
+  defaultRipple: flagIndices.asfDefaultRipple
+};
+
+const AccountFields = {
+  EmailHash: {name: 'emailHash', encoding: 'hex',
+              length: 32, defaults: '0'},
+  MessageKey: {name: 'messageKey'},
+  Domain: {name: 'domain', encoding: 'hex'},
+  TransferRate: {name: 'transferRate', defaults: 0, shift: 9}
+};
+
+module.exports = {
+  AccountFields,
+  AccountFlagIndices,
+  AccountFlags
+};

src/common/errors.js

@@ -0,0 +1,81 @@
+'use strict';
+const util = require('util');
+
+class RippleError extends Error {
+  constructor(message, data) {
+    super(message);
+    this.name = this.constructor.name;
+    this.message = message;
+    this.data = data;
+    Error.captureStackTrace(this, this.constructor.name);
+  }
+
+  toString() {
+    let result = '[' + this.name + '(' + this.message;
+    if (this.data) {
+      result += ', ' + util.inspect(this.data);
+    }
+    result += ')]';
+    return result;
+  }
+
+  /* console.log in node uses util.inspect on object, and util.inspect allows
+  us to cutomize its output:
+  https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects */
+  inspect() {
+    return this.toString();
+  }
+}
+
+class RippledError extends RippleError {}
+
+class UnexpectedError extends RippleError {}
+
+class LedgerVersionError extends RippleError {}
+
+class ConnectionError extends RippleError {}
+
+class NotConnectedError extends ConnectionError {}
+
+class DisconnectedError extends ConnectionError {}
+
+class TimeoutError extends ConnectionError {}
+
+class ResponseFormatError extends ConnectionError {}
+
+class ValidationError extends RippleError {}
+
+class NotFoundError extends RippleError {
+  constructor(message) {
+    super(message || 'Not found');
+  }
+}
+
+class MissingLedgerHistoryError extends RippleError {
+  constructor(message) {
+    super(message || 'Server is missing ledger history in the specified range');
+  }
+}
+
+class PendingLedgerVersionError extends RippleError {
+  constructor(message) {
+    super(message || 'maxLedgerVersion is greater than server\'s'
+      + ' most recent validated ledger');
+  }
+}
+
+module.exports = {
+  RippleError,
+  UnexpectedError,
+  ConnectionError,
+  RippledError,
+  NotConnectedError,
+  DisconnectedError,
+  TimeoutError,
+  ResponseFormatError,
+  ValidationError,
+  NotFoundError,
+  PendingLedgerVersionError,
+  MissingLedgerHistoryError,
+  LedgerVersionError
+};

src/common/index.js

@@ -0,0 +1,22 @@
+'use strict';
+const utils = require('./utils');
+
+module.exports = {
+  Connection: require('./connection'),
+  constants: require('./constants'),
+  errors: require('./errors'),
+  validate: require('./validate'),
+  txFlags: require('./txflags').txFlags,
+  serverInfo: require('./serverinfo'),
+  dropsToXrp: utils.dropsToXrp,
+  xrpToDrops: utils.xrpToDrops,
+  toRippledAmount: utils.toRippledAmount,
+  generateAddress: utils.generateAddress,
+  generateAddressAPI: utils.generateAddressAPI,
+  removeUndefined: utils.removeUndefined,
+  convertKeysFromSnakeCaseToCamelCase:
+    utils.convertKeysFromSnakeCaseToCamelCase,
+  iso8601ToRippleTime: utils.iso8601ToRippleTime,
+  rippleTimeToISO8601: utils.rippleTimeToISO8601,
+  isValidSecret: utils.isValidSecret
+};

src/common/rangeset.js

@@ -0,0 +1,61 @@
+/* @flow */
+'use strict';
+const _ = require('lodash');
+const assert = require('assert');
+const ranges = Symbol();
+
+function mergeIntervals(intervals: Array<[number, number]>) {
+  const stack = [[-Infinity, -Infinity]];
+  _.forEach(_.sortBy(intervals, x => x[0]), interval => {
+    const lastInterval = stack.pop();
+    if (interval[0] <= lastInterval[1] + 1) {
+      stack.push([lastInterval[0], Math.max(interval[1], lastInterval[1])]);
+    } else {
+      stack.push(lastInterval);
+      stack.push(interval);
+    }
+  });
+  return stack.slice(1);
+}
+
+class RangeSet {
+  constructor() {
+    this.reset();
+  }
+
+  reset() {
+    this[ranges] = [];
+  }
+
+  serialize() {
+    return this[ranges].map(range =>
+      range[0].toString() + '-' + range[1].toString()).join(',');
+  }
+
+  addRange(start: number, end: number) {
+    assert(start <= end, 'invalid range');
+    this[ranges] = mergeIntervals(this[ranges].concat([[start, end]]));
+  }
+
+  addValue(value: number) {
+    this.addRange(value, value);
+  }
+
+  parseAndAddRanges(rangesString: string) {
+    const rangeStrings = rangesString.split(',');
+    _.forEach(rangeStrings, rangeString => {
+      const range = rangeString.split('-').map(Number);
+      this.addRange(range[0], range.length === 1 ? range[0] : range[1]);
+    });
+  }
+
+  containsRange(start: number, end: number) {
+    return _.some(this[ranges], range => range[0] <= start && range[1] >= end);
+  }
+
+  containsValue(value: number) {
+    return this.containsRange(value, value);
+  }
+}
+
+module.exports.RangeSet = RangeSet;

src/common/schema-validator.js

@@ -0,0 +1,119 @@
+// flow is disabled for this file until support for requiring json is added:
+// https://github.com/facebook/flow/issues/167
+'use strict';
+const _ = require('lodash');
+const assert = require('assert');
+const Ajv = require('ajv');
+const ValidationError = require('./errors').ValidationError;
+const {isValidAddress} = require('ripple-address-codec');
+const {isValidSecret} = require('./utils');
+
+function loadSchemas() {
+  // listed explicitly for webpack (instead of scanning schemas directory)
+  const schemas = [
+    require('./schemas/objects/tx-json.json'),
+    require('./schemas/objects/tx-type.json'),
+    require('./schemas/objects/hash128.json'),
+    require('./schemas/objects/hash256.json'),
+    require('./schemas/objects/sequence.json'),
+    require('./schemas/objects/issue.json'),
+    require('./schemas/objects/ledgerversion.json'),
+    require('./schemas/objects/max-adjustment.json'),
+    require('./schemas/objects/memo.json'),
+    require('./schemas/objects/memos.json'),
+    require('./schemas/objects/uint32.json'),
+    require('./schemas/objects/value.json'),
+    require('./schemas/objects/source-adjustment.json'),
+    require('./schemas/objects/destination-adjustment.json'),
+    require('./schemas/objects/tag.json'),
+    require('./schemas/objects/lax-amount.json'),
+    require('./schemas/objects/lax-lax-amount.json'),
+    require('./schemas/objects/min-adjustment.json'),
+    require('./schemas/objects/source-exact-adjustment.json'),
+    require('./schemas/objects/destination-exact-adjustment.json'),
+    require('./schemas/objects/tx-hash.json'),
+    require('./schemas/objects/address.json'),
+    require('./schemas/objects/adjustment.json'),
+    require('./schemas/objects/quality.json'),
+    require('./schemas/objects/amount.json'),
+    require('./schemas/objects/amount-base.json'),
+    require('./schemas/objects/balance.json'),
+    require('./schemas/objects/blob.json'),
+    require('./schemas/objects/currency.json'),
+    require('./schemas/objects/signed-value.json'),
+    require('./schemas/objects/orderbook.json'),
+    require('./schemas/objects/instructions.json'),
+    require('./schemas/specifications/settings.json'),
+    require('./schemas/specifications/payment.json'),
+    require('./schemas/specifications/suspended-payment-cancellation.json'),
+    require('./schemas/specifications/order-cancellation.json'),
+    require('./schemas/specifications/order.json'),
+    require('./schemas/specifications/suspended-payment-execution.json'),
+    require('./schemas/specifications/suspended-payment-creation.json'),
+    require('./schemas/specifications/trustline.json'),
+    require('./schemas/output/sign.json'),
+    require('./schemas/output/submit.json'),
+    require('./schemas/output/get-account-info.json'),
+    require('./schemas/output/get-balances.json'),
+    require('./schemas/output/get-balance-sheet'),
+    require('./schemas/output/get-ledger.json'),
+    require('./schemas/output/get-orderbook.json'),
+    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/get-paths.json'),
+    require('./schemas/output/get-server-info.json'),
+    require('./schemas/output/get-settings.json'),
+    require('./schemas/output/orderbook-orders.json'),
+    require('./schemas/output/outcome.json'),
+    require('./schemas/output/get-transaction.json'),
+    require('./schemas/output/get-transactions.json'),
+    require('./schemas/output/get-trustlines.json'),
+    require('./schemas/input/get-balances.json'),
+    require('./schemas/input/get-balance-sheet.json'),
+    require('./schemas/input/get-ledger.json'),
+    require('./schemas/input/get-orders.json'),
+    require('./schemas/input/get-orderbook.json'),
+    require('./schemas/input/get-paths.json'),
+    require('./schemas/input/api-options.json'),
+    require('./schemas/input/get-settings.json'),
+    require('./schemas/input/get-account-info.json'),
+    require('./schemas/input/get-transaction.json'),
+    require('./schemas/input/get-transactions.json'),
+    require('./schemas/input/get-trustlines.json'),
+    require('./schemas/input/prepare-payment.json'),
+    require('./schemas/input/prepare-order.json'),
+    require('./schemas/input/prepare-trustline.json'),
+    require('./schemas/input/prepare-order-cancellation.json'),
+    require('./schemas/input/prepare-settings.json'),
+    require('./schemas/input/prepare-suspended-payment-creation.json'),
+    require('./schemas/input/prepare-suspended-payment-cancellation.json'),
+    require('./schemas/input/prepare-suspended-payment-execution.json'),
+    require('./schemas/input/compute-ledger-hash'),
+    require('./schemas/input/sign'),
+    require('./schemas/input/submit')
+  ];
+  const titles = _.map(schemas, schema => schema.title);
+  const duplicates = _.keys(_.pick(_.countBy(titles), count => count > 1));
+  assert(duplicates.length === 0, 'Duplicate schemas for: ' + duplicates);
+  const ajv = new Ajv();
+  _.forEach(schemas, schema => ajv.addSchema(schema, schema.title));
+  ajv.addFormat('address', isValidAddress);
+  ajv.addFormat('secret', isValidSecret);
+  return ajv;
+}
+
+const ajv = loadSchemas();
+
+function schemaValidate(schemaName: string, object: any): void {
+  const isValid = ajv.validate(schemaName, object);
+  if (!isValid) {
+    throw new ValidationError(ajv.errorsText());
+  }
+}
+
+module.exports = {
+  schemaValidate,
+  isValidSecret
+};

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

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "api-options",
+  "type": "object",
+  "properties": {
+    "trace": {"type": "boolean"},
+    "feeCushion": {"$ref": "value"},
+    "servers": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "uri",
+        "pattern": "^wss?://"
+      }
+    },
+    "proxy": {
+      "format": "uri"
+    },
+    "authorization": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

src/common/schemas/input/compute-ledger-hash.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "computeLedgerHashParameters",
+  "type": "object",
+  "properties": {
+    "ledger": {
+      "$ref": "getLedger",
+      "description": "The ledger header to hash."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["ledger"]
+}

src/common/schemas/input/get-account-info.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getAccountInfoParameters",
+  "description": "Parameters for getAccountInfo",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get the account info of."
+    },
+    "options": {
+      "description": "Options that affect what to return.",
+      "properties": {
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get the account info as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

src/common/schemas/input/get-balance-sheet.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getBalanceSheetParameters",
+  "description": "Parameters for getBalanceSheet",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The Ripple address of the account to get the balance sheet of."
+    },
+    "options": {
+      "properties": {
+        "excludeAddresses": {
+          "type": "array",
+          "items": {"$ref": "address"},
+          "uniqueItems": true,
+          "description": "Addresses to exclude from the balance totals."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get the balance sheet as of this historical ledger version."
+        }
+      },
+      "description": "Options to determine how the balances will be calculated.",
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

src/common/schemas/input/get-balances.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getBalancesParameters",
+  "description": "Parameters for getBalances",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get balances for."
+    },
+    "options": {
+      "description": "Options to filter and determine which balances to return.",
+      "properties": {
+        "counterparty": {
+          "$ref": "address",
+          "description": "Only return balances with this counterparty."
+        },
+        "currency": {
+          "$ref": "currency",
+          "description": "Only return balances for this currency."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many balances."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return balances as they were in this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

src/common/schemas/input/get-ledger.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getLedgerParameters",
+  "description": "Parameters for getLedger",
+  "type": "object",
+  "properties": {
+    "options": {
+      "description": "Options affecting what ledger and how much data to return.",
+      "properties": {
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get ledger data for this historical ledger version."
+        },
+        "includeAllData": {
+          "type": "boolean",
+          "description": "Include full transactions and/or state information if `includeTransactions` and/or `includeState` is set."
+        },
+        "includeTransactions": {
+          "type": "boolean",
+          "description": "Return an array of hashes for each transaction or an array of all transactions that were validated in this ledger version, depending on whether `includeAllData` is set."
+        },
+        "includeState": {
+          "type": "boolean",
+          "description": "Return an array of hashes for all state data or an array of all state data in this ledger version, depending on whether `includeAllData` is set."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

src/common/schemas/input/get-orderbook.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getOrderbookParameters",
+  "description": "Parameters for getOrderbook",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "Address of an account to use as point-of-view. (This affects which unfunded offers are returned.)"
+    },
+    "orderbook": {
+      "$ref": "orderbook",
+      "description": "The order book to get."
+    },
+    "options": {
+      "description": "Options to determine what to return.",
+      "properties": {
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many orders from the order book."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return the order book as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address", "orderbook"],
+  "additionalProperties": false
+}

src/common/schemas/input/get-orders.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getOrdersParameters",
+  "description": "Parameters for getOrders",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The Ripple address of the account to get open orders for."
+    },
+    "options": {
+      "description": "Options that determine what orders will be returned.",
+      "properties": {
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "At most this many orders will be returned."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return orders as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

src/common/schemas/input/get-paths.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getPathsParameters",
+  "type": "object",
+  "properties": {
+    "pathfind": {
+      "description": "Specification of a pathfind request.",
+      "properties": {
+        "source": {
+          "description": "Properties of the source of funds.",
+          "type": "object",
+          "properties": {
+            "address": {
+              "$ref": "address",
+              "description": "The Ripple address of the account where funds will come from."
+            },
+            "amount": {
+              "$ref": "laxAmount",
+              "description": "The amount of funds to send."
+            },
+            "currencies": {
+              "description": "An array of currencies (with optional counterparty) that may be used in the payment paths.",
+              "type": "array",
+              "items": {
+                "description": "A currency with optional counterparty.",
+                "type": "object",
+                "properties": {
+                  "currency": {"$ref": "currency"},
+                  "counterparty": {
+                    "$ref": "address",
+                    "description": "The counterparty for the currency; if omitted any counterparty may be used."
+                  }
+                },
+                "required": ["currency"],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            }
+          },
+          "not": {
+            "required": ["amount", "currencies"]
+          },
+          "additionalProperties": false,
+          "required": ["address"]
+        },
+        "destination": {
+          "description": "Properties of the destination of funds.",
+          "type": "object",
+          "properties": {
+            "address": {
+              "$ref": "address",
+              "description": "The address to send to."
+            },
+            "amount": {
+              "$ref": "laxLaxAmount",
+              "description": "The amount to be received by the receiver (`value` may be ommitted if a source amount is specified)."
+            }
+          },
+          "required": ["address", "amount"],
+          "additionalProperties": false
+        }
+      },
+      "required": ["source", "destination"],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["pathfind"]
+}

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

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getSettingsParameters",
+  "description": "Parameters for getSettings",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get the settings of."
+    },
+    "options": {
+      "description": "Options that affect what to return.",
+      "properties": {
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get the settings as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

src/common/schemas/input/get-transaction.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTransactionParameters",
+  "description": "Parameters for getTransaction",
+  "type": "object",
+  "properties": {
+    "id": {"$ref": "id"},
+    "options": {
+      "description": "Options to limit the ledger versions to search.",
+      "properties": {
+        "minLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "The lowest ledger version to search."
+        },
+        "maxLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "The highest ledger version to search"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id"]
+}

src/common/schemas/input/get-transactions.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTransactionsParameters",
+  "description": "Parameters for getTransactions",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get transactions for."
+    },
+    "options": {
+      "description": "Options to filter the resulting transactions.",
+      "properties": {
+        "start": {
+          "$ref": "hash256",
+          "description": "If specified, this transaction will be the first transaction in the result."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "If specified, return at most this many transactions."
+        },
+        "minLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return only transactions in this ledger verion or higher."
+        },
+        "maxLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return only transactions in this ledger version or lower."
+        },
+        "earliestFirst": {
+          "type": "boolean",
+          "description": "If true, sort transactions so that the earliest ones come first. By default, the newest transactions will come first."
+        },
+        "excludeFailures": {
+          "type": "boolean",
+          "description": "If true, the result will omit transactions that did not succeed."
+        },
+        "initiated": {
+          "type": "boolean",
+          "description": "If true, return only transactions initiated by the account specified by `address`. If false, return only transactions not initiated by the account specified by `address`."
+        },
+        "counterparty": {
+          "$ref": "address",
+          "description": "If provided, only return transactions with this account as a counterparty to the transaction."
+        },
+        "types": {
+          "type": "array",
+          "items": {"$ref": "transactionType"},
+          "description": "Only return transactions of the specified [Transaction Types](#transaction-types)."
+        },
+        "binary": {
+          "type": "boolean",
+          "description": "If true, the transactions will be sent from the server in a condensed binary format rather than JSON."
+        }
+      },
+      "additionalProperties": false,
+      "not": {
+        "anyOf": [
+          {"required": ["start", "minLedgerVersion"]},
+          {"required": ["start", "maxLedgerVersion"]}
+        ]
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

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

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTrustlinesParameters",
+  "description": "Parameters for getTrustlines",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get trustlines for."
+    },
+    "options": {
+      "description": "Options to filter and determine which trustlines to return.",
+      "properties": {
+        "counterparty": {
+          "$ref": "address",
+          "description": "Only return trustlines with this counterparty."
+        },
+        "currency": {
+          "$ref": "currency",
+          "description": "Only return trustlines for this currency."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many trustlines."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return trustlines as they were in this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

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

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareOrderCancellationParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$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."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "sequence"]
+}

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

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareOrderParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "order": {
+      "$ref": "order",
+      "description": "The specification of the order to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "order"]
+}

src/common/schemas/input/prepare-payment.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "preparePaymentParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "payment": {
+      "$ref": "payment",
+      "description": "The specification of the payment to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "payment"]
+}

src/common/schemas/input/prepare-settings.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareSettingsParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "settings": {
+      "$ref": "settings",
+      "description": "The specification of the settings to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "settings"]
+}

src/common/schemas/input/prepare-suspended-payment-cancellation.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareSuspendedPaymentCancellationParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "suspendedPaymentCancellation": {
+      "$ref": "suspendedPaymentCancellation",
+      "description": "The specification of the suspended payment cancellation to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "suspendedPaymentCancellation"]
+}

src/common/schemas/input/prepare-suspended-payment-creation.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareSuspendedPaymentCreationParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "suspendedPaymentCreation": {
+      "$ref": "suspendedPaymentCreation",
+      "description": "The specification of the suspended payment creation to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "suspendedPaymentCreation"]
+}

src/common/schemas/input/prepare-suspended-payment-execution.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareSuspendedPaymentExecutionParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "suspendedPaymentExecution": {
+      "$ref": "suspendedPaymentExecution",
+      "description": "The specification of the suspended payment execution to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "suspendedPaymentExecution"]
+}

src/common/schemas/input/prepare-trustline.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareTrustlineParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "trustline": {
+      "$ref": "trustline",
+      "description": "The specification of the trustline to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "trustline"]
+}

src/common/schemas/input/sign.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "signParameters",
+  "type": "object",
+  "properties": {
+    "txJSON": {
+      "type": "string",
+      "description": "Transaction represented as a JSON string in rippled format."
+    },
+    "secret": {
+      "type": "string",
+      "format": "secret",
+      "description": "The secret of the account that is initiating the transaction."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["txJSON", "secret"]
+}

src/common/schemas/input/submit.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "submitParameters",
+  "type": "object",
+  "properties": {
+    "signedTransaction": {
+      "$ref": "blob",
+      "description": "A signed transaction as returned by [sign](#sign)."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["signedTransaction"]
+}

src/common/schemas/objects/address.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "address",
+  "description": "A Ripple account address",
+  "type": "string",
+  "format": "address",
+  "link": "ripple-address",
+  "pattern": "^r[1-9A-HJ-NP-Za-km-z]{25,34}$"
+}

src/common/schemas/objects/adjustment.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "adjustment",
+  "type": "object",
+  "properties": {
+    "address": {"$ref": "address"},
+    "amount": {"$ref": "amount"},
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address", "amount"],
+  "additionalProperties": false
+}

src/common/schemas/objects/amount-base.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "amountbase",
+  "description": "Base class for amount and issue",
+  "type": "object",
+  "properties": {
+    "value": {
+      "description": "The quantity of the currency, denoted as a string to retain floating point precision",
+      "$ref": "value"
+    },
+    "currency": {
+      "description": "The three-character code or hexadecimal string used to denote currencies",
+      "$ref": "currency"
+    },
+    "counterparty": {
+      "description": "The Ripple address of the account that owes or is owed the funds (omitted if `currency` is \"XRP\")",
+      "$ref": "address"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["currency"],
+  "oneOf": [
+    {
+      "properties": {
+        "currency": {
+          "not": {
+            "enum": ["XRP"]
+          }
+        }
+      },
+      "required": ["counterparty"]
+    },
+    {
+      "properties": {
+        "currency": {
+          "enum": ["XRP"]
+        }
+      },
+      "not": {
+        "required": ["counterparty"]
+      }
+    }
+  ]
+}

src/common/schemas/objects/amount.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "amount",
+  "link": "amount",
+  "description": "An Amount on the Ripple Protocol, used also for XRP in the ripple-rest API",
+  "allOf": [
+    {"$ref": "amountbase"},
+    {"required": ["value"]}
+  ]
+}

src/common/schemas/objects/balance.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "balance",
+  "description": "Balance amount",
+  "link": "amount",
+  "type": "object",
+  "properties": {
+    "value": {
+      "description": "The balance on the trustline",
+      "$ref": "signedValue"
+    },
+    "currency": {
+      "description": "The three-character code or hexadecimal string used to denote currencies",
+      "$ref": "currency"
+    },
+    "counterparty": {
+      "description": "The Ripple address of the account that owes or is owed the funds.",
+      "$ref": "address"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["currency", "value"],
+  "oneOf": [
+    {
+      "properties": {
+        "currency": {
+          "not": {
+            "enum": ["XRP"]
+          }
+        }
+      },
+      "required": ["counterparty"]
+    },
+    {
+      "properties": {
+        "currency": {
+          "enum": ["XRP"]
+        }
+      },
+      "not": {
+        "required": ["counterparty"]
+      }
+    }
+  ]
+}