Publish

- ripple-address-codec@4.2.1
 - ripple-binary-codec@1.2.1
 - ripple-keypairs@1.1.1
 - xrpl@2.0.3

.github/dependabot.yml

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

.github/pull_request_template.md

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

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main, 1.x ]
+  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@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/nodejs.yml

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

.gitignore

@@ -1,5 +1,9 @@
 # .gitignore
 
+# Ignore package locks other than npm.
+yarn.lock
+npm-shrinkwrap.json
+
 # Ignore vim swap files.
 *.swp
 
@@ -17,7 +21,7 @@
 
 # Ignore object files.
 *.o
-build/ripple*.js
+build/
 tags
 bin/rippled
 Debug/*.*
@@ -25,6 +29,7 @@ Release/*.*
 
 # Ignore locally installed node_modules
 node_modules
+!test/node_modules
 
 # Ignore tmp directory.
 tmp
@@ -42,3 +47,30 @@ test/config.js
 /lib-cov
 /src-cov
 /coverage.html
+/coverage
+
+# Ignore IntelliJ files
+.idea
+
+# Ignore npm-debug
+npm-debug.log
+
+# Ignore dist folder, built from tsc
+dist/
+
+# TypeScript incremental compilation cache
+*.tsbuildinfo
+
+# Ignore perf test cache
+scripts/cache
+
+.eslintrc
+
+# nyc (istanbul)
+.nyc_output
+
+# browser tests
+testCompiledForWeb
+
+# lerna debug
+lerna-debug.log

.npmignore

@@ -1,3 +0,0 @@
-deploy
-lib-cov
-coverage.html

.nvmrc

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

.travis.yml

@@ -1,6 +0,0 @@
-language: node_js
-node_js:
-  - "0.10"
-notifications:
-  email:
-    false

.vscode/extensions.json

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

.vscode/settings.json

@@ -0,0 +1,38 @@
+{
+    "editor.tabSize": 2,
+    "cSpell.words": [
+      "secp256k1"
+    ],
+    "[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": true
+    },
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "files.watcherExclude": {
+        "**/.git/objects/**": true,
+        "**/.git/subtree-cache/**": true,
+        "**/.hg/store/**": true
+    },
+}

APPLICATIONS.md

@@ -0,0 +1,163 @@
+# Applications using xrpl.js
+
+A curated list of some of the projects and apps that leverage `xrpl.js` in some way.
+
+**Have one to add?** Please edit this file and open a PR!
+
+## Notice (disclaimer)
+
+These sites are independent of Ripple and have not been authorized, endorsed, sponsored or otherwise approved by Ripple or its affiliates.
+
+Warning: Use at your own risk.
+
+## Exchanges
+
+- **[The World Exchange](https://www.theworldexchange.net/)**
+
+  Trade, issue, and send directly on the XRP Ledger. A user interface for the XRPL's decentralized exchange.
+
+- **[Bitso](https://bitso.com/)**
+
+  Exchange allowing clients to buy and sell XRP, based in Mexico.
+
+## Explorers
+
+- **[xrpintel - XRP Intelligence](https://xrpintel.com/)**
+
+  Monitor the XRP Network in real time and explore historical statistics.
+
+- **[XRP Charts](https://xrpcharts.ripple.com/)** (xrpcharts.ripple.com)
+
+  XRP Charts provides information based on public data, including trade volume, top markets, metrics, transactions, and more.
+
+- **[Ripple Live](https://gatehub.net/live)** (gatehub.net/live)
+
+  Visualize XRP network transactions.
+
+- **[XRPL Dev. Dashboard](https://xrp.fans/)** (xrp.fans)
+
+  Debugging dashboard for `rippled-ws-client-pool`, transaction and query explorer, and transaction signing and submission tool.
+
+- **[XRP Value](http://xrpvalue.com/)**
+
+  Real-time XRP price, trades, and orderbook data from the XRP Ledger.
+
+- **[Bithomp - XRP Explorer](https://bithomp.com/explorer/)**
+
+  Look up information by entering an address, transaction hash, username, or PayID.
+
+- **[Bithomp - XRPL validators](https://bithomp.com/validators)**
+
+  List of XRPL validators, nodes, and testnet validators.
+
+- **[XRP Scan - XRP Ledger explorer](https://xrpscan.com)**
+
+  XRP Ledger explorer, metrics and analytics.
+
+- **[xrplorer](https://xrplorer.com)**
+
+  XRP Ledger explorer, API, metrics, and analytics using a graph database that is synchronized live with the XRPL.
+
+## Data monitoring
+
+- **[zerptracker](https://zerptracker.com)**
+
+  Monitor the XRPL using powerful JSONPath expressions, and receive notifications via email, SMS, webhooks, and more.
+
+- **[Utility-Scan](https://utility-scan.com)**
+
+  Attempts to detect RippleNet on-demand liquidity (ODL) transactions through known fiat corridors and report these transactions in real time.
+
+- **[XRPL Rosetta](https://xrpl-rosetta-oepox.ondigitalocean.app)**
+
+  3D Globe written in three.js connected to a Node.js websocket server that is listening to exchanges and the XRPL. The visualization aims to show trading, ODL, and liquidity at exchanges, intra-exchange volume, and flows.
+
+## Wallets and wallet tools
+
+- **[XUMM](https://xumm.app/)**
+
+  Users can use the xumm application to track their accounts, balances and transactions. The true power of xumm is the platform available for developers.
+
+- **[Xpring Wallet](https://xpring.io)** (uses `ripple-keypairs`)
+
+  Non-custodial XRP wallet.
+
+- **[XRP Toolkit](https://www.xrptoolkit.com)**
+
+  A web interface to the XRP Ledger, supporting both hardware and software wallets.
+
+- **[Toast Wallet](https://toastwallet.com/)**
+
+  A free, open source XRP Wallet for iOS, Android, Windows, Mac and Linux.
+
+- **[Toastify Ledger](https://github.com/WietseWind/toastify-ledger)** (uses `ripple-keypairs`)
+
+  Add a Regular Key to a mnemonic XRP Wallet (e.g. Ledger Nano S) to use the account with a Family Seed (secret).
+
+- **[Bithomp-submit](https://github.com/Bithomp/bithomp-submit)** (GitHub)
+
+  A tool to submit an offline-signed XRPL transaction.
+
+- **[Kyte](https://kyteapp.co/)** (kyteapp.co) ([Source](https://github.com/WietseWind/Zerp-Wallet)) (Deprecated)
+
+  Web-based XRP wallet.
+
+- **[XRP Vanity Address Generator](https://github.com/WietseWind/xrp-vanity-generator)** (Node.js)
+
+  A vanity address is a wallet address containing a few characters you like at the beginning or the end of the wallet address.
+
+- **[XRP Account Mnemonic Recovery](https://github.com/WietseWind/xrp-mnemonic-recovery)** (uses `ripple-keypairs`)
+
+  Recover a 24 word mnemonic if one word is wrong or one word is missing.
+
+## Send and request payments
+
+- **[XRP Tip Bot](https://www.xrptipbot.com/)**
+
+  A bot that enables users on reddit, Twitter and Discord to send XRP to each other through reddit comments and Twitter tweets.
+
+- **[XRP Text](https://xrptext.com/)**
+
+  Send XRP using SMS text messages.
+
+- **[XRParrot](https://xrparrot.com/)** (uses `ripple-address-codec`)
+
+  Easy EUR (SEPA) to XRP transfer (currency conversion).
+
+- **[XRP Payment](https://xrpayments.co/)** (xrpayments.co)
+
+  Tool for generating a XRP payment request URI in a QR code, with currency converter.
+
+## Development tools
+
+- **[XRP Faucets for Testnet and Devnet](https://xrpl.org/xrp-testnet-faucet.html)**
+
+  Get some test funds for development on the test network. The faucet uses `xrpl.js`.
+
+## Code samples and libraries
+
+- **[ilp-plugin-xrp-paychan](https://github.com/interledgerjs/ilp-plugin-xrp-paychan)**
+
+  Send ILP payments using XRP and payment channels (PayChan).
+
+- **[RunKit: WietseWind](https://runkit.com/wietsewind/)**
+
+  XRP Ledger code samples for Node.js.
+
+- **[GitHub Gist: WietseWind](https://gist.github.com/WietseWind)**
+
+  XRP Ledger code samples for Node.js and the web (mostly).
+
+- **[rippled-ws-client-sign](https://github.com/WietseWind/rippled-ws-client-sign)**
+
+  Sign transactions, with support for MultiSign.
+
+- **[ILP-enabled power switch](https://xrpcommunity.blog/raspberry-pi-interledger-xp-powerswitch-howto/)** ([video](https://www.youtube.com/watch?v=c-eS0HQUuJg)) (uses [`moneyd-uplink-xrp`](https://github.com/interledgerjs/moneyd-uplink-xrp))
+
+  For about $30 in parts (Raspberry Pi, 3.3V Relay board and a few wires) you can build your own power switch that will switch on if a streaming ILP payment comes in. When the payment stream stops, the power turns off.
+
+## Related apps that do not appear to use xrpl.js
+
+- **[XRP Stats](https://ledger.exposed/)** (ledger.exposed)
+
+  Rich list, live ledger stats and XRP distribution. Visualize escrows and flow of funds.

CONTRIBUTING.md

@@ -0,0 +1,160 @@
+# Contributing
+
+## Set up your dev environment
+
+### Requirements
+
+We use Node v14 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 `rippled` node in standalone mode to test xrpl.js code against. To set this up, you can either run `rippled` locally, or set up the Docker container `natenichols/rippled-standalone:latest` for this purpose. 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
+
+```bash
+npm install
+# sets up the rippled standalone Docker container - you can skip this step if you already have it set up
+docker run -p 6006:6006 -it natenichols/rippled-standalone:latest
+npm run build
+npm run test:integration
+```
+
+### 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) -
+
+```bash
+npm run build
+# sets up the rippled standalone Docker container - you can skip this step if you already have it set up
+docker run -p 6006:6006 -it natenichols/rippled-standalone:latest
+npm run test:browser
+```
+
+## Generate reference docs
+
+You can see the complete reference documentation at [`xrpl.js` docs](js.xrpl.org). You can also generate them locally using `typedoc`:
+
+```bash
+npm run docgen
+```
+
+After generating the docs, copy the docs from `packages/xrpl/docs` to `docs` at the top level.
+(That is where GitHub pages looks for the docs, if the docs aren't moved, js.xrpl.org will NOT update)
+
+## Adding and removing packages
+
+`xrpl.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
+
+`xrpl.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 `xrpl`
+npm install abbrev -w xrpl
+### adding a new dependency to `ripple-keypairs`
+npm install abbrev -w ripple-keypairs
+### removing a dependency
+npm uninstall abbrev -w xrpl
+```
+
+## Release process
+
+### Editing the Code
+
+* Your changes should have unit and/or integration tests.
+* Your changes should pass the linter.
+* Your code should pass all the tests on Github (which check the linter, unit and integration tests on Node 12/14/16, and browser tests).
+* Open a PR against `main` and ensure that all CI passes.
+* Get a full code review from one of the maintainers.
+* Merge your changes.
+
+### Release
+
+1. Ensure that all tests passed on the last CI that ran on `main`.
+2. Open a PR to update the docs if docs were modified.
+3. Create a branch off `main` that ensures that `HISTORY.md` is updated appropriately for each package.
+4. Merge this branch into `main`.
+___
+NOW WE ARE READY TO PUBLISH! No new code changes happen manually now.
+___
+6. Checkout `main` and `git pull`.
+7. Run `npm run build` to triple check the build still works
+8. Run `npx lerna publish`. This command will diff all packages. Any changed
+   package will be staged for publication.
+9. 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.
+10. 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!
+___
+11. On github, click the "releases" link on the right-hand side of the page.
+12. In the top-left corner, click the "tags" toggle.
+13. For each new tag created by lerna, click the context button (the one that looks like "...") and select "new release" to create a new release from this tag.
+14. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
+15. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
+
+## Mailing Lists
+We have a low-traffic mailing list for announcements of new `xrpl.js` releases. (About 1 email every couple of weeks)
+
++ [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-announce)
+
+If you're using the XRP Ledger in production, you should run a [rippled server](https://github.com/ripple/rippled) and subscribe to the ripple-server mailing list as well.
+
++ [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)

Gruntfile.js

@@ -1,106 +0,0 @@
-module.exports = function(grunt) {
-  grunt.loadNpmTasks('grunt-webpack');
-  grunt.loadNpmTasks('grunt-dox');
-  grunt.loadNpmTasks('grunt-contrib-concat');
-  grunt.loadNpmTasks('grunt-contrib-watch');
-
-  grunt.initConfig({
-    pkg: grunt.file.readJSON('package.json'),
-    meta: {
-      banner: '/*! <%= pkg.name %> - v<%= pkg.version %> - ' +
-        '<%= grunt.template.today("yyyy-mm-dd") %>\n' +
-        '<%= pkg.homepage ? "* " + pkg.homepage + "\n" : "" %>' +
-        '* Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author.name %>;' +
-        ' Licensed <%= _.pluck(pkg.licenses, "type").join(", ") %> */'
-    },
-    concat: {
-      sjcl: {
-        src: [
-          "src/js/sjcl/core/sjcl.js",
-          "src/js/sjcl/core/aes.js",
-          "src/js/sjcl/core/bitArray.js",
-          "src/js/sjcl/core/codecString.js",
-          "src/js/sjcl/core/codecHex.js",
-          "src/js/sjcl/core/codecBase64.js",
-          "src/js/sjcl/core/codecBytes.js",
-          "src/js/sjcl/core/sha256.js",
-          "src/js/sjcl/core/sha512.js",
-          "src/js/sjcl/core/sha1.js",
-          "src/js/sjcl/core/ccm.js",
-//          "src/js/sjcl/core/cbc.js",
-//          "src/js/sjcl/core/ocb2.js",
-          "src/js/sjcl/core/hmac.js",
-          "src/js/sjcl/core/pbkdf2.js",
-          "src/js/sjcl/core/random.js",
-          "src/js/sjcl/core/convenience.js",
-          "src/js/sjcl/core/bn.js",
-          "src/js/sjcl/core/ecc.js",
-          "src/js/sjcl/core/srp.js",
-          "src/js/sjcl-custom/sjcl-ecc-pointextras.js",
-          "src/js/sjcl-custom/sjcl-secp256k1.js",
-          "src/js/sjcl-custom/sjcl-ripemd160.js",
-          "src/js/sjcl-custom/sjcl-extramath.js",
-          "src/js/sjcl-custom/sjcl-montgomery.js",
-          "src/js/sjcl-custom/sjcl-validecc.js",
-          "src/js/sjcl-custom/sjcl-ecdsa-canonical.js",
-          "src/js/sjcl-custom/sjcl-ecdsa-der.js",
-          "src/js/sjcl-custom/sjcl-ecdsa-recoverablepublickey.js",
-          "src/js/sjcl-custom/sjcl-jacobi.js"
-        ],
-        dest: 'build/sjcl.js'
-      }
-    },
-    webpack: {
-      options: {
-        entry: "./src/js/ripple/index.js",
-        output: {
-          library: "ripple"
-        },
-        cache: true
-      },
-      lib: {
-        output: {
-          filename: "build/ripple-<%= pkg.version %>.js"
-        }
-      },
-      lib_debug: {
-        output: {
-          filename: "build/ripple-<%= pkg.version %>-debug.js"
-        },
-        debug: true,
-        devtool: 'eval'
-      },
-      lib_min: {
-        output: {
-          filename: "build/ripple-<%= pkg.version %>-min.js"
-        },
-        optimize: {
-          minimize: true
-        }
-      }
-    },
-    watch: {
-      sjcl: {
-        files: ['<%= concat.sjcl.src %>'],
-        tasks: 'concat:sjcl'
-      },
-      lib: {
-        files: 'src/js/ripple/*.js',
-        tasks: 'webpack:lib_debug'
-      }
-    },
-    dox: {
-      libdocs: {
-        options: {
-          title: "Test"
-        },
-        src: ['src/js/ripple/'],
-        dest: 'build/docs'
-      }
-    }
-  });
-
-  // Tasks
-  grunt.registerTask('default', ['concat:sjcl', 'webpack']);
-
-};

HISTORY.md

@@ -1,45 +1,3 @@
+# xrpl.js (ripple-lib) Release History
 
-##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 inadquate. 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.
-
+Please see the individual HISTORY.md documents in each package for changes.

LICENSE

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

Makefile

@@ -1,12 +0,0 @@
-test:
-	mocha --reporter spec test/*-test.js
-
-coverage:
-	rm -rf src-cov
-	mkdir src-cov
-	mkdir src-cov/js
-	jscoverage --no-highlight src/js/ripple src-cov/js/ripple
-	RIPPLE_LIB_COV=1 mocha --reporter html-cov test/*-test.js > coverage.html
-	rm -rf src-cov
-
-.PHONY: test

README.md

@@ -1,95 +1,146 @@
-#The Ripple JavaScript Library
+# xrpl.js
 
-[![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib)
+A JavaScript/TypeScript library for interacting with the XRP Ledger
 
-`ripple-lib` connects to the Ripple network via the WebSocket protocol and runs in Node.js as well as in the browser.
+[![NPM](https://nodei.co/npm/xrpl.png)](https://www.npmjs.org/package/xrpl)
+![npm bundle size](https://img.shields.io/bundlephobia/min/xrpl)
 
-###Use ripple-lib for:
+This is the recommended library for integrating a JavaScript/TypeScript app with the XRP 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.
 
-+ Connecting to a local or remote rippled in JavaScript (Node.js or browser)
-+ Issuing [rippled API](https://ripple.com/wiki/JSON_Messages) requests
-+ Listening to events on the Ripple network (transaction, ledger, etc.)
-+ Signing and submitting transactions to the Ripple network
+## [➡️ Reference Documentation](http://js.xrpl.org)
 
-###In this file:
+See the full reference documentation for all classes, methods, and utilities.
 
-1. Overview
-2. [Getting `ripple-lib`](README.md#getting-ripple-lib)
-3. [Quickstart](README.md#quickstart)
-4. [Running tests](https://github.com/ripple/ripple-lib#running-tests)
+## [➡️ Applications and Projects](https://github.com/XRPLF/xrpl.js/blob/main/APPLICATIONS.md)
 
-###For additional documentation see:
+What is `xrpl.js` used for? The applications on the list linked above use `xrpl.js`. Open a PR to add your app or project to the list!
 
-1. [The `ripple-lib` Guides (docs/GUIDES.md)](docs/GUIDES.md)
-2. [The `ripple-lib` API Reference (docs/REFERENCE.md)](docs/REFERENCE.md)
-3. https://ripple.com/wiki/Ripple_JavaScript_library
+### Features
 
-###Also see:
++ Works in Node.js and in web browsers
++ Helpers for creating requests and parsing responses for the [XRP Ledger APIs](https://xrpl.org/rippled-api.html)
++ Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)
++ Sign and submit transactions to the XRP Ledger
++ Type definitions for TypeScript
 
-+ https://ripple.com/wiki  
-+ https://ripple.com
+### Requirements
 
-##Getting `ripple-lib`
++ **[Node.js v14](https://nodejs.org/)** is recommended. We also support v12 and v16. Other versions may work but are not frequently tested.
 
-**Via npm for Node.js**
+## Getting Started
+
+In an existing project (with `package.json`), install `xrpl.js`:
 
 ```
-  $ npm install ripple-lib
+$ npm install --save xrpl
 ```
 
-**Build from the source using `grunt`**
+Or with `yarn`:
 
 ```
-  $ git clone https://github.com/ripple/ripple-lib
-  $ npm install
-  $ grunt
+$ yarn add xrpl
 ```
 
-Then use the minified `build/ripple-*-min.js` in your webpage
-
-##Quickstart
-
-`Remote` ([remote.js](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/remote.js)) is the module responsible for managing connections to `rippled` servers:
+Example usage:
 
 ```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
+const xrpl = require("xrpl")
+async function main() {
+  const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
+  await client.connect()
 
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
+  const response = await client.request({
+    "command": "account_info",
+    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
+    "ledger_index": "validated"
+  })
+  console.log(response)
 
-var remote = new Remote({
-  // see the API Reference for available options
-  trusted:        true,
-  local_signing:  true,
-  local_fee:      true,
-  fee_cushion:     1.5,
-  servers: [
-    {
-        host:    's1.ripple.com'
-      , port:    443
-      , secure:  true
-    }
-  ]
-});
-
-remote.connect(function() {
-  /* remote connected */
-
-  // see the API Reference for available functions
-});
+  client.disconnect()
+}
+main()
 ```
 
-See [The `ripple-lib` Guides](docs/GUIDES.md) and [The `ripple-lib` API Reference](docs/REFERENCE.md) for walkthroughs and details about all of the available functions and options.
+For more examples, see the [documentation](#documentation).
 
-##Running tests
+### Using xrpl.js with React Native
 
-1. Clone the repository
+If you want to use `xrpl.js` with React Native you will need to install shims for core NodeJS modules. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
 
-2. `cd` into the repository and install dependencies with `npm install`
+1. Install dependencies (you can use `yarn` as well):
 
-3. `npm test` or `make test` or `node_modules\.bin\mocha test\*-test.js` 
+    ```shell
+    npm install react-native-crypto
+    npm install xrpl
+    # install peer deps
+    npm install react-native-randombytes
+    # install latest rn-nodeify
+    npm install rn-nodeify@latest --dev
+    ```
 
-**Generating code coverage**
+2. After that, run the following command:
 
-ripple-lib uses `jscoverage` to generate code coverage. To generate a file `coverage.html`, run `make coverage`
+    ```shell
+    # install node core shims and recursively hack package.json files
+    # in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings
+    ./node_modules/.bin/rn-nodeify --hack --install
+    ```
+
+3. Enable `crypto`:
+
+    `rn-nodeify` will create a `shim.js` file in the project root directory.
+    Open it and uncomment the line that requires the crypto module:
+
+    ```javascript
+    // If using the crypto shim, uncomment the following line to ensure
+    // crypto is loaded first, so it can populate global.crypto
+    require('crypto')
+    ```
+
+4. Import `shim` in your project (it must be the first line):
+
+  ```javascript
+  import './shim'
+  ...
+  ```
+
+### Using xrpl.js with Deno
+
+Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `xrpl.js` with Deno:
+
+```javascript
+import xrpl from 'https://dev.jspm.io/npm:xrpl';
+
+(async () => {
+  const api = new (xrpl as any).Client('wss://s.altnet.rippletest.net:51233');
+  const address = 'rH8NxV12EuV...khfJ5uw9kT';
+
+  api.connect().then(() => {
+    api.getBalances(address).then((balances: any) => {
+      console.log(JSON.stringify(balances, null, 2));
+    });
+  });
+})();
+```
+
+## Documentation
+
++ [Get Started in Node.js](https://xrpl.org/get-started-using-node-js.html)
++ [Full Reference Documentation](https://js.xrpl.org)
++ [Code Samples](https://github.com/XRPLF/xrpl.js/tree/main/packages/xrpl/snippets/src)
+
+### Mailing Lists
+
+We have a low-traffic mailing list for announcements of new `xrpl.js` releases. (About 1 email per week)
+
++ [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-announce)
+
+If you're using the XRP Ledger in production, you should run a [rippled server](https://github.com/ripple/rippled) and subscribe to the ripple-server mailing list as well.
+
++ [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)
+
+## More Information
+
++ [xrpl-announce mailing list](https://groups.google.com/g/xrpl-announce) - subscribe for release announcements
++ [xrpl.js API Reference](https://js.xrpl.org)
++ [XRP Ledger Dev Portal](https://xrpl.org)

SECURITY.md

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

bench/modpow.js

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

bin/decode_binary.js

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

bin/rsign.js

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

bin/validate_address.js

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

deploy/start rippled.bat

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

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/CNAME

@@ -0,0 +1 @@
+js.xrpl.org

docs/GUIDES.md

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

docs/REFERENCE.md

@@ -1,258 +0,0 @@
-#`ripple-lib` API Reference
-
-__(More examples coming soon!)__
-
-###In this document:
-
-1. [`Remote` options](REFERENCE.md#1-remote-options)
-2. [`Remote` functions](REFERENCE.md#2-remote-functions)
-  + [Server info functions](REFERENCE.md#server-info-functions)
-  + [Ledger query functions](REFERENCE.md#ledger-query-functions)
-  + [Transaction query functions](REFERENCE.md#transaction-query-functions)
-  + [Account query functions](REFERENCE.md#account-query-functions)
-  + [Order book query functions](REFERENCE.md#order-book-query-functions)
-  + [Transaction submission functions](REFERENCE.md#transaction-submission-functions)
-3. [`Transaction` events](REFERENCE.md#3-transaction-events)
-4. [`Amount` objects](REFERENCE.md#4-amount-objects)
-
-
-###Also see:
-
-1. [The `ripple-lib` README](../README.md)
-2. [The `ripple-lib` GUIDES](GUIDES.md)
-
-
-#1. `Remote` options
-
-```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
-
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
-
-var remote = new Remote({options});
-```
-
-A new `Remote` can be created with the following options:
-
-+ `trace` Log all of the events emitted (boolean)
-+ `max_listeners` Set maxListeners for remote; prevents EventEmitter warnings (number)
-+ `connection_offset` Connect to remote servers on supplied interval (number in seconds)
-+ `trusted` truthy, if remote is trusted (boolean)
-+ `local_fee` Set whether the transaction fee range will be set locally (boolean, default is true, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `fee_cushion` Extra fee multiplier to account for async fee changes (number, e.g. 1.5, see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `max_fee` Maximum acceptable transaction fee (number in [XRP drops](https://ripple.com/wiki/Ripple_credits#Notes_on_drops), see [A note on transaction fees](GUIDES.md#a-note-on-transaction-fees))
-+ `servers` Array of server objects of the following form:
-
-```js
-{ 
-  host:    <string>
-  , port:    <number>
-  , secure:  <boolean>
-}
-```
-+ `local_signing`
-
-#2. `Remote` functions
-
-
-
-##Server info functions
-
-**[requestServerInfo([callback])](https://ripple.com/wiki/RPC_API#server_info)**
-
-Returns information about the state of the server. If you are connected to multiple servers and want to select by a particular host, use `request.set_server`. Example:
-
-```js
-var request = remote.request_server_info();
-request.set_server('my.hostname');
-request.callback(function(err, res) {
-
-});
-request.request();
-```
-
-**[requestUnlList([callback])](https://ripple.com/wiki/RPC_API#unl_list)**
-
-**[requestUnlAdd(addr, comment, [callback])](https://ripple.com/wiki/RPC_API#unl_add)**
-
-**[requestUnlDelete(node, [callback])](https://ripple.com/wiki/RPC_API#unl_delete)**
-
-**[requestPeers([callback])](https://ripple.com/wiki/RPC_API#peers)**
-
-
-**[requestConnect(ip, port, [callback])](https://ripple.com/wiki/RPC_API#connect)**
-
-
-
-##Ledger query functions
-
-**[requestLedger(ledger, [opts], [callback])](https://ripple.com/wiki/RPC_API#ledger)**
-
-**requestLedgerHeader([callback])**
-
-**[requestLedgerCurrent([callback])](https://ripple.com/wiki/RPC_API#ledger_current)**
-
-**[requestLedgerEntry(type, [callback])](https://ripple.com/wiki/RPC_API#ledger_entry)**
-
-**[requestSubscribe(streams, [callback])](https://ripple.com/wiki/RPC_API#subscribe)**
-
-Start receiving selected streams from the server.
-
-**[requestUnsubscribe(streams, [callback])](https://ripple.com/wiki/RPC_API#unsubscribe)**
-
-Stop receiving selected streams from the server.
-
-
-
-
-##Transaction query functions
-
-**[requestTransactionEntry(hash, [ledger_hash], [callback])](https://ripple.com/wiki/RPC_API#transaction_entry)**
-
-Searches a particular ledger for a transaction hash. Default ledger is the open ledger.
-
-**[requestTx(hash, [callback])](https://ripple.com/wiki/RPC_API#tx)**
-
-Searches ledger history for validated transaction hashes.
-
-
-
-
-##Account query functions
-
-**[requestAccountInfo(account, [callback])](https://ripple.com/wiki/RPC_API#account_info)**
-
-Return information about the specified account.
-
-```
-{
-  ledger_current_index: <number>,
-  account_data: {
-    Account:            <string>,
-    Balance:            <number>,
-    Flags:              <number>,
-    LedgerEntryType:    <string>,
-    OwnerCount:         <number>,
-    PreviousTxnID:      <string>,
-    PreviousTxnLgrSeq:  <number>,
-    Sequence:           <number> ,
-    index:              <string>
-  }
-}
-```
-
-**[requestAccountLines(accountID, account_index, current, [callback])](https://ripple.com/wiki/RPC_API#account_lines)**
-
-**[requestAccountOffers(accountID, account_index, current, [callback])](https://ripple.com/wiki/RPC_API#account_offers)**
-
-Return the specified account's outstanding offers.
-
-**[requestAccountTx(opts, [callback])](https://ripple.com/wiki/RPC_API#account_tx)**
-
-Fetch a list of transactions that applied to this account.
-
-Options:
-
-+ `account`
-+ `ledger_index_min` *deprecated, -1*
-+ `ledger_index_max` *deprecated, -1*
-+  `binary` *false*
-+ `count` *false*
-+  `descending` *false*
-+  `offset` *0*
-+  `limit`
-+ `forward` *false*
-+ `fwd_marker`
-+ `rev_marker`
-
-**[requestWalletAccounts(seed, [callback])](https://ripple.com/wiki/RPC_API#wallet_accounts)**
-
-Return a list of accounts for a wallet.
-
-+ requires trusted remote
-
-**requestAccountBalance(account, ledger, [callback])**
-
-Get the balance for an account. Returns an [Amount](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/amount.js) object.
-
-**requestAccountFlags(account, current, [callback])**
-
-Return the flags for an account.
-
-**requestOwnerCount(account, current, [callback])**
-
-Return the owner count for an account.
-
-**requestRippleBalance(account, issuer, currency, current, [callback])**
-
-Return a request to get a ripple balance
-
-
-
-
-##Order book query functions
-
-**[requestBookOffers(gets, pays, taker, [callback])](https://ripple.com/wiki/RPC_API#book_offers)**
-
-Return the offers for an order book as one or more pages.
-
-```js
-var request = remote.request_book_offers({
-  gets: {
-    'currency':'XRP'
-  },
-  pays: {
-    'currency':'USD',
-    'issuer': 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
-  }
-});
-
-request.request();
-```
-
-
-
-
-##Transaction submission functions
-
-**[requestSign(secret, tx_json, [callback])](https://ripple.com/wiki/RPC_API#sign)**
-
-Sign a transaction.
-
-+ requires trusted remote
-
-**[requestSubmit([callback])](https://ripple.com/wiki/RPC_API#submit)**
-
-Submit a transaction to the network. This command is used internally to submit transactions with a greater degree of reliability. See [Submitting a payment to the network](GUIDES.md#3-submitting-a-payment-to-the-network) for details.
-
-
-**[requestRipplePathFind(src_account, dst_account, dst_amount, src_currencies, [callback])](https://ripple.com/wiki/RPC_API#path_find)**
-
-
-**transaction([destination], [source], [amount], [callback])**
-
-Returns a [Transaction](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/transaction.js) object
-
-
-#3. Transaction events
-
-[Transaction](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/transaction.js) objects are EventEmitters. They may emit the following events.
-
-+ `final` Transaction has erred or succeeded. This event indicates that the transaction has finished processing.
-+ `error` Transaction has erred. This event is a final state.
-+ `success` Transaction succeeded. This event is a final state.
-+ `submitted` Transaction has been submitted to the network. The submission may result in a remote error or success.
-+ `proposed` Transaction has been submitted *successfully* to the network. The transaction at this point is awaiting validation in a ledger.
-+ `timeout` Transaction submission timed out. The transaction will be resubmitted.
-+ `resubmit` Transaction is beginning resubmission.
-+ `fee_adjusted` Transaction fee has been adjusted during its pending state. The transaction fee will only be adjusted if the remote is configured for local fees, which it is by default.
-+ `abort` Transaction has been aborted. Transactions are only aborted by manual calls to `#abort`.
-+ `missing` Four ledgers have closed without detecting validated transaction
-+ `lost` Eight ledgers have closed without detecting validated transaction. Consider the transaction lost and err/finalize.
-
-
-#4. Amount objects
-
-Coming Soon

docs/assets/highlight.css

@@ -0,0 +1,106 @@
+:root {
+    --light-hl-0: #0000FF;
+    --dark-hl-0: #569CD6;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #0070C1;
+    --dark-hl-2: #4FC1FF;
+    --light-hl-3: #795E26;
+    --dark-hl-3: #DCDCAA;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #008000;
+    --dark-hl-5: #6A9955;
+    --light-hl-6: #AF00DB;
+    --dark-hl-6: #C586C0;
+    --light-hl-7: #A31515;
+    --dark-hl-7: #CE9178;
+    --light-hl-8: #098658;
+    --dark-hl-8: #B5CEA8;
+    --light-hl-9: #267F99;
+    --dark-hl-9: #4EC9B0;
+    --light-hl-10: #000000;
+    --dark-hl-10: #C8C8C8;
+    --light-hl-11: #CD3131;
+    --dark-hl-11: #F44747;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --code-background: var(--dark-code-background);
+} }
+
+body.light {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --code-background: var(--light-code-background);
+}
+
+body.dark {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+pre, code { background: var(--code-background); }

docs/classes/ConnectionError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConnectionError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="ConnectionError.html">ConnectionError</a></li></ul><h1>Class ConnectionError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js has an error with connection to rippled.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a><ul class="tsd-hierarchy"><li><span class="target">ConnectionError</span><ul class="tsd-hierarchy"><li><a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a></li><li><a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a></li><li><a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a></li><li><a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></li><li><a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></li></ul></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Connection<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ConnectionError.html" class="tsd-kind-icon">Connection<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/DisconnectedError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DisconnectedError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="DisconnectedError.html">DisconnectedError</a></li></ul><h1>Class DisconnectedError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js has disconnected from rippled server.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a><ul class="tsd-hierarchy"><li><span class="target">DisconnectedError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Disconnected<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="DisconnectedError.html" class="tsd-kind-icon">Disconnected<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/NotConnectedError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NotConnectedError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="NotConnectedError.html">NotConnectedError</a></li></ul><h1>Class NotConnectedError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js is not connected to rippled server.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a><ul class="tsd-hierarchy"><li><span class="target">NotConnectedError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Not<wbr/>Connected<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="NotConnectedError.html" class="tsd-kind-icon">Not<wbr/>Connected<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/NotFoundError.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NotFoundError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="NotFoundError.html">NotFoundError</a></li></ul><h1>Class NotFoundError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js cannot retrieve a transaction, ledger, account, etc.
+From rippled.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a><ul class="tsd-hierarchy"><li><span class="target">NotFoundError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="NotFoundError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Not<wbr/>Found<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L143">ripple-lib/packages/xrpl/src/errors.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Not found&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message. Defaults to &quot;Not found&quot;.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="NotFoundError.html" class="tsd-kind-icon">Not<wbr/>Found<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="NotFoundError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/ResponseFormatError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ResponseFormatError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="ResponseFormatError.html">ResponseFormatError</a></li></ul><h1>Class ResponseFormatError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js sees a response in the wrong format.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a><ul class="tsd-hierarchy"><li><span class="target">ResponseFormatError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Response<wbr/>Format<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ResponseFormatError.html" class="tsd-kind-icon">Response<wbr/>Format<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/RippledError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RippledError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="RippledError.html">RippledError</a></li></ul><h1>Class RippledError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when rippled responds with an error.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a><ul class="tsd-hierarchy"><li><span class="target">RippledError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Rippled<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="RippledError.html" class="tsd-kind-icon">Rippled<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/RippledNotInitializedError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RippledNotInitializedError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="RippledNotInitializedError.html">RippledNotInitializedError</a></li></ul><h1>Class RippledNotInitializedError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when rippled is not initialized.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a><ul class="tsd-hierarchy"><li><span class="target">RippledNotInitializedError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Rippled<wbr/>Not<wbr/>Initialized<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="RippledNotInitializedError.html" class="tsd-kind-icon">Rippled<wbr/>Not<wbr/>Initialized<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/TimeoutError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TimeoutError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="TimeoutError.html">TimeoutError</a></li></ul><h1>Class TimeoutError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js times out.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a><ul class="tsd-hierarchy"><li><span class="target">TimeoutError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Timeout<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="TimeoutError.html" class="tsd-kind-icon">Timeout<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/UnexpectedError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UnexpectedError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="UnexpectedError.html">UnexpectedError</a></li></ul><h1>Class UnexpectedError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js cannot specify error type.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a><ul class="tsd-hierarchy"><li><span class="target">UnexpectedError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Unexpected<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="UnexpectedError.html" class="tsd-kind-icon">Unexpected<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/ValidationError.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidationError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="ValidationError.html">ValidationError</a></li></ul><h1>Class ValidationError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when xrpl.js sees a malformed transaction.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a><ul class="tsd-hierarchy"><li><span class="target">ValidationError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Validation<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ValidationError.html" class="tsd-kind-icon">Validation<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/Wallet.html

@@ -0,0 +1,113 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Wallet | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="Wallet.html">Wallet</a></li></ul><h1>Class Wallet</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A utility for deriving a wallet composed of a keypair (publicKey/privateKey).
+A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers).
+It provides functionality to sign/verify transactions offline.</p>
+</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-typescript"><span class="hl-5">// Derive a wallet from a bip38 Mnemonic</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">wallet</span><span class="hl-1"> = </span><span class="hl-4">Wallet</span><span class="hl-1">.</span><span class="hl-3">fromMnemonic</span><span class="hl-1">(</span><br/><span class="hl-1">  </span><span class="hl-7">&#39;jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry&#39;</span><br/><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">wallet</span><span class="hl-1">)</span><br/><span class="hl-5">// Wallet {</span><br/><span class="hl-5">// publicKey: &#39;02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2&#39;,</span><br/><span class="hl-5">// privateKey: &#39;00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2&#39;,</span><br/><span class="hl-5">// classicAddress: &#39;rwZiksrExmVkR64pf87Jor4cYbmff47SUm&#39;,</span><br/><span class="hl-5">// seed: undefined</span><br/><span class="hl-5">// }.</span><br/><br/><span class="hl-5">// Derive a wallet from a base58 encoded seed.</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">seedWallet</span><span class="hl-1"> = </span><span class="hl-4">Wallet</span><span class="hl-1">.</span><span class="hl-3">fromSeed</span><span class="hl-1">(</span><span class="hl-7">&#39;ssZkdwURFMBXenJPbrpE14b6noJSu&#39;</span><span class="hl-1">)</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">seedWallet</span><span class="hl-1">)</span><br/><span class="hl-5">// Wallet {</span><br/><span class="hl-5">// publicKey: &#39;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#39;,</span><br/><span class="hl-5">// privateKey: &#39;00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7&#39;,</span><br/><span class="hl-5">// classicAddress: &#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;,</span><br/><span class="hl-5">// seed: &#39;ssZkdwURFMBXenJPbrpE14b6noJSu&#39;</span><br/><span class="hl-5">// }.</span><br/><br/><span class="hl-5">// Sign a JSON Transaction</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">signed</span><span class="hl-1"> = </span><span class="hl-4">seedWallet</span><span class="hl-1">.</span><span class="hl-3">signTransaction</span><span class="hl-1">({</span><br/><span class="hl-1">     </span><span class="hl-4">TransactionType:</span><span class="hl-1"> </span><span class="hl-7">&#39;Payment&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">     </span><span class="hl-4">Account:</span><span class="hl-1"> </span><span class="hl-7">&#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;</span><br/><span class="hl-1">     ...........</span><br/><span class="hl-1">}).</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">signed</span><span class="hl-1">)</span><br/><span class="hl-5">// &#39;1200007321......B01BE1DFF3&#39;.</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">decode</span><span class="hl-1">(</span><span class="hl-4">signed</span><span class="hl-1">))</span><br/><span class="hl-5">// {</span><br/><span class="hl-5">//   TransactionType: &#39;Payment&#39;,</span><br/><span class="hl-5">//   SigningPubKey: &#39;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#39;,</span><br/><span class="hl-5">//   TxnSignature: &#39;3045022100AAD......5B631ABD21171B61B07D304&#39;,</span><br/><span class="hl-5">//   Account: &#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;</span><br/><span class="hl-5">//   ...........</span><br/><span class="hl-5">// }</span>
+</code></pre>
+</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Wallet</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Wallet.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#classicAddress" class="tsd-kind-icon">classic<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#privateKey" class="tsd-kind-icon">private<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#publicKey" class="tsd-kind-icon">public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#seed" class="tsd-kind-icon">seed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromSecret" class="tsd-kind-icon">from<wbr/>Secret</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Wallet.html#address" class="tsd-kind-icon">address</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="Wallet.html#checkTxSerialization" class="tsd-kind-icon">check<wbr/>Tx<wbr/>Serialization</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#getXAddress" class="tsd-kind-icon">getXAddress</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#sign" class="tsd-kind-icon">sign</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#verifyTransaction" class="tsd-kind-icon">verify<wbr/>Transaction</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="Wallet.html#deriveWallet" class="tsd-kind-icon">derive<wbr/>Wallet</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromEntropy" class="tsd-kind-icon">from<wbr/>Entropy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromMnemonic" class="tsd-kind-icon">from<wbr/>Mnemonic</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromSeed" class="tsd-kind-icon">from<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#generate" class="tsd-kind-icon">generate</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Wallet<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L110">ripple-lib/packages/xrpl/src/Wallet/index.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Creates a new Wallet.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>publicKey: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The public key for the account.</p>
+</div></div></li><li><h5>privateKey: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The private key used for signing transactions for the account.</p>
+</div></div></li><li><h5>opts: <span class="tsd-signature-symbol">{ </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>(Optional) Options to initialize a Wallet.</p>
+</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> master<wbr/>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.</p>
+</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The seed used to derive the account keys.</p>
+</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="classicAddress" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> classic<wbr/>Address</h3><div class="tsd-signature tsd-kind-icon">classic<wbr/>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L89">ripple-lib/packages/xrpl/src/Wallet/index.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="privateKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> private<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">private<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L88">ripple-lib/packages/xrpl/src/Wallet/index.ts:88</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="publicKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> public<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">public<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L87">ripple-lib/packages/xrpl/src/Wallet/index.ts:87</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="seed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> seed</h3><div class="tsd-signature tsd-kind-icon">seed<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L90">ripple-lib/packages/xrpl/src/Wallet/index.ts:90</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="fromSecret" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr/>Secret</h3><div class="tsd-signature tsd-kind-icon">from<wbr/>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> = Wallet.fromSeed</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L166">ripple-lib/packages/xrpl/src/Wallet/index.ts:166</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Derives a wallet from a seed.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>seed: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A string used to generate a keypair (publicKey/privateKey) to derive a wallet.</p>
+</div></div></li><li><h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>(Optional) Options to derive a Wallet.</p>
+</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The digital signature algorithm to generate an address for.</p>
+</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> master<wbr/>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.</p>
+</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><div><p>A Wallet derived from a seed.</p>
+</div></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="address" class="tsd-anchor"></a><h3>address</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L97">ripple-lib/packages/xrpl/src/Wallet/index.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Alias for wallet.classicAddress.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The wallet&#39;s classic address.</p>
+</div></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="checkTxSerialization" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr/>Tx<wbr/>Serialization</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">check<wbr/>Tx<wbr/>Serialization<span class="tsd-signature-symbol">(</span>serialized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tx<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L342">ripple-lib/packages/xrpl/src/Wallet/index.ts:342</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p> Decode a serialized transaction, remove the fields that are added during the signing process,
+ and verify that it matches the transaction prior to signing. This gives the user a sanity check
+ to ensure that what they try to encode matches the message that will be recieved by rippled.</p>
+</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>A ValidationError if the transaction does not have a TxnSignature/Signers property, or if
+the serialized Transaction desn&#39;t match the original transaction.</p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>serialized: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A signed and serialized transaction.</p>
+</div></div></li><li><h5>tx: <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The transaction prior to signing.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getXAddress" class="tsd-anchor"></a><h3>getXAddress</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">getXAddress<span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span>, isTestnet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L327">ripple-lib/packages/xrpl/src/Wallet/index.ts:327</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Gets an X-address in Testnet/Mainnet format.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tag: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A tag to be included within the X-address.</p>
+</div></div></li><li><h5>isTestnet: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A boolean to indicate if X-address should be in Testnet (true) or Mainnet (false) format.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>An X-address.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sign" class="tsd-anchor"></a><h3>sign</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, multisign<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L257">ripple-lib/packages/xrpl/src/Wallet/index.ts:257</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Signs a transaction offline.</p>
+</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if the transaction is already signed or does not encode/decode to same result.</p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transaction: <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A transaction to be signed offline.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> multisign: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4><div><p>A signed transaction.</p>
+</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>tx_<wbr/>blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="verifyTransaction" class="tsd-anchor"></a><h3>verify<wbr/>Transaction</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">verify<wbr/>Transaction<span class="tsd-signature-symbol">(</span>signedTransaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L313">ripple-lib/packages/xrpl/src/Wallet/index.ts:313</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Verifies a signed transaction offline.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>signedTransaction: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A signed transaction (hex string of signTransaction result) to be verified offline.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Returns true if a signedTransaction is valid.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a id="deriveWallet" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> derive<wbr/>Wallet</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><li class="tsd-signature tsd-kind-icon">derive<wbr/>Wallet<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L234">ripple-lib/packages/xrpl/src/Wallet/index.ts:234</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Derive a Wallet from a seed.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>seed: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The seed used to derive the wallet.</p>
+</div></div></li><li><h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>(Optional) Options to derive a Wallet.</p>
+</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The digital signature algorithm to generate an address for.</p>
+</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> master<wbr/>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.</p>
+</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><div><p>A Wallet derived from the seed.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="fromEntropy" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr/>Entropy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">from<wbr/>Entropy<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L209">ripple-lib/packages/xrpl/src/Wallet/index.ts:209</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Derives a wallet from an entropy (array of random numbers).</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>entropy: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>An array of random numbers to generate a seed used to derive a wallet.</p>
+</div></div></li><li><h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>(Optional) Options to derive a Wallet.</p>
+</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The digital signature algorithm to generate an address for.</p>
+</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> master<wbr/>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.</p>
+</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><div><p>A Wallet derived from an entropy.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="fromMnemonic" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr/>Mnemonic</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">from<wbr/>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L178">ripple-lib/packages/xrpl/src/Wallet/index.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Derives a wallet from a mnemonic.</p>
+</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>ValidationError if unable to derive private key from mnemonic input.</p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>mnemonic: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A string consisting of words (whitespace delimited) used to derive a wallet.</p>
+</div></div></li><li><h5>opts: <span class="tsd-signature-symbol">{ </span>derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>(Optional) Options to derive a Wallet.</p>
+</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> derivation<wbr/>Path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The path to derive a keypair (publicKey/privateKey) used for mnemonic-to-seed conversion.</p>
+</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> master<wbr/>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.</p>
+</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><div><p>A Wallet derived from a mnemonic.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="fromSeed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr/>Seed</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">from<wbr/>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L146">ripple-lib/packages/xrpl/src/Wallet/index.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Derives a wallet from a seed.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>seed: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A string used to generate a keypair (publicKey/privateKey) to derive a wallet.</p>
+</div></div></li><li><h5>opts: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>(Optional) Options to derive a Wallet.</p>
+</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The digital signature algorithm to generate an address for.</p>
+</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> master<wbr/>Address<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.</p>
+</div></div></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><div><p>A Wallet derived from a seed.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="generate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> generate</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/Wallet/index.ts#L132">ripple-lib/packages/xrpl/src/Wallet/index.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Generates a new Wallet using a generated seed.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = DEFAULT_ALGORITHM</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The digital signature algorithm to generate an address for.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><div><p>A new Wallet derived from a generated seed.</p>
+</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="Wallet.html" class="tsd-kind-icon">Wallet</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Wallet.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#classicAddress" class="tsd-kind-icon">classic<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#privateKey" class="tsd-kind-icon">private<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#publicKey" class="tsd-kind-icon">public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#seed" class="tsd-kind-icon">seed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromSecret" class="tsd-kind-icon">from<wbr/>Secret</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Wallet.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="Wallet.html#checkTxSerialization" class="tsd-kind-icon">check<wbr/>Tx<wbr/>Serialization</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#getXAddress" class="tsd-kind-icon">getXAddress</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#sign" class="tsd-kind-icon">sign</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#verifyTransaction" class="tsd-kind-icon">verify<wbr/>Transaction</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="Wallet.html#deriveWallet" class="tsd-kind-icon">derive<wbr/>Wallet</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromEntropy" class="tsd-kind-icon">from<wbr/>Entropy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromMnemonic" class="tsd-kind-icon">from<wbr/>Mnemonic</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromSeed" class="tsd-kind-icon">from<wbr/>Seed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#generate" class="tsd-kind-icon">generate</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/XRPLFaucetError.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>XRPLFaucetError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="XRPLFaucetError.html">XRPLFaucetError</a></li></ul><h1>Class XRPLFaucetError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Error thrown when a client cannot generate a wallet from the testnet/devnet
+faucets, or when the client cannot infer the faucet URL (i.e. when the Client
+is connected to mainnet).</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a><ul class="tsd-hierarchy"><li><span class="target">XRPLFaucetError</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section tsd-is-inherited"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new XRPLFaucet<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="XRPLFaucetError.html" class="tsd-kind-icon">XRPLFaucet<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/classes/XrplError.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>XrplError | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="XrplError.html">XrplError</a></li></ul><h1>Class XrplError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Base Error class for xrpl.js. All Errors thrown by xrpl.js should throw
+XrplErrors.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Error</span><ul class="tsd-hierarchy"><li><span class="target">XrplError</span><ul class="tsd-hierarchy"><li><a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a></li><li><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a></li><li><a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a></li><li><a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a></li><li><a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></li><li><a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></li></ul></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Xrpl<wbr/>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Error.constructor</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L21">ripple-lib/packages/xrpl/src/errors.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Construct an XrplError.</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The error message.</p>
+</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The data that caused the error.</p>
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="data" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L13">ripple-lib/packages/xrpl/src/errors.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a id="message" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides Error.message</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L12">ripple-lib/packages/xrpl/src/errors.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides Error.name</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L11">ripple-lib/packages/xrpl/src/errors.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3><div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Error.stack</p><ul><li>Defined in ripple-lib/node_modules/typescript/lib/lib.es5.d.ts:975</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr/>Stack<wbr/>Trace</h3><div class="tsd-signature tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from Error.prepareStackTrace</p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:11</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Optional override for formatting stack traces</p>
+</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">https://v8.dev/docs/stack-trace-api#customizing-stack-traces</a></p>
+</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">Error</span></h5></li><li><h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="stackTraceLimit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr/>Trace<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Error.stackTraceLimit</p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:13</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="inspect" class="tsd-anchor"></a><h3>inspect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L54">ripple-lib/packages/xrpl/src/errors.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Console.log in node uses util.inspect on object, and util.inspect allows
+us to customize its output:
+<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/errors.ts#L38">ripple-lib/packages/xrpl/src/errors.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Converts the Error to a human-readable String form.</p>
+</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The String output of the Error.</p>
+</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Stack<wbr/>Trace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Error.captureStackTrace</p><ul><li>Defined in ripple-lib/node_modules/@types/node/globals.d.ts:4</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Create .stack property on a target object</p>
+</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>targetObject: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="XrplError.html" class="tsd-kind-icon">Xrpl<wbr/>Error</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#stack" class="tsd-kind-icon">stack</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr/>Stack<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr/>Trace<wbr/>Limit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#inspect" class="tsd-kind-icon">inspect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/AccountSetAsfFlags.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountSetAsfFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountSetAsfFlags.html">AccountSetAsfFlags</a></li></ul><h1>Enumeration AccountSetAsfFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enum for AccountSet Flags.</p>
+</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr/>Account<wbr/>TxnID</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr/>Default<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr/>Deposit<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr/>Disable<wbr/>Master</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr/>Global<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr/>No<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireAuth" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireDest" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Dest</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfAccountTxnID" class="tsd-anchor"></a><h3>asf<wbr/>Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Account<wbr/>TxnID<span class="tsd-signature-symbol"> = 5</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L31">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Track the ID of this account&#39;s most recent transaction. Required for
+AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfDefaultRipple" class="tsd-anchor"></a><h3>asf<wbr/>Default<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Default<wbr/>Ripple<span class="tsd-signature-symbol"> = 8</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L40">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enable rippling on this account&#39;s trust lines by default.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfDepositAuth" class="tsd-anchor"></a><h3>asf<wbr/>Deposit<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Deposit<wbr/>Auth<span class="tsd-signature-symbol"> = 9</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L42">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enable Deposit Authorization on this account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfDisableMaster" class="tsd-anchor"></a><h3>asf<wbr/>Disable<wbr/>Master</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Disable<wbr/>Master<span class="tsd-signature-symbol"> = 4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L26">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Disallow use of the master key pair. Can only be enabled if the account
+has configured another way to sign transactions, such as a Regular Key or a
+Signer List.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfDisallowXRP" class="tsd-anchor"></a><h3>asf<wbr/>DisallowXRP</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>DisallowXRP<span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L20">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>XRP should not be sent to this account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfGlobalFreeze" class="tsd-anchor"></a><h3>asf<wbr/>Global<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Global<wbr/>Freeze<span class="tsd-signature-symbol"> = 7</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L38">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Freeze all assets issued by this account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfNoFreeze" class="tsd-anchor"></a><h3>asf<wbr/>No<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>No<wbr/>Freeze<span class="tsd-signature-symbol"> = 6</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L36">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Permanently give up the ability to freeze individual trust lines or
+disable Global Freeze. This flag can never be disabled after being enabled.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfRequireAuth" class="tsd-anchor"></a><h3>asf<wbr/>Require<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L18">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Require authorization for users to hold balances issued by this address
+can only be enabled if the address has no trust lines connected to it.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="asfRequireDest" class="tsd-anchor"></a><h3>asf<wbr/>Require<wbr/>Dest</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Require<wbr/>Dest<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L13">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Require a destination tag to send transactions to this account.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Asf<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr/>Account<wbr/>TxnID</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr/>Default<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr/>Deposit<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr/>Disable<wbr/>Master</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr/>Global<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr/>No<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireAuth" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireDest" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Dest</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/AccountSetTfFlags.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountSetTfFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountSetTfFlags.html">AccountSetTfFlags</a></li></ul><h1>Enumeration AccountSetTfFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enum for AccountSet Transaction Flags.</p>
+</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr/>AllowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfAllowXRP" class="tsd-anchor"></a><h3>tf<wbr/>AllowXRP</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>AllowXRP<span class="tsd-signature-symbol"> = 2097152</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L62">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The same as ClearFlag: asfDisallowXRP.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfDisallowXRP" class="tsd-anchor"></a><h3>tf<wbr/>DisallowXRP</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>DisallowXRP<span class="tsd-signature-symbol"> = 1048576</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L60">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The same as SetFlag: asfDisallowXRP.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfOptionalAuth" class="tsd-anchor"></a><h3>tf<wbr/>Optional<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth<span class="tsd-signature-symbol"> = 524288</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L58">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The same as ClearFlag: asfRequireAuth.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfOptionalDestTag" class="tsd-anchor"></a><h3>tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L54">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The same as ClearFlag: asfRequireDest.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfRequireAuth" class="tsd-anchor"></a><h3>tf<wbr/>Require<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L56">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The same as SetFlag: asfRequireAuth.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfRequireDestTag" class="tsd-anchor"></a><h3>tf<wbr/>Require<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountSet.ts#L52">ripple-lib/packages/xrpl/src/models/transactions/accountSet.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The same as SetFlag: asfRequireDest.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Tf<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr/>AllowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/LedgerEntry.AccountRootFlags.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountRootFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="../modules/LedgerEntry.html">LedgerEntry</a></li><li><a href="LedgerEntry.AccountRootFlags.html">AccountRootFlags</a></li></ul><h1>Enumeration AccountRootFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDefaultRipple" class="tsd-kind-icon">lsf<wbr/>Default<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDepositAuth" class="tsd-kind-icon">lsf<wbr/>Deposit<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDisableMaster" class="tsd-kind-icon">lsf<wbr/>Disable<wbr/>Master</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDisallowXRP" class="tsd-kind-icon">lsf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfGlobalFreeze" class="tsd-kind-icon">lsf<wbr/>Global<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfNoFreeze" class="tsd-kind-icon">lsf<wbr/>No<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfPasswordSpent" class="tsd-kind-icon">lsf<wbr/>Password<wbr/>Spent</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfRequireAuth" class="tsd-kind-icon">lsf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfRequireDestTag" class="tsd-kind-icon">lsf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDefaultRipple" class="tsd-anchor"></a><h3>lsf<wbr/>Default<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Default<wbr/>Ripple<span class="tsd-signature-symbol"> = 8388608</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L153">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enable rippling on this addresses&#39;s trust lines by default. Required for issuing addresses; discouraged for others.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDepositAuth" class="tsd-anchor"></a><h3>lsf<wbr/>Deposit<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Deposit<wbr/>Auth<span class="tsd-signature-symbol"> = 16777216</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L158">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:158</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>This account can only receive funds from transactions it sends, and from preauthorized accounts.
+(It has DepositAuth enabled.)</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDisableMaster" class="tsd-anchor"></a><h3>lsf<wbr/>Disable<wbr/>Master</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Disable<wbr/>Master<span class="tsd-signature-symbol"> = 1048576</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L141">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Disallows use of the master key to sign transactions for this account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDisallowXRP" class="tsd-anchor"></a><h3>lsf<wbr/>DisallowXRP</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>DisallowXRP<span class="tsd-signature-symbol"> = 524288</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L137">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Client applications should not send XRP to this account. Not enforced by rippled.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfGlobalFreeze" class="tsd-anchor"></a><h3>lsf<wbr/>Global<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Global<wbr/>Freeze<span class="tsd-signature-symbol"> = 4194304</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L149">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:149</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>All assets issued by this address are frozen.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfNoFreeze" class="tsd-anchor"></a><h3>lsf<wbr/>No<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>No<wbr/>Freeze<span class="tsd-signature-symbol"> = 2097152</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L145">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:145</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfPasswordSpent" class="tsd-anchor"></a><h3>lsf<wbr/>Password<wbr/>Spent</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Password<wbr/>Spent<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L125">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The account has used its free SetRegularKey transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfRequireAuth" class="tsd-anchor"></a><h3>lsf<wbr/>Require<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L133">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:133</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>This account must individually approve other users for those users to hold this account&#39;s issued currencies.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfRequireDestTag" class="tsd-anchor"></a><h3>lsf<wbr/>Require<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">lsf<wbr/>Require<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/ledger/AccountRoot.ts#L129">ripple-lib/packages/xrpl/src/models/ledger/AccountRoot.ts:129</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Requires incoming payments to specify a Destination Tag.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-namespace"><a href="LedgerEntry.AccountRootFlags.html" class="tsd-kind-icon">Account<wbr/>Root<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDefaultRipple" class="tsd-kind-icon">lsf<wbr/>Default<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDepositAuth" class="tsd-kind-icon">lsf<wbr/>Deposit<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDisableMaster" class="tsd-kind-icon">lsf<wbr/>Disable<wbr/>Master</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfDisallowXRP" class="tsd-kind-icon">lsf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfGlobalFreeze" class="tsd-kind-icon">lsf<wbr/>Global<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfNoFreeze" class="tsd-kind-icon">lsf<wbr/>No<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfPasswordSpent" class="tsd-kind-icon">lsf<wbr/>Password<wbr/>Spent</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfRequireAuth" class="tsd-kind-icon">lsf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LedgerEntry.AccountRootFlags.html#lsfRequireDestTag" class="tsd-kind-icon">lsf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/OfferCreateFlags.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OfferCreateFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="OfferCreateFlags.html">OfferCreateFlags</a></li></ul><h1>Enumeration OfferCreateFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Transaction Flags for an OfferCreate Transaction.</p>
+</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfPassive" class="tsd-kind-icon">tf<wbr/>Passive</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfSell" class="tsd-kind-icon">tf<wbr/>Sell</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfFillOrKill" class="tsd-anchor"></a><h3>tf<wbr/>Fill<wbr/>Or<wbr/>Kill</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/offerCreate.ts#L40">ripple-lib/packages/xrpl/src/models/transactions/offerCreate.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Treat the offer as a Fill or Kill order . Only try to match existing
+offers in the ledger, and only do so if the entire TakerPays quantity can
+be obtained. If the fix1578 amendment is enabled and the offer cannot be
+executed when placed, the transaction has the result code tecKILLED;
+otherwise, the transaction uses the result code tesSUCCESS even when it was
+killed without trading any currency.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfImmediateOrCancel" class="tsd-anchor"></a><h3>tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/offerCreate.ts#L31">ripple-lib/packages/xrpl/src/models/transactions/offerCreate.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>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. If the offer cannot match any offers immediately, it executes
+&quot;successfully&quot; without trading any currency. In this case, the transaction
+has the result code tesSUCCESS, but creates no Offer objects in the ledger.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfPassive" class="tsd-anchor"></a><h3>tf<wbr/>Passive</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Passive<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/offerCreate.ts#L23">ripple-lib/packages/xrpl/src/models/transactions/offerCreate.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>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.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfSell" class="tsd-anchor"></a><h3>tf<wbr/>Sell</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Sell<span class="tsd-signature-symbol"> = 524288</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/offerCreate.ts#L45">ripple-lib/packages/xrpl/src/models/transactions/offerCreate.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Exchange the entire TakerGets amount, even if it means obtaining more than
+the TakerPays amount in exchange.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr/>Create<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfPassive" class="tsd-kind-icon">tf<wbr/>Passive</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfSell" class="tsd-kind-icon">tf<wbr/>Sell</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/PaymentChannelClaimFlags.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PaymentChannelClaimFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="PaymentChannelClaimFlags.html">PaymentChannelClaimFlags</a></li></ul><h1>Enumeration PaymentChannelClaimFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enum representing values for PaymentChannelClaim transaction flags.</p>
+</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfRenew" class="tsd-kind-icon">tf<wbr/>Renew</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfClose" class="tsd-anchor"></a><h3>tf<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Close<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/paymentChannelClaim.ts#L31">ripple-lib/packages/xrpl/src/models/transactions/paymentChannelClaim.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>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&#39;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.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfRenew" class="tsd-anchor"></a><h3>tf<wbr/>Renew</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Renew<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/paymentChannelClaim.ts#L17">ripple-lib/packages/xrpl/src/models/transactions/paymentChannelClaim.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Clear the channel&#39;s Expiration time. (Expiration is different from the
+channel&#39;s immutable CancelAfter time.) Only the source address of the
+payment channel can use this flag.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfRenew" class="tsd-kind-icon">tf<wbr/>Renew</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/PaymentFlags.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PaymentFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="PaymentFlags.html">PaymentFlags</a></li></ul><h1>Enumeration PaymentFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enum representing values for Payment Transaction Flags.</p>
+</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfLimitQuality" class="tsd-kind-icon">tf<wbr/>Limit<wbr/>Quality</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfNoDirectRipple" class="tsd-kind-icon">tf<wbr/>No<wbr/>Direct<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfPartialPayment" class="tsd-kind-icon">tf<wbr/>Partial<wbr/>Payment</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfLimitQuality" class="tsd-anchor"></a><h3>tf<wbr/>Limit<wbr/>Quality</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Limit<wbr/>Quality<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/payment.ts#L36">ripple-lib/packages/xrpl/src/models/transactions/payment.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Only take paths where all the conversions have an input:output ratio that
+is equal or better than the ratio of Amount:SendMax. See Limit Quality for
+details.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfNoDirectRipple" class="tsd-anchor"></a><h3>tf<wbr/>No<wbr/>Direct<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>No<wbr/>Direct<wbr/>Ripple<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/payment.ts#L24">ripple-lib/packages/xrpl/src/models/transactions/payment.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Do not use the default path; only use paths included in the Paths field.
+This is intended to force the transaction to take arbitrage opportunities.
+Most clients do not need this.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfPartialPayment" class="tsd-anchor"></a><h3>tf<wbr/>Partial<wbr/>Payment</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Partial<wbr/>Payment<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/payment.ts#L30">ripple-lib/packages/xrpl/src/models/transactions/payment.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If the specified Amount cannot be sent without spending more than SendMax,
+reduce the received amount instead of failing outright. See Partial.
+Payments for more details.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="PaymentFlags.html" class="tsd-kind-icon">Payment<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfLimitQuality" class="tsd-kind-icon">tf<wbr/>Limit<wbr/>Quality</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfNoDirectRipple" class="tsd-kind-icon">tf<wbr/>No<wbr/>Direct<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfPartialPayment" class="tsd-kind-icon">tf<wbr/>Partial<wbr/>Payment</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/enums/TrustSetFlags.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TrustSetFlags | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="TrustSetFlags.html">TrustSetFlags</a></li></ul><h1>Enumeration TrustSetFlags</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enum representing values of <a href="../interfaces/TrustSet.html">TrustSet</a> transaction flags.</p>
+</div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetfAuth" class="tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfClearFreeze" class="tsd-anchor"></a><h3>tf<wbr/>Clear<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze<span class="tsd-signature-symbol"> = 2097152</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/trustSet.ts#L32">ripple-lib/packages/xrpl/src/models/transactions/trustSet.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Unfreeze the trust line.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfClearNoRipple" class="tsd-anchor"></a><h3>tf<wbr/>Clear<wbr/>No<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/trustSet.ts#L28">ripple-lib/packages/xrpl/src/models/transactions/trustSet.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Disable the No Ripple flag, allowing rippling on this trust line.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfSetFreeze" class="tsd-anchor"></a><h3>tf<wbr/>Set<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze<span class="tsd-signature-symbol"> = 1048576</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/trustSet.ts#L30">ripple-lib/packages/xrpl/src/models/transactions/trustSet.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Freeze the trust line.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfSetNoRipple" class="tsd-anchor"></a><h3>tf<wbr/>Set<wbr/>No<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/trustSet.ts#L26">ripple-lib/packages/xrpl/src/models/transactions/trustSet.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Enable the No Ripple flag, which blocks rippling between two trust lines.
+of the same currency if this flag is enabled on both.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfSetfAuth" class="tsd-anchor"></a><h3>tf<wbr/>Setf<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/trustSet.ts#L21">ripple-lib/packages/xrpl/src/models/transactions/trustSet.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Authorize the other party to hold currency issued by this account. (No
+effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr/>Set<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetfAuth" class="tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountChannelsRequest.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountChannelsRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountChannelsRequest.html">AccountChannelsRequest</a></li></ul><h1>Interface AccountChannelsRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The account_channels method returns information about an account&#39;s Payment
+Channels. This includes only channels where the specified account is the
+channel&#39;s source, not the destination. (A channel&#39;s &quot;source&quot; and &quot;owner&quot; are
+the same.) All information retrieved is relative to a particular version of
+the ledger. Returns an <a href="AccountChannelsResponse.html">AccountChannelsResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountChannelsRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountChannelsRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#marker" class="tsd-kind-icon">marker</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L36">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique identifier of an account, typically the account&#39;s address. The
+request returns channels where this account is the channel&#39;s owner/source.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_channels&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L30">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destination_account" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> destination_<wbr/>account</h3><div class="tsd-signature tsd-kind-icon">destination_<wbr/>account<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L42">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique identifier of an account, typically the account&#39;s address. If
+provided, filter results to payment channels whose destination is this
+account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L44">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L49">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L54">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Limit the number of transactions to retrieve. Cannot be less than 10 or
+more than 400. The default is 200.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3><div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountChannels.ts#L59">ripple-lib/packages/xrpl/src/models/methods/accountChannels.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Value from a previous paginated response. Resume retrieving data where
+that response left off.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountChannelsRequest.html" class="tsd-kind-icon">Account<wbr/>Channels<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountChannelsRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#marker" class="tsd-kind-icon">marker</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountCurrenciesRequest.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountCurrenciesRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountCurrenciesRequest.html">AccountCurrenciesRequest</a></li></ul><h1>Interface AccountCurrenciesRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The <code>account_currencies</code> command retrieves a list of currencies that an
+account can send or receive, based on its trust lines. Expects an
+<a href="AccountCurrenciesResponse.html">AccountCurrenciesResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountCurrenciesRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountCurrenciesRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountCurrencies.ts#L15">ripple-lib/packages/xrpl/src/models/methods/accountCurrencies.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique identifier for the account, most commonly the account&#39;s address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_currencies&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountCurrencies.ts#L13">ripple-lib/packages/xrpl/src/models/methods/accountCurrencies.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountCurrencies.ts#L17">ripple-lib/packages/xrpl/src/models/methods/accountCurrencies.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountCurrencies.ts#L22">ripple-lib/packages/xrpl/src/models/methods/accountCurrencies.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strict" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3><div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountCurrencies.ts#L28">ripple-lib/packages/xrpl/src/models/methods/accountCurrencies.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, then the account field only accepts a public key or XRP Ledger
+address. Otherwise, account can be a secret or passphrase (not
+recommended). The default is false.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountCurrenciesRequest.html" class="tsd-kind-icon">Account<wbr/>Currencies<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountCurrenciesRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountDelete.html

@@ -0,0 +1,53 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountDelete | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountDelete.html">AccountDelete</a></li></ul><h1>Interface AccountDelete</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>An AccountDelete transaction deletes an account and any objects it owns in
+the XRP Ledger, if possible, sending the account&#39;s remaining XRP to a
+specified destination account.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">AccountDelete</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountDelete.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountDelete.html#DestinationTag" class="tsd-kind-icon">Destination<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountDelete.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3>Account</h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L112">ripple-lib/packages/xrpl/src/models/transactions/common.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique address of the account that initiated the transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L138">ripple-lib/packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hash value identifying another transaction. If provided, this transaction
+is only valid if the sending account&#39;s previously-sent transaction matches
+the provided hash.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Destination" class="tsd-anchor"></a><h3>Destination</h3><div class="tsd-signature tsd-kind-icon">Destination<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountDelete.ts#L19">ripple-lib/packages/xrpl/src/models/transactions/accountDelete.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The address of an account to receive any leftover XRP after deleting the
+sending account. Must be a funded account in the ledger, and must not be.
+the sending account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="DestinationTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Destination<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountDelete.ts#L24">ripple-lib/packages/xrpl/src/models/transactions/accountDelete.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary destination tag that identifies a hosted recipient or other.
+information for the recipient of the deleted account&#39;s leftover XRP.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3><div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L125">ripple-lib/packages/xrpl/src/models/transactions/common.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Integer amount of XRP, in drops, to be destroyed as a cost for
+distributing this transaction to the network. Some transaction types have
+different minimum requirements.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L140">ripple-lib/packages/xrpl/src/models/transactions/common.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set of bit-flags for this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L146">ripple-lib/packages/xrpl/src/models/transactions/common.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Highest ledger index this transaction can appear in. Specifying this field
+places a strict upper limit on how long the transaction can wait to be
+validated or rejected.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3><div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L150">ripple-lib/packages/xrpl/src/models/transactions/common.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Additional arbitrary information used to identify this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L132">ripple-lib/packages/xrpl/src/models/transactions/common.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the account sending the transaction. A transaction
+is only valid if the Sequence number is exactly 1 greater than the previous
+transaction from the same account. The special case 0 means the transaction
+is using a Ticket instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3><div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L155">ripple-lib/packages/xrpl/src/models/transactions/common.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Array of objects that represent a multi-signature which authorizes this
+transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L168">ripple-lib/packages/xrpl/src/models/transactions/common.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex representation of the public key that corresponds to the private key
+used to sign this transaction. If an empty string, indicates a
+multi-signature is present in the Signers field instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L162">ripple-lib/packages/xrpl/src/models/transactions/common.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary integer used to identify the reason for this payment, or a sender
+on whose behalf this transaction is made. Conventionally, a refund should
+specify the initial payment&#39;s SourceTag as the refund payment&#39;s
+DestinationTag.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L173">ripple-lib/packages/xrpl/src/models/transactions/common.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the ticket to use in place of a Sequence number. If
+this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3>Transaction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AccountDelete&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/accountDelete.ts#L13">ripple-lib/packages/xrpl/src/models/transactions/accountDelete.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L178">ripple-lib/packages/xrpl/src/models/transactions/common.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature that verifies this transaction as originating from the
+account it says it is from.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountDelete.html" class="tsd-kind-icon">Account<wbr/>Delete</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountDelete.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountDelete.html#DestinationTag" class="tsd-kind-icon">Destination<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountDelete.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountDelete.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountInfoRequest.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountInfoRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountInfoRequest.html">AccountInfoRequest</a></li></ul><h1>Interface AccountInfoRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The <code>account_info</code> command retrieves information about an account, its
+activity, and its XRP balance. All information retrieved is relative to a
+particular version of the ledger. Returns an <a href="AccountInfoResponse.html">AccountInfoResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountInfoRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountInfoRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#queue" class="tsd-kind-icon">queue</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#signer_lists" class="tsd-kind-icon">signer_<wbr/>lists</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L16">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique identifier for the account, most commonly the account&#39;s address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_info&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L14">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L18">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L23">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="queue" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> queue</h3><div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L29">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Whether to get info about this account&#39;s queued transactions. Can only be
+used when querying for the data from the current open ledger. Not available
+from servers in Reporting Mode.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="signer_lists" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> signer_<wbr/>lists</h3><div class="tsd-signature tsd-kind-icon">signer_<wbr/>lists<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L33">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Request SignerList objects associated with this account.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strict" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3><div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountInfo.ts#L39">ripple-lib/packages/xrpl/src/models/methods/accountInfo.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, then the account field only accepts a public key or XRP Ledger
+address. Otherwise, account can be a secret or passphrase (not
+recommended). The default is false.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountInfoRequest.html" class="tsd-kind-icon">Account<wbr/>Info<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountInfoRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#queue" class="tsd-kind-icon">queue</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#signer_lists" class="tsd-kind-icon">signer_<wbr/>lists</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountLinesRequest.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountLinesRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountLinesRequest.html">AccountLinesRequest</a></li></ul><h1>Interface AccountLinesRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The account_lines method returns information about an account&#39;s trust lines,
+ including balances in all non-XRP currencies and assets. All information
+retrieved is relative to a particular version of the ledger. Expects an
+<a href="AccountLinesResponse.html">AccountLinesResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountLinesRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountLinesRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#marker" class="tsd-kind-icon">marker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#peer" class="tsd-kind-icon">peer</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L80">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique identifier for the account, most commonly the account&#39;s Address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_lines&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L78">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:78</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L82">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L87">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L97">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Limit the number of trust lines to retrieve. The server is not required to
+honor this value. Must be within the inclusive range 10 to 400.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3><div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L102">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Value from a previous paginated response. Resume retrieving data where
+that response left off.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="peer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> peer</h3><div class="tsd-signature tsd-kind-icon">peer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountLines.ts#L92">ripple-lib/packages/xrpl/src/models/methods/accountLines.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The Address of a second account. If provided, show only lines of trust
+connecting the two accounts.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountLinesRequest.html" class="tsd-kind-icon">Account<wbr/>Lines<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountLinesRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#marker" class="tsd-kind-icon">marker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#peer" class="tsd-kind-icon">peer</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountObjectsRequest.html

@@ -0,0 +1,32 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountObjectsRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountObjectsRequest.html">AccountObjectsRequest</a></li></ul><h1>Interface AccountObjectsRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The account_objects command returns the raw ledger format for all objects
+owned by an account. For a higher-level view of an account&#39;s trust lines and
+balances, see the account_lines method instead. Expects a response in the
+form of an <a href="AccountObjectsResponse.html">AccountObjectsResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountObjectsRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountObjectsRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#deletion_blockers_only" class="tsd-kind-icon">deletion_<wbr/>blockers_<wbr/>only</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#marker" class="tsd-kind-icon">marker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#type" class="tsd-kind-icon">type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L26">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique identifier for the account, most commonly the account&#39;s address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_objects&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L24">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="deletion_blockers_only" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> deletion_<wbr/>blockers_<wbr/>only</h3><div class="tsd-signature tsd-kind-icon">deletion_<wbr/>blockers_<wbr/>only<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L37">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, the response only includes objects that would block this account
+from being deleted. The default is false.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L39">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L44">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+Ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L49">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The maximum number of objects to include in the results. Must be within
+the inclusive range 10 to 400 on non-admin connections. The default is 200.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3><div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L54">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Value from a previous paginated response. Resume retrieving data where
+that response left off.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AccountObjectType</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountObjects.ts#L32">ripple-lib/packages/xrpl/src/models/methods/accountObjects.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If included, filter results to include only this type of ledger object.
+The valid types are: Check , DepositPreauth, Escrow, Offer, PayChannel,
+SignerList, Ticket, and RippleState (trust line).</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountObjectsRequest.html" class="tsd-kind-icon">Account<wbr/>Objects<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountObjectsRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#deletion_blockers_only" class="tsd-kind-icon">deletion_<wbr/>blockers_<wbr/>only</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#marker" class="tsd-kind-icon">marker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountOffersRequest.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountOffersRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountOffersRequest.html">AccountOffersRequest</a></li></ul><h1>Interface AccountOffersRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The account_offers method retrieves a list of offers made by a given account
+that are outstanding as of a particular ledger version. Expects a response in
+the form of a <a href="AccountOffersResponse.html">AccountOffersResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountOffersRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountOffersRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#marker" class="tsd-kind-icon">marker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L15">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique identifier for the account, most commonly the account&#39;s Address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_offers&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L13">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L17">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string identifying the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L22">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or &quot;current&quot;, &quot;closed&quot;, or
+&quot;validated&quot; to select a ledger dynamically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L27">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Limit the number of transactions to retrieve. The server is not required
+to honor this value. Must be within the inclusive range 10 to 400.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3><div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L32">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Value from a previous paginated response. Resume retrieving data where
+that response left off.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strict" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3><div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountOffers.ts#L38">ripple-lib/packages/xrpl/src/models/methods/accountOffers.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, then the account field only accepts a public key or XRP Ledger
+address. Otherwise, account can be a secret or passphrase (not
+recommended). The default is false.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountOffersRequest.html" class="tsd-kind-icon">Account<wbr/>Offers<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountOffersRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#marker" class="tsd-kind-icon">marker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/AccountTxRequest.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountTxRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="AccountTxRequest.html">AccountTxRequest</a></li></ul><h1>Interface AccountTxRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The account_tx method retrieves a list of transactions that involved the
+specified account. Expects a response in the form of a <a href="AccountTxResponse.html">AccountTxResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">AccountTxRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountTxRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#forward" class="tsd-kind-icon">forward</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index_max" class="tsd-kind-icon">ledger_<wbr/>index_<wbr/>max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index_min" class="tsd-kind-icon">ledger_<wbr/>index_<wbr/>min</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#marker" class="tsd-kind-icon">marker</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L16">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique identifier for the account, most commonly the account&#39;s address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="binary" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3><div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L37">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, return transactions as hex strings instead of JSON. The default is
+false.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_tx&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L14">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="forward" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> forward</h3><div class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L42">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, returns values indexed with the oldest ledger first. Otherwise,
+the results are indexed with the newest ledger first.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L30">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Use to look for transactions from a single ledger only.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L32">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Use to look for transactions from a single ledger only.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index_max" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index_<wbr/>max</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index_<wbr/>max<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L28">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Use to specify the most recent ledger to include transactions from. A
+value of -1 instructs the server to use the most recent validated ledger
+version available.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index_min" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index_<wbr/>min</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index_<wbr/>min<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L22">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Use to specify the earliest ledger to include transactions from. A value
+of -1 instructs the server to use the earliest validated ledger version
+available.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L47">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Default varies. Limit the number of transactions to retrieve. The server
+is not required to honor this value.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3><div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/accountTx.ts#L53">ripple-lib/packages/xrpl/src/models/methods/accountTx.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Value from a previous paginated response. Resume retrieving data where
+that response left off. This value is stable even if there is a change in
+the server&#39;s range of available ledgers.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AccountTxRequest.html" class="tsd-kind-icon">Account<wbr/>Tx<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountTxRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#forward" class="tsd-kind-icon">forward</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index_max" class="tsd-kind-icon">ledger_<wbr/>index_<wbr/>max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index_min" class="tsd-kind-icon">ledger_<wbr/>index_<wbr/>min</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#marker" class="tsd-kind-icon">marker</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/BookOffersRequest.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BookOffersRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="BookOffersRequest.html">BookOffersRequest</a></li></ul><h1>Interface BookOffersRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The book_offers method retrieves a list of offers, also known as the order.
+Book, between two currencies. Returns an <a href="BookOffersResponse.html">BookOffersResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">BookOffersRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="BookOffersRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker" class="tsd-kind-icon">taker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_gets" class="tsd-kind-icon">taker_<wbr/>gets</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_pays" class="tsd-kind-icon">taker_<wbr/>pays</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;book_offers&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L18">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L20">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L25">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L31">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If provided, the server does not provide more than this many offers in the
+results. The total number of results returned may be fewer than the limit,
+because the server omits unfunded offers.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> taker</h3><div class="tsd-signature tsd-kind-icon">taker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L36">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The Address of an account to use as a perspective. Unfunded offers placed
+by this account are always included in the response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker_gets" class="tsd-anchor"></a><h3>taker_<wbr/>gets</h3><div class="tsd-signature tsd-kind-icon">taker_<wbr/>gets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TakerAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L42">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Specification of which currency the account taking the offer would
+receive, as an object with currency and issuer fields (omit issuer for
+XRP), like currency amounts.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker_pays" class="tsd-anchor"></a><h3>taker_<wbr/>pays</h3><div class="tsd-signature tsd-kind-icon">taker_<wbr/>pays<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TakerAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/bookOffers.ts#L48">ripple-lib/packages/xrpl/src/models/methods/bookOffers.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Specification of which currency the account taking the offer would pay, as
+an object with currency and issuer fields (omit issuer for XRP), like
+currency amounts.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="BookOffersRequest.html" class="tsd-kind-icon">Book<wbr/>Offers<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="BookOffersRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker" class="tsd-kind-icon">taker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_gets" class="tsd-kind-icon">taker_<wbr/>gets</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_pays" class="tsd-kind-icon">taker_<wbr/>pays</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/ChannelVerifyRequest.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChannelVerifyRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="ChannelVerifyRequest.html">ChannelVerifyRequest</a></li></ul><h1>Interface ChannelVerifyRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The <code>channel_verify</code> method checks the validity of a signature that can be
+used to redeem a specific amount of XRP from a payment channel. Expects a
+response in the form of a <a href="ChannelVerifyResponse.html">ChannelVerifyResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">ChannelVerifyRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#amount" class="tsd-kind-icon">amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#channel_id" class="tsd-kind-icon">channel_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ChannelVerifyRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#public_key" class="tsd-kind-icon">public_<wbr/>key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#signature" class="tsd-kind-icon">signature</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="amount" class="tsd-anchor"></a><h3>amount</h3><div class="tsd-signature tsd-kind-icon">amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/channelVerify.ts#L13">ripple-lib/packages/xrpl/src/models/methods/channelVerify.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The amount of XRP, in drops, the provided signature authorizes.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="channel_id" class="tsd-anchor"></a><h3>channel_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">channel_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/channelVerify.ts#L18">ripple-lib/packages/xrpl/src/models/methods/channelVerify.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The Channel ID of the channel that provides the XRP. This is a
+64-character hexadecimal string.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;channel_verify&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/channelVerify.ts#L11">ripple-lib/packages/xrpl/src/models/methods/channelVerify.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="public_key" class="tsd-anchor"></a><h3>public_<wbr/>key</h3><div class="tsd-signature tsd-kind-icon">public_<wbr/>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/channelVerify.ts#L23">ripple-lib/packages/xrpl/src/models/methods/channelVerify.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The public key of the channel and the key pair that was used to create the
+signature, in hexadecimal or the XRP Ledger&#39;s base58 format.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="signature" class="tsd-anchor"></a><h3>signature</h3><div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/channelVerify.ts#L25">ripple-lib/packages/xrpl/src/models/methods/channelVerify.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature to verify, in hexadecimal.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ChannelVerifyRequest.html" class="tsd-kind-icon">Channel<wbr/>Verify<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#amount" class="tsd-kind-icon">amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#channel_id" class="tsd-kind-icon">channel_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ChannelVerifyRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#public_key" class="tsd-kind-icon">public_<wbr/>key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#signature" class="tsd-kind-icon">signature</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/CheckCancel.html

@@ -0,0 +1,50 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CheckCancel | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="CheckCancel.html">CheckCancel</a></li></ul><h1>Interface CheckCancel</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Cancels an unredeemed Check, removing it from the ledger without sending any
+money. The source or the destination of the check can cancel a Check at any
+time using this transaction type. If the Check has expired, any address can
+cancel it.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">CheckCancel</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCancel.html#CheckID" class="tsd-kind-icon">CheckID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="CheckCancel.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3>Account</h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L112">ripple-lib/packages/xrpl/src/models/transactions/common.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique address of the account that initiated the transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L138">ripple-lib/packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hash value identifying another transaction. If provided, this transaction
+is only valid if the sending account&#39;s previously-sent transaction matches
+the provided hash.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="CheckID" class="tsd-anchor"></a><h3>CheckID</h3><div class="tsd-signature tsd-kind-icon">CheckID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/checkCancel.ts#L19">ripple-lib/packages/xrpl/src/models/transactions/checkCancel.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ID of the Check ledger object to cancel as a 64-character hexadecimal
+string.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3><div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L125">ripple-lib/packages/xrpl/src/models/transactions/common.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Integer amount of XRP, in drops, to be destroyed as a cost for
+distributing this transaction to the network. Some transaction types have
+different minimum requirements.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L140">ripple-lib/packages/xrpl/src/models/transactions/common.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set of bit-flags for this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L146">ripple-lib/packages/xrpl/src/models/transactions/common.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Highest ledger index this transaction can appear in. Specifying this field
+places a strict upper limit on how long the transaction can wait to be
+validated or rejected.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3><div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L150">ripple-lib/packages/xrpl/src/models/transactions/common.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Additional arbitrary information used to identify this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L132">ripple-lib/packages/xrpl/src/models/transactions/common.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the account sending the transaction. A transaction
+is only valid if the Sequence number is exactly 1 greater than the previous
+transaction from the same account. The special case 0 means the transaction
+is using a Ticket instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3><div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L155">ripple-lib/packages/xrpl/src/models/transactions/common.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Array of objects that represent a multi-signature which authorizes this
+transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L168">ripple-lib/packages/xrpl/src/models/transactions/common.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex representation of the public key that corresponds to the private key
+used to sign this transaction. If an empty string, indicates a
+multi-signature is present in the Signers field instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L162">ripple-lib/packages/xrpl/src/models/transactions/common.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary integer used to identify the reason for this payment, or a sender
+on whose behalf this transaction is made. Conventionally, a refund should
+specify the initial payment&#39;s SourceTag as the refund payment&#39;s
+DestinationTag.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L173">ripple-lib/packages/xrpl/src/models/transactions/common.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the ticket to use in place of a Sequence number. If
+this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3>Transaction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CheckCancel&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/checkCancel.ts#L14">ripple-lib/packages/xrpl/src/models/transactions/checkCancel.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L178">ripple-lib/packages/xrpl/src/models/transactions/common.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature that verifies this transaction as originating from the
+account it says it is from.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CheckCancel.html" class="tsd-kind-icon">Check<wbr/>Cancel</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCancel.html#CheckID" class="tsd-kind-icon">CheckID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="CheckCancel.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCancel.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/CheckCash.html

@@ -0,0 +1,57 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CheckCash | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="CheckCash.html">CheckCash</a></li></ul><h1>Interface CheckCash</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Attempts to redeem a Check object in the ledger to receive up to the amount
+authorized by the corresponding CheckCreate transaction. Only the Destination
+address of a Check can cash it with a CheckCash transaction.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">CheckCash</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCash.html#Amount" class="tsd-kind-icon">Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCash.html#CheckID" class="tsd-kind-icon">CheckID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCash.html#DeliverMin" class="tsd-kind-icon">Deliver<wbr/>Min</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="CheckCash.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3>Account</h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L112">ripple-lib/packages/xrpl/src/models/transactions/common.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique address of the account that initiated the transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L138">ripple-lib/packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hash value identifying another transaction. If provided, this transaction
+is only valid if the sending account&#39;s previously-sent transaction matches
+the provided hash.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Amount" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Amount</h3><div class="tsd-signature tsd-kind-icon">Amount<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/checkCash.ts#L26">ripple-lib/packages/xrpl/src/models/transactions/checkCash.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Redeem the Check for exactly this amount, if possible. The currency must
+match that of the SendMax of the corresponding CheckCreate transaction. You.
+must provide either this field or DeliverMin.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="CheckID" class="tsd-anchor"></a><h3>CheckID</h3><div class="tsd-signature tsd-kind-icon">CheckID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/checkCash.ts#L20">ripple-lib/packages/xrpl/src/models/transactions/checkCash.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ID of the Check ledger object to cash as a 64-character hexadecimal
+string.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="DeliverMin" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Deliver<wbr/>Min</h3><div class="tsd-signature tsd-kind-icon">Deliver<wbr/>Min<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/checkCash.ts#L32">ripple-lib/packages/xrpl/src/models/transactions/checkCash.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Redeem the Check for at least this amount and for as much as possible. The
+currency must match that of the SendMax of the corresponding CheckCreate.
+transaction. You must provide either this field or Amount.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3><div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L125">ripple-lib/packages/xrpl/src/models/transactions/common.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Integer amount of XRP, in drops, to be destroyed as a cost for
+distributing this transaction to the network. Some transaction types have
+different minimum requirements.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L140">ripple-lib/packages/xrpl/src/models/transactions/common.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set of bit-flags for this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L146">ripple-lib/packages/xrpl/src/models/transactions/common.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Highest ledger index this transaction can appear in. Specifying this field
+places a strict upper limit on how long the transaction can wait to be
+validated or rejected.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3><div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L150">ripple-lib/packages/xrpl/src/models/transactions/common.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Additional arbitrary information used to identify this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L132">ripple-lib/packages/xrpl/src/models/transactions/common.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the account sending the transaction. A transaction
+is only valid if the Sequence number is exactly 1 greater than the previous
+transaction from the same account. The special case 0 means the transaction
+is using a Ticket instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3><div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L155">ripple-lib/packages/xrpl/src/models/transactions/common.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Array of objects that represent a multi-signature which authorizes this
+transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L168">ripple-lib/packages/xrpl/src/models/transactions/common.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex representation of the public key that corresponds to the private key
+used to sign this transaction. If an empty string, indicates a
+multi-signature is present in the Signers field instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L162">ripple-lib/packages/xrpl/src/models/transactions/common.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary integer used to identify the reason for this payment, or a sender
+on whose behalf this transaction is made. Conventionally, a refund should
+specify the initial payment&#39;s SourceTag as the refund payment&#39;s
+DestinationTag.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L173">ripple-lib/packages/xrpl/src/models/transactions/common.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the ticket to use in place of a Sequence number. If
+this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3>Transaction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CheckCash&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/checkCash.ts#L15">ripple-lib/packages/xrpl/src/models/transactions/checkCash.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L178">ripple-lib/packages/xrpl/src/models/transactions/common.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature that verifies this transaction as originating from the
+account it says it is from.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CheckCash.html" class="tsd-kind-icon">Check<wbr/>Cash</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCash.html#Amount" class="tsd-kind-icon">Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCash.html#CheckID" class="tsd-kind-icon">CheckID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCash.html#DeliverMin" class="tsd-kind-icon">Deliver<wbr/>Min</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="CheckCash.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCash.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/ConsensusStream.html

@@ -0,0 +1,8 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConsensusStream | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="ConsensusStream.html">ConsensusStream</a></li></ul><h1>Interface ConsensusStream</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The consensus stream sends consensusPhase messages when the consensus
+process changes phase. The message contains the new phase of consensus the
+server is in.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseStream</span><ul class="tsd-hierarchy"><li><span class="target">ConsensusStream</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConsensusStream.html#consensus" class="tsd-kind-icon">consensus</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ConsensusStream.html#type" class="tsd-kind-icon">type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="consensus" class="tsd-anchor"></a><h3>consensus</h3><div class="tsd-signature tsd-kind-icon">consensus<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;open&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;establish&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;accepted&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/subscribe.ts#L356">ripple-lib/packages/xrpl/src/models/methods/subscribe.ts:356</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The new consensus phase the server is in. Possible values are open,
+establish, and accepted.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consensusPhase&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseStream.type</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/subscribe.ts#L351">ripple-lib/packages/xrpl/src/models/methods/subscribe.ts:351</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ConsensusStream.html" class="tsd-kind-icon">Consensus<wbr/>Stream</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConsensusStream.html#consensus" class="tsd-kind-icon">consensus</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ConsensusStream.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/DepositAuthorizedRequest.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DepositAuthorizedRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="DepositAuthorizedRequest.html">DepositAuthorizedRequest</a></li></ul><h1>Interface DepositAuthorizedRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The deposit_authorized command indicates whether one account is authorized to
+send payments directly to another. Expects a response in the form of a <a href="DepositAuthorizedResponse.html">DepositAuthorizedResponse</a>.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">DepositAuthorizedRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="DepositAuthorizedRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#source_account" class="tsd-kind-icon">source_<wbr/>account</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;deposit_authorized&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/depositAuthorized.ts#L13">ripple-lib/packages/xrpl/src/models/methods/depositAuthorized.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destination_account" class="tsd-anchor"></a><h3>destination_<wbr/>account</h3><div class="tsd-signature tsd-kind-icon">destination_<wbr/>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/depositAuthorized.ts#L17">ripple-lib/packages/xrpl/src/models/methods/depositAuthorized.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The recipient of a possible payment.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/depositAuthorized.ts#L19">ripple-lib/packages/xrpl/src/models/methods/depositAuthorized.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/depositAuthorized.ts#L24">ripple-lib/packages/xrpl/src/models/methods/depositAuthorized.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger to use, or a shortcut string to choose a
+ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="source_account" class="tsd-anchor"></a><h3>source_<wbr/>account</h3><div class="tsd-signature tsd-kind-icon">source_<wbr/>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/depositAuthorized.ts#L15">ripple-lib/packages/xrpl/src/models/methods/depositAuthorized.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sender of a possible payment.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="DepositAuthorizedRequest.html" class="tsd-kind-icon">Deposit<wbr/>Authorized<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="DepositAuthorizedRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr/>account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#source_account" class="tsd-kind-icon">source_<wbr/>account</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/DepositPreauth.html

@@ -0,0 +1,51 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DepositPreauth | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="DepositPreauth.html">DepositPreauth</a></li></ul><h1>Interface DepositPreauth</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A DepositPreauth transaction gives another account pre-approval to deliver
+payments to the sender of this transaction. This is only useful if the sender
+of this transaction is using (or plans to use) Deposit Authorization.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">DepositPreauth</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositPreauth.html#Authorize" class="tsd-kind-icon">Authorize</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="DepositPreauth.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositPreauth.html#Unauthorize" class="tsd-kind-icon">Unauthorize</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3>Account</h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L112">ripple-lib/packages/xrpl/src/models/transactions/common.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique address of the account that initiated the transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L138">ripple-lib/packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hash value identifying another transaction. If provided, this transaction
+is only valid if the sending account&#39;s previously-sent transaction matches
+the provided hash.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Authorize" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Authorize</h3><div class="tsd-signature tsd-kind-icon">Authorize<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/depositPreauth.ts#L16">ripple-lib/packages/xrpl/src/models/transactions/depositPreauth.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The XRP Ledger address of the sender to preauthorize.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3><div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L125">ripple-lib/packages/xrpl/src/models/transactions/common.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Integer amount of XRP, in drops, to be destroyed as a cost for
+distributing this transaction to the network. Some transaction types have
+different minimum requirements.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L140">ripple-lib/packages/xrpl/src/models/transactions/common.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set of bit-flags for this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L146">ripple-lib/packages/xrpl/src/models/transactions/common.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Highest ledger index this transaction can appear in. Specifying this field
+places a strict upper limit on how long the transaction can wait to be
+validated or rejected.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3><div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L150">ripple-lib/packages/xrpl/src/models/transactions/common.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Additional arbitrary information used to identify this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L132">ripple-lib/packages/xrpl/src/models/transactions/common.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the account sending the transaction. A transaction
+is only valid if the Sequence number is exactly 1 greater than the previous
+transaction from the same account. The special case 0 means the transaction
+is using a Ticket instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3><div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L155">ripple-lib/packages/xrpl/src/models/transactions/common.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Array of objects that represent a multi-signature which authorizes this
+transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L168">ripple-lib/packages/xrpl/src/models/transactions/common.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex representation of the public key that corresponds to the private key
+used to sign this transaction. If an empty string, indicates a
+multi-signature is present in the Signers field instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L162">ripple-lib/packages/xrpl/src/models/transactions/common.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary integer used to identify the reason for this payment, or a sender
+on whose behalf this transaction is made. Conventionally, a refund should
+specify the initial payment&#39;s SourceTag as the refund payment&#39;s
+DestinationTag.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L173">ripple-lib/packages/xrpl/src/models/transactions/common.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the ticket to use in place of a Sequence number. If
+this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3>Transaction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;DepositPreauth&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/depositPreauth.ts#L14">ripple-lib/packages/xrpl/src/models/transactions/depositPreauth.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L178">ripple-lib/packages/xrpl/src/models/transactions/common.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature that verifies this transaction as originating from the
+account it says it is from.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Unauthorize" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Unauthorize</h3><div class="tsd-signature tsd-kind-icon">Unauthorize<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/depositPreauth.ts#L21">ripple-lib/packages/xrpl/src/models/transactions/depositPreauth.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The XRP Ledger address of a sender whose preauthorization should be.
+revoked.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr/>Preauth</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositPreauth.html#Authorize" class="tsd-kind-icon">Authorize</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="DepositPreauth.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositPreauth.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositPreauth.html#Unauthorize" class="tsd-kind-icon">Unauthorize</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/EscrowCancel.html

@@ -0,0 +1,49 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EscrowCancel | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="EscrowCancel.html">EscrowCancel</a></li></ul><h1>Interface EscrowCancel</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Return escrowed XRP to the sender.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">EscrowCancel</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCancel.html#OfferSequence" class="tsd-kind-icon">Offer<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCancel.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="EscrowCancel.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3>Account</h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L112">ripple-lib/packages/xrpl/src/models/transactions/common.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique address of the account that initiated the transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L138">ripple-lib/packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hash value identifying another transaction. If provided, this transaction
+is only valid if the sending account&#39;s previously-sent transaction matches
+the provided hash.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3><div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L125">ripple-lib/packages/xrpl/src/models/transactions/common.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Integer amount of XRP, in drops, to be destroyed as a cost for
+distributing this transaction to the network. Some transaction types have
+different minimum requirements.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L140">ripple-lib/packages/xrpl/src/models/transactions/common.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set of bit-flags for this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L146">ripple-lib/packages/xrpl/src/models/transactions/common.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Highest ledger index this transaction can appear in. Specifying this field
+places a strict upper limit on how long the transaction can wait to be
+validated or rejected.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3><div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L150">ripple-lib/packages/xrpl/src/models/transactions/common.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Additional arbitrary information used to identify this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="OfferSequence" class="tsd-anchor"></a><h3>Offer<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Offer<wbr/>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowCancel.ts#L18">ripple-lib/packages/xrpl/src/models/transactions/escrowCancel.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Transaction sequence (or Ticket  number) of EscrowCreate transaction that.
+created the escrow to cancel.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Owner" class="tsd-anchor"></a><h3>Owner</h3><div class="tsd-signature tsd-kind-icon">Owner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowCancel.ts#L13">ripple-lib/packages/xrpl/src/models/transactions/escrowCancel.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Address of the source account that funded the escrow payment.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L132">ripple-lib/packages/xrpl/src/models/transactions/common.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the account sending the transaction. A transaction
+is only valid if the Sequence number is exactly 1 greater than the previous
+transaction from the same account. The special case 0 means the transaction
+is using a Ticket instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3><div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L155">ripple-lib/packages/xrpl/src/models/transactions/common.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Array of objects that represent a multi-signature which authorizes this
+transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L168">ripple-lib/packages/xrpl/src/models/transactions/common.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex representation of the public key that corresponds to the private key
+used to sign this transaction. If an empty string, indicates a
+multi-signature is present in the Signers field instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L162">ripple-lib/packages/xrpl/src/models/transactions/common.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary integer used to identify the reason for this payment, or a sender
+on whose behalf this transaction is made. Conventionally, a refund should
+specify the initial payment&#39;s SourceTag as the refund payment&#39;s
+DestinationTag.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L173">ripple-lib/packages/xrpl/src/models/transactions/common.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the ticket to use in place of a Sequence number. If
+this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3>Transaction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EscrowCancel&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowCancel.ts#L11">ripple-lib/packages/xrpl/src/models/transactions/escrowCancel.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L178">ripple-lib/packages/xrpl/src/models/transactions/common.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature that verifies this transaction as originating from the
+account it says it is from.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="EscrowCancel.html" class="tsd-kind-icon">Escrow<wbr/>Cancel</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCancel.html#OfferSequence" class="tsd-kind-icon">Offer<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCancel.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="EscrowCancel.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCancel.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/EscrowFinish.html

@@ -0,0 +1,55 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EscrowFinish | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="EscrowFinish.html">EscrowFinish</a></li></ul><h1>Interface EscrowFinish</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Deliver XRP from a held payment to the recipient.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">EscrowFinish</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#Condition" class="tsd-kind-icon">Condition</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#OfferSequence" class="tsd-kind-icon">Offer<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="EscrowFinish.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3>Account</h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L112">ripple-lib/packages/xrpl/src/models/transactions/common.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The unique address of the account that initiated the transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L138">ripple-lib/packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hash value identifying another transaction. If provided, this transaction
+is only valid if the sending account&#39;s previously-sent transaction matches
+the provided hash.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Condition" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Condition</h3><div class="tsd-signature tsd-kind-icon">Condition<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowFinish.ts#L23">ripple-lib/packages/xrpl/src/models/transactions/escrowFinish.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex value matching the previously-supplied PREIMAGE-SHA-256.
+crypto-condition of the held payment.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3><div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L125">ripple-lib/packages/xrpl/src/models/transactions/common.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Integer amount of XRP, in drops, to be destroyed as a cost for
+distributing this transaction to the network. Some transaction types have
+different minimum requirements.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L140">ripple-lib/packages/xrpl/src/models/transactions/common.ts:140</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Set of bit-flags for this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Fulfillment" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Fulfillment</h3><div class="tsd-signature tsd-kind-icon">Fulfillment<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowFinish.ts#L28">ripple-lib/packages/xrpl/src/models/transactions/escrowFinish.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex value of the PREIMAGE-SHA-256 crypto-condition fulfillment matching.
+the held payment&#39;s Condition.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L146">ripple-lib/packages/xrpl/src/models/transactions/common.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Highest ledger index this transaction can appear in. Specifying this field
+places a strict upper limit on how long the transaction can wait to be
+validated or rejected.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3><div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L150">ripple-lib/packages/xrpl/src/models/transactions/common.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Additional arbitrary information used to identify this transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="OfferSequence" class="tsd-anchor"></a><h3>Offer<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Offer<wbr/>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowFinish.ts#L18">ripple-lib/packages/xrpl/src/models/transactions/escrowFinish.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Transaction sequence of EscrowCreate transaction that created the held.
+payment to finish.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Owner" class="tsd-anchor"></a><h3>Owner</h3><div class="tsd-signature tsd-kind-icon">Owner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowFinish.ts#L13">ripple-lib/packages/xrpl/src/models/transactions/escrowFinish.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Address of the source account that funded the held payment.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L132">ripple-lib/packages/xrpl/src/models/transactions/common.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the account sending the transaction. A transaction
+is only valid if the Sequence number is exactly 1 greater than the previous
+transaction from the same account. The special case 0 means the transaction
+is using a Ticket instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3><div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L155">ripple-lib/packages/xrpl/src/models/transactions/common.ts:155</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Array of objects that represent a multi-signature which authorizes this
+transaction.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L168">ripple-lib/packages/xrpl/src/models/transactions/common.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Hex representation of the public key that corresponds to the private key
+used to sign this transaction. If an empty string, indicates a
+multi-signature is present in the Signers field instead.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L162">ripple-lib/packages/xrpl/src/models/transactions/common.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Arbitrary integer used to identify the reason for this payment, or a sender
+on whose behalf this transaction is made. Conventionally, a refund should
+specify the initial payment&#39;s SourceTag as the refund payment&#39;s
+DestinationTag.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence</h3><div class="tsd-signature tsd-kind-icon">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L173">ripple-lib/packages/xrpl/src/models/transactions/common.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The sequence number of the ticket to use in place of a Sequence number. If
+this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3>Transaction<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EscrowFinish&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/escrowFinish.ts#L11">ripple-lib/packages/xrpl/src/models/transactions/escrowFinish.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature</h3><div class="tsd-signature tsd-kind-icon">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/transactions/common.ts#L178">ripple-lib/packages/xrpl/src/models/transactions/common.ts:178</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The signature that verifies this transaction as originating from the
+account it says it is from.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="EscrowFinish.html" class="tsd-kind-icon">Escrow<wbr/>Finish</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#Condition" class="tsd-kind-icon">Condition</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#OfferSequence" class="tsd-kind-icon">Offer<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowFinish.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="EscrowFinish.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowFinish.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/FeeRequest.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FeeRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="FeeRequest.html">FeeRequest</a></li></ul><h1>Interface FeeRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The <code>fee</code> command reports the current state of the open-ledger requirements
+for the transaction cost. This requires the FeeEscalation amendment to be
+enabled. Expects a response in the form of a <a href="FeeResponse.html">FeeResponse</a>.</p>
+</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">feeRequest</span><span class="hl-1">: </span><span class="hl-9">FeeRequest</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">command:</span><span class="hl-1"> </span><span class="hl-7">&#39;fee&#39;</span><br/><span class="hl-1">}</span>
+</code></pre>
+</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">FeeRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="FeeRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeRequest.html#id" class="tsd-kind-icon">id</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fee&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/fee.ts#L18">ripple-lib/packages/xrpl/src/models/methods/fee.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="FeeRequest.html" class="tsd-kind-icon">Fee<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="FeeRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeRequest.html#id" class="tsd-kind-icon">id</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/GatewayBalancesRequest.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GatewayBalancesRequest | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="GatewayBalancesRequest.html">GatewayBalancesRequest</a></li></ul><h1>Interface GatewayBalancesRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The gateway_balances command calculates the total balances issued by a given
+account, optionally excluding amounts held by operational addresses. Expects
+a response in the form of a <a href="GatewayBalancesResponse.html">GatewayBalancesResponse</a>.</p>
+</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">gatewayBalances</span><span class="hl-1">: </span><span class="hl-9">GatewayBalanceRequest</span><span class="hl-1"> = {</span><br/><span class="hl-1">  </span><span class="hl-7">&quot;id&quot;</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-7">&quot;example_gateway_balances_1&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-7">&quot;command&quot;</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-7">&quot;gateway_balances&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-7">&quot;account&quot;</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-7">&quot;rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-7">&quot;strict&quot;</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-7">&quot;hotwallet&quot;</span><span class="hl-4">:</span><span class="hl-1"> [</span><span class="hl-7">&quot;rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ&quot;</span><span class="hl-1">,</span><span class="hl-7">&quot;ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt&quot;</span><span class="hl-1">],</span><br/><span class="hl-1">  </span><span class="hl-7">&quot;ledger_index&quot;</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-7">&quot;validated&quot;</span><br/><span class="hl-1">}</span>
+</code></pre>
+</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">GatewayBalancesRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="GatewayBalancesRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#hotwallet" class="tsd-kind-icon">hotwallet</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account" class="tsd-anchor"></a><h3>account</h3><div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/gatewayBalances.ts#L27">ripple-lib/packages/xrpl/src/models/methods/gatewayBalances.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The Address to check. This should be the issuing address.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The API version to use. If omitted, use version 1.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;gateway_balances&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/gatewayBalances.ts#L25">ripple-lib/packages/xrpl/src/models/methods/gatewayBalances.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="hotwallet" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> hotwallet</h3><div class="tsd-signature tsd-kind-icon">hotwallet<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/gatewayBalances.ts#L37">ripple-lib/packages/xrpl/src/models/methods/gatewayBalances.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>An operational address to exclude from the balances issued, or an array of
+Such addresses.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A unique value to identify this request. The response to this request uses
+the same id field. This way, even if responses arrive out of order, you
+know which request prompted which response.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/gatewayBalances.ts#L39">ripple-lib/packages/xrpl/src/models/methods/gatewayBalances.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>A 20-byte hex string for the ledger version to use.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/gatewayBalances.ts#L44">ripple-lib/packages/xrpl/src/models/methods/gatewayBalances.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>The ledger index of the ledger version to use, or a shortcut string to
+choose a ledger automatically.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strict" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3><div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/gatewayBalances.ts#L32">ripple-lib/packages/xrpl/src/models/methods/gatewayBalances.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>If true, only accept an address or public key for the account parameter.
+Defaults to false.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="GatewayBalancesRequest.html" class="tsd-kind-icon">Gateway<wbr/>Balances<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="GatewayBalancesRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#hotwallet" class="tsd-kind-icon">hotwallet</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#strict" class="tsd-kind-icon">strict</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>