Support Cron Amendment (#32)

Co-authored-by: Chenna Keshava B S <21219765+ckeshava@users.noreply.github.com>
Co-authored-by: Denis Angell <dangell@transia.co>

.ci-config/getNewAmendments.js

@@ -0,0 +1,56 @@
+const xahau = require("xahau");
+const fs = require("fs");
+const path = require("path");
+
+const filePath = path.resolve(__dirname, "./rippled.cfg");
+const existingConfig = fs.readFileSync(filePath, "utf-8");
+
+const networkToEmulate = "wss://s.devnet.rippletest.net:51233/";
+
+const amendmentsToIgnore = [
+  "86E83A7D2ECE3AD5FA87AB2195AE015C950469ABF0B72EAACED318F74886AE90", // CryptoConditionsSuite is obsolete
+];
+
+async function main() {
+  const client = new xahau.Client(networkToEmulate);
+  await client.connect();
+
+  // Looks up what amendments have been enabled via their hash
+  const request = {
+    command: "ledger_entry",
+    index: "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4",
+    ledger_index: "validated",
+  };
+  const response = await client.request(request);
+
+  const amendments = response.result.node.Amendments;
+
+  const newAmendments = [];
+  amendments.forEach((amendment) => {
+    if (
+      !existingConfig.includes(amendment) &&
+      !amendmentsToIgnore.includes(amendment)
+    ) {
+      newAmendments.push(amendment);
+    }
+  });
+
+  if (newAmendments.length > 0) {
+    console.log(
+      "New Amendment Hashes - Look up their names on https://xrpl.org/known-amendments.html"
+    );
+    newAmendments.forEach((amendment) => {
+      console.log(amendment);
+    });
+  } else {
+    console.log(
+      `No new amendments to add!
+Looking at network: ${networkToEmulate}.
+Path to config: ${filePath}`
+    );
+  }
+
+  await client.disconnect();
+}
+
+main().catch((error) => console.log(error));

.ci-config/xahaud.cfg

@@ -0,0 +1,169 @@
+[server]
+port_rpc_admin_local
+port_ws_public
+port_ws_admin_local
+
+# port_peer
+# port_ws_admin_local
+# ssl_key = /etc/ssl/private/server.key
+# ssl_cert = /etc/ssl/certs/server.crt
+
+# IPs must be 0.0.0.0 instead of 127.0.0.1 to be accessed outside the docker container
+
+[port_rpc_admin_local]
+port = 5005
+ip = 0.0.0.0
+admin = 0.0.0.0
+protocol = http
+
+[port_ws_public]
+port = 80
+ip = 0.0.0.0
+protocol = ws
+
+# [port_peer]
+# port = 51235
+# ip = 0.0.0.0
+# protocol = peer
+
+[port_ws_admin_local]
+port = 6006
+ip = 0.0.0.0
+admin = 0.0.0.0
+protocol = ws
+
+[node_size]
+small
+
+# tiny
+# small
+# medium
+# large
+# huge
+
+[node_db]
+type=NuDB
+path=/var/lib/rippled/db/nudb
+advisory_delete=0
+
+# How many ledgers do we want to keep (history)?
+# Integer value that defines the number of ledgers
+# between online deletion events
+online_delete=256
+
+[ledger_history]
+# How many ledgers do we want to keep (history)?
+# Integer value (ledger count)
+# or (if you have lots of TB SSD storage): 'full'
+256
+
+[database_path]
+/var/lib/rippled/db
+
+[debug_logfile]
+/var/log/rippled/debug.log
+
+
+[ips]
+r.ripple.com 51235
+
+# [validators_file]
+# validators.txt
+
+[rpc_startup]
+{ "command": "log_level", "severity": "info" }
+
+# severity (order: lots of information .. only errors)
+# debug
+# info
+# warn
+# error
+# fatal
+
+[ssl_verify]
+1
+
+# The [features] stanza does not currently work for standalone mode: https://github.com/XRPLF/xrpl-dev-portal/issues/1762#issuecomment-1441252450
+
+
+# In order to enable an amendment which by default would vote "No", you must include its amendment id and name here.
+# To add amendments specifically from the latest releases of rippled:
+# 1. Go to https://xrpl.org/known-amendments.html
+# 2. Find the first amendment in the latest releases of rippled which are not already in the list below
+# 3. Click on each amendment to get their Amendment ID and name to add to this list manually.
+#    You will likely update the list with all amendments from a new release of rippled all at once.
+
+# To get the list of amendments on a network (e.g. devnet) follow the steps in xahau.js's CONTRIBUTING.md for "Updating the Docker container".
+# https://github.com/Xahau/xahau.js/blob/main/CONTRIBUTING.md
+# (Running the script `getNewAmendments.js` should help you identify any new amendments that should be added.)
+#
+# Note: The version of rippled you use this config with must have an implementation for the amendments you attempt to enable or it will crash.
+# If you need the version of rippled to be more up to date, you may need to make a comment on this repo: https://github.com/WietseWind/docker-rippled
+
+[features]
+# Amendments
+NegativeUNL
+fixRemoveNFTokenAutoTrustLine
+NonFungibleTokensV1
+CheckCashMakesTrustLine
+fixRmSmallIncreasedQOffers
+fixSTAmountCanonicalize
+FlowSortStrands
+TicketBatch
+fixQualityUpperBound
+FlowCross
+HardenedValidations
+DepositPreauth
+MultiSignReserve
+fix1623
+fix1513
+RequireFullyCanonicalSig
+fix1543
+fix1781
+fixCheckThreading
+fix1515
+CryptoConditionsSuite
+fixPayChanRecipientOwnerDir
+fix1578
+fix1571
+fixAmendmentMajorityCalc
+fixTakerDryOfferRemoval
+fixMasterKeyAsRegularKey
+Flow
+DeletableAccounts
+DepositAuth
+Checks
+NonFungibleTokensV1_1
+DisallowIncoming
+fixNonFungibleTokensV1_2
+fixUniversalNumber
+ImmediateOfferKilled
+XRPFees
+ExpandedSignerList
+fixNFTokenRemint
+# Additional Amendments
+BalanceRewards
+Hooks
+HooksUpdate1
+Import
+Remit
+URIToken
+XahauGenesis
+ZeroB2M
+fix240819
+fix240911
+fixFloatDivide
+fixNFTokenDirV1
+fixNFTokenNegOffer
+fixNSDelete
+fixPageCap
+fixReduceImport
+fixXahauV1
+fixXahauV2
+fixXahauV3
+PaychanAndEscrowForTokens
+DeepFreeze
+Clawback
+
+[network_id]
+21337

.coderabbit.yaml

@@ -0,0 +1,28 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+language: "en-US"
+reviews:
+  # Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky.
+  profile: "chill"
+  # Approve the review once CodeRabbit's comments are resolved. Note: In GitLab, all discussions must be resolved.
+  request_changes_workflow: false
+  # Generate a high level summary of the changes in the PR/MR description.
+  high_level_summary: false
+  # Generate a poem in the walkthrough comment.
+  poem: true
+  # Post review details on each review. Additionally, post a review status when a review is skipped in certain cases.
+  review_status: true
+  # Generate walkthrough in a markdown collapsible section.
+  collapse_walkthrough: false
+  # Abort the in-progress review if the pull request is closed or merged.
+  abort_on_close: true
+  auto_review:
+    # Automatic Review | Automatic code review
+    enabled: true
+    # Review draft PRs/MRs.
+    drafts: false
+    # Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive).
+    ignore_title_keywords:
+      - build(
+chat:
+  # Enable the bot to reply automatically without requiring the user to tag it.
+  auto_reply: true

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "15:00"
+  open-pull-requests-limit: 10

.github/pull_request_template.md

@@ -0,0 +1,48 @@
+## 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
+
+### Did you update HISTORY.md?
+
+- [ ] Yes
+- [ ] No, this change does not impact library users
+
+## 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

@@ -0,0 +1,65 @@
+# 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:
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  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@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        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@v2
+
+      # ℹ️ 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@v2

.github/workflows/nodejs.yml

@@ -0,0 +1,200 @@
+# 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
+
+env:
+  XAHAUD_DOCKER_IMAGE: xahauci/xahaud:2025.2.6
+
+on:
+  push:
+    branches: [main-xahau, 1.x]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build-and-lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup npm version 9
+        run: |
+          npm i -g npm@9 --registry=https://registry.npmjs.org
+
+      - name: Cache node modules
+        id: cache-nodemodules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          # caching node_modules
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ matrix.node-version }}-
+            ${{ runner.os }}-deps-
+
+      - name: Install Dependencies
+        if: steps.cache-nodemodules.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - run: npm run build
+      - run: npm run lint
+
+  unit:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup npm version 9
+        run: |
+          npm i -g npm@9 --registry=https://registry.npmjs.org
+
+      - name: Cache node modules
+        id: cache-nodemodules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          # caching node_modules
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ matrix.node-version }}-
+            ${{ runner.os }}-deps-
+
+      - name: Install Dependencies
+        if: steps.cache-nodemodules.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - run: npm run build
+      - run: npm test
+
+  integration:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run docker in background
+        run: |
+          docker run --detach --rm --name xahaud-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/opt/xahau/etc/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true ${{ env.XAHAUD_DOCKER_IMAGE }} /opt/xahau/bin/xahaud -a --conf /opt/xahau/etc/xahaud.cfg
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup npm version 9
+        run: |
+          npm i -g npm@9 --registry=https://registry.npmjs.org
+
+      - name: Cache node modules
+        id: cache-nodemodules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          # caching node_modules
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ matrix.node-version }}-
+            ${{ runner.os }}-deps-
+
+      - name: Install Dependencies
+        if: steps.cache-nodemodules.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - run: npm run build
+
+      - name: Run integration test
+        run: npm run test:integration
+
+      - name: Stop docker container
+        if: always()
+        run: docker stop xahaud-service
+
+  browser:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Run docker in background
+        run: |
+          docker run --detach --rm --name xahaud-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/opt/xahau/etc/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true ${{ env.XAHAUD_DOCKER_IMAGE }} /opt/xahau/bin/xahaud -a --conf /opt/xahau/etc/xahaud.cfg
+
+      - name: Setup npm version 9
+        run: |
+          npm i -g npm@9 --registry=https://registry.npmjs.org
+
+      - name: Cache node modules
+        id: cache-nodemodules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          # caching node_modules
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ matrix.node-version }}-
+            ${{ runner.os }}-deps-
+
+      - name: Install Dependencies
+        if: steps.cache-nodemodules.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - run: npm run build
+
+      - name: Run integration test
+        run: npm run test:browser
+
+      - name: Stop docker container
+        if: always()
+        run: docker stop xahaud-service

.gitignore

@@ -1,5 +1,9 @@
 # .gitignore
 
+# Ignore package locks other than npm.
+yarn.lock
+npm-shrinkwrap.json
+
 # Ignore vim swap files.
 *.swp
 
@@ -18,6 +22,7 @@
 # Ignore object files.
 *.o
 build/
+coverage/
 tags
 bin/rippled
 Debug/*.*
@@ -35,8 +40,6 @@ db/*.db
 db/*.db-*
 
 # Ignore customized configs
-rippled.cfg
-validators.txt
 test/config.js
 
 # Ignore coverage files
@@ -47,6 +50,7 @@ test/config.js
 
 # Ignore IntelliJ files
 .idea
+*.iml
 
 # Ignore npm-debug
 npm-debug.log
@@ -54,6 +58,9 @@ npm-debug.log
 # Ignore dist folder, built from tsc
 dist/
 
+# TypeScript incremental compilation cache
+*.tsbuildinfo
+
 # Ignore perf test cache
 scripts/cache
 
@@ -61,3 +68,9 @@ scripts/cache
 
 # nyc (istanbul)
 .nyc_output
+
+# browser tests
+testCompiledForWeb
+
+# lerna debug
+lerna-debug.log

.ncurc.json

@@ -0,0 +1,4 @@
+{
+  "reject": [
+  ]
+}

.npmignore

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

.nvmrc

@@ -1 +1 @@
-v10
+v18

.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
-}

.prettierignore

@@ -0,0 +1 @@
+*.md

.travis.yml

@@ -1,11 +0,0 @@
-language: node_js
-node_js:
-  - 6
-  - 8
-  - 9
-  - 10
-script:
-  - yarn compile
-  - yarn test
-  - yarn build
-  - yarn lint

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+      "dbaeumer.vscode-eslint",
+      "esbenp.prettier-vscode"
+    ]
+  }

.vscode/settings.json

@@ -0,0 +1,60 @@
+{
+    "editor.tabSize": 2,
+    "cSpell.words": [
+        "altnet",
+        "Autofills",
+        "Clawback",
+        "hostid",
+        "keypair",
+        "keypairs",
+        "multisign",
+        "multisigned",
+        "multisigning",
+        "preauthorization",
+        "rippletest",
+        "secp256k1",
+        "Setf",
+        "Sidechains",
+        "xchain"
+    ],
+    "[javascript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
+    "[javascriptreact]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
+    "[typescriptreact]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "editor.formatOnSave": true
+    },
+    "eslint.alwaysShowStatus": true,
+    "eslint.lintTask.enable": true,
+    "eslint.codeAction.showDocumentation": {
+        "enable": true
+    },
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit"
+    },
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "files.watcherExclude": {
+        "**/.git/objects/**": true,
+        "**/.git/subtree-cache/**": true,
+        "**/.hg/store/**": true
+    },
+    "search.exclude": {
+        "**/.git": true,
+        "**/node_modules": true,
+        "**/tmp": true,
+        "**/docs/**/*.html": true,
+        "**/fixtures/**/*.json": true,
+        "**/docs/assets": true
+    },
+}

CONTRIBUTING.md

@@ -0,0 +1,280 @@
+# Contributing
+
+### High Level Process to Contribute Code
+
+- You should open a PR against `main` and ensure that all CI passes.
+- Your changes should have [unit](#unit-tests) and/or [integration tests](#integration-tests).
+- Your changes should [pass the linter](#run-the-linter).
+- You should get a full code review from two of the maintainers.
+- Then you can merge your changes. (Which will then be included in the next release)
+
+## Set up your dev environment
+
+### Requirements
+
+We use Node v18 for development - that is the version that our linters require.
+You must also use `npm` v7. You can check your `npm` version with:
+
+```bash
+npm -v
+```
+
+If your `npm` version is too old, use this command to update it:
+
+```bash
+npm -g i npm@7
+```
+
+### Set up
+
+1. Clone the repository
+2. `cd` into the repository
+3. Install dependencies with `npm install`
+
+### Build
+
+```bash
+npm run build
+```
+
+## Run the linter
+
+```bash
+npm install
+npm run build
+npm run lint
+```
+
+## Running Tests
+
+For integration and browser tests, we use a `xahaud` node in standalone mode to test xahau.js code against. To set this up, you can either configure and run `xahaud` locally, or set up the Docker container `xahauci/xahaud` by [following these instructions](#integration-tests). The latter will require you to [install Docker](https://docs.docker.com/get-docker/).
+
+### Unit Tests
+
+```bash
+npm install
+npm run build
+npm test
+```
+
+### Integration Tests
+
+From the top-level xahau.js folder (one level above `packages`), run the following commands:
+
+```bash
+npm install
+# sets up the xahaud standalone Docker container - you can skip this step if you already have it set up
+docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/opt/xahau/etc/ --platform linux/amd64 xahauci/xahaud:2025.2.6 /opt/xahau/bin/xahaud -a --conf /opt/xahau/etc/xahaud.cfg
+npm run build
+npm run test:integration
+```
+
+Breaking down the command:
+* `docker run -p 6006:6006` starts a Docker container with an open port for admin WebSocket requests.
+* `--interactive` allows you to interact with the container.
+* `-t` starts a terminal in the container for you to send commands to.
+* `--volume $PWD/.ci-config:/config/` identifies the `xahaud.cfg` and `validators.txt` to import. It must be an absolute path, so we use `$PWD` instead of `./`.
+* `xahauci/xahaud` is an image that is regularly updated with the latest `xahaud` releases
+* `/opt/xahau/bin/xahaud -a --conf /opt/xahau/etc/xahaud.cfg` starts `xahaud` in standalone mode
+
+### Browser Tests
+
+There are two ways to run browser tests.
+
+One is in the browser - run `npm run build:browserTests` and open `test/localIntegrationRunner.html` in your browser.
+
+The other is in the command line (this is what we use for CI) -
+
+This should be run from the `xahau.js` top level folder (one above the `packages` folder).
+
+```bash
+npm run build
+# sets up the xahaud standalone Docker container - you can skip this step if you already have it set up
+docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/opt/xahau/etc/ --platform linux/amd64 xahauci/xahaud:2025.2.6 /opt/xahau/bin/xahaud -a --conf /opt/xahau/etc/xahaud.cfg
+npm run test:browser
+```
+
+## High Level Architecture
+
+This is a monorepo, which means that there are multiple packages in a single GitHub repository using [Lerna](https://lerna.js.org/).
+
+The 4 packages currently here are:
+
+1. xahau.js - The client library for interacting with the ledger.
+2. xahau-binary-codec - A library for serializing and deserializing transactions for the ledger.
+3. xahau-keypairs - A library for generating and using cryptographic keypairs.
+4. xahau-address-codec - A library for encoding and decoding Xahau Ledger addresses and seeds.
+5. isomorphic - A collection of isomorphic implementations of crypto and utility functions.
+6. secret-numbers - Generate XRPL Accounts with a number-based secret: 8 chunks of 6 digits.
+
+Each package has it's own README which dives deeper into what it's main purpose is, and the core functionality it offers.
+They also run tests independently as they were originally in separate repositories.
+
+These are managed in a monorepo because often a change in a lower-level library will also require a change in xahau.js, and so it makes sense to be able to allow for modifications of all packages at once without coordinating versions across multiple repositories.
+
+Let's dive a bit into how xahau.js is structured!
+
+### The File Structure
+
+Within the xrpl package, each folder has a specific purpose:
+
+**Client** - This contains logic for handling the websocket connection to xahaud servers.
+**Models** - These types model LedgerObjects, Requests/Methods, and Transactions in order to give type hints and nice errors for users.
+**Sugar** - This is where handy helper functions end up, like `submit`, `autofill`, and `getXAHBalance` amongst others.
+**Utils** - These are shared functions which are useful for conversions, or internal implementation details within the library.
+**Wallet** - This logic handles managing keys, addresses, and signing within xahau.js
+
+### Writing Tests for xahau.js
+
+For every file in `src`, we try to have a corresponding file in `test` with unit tests.
+
+The goal is to maintain above 80% code coverage, and generally any new feature or bug fix should be accompanied by unit tests, and integration tests if applicable.
+
+For an example of a unit test, check out the [autofill tests here](./packages/xahau/test/client/autofill.ts).
+
+If your code connects to the ledger (ex. Adding a new transaction type) it's handy to write integration tests to ensure that you can successfully interact with the ledger. Integration tests are generally run against a docker instance of xahaud which contains the latest updates. Since standalone mode allows us to manually close ledgers, this allows us to run integration tests at a much faster rate than if we had to wait 4-5 seconds per transaction for the ledger to validate the transaction. [See above](#running-tests) for how to start up the docker container to run integration tests.
+
+All integration tests should be written in the `test/integration` folder, with new `Requests` and `Transactions` tests being in their respective folders.
+
+For an example of how to write an integration test for `xahau.js`, you can look at the [Payment integration test](./packages/xahau/test/integration/transactions/payment.ts).
+
+## Generate reference docs
+
+You can see the complete reference documentation at [`xahau.js` docs](https://js.xrpl.org). You can also generate them locally using `typedoc`:
+
+```bash
+npm run docgen
+```
+
+This updates `docs/` at the top level, where GitHub Pages looks for the docs.
+
+## Update `definitions.json`
+
+Use [this repo](https://github.com/RichardAH/xrpl-codec-gen) to generate a new `definitions.json` file from the xahaud source code. Instructions are available in that README.
+
+## Adding and removing packages
+
+`xahau.js` uses `lerna` and `npm`'s workspaces features to manage a monorepo.
+Adding and removing packages requires a slightly different process than normal
+as a result.
+
+### Adding or removing development dependencies
+
+`xahau.js` strives to use the same development dependencies in all packages.
+You may add and remove dev dependencies like normal:
+
+```bash
+### adding a new dependency
+npm install --save-dev abbrev
+### removing a dependency
+npm uninstall --save-dev abbrev
+```
+
+### Adding or removing runtime dependencies
+
+You need to specify which package is changing using the `-w` flag:
+
+```bash
+### adding a new dependency to `xahau`
+npm install abbrev -w xahau
+### adding a new dependency to `xahau-keypairs`
+npm install abbrev -w xahau-keypairs
+### removing a dependency
+npm uninstall abbrev -w xahau
+```
+
+## Updating the Docker container for CI
+
+In order to test the library, we need to enable the latest amendments in the docker container.
+This requires updating the `/.ci-config/xahaud.cfg` file with the hashes and names of new amendments.
+
+In order to update the list, follow these steps from the top level of the library:
+1. Run `node ./.ci-config/getNewAmendments.js`
+2. If there are any new amendment hashes, add a comment to the end of `/.ci-config/xahaud.cfg` with the date
+   - `Ex. "# Added August 9th, 2023"`
+3. For each hash printed out by the script, add the hash and name to the config file.
+   - Ex. `B2A4DB846F0891BF2C76AB2F2ACC8F5B4EC64437135C6E56F3F859DE5FFD5856 ExpandedSignerList`
+   - You can look up the name by searching for the hash on https://xrpl.org/known-amendments.html
+4. Push your changes
+
+Note: The same updated config can be used to update xahau-py's CI as well.
+
+## Updating `definitions.json`
+
+This should almost always be done using the [`xrpl-codec-gen`](https://github.com/RichardAH/xrpl-codec-gen) script - if the output needs manual intervention afterwards, consider updating the script instead.
+
+1. Clone / pull the latest changes from [xahaud](https://github.com/XRPLF/xahaud) - Specifically the `develop` branch is usually the right one.
+2. Clone / pull the latest changes from [`xrpl-codec-gen`](https://github.com/RichardAH/xrpl-codec-gen)
+3. From the `xrpl-codec-gen` tool, follow the steps in the `README.md` to generate a new `definitions.json` file.
+4. Replace the `definitions.json` file in the `xahau-binary-codec` with the newly generated file.
+5. Verify that the changes make sense by inspection before submitting, as there may be updates required for the `xrpl-codec-gen` tool depending on the latest amendments we're updating to match.
+
+
+## Release process + checklist
+
+## PR process
+
+- [ ] Your changes should be on a branch.
+- [ ] Your changes should have unit tests.
+- [ ] Lint the code with `npm lint`
+- [ ] Build your code with `npm build`
+- [ ] Run the unit tests with `npm test`
+- [ ] Get a full code review.
+- [ ] Merge your branch into `main` and push to github.
+- [ ] Ensure that all tests passed on the last CI that ran on `main`.
+
+## Release
+
+1. Checkout `main` (or your beta branch) and `git pull`.
+1. Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture updates that take place during this process.
+1. Update `HISTORY.md` to reflect release changes.
+
+   - [ ] Update the version number and release date, and ensure it lists the changes since the previous release.
+
+1. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
+1. Run `npm run build` to triple check the build still works
+1. Run `npx lerna version --no-git-tag-version` - This bumps the package versions.
+
+   - For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `main`, and create a new git tag for each published package.
+   - If you do NOT want to update the package number, choose "Custom Version" and set the version to be the same as the existing version. Lerna will not publish any changes in this case.
+   - If publishing a beta, make sure that the versions are all of the form `a.b.c-beta.d`, where `a`, `b`, and `c` are identical to the last normal release except for one, which has been incremented by 1.
+
+1. Run `npm i` to update the package-lock with the updated versions.
+1. Create a new PR from this branch into `main` and merge it (you can directly merge into the beta branch for a beta).
+1. Checkout `main` and `git pull` (you can skip this step for a beta since you already have the latest version of the beta branch).
+1. Actually publish the packages with one of the following:
+
+   - Stable release: Run `npx lerna publish from-package --yes`
+   - Beta release: Run `npx lerna publish from-package --dist-tag beta --yes`
+     Notice this allows developers to install the package with `npm add xahau@beta`
+
+1. If requested, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
+
+   NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
+
+1. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `xahau@2.1.1`), for each version released.
+1. Run `git push --follow-tags`, to push the tags to Github.
+1. On GitHub, click the "Releases" link on the right-hand side of the page.
+
+1. Repeat for each release:
+
+   1. Click "Draft a new release"
+   1. Click "Choose a tag", and choose a tag that you just created.
+   1. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
+
+1. Send an email to [xahau-announce](https://groups.google.com/g/xahau-announce).
+1. Lastly, send a similar message to the Xahau Discord in the [`javascript` channel](https://discord.com/channels/1085202760548499486/1085203623111295068). The message should include:
+   1. The version changes for xahau libraries
+   1. A link to the more detailed changes
+   1. Highlights of important changes
+
+
+## Mailing Lists
+
+We have a low-traffic mailing list for announcements of new `xahau.js` releases. (About 1 email every couple of weeks)
+
+- [Subscribe to xahau-announce](https://groups.google.com/g/xahau-announce)
+
+If you're using the Xahau Ledger in production, you should run a [xahaud server](https://github.com/xahau/xahaud) and subscribe to the xahau-server mailing list as well.
+
+- [Subscribe to xahau-server](https://groups.google.com/g/xahau-server)

Gulpfile.js

@@ -1,216 +0,0 @@
-/* eslint-disable no-var, no-param-reassign */
-/* these eslint rules are disabled because gulp does not support babel yet */
-'use strict';
-const _ = require('lodash');
-const fs = require('fs');
-const path = require('path');
-const assert = require('assert');
-const gulp = require('gulp');
-const rename = require('gulp-rename');
-const webpack = require('webpack');
-const bump = require('gulp-bump');
-const argv = require('yargs').argv;
-const UglifyJsPlugin = require('uglifyjs-webpack-plugin')
-
-var pkg = require('./package.json');
-
-var uglifyOptions = {
-  mangle: {
-    reserved: ['_', 'RippleError', 'RippledError', 'UnexpectedError',
-    'LedgerVersionError', 'ConnectionError', 'NotConnectedError',
-    'DisconnectedError', 'TimeoutError', 'ResponseFormatError',
-    'ValidationError', 'NotFoundError', 'MissingLedgerHistoryError',
-    'PendingLedgerVersionError'
-    ]
-  }
-};
-
-function getWebpackConfig(extension, overrides) {
-  overrides = overrides || {};
-  let defaults = {
-    cache: true,
-    externals: [{
-      'lodash': '_'
-    }],
-    entry: './src/index.ts',
-    output: {
-      library: 'ripple',
-      path: path.join(__dirname, '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: {
-      rules: [{
-        test: /jayson/,
-        use: 'null',
-      }, {
-        test: /\.ts$/,
-        use: [{
-          loader: 'ts-loader',
-          options: {
-            compilerOptions: {declaration: false}
-          },
-        }],
-      }, {
-        test: /\.json/,
-        use: 'json-loader',
-      }]
-    },
-    resolve: {
-      extensions: [ '.ts', '.js' ]
-    },
-  };
-  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 getWebpackConfig('.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(getWebpackConfig('.js'), createBuildLink(callback));
-});
-
-gulp.task('build-min', function(callback) {
-  const webpackConfig = getWebpackConfig('-min.js');
-  webpackConfig.plugins.push(new UglifyJsPlugin({uglifyOptions}));
-  webpack(webpackConfig, function() {
-    createLink('./build/ripple-' + pkg.version + '-min.js',
-      './build/ripple-latest-min.js');
-    callback();
-  });
-});
-
-gulp.task('build-debug', function(callback) {
-  const webpackConfig = getWebpackConfig('-debug.js', {devtool: 'eval'});
-  webpackConfig.plugins.unshift(new webpack.LoaderOptionsPlugin({debug: true}));
-  webpack(webpackConfig, 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.ts',
-    externals: [{
-      './transaction': buildUseError('Transaction'),
-      './orderbook': buildUseError('OrderBook'),
-      './account': buildUseError('Account'),
-      './serializedobject': buildUseError('SerializedObject')
-    }],
-    plugins: [
-      new UglifyJsPlugin()
-    ]
-  };
-  webpack(getWebpackConfig('-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']);

HISTORY.md

@@ -1,778 +1,12 @@
-# ripple-lib Release History
-
-## 1.1.0 (2018-10-31)
-
-+ Add support for Node.js v10 LTS (#964)
-+ Add [DepositPreauth](https://developers.ripple.com/depositauth.html) ([#958](https://github.com/ripple/ripple-lib/pull/958))
-+ In `FormattedTransactionType`, the `Outcome`'s `balanceChanges` property had
-  the wrong type. This is now fixed (#955)
-+ Add/fix docs for: xrpToDrops, dropsToXrp, iso8601ToRippleTime, schemaValidator, isValidAddress, isValidSecret, deriveKeypair, deriveAddress
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-e1d742092b3c0fcee97a875e18db4baeab3bbc82f08b96e883ee188c5f0cfb37  ripple-1.1.0-debug.js
-f28921f57a133678dcb3cb54c497626bd76b1f953d22d61f3ddca31c8947d552  ripple-1.1.0-min.js
-3696871a80c1102635699994adcaf00cdfdfcff5014fc2eba3d8f8d8437c8f91  ripple-1.1.0.js
-```
-
-## 1.0.2 (2018-10-16)
-
-+ Fix #954: Exclude SendMax from all XRP to XRP payments (thanks @jefftrudeau)
-+ TypeScript
-  + book_offers returns offers type OfferLedgerEntry (#951)
-  + Use `object` (#936)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 * 
-2556fe17296e127ed44e7066e90a6175e2b164f00ca3c1aa7b1c554f31c688dd  ripple-1.0.2-debug.js
-e0342ea21eac32a1024c62034fba09c6f26dd3e7371b23ea1e153e03135cd590  ripple-1.0.2-min.js
-c7286c517497d018d02d09257e81172b61d36c8b9885a077af68e8133c3b3b9b  ripple-1.0.2.js
-```
-
-## 1.0.1 (2018-09-27)
-
-+ Add address/secret/key validation and derivation methods ([#932](https://github.com/ripple/ripple-lib/pull/932))
-  + `isValidAddress(address: string) : boolean`: Checks if the specified string contains a valid address.
-  + `isValidSecret(secret: string): boolean`: Checks if the specified string contains a valid secret.
-  + `deriveKeypair(seed: string): {privateKey: string, publicKey: string}`: Derive a public and private key from a seed.
-  + `deriveAddress(publicKey: string): string`: Derive an XRP Ledger address from a public key.
-+ To derive an address from a secret:
-  1. Derive the public key from the secret.
-  2. Derive the address from the public key.
-  + Example: `const address = api.deriveAddress(api.deriveKeypair(secret).publicKey)`
-+ Update server regex to accommodate UDS (#944)
-+ Include memos when parsing trustlines (#949)
-+ Add remaining LedgerEntry types (#943)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-9b6408641ce83659afcd5765c256c35829a4fcb4c3244dc9ca6bf27c871a45c4  ripple-1.0.1-debug.js
-7ab2b69fe59c2d4a74638116e2ba3b387155eb2d23e48a01bbf7beb72911f898  ripple-1.0.1-min.js
-8bb4dcad9ce25a27003b1d73d71ddf41b8a5af02ece4ebbfeaff4aeb91f3b8c4  ripple-1.0.1.js
-```
-
-## 1.0.0 (2018-08-30)
-
-We are pleased to announce the release of `ripple-lib` version 1.0.0.
-
-This version features a range of changes and improvements that make the library
-more capable and flexible. It includes new methods for accessing rippled APIs,
-including subscriptions.
-
-When using this version with `rippled` for online functionality, we recommend
-using `rippled` version 1.0.1 or later.
-
-Here is a summary of the changes since `ripple-lib` version 0.22.0, which was
-the last non-beta version.
-
-### New Features
-
-+ [Add `request()`, `hasNextPage()`, and `requestNextPage()` for accessing `rippled`
-  APIs](https://github.com/ripple/ripple-lib/blob/09541dae86bc859bf5928ac65b2645dfaaf7f8b1/docs/index.md#rippled-apis).
-+ Add `prepareTransaction()` for preparing raw `txJSON`.
-+ XRP amounts can be specified in drops. Also, `xrpToDrops()` and `dropsToXrp()`
-  are available to make conversions.
-+ `getTransaction` responses can include a new `channelChanges` property that
-  describes the details of a payment channel.
-
-### Data Validation and Errors
-
-+ [Amounts in drops and XRP are checked for
-  validity](https://github.com/ripple/ripple-lib/blob/develop/HISTORY.md#100-beta1-2018-05-24).
-+ [A maximum fee is now
-  imposed](https://github.com/ripple/ripple-lib/blob/develop/HISTORY.md#100-beta2-2018-06-08). Exceeding it causes a `ValidationError` to be
-  thrown.
-+ Errors are improved and more data validation was added.
-+ Bug fix: `getPaths` now filters paths correctly and works correctly when the
-  destination currency is XRP.
-
-### Breaking Changes
-
-The following changes were introduced in 1.0.0.
-
-+ `getTransaction()` and `getTransactions()`
-  + The `specification.destination.amount` field has been removed from the parsed transaction response.
-  + To determine the amount that a transaction delivered, use `outcome.deliveredAmount`.
-  + If you require the provisional requested `Amount` from the original transaction:
-    + Use `getTransaction`'s `includeRawTransaction` option, or
-    + Use `getTransactions`'s `includeRawTransactions` option, or
-    + Use the rippled APIs directly with `request`. For example, call the API methods `tx`, `account_tx`, etc.
-+ `getLedger()` response object
-  + The `rawTransactions` field has been removed (for consistency with `getTransaction()` and `getTransactions()`).
-  + Instead, within each `transaction`, use the new `rawTransaction` JSON string.
-  + The `metaData` field has been renamed to `meta` for consistency with rippled's `tx` method.
-  + `ledger_index` has been added to each raw transaction.
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-06e5efcb6846ad45dedfd85cfa2ef4bdeb608b15ccbfb60b872c995d97342426  ripple-1.0.0-debug.js
-cdb26b928a89ce228c727d1ff966df266eb46b2f76bd94f81cbeb0a9d75febf0  ripple-1.0.0-min.js
-f74ee804e8a945a994e4e3901a0a3eb52292fbdcbff61ed30cefb8ffbcba50c3  ripple-1.0.0.js
-```
-
-## 1.0.0-beta.5 (2018-08-11)
-
-+ [Fix a TypeScript error by importing the `Prepare` type](https://github.com/ripple/ripple-lib/commit/7cd517268bda5fe74b91dad02fedf8b51b7eae9b)
-
-## 1.0.0-beta.4 (2018-08-10)
-
-+ [Add `prepareTransaction()`](https://github.com/ripple/ripple-lib/pull/898)
-+ Internal improvements and cleanup
-
-## 1.0.0-beta.3 (2018-07-17)
-
-+ For payment channel transactions, `getTransaction` includes a new
-  `channelChanges` property that describes the details of the payment channel.
-  (#920)
-
-### Bug Fixes
-
-+ A bug caused calculated fees to use too many decimal places. This was fixed by
-  rounding fees to 6 decimal places. (#912)
-+ When using the Settings transaction to set up a multi-signing list, the
-  threshold and weights fields are required. (#909)
-+ Docs: Fix the MIMETYPE in examples with memos. (#914)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-460dbb521e24c44cb53dabc1a74feeca33d031b44d889dd5b51103ca92d51de6  ripple-1.0.0-beta.3-debug.js
-cccfd24973c6b7990d9e933a589175dae26249825737fff4f2f73d8558a3f186  ripple-1.0.0-beta.3-min.js
-0dc456a58fb078347d9920310621595905085595d73c2b8fe96bea73bcf35450  ripple-1.0.0-beta.3.js
-```
-
-## 1.0.0-beta.2 (2018-06-08)
-
-### Breaking Changes
-
-+ During transaction preparation, there is now a maximum fee. Also, when a transaction is signed, its fee is checked and an error is thrown if the fee exceeds the maximum. The default `maxFeeXRP` is `'2'` (2 XRP). Override this value in the RippleAPI constructor.
-+ Attempting to prepare a transaction with an exact `fee` higher than `maxFeeXRP` causes a `ValidationError` to be thrown.
-+ Attempting to sign a transaction with a fee higher than `maxFeeXRP` causes a `ValidationError` to be thrown.
-+ The value returned by `getFee()` is capped at `maxFeeXRP`.
-
-### Other Changes
-
-+ In Transaction Instructions, the `maxFee` parameter is deprecated. Use the `maxFeeXRP` parameter in the RippleAPI constructor.
-
-#### Overview of new fee limit
-
-Most users of ripple-lib do not need to make any code changes to accommodate the new soft limit on fees. The limit is designed to protect against the most severe cases where an unintentionally high fee may be used.
-
-+ When having ripple-lib provide the fee with a `prepare*` method, a maximum fee of `maxFeeXRP` (default 2 XRP) applies. You can prepare more economical transactions by setting a lower `maxFeeXRP`, or support high-priority transactions by setting a higher `maxFeeXRP` in the RippleAPI constructor.
-+ When using `sign` with a Fee higher than `maxFeeXRP`, a `ValidationError` is thrown.
-
-If you have any questions or concerns, please open an issue on GitHub.
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-ef348a2805098e61395b689b410cbf4bfd35e4d72e38c89f4ab74ec5e19793f5  ripple-1.0.0-beta.2-debug.js
-ea33fd53df8c7176d5fbf52dae0b64aade7180860f26449062cdbefaf8bd4d9b  ripple-1.0.0-beta.2-min.js
-fe5cc6e97c9b8a1470dacb34f16a64255cd639a25381abe9db1ba79e102456f2  ripple-1.0.0-beta.2.js
-```
-
-## 1.0.0-beta.1 (2018-05-24)
-
-### Breaking Changes
-
-+ Amounts in drops and XRP are checked for validity. Some
-  methods may now throw a `BigNumber Error` or `ValidationError` if the amount
-  is invalid. This may include methods that previously did not throw.
-+ Note that 1 drop is equivalent to 0.000001 XRP and 1 XRP is equivalent to 1,000,000 drops.
-+ Using drops is recommended. All rippled APIs require XRP amounts to be
-  expressed in drops.
-
-### Other Changes
-
-+ Allow specifying amounts in drops for consistency with the `rippled`
-  APIs.
-+ Export `xrpToDrops()` and `dropsToXrp()` functions.
-+ Potentially breaking change: Improve errors. For example, `RippledError` now includes the full response from
-  the `rippled` server ([#687](https://github.com/ripple/ripple-lib/issues/687)). `NotConnectedError`
-  may be thrown with a different message than before.
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-a80ebb39e186640246306eadb2879147458c8271fd3c6cb32e6ef78d0b4b01a5  ripple-1.0.0-beta.1-debug.js
-81bcc4b5fd6fd52220ed151242eaddd63eb29c4078845edc68f65b769557d126  ripple-1.0.0-beta.1-min.js
-738b4d65b58cf4e3542fa396f8d319a24cd7d0b7aff5ff629a900e244f735ff4  ripple-1.0.0-beta.1.js
-```
-
-## 1.0.0-beta.0 (2018-05-10)
-
-+ [Add `request`, `hasNextPage`, and
-  `requestNextPage`](https://github.com/ripple/ripple-lib/pull/887).
-  + This provides support for all rippled APIs, including subscriptions.
-
-When using rippled APIs, you must:
-+ For all XRP amounts, use drops (1 drop = 0.000001 XRP).
-+ Instead of `counterparty`, use `issuer`.
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-ab2094979a3d6b320c7bc22bc5946c50fa5e29af0976d352e7689b0a4d840c55  ripple-1.0.0-beta.0-debug.js
-0e7f7d740606c2866ebf63776b13b41a555848e1a1419e2c8058d2e6c562d7fd  ripple-1.0.0-beta.0-min.js
-bd05e8806832ca4192aea7ba2d0362baa9f44605f8e8e6676acd25eb0b94b778  ripple-1.0.0-beta.0.js
-```
-
-## 0.22.0 (2018-05-10)
-
-+ [`getOrderbook` - return raw order data](https://github.com/ripple/ripple-lib/pull/886). The full `BookOffer` data is now provided under `data`.
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-33f71b55c4adec4452826e44fe7809377364df04222b60f0fce01e7de2daff33  ripple-0.22.0-debug.js
-63232888a4ea77065e8e8eb8fdaa8ebfe3a785428fe935e2667c1ea54c837f29  ripple-0.22.0-min.js
-ab98026fabe296bd938297c48cb58e01dfdbe90f3c66c9617d6a3e1efd4c6b93  ripple-0.22.0.js
-```
-
-## 0.21.0 (2018-04-11)
-
-+ [Upgrade https-proxy-agent](https://github.com/ripple/ripple-lib/pull/883)
-+ [Add getAccountObjects](https://github.com/ripple/ripple-lib/pull/881)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-3ab52209ad4a80393c8c08ef3f4aa9cfb47bc76c0ede2ee9fa7f5ca180ba4d67  ripple-0.21.0-debug.js
-3b1efccded347bed5f64757098a1ea6a513bb8932d922d00af47cd24e001dc14  ripple-0.21.0-min.js
-db08e5a3eab1f659b4c803543374398004d950ba720adc4b9a7658817cb5c94b  ripple-0.21.0.js
-```
-
-## 0.20.0 (2018-04-09)
-
-+ [Add support for using a keypair with sign()](https://github.com/ripple/ripple-lib/pull/769)
-+ [Fix a bug caused by jsonschema v1.2.3 by pinning to v1.2.2](https://github.com/ripple/ripple-lib/pull/882)
-+ [Improve Payment Channel documentation](https://github.com/ripple/ripple-lib/pull/877)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-389811a9baa72f77e2a43d0b48045762d29a6f616ed5fd2660ba76fc12a3ecc5  ripple-0.20.0-debug.js
-c1746ea0dd55318cb4e1ef3955ef14759d9d70861437c69abafc10169916f068  ripple-0.20.0-min.js
-17958b0e46395d2b2a35a003693c0babdfb5382513d3cc58a62f8648ad710b0e  ripple-0.20.0.js
-```
-
-## 0.19.1 (2018-03-22)
-
-+ [Fix: Include TypeScript declarations in npm package](https://github.com/ripple/ripple-lib/pull/863)
-+ [Fix: Documentation link to checkCash](https://github.com/ripple/ripple-lib/pull/871)
-+ [Internal: Clean up types and migrate more APIs to new request method](https://github.com/ripple/ripple-lib/pull/857)
-+ [Internal: Fix Payment source and destination types](https://github.com/ripple/ripple-lib/pull/870)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-3ed5332aa035c07bae6c1abfdfc8ca77cdbb05cc4b88878f544f1ea4cb793f4d  ripple-0.19.1-debug.js
-2f5507aa00a40ab6a94de1822af87db5e927edef3885aef5d9b39ccb623ccb54  ripple-0.19.1-min.js
-1e439aee1b220242d56ea687a9b55a67b8614212c1ddbd70a4fcf34503fc487a  ripple-0.19.1.js
-```
-
-## 0.19.0 (2018-03-02)
-
-+ [Add support for Checks](https://github.com/ripple/ripple-lib/pull/853)
-  + **CheckCreate** adds a check entry to the ledger. The check is a promise from the source of the check that the destination of the check may cash the check and receive up to the SendMax specified on the check. The check may have an (optional) expiration, after which the check may no longer be cashed.
-  + **CheckCancel** removes the check from the ledger without transferring funds. Either the check's source or destination can cancel the check at any time. After a check has expired, any account can cancel the check.
-  + **CheckCash** is a request by the destination of the check to transfer a requested amount of funds, up to the check's SendMax, from the source to the destination. The destination may receive less than the SendMax due to transfer fees.
-+ [Add support for the Deposit Authorization account root flag](https://github.com/ripple/ripple-lib/pull/852)
-+ [Generate .ts.d TypeScript declaration files](https://github.com/ripple/ripple-lib/pull/851)
-+ [Improve documentation of getTransactions params](https://github.com/ripple/ripple-lib/pull/856)
-+ [Add new request interface](https://github.com/ripple/ripple-lib/pull/843) (private for now)
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-0e7ce4594b7e455fbc57ad81f6fddc391d1e1f349a49c96ad783be50f80fdc14  ripple-0.19.0-debug.js
-6d716a0357929e51e476f22136880f7a0e5458fd396ac145ce9308f278ff7cc1  ripple-0.19.0-min.js
-6715db1af638f99226ab7f8f244103306aa6e04d1b8c1da47a63431053bacb84  ripple-0.19.0.js
-```
-
-## 0.18.2 (2018-02-13)
-
-+ [Fix: Publish updated browser builds to npm so that users can easily use
-  CDNs](https://github.com/ripple/ripple-lib/pull/849)
-+ [Fix: Browserify fails due to dependency on `ws`](https://github.com/ripple/ripple-lib/pull/847)
-+ [Fix: `build` script fails when `node_modules` is in path](https://github.com/ripple/ripple-lib/pull/846)
-+ [Reduce size of published npm package](https://github.com/ripple/ripple-lib/commit/0c318816ccf25c4c3932934a35ef903cc552edc1)
-+ Clean up files from Flow (we migrated to TypeScript)
-+ Typos and code cleanup
-
-The SHA-256 checksums for the browser version of this release can be found
-below.
-```
-% shasum -a 256 *
-f08ab61137255be3639e9d210ded2a182b6e0388f257a70d9b372ce7e7e518a6  ripple-0.18.2-debug.js
-0604835b8421391167b4314ce93a76b5994780a08bd7edf36d91eb5e8f2643a2  ripple-0.18.2-min.js
-fda56ab5c8256e04355e20064877ef4053f26c87f37cfcf861340f22bf89ee40  ripple-0.18.2.js
-```
-
-## 0.18.1 (2018-01-27)
-
-Note: The package published to npm for this version did not include updated
-browser builds. If you are using a CDN that pulls from npm, please use 0.18.2 or
-later.
-
-+ [Fix: isSameIssue() should check counterparty](https://github.com/ripple/ripple-lib/pull/836). This bug caused `getOrderbook()` to return incorrect values.
-
-The SHA-256 checksums for the browser version of this release can be found below.
-```
-% shasum -a 256 *
-6871855a2af1dc591ef557d442c11e8c60e01c5932054e13e8cbb84a182f45e0  ripple-0.18.1-debug.js
-331f0baff46af44933a8fa31f128132945ff82a147acfff0a7315adb446e3de0  ripple-0.18.1-min.js
-26324bb0725d2d484fe3b6086335d49734f45dc647b07c60746e0d8619f1ed3e  ripple-0.18.1.js
-```
-
-## 0.18.0 (2018-01-25)
-
-+ [Convert from Flow to TypeScript](https://github.com/ripple/ripple-lib/pull/816)
-+ [Use ES Module syntax](https://github.com/ripple/ripple-lib/pull/815) (Babel still compiles these to common.js modules for
-  distribution)
-+ Docs: [Improve escrow creation example/test](https://github.com/ripple/ripple-lib/pull/820)
-+ [Fix type errors](https://github.com/ripple/ripple-lib/pull/811)
-+ [Fix lint errors](https://github.com/ripple/ripple-lib/pull/813)
-
-## 0.17.9 (2017-11-14)
-
-+ [Update ws dependency to 3.3.1](https://github.com/ripple/ripple-lib/pull/804)
-+ [Remove unnecessary polyfills](https://github.com/ripple/ripple-lib/pull/807)
-+ Fix lint errors ([#786](https://github.com/ripple/ripple-lib/pull/786), [#808](https://github.com/ripple/ripple-lib/pull/808))
-+ [Update ripple-keypairs dependency to 0.10.1](https://github.com/ripple/ripple-lib/pull/805)
-
-The SHA-256 checksums for the browser version of this release can be found below.
-```
-% shasum -a 256 *
-b52f251eedac2509d72093eab1e8dba0d0f4a9fe6a28ec1cc90853cfb0fd7110  ripple-0.17.9-debug.js
-d577a2bbdbdf7535c5365a1c52a2a31989d1b966e30abcba65c87133a536b9dc  ripple-0.17.9-min.js
-ff4c3002842fac72ec2ebbd081e9594b0de6050d4d051a8fd6c06adb9a351488  ripple-0.17.9.js
-```
-
-The SHA-1 checksums for the browser version of this release can be found below.
-```
-% shasum *
-e1995afc34aef6accd269cfccc55a45619618a41  ripple-0.17.9-debug.js
-e6ad9a9c111ab696f5637bfa372d80999e5ae362  ripple-0.17.9-min.js
-4866494ec5f9095cc34bea142f1e2b8ac5f7fbf8  ripple-0.17.9.js
-```
-
-## 0.17.8 (2017-11-06)
-
-+ Fix: Freezing in Safari 10.1 (updated bignumber.js) (closes #762)
-+ [Fix: `getSettings` should include signers](https://github.com/ripple/ripple-lib/commit/2a90f9b134e168937dceb7da283d63734eac9e7c)
-+ Update for Node 6
-+ Update lodash dependency
-+ Migrate to yarn
-
-## 0.17.7 (2017-05-08)
-
-+ Replace AJV with jsonschema
-
-## 0.16.5 (2016-01-21)
-
-+ [Filter insufficient source funds paths from pathfind results](https://github.com/ripple/ripple-lib/pull/688)
-
-## 0.16.4
-
-+ [Update `ws` to 1.0.1](https://github.com/ripple/ripple-lib/pull/682)
-
-## 0.16.2
-
-+ Bump `ripple-binary-codec` dependency version to 0.1.1 to fix issue with `computeLedgerHash` for transactions with `DeliverMin`
-
-## 0.16.1
-
-+ [FIX: Use assert not assert-diff](https://github.com/ripple/ripple-lib/commit/f6ebe325193e7208c5ee8d8e84a7504714f0009e)
-
-## 0.16.0
-
-__BREAKING CHANGES__
-+ [Fix types of XRP values in `getServerInfo` response](https://github.com/ripple/ripple-lib/commit/99d08065e4bda3dda6ae1f183adbd11abc70a9b7)
-+ [Change error event format and fix crash due to error event on websocket](https://github.com/ripple/ripple-lib/commit/9cd72595f0efc062d77b9d625695d6030c524cc6)
-
-__OTHER CHANGES__
-+ [Fix `generateAddress` docs and add error event listener to boilerplate](https://github.com/ripple/ripple-lib/commit/809d981987a2890fac3a73a40a05c598b9040334)
-+ [Allow setting `maxLedgerVersion` to `null` to specify no maximum](https://github.com/ripple/ripple-lib/commit/82613e7e8b360d1ae1552eab4559ab4763c06d7e)
-+ [Add support for client certificates](https://github.com/ripple/ripple-lib/commit/5f5e48e4140345d166b8c1a3ee0847b0d9e2d893)
-+ [`getFee` returns a string not a float](https://github.com/ripple/ripple-lib/commit/7bf2da6014c87e164542e69356efeaabb575a157)
-+ [Fix parsing of quality for `getTrustlines`](https://github.com/ripple/ripple-lib/commit/86ff315ef2a39dfdc2ce97e0e1c4aa73f04e363b)
-+ Fix `DeliverMin` value when specifying `minAmount`
-+ [http server example](https://github.com/ripple/ripple-lib/commit/76866ab901ea46a2dd73181605e0f7f4220043d4)
-
-## 0.15.2
-
-+ [Fix support for proxy credentials in proxy URL and fix error when there are more than 10 outstanding requests](https://github.com/ripple/ripple-lib/commit/0990ad4a6f1d59ca9d2cb859b4e2d71693f3fc4b)
-
-## 0.15.1
-
-+ [Fix `babel-polyfill` require](https://github.com/ripple/ripple-lib/commit/062148674c3b1293ab82c28e25615ddd530339fa)
-+ [Fix samples](https://github.com/ripple/ripple-lib/commit/5d5cf868a2ddb1b1cd40e4a4f0a782d0066c2055)
-+ [Add unit tests for `RippleAPIBroadcast`](https://github.com/ripple/ripple-lib/commit/ddf8fe5b1a9c750490dca98fb9ffaaf8017f87e0)
-
-## 0.15.0
-
-__BREAKING CHANGES__
-+ ["servers" parameter changed to single "server"](https://github.com/ripple/ripple-lib/commit/7061e9afe46f0682254d098adeff3dd7157521a1)
-
-__OTHER CHANGES__
-+ [Fix handling memos in `prepareSettings`](https://github.com/ripple/ripple-lib/commit/c9704137b7b538e8dbf31c483bcdcf2dcfd7cd75)
-+ [Docs: SusPay warnings, offline mode, and other tweaks](https://github.com/ripple/ripple-lib/commit/4b4fc36ebd93f1360781a65f2869bd2c4f0a5093)
-+ [Fix prepareOrderCancellation documentation](https://github.com/ripple/ripple-lib/commit/5e720891f579fd73d43c64e5ec519d9121023c10)
-
-## 0.14.0
-
-__BREAKING CHANGES__
-+ [`prepareOrderCancellation` now takes orderCancellation specification](https://github.com/ripple/ripple-lib/commit/7f33d8a71e56289e5a5e0ead1c74f75ebcde72bc)
-+ [Rename "ledgerClosed" event to "ledger" and change format](https://github.com/ripple/ripple-lib/commit/8a3d4a64db5fbf560ebf87dc62e0212513c5e18a)
-
-__OTHER CHANGES__
-+ [Fix proxy support and add support for proxy authorization](https://github.com/ripple/ripple-lib/commit/14b840f3feca758e0384b746c94e36d8bf59b8c2)
-+ [Fix trace option](https://github.com/ripple/ripple-lib/commit/af620755c53556c55eed12de4b0013ef5a349ce2)
-+ [Allow memos on all transaction types](https://github.com/ripple/ripple-lib/commit/b5081344da8e66fbd3a5113cc3313325ef72a494)
-+ [Add documentation for RippleAPI options](https://github.com/ripple/ripple-lib/commit/a76b554cadb9f9f918b06f8386bc29355682a1a4)
-+ [Docs: more on basic types, tx types](https://github.com/ripple/ripple-lib/commit/fdbac63f466b4fd3be701d4878800d856692e26e)
-+ [Docs: revised introductory material](https://github.com/ripple/ripple-lib/commit/ef2515507dbd3c6a426ab5b31332a1bdf72d5b2d)
-+ [boost coverage to almost 100%](https://github.com/ripple/ripple-lib/commit/995606b1e6f3643af34d9fd442ccd31f320b03eb)
-
-## 0.13.2
-
-+ [Fix: Specify send_max when pathfinding with a source amount](https://github.com/ripple/ripple-lib/commit/75142139184625c8b9fcc480b1825d9985337813)
-
-## 0.13.1
-
-+ [Add documentation for API events](https://github.com/ripple/ripple-lib/commit/25d1ac0c5f95cad32ea4ceebb)
-+ [Fix: Add babel-polyfill](https://github.com/ripple/ripple-lib/commit/8a53abc32f6ec6c7d50cd182492d6fb511b86704)
-+ [Fix: Bump version on ripple-hashes](https://github.com/ripple/ripple-lib/commit/12e5765c64aea31b3c2fb65ff989cf01e6368f58)
-
-## 0.13.0
-
-__BREAKING CHANGES__
-+ Add new RippleAPI interface and delete old API
-    - [RippleAPI README and samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
-
-__OTHER CHANGES__
-+ [Removed timeout method of Request and added default timeout](https://github.com/ripple/ripple-lib/commit/634fe5683a9082e57682ff7d5c4fb9483b4af818)
-+ [Add Remote.closeCurrentPathFind function, so current pathfind can be properly closed](https://github.com/ripple/ripple-lib/commit/e99010f363fc7cbe7fd547d3ca5b32ea083c44e6)
-+ [Implement Balance Sheet API](https://github.com/ripple/ripple-lib/pull/579)
-+ [Fix bugs in orderbook subscription](https://github.com/ripple/ripple-lib/commit/7404795dc64a85216148de7bc3ca7da7b33f4490)
-+ [Fix crash due to rippled slowDown error](https://github.com/ripple/ripple-lib/commit/84838b2e9f6969b593b8462a62a6b8f516ada937)
-+ [Fix: Emit error events and return error on pathfind](https://github.com/ripple/ripple-lib/commit/1ccbaf677631a1944eb05d90f7afc5f3690a03dd)
-+ [Deprecate core and remove snake case method copying](https://github.com/ripple/ripple-lib/commit/fb8dc44ec1d49bb05cd0cdbe6dd4ab211195868a)
-+ [Fix RangeSet for validated_ledger as single ledger](https://github.com/ripple/ripple-lib/commit/9f9e76f8b933201651af59307135f67cfa7d60e8)
-+ [Fix bug where the paths would be set with an empty array](https://github.com/ripple/ripple-lib/commit/83874ec0962da311b76f2385623e51c68bc39035)
-+ [Fix reserve calculation](https://github.com/ripple/ripple-lib/commit/52879febb92d876f01f2e4d70871baa07af631fb)
-
-## 0.12.9
-
-+ [OrderBook performance optimizations](https://github.com/ripple/ripple-lib/commit/3e17d91edf36745f6b6c09b0ad88971b7775f6ab)
-
-## 0.12.7 and 0.12.8
-
-+ [Improve performance of orderbook](https://github.com/ripple/ripple-lib/commit/c745faaaf0956ca98448a754b4fe97fb50574fc7)
-+ [Remove Firefox warning about prototype overwrite](https://github.com/ripple/ripple-lib/commit/0c62fa21123b220b066871e1c41a3b4fe6f51885)
-+ [Fix compare bug in `Amount` class](https://github.com/ripple/ripple-lib/commit/806547dd154e1b0bf252e8a74ad3ac6aa8a97660)
-
-## 0.12.6
-
-+ [Fix webpack require failure due to "./" notation](https://github.com/ripple/ripple-lib/commit/8d9746d7b10be203ee613df523c2522012ff1baf)
-
-## 0.12.15
-
-+ [Add offer autobridging](https://github.com/ripple/ripple-lib/commit/c7bbce83719c1e8c6a4fae5ca850e7515db1a4a5)
-+ [Prevent crash when listening for "model" events on the OrderBook class](https://github.com/ripple/ripple-lib/commit/5824c3cb7cb6bd834d6e037f69943aebf3d83351)
-+ [Fix empty order edgecase](https://github.com/ripple/ripple-lib/commit/64809d9ae23dc24f47accd4b4788b48f49880d3e)
-+ [Fix AutobridgeCalculator (RT-3445)](https://github.com/ripple/ripple-lib/commit/1fff5ea6dcbcee856536df26f3b9cf1aec3c3b55)
-+ [Update sjcl and delete custom ripemd160, montgomery, and jacobi](https://github.com/ripple/ripple-lib/commit/50cda426eb83599c38c0b725e1524a01fc415da2)
-+ [Fix transaction summary for transactions that fail with remoteError](https://github.com/ripple/ripple-lib/commit/5e714f6143464d7912f42537acaa553b88eaf6dc)
-+ [Fix serializedobject append for excessively large bytes length](https://github.com/ripple/ripple-lib/commit/e93f1ab6f4aaad347450aee75a169af0faa2121c)
-+ [Switch to sjcl npm module](https://github.com/ripple/ripple-lib/commit/9a502580fd89ec6a9aa55f4e5847f6a4a2cb5bba)
-+ [Add babel transpiler](https://github.com/ripple/ripple-lib/commit/398f8d001f758bf575b959537a17e79e4042d17b)
-+ [Remove unused float.js and wallet.js](https://github.com/ripple/ripple-lib/commit/d4a4b5f4fbbf09677a59ce81bace35c6426a2fda)
-+ [Remove config singleton to reduce global state](https://github.com/ripple/ripple-lib/commit/c655c2a20ee5d150a4b5a1b6717b9fb81f636025)
-
-## 0.12.4
-
-+ [Improve entropy security](https://github.com/ripple/ripple-lib/commit/c7ba822320880037796f57876d1abb4e525648ed)
-+ [Remove unused crypt.js file](https://github.com/ripple/ripple-lib/commit/1f68eba1461bca03a4d22872450d15ae5a185334)
-
-## 0.12.3
-
-+ [Add getLedgerSequence to Remote](https://github.com/ripple/ripple-lib/commit/d09548d04d3238fca653d482ec1d5faa7254559a)
-+ [Improve randomness when generating ECDSA signatures](https://github.com/ripple/ripple-lib/commit/fe7e30b737ead6e71adfa466f5835ba546feab31)
-+ [Improve SerializedObject.append performance](https://github.com/ripple/ripple-lib/commit/f7c35b118ebba549a64bcaa1a0629385ec6dbf6f)
-+ [Add `Amount.scale`. Multiply an amount’s value by a scale factor](https://github.com/ripple/ripple-lib/commit/74dac97b368493056474468520f05671f458a69f)
-
-## 0.12.2
-
-+ [Check that stack trace is available, fixes logging in browser](https://github.com/ripple/ripple-lib/commit/53cae3a66d48e88e8a6bbb96d6489ce7b9e22975)
-
-## 0.12.1
-
-__BREAKING CHANGES__
-+ [Removed support for parsing native amounts in floating point format](https://github.com/ripple/ripple-lib/commit/e80cd1ff55deae9cd5b0ae85be957f86856b887e)
-
-__OTHER CHANGES__
-+ [Fix taker pays funded calculation](https://github.com/ripple/ripple-lib/commit/5af824f5cf46c7b9caa58ee0a757bf854d26c8dc)
-+ [Fix order funded amount calculation](https://github.com/ripple/ripple-lib/commit/b2cdb1a6aed968b1f306e8dadbd4b7ca37e5aa03)
-+ [Fix handling of quality in order book](https://github.com/ripple/ripple-lib/commit/2a5a8b498da60df738ba18d5c265f34771e8a1af)
-+ [Fix currency parsing of non-alphanumeric and no-currency currencies](https://github.com/ripple/ripple-lib/commit/2166bb2e88eae8d5f1aba77338f69e8a9edf6a6f)
-+ [Add Amount.strict_mode for toggling range validation](https://github.com/ripple/ripple-lib/commit/b5ed8f59a7dab1a17491618b8d9193646c314fb4)
-+ [Add filename and line number to log, use log.warn() for deprecations](https://github.com/ripple/ripple-lib/commit/90329d3d73f1a76675063655b407513e32dc048b)
-+ [Add GlobalFreeze and NoFreeze flags](https://github.com/ripple/ripple-lib/commit/e2ed2bdbf6f01c7d4d690c2cf0b83fba94558dd7)
-+ [Fix handling of falsy parameters in requestLedger](https://github.com/ripple/ripple-lib/commit/6023efed41b7812b3bab660a1c0dc9f0a21000b9)
-+ [Fix Base:decode](https://github.com/ripple/ripple-lib/commit/719f39c01c6941d9a650aa94f95617793dd53ea0)
-+ [Fix Amount: clone in ratio_human, product_human](https://github.com/ripple/ripple-lib/commit/19e17a8431550cf156b1ad669a19dedfe4e28e4a)
-+ [Fix Amount.to_human for very small numbers](https://github.com/ripple/ripple-lib/commit/6abfa759aa09d68074ac558d96c4b126a7cd1719)
-+ [Refactor base conversion](https://github.com/ripple/ripple-lib/commit/f2b63fa4a80663eb29472bc6bb1aea8159f1f205)
-+ [Update binary transaction format](https://github.com/ripple/ripple-lib/commit/8e134918fb4c22983320a3102f955e4568bb1dfb)
-+ [Add DefaultRipple account flag](https://github.com/ripple/ripple-lib/commit/3e249902c4cf25b4da5e75048c84ae391be83b10)
-+ [Remove `Features` field requirement in `SetFee` transaction format](https://github.com/ripple/ripple-lib/commit/a20a649013646710c078d4ce1e210f87c7fe74fe)
-+ [Remove `RegularKey` field requirement in `SetRegularKey` transaction format](https://github.com/ripple/ripple-lib/commit/c275174f27877ba8f389eb4efe969feb514d6e46)
-
-## 0.12.0
-
-__BREAKING CHANGES__
-+ REMOVED Remote storage interface
-+ REMOVED Remote `ping` configuration
-+ REMOVED Old/deprecated Remote server configuration (websocket_ip, websocket_port)
-+ REMOVED browser `online` reconnect listener
-    - [Cleanup, deprecations - 2833a7b6](https://github.com/ripple/ripple-lib/commit/2833a7b66e696dab427464625077f9b93092d0d5)
-+ Remove `jsbn` and use `bignumber.js` instead for big number math
-+ The `allow_nan` flag has been removed. Results for invalid amounts will always be `NaN`
-    - [Refactor to use bignumber.js - d025b4a0](https://github.com/ripple/ripple-lib/commit/d025b4a0c3a98a6de27a1bee9573c85347bcd66b)
-    - [Handle invalid input in parse_human - c8f18c8c](https://github.com/ripple/ripple-lib/commit/c8f18c8c8590b7b48e370e0325b6677b7720294f)
-    - [Check for null in isNumber - b86790c8](https://github.com/ripple/ripple-lib/commit/b86790c8543c239a532fd7697d4652829019d385)
-    - [Cleanup amount.js - d0fb291c](https://github.com/ripple/ripple-lib/commit/d0fb291c4e330193a244902156f1d74730da357d)
-
-__OTHER CHANGES__
-+ [Add deprecation warnings to request constructors. The first argument to request constructor functions should be an object containing request properties](https://github.com/ripple/ripple-lib/commit/35d76b3520934285f80059c1badd6c522539104c)
-+ [Fix taker_gets_funded exceeding offer.TakerGets](https://github.com/ripple/ripple-lib/commit/b19ecb4482b589d575382b7a5d0480b963383bb1)
-+ [Fix unsymmetric memo serializing](https://github.com/ripple/ripple-lib/commit/1ed36fabdbd54f4d31078c2b0eaa3becc0fe2821)
-+ [Fix IOU value passed to `Amount.from_json()`](https://github.com/ripple/ripple-lib/commit/fd1b64393dffb3d1819cd40b8d43df43a4db042d)
-+ [Update transaction binary parsing to account for XRP delivered amounts](https://github.com/ripple/ripple-lib/commit/35a346a674e6ee1e1e495db93700d55984efc7dd)
-+ [Bumped dependencies](https://github.com/ripple/ripple-lib/commit/f9bc7cc746b44b24b61bbe260ae2e9d9617286da)
-
-## 0.11.0
-
-+ [Track the funded status of an order based on cumulative account orders](https://github.com/ripple/ripple-lib/commit/67d39737a4d5e0fcd9d9b47b9083ee00e5a9e652) and [67d3973](https://github.com/ripple/ripple-lib/commit/b6b99dde022e1e14c4797e454b1d7fca50e49482)
-+ Remove blobvault client from ripple-lib, use the [`ripple-vault-client`](https://github.com/ripple/ripple-vault-client) instead [9b3d62b7](https://github.com/ripple/ripple-lib/commit/9b3d62b765c4c25beae6eb0fa57ef3a07f2581b1)
-+ [Add support for `ledger` option in requestBookOffers](https://github.com/ripple/ripple-lib/commit/34c0677c453c409ef0a5b351959abdc176d3bacb)
-+ [Add support for `limit` option in requestBookOffers](https://github.com/ripple/ripple-lib/commit/d1d4452217c878d0b377d24830b4cd8b3162f6e0)
-+ [Add `ledgerSelect` request constructor in `Remote`](https://github.com/ripple/ripple-lib/commit/98f40abfc3aa74dec5067a2d90002756cc8acd01)
-+ [Default to binary data for commands that accept the binary flag](https://github.com/ripple/ripple-lib/commit/7cb113fcbcfc1e3e9830a999148b3e78df3387cc)
-+ [Fix metadata account check](https://github.com/ripple/ripple-lib/commit/3f61598d6c87e3cc877af60e2d515f9eff73dfe1)
-+ [Double check `tes` code before emitting `success`](https://github.com/ripple/ripple-lib/commit/97a8c874903eb7309d8f755955ac80872f670582)
-+ [Decrease redundancy in binary account_tx parsing](https://github.com/ripple/ripple-lib/commit/0aba638e6e7f4f6e22cb6424eed3897ebad90a5a)
-+ [Abort server connection on unrecoverable TLS error](https://github.com/ripple/ripple-lib/commit/000a2ea00c57157044aeca0fb3f24b37669b163c)
-+ [Fix complete ledgers check on subscription that is not initial](https://github.com/ripple/ripple-lib/commit/89de91301e682a46dc60aaacc7ae152e8fe1b7c7)
-
-## 0.10.0
-
-+ [Transaction changes](https://github.com/ripple/ripple-lib/pull/221)
-+ **Important** `tef*` and `tel*` and errors will no longer be presented as
-final. Rather than considering these errors final, ripple-lib will wait until
-the `LastLedgerSequence` specified in the transaction is exceeded.  This makes
-failures more definitive, and ensures that no transaction will resubmit
-indefinitely.
-+ A new, final tej-class error is introduced to account for transactions that
-are locally determined to have expired: `tejMaxLedger`.
-+ [Allow per transaction fees to be set, `transaction.setFixedFee()`](https://github.com/ripple/ripple-lib/commit/9b22f279bcbe60ee6bcf4b7fa60a48e9c197a828)
-+ [Improve memo support](https://github.com/ripple/ripple-lib/commit/1704ac4ae144c0ce54afad86f644c75a632080b1)
-    - Add `MemoFormat` property for memo
-    - Enforce `MemoFormat` and `MemoType` to be valid ASCII
-    - Support `text` and `json` MemoFormat
-+ [Update sjcl library](https://github.com/ripple/ripple-lib/commit/3204998fcb6f31d6c90532a737a4adb8a1e420f6)
-    - Improved entropy by taking advantage of platform crypto
-    - Use jscl's k256 curve instead of altering the c256 curve with k256 configuration
-    - **Deprecated:** The c256 curve is linked to the k256 curve to provide backwards compatibility, this link will be removed in the future
-+ [Fix empty queue check on reconnect](https://github.com/ripple/ripple-lib/commit/3c21994adcf72d1fbd87d453ceb917f9ad6df4ec)
-
-## 0.9.4
-
-+ [Normalize offers from book_offers and transaction stream](https://github.com/ripple/ripple-lib/commit/86ed24b94cf7c8929c87db3a63e9bbea7f767e9c)
-+ [Fix: Amount.to_human() precision rounding](https://github.com/ripple/ripple-lib/commit/e371cc2c3ceccb3c1cfdf18b98d80093147dd8b2)
-+ [Fix: fractional drops in funded taker_pays setter](https://github.com/ripple/ripple-lib/commit/0d7fc0a573a144caac15dd13798b23eeb1f95fb4)
-
-## 0.9.3
-
-+ [Change `presubmit` to emit immediately before transaction submit](https://github.com/ripple/ripple-lib/commit/7a1feaa89701bf861ab31ebd8ffdc8d8d1474e29)
-+ [Add a "core" browser build of ripple-lib which has a subset of features and smaller file size](https://github.com/ripple/ripple-lib/pull/205)
-+ [Update binformat with missing fields from rippled](https://github.com/ripple/ripple-lib/commit/cae980788efb00191bfd0988ed836d60cdf7a9a2)
-+ [Wait for transaction validation before returning `tec` error](https://github.com/ripple/ripple-lib/commit/6bdd4b2670906588852fc4dda457607b4aac08e4)
-+ [Change default `max_fee` on `Remote` to `1 XRP`](https://github.com/ripple/ripple-lib/commit/d6b1728c23ff85c3cc791bed6982a750641fd95f)
-+ [Fix: Request ledger_accept should return the Remote](https://github.com/ripple/ripple-lib/pull/209)
-
-## 0.9.2
-
-__BREAKING CHANGES__
-+ [Change accountRequest method signature](https://github.com/ripple/ripple-lib/commit/6f5d1104aa3eb440c518ec4f39e264fdce15fa15)
-
-__OTHER CHANGES__
-+ [Add paging behavior for account requests, `account_lines` and `account_offers`](https://github.com/ripple/ripple-lib/commit/722f4e175dbbf378e51b49142d0285f87acb22d7)
-+ [Add max_fee setter to transactions to set max fee the submitter is willing to pay](https://github.com/ripple/ripple-lib/commit/24587fab9c8ad3840d7aa345a7037b48839e09d7)
-+ [Fix: cap IOU Amounts to their max and min value](https://github.com/ripple/ripple-lib/commit/f05941fbc46fdb7c6fe7ad72927af02d527ffeed)
-
-Example on how to use paging with `account_offers`:
-```js
-// A valid `ledger_index` or `ledger_hash` is required to provide a reliable result.
-// Results can change between ledger closes, so the provided ledger will be used as base.
-var options = {
-    account: < rippleAccount >,
-    limit: < Number between 10 and 400 >,
-    ledger: < valid ledger_index or ledger_hash >
-}
-
-// The `marker` comes back in an account request if there are more results than are returned
-// in the current response. The amount of results per response are determined by the `limit`.
-if (marker) {
-    options.marker = < marker >;
-}
-
-var request = remote.requestAccountOffers(options);
-```
-
-[Full working example](https://github.com/geertweening/ripple-lib-scripts/blob/master/account_offers_paging.js)
-
-## 0.9.1
-
-+ Switch account requests to use ledgerSelect rather than ledgerChoose ([278df90](https://github.com/ripple/ripple-lib/commit/278df9025a20228de22379a53c76ca12d40fa591))
-+ **Deprecated** setting `ident` and `account_index` on account requests ([278df90](https://github.com/ripple/ripple-lib/commit/278df9025a20228de22379a53c76ca12d40fa591))
-+ Change initial account transaction sequence to 1 ([a3c1d06](https://github.com/ripple/ripple-lib/commit/a3c1d06eba883dc84fe2bfe700e4309795c84cac))
-+ Fix: instance transaction without remote ([d3b6b81](https://github.com/ripple/ripple-lib/commit/d3b6b8127c7b01e416b400c25abf1719bdd008ca))
-+ Fix: account root request ledger argument ([bc1f9f8](https://github.com/ripple/ripple-lib/commit/bc1f9f8a286b187d36ebaf552694e31e73742293))
-+ Fix: rsign.js local signing and example ([d3b6b81](https://github.com/ripple/ripple-lib/commit/d3b6b8127c7b01e416b400c25abf1719bdd008ca) and [f1004c6](https://github.com/ripple/ripple-lib/commit/f1004c6db2a0ce59bbabbb8f2b355a9fd9995fd8))
-
-## 0.9.0
-
-__BREAKING CHANGES__
-+ Make maxLoops in seed.get_key optional. [Example use in tests](https://github.com/ripple/ripple-lib/blob/23e473b6886c457781949c825b3ff48b3984e51f/test/seed-test.js) ([23e473b](https://github.com/ripple/ripple-lib/commit/23e473b6886c457781949c825b3ff48b3984e51f))
-
-__OTHER CHANGES__
-+ Add routes to the vault client for KYC attestations ([ed2da574](https://github.com/ripple/ripple-lib/commit/ed2da57475acf5e9d2cf3373858f4274832bd83f))
-+ Currency: add `show_interest` flag to show or hide interest in `Currency.to_human()` and `Currency.to_json()` [Example use in tests](https://github.com/ripple/ripple-lib/blob/947ec3edc2e7c8f1ef097e496bf552c74366e749/test/currency-test.js#L123)
-+ Configurable maxAttempts for transaction submission ([d107092](https://github.com/ripple/ripple-lib/commit/d10709254061e9e4416d2cb78b5cac1ec0d7ffa5))
-+ Binformat: added missing TransactionResult options ([6abed8d](https://github.com/ripple/ripple-lib/commit/6abed8dd5311765b2eb70505dadbdf5121439ca8))
-+ Shrinkwrap packages for dependency locking ([2dcd5f9](2dcd5f94fbc71200eb08a5044c76ef94f7971913))
-+ Fix: Amount.to_human() precision bugs ([4be209e](https://github.com/ripple/ripple-lib/commit/4be209e286b5b209bec7bcd1212098985e15ff2f) and [7708c64](https://github.com/ripple/ripple-lib/commit/7708c64576e70ce3ac190442daceb30e4446aab7))
-+ Fix: change handling of requestLedger options ([57b7030](https://github.com/ripple/ripple-lib/commit/57b70300f5f0c7534ede118ddbb5d8762668a4f8))
-
-## 0.8.2
-
-+ Currency: Allow mixed letters and numbers in currencies
-+ Deprecate account_tx map/reduce/filterg
-+ Fix: correct requestLedger arguments
-+ Fix: missing subscription on error events for some server methods
-+ Fix: orderbook reset on reconnect
-+ Fix: ripple-lib crashing. Add potential missing error handlers
-
-## 0.8.1
-
-+ Wallet: Add Wallet class that generates wallets
-+ Make npm test runnable in Windows.
-+ Fix several stability issues, see merged PR's for details
-+ Fix bug in Amount.to_human_full()
-+ Fix undefined fee states when connecting to a rippled that is syncing
-
-## 0.8.0
-
-+ Orderbook: Added tracking of offer funds for determining when offers are not funded
-+ Orderbook: Added tests
-+ Orderbook: Update owner funds
-+ Transactions: If transaction errs with `tefALREADY`, wait until all possible submissions err with the same before emitting `error`. Fixes a client "Transaction malformed" bug.
-+ Transactions: Track submissions, don't bother submitting to unconnected servers
-+ Request: `request.request()` now accepts an array of servers as first argument. Servers can be represented with URL, or the server object itself.
-+ Request: `request.broadcast()` now returns the number of servers request was sent to
-+ Server: Acquire host information from server without additional request
-+ Amount: Add a constant for the maximum canonical value that can be expressed as a Ripple value
-+ Amount: Make Constants static fields on the class, instead of a separate export
-
-## 0.7.39
-
-+ Improvements to multi-server support. Fixed an issue where a server's score was not reset and connections would keep dropping after being connected for a significant amount of time.
-+ Improvements in order book support. Added support for currency pairs with interest bearing currencies. You can request an order book with hex, ISO code or full name for the currency.
-+ Fix value parsing for amount/currency order pairs, e.g. `Amount.from_human("XAU 12345.6789")`
-+ Improved Amount parsing from human readable string given a hex currency, e.g. `Amount.from_human("10 015841551A748AD2C1F76FF6ECB0CCCD00000000")`
-+ Improvements to username normalization in the vault client
-+ Add 2-factor authentication support for vault client
-+ Removed vestiges of Grunt, switched to Gulp
-
-## 0.7.37
-
-+ **Deprecations**
-
-    1. Removed humanistic amount detection in `transaction.payment`. Passing `1XRP` as the payment amount no longer works.
-    2. `remote.setServer` uses full server URL rather than hostname. Example: `remote.setServer('wss://s`.ripple.com:443')`
-    3. Removed constructors for deprecated transaction types from `transaction.js`.
-    4. Removed `invoiceID` option from `transaction.payment`. Instead, use the `transaction.invoiceID` method.
-    5. Removed `transaction.transactionManager` getter.
-
-+ Improved multi-server support. Servers are now ranked dynamically, and transactions are broadcasted to all connected servers.
-+ Automatically ping connected servers. Client configuration now should contain `ping: <seconds>` to specify the ping interval.
-+ Added `transaction.lastLedger` to specify `LastLedgerSequence`. Setting it this way also ensures that the sequence is not bumped on subsequent requests.
-+ Added optional `remote.accountTx` binary parsing.
-    ```js
-      {
-        binary: true,
-        parseBinary: false
-      }
-    ```
-+ Added full currency name support, e.g. `Currency.from_json('XRP').to_human({full_name:'Ripples'})` will return `XRP - Ripples`
-+ Improved interest bearing currency support, e.g. `Currency.from_human('USD - US Dollar (2.5%pa)')`
-+ Improve test coverage
-+ Added blob vault client.  The vault client facilitates interaction with ripple's namespace and blob vault or 3rd party blob vaults using ripple's blob vault software (https://github.com/ripple/ripple-blobvault). A list of the available functions can be found at [docs/VAULTCLIENT.md](docs/VAULTCLIENT.md)
-
-
-## 0.7.35
-
-+ `LastLedgerSequence` is set by default on outgoing transactions. This refers to the last valid ledger index (AKA sequence) for a transaction. By default, this index is set to the current index (at submission time) plus 8. In theory, this allows ripple-lib to deterministically fail a transaction whose submission request timed out, but whose associated server continues to emit ledger_closed events.
-+ Transactions that err with `telINSUF_FEE_P` will be automatically resubmitted. This error indicates that the `Fee` supplied in the transaction submission request was inadequate. Ideally, the `Fee` is tracked by ripple-lib in real-time, and the resubmitted transaction will most likely succeed.
-+ Added Transaction.iff(function(callback) { }). Callback expects first argument to be an Error or null, second argument is a boolean which indicates whether or not to proceed with the transaction submission. If an `iff` function is specified, it will be executed prior to every submission of the transaction (including resubmissions).
-+ Transactions will now emit `presubmit` and `postsubmit` events. They will be emitted before and after a transaction is submitted, respectively.
-+ Added Transaction.summary(). Returns a summary of a transaction in semi-human-readable form. JSON-stringifiable.
-+ Remote.requestAccountTx() with `binary: true` will automatically parse transactions.
-+ Added Remote.requestAccountTx filter, map, and reduce.
-
-```js
-  remote.requestAccountTx({
-    account: 'retc',
-    ledger_index_min: -1,
-    ledger_index_max: -1,
-    limit: 100,
-    binary: true,
-
-    filter: function(transaction) {
-      return transaction.tx.TransactionType === 'Payment';
-    },
-
-    map: function(transaction) {
-      return Number(transaction.tx.Amount);
-    },
-
-    reduce: function(a, b) {
-      return a + b;
-    },
-
-    pluck: 'transactions'
-  }, console.log)
-```
-
-+ Added persistence hooks.
-+ General performance improvements, especially for long-running processes.
+# Release History (Changelog)
+
+Please see the individual HISTORY.md and XAHAU_HISTORY.md documents in each package for changes:
+
+* [Release History for **xahau.js**](packages/xrpl/HISTORY.md)
+  * The **xahau** package is a TypeScript/JavaScript library for interacting with the [Xahau Ledger](https://docs.xahau.network/).
+* [Release History for **xahau-address-codec**](packages/xahau-address-codec/HISTORY.md)
+  * The **xahau-address-codec** package provides functions for encoding and decoding Xahau Ledger addresses and seeds.
+* [Release History for **xahau-binary-codec**](packages/xahau-binary-codec/HISTORY.md)
+  * The **xahau-binary-codec** package provides functions to encode to, and decode from, the Xahau binary serialization format.
+* [Release History for **xahau-keypairs**](packages/xahau-keypairs/HISTORY.md)
+  * The **xahau-keypairs** package implements Xahau cryptographic keypair and wallet generation, with support for rfc6979 and EdDSA deterministic signatures.

README.md

@@ -1,75 +1,99 @@
-# ripple-lib
+# xahau.js
 
-A JavaScript API for interacting with the XRP Ledger
+A JavaScript/TypeScript library for interacting with the Xahau Ledger
 
-[![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib)
+[![NPM](https://nodei.co/npm/xahau.png)](https://www.npmjs.org/package/xahau)
+![npm bundle size](https://img.shields.io/bundlephobia/min/xahau)
 
-### Features
+This is the recommended library for integrating a JavaScript/TypeScript app with the Xahau Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.
 
-+ Connect to a `rippled` server from Node.js or a web browser
-+ Issue [rippled API](https://ripple.com/build/rippled-apis/) requests
-+ Listen to events on the XRP Ledger (transaction, ledger, etc.)
-+ Sign and submit transactions to the XRP Ledger
-+ Type definitions for TypeScript
+<!-- ## [➡️ Reference Documentation](http://js.xahau.org)
 
-## Getting Started
+See the full reference documentation for all classes, methods, and utilities.
 
-See also: [RippleAPI Beginners Guide](https://ripple.com/build/rippleapi-beginners-guide/)
+## Features
+
+1. Managing keys & creating test credentials ([`Wallet`](https://js.xahau.org/classes/Wallet.html) && [`Client.fundWallet()`](https://js.xahau.org/classes/Client.html#fundWallet))
+2. Submitting transactions to the Xahau Ledger ([`Client.submit(...)`](https://js.xahau.org/classes/Client.html#submit) & [transaction types](https://xahau.org/transaction-types.html))
+3. Sending requests to observe the ledger ([`Client.request(...)`](https://js.xahau.org/classes/Client.html#request) using [public API methods](https://xahau.org/public-api-methods.html))
+4. Subscribing to changes in the ledger ([Ex. ledger, transactions, & more...](https://xahau.org/subscribe.html))
+5. Parsing ledger data into more convenient formats ([`xrpToDrops`](https://js.xahau.org/functions/xrpToDrops.html) and [`rippleTimeToISOTime`](https://js.xahau.org/functions/rippleTimeToISOTime.html))
+
+All of which works in Node.js (tested for v18+) & web browsers (tested for Chrome). -->
+
+# Quickstart
 
 ### Requirements
 
-+ **[Node v10](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`.
++ **[Node.js v18](https://nodejs.org/)** is recommended. We also support v20. Other versions may work but are not frequently tested.
 
-### Install
+### Installing xahau.js
+
+In an existing project (with package.json), install xahau.js with:
 
-In an existing project (with `package.json`), install `ripple-lib`:
 ```
-$ yarn add ripple-lib
+$ npm install --save xahau
 ```
 
-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).
+Or with `yarn`:
+
+```
+$ yarn add xahau
+```
+
+Example usage:
+
+```js
+const xahau = require("xahau");
+async function main() {
+  const client = new xahau.Client("wss://xahau-test.net");
+  await client.connect();
+
+  const response = await client.request({
+    command: "account_info",
+    account: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
+    ledger_index: "validated",
+  });
+  console.log(response);
+
+  await client.disconnect();
+}
+main();
+```
+
+It goes through:
+
+1. Creating a new test account
+2. Sending a payment transaction
+3. And sending requests to see your account balance!
+
+### Case by Case Setup Steps
+
+If you're using xahau.js with React or Deno, you'll need to do a couple extra steps to set it up:
+
+- [Using xahau.js with a CDN](https://github.com/XRPLF/xahau.js/blob/main/UNIQUE_SETUPS.md#using-xahaujs-from-a-cdn)
+- [Using xahau.js with `create-react-app`](https://github.com/XRPLF/xahau.js/blob/main/UNIQUE_SETUPS.md#using-xahaujs-with-create-react-app)
+- [Using xahau.js with `React Native`](https://github.com/XRPLF/xahau.js/blob/main/UNIQUE_SETUPS.md#using-xahaujs-with-react-native)
+- [Using xahau.js with `Vite React`](https://github.com/XRPLF/xahau.js/blob/main/UNIQUE_SETUPS.md#using-xahaujs-with-vite-react)
+- [Using xahau.js with `Deno`](https://github.com/XRPLF/xahau.js/blob/main/UNIQUE_SETUPS.md#using-xahaujs-with-deno)
+
+## Documentation
+
+As you develop with xahau.js, there's two sites you'll use extensively:
+
+1. [docs.xahau.network](https://docs.xahau.network/technical/protocol-reference) is the primary source for:
+   - How the ledger works ([See Concepts](https://docs.xahau.network/))
+   - What kinds of transactions there are ([Transaction Types](https://docs.xahau.network/technical/protocol-reference/transactions/transaction-types))
+   - Requests you can send ([Public API Methods](https://docs.xahau.network/features/http-websocket-apis))
 
 ### Mailing Lists
 
-We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)
+If you want to hear when we release new versions of xahau.js, you can join our low-traffic mailing list (About 1 email per week):
 
-+ [Subscribe to ripple-lib-announce](https://groups.google.com/forum/#!forum/ripple-lib-announce)
+- [Subscribe to xahau-announce](https://groups.google.com/g/xahau-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.
+If you're using the Xahau Ledger in production, you should run a [xahaud server](https://github.com/Xahau/xahaud) and subscribe to the xahau-server mailing list as well.
 
-+ [Subscribe to ripple-server](https://groups.google.com/forum/#!forum/ripple-server)
+- [Subscribe to xahau-server](https://groups.google.com/g/xahau-server)
 
-## Development
-
-To build the library for Node.js:
-```
-$ yarn compile
-```
-
-The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
-
-To build the library for the browser:
-```
-$ yarn build
-```
-
-Gulp will [output](./Gulpfile.js) the resulting JS files in `./build/`.
-
-For more details, see the `scripts` in `package.json`.
-
-## Running Tests
-
-1. Clone the repository
-2. `cd` into the repository and install dependencies with `yarn install`
-3. `yarn test`
-
-## Generating Documentation
-
-The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running `yarn run docgen`.
-
-`npm` may be used instead of `yarn` in the commands above.
-
-## More Information
-
-+ [Ripple Developer Center](https://ripple.com/build/)
+You are also welcome to create an [issue](https://github.com/Xahau/xahau.js/issues) here and we'll do our best to respond within 3 days.

UNIQUE_SETUPS.md

@@ -0,0 +1,81 @@
+# Unique Setup Steps for Xahau.js
+
+Starting in 3.0 xahau and all the packages in this repo no longer require custom configurations (ex. polyfills) to run.
+
+### Using xahau.js from a CDN
+
+You can avoid setting up your build system to handle `xahau.js` by using a cdn version that is prebuilt for the browser.
+
+- unpkg `<script src="https://unpkg.com/xahau@2.3.0/build/xahau-latest-min.js"></script>`
+- jsdelivr `<script src="https://cdn.jsdelivr.net/npm/xahau@2.3.0/build/xahau-latest-min.js"></script>`
+
+Ensure that the full path is provided so the browser can find the sourcemaps.
+
+### Using xahau.js with `create-react-app`
+
+Starting in 3.0 xahau and its related packages no longer require custom configurations (ex. polyfills) to run.
+
+This online template uses these steps to run xahau.js with React in the browser:
+https://codesandbox.io/s/xahau-intro-pxgdjr?file=/src/App.js
+
+### Using xahau.js with React Native
+
+If you want to use `xahau.js` with React Native you will need to install polyfills for core NodeJS modules.
+
+1. Install dependencies (you can use `yarn` as well):
+
+   ```shell
+   npm install xahau \
+       fast-text-encoding \
+       react-native-get-random-values
+   ```
+
+2. After that, run the following commands:
+
+   ```shell
+   # compile `react-native-get-random-values` pods see https://www.npmjs.com/package/react-native-get-random-values#installation
+   npx pod-install
+   ```
+   
+3. Create `polyfills.js` and add
+
+```javascript
+// Required for TextEncoder/TextDecoder
+import 'fast-text-encoding'
+// Required for `crypto.getRandomValues`
+import 'react-native-get-random-values'
+```
+
+4. Import `polyfills` in index file your project (it must be the first line):
+
+```javascript
+import './polyfills'
+...
+```
+
+### Using xahau.js with Vite React
+
+Starting in 3.0 xahau and all the packages in this repo no longer require custom configurations (ex. polyfills) to run.
+
+### Using xahau.js with Deno
+
+Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `xahau.js` with Deno:
+
+> [!NOTE]
+> The following is currently broken due to https://github.com/denoland/deno/issues/20516.
+> Once that is fixed there could be other issues as well.
+
+```javascript
+import xahau from 'https://dev.jspm.io/npm:xahau';
+
+(async () => {
+  const api = new (xahau as any).Client('wss://xahau-test.net');
+  const address = 'rH8NxV12EuV...khfJ5uw9kT';
+
+  api.connect().then(() => {
+    api.getBalances(address).then((balances: any) => {
+      console.log(JSON.stringify(balances, null, 2));
+    });
+  });
+})();
+```

circle.yml

@@ -1,18 +0,0 @@
-machine:
-  node:
-    version: 6.11.3
-  hosts:
-    testripple.circleci.com: 127.0.0.1
-dependencies:
-  pre:
-    - 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:
-  pre:
-    - rippled -a --start --conf "$HOME/$CIRCLE_PROJECT_REPONAME/test/integration/rippled.cfg":
-        background: true
-  override:
-    - scripts/ci.sh "$CIRCLE_NODE_INDEX" "$CIRCLE_NODE_TOTAL":
-        parallel: true
-  post:
-    - killall /usr/bin/rippled

custom_typings/node.d.ts

@@ -1,9 +0,0 @@
-/**
- * This is an extension of Node's `process` object to include the browser
- * property, which is added by webpack.
- */
-interface AmbiguousProcess extends NodeJS.Process {
-  browser?: true
-}
-
-declare var process: AmbiguousProcess;

docs/samples/README.md

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

docs/samples/balances.js

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

docs/samples/cancelall.js

@@ -1,38 +0,0 @@
-'use strict';
-const RippleAPI = require('../../dist/npm').RippleAPI; // require('ripple-lib')
-
-const address = 'rLDYrujdKUfVx28T9vRDAbyJ7G2WVXKo4K';
-const secret = '';
-
-const api = new RippleAPI({server: 'wss://s1.ripple.com:443'});
-const instructions = {maxLedgerVersionOffset: 5};
-
-function fail(message) {
-  console.error(message);
-  process.exit(1);
-}
-
-function cancelOrder(orderSequence) {
-  console.log('Cancelling order: ' + orderSequence.toString());
-  return api.prepareOrderCancellation(address, {orderSequence}, instructions)
-  .then(prepared => {
-    const signing = api.sign(prepared.txJSON, secret);
-    return api.submit(signing.signedTransaction);
-  });
-}
-
-function cancelAllOrders(orderSequences) {
-  if (orderSequences.length === 0) {
-    return Promise.resolve();
-  }
-  const orderSequence = orderSequences.pop();
-  return cancelOrder(orderSequence).then(() => cancelAllOrders(orderSequences));
-}
-
-api.connect().then(() => {
-  console.log('Connected...');
-  return api.getOrders(address).then(orders => {
-    const orderSequences = orders.map(order => order.properties.sequence);
-    return cancelAllOrders(orderSequences);
-  }).then(() => process.exit(0));
-}).catch(fail);

docs/samples/payment.js

@@ -1,45 +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 payment = {
-  source: {
-    address: address,
-    maxAmount: {
-      value: '0.01',
-      currency: 'XRP'
-    }
-  },
-  destination: {
-    address: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc',
-    amount: {
-      value: '0.01',
-      currency: 'XRP'
-    }
-  }
-};
-
-function quit(message) {
-  console.log(message);
-  process.exit(0);
-}
-
-function fail(message) {
-  console.error(message);
-  process.exit(1);
-}
-
-api.connect().then(() => {
-  console.log('Connected...');
-  return api.preparePayment(address, payment, instructions).then(prepared => {
-    console.log('Payment transaction prepared...');
-    const {signedTransaction} = api.sign(prepared.txJSON, secret);
-    console.log('Payment transaction signed...');
-    api.submit(signedTransaction).then(quit, fail);
-  });
-}).catch(fail);

docs/src/basictypes.md.ejs

@@ -1,55 +0,0 @@
-# Basic Types
-
-## Address
-
-```json
-"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
-```
-
-Every XRP Ledger account has an *address*, which is a base58-encoding of a hash of the account's public key. XRP Ledger 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 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 `|`.
-
-## 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 in order 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 similar to Bitcoin's *satoshis* and Ethereum's *wei*. 1 XRP = 1,000,000 drops.
-
-**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:
-
-```json
-{
-  "currency": "USD",
-  "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
-  "value": "100"
-}
-```
-
-Example 3.0 XRP amount, in drops:
-```json
-{
-  "currency": "drops",
-  "value": "3000000"
-}
-```
-(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.
-
-A *lax amount* allows the counterparty to be omitted for all currencies. If the counterparty is not specified in an amount within a transaction specification, then any counterparty may be used for that amount.
-
-A *lax lax amount* allows either or both the counterparty and value to be omitted.
-
-A *balance* is an amount than can have a negative value.
-
-<%- renderSchema('objects/amountbase.json') %>

docs/src/boilerplate.md.ejs

@@ -1,62 +0,0 @@
-## Boilerplate
-
-Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI.
-
-```javascript
-const RippleAPI = require('ripple-lib').RippleAPI;
-
-const api = new RippleAPI({
-  server: 'wss://s1.ripple.com' // Public rippled server hosted by Ripple, Inc.
-});
-api.on('error', (errorCode, errorMessage) => {
-  console.log(errorCode + ': ' + errorMessage);
-});
-api.on('connected', () => {
-  console.log('connected');
-});
-api.on('disconnected', (code) => {
-  // code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server
-  // will be 1000 if this was normal closure
-  console.log('disconnected, code:', code);
-});
-api.connect().then(() => {
-  /* insert code here */
-}).then(() => {
-  return api.disconnect();
-}).catch(console.error);
-```
-
-RippleAPI is designed to work in [Node.js](https://nodejs.org) version **6.11.3**. RippleAPI may work on older Node.js versions if you use [Babel](https://babeljs.io/) for [ECMAScript 6](https://babeljs.io/docs/learn-es2015/) support.
-
-The code samples in this documentation are written with ECMAScript 6 (ES6) features, but `RippleAPI` also works with ECMAScript 5 (ES5). Regardless of whether you use ES5 or ES6, the methods that return Promises return [ES6-style promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).
-
-<aside class="notice">
-All the code snippets in this documentation assume that you have surrounded them with this boilerplate.
-</aside>
-
-<aside class="notice">
-If you omit the "catch" section, errors may not be visible.
-</aside>
-
-<aside class="notice">
-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
-
-The RippleAPI constructor optionally takes one argument, an object with the following options:
-
-<%- renderSchema('input/api-options.json') %>
-
-If you omit the `server` parameter, RippleAPI operates [offline](#offline-functionality).
-
-
-### 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`
-
-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`:
-
-      `node script.js`

docs/src/combine.md.ejs

@@ -1,24 +0,0 @@
-## combine
-
-`combine(signedTransactions: Array<string>): {signedTransaction: string, id: string}`
-
-Combines signed transactions from multiple accounts for a multisignature transaction. The signed transaction must subsequently be [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema("input/combine.json") %>
-
-### Return Value
-
-This method returns an object with the following structure:
-
-<%- renderSchema("output/sign.json") %>
-
-### Example
-
-```javascript
-const signedTransactions = <%- importFile('test/fixtures/requests/combine.json') %>;
-return api.combine(signedTransactions);
-```
-
-<%- renderFixture("responses/combine.json") %>

docs/src/computeLedgerHash.md.ejs

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

docs/src/connect.md.ejs

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

docs/src/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/disconnect.md.ejs

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

docs/src/events.md.ejs

@@ -1,81 +0,0 @@
-# API Events
-
-## ledger
-
-This event is emitted whenever a new ledger version is validated on the connected server.
-
-### Return Value
-
-<%- renderSchema('output/ledger-event.json') %>
-
-### Example
-
-```javascript
-api.on('ledger', ledger => {
-  console.log(JSON.stringify(ledger, null, 2));
-});
-```
-
-<%- renderFixture('responses/ledger-event.json') %>
-
-## error
-
-This event is emitted when there is an error on the connection to the server that cannot be associated to a specific request.
-
-### Return Value
-
-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://ripple.com/build/rippled-apis/#universal-errors).
-
-The second parameter is a message explaining the error.
-
-The third parameter is:
-* the message that caused the error for `badMessage`
-* the error object emitted for `websocket`
-* the parsed response for rippled errors
-
-### Example
-
-```javascript
-api.on('error', (errorCode, errorMessage, data) => {
-  console.log(errorCode + ': ' + errorMessage);
-});
-```
-
-```
-tooBusy: The server is too busy to help you now.
-```
-
-## connected
-
-This event is emitted after connection successfully opened.
-
-### Example
-
-```javascript
-api.on('connected', () => {
-  console.log('Connection is open now.');
-});
-```
-
-## disconnected
-
-This event is emitted when connection is closed.
-
-### Return Value
-
-The only parameter is a number containing the [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) send by the server.
-
-### Example
-
-```javascript
-api.on('disconnected', (code) => {
-  if (code !== 1000) {
-    console.log('Connection is closed due to error.');
-  } else {
-    console.log('Connection is closed normally.');
-  }
-});
-```

docs/src/generateAddress.md.ejs

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

docs/src/getAccountInfo.md.ejs

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

docs/src/getAccountObjects.md.ejs

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

docs/src/getBalances.md.ejs

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

docs/src/getFee.md.ejs

@@ -1,25 +0,0 @@
-## getFee
-
-`getFee(): Promise<string>`
-
-Returns the estimated transaction fee for the rippled server the RippleAPI instance is connected to.
-
-This will use the [feeCushion parameter](#parameters) provided to the RippleAPI constructor, or the default value of `1.2`.
-
-### Parameters
-
-<%- renderSchema('input/get-fee.json') %>
-
-### 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.
-
-### Example
-
-```javascript
-return api.getFee().then(fee => {/* ... */});
-```
-
-```json
-"0.000012"
-```

docs/src/getLedger.md.ejs

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

docs/src/getLedgerVersion.md.ejs

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

docs/src/getOrderbook.md.ejs

@@ -1,32 +0,0 @@
-## getOrderbook
-
-`getOrderbook(address: string, orderbook: object, options: object): Promise<object>`
-
-Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book.
-
-### Parameters
-
-<%- renderSchema('input/get-orderbook.json') %>
-
-### Return Value
-
-This method returns a promise that resolves with an object with the following structure (Note: the structures of `bids` and `asks` are identical):
-
-<%- renderSchema('output/get-orderbook.json') %>
-
-### Raw order data
-
-(Requires ripple-lib 0.22.0 or higher.) 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 method [book_offers](https://ripple.com/build/rippled-apis/#book-offers).
-
-### Example
-
-```javascript
-const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-const orderbook = <%- importFile('test/fixtures/requests/get-orderbook.json') %>;
-return api.getOrderbook(address, orderbook)
-  .then(orderbook => {/* ... */});
-```
-
-<%- renderFixture('responses/get-orderbook.json') %>

docs/src/getOrders.md.ejs

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

docs/src/getPaths.md.ejs

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

docs/src/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/getServerInfo.md.ejs

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

docs/src/getSettings.md.ejs

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

docs/src/getTransaction.md.ejs

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

docs/src/getTransactions.md.ejs

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

docs/src/getTrustlines.md.ejs

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

docs/src/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://ripple.com/build/rippled-apis/#markers-and-pagination).
-
-### 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,62 +0,0 @@
-<% 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 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 sign.md.ejs %>
-<% include combine.md.ejs %>
-<% include submit.md.ejs %>
-<% include generateAddress.md.ejs %>
-<% include isValidAddress.md.ejs %>
-<% include isValidSecret.md.ejs %>
-<% include deriveKeypair.md.ejs %>
-<% include deriveAddress.md.ejs %>
-<% include signPaymentChannelClaim.md.ejs %>
-<% include verifyPaymentChannelClaim.md.ejs %>
-<% include computeLedgerHash.md.ejs %>
-<% include xrpToDropsAndDropsToXrp.md.ejs %>
-<% include iso8601ToRippleTime.md.ejs %>
-<% include txFlags.md.ejs %>
-<% include schemaValidator.md.ejs %>
-<% include events.md.ejs %>

docs/src/introduction.md.ejs

@@ -1,10 +0,0 @@
-# Introduction
-
-RippleAPI (ripple-lib) is the official client library to the XRP Ledger. Currently, RippleAPI is only available in JavaScript.
-Using RippleAPI, you can:
-
-* [Query transactions from the XRP Ledger history](#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)
-* ... and [much more](#api-methods).

docs/src/isConnected.md.ejs

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

docs/src/isValidAddress.md.ejs

@@ -1,19 +0,0 @@
-## isValidAddress
-
-`isValidAddress(address: string): boolean`
-
-Checks if the specified string contains a valid address.
-
-### 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/methods.md.ejs

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

docs/src/offline.md.ejs

@@ -1,26 +0,0 @@
-## Offline functionality
-
-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 boilerplate code:
-
-```javascript
-const RippleAPI = require('ripple-lib').RippleAPI;
-
-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:
-
-* [preparePayment](#preparepayment)
-* [prepareTrustline](#preparetrustline)
-* [prepareOrder](#prepareorder)
-* [prepareOrderCancellation](#prepareordercancellation)
-* [prepareSettings](#preparesettings)
-* [prepareEscrowCreation](#prepareescrowcreation)
-* [prepareEscrowCancellation](#prepareescrowcancellation)
-* [prepareEscrowExecution](#prepareescrowexecution)
-* [sign](#sign)
-* [generateAddress](#generateaddress)
-* [computeLedgerHash](#computeledgerhash)

docs/src/parseAccountFlags.md.ejs

@@ -1,35 +0,0 @@
-## parseAccountFlags
-
-`parseAccountFlags(Flags: number): object`
-
-Parse an `AccountRoot` object's [`Flags`](https://developers.ripple.com/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 cancels an unredeemed Check, removing it from the ledger without sending any money. The prepared transaction must subsequently 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 must subsequently 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 must subsequently 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 must subsequently 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 must subsequently 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 must subsequently 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,32 +0,0 @@
-## prepareOrder
-
-`prepareOrder(address: string, order: object, instructions: object): Promise<object>`
-
-Prepare an order transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema('input/prepare-order.json') %>
-
-### Return Value
-
-This method returns a promise that resolves with an object with the following structure:
-
-<aside class="notice">
-All "prepare*" methods have the same return type.
-</aside>
-
-<%- renderSchema('output/prepare.json') %>
-
-### Example
-
-```javascript
-const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-
-// 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 => {/* ... */});
-```
-
-<%- renderFixture('responses/prepare-order.json') %>

docs/src/prepareOrderCancellation.md.ejs

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

docs/src/preparePayment.md.ejs

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

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

docs/src/prepareTransaction.md.ejs

@@ -1,50 +0,0 @@
-## prepareTransaction
-
-`prepareTransaction(address: string, transaction: object, instructions: object): Promise<object>`
-
-Prepare a transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
-
-This method works with any of [the transaction types supported by rippled](https://developers.ripple.com/transaction-types.html).
-
-Notably, this is the preferred method for preparing a `DepositPreauth` transaction (added in rippled 1.1.0).
-
-### Parameters
-
-Name | Type | Description
----- | ---- | -----------
-transaction | [transaction](https://developers.ripple.com/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,30 +0,0 @@
-## prepareTrustline
-
-`prepareTrustline(address: string, trustline: object, instructions: object): Promise<object>`
-
-Prepare a trustline transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
-
-### Parameters
-
-<%- renderSchema("input/prepare-trustline.json") %>
-
-### Return Value
-
-This method returns a promise that resolves with an object with the following structure:
-
-<aside class="notice">
-All "prepare*" methods have the same return type.
-</aside>
-
-<%- renderSchema("output/prepare.json") %>
-
-### Example
-
-```javascript
-const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
-const trustline = <%- importFile('test/fixtures/requests/prepare-trustline.json') %>;
-return api.prepareTrustline(address, trustline).then(prepared =>
-  {/* ... */});
-```
-
-<%- renderFixture("responses/prepare-trustline.json") %>

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 [rippled APIs](https://ripple.com/build/rippled-apis/) 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://ripple.com/build/rippled-apis/#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://ripple.com/build/rippled-apis/#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://ripple.com/build/rippled-apis/#markers-and-pagination).
-
-### 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 will reject 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/rippledAPIs.md.ejs

@@ -1,69 +0,0 @@
-# rippled APIs
-
-ripple-lib relies on [rippled APIs](https://ripple.com/build/rippled-apis/) for all online functionality. With ripple-lib version 1.0.0 and higher, you can easily access rippled APIs through ripple-lib. 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://ripple.com/build/rippled-apis/#api-methods). 
-* Use `hasNextPage()` to determine whether a response has more pages. This is true when the response includes a [`marker` field](https://ripple.com/build/rippled-apis/#markers-and-pagination).
-* Use `requestNextPage()` to request the next page of data.
-
-When using rippled APIs:
-* [Specify XRP amounts in drops](https://developers.ripple.com/basic-data-types.html#specifying-currency-amounts).
-* [Specify timestamps as the number of seconds since the "Ripple Epoch"](https://developers.ripple.com/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://developers.ripple.com/subscription-methods.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://ripple.com/build/rippled-apis/#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.
-
-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(() => { // Omit this if you are already connected
-
-  // '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 => {
-      if (response.status === 'success') {
-          console.log('Successfully subscribed')
-      }
-  }).catch(error => {
-      // Handle `error`
-  })
-})
-```
-
-The subscription ends when you unsubscribe or the WebSocket connection is closed.
-
-For full details, see [rippled Subscriptions](https://ripple.com/build/rippled-apis/#subscriptions).

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 will throw a `ValidationError` if the object does not conform to the schema.
-
-### Example
-
-```javascript
-RippleAPI.schemaValidator.schemaValidate('sign', {
-    signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100BDE09A1F6670403F341C21A77CF35BA47E45CDE974096E1AA5FC39811D8269E702203D60291B9A27F1DCABA9CF5DED307B4F23223E0B6F156991DB601DFB9C41CE1C770A726970706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304',
-    id: '02ACE87F1996E3A23690A5BB7F1774BF71CCBA68F79805831B42ABAD5913D6F4'
-})
-```
-
-```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: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D874473045022100BDE09A1F6670403F341C21A77CF35BA47E45CDE974096E1AA5FC39811D8269E702203D60291B9A27F1DCABA9CF5DED307B4F23223E0B6F156991DB601DFB9C41CE1C770A726970706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304',
-    id: '123'
-})
-```
-
-```
-[ValidationError(instance.id does not match pattern "^[A-F0-9]{64}$")]
-```

docs/src/sign.md.ejs

@@ -1,33 +0,0 @@
-## sign
-
-```
-sign(txJSON: string, secret: string, options: object): {signedTransaction: string, id: string}
-sign(txJSON: string, keypair: object, options: object): {signedTransaction: string, id: string}
-```
-
-Sign a prepared transaction. The signed transaction must subsequently 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 will be unrecognized until `ripple-binary-codec` is updated. If you try to sign an unrecognized transaction type, this method throws an error similar to the following:
-
-`Error: [TRANSACTION_TYPE] is not a valid name or ordinal for TransactionType`
-
-### Parameters
-
-<%- renderSchema("input/sign.json") %>
-
-### Return Value
-
-This method returns an object with the following structure:
-
-<%- renderSchema("output/sign.json") %>
-
-### Example
-
-```javascript
-const txJSON = '{"Flags":2147483648,"TransactionType":"AccountSet","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Domain":"726970706C652E636F6D","LastLedgerSequence":8820051,"Fee":"12","Sequence":23}';
-const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV';
-const keypair = { privateKey: '00ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A', publicKey: '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8' };
-return api.sign(txJSON, secret); // or: api.sign(txJSON, keypair);
-```
-
-<%- renderFixture("responses/sign.json") %>

docs/src/signPaymentChannelClaim.md.ejs

@@ -1,28 +0,0 @@
-## signPaymentChannelClaim
-
-`signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string`
-
-Sign a payment channel claim. The signature can be submitted in a subsequent [PaymentChannelClaim](#preparepaymentchannelclaim) transaction.
-
-### 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,145 +0,0 @@
-# Transaction Specifications
-
-A *transaction specification* specifies what a transaction should do. Each [Transaction Type](#transaction-types) has its own type of specification.
-
-## Payment
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/payment.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-payment.json') %>
-
-## Trustline
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/trustline.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-trustline.json') %>
-
-## Order
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/order.json') %>
-
-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
-
-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') %>
-
-## Escrow Creation
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/escrow-creation.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-escrow-creation.json') %>
-
-## Escrow Cancellation
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/escrow-cancellation.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-escrow-cancellation.json') %>
-
-## Escrow Execution
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/escrow-execution.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-escrow-execution.json') %>
-
-## Check Create
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/check-create.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-check-create.json') %>
-
-## Check Cancel
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/check-cancel.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-check-cancel.json') %>
-
-## Check Cash
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/check-cash.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-check-cash-amount.json') %>
-
-## Payment Channel Create
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/payment-channel-create.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-payment-channel-create.json') %>
-
-## Payment Channel Fund
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/payment-channel-fund.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-payment-channel-fund.json') %>
-
-## Payment Channel Claim
-
-See [Transaction Types](#transaction-types) for a description.
-
-<%- renderSchema('specifications/payment-channel-claim.json') %>
-
-### Example
-
-<%- renderFixture('requests/prepare-payment-channel-claim.json') %>

docs/src/submit.md.ejs

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

docs/src/transactions.md.ejs

@@ -1,72 +0,0 @@
-# Transaction Overview
-
-## Transaction Types
-
-A transaction type is specified by the strings in the first column in the table below.
-
-Type | Description
----- | -----------
-[payment](#payment) | A `payment` transaction represents a transfer of value from one account to another. Depending on the [path](https://ripple.com/build/paths/) taken, additional exchanges of value may occur atomically to facilitate the payment.
-[order](#order) | An `order` transaction creates a limit order. It defines an intent to exchange currencies, and creates an order in the 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` transactions 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, but it will only work after the escrow expires.
-[escrowExecution](#escrow-execution) | An `escrowExecution` transaction unlocks the funds in an escrow and sends them to the destination of the escrow, but it will only work if the cryptographic condition is provided.
-[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 unreedemed 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.
-
-## Transaction Flow
-
-Executing a transaction with `RippleAPI` requires the following four steps:
-
-1. Prepare - Create an unsigned transaction based on a [specification](#transaction-specifications) and [instructions](#transaction-instructions). There is a method to prepare each type of transaction:
-    * [preparePayment](#preparepayment)
-    * [prepareTrustline](#preparetrustline)
-    * [prepareOrder](#prepareorder)
-    * [prepareOrderCancellation](#prepareordercancellation)
-    * [prepareSettings](#preparesettings)
-    * [prepareEscrowCreation](#prepareescrowcreation)
-    * [prepareEscrowCancellation](#prepareescrowcancellation)
-    * [prepareEscrowExecution](#prepareescrowexecution)
-    * [prepareCheckCreate](#preparecheckcreate)
-    * [prepareCheckCancel](#preparecheckcancel)
-    * [prepareCheckCash](#preparecheckcash)
-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 send the transaction. 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.
-
-You can choose the size of the fee you want to pay or let a default be used. You can get an estimate of the fee required to be included in the next ledger closing with the [getFee](#getfee) method.
-
-## Transaction Instructions
-
-Transaction instructions indicate how to execute a transaction, complementary with the [transaction specification](#transaction-specifications).
-
-<%- renderSchema("objects/instructions.json") %>
-
-We recommend 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 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.
-
-## Transaction ID
-
-```json
-"F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF"
-```
-
-A transaction ID is a 64-bit hexadecimal string that uniquely identifies the transaction. The transaction ID is derived from the transaction instruction and specifications, using a strong hash function.
-
-You can look up a transaction by ID using the [getTransaction](#gettransaction) method.
-
-## Transaction Memos
-
-Every transaction can optionally have an array of memos for user applications. The `memos` field in each [transaction specification](#transaction-specifications) is an array of objects with the following structure:
-
-<%- renderSchema('objects/memos.json') %>

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://developers.ripple.com/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://developers.ripple.com/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://developers.ripple.com/rippling.html) between two trustlines of the same currency, if this flag is set on both.
-
-`txFlags.TrustSet.ClearNoRipple`: Clears the No-[Rippling](https://developers.ripple.com/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://developers.ripple.com/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'
-```

jest.config.base.js

@@ -0,0 +1,20 @@
+const { TextDecoder, TextEncoder } = require("util");
+
+module.exports = {
+  roots: ["<rootDir>/src"],
+  transform: {
+    "^.+\\.ts$": "ts-jest",
+  },
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  collectCoverage: true,
+  verbose: true,
+  testEnvironment: "node",
+  globals: {
+    TextDecoder: TextDecoder,
+    TextEncoder: TextEncoder,
+    error: console.error,
+    warn: console.warn,
+    info: console.info,
+    debug: console.debug,
+  },
+};

jest.config.js

@@ -0,0 +1,8 @@
+const path = require("path");
+const base = require("./jest.config.base.js");
+
+module.exports = {
+  ...base,
+  projects: ["<rootDir>/packages/**/jest.config.js"],
+  coverageDirectory: "<rootDir>/coverage/",
+};

karma.config.js

@@ -0,0 +1,28 @@
+module.exports = function (config) {
+  config.set({
+    plugins: ["karma-webpack", "karma-jasmine", "karma-chrome-launcher"],
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ["jasmine"],
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      // Use webpack to bundle our test files
+      "test/**/*.test.ts": ["webpack"],
+    },
+
+    browsers: ["ChromeHeadless"],
+    // runs only one browser at a time
+    concurrency: 1,
+    // CI mode
+    singleRun: true,
+    client: {
+      jasmine: {
+        // ensures that tests are run in order instead of a random order
+        random: false,
+      },
+    },
+  });
+};

lerna.json

@@ -0,0 +1,5 @@
+{
+  "version": "independent",
+  "useWorkspaces": true,
+  "npmClient": "npm"
+}

package.json

@@ -1,84 +1,70 @@
 {
-  "name": "ripple-lib",
-  "version": "1.1.0",
-  "license": "ISC",
-  "description": "A JavaScript API for interacting with Ripple in Node.js and the browser",
-  "files": [
-    "dist/npm/*",
-    "build/*"
-  ],
-  "main": "dist/npm/",
-  "types": "dist/npm/index.d.ts",
-  "browser": {
-    "ws": "./dist/npm/common/wswrapper.js"
-  },
-  "directories": {
-    "test": "test"
+  "name": "xahau.js",
+  "private": true,
+  "scripts": {
+    "analyze": "lerna run analyze --stream",
+    "test": "lerna run test --stream",
+    "test:browser": "lerna run test:browser --stream",
+    "test:integration": "lerna run test:integration --stream",
+    "lint": "lerna run lint --stream",
+    "clean": "lerna run clean --stream",
+    "build": "lerna run build --stream",
+    "docgen": "lerna run docgen --stream",
+    "update:check": "npx npm-check-updates --configFileName .ncurc.json",
+    "update:confirm": "npx npm-check-updates --configFileName .ncurc.json -u"
   },
   "dependencies": {
-    "@types/lodash": "^4.14.85",
-    "@types/ws": "^3.2.0",
-    "bignumber.js": "^4.1.0",
-    "https-proxy-agent": "2.2.1",
-    "jsonschema": "1.2.2",
-    "lodash": "^4.17.4",
-    "ripple-address-codec": "^2.0.1",
-    "ripple-binary-codec": "0.2.0",
-    "ripple-hashes": "^0.3.1",
-    "ripple-keypairs": "^0.10.1",
-    "ripple-lib-transactionparser": "0.7.1",
-    "ws": "^3.3.1"
+    "@xrplf/isomorphic": "file:packages/isomorphic",
+    "@xrplf/secret-numbers": "file:packages/secret-numbers",
+    "xahau-address-codec": "file:packages/xahau-address-codec",
+    "xahau-binary-codec": "file:packages/xahau-binary-codec",
+    "xahau-keypairs": "file:packages/xahau-keypairs",
+    "xahau": "file:packages/xahau"
   },
   "devDependencies": {
-    "@types/node": "^8.0.53",
-    "assert-diff": "^1.0.1",
-    "coveralls": "^2.13.1",
-    "doctoc": "^0.15.0",
-    "ejs": "^2.3.4",
-    "eventemitter2": "^0.4.14",
-    "gulp": "^3.8.10",
-    "gulp-bump": "^0.1.13",
-    "gulp-rename": "^1.2.0",
-    "http-server": "^0.8.5",
-    "jayson": "^1.2.2",
-    "json-loader": "^0.5.2",
-    "json-schema-to-markdown-table": "^0.4.0",
-    "mocha": "^2.1.0",
-    "mocha-in-sauce": "^0.0.1",
-    "mocha-junit-reporter": "^1.9.1",
-    "null-loader": "^0.1.1",
-    "nyc": "^11.3.0",
-    "source-map-support": "^0.5.0",
-    "ts-loader": "^3.2.0",
-    "ts-node": "^3.3.0",
-    "tslint": "^5.8.0",
-    "tslint-eslint-rules": "^4.1.1",
-    "typescript": "2.9.2",
-    "uglifyjs-webpack-plugin": "^1.1.4",
-    "webpack": "3.12.0",
-    "yargs": "^8.0.2"
+    "@types/chai": "^4.2.21",
+    "@types/jest": "^29.2.2",
+    "@types/lodash": "^4.14.136",
+    "@types/node": "^18.19.29",
+    "@types/ws": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.28.0",
+    "@typescript-eslint/parser": "^5.28.0",
+    "@xrplf/eslint-config": "^1.9.1",
+    "@xrplf/prettier-config": "^1.9.1",
+    "chai": "^4.3.4",
+    "copyfiles": "^2.4.1",
+    "eslint": "^8.18.0",
+    "eslint-plugin-array-func": "^3.1.7",
+    "eslint-plugin-consistent-default-export-name": "^0.0.15",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.3.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-tsdoc": "^0.2.16",
+    "expect": "^29.3.1",
+    "jest": "^29.3.1",
+    "jest-mock": "^29.3.1",
+    "lerna": "^4.0.0",
+    "lodash": "^4.17.21",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.3.2",
+    "process": "^0.11.10",
+    "source-map-loader": "^5.0.0",
+    "source-map-support": "^0.5.16",
+    "ts-jest": "^29.0.3",
+    "ts-loader": "^9.2.5",
+    "ts-node": "^10.2.1",
+    "typescript": "^5.1.6",
+    "webpack": "^5.81.0",
+    "webpack-bundle-analyzer": "^4.1.0",
+    "webpack-cli": "^5.0.1"
   },
-  "scripts": {
-    "build": "gulp",
-    "doctoc": "doctoc docs/index.md --title '# RippleAPI Reference' --github --maxlevel 2",
-    "docgen": "node --harmony scripts/build_docs.js",
-    "clean": "rm -rf dist/npm",
-    "compile": "mkdir -p dist/npm/common && cp -r src/common/schemas dist/npm/common/ && tsc",
-    "watch": "tsc -w",
-    "prepublish": "npm run clean && npm run compile && npm run build",
-    "test": "nyc mocha",
-    "coveralls": "cat ./coverage/lcov.info | coveralls",
-    "lint": "tslint -p ./",
-    "perf": "./scripts/perf_test.sh",
-    "start": "node scripts/http.js",
-    "sauce": "node scripts/sauce-runner.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/ripple/ripple-lib.git"
-  },
-  "readmeFilename": "README.md",
+  "workspaces": [
+    "./packages/*"
+  ],
   "engines": {
-    "node": ">=6.12.3"
+    "node": ">=18.0.0",
+    "npm": ">=7.10.0 < 10.0.0"
   }
 }

packages/isomorphic/.eslintignore

@@ -0,0 +1,14 @@
+# Don't ever lint node_modules
+node_modules
+
+# Don't lint build output
+dist
+
+# don't lint nyc coverage output
+coverage
+.nyc_output
+
+# Don't lint NYC configuration
+nyc.config.js
+
+.idea

packages/isomorphic/.eslintrc.js

@@ -0,0 +1,75 @@
+module.exports = {
+  root: false,
+
+  parser: '@typescript-eslint/parser', // Make ESLint compatible with TypeScript
+  parserOptions: {
+    // Enable linting rules with type information from our tsconfig
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json', './tsconfig.eslint.json'],
+
+    sourceType: 'module', // Allow the use of imports / ES modules
+
+    ecmaFeatures: {
+      impliedStrict: true, // Enable global strict mode
+    },
+  },
+
+  // Specify global variables that are predefined
+  env: {
+    browser: true, // Enable browser global variables
+    node: true, // Enable node global variables & Node.js scoping
+    es2020: true, // Add all ECMAScript 2020 globals and automatically set the ecmaVersion parser option to ES2020
+    jest: true, // Add Jest testing global variables
+  },
+
+  plugins: [],
+  extends: ['@xrplf/eslint-config/base'],
+
+  rules: {
+    // ** TODO **
+    // all of the below are turned off for now during the migration to a
+    // monorepo. They need to actually be addressed!
+    // **
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-magic-numbers': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/explicit-member-accessibility': 'off',
+    '@typescript-eslint/promise-function-async': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/prefer-nullish-coalescing': 'off',
+    '@typescript-eslint/naming-convention': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/consistent-type-assertions': 'off',
+    'import/no-unused-modules': 'off',
+    'import/prefer-default-export': 'off',
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-description': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/require-description-complete-sentence': 'off',
+    'jsdoc/check-tag-names': 'off',
+    'jsdoc/check-examples': 'off', // Not implemented in eslint 8
+    'jsdoc/no-types': 'off',
+    'tsdoc/syntax': 'off',
+    'import/order': 'off',
+    'eslint-comments/require-description': 'off',
+    'no-shadow': 'off',
+    'multiline-comment-style': 'off',
+    '@typescript-eslint/no-require-imports': 'off',
+  },
+
+  overrides: [
+    {
+      files: ['test/*.test.ts'],
+      // tests are importing through full module name to test in an isomorphic way
+      rules: {
+        'node/no-extraneous-import': 'off',
+        'import/no-extraneous-dependencies': 'off',
+      },
+    },
+  ],
+}

packages/isomorphic/HISTORY.md

@@ -0,0 +1,24 @@
+# @xrplf/isomorphic Release History
+
+## Unreleased
+
+## 1.0.1 (2024-06-03)
+
+### Fixed
+
+* Throw error if `hexToBytes` or `hexToString` is provided a string that is not in hex
+
+## 1.0.0 (2024-02-01)
+
+Initial release providing isomorphic and tree-shakable implementations of:
+
+* ripemd160
+* sha256
+* sha512
+* bytesToHash
+* hashToBytes
+* hexToString
+* stringToHex
+* randomBytes
+* stringToHex
+* ws