Bump version to 0.17.3 and bump ripple-binary-codec to 0.1.4

.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["es2015", "stage-1"],
+  "plugins": ["syntax-flow", "transform-flow-strip-types"]
+}

.eslintrc.json

@@ -1,29 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es6": true,
-    "node": true,
-    "mocha": true
-  },
-  "extends": [
-    "eslint:recommended"
-  ],
-  "globals": {
-    "NodeJS": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module"
-  },
-  "plugins": [
-    "@typescript-eslint"
-  ],
-  "rules": {
-    "no-useless-constructor": 0,
-    "no-unused-vars": 0,
-    "no-prototype-builtins": 0,
-    "require-atomic-updates": 0,
-    "no-dupe-class-members": 0
-  }
-}

.flowconfig

@@ -0,0 +1,19 @@
+[ignore]
+.*/ripple-lib/src/.*
+.*/ripple-lib/dist/.*
+.*/ripple-lib/test/fixtures/.*
+.*/node_modules/flow-bin/.*
+.*/node_modules/webpack/.*
+.*/node_modules/babel-core/.*
+.*/node_modules/babel-eslint/.*
+.*/node_modules/babel-preset-es2015/.*
+.*/node_modules/babel-preset-stage-1/.*
+.*/node_modules/babel-register/.*
+
+[include]
+./node_modules/
+
+[libs]
+
+[options]
+module.system=node

.github/dependabot.yml

@@ -1,13 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: monthly
-    time: "15:00"
-  open-pull-requests-limit: 10
-  ignore:
-  - dependency-name: jsonschema
-    versions:
-    - "> 1.2.2"
-    - "< 2"

.github/pull_request_template.md

@@ -1,50 +0,0 @@
-## High Level Overview of Change
-
-<!--
-Please include a summary/list of the changes.
-If too broad, please consider splitting into multiple PRs.
-If a relevant Asana task, please link it here.
--->
-
-### Context of Change
-
-<!--
-Please include the context of a change.
-If a bug fix, when was the bug introduced? What was the behavior?
-If a new feature, why was this architecture chosen? What were the alternatives?
-If a refactor, how is this better than the previous implementation?
-
-If there is a design document for this feature, please link it here.
--->
-
-### Type of Change
-
-<!--
-Please check relevant options, delete irrelevant ones.
--->
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] Refactor (non-breaking change that only restructures code)
-- [ ] Tests (You added tests for code that already exists, or your new feature included in this PR)
-- [ ] Documentation Updates
-- [ ] Release
-
-## Before / After
-
-<!--
-If just refactoring / back-end changes, this can be just an in-English description of the change at a technical level.
-If a UI change, screenshots should be included.
--->
-
-## Test Plan
-
-<!--
-Please describe the tests that you ran to verify your changes and provide instructions so that others can reproduce.
--->
-
-<!--
-## Future Tasks
-For future tasks related to PR.
--->

.github/workflows/codeql-analysis.yml

@@ -1,67 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ develop, master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ develop ]
-  schedule:
-    - cron: '44 5 * * 6'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

.github/workflows/nodejs.yml

@@ -1,81 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ develop, master ]
-  pull_request:
-    branches: [ develop ]
-
-jobs:
-  unit:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: yarn install
-    - run: yarn test
-    - run: yarn lint
-    - run: yarn build
-
-  integration:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-
-    services:
-      rippled:
-        image: natenichols/rippled-standalone:latest
-        ports:
-        - 6006:6006
-        options:
-          --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s 
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: yarn install
-    - run: yarn test:integration
-      env:
-        HOST: localhost
-        PORT: ${{ job.services.rippled.ports['6006'] }}
-
-  browser:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [14.x] # This just needs to be compatible w/ puppeteer
-
-    services:
-      rippled:
-        image: natenichols/rippled-standalone:latest
-        ports:
-        - 6006:6006
-        options:
-          --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s 
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: yarn install
-    - run: yarn test:browser

.gitignore

@@ -1,9 +1,5 @@
 # .gitignore
 
-# Ignore package locks other than Yarn.
-package-lock.json
-npm-shrinkwrap.json
-
 # Ignore vim swap files.
 *.swp
 
@@ -55,19 +51,13 @@ test/config.js
 # Ignore npm-debug
 npm-debug.log
 
-# Ignore dist folder, built from tsc
+# Ignore dist folder, build for bower
 dist/
 
-# TypeScript incremental compilation cache
-*.tsbuildinfo
+# Ignore flow output directory
+out/
 
 # Ignore perf test cache
 scripts/cache
 
-.eslintrc
-
-# nyc (istanbul)
-.nyc_output
-
-# browser tests
-test-compiled-for-web 
+eslintrc

.npmignore

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

.nvmrc

@@ -1 +0,0 @@
-v12

.nycrc

@@ -1,10 +0,0 @@
-{
-  "include": ["src/**/*.ts"],
-  "exclude": ["src/**/*.d.ts"],
-  "extension": [".ts"],
-  "require": ["ts-node/register"],
-  "reporter": ["text-summary", "html"],
-  "sourceMap": true,
-  "instrument": true,
-  "cache": true
-}

.prettierrc

@@ -1,10 +0,0 @@
-{
-  "parser": "typescript",
-  "printWidth": 80,
-  "tabWidth": 2,
-  "semi": false,
-  "singleQuote": true,
-  "trailingComma": "none",
-  "quoteProps": "consistent",
-  "bracketSpacing": false
-}

.travis.yml

@@ -1,9 +0,0 @@
-language: node_js
-node_js:
-  - 10
-  - 12
-  - 13
-script:
-  - yarn test
-  - yarn build
-  - yarn lint

APPLICATIONS.md

@@ -1 +0,0 @@
-# [Moved to xrpl.js](https://github.com/XRPLF/xrpl.js/blob/main/APPLICATIONS.md)

Gulpfile.js

@@ -0,0 +1,209 @@
+/* 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 uglify = require('gulp-uglify');
+var rename = require('gulp-rename');
+var webpack = require('webpack');
+var bump = require('gulp-bump');
+var argv = require('yargs').argv;
+var assert = require('assert');
+var fs = require('fs');
+
+var pkg = require('./package.json');
+
+var uglifyOptions = {
+  mangle: {
+    except: ['_', 'RippleError', 'RippledError', 'UnexpectedError',
+    'LedgerVersionError', 'ConnectionError', 'NotConnectedError',
+    'DisconnectedError', 'TimeoutError', 'ResponseFormatError',
+    'ValidationError', 'NotFoundError', 'MissingLedgerHistoryError',
+    'PendingLedgerVersionError'
+    ]
+  }
+};
+
+function webpackConfig(extension, overrides) {
+  overrides = overrides || {};
+  var defaults = {
+    cache: true,
+    externals: [{
+      'lodash': '_'
+    }],
+    entry: './src/index.js',
+    output: {
+      library: 'ripple',
+      path: './build/',
+      filename: ['ripple-', extension].join(pkg.version)
+    },
+    plugins: [
+      new webpack.NormalModuleReplacementPlugin(/^ws$/, './wswrapper'),
+      new webpack.NormalModuleReplacementPlugin(/^\.\/wallet$/, './wallet-web'),
+      new webpack.NormalModuleReplacementPlugin(/^.*setup-api$/,
+        './setup-api-web')
+    ],
+    module: {
+      loaders: [{
+        test: /jayson/,
+        loader: 'null'
+      }, {
+        test: /\.js$/,
+        exclude: [/node_modules/],
+        loader: 'babel-loader'
+      }, {
+        test: /\.json/,
+        loader: 'json-loader'
+      }]
+    }
+  };
+  return _.assign({}, defaults, overrides);
+}
+
+function webpackConfigForWebTest(testFileName, path) {
+  var match = testFileName.match(/\/?([^\/]*)-test.js$/);
+  if (!match) {
+    assert(false, 'wrong filename:' + testFileName);
+  }
+  var configOverrides = {
+    externals: [{
+      'lodash': '_',
+      'ripple-api': 'ripple',
+      'net': 'null'
+    }],
+    entry: testFileName,
+    output: {
+      library: match[1].replace(/-/g, '_'),
+      path: './test-compiled-for-web/' + (path ? path : ''),
+      filename: match[1] + '-test.js'
+    }
+  };
+  return webpackConfig('.js', configOverrides);
+}
+
+gulp.task('build-tests', function(callback) {
+  var times = 0;
+  function done() {
+    if (++times >= 5) {
+      callback();
+    }
+  }
+  webpack(webpackConfigForWebTest('./test/rangeset-test.js'), done);
+  webpack(webpackConfigForWebTest('./test/connection-test.js'), done);
+  webpack(webpackConfigForWebTest('./test/api-test.js'), done);
+  webpack(webpackConfigForWebTest('./test/broadcast-api-test.js'), done);
+  webpack(webpackConfigForWebTest('./test/integration/integration-test.js',
+    'integration/'), done);
+});
+
+function createLink(from, to) {
+  if (fs.existsSync(to)) {
+    fs.unlinkSync(to);
+  }
+  fs.linkSync(from, to);
+}
+
+function createBuildLink(callback) {
+  return function(err, res) {
+    createLink('./build/ripple-' + pkg.version + '.js',
+      './build/ripple-latest.js');
+    callback(err, res);
+  };
+}
+
+gulp.task('build', function(callback) {
+  webpack(webpackConfig('.js'), createBuildLink(callback));
+});
+
+gulp.task('build-min', ['build'], function() {
+  return gulp.src(['./build/ripple-', '.js'].join(pkg.version))
+  .pipe(uglify(uglifyOptions))
+  .pipe(rename(['ripple-', '-min.js'].join(pkg.version)))
+  .pipe(gulp.dest('./build/'))
+  .on('end', function() {
+    createLink('./build/ripple-' + pkg.version + '-min.js',
+      './build/ripple-latest-min.js');
+  });
+});
+
+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/bower'));
+});
+
+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/bower'));
+});
+
+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/bower'));
+});
+
+gulp.task('bower-version', function() {
+  gulp.src('./dist/bower/bower.json')
+  .pipe(bump({version: pkg.version}))
+  .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');
+  }
+
+  gulp.src('./package.json')
+  .pipe(bump({type: argv.type}))
+  .pipe(gulp.dest('./'));
+});
+
+gulp.task('version-beta', function() {
+  gulp.src('./package.json')
+  .pipe(bump({version: pkg.version + '-beta'}))
+  .pipe(gulp.dest('./'));
+});
+
+gulp.task('default', ['build', 'build-debug', 'build-min']);

LICENSE

@@ -1,6 +1,4 @@
-ISC License
-
-Copyright (c) 2012-2021 Contributers to xrpl.js
+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

README.md

@@ -1,149 +1,37 @@
-## Deprecated
+#ripple-lib
 
-This library (ripple-lib 1.x) has been deprecated in favor of [xrpl.js version 2+](https://github.com/XRPLF/xrpl.js).
+A JavaScript API for interacting with Ripple in Node.js
 
-# ripple-lib (RippleAPI)
-
-A JavaScript/TypeScript API for interacting with the XRP Ledger
+[![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)
 
-This library is for integrating a JavaScript/TypeScript app with the XRP Ledger and supports functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.
+###Features
 
-## [➡️ Reference Documentation](https://github.com/XRPLF/xrpl.js/blob/1.x/docs/index.md)
++ Connect to a rippled server in Node.js
++ 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
 
-Use the above link to view the full reference documentation.
+##Getting Started
 
-### Features
-
-+ Connect to a `rippled` server from Node.js or a web browser
-+ Helpers for creating requests and parsing responses for the [rippled API](https://developers.ripple.com/rippled-api.html)
-+ Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)
-+ Sign and submit transactions to the XRP Ledger
-+ Type definitions for TypeScript
-
-### Requirements
-
-+ **[Node.js v14](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
-+ **[Yarn](https://yarnpkg.com/)** is recommended. `npm` may work but we use `yarn.lock`.
-
-## Getting Started
-
-See also: [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
-
-In an existing project (with `package.json`), install `ripple-lib`:
+Install `ripple-lib` using npm:
 ```
-$ yarn add ripple-lib
+  $ npm install ripple-lib
 ```
 
-Then see the [documentation](#documentation).
+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)
 
-### Using ripple-lib with React Native
-
-If you want to use `ripple-lib` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
-
-1. Install dependencies (you can use `npm` as well):
-
-    ```shell
-    yarn add react-native-crypto
-    yarn add ripple-lib 
-    # install peer deps
-    yarn add react-native-randombytes
-    # install latest rn-nodeify
-    yarn add rn-nodeify@latest --dev
-    ```
-
-2. After that, run the following command:
-
-    ```shell
-    # install node core shims and recursively hack package.json files
-    # in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings
-    ./node_modules/.bin/rn-nodeify --hack --install
-    ```
-
-3. Enable `crypto`:
-
-    `rn-nodeify` will create a `shim.js` file in the project root directory.
-    Open it and uncomment the line that requires the crypto module:
-
-    ```javascript
-    // If using the crypto shim, uncomment the following line to ensure
-    // crypto is loaded first, so it can populate global.crypto
-    require('crypto')
-    ```
-
-4. Import `shim` in your project (it must be the first line):
-
-  ```javascript
-  import './shim'
-  ...
-  ```
-
-### Using ripple-lib with Deno
-
-Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `ripple-lib` with Deno:
-
-```javascript
-import ripple from 'https://dev.jspm.io/npm:ripple-lib';
-
-(async () => {
-  const api = new (ripple as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
-  const address = 'rH8NxV12EuV...khfJ5uw9kT';
-
-  api.connect().then(() => {
-    api.getBalances(address).then((balances: any) => {
-      console.log(JSON.stringify(balances, null, 2));
-    });
-  });
-})();
-```
-
-## Documentation
-
-+ [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
-+ [RippleAPI Full Reference Documentation](https://xrpl.org/rippleapi-reference.html) ([in this repo](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md))
-+ [Code Samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
-+ [XRP Ledger Dev Portal](https://xrpl.org/)
-
-### Mailing Lists
-
-We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)
-
-+ [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-announce)
-
-If you're using the XRP Ledger in production, you should run a [rippled server](https://github.com/ripple/rippled) and subscribe to the ripple-server mailing list as well.
-
-+ [Subscribe to ripple-server](https://groups.google.com/forum/#!forum/ripple-server)
-
-## Development
-
-To build the library for Node.js and the browser:
-```
-$ yarn build
-```
-
-The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
-
-webpack will output the resulting JS files in `./build/`.
-
-For details, see the `scripts` in `package.json`.
-
-## Running Tests
-
-### Unit Tests
+##Running tests
 
 1. Clone the repository
-2. `cd` into the repository and install dependencies with `yarn install`
-3. `yarn test`
+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/`)
 
-### Linting
+##Generating Documentation
 
-Run `yarn lint` to lint the code with `eslint`.
+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`.
 
-## Generating Documentation
+##More Information
 
-Do not edit `./docs/index.md` directly because it is a generated file.
-
-Instead, edit the appropriate `.md.ejs` files in `./docs/src/`.
-
-If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running `yarn run docgen`.
++ [Ripple Dev Portal](https://ripple.com/build/)

SECURITY.md

@@ -1,29 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-This table shows which versions of ripple-lib are currently supported with security updates:
-
-| Version | Supported              |
-| ------- | ---------------------- |
-| 1.x     | :white_check_mark: Yes |
-| 0.x     | :x:                No  |
-
-## Responsible disclosure security policy
-
-The responsible disclosure of vulnerabilities helps to protect users of the project. Vulnerabilities are first triaged in a private manner, and only publicly disclosed after a reasonable time period that allows patching the vulnerability and provides an upgrade path for users.
-
-When contacting us directly via email, we will do our best to respond in a reasonable time to resolve the issue. Do not disclose the vulnerability until it has been patched and users have been given time to upgrade.
-
-We kindly ask you to refrain from malicious acts that put our users, the project, or any of the project’s team members at risk.
-
-## Reporting a security issue
-
-Security is a top priority. But no matter how much effort we put into security, there can still be vulnerabilities present.
-
-If you discover a security vulnerability, please use the following means of communications to report it to us:
-
-- Report the security issue to bugs@ripple.com
-- [Ripple Bug Bounty](https://ripple.com/bug-bounty/)
-
-Your efforts to responsibly disclose your findings are sincerely appreciated and will be taken into account to acknowledge your contributions.

circle.yml

@@ -1,10 +1,12 @@
 machine:
   node:
-    version: 6.11.3
+    version: 0.12.0
   hosts:
     testripple.circleci.com: 127.0.0.1
 dependencies:
   pre:
+    - npm -g install npm@latest-2
+    - npm install flow-bin
     - wget https://s3-us-west-2.amazonaws.com/ripple-debs/rippled_0.30.1-b11-1.deb
     - sudo dpkg -i rippled_0.30.1-b11-1.deb
 test:

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/README.md

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

docs/samples/ticket.js

@@ -1,31 +0,0 @@
-'use strict';
-const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib')
-
-const address = 'INSERT ADDRESS HERE';
-const secret = 'INSERT SECRET HERE';
-
-const api = new RippleAPI({server: 'wss://s1.ripple.com:443'});
-const instructions = {
-  maxLedgerVersionOffset: 5
-};
-const numberOfTickets = 1;
-
-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.prepareTicketCreate(address, numberOfTickets, instructions).then(prepared => {
-    console.log('Ticket transaction prepared...');
-    const {signedTransaction} = api.sign(prepared.txJSON, secret);
-    console.log('Ticket transaction signed...');
-    api.submit(signedTransaction).then(quit, fail);
-  });
-}).catch(fail);

docs/src/accountSetFlags.md.ejs

@@ -1,23 +0,0 @@
-## AccountSet Flags
-
-To modify account flags, you can use an AccountSet transaction and its `SetFlag` or `ClearFlag` fields.
-	
-The flags are called [AccountSet flags (asf*)](https://xrpl.org/accountset.html#accountset-flags):
-
-`RippleAPI.accountSetFlags.requireDestinationTag`: Require a destination tag to send transactions to this account.
-
-`RippleAPI.accountSetFlags.requireAuthorization`: Require authorization for users to hold balances issued by this address. Can only be enabled if the address has no trust lines connected to it.
-
-`RippleAPI.accountSetFlags.disallowIncomingXRP`: XRP should not be sent to this account. (Enforced by client applications, not by rippled)
-
-`RippleAPI.accountSetFlags.disableMasterKey`: Disallow use of the master key pair. Can only be enabled if the account has configured another way to sign transactions.
-
-`RippleAPI.accountSetFlags.enableTransactionIDTracking`: Track the ID of this account's most recent transaction.
-
-`RippleAPI.accountSetFlags.noFreeze`: Permanently give up the ability to freeze individual trust lines or disable Global Freeze. This flag can never be disabled after being enabled.
-
-`RippleAPI.accountSetFlags.globalFreeze`:	Freeze all assets issued by this account.
-
-`RippleAPI.accountSetFlags.defaultRipple`: Enable [rippling](https://xrpl.org/rippling.html) on this account's trust lines by default.
-
-`RippleAPI.accountSetFlags.depositAuth`:Enable Deposit Authorization on this account.

docs/src/basictypes.md.ejs

@@ -1,43 +1,32 @@
 # Basic Types
 
-## Address
+## Ripple Address
 
 ```json
 "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
 ```
 
-```json
-"X7AcgcsBL6XDcUb289X4mJ8djcdyKaB5hJDWMArnXr61cqZ"
-```
-
-An *address* refers to a specific XRP Ledger account. It is a base-58 encoding of a hash of the account's public key. There are two kinds of addresses in common use:
-
-### Classic Address
-
-A *classic address* encodes a hash of the account's public key and a checksum. It has no other data. This kind of address always starts with the lowercase letter `r`.
-
-### X-address
-
-An *X-address* encodes a hash of the account's public key, a tag, and a checksum. This kind of address starts with the uppercase letter `X` if it is intended for use on the production XRP Ledger (mainnet). It starts with the uppercase letter `T` if it is intended for use on a test network such as Testnet or Devnet.
+Every Ripple account has an *address*, which is a base58-encoding of a hash of the account's public key. Ripple addresses always start with the lowercase letter `r`.
 
 ## Account Sequence Number
 
-Every XRP Ledger account has a *sequence number* that is used to keep transactions in order. Every transaction must have a sequence or a ticketSequence number. A transaction can only be executed if it has the next sequence number in order, of the account sending it, or uses a previously generated ticketSequence 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.
+Every Ripple account has a *sequence number* that is used to keep transactions in order. Every transaction must have a sequence number. A transaction can only be executed if it has the next sequence number in order, of the account sending it. This prevents one transaction from executing twice and transactions executing out of order. The sequence number starts at `1` and increments for each transaction that the account makes.
 
 ## Currency
 
-Currencies are represented as either 3-character currency codes or 40-character uppercase hexadecimal strings. We recommend using uppercase [ISO 4217 Currency Codes](http://www.xe.com/iso4217.php) only. The string "XRP" is disallowed on trustlines because it is reserved for the XRP Ledger's native currency. The following characters are permitted: all uppercase and lowercase letters, digits, as well as the symbols `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `<`, `>`, `(`, `)`, `{`, `}`, `[`, `]`, and `|`.
+Currencies are represented as either 3-character currency codes or 40-character uppercase hexadecimal strings. We recommend using uppercase [ISO 4217 Currency Codes](http://www.xe.com/iso4217.php) only. The string "XRP" is disallowed on trustlines because it is reserved for the Ripple native currency. The following characters are permitted: all uppercase and lowercase letters, digits, as well as the symbols `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `<`, `>`, `(`, `)`, `{`, `}`, `[`, `]`, and `|`.
 
 ## Value
 A *value* is a quantity of a currency represented as a decimal string. Be careful: JavaScript's native number format does not have sufficient precision to represent all values. XRP has different precision from other currencies.
 
-**XRP** has 6 significant digits past the decimal point. In other words, XRP cannot be divided into positive values smaller than `0.000001` (1e-6). This smallest unit is called a "drop". XRP has a maximum value of `100000000000` (1e11). Some RippleAPI methods accept XRP to maintain compatibility with older versions of the API. For consistency with the `rippled` APIs, we recommend formally specifying XRP values in *drops* in all API requests, and converting them to XRP for display. This is like Bitcoin's *satoshis* and Ethereum's *wei*. 1 XRP = 1,000,000 drops.
+**XRP** has 6 significant digits past the decimal point. In other words, XRP cannot be divided into positive values smaller than `0.000001` (1e-6). XRP has a maximum value of `100000000000` (1e11).
 
 **Non-XRP values** have 16 decimal digits of precision, with a maximum value of `9999999999999999e80`. The smallest positive non-XRP value is `1e-81`.
 
+
 ## Amount
 
-Example 100.00 USD amount:
+Example amount:
 
 ```json
 {
@@ -47,16 +36,15 @@ Example 100.00 USD amount:
 }
 ```
 
-Example 3.0 XRP amount, in drops:
+Example XRP amount:
 ```json
 {
-  "currency": "drops",
-  "value": "3000000"
+  "currency": "XRP",
+  "value": "2000"
 }
 ```
-(Requires `ripple-lib` version 1.0.0 or higher.)
 
-An *amount* is an object specifying a currency, a quantity of that currency, and the counterparty (issuer) on the trustline that holds the value. For XRP, there is no counterparty.
+An *amount* is data structure representing a currency, a quantity of that currency, and the counterparty on the trustline that holds the value. For XRP, there is no counterparty.
 
 A *lax amount* allows the counterparty to be omitted for all currencies. If the counterparty is not specified in an amount within a transaction specification, then any counterparty may be used for that amount.
 
@@ -64,4 +52,4 @@ A *lax lax amount* allows either or both the counterparty and value to be omitte
 
 A *balance* is an amount than can have a negative value.
 
-<%- renderSchema('objects/amountbase.json') %>
+<%- renderSchema('objects/amount-base.json') %>

docs/src/boilerplate.md.ejs

@@ -3,10 +3,10 @@
 Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI.
 
 ```javascript
-const RippleAPI = require('ripple-lib').RippleAPI;
+const {RippleAPI} = require('ripple-lib');
 
 const api = new RippleAPI({
-  server: 'wss://xrplcluster.com' // Public cluster
+  server: 'wss://s1.ripple.com' // Public rippled server hosted by Ripple, Inc.
 });
 api.on('error', (errorCode, errorMessage) => {
   console.log(errorCode + ': ' + errorMessage);
@@ -16,7 +16,7 @@ api.on('connected', () => {
 });
 api.on('disconnected', (code) => {
   // code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server
-  // the code is 1000 for a normal closure
+  // will be 1000 if this was normal closure
   console.log('disconnected, code:', code);
 });
 api.connect().then(() => {
@@ -26,7 +26,9 @@ api.connect().then(() => {
 }).catch(console.error);
 ```
 
-[Node.js v14](https://nodejs.org/) is recommended. Other versions may work but are not frequently tested.
+RippleAPI is designed to work in [NodeJS](https://nodejs.org) (version `0.12.0` or greater) using [Babel](https://babeljs.io/) for [ECMAScript 6](https://babeljs.io/docs/learn-es2015/) support.
+
+The code samples in this documentation are written in ES6, but `RippleAPI` will work with ES5 also. Regardless of whether you use ES5 or ES6, the methods that return promises will return [ES6-style promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).
 
 <aside class="notice">
 All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
@@ -37,7 +39,7 @@ If you omit the "catch" section, errors may not be visible.
 </aside>
 
 <aside class="notice">
-The API emits an "error" event whenever an error occurs that cannot be associated with a specific request. If there is no listener registered for this event, the API throws an exception whenever the event is emitted.
+The "error" event is emitted whenever an error occurs that cannot be associated with a specific request. If the listener is not registered, an exception will be thrown whenever the event is emitted.
 </aside>
 
 ### Parameters
@@ -51,10 +53,16 @@ If you omit the `server` parameter, RippleAPI operates [offline](#offline-functi
 
 ### Installation ###
 
-1. Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install). Most Linux distros have a package for Node.js; check that it's the version you want.
-2. Use yarn to install RippleAPI:
-      `yarn add ripple-lib`
+1. Install [NodeJS](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for NodeJS, but make sure you have version `0.12.0` or higher.
+2. Use npm to install [Babel](https://babeljs.io/) globally:
+      `npm install -g babel-cli`
+3. Use npm to install RippleAPI:
+      `npm install ripple-lib`
 
-After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`:
+After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using babel-node:
+      `babel-node script.js`
+
+<aside class="notice">
+Instead of using babel-node in production, we recommend using Babel to transpile to ECMAScript 5 first.
+</aside>
 
-      `node script.js`

docs/src/combine.md.ejs

@@ -2,7 +2,7 @@
 
 `combine(signedTransactions: Array<string>): {signedTransaction: string, id: string}`
 
-Combines signed transactions from multiple accounts for a multisignature transaction into a form that can be [submitted](#submit).
+Combines signed transactions from multiple accounts for a multisignature transaction. The signed transaction must subsequently be [submitted](#submit).
 
 ### Parameters
 

docs/src/computeLedgerHash.md.ejs

@@ -1,6 +1,6 @@
 ## computeLedgerHash
 
-`computeLedgerHash(ledger: object): string`
+`computeLedgerHash(ledger: Object): string`
 
 Compute the hash of a ledger.
 

docs/src/deriveAddress.md.ejs

@@ -1,19 +0,0 @@
-## deriveAddress
-
-`deriveAddress(publicKey: string): string`
-
-Derive an XRP Ledger address from a public key.
-
-### Parameters
-
-This method takes one parameter, the public key from which to derive the address.
-
-### Return Value
-
-This method returns a string corresponding to the address derived from the public key.
-
-### Example
-
-```javascript
-var address = api.deriveAddress(public_key);
-```

docs/src/deriveKeypair.md.ejs

@@ -1,21 +0,0 @@
-## deriveKeypair
-
-`deriveKeypair(seed: string): {privateKey: string, publicKey: string}`
-
-Derive a public and private key from a seed.
-
-### Parameters
-
-This method takes one parameter, the seed from which to derive the public and private key.
-
-### Return Value
-
-This method returns an object containing the public and private components of the keypair corresponding to the seed.
-
-### Example
-
-```javascript
-var keypair = api.deriveKeypair(seed)
-var public_key = keypair.publicKey;
-var private_key = keypair.privateKey;
-```

docs/src/events.md.ejs

@@ -27,7 +27,7 @@ This event is emitted when there is an error on the connection to the server tha
 The first parameter is a string indicating the error type:
 * `badMessage` - rippled returned a malformed message
 * `websocket` - the websocket library emitted an error
-* one of the error codes found in the [`rippled` Universal Errors](https://xrpl.org/error-formatting.html#universal-errors).
+* one of the error codes found in the [rippled Universal Errors](https://ripple.com/build/rippled-apis/#universal-errors).
 
 The second parameter is a message explaining the error.
 

docs/src/formatBidsAndAsks.md.ejs

@@ -1,254 +0,0 @@
-## formatBidsAndAsks
-
-`formatBidsAndAsks(orderbookInfo: {base: Issue, counter: Issue}, offers: BookOffer[]): orderbook`
-
-Returns formatted bids and asks, which make up an orderbook.
-
-This is a static method on the `RippleAPI` class.
-
-### Parameters
-
-This method takes two parameters.
-
-1. An `OrderbookInfo` object: `{ base: Issue, counter: Issue }`.
-2. An array of `BookOffer` objects.
-
-### Return Value
-
-This method returns an object with two properties: `bids` and `asks`, each of which is an array of bids (buy orders) or asks (sell orders), respectively. Both `bids` and `asks` are formatted the same way.
-
-Object structure:
-
-<%- renderSchema('output/get-orderbook.json') %>
-
-**Raw order data:** The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields.
-
-For details, see the `rippled` [book_offers method](https://xrpl.org/book_offers.html).
-
-### Example
-
-```javascript
-const orderbookInfo = {
-  "base": {
-    "currency": "USD",
-    "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-  },
-  "counter": {
-    "currency": "BTC",
-    "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-  }
-};
-
-const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-
-return Promise.all(
-  [
-    this.api.request('book_offers', {
-      taker_gets: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base),
-      taker_pays: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter),
-      ledger_index: 'validated',
-      limit: 20,
-      taker: address
-    }),
-    this.api.request('book_offers', {
-      taker_gets: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter),
-      taker_pays: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base),
-      ledger_index: 'validated',
-      limit: 20,
-      taker: address
-    })
-  ]
-).then((directOfferResults, reverseOfferResults) => {
-  const directOffers = (directOfferResults ? directOfferResults : []).reduce((acc, res) => acc.concat(res.offers), [])
-  const reverseOffers = (reverseOfferResults ? reverseOfferResults : []).reduce((acc, res) => acc.concat(res.offers), [])
-  const orderbook = RippleAPI.formatBidsAndAsks(orderbookInfo, [...directOffers, ...reverseOffers]);
-  console.log(JSON.stringify(orderbook, null, 2));
-});
-```
-
-```
-{
-  "bids": [
-    {
-      "specification": {
-        "direction": "buy",
-        "quantity": {
-          "currency": "USD",
-          "value": "0.71800168",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        },
-        "totalPrice": {
-          "currency": "BTC",
-          "value": "0.00016708342",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
-      },
-      "properties": {
-        "maker": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq",
-        "sequence": 262660,
-        "makerExchangeRate": "4297.264683713081"
-      },
-      "data": {
-        "Account": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq",
-        "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98580F4456E6FA8239",
-        "BookNode": "0000000000000000",
-        "Flags": 0,
-        "LedgerEntryType": "Offer",
-        "OwnerNode": "000000000000001D",
-        "PreviousTxnID": "16D75506C6317723FC03543130B5E0AAB13E8AD22514C1DB098BE05771C90447",
-        "PreviousTxnLgrSeq": 43127860,
-        "Sequence": 262660,
-        "TakerGets": {
-          "currency": "BTC",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "0.00016708342"
-        },
-        "TakerPays": {
-          "currency": "USD",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "0.71800168"
-        },
-        "index": "DE877FB94EF892A4BCC58DB8CDE063D97AB5133201905DE6C8650B5DEA19E11B",
-        "owner_funds": "0.03358376764081196",
-        "quality": "4297.264683713081"
-      }
-    },
-    {
-      "specification": {
-        "direction": "buy",
-        "quantity": {
-          "currency": "USD",
-          "value": "1.6770875",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        },
-        "totalPrice": {
-          "currency": "BTC",
-          "value": "0.00038681218",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
-      },
-      "properties": {
-        "maker": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM",
-        "sequence": 231459,
-        "makerExchangeRate": "4335.663628792661"
-      },
-      "data": {
-        "Account": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM",
-        "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98580F67435A75B355",
-        "BookNode": "0000000000000000",
-        "Flags": 0,
-        "LedgerEntryType": "Offer",
-        "OwnerNode": "0000000000000001",
-        "PreviousTxnID": "F049EAFDDDA7B99970F77533743D95C9E12A16FE6C56215A0B09C32C4D23163F",
-        "PreviousTxnLgrSeq": 43127094,
-        "Sequence": 231459,
-        "TakerGets": {
-          "currency": "BTC",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "0.00038681218"
-        },
-        "TakerPays": {
-          "currency": "USD",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "1.6770875"
-        },
-        "index": "3B314A51BD57601CA1509834DF9462037BF4B05AFCC1E1EFD334DB4E2D7B2AA6",
-        "owner_funds": "0.03906802968738533",
-        "quality": "4335.663628792661"
-      }
-    },
-    // ... trimmed for brevity ...
-  ],
-  "asks": [
-    {
-      "specification": {
-        "direction": "sell",
-        "quantity": {
-          "currency": "USD",
-          "value": "0.71085738",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        },
-        "totalPrice": {
-          "currency": "BTC",
-          "value": "0.00016876265",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
-      },
-      "properties": {
-        "maker": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq",
-        "sequence": 262664,
-        "makerExchangeRate": "0.0002374071856720401"
-      },
-      "data": {
-        "Account": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq",
-        "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A451086F34ADB0EA11",
-        "BookNode": "0000000000000000",
-        "Flags": 0,
-        "LedgerEntryType": "Offer",
-        "OwnerNode": "000000000000001D",
-        "PreviousTxnID": "54CE0B2783AF973718FAFA35E864A3C172BE488EBBB6F2852611C6DAC8893BDF",
-        "PreviousTxnLgrSeq": 43127875,
-        "Sequence": 262664,
-        "TakerGets": {
-          "currency": "USD",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "0.71085738"
-        },
-        "TakerPays": {
-          "currency": "BTC",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "0.00016876265"
-        },
-        "index": "2D4ED103D6B3FEFA21BC385C53B63359F5678E5AA5429DDE6E1D8FE8B41CD6A8",
-        "owner_funds": "142.8821425048244",
-        "quality": "0.0002374071856720401"
-      }
-    },
-    {
-      "specification": {
-        "direction": "sell",
-        "quantity": {
-          "currency": "USD",
-          "value": "1.6438778",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        },
-        "totalPrice": {
-          "currency": "BTC",
-          "value": "0.00039462656",
-          "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-        }
-      },
-      "properties": {
-        "maker": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM",
-        "sequence": 231483,
-        "makerExchangeRate": "0.0002400583303698121"
-      },
-      "data": {
-        "Account": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM",
-        "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4510887515B1216C9",
-        "BookNode": "0000000000000000",
-        "Flags": 0,
-        "LedgerEntryType": "Offer",
-        "OwnerNode": "0000000000000001",
-        "PreviousTxnID": "6FA370F52C45F6149482156FF7B4226713AECE991FB7D053F74172CB0B8F24E9",
-        "PreviousTxnLgrSeq": 43127158,
-        "Sequence": 231483,
-        "TakerGets": {
-          "currency": "USD",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "1.6438778"
-        },
-        "TakerPays": {
-          "currency": "BTC",
-          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
-          "value": "0.00039462656"
-        },
-        "index": "735F9661AD006BA0776859BE371D445555FC0815604603AC056469C16AC84AE3",
-        "owner_funds": "166.0316626329364",
-        "quality": "0.0002400583303698121"
-      }
-    },
-    // ... trimmed for brevity ...
-  ]
-}
-```

docs/src/generateAddress.md.ejs

@@ -1,10 +1,8 @@
 ## generateAddress
 
-`generateAddress(options?: object): {address: string, secret: string}`
+`generateAddress(): {address: string, secret: string}`
 
-Deprecated: This method returns a classic address. If you do not need the classic address, use `generateXAddress` instead.
-
-Generate a new XRP Ledger address and corresponding secret.
+Generate a new Ripple address and corresponding secret.
 
 ### Parameters
 

docs/src/generateFaucetWallet.md.ejs

@@ -1,19 +0,0 @@
-## generateFaucetWallet
-
-`generateFaucetWallet(onTestnet = true)`
-
-Calls the Testnet or Devnet faucet API in order to generate a new, random wallet with some amount of test XRP. This is for testing purposes only.
-
-### Example
-
-**Request**
-
-Create a new wallet on the Testnet:
-
-```javascript
-const wallet = await api.generateFaucetWallet()
-```
-
-**Response**
-
-<%- renderFixture('responses/generate-faucet-wallet.json') %>

docs/src/generateXAddress.md.ejs

@@ -1,23 +0,0 @@
-## generateXAddress
-
-`generateXAddress(options?: object): {address: string, secret: string}`
-
-Generate a new XRP Ledger address and corresponding secret.
-
-### Parameters
-
-<%- renderSchema('input/generate-x-address.json') %>
-
-### Return Value
-
-This method returns an object with the following structure:
-
-<%- renderSchema('output/generate-x-address.json') %>
-
-### Example
-
-```javascript
-return api.generateXAddress();
-```
-
-<%- renderFixture('responses/generate-x-address.json') %>

docs/src/getAccountInfo.md.ejs

@@ -1,6 +1,6 @@
 ## getAccountInfo
 
-`getAccountInfo(address: string, options: object): Promise<object>`
+`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).
 

docs/src/getAccountObjects.md.ejs

@@ -1,34 +0,0 @@
-## getAccountObjects
-
-`getAccountObjects(address: string, options: object): Promise<AccountObjectsResponse>`
-
-Returns objects owned by an account. For an account's trust lines and balances, see `getTrustlines` and `getBalances`.
-
-### Parameters
-
-<%- renderSchema('input/get-account-objects.json') %>
-
-### Return Value
-
-This method returns a promise that resolves with an object with the following structure:
-
-<%- renderSchema('output/get-account-objects.json') %>
-
-The types of objects that may be returned include:
-
-* `Offer` objects for orders that are currently live, unfunded, or expired but not yet removed.
-* `RippleState` objects for trust lines where this account's side is not in the default state.
-* A `SignerList` object if the account has multi-signing enabled.
-* `Escrow` objects for held payments that have not yet been executed or canceled.
-* `PayChannel` objects for open payment channels.
-* `Check` objects for pending checks.
-
-### Example
-
-```javascript
-const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-return api.getAccountObjects(address: address).then(objects =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/get-account-objects.json') %>

docs/src/getBalanceSheet.md.ejs

@@ -1,6 +1,6 @@
 ## getBalanceSheet
 
-`getBalanceSheet(address: string, options: object): Promise<object>`
+`getBalanceSheet(address: string, options: Object): Promise<Object>`
 
 Returns aggregate balances by currency plus a breakdown of assets and obligations for a specified account.
 

docs/src/getBalances.md.ejs

@@ -1,6 +1,6 @@
 ## getBalances
 
-`getBalances(address: string, options: object): Promise<Array<object>>`
+`getBalances(address: string, options: Object): Promise<Array<Object>>`
 
 Returns balances for a specified account.
 

docs/src/getFee.md.ejs

@@ -1,18 +1,16 @@
 ## getFee
 
-`getFee(): Promise<string>`
+`getFee(): Promise<number>`
 
 Returns the estimated transaction fee for the rippled server the RippleAPI instance is connected to.
 
-This uses the [feeCushion parameter](#parameters) provided to the RippleAPI constructor, or the default value of `1.2`.
-
 ### Parameters
 
-<%- renderSchema('input/get-fee.json') %>
+This method has no parameters.
 
 ### Return Value
 
-This method returns a promise that resolves with a string-encoded floating point value representing the estimated fee to submit a transaction, expressed in XRP.
+This method returns a promise that resolves with a string encoded floating point value representing the estimated fee to submit a transaction, expressed in XRP.
 
 ### Example
 
@@ -21,5 +19,5 @@ return api.getFee().then(fee => {/* ... */});
 ```
 
 ```json
-"0.000012"
+"0.012"
 ```

docs/src/getLedger.md.ejs

@@ -1,6 +1,6 @@
 ## getLedger
 
-`getLedger(options: object): Promise<object>`
+`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.
 

docs/src/getOrderbook.md.ejs

@@ -1,27 +1,19 @@
 ## getOrderbook
 
-`getOrderbook(address: string, orderbook: object, options: object): Promise<object>`
+`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.
 
-**Breaking change:** In ripple-lib 1.1.0 and earlier, orders returned by this method were not sorted correctly. Orders are now sorted correctly, from best to worst.
-
-**See also:** An alternative way to get orderbooks is with `request` and [`formatBidsAndAsks`](#formatbidsandasks).
-
 ### Parameters
 
 <%- renderSchema('input/get-orderbook.json') %>
 
 ### Return Value
 
-This method returns a promise that resolves with an object with the following structure Both `bids` and `asks` have the same format:
+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') %>
 
-**Raw order data:** The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields.
-
-For details, see the `rippled` [book_offers method](https://xrpl.org/book_offers.html).
-
 ### Example
 
 ```javascript

docs/src/getOrders.md.ejs

@@ -1,6 +1,6 @@
 ## getOrders
 
-`getOrders(address: string, options: object): Promise<Array<object>>`
+`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.
 

docs/src/getPaths.md.ejs

@@ -1,6 +1,6 @@
 ## getPaths
 
-`getPaths(pathfind: object): Promise<Array<object>>`
+`getPaths(pathfind: Object): Promise<Array<Object>>`
 
 Finds paths to send a payment. Paths are options for how to route a payment.
 

docs/src/getPaymentChannel.md.ejs

@@ -1,26 +0,0 @@
-## getPaymentChannel
-
-`getPaymentChannel(id: string): Promise<object>`
-
-Returns specified payment channel.
-
-### Parameters
-
-<%- renderSchema('input/get-payment-channel.json') %>
-
-### Return Value
-
-This method returns a promise that resolves with an object with the following structure:
-
-<%- renderSchema('output/get-payment-channel.json') %>
-
-### Example
-
-```javascript
-const channelId =
-  'E30E709CF009A1F26E0E5C48F7AA1BFB79393764F15FB108BDC6E06D3CBD8415';
-return api.getPaymentChannel(channelId).then(channel =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/get-payment-channel.json') %>

docs/src/getSettings.md.ejs

@@ -1,6 +1,6 @@
 ## getSettings
 
-`getSettings(address: string, options: object): Promise<object>`
+`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).
 
@@ -10,7 +10,7 @@ Returns settings for the specified account. Note: For account data that is not m
 
 ### Return Value
 
-This method returns a promise that resolves with an array of objects with the following structure. All fields are optional, and are omitted if they are set to their default 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') %>
 

docs/src/getTransaction.md.ejs

@@ -1,6 +1,6 @@
 ## getTransaction
 
-`getTransaction(id: string, options: object): Promise<object>`
+`getTransaction(id: string, options: Object): Promise<Object>`
 
 Retrieves a transaction by its [Transaction ID](#transaction-id).
 

docs/src/getTransactions.md.ejs

@@ -1,6 +1,6 @@
 ## getTransactions
 
-`getTransactions(address: string, options: object): Promise<Array<object>>`
+`getTransactions(address: string, options: Object): Promise<Array<Object>>`
 
 Retrieves historical transactions of an account.
 

docs/src/getTrustlines.md.ejs

@@ -1,6 +1,6 @@
 ## getTrustlines
 
-`getTrustlines(address: string, options: object): Promise<Array<object>>`
+`getTrustlines(address: string, options: Object): Promise<Array<Object>>`
 
 Returns trustlines for a specified account.
 

docs/src/hasNextPage.md.ejs

@@ -1,27 +0,0 @@
-## hasNextPage
-
-`hasNextPage(currentResponse): boolean`
-
-Returns `true` when there are more pages available.
-
-When there are more results than contained in the response, the response includes a `marker` field. You can use this convenience method, or check for `marker` yourself.
-
-See [Markers and Pagination](https://xrpl.org/markers-and-pagination.html).
-
-### Return Value
-
-This method returns `true` if `currentResponse` includes a `marker`.
-
-### Example
-
-```javascript
-return api.request('ledger_data', {
-  ledger_index: 'validated'
-}).then(response => {
-  /* Do something useful with response */
-
-  if (api.hasNextPage(response)) {
-    /* There are more pages available */
-  }
-}).catch(console.error);
-```

docs/src/index.md.ejs

@@ -1,72 +1,38 @@
-<%- include('introduction.md.ejs') %>
-<%- include('boilerplate.md.ejs') %>
-<%- include('offline.md.ejs') %>
-<%- include('basictypes.md.ejs') %>
-<%- include('transactions.md.ejs') %>
-<%- include('specifications.md.ejs') %>
-<%- include('rippledAPIs.md.ejs') %>
-<%- include('request.md.ejs') %>
-<%- include('hasNextPage.md.ejs') %>
-<%- include('requestNextPage.md.ejs') %>
-
-<%- include('staticMethods.md.ejs') %>
-<%- include('renameCounterpartyToIssuer.md.ejs') %>
-<%- include('formatBidsAndAsks.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('getAccountObjects.md.ejs') %>
-<%- include('getPaymentChannel.md.ejs') %>
-<%- include('getLedger.md.ejs') %>
-<%- include('parseAccountFlags.md.ejs') %>
-<%- include('prepareTransaction.md.ejs') %>
-<%- include('preparePayment.md.ejs') %>
-<%- include('prepareTrustline.md.ejs') %>
-<%- include('prepareOrder.md.ejs') %>
-<%- include('prepareOrderCancellation.md.ejs') %>
-<%- include('prepareSettings.md.ejs') %>
-<%- include('prepareEscrowCreation.md.ejs') %>
-<%- include('prepareEscrowCancellation.md.ejs') %>
-<%- include('prepareEscrowExecution.md.ejs') %>
-<%- include('preparePaymentChannelCreate.md.ejs') %>
-<%- include('preparePaymentChannelClaim.md.ejs') %>
-<%- include('preparePaymentChannelFund.md.ejs') %>
-<%- include('prepareCheckCreate.md.ejs') %>
-<%- include('prepareCheckCancel.md.ejs') %>
-<%- include('prepareCheckCash.md.ejs') %>
-<%- include('prepareTicketCreate.md.ejs') %>
-<%- include('sign.md.ejs') %>
-<%- include('combine.md.ejs') %>
-<%- include('submit.md.ejs') %>
-<%- include('generateXAddress.md.ejs') %>
-<%- include('generateAddress.md.ejs') %>
-<%- include('isValidAddress.md.ejs') %>
-<%- include('isValidSecret.md.ejs') %>
-<%- include('deriveKeypair.md.ejs') %>
-<%- include('deriveAddress.md.ejs') %>
-<%- include('generateFaucetWallet.md.ejs') %>
-<%- include('signPaymentChannelClaim.md.ejs') %>
-<%- include('verifyPaymentChannelClaim.md.ejs') %>
-<%- include('computeLedgerHash.md.ejs') %>
-<%- include('xrpToDropsAndDropsToXrp.md.ejs') %>
-<%- include('iso8601ToRippleTime.md.ejs') %>
-<%- include('rippleTimeToISO8601.md.ejs') %>
-<%- include('txFlags.md.ejs') %>
-<%- include('accountSetFlags.md.ejs') %>
-<%- include('schemaValidator.md.ejs') %>
-<%- include('events.md.ejs') %>
+<% include introduction.md.ejs %>
+<% include boilerplate.md.ejs %>
+<% include offline.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 combine.md.ejs %>
+<% include submit.md.ejs %>
+<% include generateAddress.md.ejs %>
+<% include computeLedgerHash.md.ejs %>
+<% include events.md.ejs %>

docs/src/introduction.md.ejs

@@ -1,15 +1,12 @@
 # Introduction
 
-RippleAPI (ripple-lib) is the official client library to the XRP Ledger. Currently, RippleAPI is only available in JavaScript/TypeScript.
-
+RippleAPI is the official client library to the Ripple Consensus Ledger. Currently, RippleAPI is only available in JavaScript. 
 Using RippleAPI, you can:
 
-* [Query transactions from the XRP Ledger history](#gettransaction)
+* [Query transactions from the network](#gettransaction)
 * [Sign](#sign) transactions securely without connecting to any server
-* [Submit](#submit) transactions to the XRP Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types)
-* [Generate a new XRP Ledger Address](#generateaddress)
+* [Submit](#submit) transactions to the Ripple Consensus Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types)
+* [Generate a new Ripple Address](#generateaddress)
 * ... and [much more](#api-methods).
 
-This page contains documentation for ripple-lib. To use ripple-lib with npm/yarn, begin with the [Getting Started](https://github.com/ripple/ripple-lib#getting-started) steps.
-
-**What is ripple-lib used for?** Here's a [list of applications that use `ripple-lib`](https://github.com/ripple/ripple-lib/blob/develop/APPLICATIONS.md). Open a PR to add your app or project to the list!
+RippleAPI only provides access to *validated*, *immutable* transaction data.

docs/src/isValidAddress.md.ejs

@@ -1,19 +0,0 @@
-## isValidAddress
-
-`isValidAddress(address: string): boolean`
-
-Checks if the specified string contains a valid address. X-addresses are considered valid with ripple-lib v1.4.0 and higher.
-
-### Parameters
-
-This method takes one parameter, the address to validate.
-
-### Return Value
-
-This method returns `true` if the address is valid and `false` if it is not.
-
-### Example
-
-```javascript
-return api.isValidAddress("address")
-```

docs/src/isValidSecret.md.ejs

@@ -1,19 +0,0 @@
-## isValidSecret
-
-`isValidSecret(secret: string): boolean`
-
-Checks if the specified string contains a valid secret.
-
-### Parameters
-
-This method takes one parameter, the secret which to validate.
-
-### Return Value
-
-This method returns `true` if the secret is valid and `false` if it is not.
-
-### Example
-
-```javascript
-return api.isValidSecret("secret")
-```

docs/src/iso8601ToRippleTime.md.ejs

@@ -1,27 +0,0 @@
-## iso8601ToRippleTime
-
-`iso8601ToRippleTime(iso8601: string): number`
-
-This method parses a string representation of a date, and returns the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC).
-
-The Ripple Epoch is 946684800 seconds after the Unix Epoch.
-
-This method is useful for creating timestamps to use with the rippled APIs. The rippled APIs represent time as an unsigned integer of the number of seconds since the Ripple Epoch.
-
-### Parameters
-
-`iso8601`: A string representing a date and time. This string is parsed using JavaScript's `Date.parse()` method.
-
-### Return Value
-
-The number of seconds since the Ripple Epoch.
-
-### Example
-
-```javascript
-api.iso8601ToRippleTime('2017-02-17T15:04:57Z');
-```
-
-```json
-540659097
-```

docs/src/offline.md.ejs

@@ -1,27 +1,27 @@
 ## Offline functionality
 
-RippleAPI can also function without internet connectivity, so you can generate secrets and sign transactions from a secure, isolated machine.
+RippleAPI can also function without internet connectivity. This can be useful in order to generate secrets and sign transactions from a secure, isolated machine.
 
-To instantiate RippleAPI in offline mode, use the following code:
+To instantiate RippleAPI in offline mode, use the following boilerplate code:
 
 ```javascript
-const RippleAPI = require('ripple-lib').RippleAPI;
+const {RippleAPI} = require('ripple-lib');
 
 const api = new RippleAPI();
 /* insert code here */
 ```
 
-Methods that depend on the state of the XRP Ledger are unavailable in offline mode. To prepare transactions offline, you **must** specify  the `fee`, `sequence`, and `maxLedgerVersion` parameters in the [transaction instructions](#transaction-instructions). You can use the following methods while offline:
+Methods that depend on the state of the Ripple Consensus Ledger are unavailable in offline mode. To prepare transactions offline, you **must** specify  the `fee`, `sequence`, and `maxLedgerVersion` parameters in the [transaction instructions](#transaction-instructions). The following methods should work offline:
 
 * [preparePayment](#preparepayment)
 * [prepareTrustline](#preparetrustline)
 * [prepareOrder](#prepareorder)
 * [prepareOrderCancellation](#prepareordercancellation)
 * [prepareSettings](#preparesettings)
-* [prepareEscrowCreation](#prepareescrowcreation)
-* [prepareEscrowCancellation](#prepareescrowcancellation)
-* [prepareEscrowExecution](#prepareescrowexecution)
+* [prepareSuspendedPaymentCreation](#preparesuspendedpaymentcreation)
+* [prepareSuspendedPaymentCancellation](#preparesuspendedpaymentcancellation)
+* [prepareSuspendedPaymentExecution](#preparesuspendedpaymentexecution)
 * [sign](#sign)
 * [generateAddress](#generateaddress)
-* [generateXAddress](#generatexaddress)
 * [computeLedgerHash](#computeledgerhash)
+

docs/src/parseAccountFlags.md.ejs

@@ -1,35 +0,0 @@
-## parseAccountFlags
-
-`parseAccountFlags(Flags: number): object`
-
-Parse an `AccountRoot` object's [`Flags`](https://xrpl.org/accountroot.html#accountroot-flags).
-
-### Parameters
-
-This method takes one parameter, the AccountRoot `Flags` number to parse. Note that flags have different mappings on other types of objects or in transactions such as AccountSet.
-
-### Return Value
-
-This method returns an object with containing a key for each AccountRoot flag known to this version of RippleAPI. Each flag has a boolean value of `true` or `false`.
-
-### Example
-
-```javascript
-const account_info = await api.request('account_info', {account: 'rKsdkGhyZH6b2Zzd5hNnEqSv2wpznn4n6N'})
-const flags = api.parseAccountFlags(account_info.account_data.Flags)
-console.log(JSON.stringify(flags, null, 2))
-```
-
-```json
-{
-  "passwordSpent": false,
-  "requireDestinationTag": false,
-  "requireAuthorization": false,
-  "depositAuth": true,
-  "disallowIncomingXRP": false,
-  "disableMasterKey": false,
-  "noFreeze": false,
-  "globalFreeze": false,
-  "defaultRipple": false
-}
-```

docs/src/prepareCheckCancel.md.ejs

@@ -1,30 +0,0 @@
-## prepareCheckCancel
-
-`prepareCheckCancel(address: string, checkCancel: object, instructions: object): Promise<object>`
-
-Prepare a Check cancellation transaction. This type of transaction cancels an unredeemed Check, removing it from the ledger without sending any money. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-check-cancel.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 checkCancel = <%- importFile('test/fixtures/requests/prepare-check-cancel.json') %>;
-return api.prepareCheckCancel(address, checkCancel).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-check-cancel.json') %>

docs/src/prepareCheckCash.md.ejs

@@ -1,30 +0,0 @@
-## prepareCheckCash
-
-`prepareCheckCash(address: string, checkCash: object, instructions: object): Promise<object>`
-
-Prepare a Check cashing transaction. This redeems a Check to receive up to the amount authorized by the corresponding CheckCreate transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-check-cash.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 checkCash = <%- importFile('test/fixtures/requests/prepare-check-cash-amount.json') %>;
-return api.prepareCheckCash(address, checkCash).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-check-cash-amount.json') %>

docs/src/prepareCheckCreate.md.ejs

@@ -1,30 +0,0 @@
-## prepareCheckCreate
-
-`prepareCheckCreate(address: string, checkCreate: object, instructions: object): Promise<object>`
-
-Prepare a Check creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-check-create.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 checkCreate = <%- importFile('test/fixtures/requests/prepare-check-create.json') %>;
-return api.prepareCheckCreate(address, checkCreate).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-check-create.json') %>

docs/src/prepareEscrowCancellation.md.ejs

@@ -1,30 +0,0 @@
-## prepareEscrowCancellation
-
-`prepareEscrowCancellation(address: string, escrowCancellation: object, instructions: object): Promise<object>`
-
-Prepare an escrow cancellation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-escrow-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 escrowCancellation = <%- importFile('test/fixtures/requests/prepare-escrow-cancellation.json') %>;
-return api.prepareEscrowCancellation(address, escrowCancellation).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-escrow-cancellation.json') %>

docs/src/prepareEscrowCreation.md.ejs

@@ -1,36 +0,0 @@
-## prepareEscrowCreation
-
-`prepareEscrowCreation(address: string, escrowCreation: object, instructions: object): Promise<object>`
-
-Prepare an escrow creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-escrow-creation.json') %>
-
-This is a convenience method for generating the EscrowCreate JSON used by rippled, so the same restrictions apply.
-
-Field mapping: `allowCancelAfter` is equivalent to rippled's `CancelAfter`; `allowExecuteAfter` is equivalent to `FinishAfter`. At the `allowCancelAfter` time, the escrow is considered expired. This means that the funds can only be returned to the sender. At the `allowExecuteAfter` time, the escrow is permitted to be released to the recipient (if the `condition` is fulfilled).
-
-Note that `allowCancelAfter` must be chronologically later than `allowExecuteAfter`.
-
-### 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 escrowCreation = <%- importFile('test/fixtures/requests/prepare-escrow-creation.json') %>;
-return api.prepareEscrowCreation(address, escrowCreation).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-escrow-creation.json') %>

docs/src/prepareEscrowExecution.md.ejs

@@ -1,30 +0,0 @@
-## prepareEscrowExecution
-
-`prepareEscrowExecution(address: string, escrowExecution: object, instructions: object): Promise<object>`
-
-Prepare an escrow execution transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-escrow-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 escrowExecution = <%- importFile('test/fixtures/requests/prepare-escrow-execution.json') %>;
-return api.prepareEscrowExecution(address, escrowExecution).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-escrow-execution.json') %>

docs/src/prepareOrder.md.ejs

@@ -1,8 +1,8 @@
 ## prepareOrder
 
-`prepareOrder(address: string, order: object, instructions: object): Promise<object>`
+`prepareOrder(address: string, order: Object, instructions: Object): Promise<Object>`
 
-Prepare an order transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
+Prepare an order transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
 
 ### Parameters
 
@@ -22,8 +22,6 @@ All "prepare*" methods have the same return type.
 
 ```javascript
 const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-
-// Buy 10.10 USD (of the specified issuer) for 2.0 XRP (2000000 drops), fill or kill.
 const order = <%- importFile('test/fixtures/requests/prepare-order.json') %>;
 return api.prepareOrder(address, order)
   .then(prepared => {/* ... */});

docs/src/prepareOrderCancellation.md.ejs

@@ -1,8 +1,8 @@
 ## prepareOrderCancellation
 
-`prepareOrderCancellation(address: string, orderCancellation: object, instructions: object): Promise<object>`
+`prepareOrderCancellation(address: string, orderCancellation: Object, instructions: Object): Promise<Object>`
 
-Prepare an order cancellation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
+Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
 
 ### Parameters
 

docs/src/preparePayment.md.ejs

@@ -1,8 +1,8 @@
 ## preparePayment
 
-`preparePayment(address: string, payment: object, instructions: object): Promise<object>`
+`preparePayment(address: string, payment: Object, instructions: Object): Promise<Object>`
 
-Prepare a payment transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
+Prepare a payment transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
 
 ### Parameters
 
@@ -23,11 +23,8 @@ All "prepare*" methods have the same return type.
 ```javascript
 const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
 const payment = <%- importFile('test/fixtures/requests/prepare-payment.json') %>;
-return api.preparePayment(address, payment).then(prepared => {
-    /* ... */
-  }).catch(error => {
-    /* ... as with all prepare* methods, use a Promise catch block to handle errors ... */
-  })
+return api.preparePayment(address, payment).then(prepared =>
+  {/* ... */});
 ```
 
 <%- renderFixture("responses/prepare-payment.json") %>

docs/src/preparePaymentChannelClaim.md.ejs

@@ -1,30 +0,0 @@
-## preparePaymentChannelClaim
-
-`preparePaymentChannelClaim(address: string, paymentChannelClaim: object, instructions: object): Promise<object>`
-
-Prepare a payment channel claim transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-payment-channel-claim.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 paymentChannelClaim = <%- importFile('test/fixtures/requests/prepare-payment-channel-claim.json') %>;
-return api.preparePaymentChannelClaim(address, paymentChannelClaim).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-payment-channel-claim.json') %>

docs/src/preparePaymentChannelCreate.md.ejs

@@ -1,30 +0,0 @@
-## preparePaymentChannelCreate
-
-`preparePaymentChannelCreate(address: string, paymentChannelCreate: object, instructions: object): Promise<object>`
-
-Prepare a payment channel creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-payment-channel-create.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 paymentChannelCreate = <%- importFile('test/fixtures/requests/prepare-payment-channel-create.json') %>;
-return api.preparePaymentChannelCreate(address, paymentChannelCreate).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-payment-channel-create.json') %>

docs/src/preparePaymentChannelFund.md.ejs

@@ -1,30 +0,0 @@
-## preparePaymentChannelFund
-
-`preparePaymentChannelFund(address: string, paymentChannelFund: object, instructions: object): Promise<object>`
-
-Prepare a payment channel fund transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-payment-channel-fund.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 paymentChannelFund = <%- importFile('test/fixtures/requests/prepare-payment-channel-fund.json') %>;
-return api.preparePaymentChannelFund(address, paymentChannelFund).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-payment-channel-fund.json') %>

docs/src/prepareSettings.md.ejs

@@ -1,8 +1,8 @@
 ## prepareSettings
 
-`prepareSettings(address: string, settings: object, instructions: object): Promise<object>`
+`prepareSettings(address: string, settings: Object, instructions: Object): Promise<Object>`
 
-Prepare a settings transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
+Prepare a settings transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
 
 ### Parameters
 

docs/src/prepareSuspendedPaymentCancellation.md.ejs

@@ -0,0 +1,32 @@
+## 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).
+
+**Caution:** Suspended Payments are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only.
+
+### 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,32 @@
+## 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).
+
+**Caution:** Suspended Payments are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only.
+
+### 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,32 @@
+## 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).
+
+**Caution:** Suspended Payments are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only.
+
+### 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/prepareTicketCreate.md.ejs

@@ -1,34 +0,0 @@
-## prepareTicketCreate
-
-`prepareTicketCreate(address: string, ticketCount: number, instructions: object): Promise<object>`
-
-Prepare a ticket transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-Ticket functionality requires the [TicketBatch amendment](https://github.com/ripple/xrpl-dev-portal/issues/898). As of 2020-11-24, this amendment is not activated on the Mainnet, Testnet, or Devnet.
-
-### Parameters
-
-<%- renderSchema("input/prepare-ticket-create.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';
-return api.prepareTicketCreate(address, 2).then(prepared => {
-    /* ... */
-  }).catch(error => {
-    /* ... as with all prepare* methods, use a Promise catch block to handle errors ... */
-  })
-```
-
-<%- renderFixture("responses/prepare-ticket-create.json") %>

docs/src/prepareTransaction.md.ejs

@@ -1,50 +0,0 @@
-## prepareTransaction
-
-`prepareTransaction(transaction: object, instructions: object): Promise<object>`
-
-Prepare a transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
-
-This method works with any of [the transaction types supported by rippled](https://xrpl.org/transaction-types.html).
-
-Notably, this is the preferred method for preparing `DepositPreauth` or `AccountDelete` transactions.
-
-### Parameters
-
-Name | Type | Description
----- | ---- | -----------
-transaction | [Transaction](https://xrpl.org/transaction-formats.html) | The specification (JSON) of the transaction to prepare. Set `Account` to the address of the account that is creating the transaction. You may omit auto-fillable fields like `Fee`, `Flags`, and `Sequence` to have them set automatically.
-instructions | [Instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction.
-
-### 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
-async function preparedPreauth() {
-  const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-  return api.prepareTransaction({
-    TransactionType: 'DepositPreauth',
-    Account: address,
-    Authorize: 'rMyVso4p83khNyHdV1m1PggV9QNadCj8wM'
-  });
-}
-```
-
-```javascript
-{
-  txJSON: '{"TransactionType":"DepositPreauth","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Authorize":"rMyVso4p83khNyHdV1m1PggV9QNadCj8wM","Flags":2147483648,"LastLedgerSequence":13561714,"Fee":"12","Sequence":1}',
-  instructions: {
-    fee: '0.000012',
-    sequence: 1,
-    maxLedgerVersion: 13561714
-  }
-}
-```

docs/src/prepareTrustline.md.ejs

@@ -1,8 +1,8 @@
 ## prepareTrustline
 
-`prepareTrustline(address: string, trustline: object, instructions: object): Promise<object>`
+`prepareTrustline(address: string, trustline: Object, instructions: Object): Promise<Object>`
 
-Prepare a trustline transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
+Prepare a trustline transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
 
 ### Parameters
 

docs/src/renameCounterpartyToIssuer.md.ejs

@@ -1,37 +0,0 @@
-## renameCounterpartyToIssuer
-
-`renameCounterpartyToIssuer(issue: {currency: string, counterparty: address}): {currency: string, issuer: address}`
-
-Returns an object with the `counterparty` field renamed to `issuer`. This is useful because RippleAPI generally uses the name `counterparty` while the rippled API generally uses the name `issuer`.
-
-This is a static method on the `RippleAPI` class.
-
-### Parameters
-
-This method takes one parameter, an object with a `counterparty` field.
-
-### Return Value
-
-This method returns a new object based on the source object, but with `issuer` instead of `counterparty`.
-
-### Example
-
-```javascript
-const orderbookInfo = {
-  "base": {
-    "currency": "USD",
-    "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-  },
-  "counter": {
-    "currency": "BTC",
-    "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
-  }
-};
-console.log(RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base))
-console.log(RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter))
-```
-
-```
-{ currency: 'USD', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' }
-{ currency: 'BTC', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' }
-```

docs/src/request.md.ejs

@@ -1,27 +0,0 @@
-## request
-
-`request(command: string, options: object): Promise<object>`
-
-Returns the response from invoking the specified command, with the specified options, on the connected rippled server.
-
-Refer to [HTTP / WebSocket APIs](https://xrpl.org/rippled-api.html) for commands and options. All XRP amounts must be specified in drops. One drop is equal to 0.000001 XRP. See [Specifying Currency Amounts](https://xrpl.org/basic-data-types.html#specifying-currency-amounts).
-
-Most commands return data for the `current` (in-progress, open) ledger by default. Do not rely on this. Always specify a ledger version in your request. In the example below, the 'validated' ledger is requested, which is the most recent ledger that has been validated by the whole network. See [Specifying Ledgers](https://xrpl.org/basic-data-types.html#specifying-ledgers).
-
-### Return Value
-
-This method returns a promise that resolves with the response from rippled.
-
-### Example
-
-```javascript
-// Replace 'ledger' with your desired rippled command
-return api.request('ledger', {
-  ledger_index: 'validated'
-}).then(response => {
-  /* Do something useful with response */
-  console.log(JSON.stringify(response, null, 2))
-}).catch(console.error);
-```
-
-<%- renderFixture('responses/ledger.json') %>

docs/src/requestNextPage.md.ejs

@@ -1,29 +0,0 @@
-## requestNextPage
-
-`requestNextPage(command: string, params: object = {}, currentResponse: object): Promise<object>`
-
-Requests the next page of data.
-
-You can use this convenience method, or include `currentResponse.marker` in `params` yourself, when using `request`.
-
-See [Markers and Pagination](https://xrpl.org/markers-and-pagination.html).
-
-### Return Value
-
-This method returns a promise that resolves with the next page of data from rippled.
-
-If the response does not have a next page, the promise rejects with `new errors.NotFoundError('response does not have a next page')`.
-
-### Example
-
-```javascript
-const command = 'ledger_data'
-const params = {
-  ledger_index: 'validated'
-}
-return api.request(command, params).then(response => {
-  return api.requestNextPage(command, params, response)
-}).then(response_page_2 => {
-  /* Do something useful with second page of response */
-}).catch(console.error);
-```

docs/src/rippleTimeToISO8601.md.ejs

@@ -1,27 +0,0 @@
-## rippleTimeToISO8601
-
-`rippleTimeToISO8601(rippleTime: number): string`
-
-This method takes the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC) and returns a string representation of a date.
-
-The Ripple Epoch is 946684800 seconds after the Unix Epoch.
-
-This method is useful for interpreting timestamps returned by the rippled APIs. The rippled APIs represent time as an unsigned integer of the number of seconds since the Ripple Epoch.
-
-### Parameters
-
-`rippleTime`: A number of seconds since the Ripple Epoch.
-
-### Return Value
-
-A string representing a date and time, created by calling a `Date` object's `toISOString()` method.
-
-### Example
-
-```javascript
-api.rippleTimeToISO8601(540659097);
-```
-
-```json
-'2017-02-17T15:04:57.000Z'
-```

docs/src/rippledAPIs.md.ejs

@@ -1,71 +0,0 @@
-# rippled APIs
-
-ripple-lib uses the XRP Ledger's [WebSocket API](https://xrpl.org/rippled-api.html) for online functionality. You can use ripple-lib to call these APIs directly. Use the `request()`, `hasNextPage()`, and `requestNextPage()` methods:
-
-* Use `request()` to issue any `rippled` command, including `account_currencies`, `subscribe`, and `unsubscribe`. [Full list of API Methods](https://xrpl.org/public-rippled-methods.html).
-* Use `hasNextPage()` to determine whether a response has more pages. This is true when the response includes a [`marker` field](https://xrpl.org/markers-and-pagination.html).
-* Use `requestNextPage()` to request the next page of data.
-
-When using rippled APIs:
-
-* [Specify XRP amounts in drops](https://xrpl.org/basic-data-types.html#specifying-currency-amounts).
-* [Specify timestamps as the number of seconds since the "Ripple Epoch"](https://xrpl.org/basic-data-types.html#specifying-time).
-* Instead of `counterparty`, use `issuer`.
-
-## Listening to streams
-
-The `rippled` server can push updates to your client when various events happen.
-Refer to [Subscriptions in the `rippled` API docs](https://xrpl.org/subscribe.html) for details.
-
-Note that the `streams` parameter for generic streams takes an array. For example, to subscribe to the `validations` stream, use `{ streams: [ 'validations' ] }`.
-
-The string names of some generic streams to subscribe to are in the table below. (Refer to `rippled` for an up-to-date list of streams.)
-
-Type | Description
----- | -----------
-`server` | Sends a message whenever the status of the `rippled` server (for example, network connectivity) changes.
-`ledger` | Sends a message whenever the consensus process declares a new validated ledger.
-`transactions` | Sends a message whenever a transaction is included in a closed ledger.
-`transactions_proposed` | Sends a message whenever a transaction is included in a closed ledger, as well as some transactions that have not yet been included in a validated ledger and may never be. Not all proposed transactions appear before validation. Even some transactions that don't succeed are included in validated ledgers because they take the anti-spam transaction fee.
-`validations` | Sends a message whenever the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator.
-`manifests` | Sends a message whenever the server receives a manifest.
-`peer_status` | (Admin-only) Information about connected peer `rippled` servers, especially with regards to the consensus process.
-
-When you subscribe to a stream, you must also listen to the relevant message type(s). Some of the available message types are in the table below. (Refer to `rippled` for an up-to-date list of message types.)
-
-Type | Description
----- | -----------
-`ledgerClosed` | Sent by the `ledger` stream when the consensus process declares a new fully validated ledger. The message identifies the ledger and provides some information about its contents.
-`validationReceived` | Sent by the `validations` stream when the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator.
-`manifestReceived` | Sent by the `manifests` stream when the server receives a manifest.
-`transaction` | Sent by many subscriptions including `transactions`, `transactions_proposed`, `accounts`, `accounts_proposed`, and `book` (Order Book). See [Transaction Streams](https://xrpl.org/subscribe.html#transaction-streams) for details.
-`peerStatusChange` | (Admin-only) Reports a large amount of information on the activities of other `rippled` servers to which the server is connected.
-`path_find` | Asynchronous follow-up response to the currently open path\_find request. See [rippled path\_find method](https://xrpl.org/path_find.html) for details.
-
-To register your listener function, use `connection.on(type, handler)`.
-
-Here is an example of listening for transactions on given account(s):
-```
-const account = 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn' // Replace with the account you want notifications for
-api.connect().then(() => {
-
-  // 'transaction' can be replaced with the relevant `type` from the table above
-  api.connection.on('transaction', (event) => {
-
-      // Do something useful with `event`
-      console.log(JSON.stringify(event, null, 2))
-  })
-
-  api.request('subscribe', {
-      accounts: [ account ]
-  }).then(response => {
-      console.log('Successfully subscribed')
-  }).catch(error => {
-      // Handle `error`
-  })
-})
-```
-
-The subscription ends when you unsubscribe or the WebSocket connection is closed.
-
-For full details, see the [subscribe method](https://xrpl.org/subscribe.html).

docs/src/schemaValidator.md.ejs

@@ -1,35 +0,0 @@
-## schemaValidator
-
-Unlike the rest of the ripple-lib API, schemaValidator is a static object on RippleAPI. It provides utility methods that do not use a server.
-
-## schemaValidate
-
-`RippleAPI.schemaValidator.schemaValidate(schemaName: string, object: any): void`
-
-This method checks an object for conformance to a specified schema. It does not return anything, but throws a `ValidationError` if the object does not conform to the schema.
-
-### Example
-
-```javascript
-RippleAPI.schemaValidator.schemaValidate('sign', {
-    signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304',
-    id: '10B54D31384A49336C36A5907E3C28227139E282D3C7F734FEA351DE446F3674'
-})
-```
-
-```json
-undefined
-```
-
-If the object is valid (conforms to the schema), nothing is returned. Otherwise, `schemaValidate` throws an error:
-
-```javascript
-RippleAPI.schemaValidator.schemaValidate('sign', {
-    signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304',
-    id: '123'
-})
-```
-
-```
-[ValidationError(instance.id does not match pattern "^[A-F0-9]{64}$")]
-```

docs/src/sign.md.ejs

@@ -1,22 +1,13 @@
 ## sign
 
-```
-sign(txJSON: string, secret: string, options: object): {signedTransaction: string, id: string}
-sign(txJSON: string, keypair: object, options: object): {signedTransaction: string, id: string}
-```
+`sign(txJSON: string, secret: string, options: Object): {signedTransaction: string, id: string}`
 
-Sign a prepared transaction. The signed transaction can then be [submitted](#submit).
-
-This method can sign any of [the transaction types supported by ripple-binary-codec](https://github.com/ripple/ripple-binary-codec/blob/cfcde79c19c359e9a0466d7bc3dc9a3aef47bb99/src/enums/definitions.json#L1637). When a new transaction type is added to the XRP Ledger, it is unrecognized until `ripple-binary-codec` is updated. If you try to sign an unrecognized transaction type, this method throws an error like the following:
-
-`Error: [TRANSACTION_TYPE] is not a valid name or ordinal for TransactionType`
+Sign a prepared transaction. The signed transaction must subsequently be [submitted](#submit).
 
 ### Parameters
 
 <%- renderSchema("input/sign.json") %>
 
-When this method is used for multi-signing, the `options` parameter is required. See the multi-signing example in this section for more details.
-
 ### Return Value
 
 This method returns an object with the following structure:
@@ -26,116 +17,9 @@ This method returns an object with the following structure:
 ### Example
 
 ```javascript
-// AccountSet transaction that sets Domain to example.com:
-const txJSON = '{"Flags":2147483648,"TransactionType":"AccountSet","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Domain":"6578616D706C652E636F6D","LastLedgerSequence":8820051,"Fee":"12","Sequence":23}';
+const txJSON = '{"Flags":2147483648,"TransactionType":"AccountSet","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Domain":"726970706C652E636F6D","LastLedgerSequence":8820051,"Fee":"12","Sequence":23}';
 const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV';
-const keypair = { privateKey: '00ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A', publicKey: '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8' };
-return api.sign(txJSON, secret); // or: api.sign(txJSON, keypair);
+return api.sign(txJSON, secret);
 ```
 
 <%- renderFixture("responses/sign.json") %>
-
-### Example Keypairs
-
-To learn how keypairs are derived read [here](https://xrpl.org/cryptographic-keys.html#generating-keys).
-```javascript
-// secp25519 (33 bytes)
-const privateKey = "002512BBDFDBB77510883B7DCCBEF270B86DEAC8B64AC762873D75A1BEE6298665"
-const publicKey = "0390A196799EE412284A5D80BF78C3E84CBB80E1437A0AECD9ADF94D7FEAAFA284"
-
-// ed25519 (Note the 0xED prefixes a 32 byte value for a total of 33 bytes)
-const privateKey = "ED0B6CBAC838DFE7F47EA1BD0DF00EC282FDF45510C92161072CCFB84035390C4D"
-const publicKey = "ED1A7C082846CFF58FF9A892BA4BA2593151CCF1DBA59F37714CC9ED39824AF85F"
-```
-
-### Example (multi-signing)
-
-```javascript
-const RippleAPI = require('ripple-lib').RippleAPI;
-
-// jon's address will have a multi-signing setup with a quorum of 2
-const jon = {
-    account: 'rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj',
-    secret: 'sh4Va7b1wQof8knHFV2sxwX12fSgK'
-};
-const aya = {
-    account: 'rnrPdBjs98fFFfmRpL6hM7exT788SWQPFN',
-    secret: 'snaMuMrXeVc2Vd4NYvHofeGNjgYoe'
-};
-const bran = {
-    account: 'rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH',
-    secret: 'shQtQ8Um5MS218yvEU3Ehy1eZQKqH'
-};
-
-// Setup the signers list with a quorum of 2
-const multiSignSetupTransaction = {
-    "Flags": 0,
-    "TransactionType": "SignerListSet",
-    "Account": "rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj",
-    "Fee": "120",
-    "SignerQuorum": 2,
-    "SignerEntries": [
-        {
-            "SignerEntry": {
-                "Account": "rnrPdBjs98fFFfmRpL6hM7exT788SWQPFN",
-                "SignerWeight": 2
-            }
-        },
-        {
-            "SignerEntry": {
-                "Account": "rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH",
-                "SignerWeight": 1
-            }
-        },
-    ]
-};
-
-// a transaction which requires multi signing
-const multiSignPaymentTransaction = {
-    TransactionType: 'Payment',
-    Account: 'rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj',
-    Destination: 'rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH',
-    Amount: '88000000'
-};
-
-const multiSignPaymentInstruction = {
-  signersCount: 2
-};
-
-const api = new RippleAPI({
-    server: 'wss://s.altnet.rippletest.net:51233'
-});
-
-api.connect().then(() => {
-    // adding the multi signing feature to jon's account
-    api.prepareTransaction(multiSignSetupTransaction).then((prepared) => {
-        console.log(prepared);
-        jonSign = api.sign(prepared.txJSON, jon.secret).signedTransaction;
-        api.submit(jonSign).then( response => {
-            console.log(response.resultCode, response.resultMessage);
-
-            // multi sign a transaction
-            api.prepareTransaction(multiSignPaymentTransaction, multiSignPaymentInstruction).then(prepared => {
-                console.log(prepared);
-
-                // Aya and Bran sign it too but with 'signAs' set to their own account
-                let ayaSign = api.sign(prepared.txJSON, aya.secret, {'signAs': aya.account}).signedTransaction;
-                let branSign = api.sign(prepared.txJSON, bran.secret, {'signAs': bran.account}).signedTransaction;
-
-                // signatures are combined and submitted
-                let combinedTx = api.combine([ayaSign, branSign]);
-                api.submit(combinedTx.signedTransaction).then(response => {
-                    console.log(response.tx_json.hash);
-                    return api.disconnect();
-                }).catch(console.error);
-            }).catch(console.error);
-        }).catch(console.error)
-    }).catch(console.error);
-}).catch(console.error);
-```
-
-If the multi-signing account was setup properly, the above example logs `resultCode: 'tesSUCCESS'` and the hash for the transaction. If any of `{signAs: some_address}` options were missing, the code returns a validation error such as:
-
-```
-[ValidationError(txJSON is not the same for all signedTransactions)]
-```

docs/src/signPaymentChannelClaim.md.ejs

@@ -1,28 +0,0 @@
-## signPaymentChannelClaim
-
-`signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string`
-
-Sign a payment channel claim. A [PaymentChannelClaim](#preparepaymentchannelclaim) transaction can use the resulting signature to withdraw XRP from a payment channel.
-
-### Parameters
-
-<%- renderSchema("input/sign-payment-channel-claim.json") %>
-
-### Return Value
-
-This method returns a signature string:
-
-<%- renderSchema("output/sign-payment-channel-claim.json") %>
-
-### Example
-
-```javascript
-const channel =
-  '3E18C05AD40319B809520F1A136370C4075321B285217323396D6FD9EE1E9037';
-const amount = '.00001';
-const privateKey =
-  'ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A';
-return api.signPaymentChannelClaim(channel, amount, privateKey);
-```
-
-<%- renderFixture("responses/sign-payment-channel-claim.json") %>

docs/src/specifications.md.ejs

@@ -1,185 +1,83 @@
 # Transaction Specifications
 
-A *transaction specification* specifies what a transaction should do. Each [Transaction Type](#transaction-types) has its own type of specification, which corresponds to the [native XRP Ledger transaction types](https://xrpl.org/transaction-types.html).
-
-## Account Delete
-
-Delete your account and send the remaining XRP elsewhere. (Native transaction type: [AccountDelete](https://xrpl.org/accountdelete.html))
-
-<%- renderSchema('specifications/account-delete.json') %>
-
-> **Note:** To prepare an Account Delete transaction, use [`prepareTransaction()`](#preparetransaction) with the [native transaction format](https://xrpl.org/accountdelete.html).
-
-## Check Cancel
-
-Cancel a Check that has not been redeemed. (Native transaction type: [CheckCancel](https://xrpl.org/checkcancel.html))
-
-<%- renderSchema('specifications/check-cancel.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-check-cancel.json') %>
-
-
-## Check Cash
-
-Redeem a Check for up to its stated value. (Native transaction type: [CheckCash](https://xrpl.org/checkcash.html))
-
-<%- renderSchema('specifications/check-cash.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-check-cash-amount.json') %>
-
-
-## Check Create
-
-Create a Check, a deferred payment that can be redeemed by the destination. (Native transaction type: [CheckCreate](https://xrpl.org/checkcreate.html))
-
-<%- renderSchema('specifications/check-create.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-check-create.json') %>
-
-
-## Deposit Preauth
-
-Preauthorize an sender to deposit money at an account using [Deposit Authorization](https://xrpl.org/depositauth.html). (Native transaction type: [DepositPreauth](https://xrpl.org/depositpreauth.html))
-
-<%- renderSchema('specifications/deposit-preauth.json') %>
-
-> **Note:** To prepare a Deposit Preauth transaction, use [`prepareTransaction()`](#preparetransaction) with the [native transaction format](https://xrpl.org/depositpreauth.html).
-
-
-## Escrow Cancellation
-
-Cancel an Escrow that has passed its expiration. (Native transaction type: [EscrowCancel](https://xrpl.org/escrowcancel.html))
-
-<%- renderSchema('specifications/escrow-cancellation.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-escrow-cancellation.json') %>
-
-
-## Escrow Creation
-
-Create an Escrow that locks up XRP until a given time or condition is met. (Native transaction type: [EscrowCreate](https://xrpl.org/escrowcreate.html))
-
-<%- renderSchema('specifications/escrow-creation.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-escrow-creation.json') %>
-
-
-## Escrow Execution
-
-Deliver XRP from an Escrow after its conditions have been met. (Native transaction type: [EscrowFinish](https://xrpl.org/escrowfinish.html))
-
-<%- renderSchema('specifications/escrow-execution.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-escrow-execution.json') %>
-
-
-## Order
-
-Create and execute a limit order in the decentralized exchange. (Native transaction type: [OfferCreate](https://xrpl.org/offercreate.html))
-
-<%- renderSchema('specifications/order.json') %>
-
-The following invalid flag combination causes a `ValidationError`: `immediateOrCancel` and `fillOrKill`. These fields are mutually exclusive, and cannot both be set at the same time.
-
-#### Example
-
-<%- renderFixture('requests/prepare-order.json') %>
-
-
-## Order Cancellation
-
-Cancel an order in the decentralized exchange. (Native transaction type: [OfferCancel](https://xrpl.org/offercancel.html))
-
-<%- renderSchema('specifications/order-cancellation.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-order-cancellation.json') %>
-
+A *transaction specification* specifies what a transaction should do. Each [Transaction Type](#transaction-types) has its own type of specification.
 
 ## Payment
 
-Send value from one account to another. (Native transaction type: [Payment](https://xrpl.org/payment.html))
+See [Transaction Types](#transaction-types) for a description.
 
 <%- renderSchema('specifications/payment.json') %>
 
-#### Example
+### Example
 
 <%- renderFixture('requests/prepare-payment.json') %>
 
-
-## Payment Channel Claim
-
-Redeem XRP from a Payment Channel. (Native transaction type: [PaymentChannelClaim](https://xrpl.org/paymentchannelclaim.html))
-
-<%- renderSchema('specifications/payment-channel-claim.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-payment-channel-claim.json') %>
-
-
-## Payment Channel Create
-
-Create a Payment Channel with XRP set aside for asynchronous payments. (Native transaction type: [PaymentChannelCreate](https://xrpl.org/paymentchannelcreate.html))
-
-<%- renderSchema('specifications/payment-channel-create.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-payment-channel-create.json') %>
-
-
-## Payment Channel Fund
-
-Add XRP to a Payment Channel. (Native transaction type: [PaymentChannelFund](https://xrpl.org/paymentchannelfund.html))
-
-<%- renderSchema('specifications/payment-channel-fund.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-payment-channel-fund.json') %>
-
-
-
-## Settings
-
-Change account settings. (Native transaction types: [AccountSet](https://xrpl.org/accountset.html), [SetRegularKey](https://xrpl.org/setregularkey.html), [SignerListSet](https://xrpl.org/signerlistset.html))
-
-<%- renderSchema('output/get-settings.json') %>
-
-#### Example
-
-<%- renderFixture('requests/prepare-settings.json') %>
-
-
-## Ticket Create
-
-Set aside account Sequence numbers as Tickets to be used by later transactions.
-
-> **Caution:** As of 2021-01-22, Tickets are not yet available on the XRP Ledger.
-
-> **Note:** To prepare a Ticket Create transaction, use [`prepareTransaction()`](#preparetransaction) with the native transaction format. <!-- Future link: https://xrpl.org/ticketcreate.html -->
-
-
 ## Trustline
 
-Create or modify a trust line between two accounts, for an issued currency. (Native transaction type: [TrustSet](https://xrpl.org/trustset.html))
+See [Transaction Types](#transaction-types) for a description.
 
 <%- renderSchema('specifications/trustline.json') %>
 
-#### Example
+### Example
 
 <%- renderFixture('requests/prepare-trustline.json') %>
+
+## Order
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/order.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-order.json') %>
+
+## Order Cancellation
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/order-cancellation.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-order-cancellation.json') %>
+
+## Settings
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('output/get-settings.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-settings.json') %>
+
+## Suspended Payment Creation
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/suspended-payment-creation.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-suspended-payment-creation.json') %>
+
+## Suspended Payment Cancellation
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/suspended-payment-cancellation.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-suspended-payment-cancellation.json') %>
+
+## Suspended Payment Execution
+
+See [Transaction Types](#transaction-types) for a description.
+
+<%- renderSchema('specifications/suspended-payment-execution.json') %>
+
+### Example
+
+<%- renderFixture('requests/prepare-suspended-payment-execution.json') %>

docs/src/staticMethods.md.ejs

@@ -1,100 +0,0 @@
-# Static Methods
-
-You can access static methods directly on the `RippleAPI` class. For example, `RippleAPI.computeBinaryTransactionHash(...)`.
-
-A few of the most commonly-used methods are documented below.
-
-For a full list, refer to these docs:
-
-- [XRP Ledger Hashes](https://github.com/ripple/ripple-lib/blob/develop/src/common/hashes/README.md)
-- [ripple-address-codec API](https://github.com/ripple/ripple-address-codec/blob/master/README.md#api)
-
-## computeBinaryTransactionHash
-
-`computeBinaryTransactionHash(txBlobHex: string): string`
-
-Returns the hash (id) of a binary transaction blob.
-
-This is a static method on the `RippleAPI` class.
-
-### Parameters
-
-This method takes one parameter, a string containing a binary transaction in hex.
-
-### Return Value
-
-This method returns a string representing the transaction's id (hash).
-
-### Example
-
-```javascript
-const signed_blob = '120000228000000024000B2E5A201B0066374B61400000003B9ACA0068400000000000000C732102356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC74473045022100B3721EEB1ED6DFF29FB8B209E2DE6B54A0A6E44D52D926342F3D334BE98F08640220367A74107AD5DEAEFA3AB2984C161FC23F30B2704BB5CC984358BA262177A4568114F667B0CA50CC7709A220B0561B85E53A48461FA883142B71D8B09B4EE8DAA68FB936C23E3A974713BDAC'
-if (typeof signed_blob === 'string' && signed_blob.match(/^[A-F0-9]+$/)) {
-  const id = RippleAPI.computeBinaryTransactionHash(signed_blob)
-  console.log('Transaction hash:', id')
-}
-```
-
-```
-Transaction hash: 80C5E11E1A21A626759D6CB944B33DBAAC66BD704A289C86E330B847904F5C13
-```
-
-[RunKit Example: computeBinaryTransactionHash](https://runkit.com/intelliot/computebinarytransactionhash-example)
-
-## classicAddressToXAddress
-
-`classicAddressToXAddress(classicAddress: string, tag: number | false[, test: boolean]): string`
-
-Convert a classic address and tag to an X-address.
-
-If `test` is `true`, the address starts with `T` to show that the address is intended for use on a test network.
-
-### Example: Encode an X-address with tag 4294967295
-
-```javascript
-const RippleAPI = require('ripple-lib').RippleAPI
-const xAddress = RippleAPI.classicAddressToXAddress('rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf', 4294967295)
-console.log(xAddress)
-```
-
-```
-XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi
-```
-
-### Example: Encode a test address for use with Testnet or Devnet
-
-```javascript
-const RippleAPI = require('ripple-lib').RippleAPI
-const address = RippleAPI.classicAddressToXAddress('r3SVzk8ApofDJuVBPKdmbbLjWGCCXpBQ2g', 123, true)
-console.log(address)
-```
-
-```
-T7oKJ3q7s94kDH6tpkBowhetT1JKfcfdSCmAXbS75iATyLD
-```
-
-## xAddressToClassicAddress
-
-`xAddressToClassicAddress(xAddress: string): {classicAddress: string, tag: number | false, test: boolean}`
-
-Convert an X-address to a classic address and tag.
-
-Since `0` is a valid tag, use `if (tag !== false)` to you want to check for a tag.
-
-If the address is intended for use on a test network, `test === true`. Otherwise, `test === false`.
-
-### Example
-
-```javascript
-const RippleAPI = require('ripple-lib').RippleAPI
-const address = RippleAPI.xAddressToClassicAddress('XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi')
-console.log(address)
-```
-
-```
-{
-  classicAddress: 'rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf',
-  tag: 4294967295,
-  test: false
-}
-```

docs/src/submit.md.ejs

@@ -1,83 +1,25 @@
 ## submit
 
-`request('submit', {tx_blob: string, fail_hard: boolean}): Promise<object>`
+`submit(signedTransaction: string): Promise<Object>`
 
-The `submit` method applies a transaction and sends it to the network to be confirmed and included in future ledgers.
-
-This method takes a signed, serialized transaction as a binary blob, and submits it to the network as-is. Since signed transaction objects are immutable, no part of the transaction can be modified or automatically filled in after submission.
-
-To send a transaction as robustly as possible, you should construct and sign it in advance, persist it somewhere that you can access even after a power outage, then `submit` it as a `tx_blob`. After submission, monitor the network with the `tx` method to see if the transaction was successfully applied; if a restart or other problem occurs, you can safely re-submit the `tx_blob` transaction: it won't be applied twice since it has the same sequence number as the old transaction.
+Submits a signed transaction. The transaction is not guaranteed to succeed; it must be verified with [getTransaction](#gettransaction).
 
 ### Parameters
 
-| `Field`     | Type    | Description                                          |
-|:------------|:--------|:-----------------------------------------------------|
-| `tx_blob`   | String  | Hex representation of the signed transaction to submit. This can be a multi-signed transaction. |
-| `fail_hard` | Boolean | (Optional, defaults to false) If true, and the transaction fails locally, do not retry or relay the transaction to other servers |
+<%- renderSchema('input/submit.json') %>
 
 ### Return Value
 
-When successful, this method returns an object containing the following fields:
+This method returns an object with the following structure:
 
-| `Field`                 | Type    | Description                              |
-|:------------------------|:--------|:-----------------------------------------|
-| `engine_result`         | String  | Text [result code](https://xrpl.org/transaction-results.html) indicating the preliminary result of the transaction, for example `tesSUCCESS` |
-| `engine_result_code`    | Integer | Numeric version of the [result code](https://xrpl.org/transaction-results.html). **Not recommended.** |
-| `engine_result_message` | String  | Human-readable explanation of the transaction's preliminary result |
-| `tx_blob`               | String  | The complete transaction in hex string format |
-| `tx_json`               | Object  | The complete transaction in JSON format  |
-| `accepted`              | Boolean | The value `true` indicates that the transaction was applied, queued, broadcast, or kept for later. The value `false` indicates that none of those happened, so the transaction cannot possibly succeed as long as you do not submit it again and have not already submitted it another time. [New in: rippled 1.5.0] |
-| `account_sequence_available` | Number | The next [Sequence Number](https://xrpl.org/basic-data-types.html#account-sequence) available for the sending account after all pending and [queued](https://xrpl.org/transaction-queue.html) transactions. [New in: rippled 1.5.0] |
-| `account_sequence_next` | number  | The next [Sequence Number](https://xrpl.org/basic-data-types.html#account-sequence) for the sending account after all transactions that have been provisionally applied, but not transactions in the [queue](https://xrpl.org/transaction-queue.html). [New in: rippled 1.5.0] |
-| `applied`               | Boolean | The value `true` indicates that this transaction was applied to the open ledger. In this case, the transaction is likely, but not guaranteed, to be validated in the next ledger version. [New in: rippled 1.5.0] |
-| `broadcast`             | Boolean | The value `true` indicates this transaction was broadcast to peer servers in the peer-to-peer XRP Ledger network. (Note: if the server has no peers, such as in [stand-alone mode](https://xrpl.org/rippled-server-modes.html#reasons-to-run-a-rippled-server-in-stand-alone-mode), the server uses the value `true` for cases where it _would_ have broadcast the transaction.) The value `false` indicates the transaction was not broadcast to any other servers. [New in: rippled 1.5.0] |
-| `kept`                  | Boolean | The value `true` indicates that the transaction was kept to be retried later. [New in: rippled 1.5.0] |
-| `queued`                | Boolean | The value `true` indicates the transaction was put in the [Transaction Queue](https://xrpl.org/transaction-queue.html), which means it is likely to be included in a future ledger version. [New in: rippled 1.5.0] |
-| `open_ledger_cost`      | String  | The current [open ledger cost](https://xrpl.org/transaction-cost.html#open-ledger-cost) before processing this transaction. Transactions with a lower cost are likely to be [queued](https://xrpl.org/transaction-queue.html). [New in: rippled 1.5.0] |
-| `validated_ledger_index` | Integer  | The [ledger index](https://xrpl.org/basic-data-types.html#ledger-index) of the newest validated ledger at the time of submission. This provides a lower bound on the ledger versions that the transaction can appear in as a result of this request. (The transaction could only have been validated in this ledger version or earlier if it had already been submitted before.) |
-
-Note: Many situations can prevent a transaction from processing successfully, such as a lack of trust lines connecting the two accounts in a payment, or changes in the state of the ledger since the time the transaction was constructed. Even if nothing is wrong, it may take several seconds to close and validate the ledger version that includes the transaction. Do not consider the transaction's results final until they appear in a validated ledger version.
+<%- renderSchema('output/submit.json') %>
 
 ### Example
 
 ```javascript
-const signedTransaction = '12000022800000002400000007201B007008BC61400000000754D4C068400000000000000C732103E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F824832874473045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22811492F80A3F3849DBB5714A4F2C691CE7D47BEED58083141266204CFBC657E65D9B4D30301FF98644693935';
-const failHard = false;
-const result = await api.request('submit', {
-  tx_blob: signedTransaction,
-  fail_hard: failHard // optional
-});
+const signedTransaction = '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100BDE09A1F6670403F341C21A77CF35BA47E45CDE974096E1AA5FC39811D8269E702203D60291B9A27F1DCABA9CF5DED307B4F23223E0B6F156991DB601DFB9C41CE1C770A726970706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304';
+return api.submit(signedTransaction)
+  .then(result => {/* ... */});
 ```
 
-```json
-{
-  "accepted": true,
-  "account_sequence_available": 8,
-  "account_sequence_next": 8,
-  "applied": true,
-  "broadcast": true,
-  "engine_result": "tesSUCCESS",
-  "engine_result_code": 0,
-  "engine_result_message": "The transaction was applied. Only final in a validated ledger.",
-  "kept": true,
-  "open_ledger_cost": "10",
-  "queued": false,
-  "tx_blob": "12000022800000002400000007201B007008BC61400000000754D4C068400000000000000C732103E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F824832874473045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22811492F80A3F3849DBB5714A4F2C691CE7D47BEED58083141266204CFBC657E65D9B4D30301FF98644693935",
-  "tx_json": {
-      "Account": "rNQao3Z1irwRjKWSs8heL4a8WKLPKfLrXs",
-      "Amount": "123000000",
-      "Destination": "rpgHWJdXkSvvzikdJCpuMzU7zWnuqsJRCZ",
-      "Fee": "12",
-      "Flags": 2147483648,
-      "LastLedgerSequence": 7342268,
-      "Sequence": 7,
-      "SigningPubKey": "03E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F8248328",
-      "TransactionType": "Payment",
-      "TxnSignature": "3045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22",
-      "hash": "FE8D68D7FF5805EB07AF15A1ADF07FB5463CCD2C6C0A15981EB3D26A02E1551C"
-  },
-  "validated_ledger_index": 7341775
-}
-```
-
-(In ripple-lib 1.8.0, [the old `submit` method](https://github.com/ripple/ripple-lib/blob/1.7.0/docs/index.md#submit) was deprecated.)
+<%- renderFixture('responses/submit.json') %>

docs/src/transactions.md.ejs

@@ -6,21 +6,16 @@ A transaction type is specified by the strings in the first column in the table
 
 Type | Description
 ---- | -----------
-[payment](#payment) | A `payment` transaction represents a transfer of value from one account to another. Depending on the [path](https://xrpl.org/paths.html) taken, additional exchanges of value may occur atomically to enable the payment.
-[order](#order) | An `order` transaction creates a limit order. It defines an intent to exchange currencies, and creates an order in the XRP 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 XRP Ledger's order book.
-[trustline](#trustline) | A `trustline` transaction creates or modifies a trust line between two accounts.
-[settings](#settings) | A `settings` transaction modifies the settings of an account in the XRP Ledger.
-[escrowCreation](#escrow-creation) | An `escrowCreation` transaction creates an escrow on the ledger, which locks XRP until a cryptographic condition is met or it expires. It is like an escrow service where the XRP Ledger acts as the escrow agent.
-[escrowCancellation](#escrow-cancellation) | An `escrowCancellation` transaction unlocks the funds in an escrow and sends them back to the creator of the escrow, if the escrow has expired.
-[escrowExecution](#escrow-execution) | An `escrowExecution` transaction unlocks the funds in an escrow and sends them to the destination of the escrow, if the conditions for the escrow are met.
-[checkCreate](#check-create) | A `checkCreate` transaction creates a check on the ledger, which is a deferred payment that can be cashed by its intended destination.
-[checkCancel](#check-cancel) | A `checkCancel` transaction cancels an unredeemed Check, removing it from the ledger without sending any money.
-[checkCash](#check-cash) | A `checkCash` transaction redeems a Check to receive up to the amount authorized by the corresponding `checkCreate` transaction. Only the `destination` address of a Check can cash it.
-[paymentChannelCreate](#payment-channel-create) | A `paymentChannelCreate` transaction opens a payment channel between two addresses with XRP set aside for asynchronous payments.
-[paymentChannelFund](#payment-channel-fund) | A `paymentChannelFund` transaction adds XRP to a payment channel and optionally sets a new expiration for the channel.
-[paymentChannelClaim](#payment-channel-claim) | A `paymentChannelClaim` transaction withdraws XRP from a channel and optionally requests to close it.
-[ticketCreate](#ticket-create) | A successful `ticketCreate` transaction adds a Ticket in the directory of the owning account.
+[payment](#payment) | A `payment` transaction represents a transfer of value from one account to another. Depending on the [path](https://ripple.com/build/paths/) taken, additional exchanges of value may occur atomically to facilitate the payment.
+[order](#order) | An `order` transaction creates a limit order. It defines an intent to exchange currencies, and creates an order in the Ripple Consensus Ledger's order book if not completely fulfilled when placed. Orders can be partially fulfilled.
+[orderCancellation](#order-cancellation) | An `orderCancellation` transaction cancels an order in the Ripple Consensus Ledger's order book.
+[trustline](#trustline) | A `trustline` transactions creates or modifies a trust line between two accounts.
+[settings](#settings) | A `settings` transaction modifies the settings of an account in the Ripple Consensus Ledger.
+[suspendedPaymentCreation](#suspended-payment-creation) | A `suspendedPaymentCreation` transaction creates a suspended payment on the ledger, which locks XRP until a cryptographic condition is met or it expires. It is like an escrow service where the Ripple network acts as the escrow agent.
+[suspendedPaymentCancellation](#suspended-payment-cancellation) | A `suspendedPaymentCancellation` transaction unlocks the funds in a suspended payment and sends them back to the creator of the suspended payment, but it will only work after the suspended payment expires.
+[suspendedPaymentExecution](#suspended-payment-execution) | A `suspendedPaymentExecution` transaction unlocks the funds in a suspended payment and sends them to the destination of the suspended payment, but it will only work if the cryptographic condition is provided.
+
+The three "suspended payment" transaction types are not supported by the production Ripple peer-to-peer network at this time. They are available for testing purposes if you [configure RippleAPI](#boilerplate) to connect to the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) instead.
 
 ## Transaction Flow
 
@@ -32,32 +27,26 @@ Executing a transaction with `RippleAPI` requires the following four steps:
     * [prepareOrder](#prepareorder)
     * [prepareOrderCancellation](#prepareordercancellation)
     * [prepareSettings](#preparesettings)
-    * [prepareEscrowCreation](#prepareescrowcreation)
-    * [prepareEscrowCancellation](#prepareescrowcancellation)
-    * [prepareEscrowExecution](#prepareescrowexecution)
-    * [prepareCheckCreate](#preparecheckcreate)
-    * [prepareCheckCancel](#preparecheckcancel)
-    * [prepareCheckCash](#preparecheckcash)
-    * [prepareTicketCreate](#prepareticketcreate)
+    * [prepareSuspendedPaymentCreation](#preparesuspendedpaymentcreation)
+    * [prepareSuspendedPaymentCancellation](#preparesuspendedpaymentcancellation)
+    * [prepareSuspendedPaymentExecution](#preparesuspendedpaymentexecution)
 2. [Sign](#sign) - Cryptographically sign the transaction locally and save the [transaction ID](#transaction-id). Signing is how the owner of an account authorizes a transaction to take place. For multisignature transactions, the `signedTransaction` fields returned by `sign` must be collected and passed to the [combine](#combine) method.
 3. [Submit](#submit) - Submit the transaction to the connected server.
 4. Verify - Verify that the transaction got validated by querying with [getTransaction](#gettransaction). This is necessary because transactions may fail even if they were successfully submitted.
 
 ## Transaction Fees
 
-Every transaction must destroy a small amount of XRP as a cost to apply the transaction to the ledger. This is also called a *transaction fee*. The transaction cost is designed to increase along with the load on the XRP Ledger, making it very expensive to deliberately or inadvertently overload the peer-to-peer network that powers the XRP Ledger.
+Every transaction must destroy a small amount of XRP as a cost to send the transaction. This is also called a *transaction fee*. The transaction cost is designed to increase along with the load on the Ripple network, making it very expensive to deliberately or inadvertently overload the network.
 
 You can choose the size of the fee you want to pay or let a default be used. You can get an estimate of the fee required to be included in the next ledger closing with the [getFee](#getfee) method.
 
-For a multi-signed transaction, ripple-lib automatically multiplies the `fee` by (1 + Number of Signatures Provided). For example, if you set `instructions.fee = '0.000020'` and `instructions.signersCount = 2`, the prepared transaction's `Fee` is 20 drops × (1 + 2 Signatures) = 60 drops. See [Transaction Cost](https://xrpl.org/transaction-cost.html).
-
 ## Transaction Instructions
 
 Transaction instructions indicate how to execute a transaction, complementary with the [transaction specification](#transaction-specifications).
 
 <%- renderSchema("objects/instructions.json") %>
 
-We recommend that you specify a `maxLedgerVersion` so that you can quickly determine that a failed transaction can never succeed in the future. It is impossible for a transaction to succeed after the XRP Ledger's consensus-validated ledger version exceeds the transaction's `maxLedgerVersion`. If you omit `maxLedgerVersion`, the "prepare\*" method automatically supplies a `maxLedgerVersion` equal to the current ledger plus 3, which it includes in the return value from the "prepare\*" method.
+We recommended that you specify a `maxLedgerVersion` so that you can quickly determine that a failed transaction will never succeeed in the future. It is impossible for a transaction to succeed after the network ledger version exceeds the transaction's `maxLedgerVersion`. If you omit `maxLedgerVersion`, the "prepare*" method automatically supplies a `maxLedgerVersion` equal to the current ledger plus 3, which it includes in the return value from the "prepare*" method.
 
 ## Transaction ID
 

docs/src/txFlags.md.ejs

@@ -1,81 +0,0 @@
-## txFlags
-
-`txFlags.TRANSACTION_TYPE.FLAG`
-
-This object provides constants for use when creating or interpreting transaction flags. Most transactions have a set of bit-flags that represent various options that affect how a transaction should behave. These options are represented as binary values that can be combined with bitwise-or operations to encode multiple flags at once.
-
-Most flags only have meaning for a specific transaction type. The same bitwise value may be reused for flags on different transaction types, so it is important to pay attention to the transaction type when setting and reading flags.
-
-Bits that are not defined as flags MUST be 0.
-
-### Global Flag
-
-Applies globally to all transactions.
-
-`txFlags.Universal.FullyCanonicalSig`: Require a fully-canonical signature. When preparing transactions, ripple-lib enables this flag for you.
-
-### Payment Flags
-
-`txFlags.Payment.NoRippleDirect`: Do not use the default path; only use specified paths. This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this.
-
-`txFlags.Payment.PartialPayment`: If the specified destination amount cannot be sent without spending more than the source maxAmount, reduce the received amount instead of failing outright. See [Partial Payments](https://xrpl.org/partial-payments.html) for more details.
-
-`txFlags.Payment.LimitQuality`: Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of `destination.amount`:`source.maxAmount`. See [Limit Quality](https://xrpl.org/payment.html#limit-quality) for details.
-
-### OfferCreate Flags
-
-`txFlags.OfferCreate.Passive`: If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the ledger. It still consumes offers that cross it.
-
-`txFlags.OfferCreate.ImmediateOrCancel`: Treat the offer as an Immediate or Cancel order. If enabled, the offer never becomes a ledger object: it only tries to match existing offers in the ledger.
-
-`txFlags.OfferCreate.FillOrKill`: Treat the offer as a Fill or Kill order.
-
-`txFlags.OfferCreate.Sell`: Treat the offer as a Sell order. With `order.direction = 'sell'`, exchange the entire `order.quantity`, even if it means obtaining more than the `order.totalPrice` amount in exchange. If using `prepareOrder`, ripple-lib sets this flag for you.
-
-### TrustSet Flags
-
-`txFlags.TrustSet.SetAuth`: Authorize the other party to hold issuances from this account. (No effect unless using the AccountSet.RequireAuth flag.) Cannot be unset.
-
-`txFlags.TrustSet.NoRipple`:  Obsolete.
-
-`txFlags.TrustSet.SetNoRipple`: Blocks [rippling](https://xrpl.org/rippling.html) between two trustlines of the same currency, if this flag is set on both.
-
-`txFlags.TrustSet.ClearNoRipple`: Clears the No-[Rippling](https://xrpl.org/rippling.html) flag.
-
-`txFlags.TrustSet.SetFreeze`: Freeze the trustline. A non-XRP currency can be frozen by the exchange or gateway that issued it. XRP cannot be frozen.
-
-`txFlags.TrustSet.ClearFreeze`: Unfreeze the trustline.
-
-### AccountSet Flags
-
-You can use the `prepareSettings` method to change your account flags. This method uses AccountSet flags internally.
-
-In the rippled API, Account Flags can be enabled and disabled with the SetFlag and ClearFlag parameters. See [AccountSet Flags](https://xrpl.org/accountset.html#accountset-flags).
-
-The AccountSet transaction type has some transaction flags, but their use is discouraged.
-
-* `txFlags.AccountSet.RequireDestTag`
-* `txFlags.AccountSet.OptionalDestTag`
-* `txFlags.AccountSet.RequireAuth`
-* `txFlags.AccountSet.OptionalAuth`
-* `txFlags.AccountSet.DisallowXRP`
-* `txFlags.AccountSet.AllowXRP`
-
-### PaymentChannelClaim Flags
-
-`txFlags.PaymentChannelClaim.Renew`: Clear the channel's Expiration time. (Expiration is different from the channel's immutable CancelAfter time.) Only the source address of the payment channel can use this flag.
-
-`txFlags.PaymentChannelClaim.Close`: Request to close the channel. Only the channel source and destination addresses can use this flag. This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if the destination address uses it. If the source address uses this flag when the channel still holds XRP, this schedules the channel to close after SettleDelay seconds have passed. (Specifically, this sets the Expiration of the channel to the close time of the previous ledger plus the channel's SettleDelay time, unless the channel already has an earlier Expiration time.) If the destination address uses this flag when the channel still holds XRP, any XRP that remains after processing the claim is returned to the source address.
-
-### Other Transaction Types
-
-The remaining transaction types do not have any flags at this time.
-
-* OfferCancel
-* SetRegularKey
-* SignerListSet
-* EscrowCreate
-* EscrowFinish
-* EscrowCancel
-* PaymentChannelCreate
-* PaymentChannelFund

docs/src/verifyPaymentChannelClaim.md.ejs

@@ -1,31 +0,0 @@
-## verifyPaymentChannelClaim
-
-`verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean`
-
-Verify a payment channel claim signature.
-
-### Parameters
-
-<%- renderSchema("input/verify-payment-channel-claim.json") %>
-
-### Return Value
-
-This method returns `true` if the claim signature is valid.
-
-<%- renderSchema("output/verify-payment-channel-claim.json") %>
-
-### Example
-
-```javascript
-const channel =
-  '3E18C05AD40319B809520F1A136370C4075321B285217323396D6FD9EE1E9037';
-const amount = '.00001';
-const signature = <%- importFile("test/fixtures/responses/sign-payment-channel-claim.json") %>;
-const publicKey =
-  '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8';
-return api.verifyPaymentChannelClaim(channel, amount, signature, publicKey);
-```
-
-```json
-true
-```

docs/src/xrpToDropsAndDropsToXrp.md.ejs

@@ -1,47 +0,0 @@
-## xrpToDrops
-
-`xrpToDrops(xrp: string | BigNumber): string`
-
-Converts an XRP amount to drops. 1 XRP = 1,000,000 drops, so 1 drop = 0.000001 XRP. This method is useful when converting amounts for use with the rippled API, which requires XRP amounts to be specified in drops.
-
-### Parameters
-
-`xrp`: A string or BigNumber representing an amount of XRP. If `xrp` is a string, it may start with `-`, must contain at least one number, and may contain up to one `.`. This method throws a `ValidationError` for invalid input.
-
-### Return Value
-
-A string representing an equivalent amount of drops.
-
-### Example
-
-```javascript
-return api.xrpToDrops('1');
-```
-
-```json
-'1000000'
-```
-
-## dropsToXrp
-
-`dropsToXrp(drops: string | BigNumber): string`
-
-Converts an amount of drops to XRP. 1 drop = 0.000001 XRP, so 1 XRP = 1,000,000 drops. This method is useful when converting amounts from the rippled API, which describes XRP amounts in drops.
-
-### Parameters
-
-`drops`: A string or BigNumber representing an amount of drops. If `drops` is a string, it may start with `-` and must contain at least one number. This method throws a `ValidationError` for invalid input.
-
-### Return Value
-
-A string representing an equivalent amount of XRP.
-
-### Example
-
-```javascript
-return api.dropsToXrp('1');
-```
-
-```json
-'0.000001'
-```

package.json

@@ -1,100 +1,90 @@
 {
   "name": "ripple-lib",
-  "version": "1.10.1",
+  "version": "0.17.3",
   "license": "ISC",
-  "description": "Deprecated - consider migrating to xrpl.js: https://xrpl.org/xrpljs2-migration-guide.html",
+  "description": "A JavaScript API for interacting with Ripple in Node.js and the browser",
   "files": [
     "dist/npm/*",
-    "build/ripple-latest-min.js",
-    "build/ripple-latest.js"
+    "bin/*",
+    "build/*",
+    "test/*",
+    "Gulpfile.js"
   ],
   "main": "dist/npm/",
-  "unpkg": "build/ripple-latest-min.js",
-  "jsdelivr": "build/ripple-latest-min.js",
-  "types": "dist/npm/index.d.ts",
-  "browser": {
-    "ws": "./dist/npm/common/wswrapper.js",
-    "https-proxy-agent": false
-  },
   "directories": {
     "test": "test"
   },
   "dependencies": {
-    "@types/lodash": "^4.14.136",
-    "@types/ws": "^7.2.0",
-    "bignumber.js": "^9.0.0",
-    "https-proxy-agent": "^5.0.0",
-    "jsonschema": "1.2.2",
-    "lodash": "^4.17.4",
-    "ripple-address-codec": "^4.1.1",
-    "ripple-binary-codec": "^1.1.3",
-    "ripple-keypairs": "^1.0.3",
-    "ripple-lib-transactionparser": "0.8.2",
-    "ws": "^7.2.0"
-  },
-  "resolutions": {
-    "elliptic": "^6.5.4"
+    "ajv": "^4.0.5",
+    "ajv-i18n": "^1.2.0",
+    "babel-polyfill": "^6.3.14",
+    "babel-runtime": "^6.3.19",
+    "bignumber.js": "^2.0.3",
+    "https-proxy-agent": "^1.0.0",
+    "jayson": "^1.2.2",
+    "lodash": "^3.1.0",
+    "ripple-address-codec": "^2.0.1",
+    "ripple-binary-codec": "^0.1.4",
+    "ripple-hashes": "^0.1.0",
+    "ripple-keypairs": "^0.10.0",
+    "ripple-lib-transactionparser": "^0.6.0",
+    "ws": "^1.0.1"
   },
   "devDependencies": {
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.4.3",
-    "@typescript-eslint/eslint-plugin": "^2.3.3",
-    "@typescript-eslint/parser": "^2.27.0",
-    "assert": "^2.0.0",
-    "assert-diff": "^3.0.0",
-    "buffer": "^6.0.2",
-    "crypto-browserify": "^3.12.0",
-    "doctoc": "^2.0.0",
-    "ejs": "^3.0.1",
-    "eslint": "^6.5.1",
-    "eventemitter2": "^6.0.0",
-    "https-browserify": "^1.0.0",
+    "assert-diff": "^1.0.1",
+    "babel-cli": "^6.4.0",
+    "babel-core": "^6.4.0",
+    "babel-eslint": "^6.0.4",
+    "babel-loader": "^6.2.1",
+    "babel-plugin-syntax-flow": "^6.3.13",
+    "babel-plugin-transform-flow-strip-types": "^6.4.0",
+    "babel-preset-es2015": "^6.3.13",
+    "babel-preset-stage-1": "^6.3.13",
+    "babel-register": "^6.3.13",
+    "coveralls": "^2.11.9",
+    "doctoc": "^0.15.0",
+    "ejs": "^2.3.4",
+    "eslint": "^2.9.0",
+    "eventemitter2": "^0.4.14",
+    "flow-bin": "^0.30.0",
+    "gulp": "^3.8.10",
+    "gulp-bump": "^0.1.13",
+    "gulp-rename": "^1.2.0",
+    "gulp-uglify": "^1.1.0",
+    "http-server": "^0.8.5",
+    "istanbul": "^1.1.0-alpha.1",
+    "json-loader": "^0.5.2",
     "json-schema-to-markdown-table": "^0.4.0",
-    "mocha": "^9",
-    "nyc": "^15",
-    "path-browserify": "1.0.1",
-    "prettier": "^2.0.5",
-    "process": "^0.11.10",
-    "puppeteer": "10.2.0",
-    "stream-browserify": "^3.0.0",
-    "stream-http": "3.2.0",
-    "ts-loader": "^9.2.5",
-    "ts-node": "^10.1.0",
-    "typescript": "^3.9.9",
-    "url": "^0.11.0",
-    "webpack": "^5.6.0",
-    "webpack-bundle-analyzer": "^4.1.0",
-    "webpack-cli": "^4.2.0"
+    "mocha": "^2.1.0",
+    "mocha-in-sauce": "^0.0.1",
+    "mocha-junit-reporter": "^1.9.1",
+    "null-loader": "^0.1.1",
+    "webpack": "^1.5.3",
+    "yargs": "^1.3.1"
   },
   "scripts": {
-    "build:schemas": "mkdir -p dist/npm/common && cp -r src/common/schemas dist/npm/common/",
-    "build:lib": "tsc --build",
-    "build:web": "webpack",
-    "build": "yarn build:schemas && yarn build:lib && yarn build:web",
-    "analyze": "yarn build:web --analyze",
-    "watch": "yarn build:lib --watch",
-    "clean": "rm -rf dist/npm",
+    "build": "gulp",
     "doctoc": "doctoc docs/index.md --title '# RippleAPI Reference' --github --maxlevel 2",
     "docgen": "node --harmony scripts/build_docs.js",
-    "prepublish": "yarn clean && yarn build",
-    "test": "TS_NODE_PROJECT=src/tsconfig.json nyc mocha --config=test/.mocharc.json --exit",
-    "test:integration": "TS_NODE_PROJECT=src/tsconfig.json nyc mocha ./test/integration/*.ts",
-    "test:browser": "TS_NODE_PROJECT=src/tsconfig.json nyc mocha ./test/browser/*.ts",
-    "test:watch": "TS_NODE_PROJECT=src/tsconfig.json mocha --config=test/.mocharc.json --watch --reporter dot",
-    "format": "prettier --write '{src,test}/**/*.ts'",
-    "lint": "eslint 'src/**/*.ts' 'test/*-test.{ts,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": "babel-node ./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_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",
-    "compile:snippets": "tsc -p snippets/tsconfig.json",
-    "start:snippet": "npm run compile:snippets && node ./snippets/dist/start.js",
-    "inspect:snippet": "npm run compile:snippets && node inspect ./snippets/dist/start.js"
+    "start": "babel-node scripts/http.js",
+    "sauce": "babel-node scripts/sauce-runner.js"
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:XRPLF/xrpl.js.git"
+    "url": "git://github.com/ripple/ripple-lib.git"
   },
   "readmeFilename": "README.md",
   "engines": {
-    "node": ">=10.13.0",
-    "yarn": "^1.15.2"
+    "node": ">=0.12.0"
   }
 }

scripts/ci.sh

@@ -7,22 +7,29 @@ function checkEOL {
   ./scripts/checkeol.sh
 }
 
+typecheck() {
+  npm install -g flow-bin
+  flow --version
+  npm run typecheck
+}
+
 lint() {
-  echo "tslint $(node_modules/.bin/tslint --version)"
-  yarn lint
+  echo "eslint $(node_modules/.bin/eslint --version)"
+  npm list 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"
-
-  # TODO: replace/upgrade mocha-junit-reporter
-  #mocha test --reporter mocha-junit-reporter --reporter-options mochaFile=$CIRCLE_TEST_REPORTS/test-results.xml
-
-  yarn test --coverage
-  #yarn run coveralls
+  mocha test --reporter mocha-junit-reporter --reporter-options mochaFile=$CIRCLE_TEST_REPORTS/test-results.xml
+  npm test --coverage
+  npm run coveralls
 
   # test compiled version in "dist/npm"
-  $(npm bin)/babel -D --optional runtime --ignore "**/node_modules/**" -d test-compiled/ test/
+  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
@@ -39,7 +46,7 @@ unittest() {
 
   #echo "Running tests in SauceLabs"
   #http-server &
-  #yarn run sauce
+  #npm run sauce
 
   #pkill -f mocked-server.js
   #pkill -f http-server
@@ -48,6 +55,7 @@ unittest() {
 
 integrationtest() {
   mocha test/integration/integration-test.js
+  mocha test/integration/http-integration-test.js
 
   # run integration tests in PhantomJS
   #gulp build-tests build-min
@@ -57,7 +65,7 @@ integrationtest() {
 
 doctest() {
   mv docs/index.md docs/index.md.save
-  yarn run docgen
+  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
@@ -68,6 +76,7 @@ oneNode() {
   checkEOL
   doctest
   lint
+  typecheck
   unittest
   integrationtest
 }
@@ -75,7 +84,7 @@ oneNode() {
 twoNodes() {
   case "$NODE_INDEX" in
     0) doctest; lint; integrationtest;;
-    1) checkEOL; unittest;;
+    1) checkEOL; typecheck; unittest;;
     *) echo "ERROR: invalid usage"; exit 2;;
   esac
 }
@@ -83,7 +92,7 @@ twoNodes() {
 threeNodes() {
   case "$NODE_INDEX" in
     0) doctest; lint; integrationtest;;
-    1) checkEOL;;
+    1) checkEOL; typecheck;;
     2) unittest;;
     *) echo "ERROR: invalid usage"; exit 2;;
   esac

scripts/http.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const createHTTPServer = require('../src/index').createHTTPServer;
+const port = 5990;
+const serverUrl = 'wss://s1.ripple.com';
+
+
+function main() {
+  const server = createHTTPServer({server: serverUrl}, port);
+  server.start().then(() => {
+    console.log('Server started on port ' + String(port));
+  });
+}
+
+
+main();

scripts/publish

@@ -7,12 +7,12 @@ function exit_on_error {
 
 rm -rf build
 
-yarn install
+npm install
 gulp
-yarn test
+npm test
 exit_on_error
 
 echo ""
 echo "publish to npm"
-yarn publish
+npm publish
 exit_on_error

scripts/publish_rc

@@ -7,12 +7,12 @@ function exit_on_error {
 
 rm -rf build
 
-yarn install
+npm install
 gulp
-yarn test
+npm test
 exit_on_error
 
 echo ""
 echo "publish rc to npm"
-yarn publish --tag beta
+npm publish --tag beta
 exit_on_error

scripts/sauce-runner.js

@@ -0,0 +1,100 @@
+
+const _ = require('lodash');
+const MochaSauce = require('mocha-in-sauce');
+
+const testUrl = 'http://testripple.circleci.com:8080/test/saucerunner.html';
+
+
+function main() {
+  // uncomment for more debug info
+  // process.env.DEBUG = '*';
+
+  // configure
+  const config = {
+    name: 'RippleAPI',
+    host: 'localhost',
+    port: 4445,
+    maxDuration: 180000,
+    // the current build name (optional)
+    build: Date.now(),
+    url: testUrl,
+    runSauceConnect: true
+  };
+
+  if (process.env.CIRCLE_BUILD_NUM) {
+    config.build = process.env.CIRCLE_BUILD_NUM;
+    config.tags = [process.env.CIRCLE_BRANCH, process.env.CIRCLE_SHA1];
+    config.tunnelIdentifier = process.env.CIRCLE_BUILD_NUM;
+  }
+
+  const sauce = new MochaSauce(config);
+
+  sauce.concurrency(5);
+
+  // setup what browsers to test with
+  sauce.browser({browserName: 'firefox', platform: 'Linux',
+   version: '43'});
+  sauce.browser({browserName: 'firefox', platform: 'Windows 8.1',
+    version: '43'});
+  sauce.browser({browserName: 'firefox', platform: 'OS X 10.11',
+   version: '43'});
+  sauce.browser({browserName: 'safari', platform: 'OS X 10.11',
+    version: '9'});
+  sauce.browser({browserName: 'safari', platform: 'OS X 10.10',
+    version: '8'});
+  sauce.browser({browserName: 'safari', platform: 'OS X 10.9',
+    version: '7'});
+  sauce.browser({browserName: 'chrome', platform: 'OS X 10.11',
+    version: '47'});
+  sauce.browser({browserName: 'chrome', platform: 'Linux',
+    version: '47'});
+  sauce.browser({browserName: 'chrome', platform: 'Windows 8.1',
+    version: '47'});
+  sauce.browser({browserName: 'internet explorer', platform: 'Windows 10',
+    version: '11'});
+  sauce.browser({browserName: 'MicrosoftEdge', platform: 'Windows 10',
+    version: '20'});
+
+  sauce.on('init', function(browser) {
+    console.log('  init : %s %s', browser.browserName, browser.platform);
+  });
+
+  sauce.on('start', function(browser) {
+    console.log('  start : %s %s', browser.browserName, browser.platform);
+  });
+
+  sauce.on('end', function(browser, res) {
+    console.log('  end : %s %s : %d failures', browser.browserName,
+      browser.platform, res && res.failures);
+  });
+
+  sauce.on('connected', sauceConnectProcess => {
+    sauceConnectProcess.on('exit', function(code, /* signal */) {
+      if (code > 0) {
+        console.log('something wrong - exiting');
+        process.exit();
+      } else {
+        console.log('normal tunnel exit');
+      }
+    });
+  });
+
+
+  sauce.start(function(err, res) {
+    let failure = false;
+    if (err) {
+      console.log('Error starting Sauce');
+      console.error(err);
+      process.exitCode = 2;
+    } else {
+      console.log('-------------- done --------------');
+      failure = _.some(res, 'failures');
+      console.log('Tests are failed:', failure);
+      if (failure) {
+        process.exitCode = 1;
+      }
+    }
+  });
+}
+
+main();

snippets/src/decoder.ts

@@ -1,9 +0,0 @@
-import * as codec from 'ripple-binary-codec'
-
-const original = codec.decode('12000022800200002400000001201B00EF81E661EC6386F26FC0FFFF0000000000000000000000005553440000000000054F6F784A58F9EFB0A9EB90B83464F9D166461968400000000000000C6940000000000000646AD3504529A0465E2E0000000000000000000000005553440000000000054F6F784A58F9EFB0A9EB90B83464F9D1664619732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D87446304402200A693FB5CA6B21250EBDFD8CFF526EE0DF7C9E4E31EB0660692E75E6A93BF5F802203CC39463DDA21386898CA31E18AD1A6828647D65741DD637BAD71BC83E29DB9481145E7B112523F68D2F5E879DB4EAC51C6698A693048314CA6EDC7A28252DAEA6F2045B24F4D7C333E146170112300000000000000000000000005553440000000000054F6F784A58F9EFB0A9EB90B83464F9D166461900')
-
-const test = codec.decode('12000022800200002400000017201B008694F261EC6386F26FC0FFFF0000000000000000000000005553440000000000054F6F784A58F9EFB0A9EB90B83464F9D166461968400000000000000C6940000000000000646AD3504529A0465E2E0000000000000000000000005553440000000000054F6F784A58F9EFB0A9EB90B83464F9D1664619732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100D8B57E8E06EAE27B1343AF8CAD3F501E18260CCF8BCED08066074106F0F191A3022058FEA6CE9E7FA69D1244C3A70F18983CC2DAF0B10CBB86A6677CF2A5D2B8A68081145E7B112523F68D2F5E879DB4EAC51C6698A693048314CA6EDC7A28252DAEA6F2045B24F4D7C333E146170112300000000000000000000000005553440000000000054F6F784A58F9EFB0A9EB90B83464F9D166461900')
-
-console.log('original:', JSON.stringify(original))
-
-console.log('test:', JSON.stringify(test))