build: makes connection private

* write getLedgerIndex

* add to client

* rename file

* add tests

* remove unused import

* fix browser tests

* respond to comments, more cleanup

.eslintrc.js

@@ -47,11 +47,6 @@ module.exports = {
     // no-shadow has false-positives for enum, @typescript-eslint version fixes that
     'no-shadow': 'off',
     '@typescript-eslint/no-shadow': ['error'],
-    'multiline-comment-style': ['error', 'starred-block'],
-    'jsdoc/check-examples': 'off',
-
-    'tsdoc/syntax': 'off',
-    'jsdoc/require-description-complete-sentence': 'off',
   },
   overrides: [
     {
@@ -62,24 +57,17 @@ module.exports = {
       },
     },
     {
+      // TODO: remove when snippets are written
       files: ['snippets/src/*.ts'],
       rules: {
+        'max-len': 'off',
+        'import/unambiguous': 'off',
         'import/no-unused-modules': 'off',
-        // Each file has a particular flow.
-        'max-lines-per-function': 'off',
-        'max-statements': 'off',
-        // Snippets have logs on console to better understand the working.
-        'no-console': 'off',
       },
     },
     {
       files: ['test/**/*.ts'],
       rules: {
-        // Because this project is managed by lerna, dev dependencies are
-        // hoisted and do not appear in the package.json.
-        'import/no-extraneous-dependencies': 'off',
-        'node/no-extraneous-import': 'off',
-
         // We have lots of magic numbers in tests
         '@typescript-eslint/no-magic-numbers': 'off',
 
@@ -95,14 +83,19 @@ module.exports = {
         // We need to mess with internal things to generate certain testing situations
         '@typescript-eslint/no-unsafe-member-access': 'off',
 
+        // We need to be able to import xrpl-local
+        'node/no-extraneous-import': [
+          'error',
+          {
+            allowModules: ['xrpl-local'],
+          },
+        ],
+
         // Tests are already in 2 callbacks, so max 3 is pretty restrictive
         'max-nested-callbacks': 'off',
 
         // setup/teardown client is easier to do in before/after, even if there is only one testcase
         'mocha/no-hooks-for-single-case': 'off',
-
-        // messes with fixtures
-        'consistent-default-export-name/default-import-match-filename': 'off',
       },
     },
     {

.github/dependabot.yml

@@ -6,3 +6,8 @@ updates:
     interval: monthly
     time: "15:00"
   open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: jsonschema
+    versions:
+    - "> 1.2.2"
+    - "< 2"

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main, 1.x ]
+    branches: [ develop, master ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [ develop ]
   schedule:
     - cron: '44 5 * * 6'
 

.github/workflows/nodejs.yml

@@ -5,7 +5,7 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ main, 1.x ]
+    branches: [ develop, master, 2.0 ]
   pull_request:
   workflow_dispatch:
 
@@ -23,10 +23,9 @@ jobs:
       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 install
     - run: npm run lint
+    - run: npm run build
 
   unit:
     runs-on: ubuntu-latest
@@ -42,9 +41,7 @@ jobs:
       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 install --ignore-engines
     - run: npm test
 
   integration:
@@ -68,9 +65,7 @@ jobs:
       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 install --ignore-engines
     - run: npm run test:integration
       env:
         HOST: localhost
@@ -97,7 +92,5 @@ jobs:
       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 install
     - run: npm run test:browser

.gitignore

@@ -71,6 +71,3 @@ scripts/cache
 
 # browser tests
 testCompiledForWeb
-
-# lerna debug
-lerna-debug.log

.travis.yml

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

.vscode/settings.json

@@ -1,8 +1,5 @@
 {
     "editor.tabSize": 2,
-    "cSpell.words": [
-      "secp256k1"
-    ],
     "[javascript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode",
         "editor.formatOnSave": true

APPLICATIONS.md

@@ -109,10 +109,6 @@ Warning: Use at your own risk.
 - **[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.
-  
-- **[Trustline](https://trustline.co)**
-
-  A decentralized stablecoin wallet that runs on the XRP Ledger.
 
 ## Send and request payments
 

CONTRIBUTING.md

@@ -1,168 +0,0 @@
-# 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](https://js.xrpl.org). You can also generate them locally using `typedoc`:
-
-```bash
-npm run docgen
-```
-
-This updates `docs/` at the top level, where GitHub Pages looks for the docs.
-
-## 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.
-___
-NOW WE ARE READY TO PUBLISH! No new code changes happen manually now.
-___
-3. Checkout `main` and `git pull`.
-4. Create a new branch to capture updates that take place during this process. `git checkout -b <BRANCH_NAME>`
-5. Run `npm run build` to triple check the build still works
-6. Run `npx lerna version --no-git-tag-version` - This creates a draft PR and release tags for the new version.
-7. 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.
-8. Run `npm i` to update the package-lock with the updated versions
-9. Create a new PR from this branch into `main` and merge it.
-10. Checkout `main` and `git pull`
-11. Run `npx lerna publish from-package --yes` - This will actually publish the packages.
-12. If it asks for it, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
-13. Create a new branch to capture the updated packages from the release (`git checkout -b <BRANCH_NAME>`)
-14. Make a PR to merge those changes into `main`
-
-___
-NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
-___
-15. Pull the most recent changes to main locally.
-16. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `xrpl@2.1.1`), for each version released.
-17. Run `git push --follow-tags`, to push the tags to Github.
-18. On Github, click the "releases" link on the right-hand side of the page.
-19. Click "Draft a new release"
-20. Click "Choose a tag", and choose a tag that you just created.
-21. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
-22. Repeat steps 19-21 for each release.
-23. 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)

README.md

@@ -3,71 +3,46 @@
 A JavaScript/TypeScript library for interacting with the XRP Ledger
 
 [![NPM](https://nodei.co/npm/xrpl.png)](https://www.npmjs.org/package/xrpl)
-![npm bundle size](https://img.shields.io/bundlephobia/min/xrpl)
 
 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.
 
-## [➡️ Reference Documentation](http://js.xrpl.org)
+## [➡️ Reference Documentation](https://xrpl.org/rippleapi-reference.html)
 
-See the full reference documentation for all classes, methods, and utilities.
+See the full reference documentation on the XRP Ledger Dev Portal.
 
-## [➡️ Applications and Projects](https://github.com/XRPLF/xrpl.js/blob/main/APPLICATIONS.md)
+## [➡️ Applications and Projects](APPLICATIONS.md)
 
-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!
+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!
 
 ### Features
 
-+ 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)
++ Connect to a `rippled` server from Node.js or a web browser
++ Helpers for creating requests and parsing responses for the [rippled API](https://developers.ripple.com/rippled-api.html)
 + Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)
 + Sign and submit transactions to the XRP Ledger
 + Type definitions for TypeScript
 
 ### Requirements
 
-+ **[Node.js v14](https://nodejs.org/)** is recommended. We also support v12 and v16. Other versions may work but are not frequently tested.
++ **[Node.js v14](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
++ **[npm](https://www.npmjs.com/)** is recommended. `yarn` may work but we use `package-lock.json`.
 
 ## Getting Started
 
+See also: [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
+
 In an existing project (with `package.json`), install `xrpl.js`:
-
 ```
-$ npm install --save xrpl
+$ npm install xrpl
 ```
 
-Or with `yarn`:
-
-```
-$ yarn add xrpl
-```
-
-Example usage:
-
-```js
-const xrpl = require("xrpl")
-async function main() {
-  const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
-  await client.connect()
-
-  const response = await client.request({
-    "command": "account_info",
-    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
-    "ledger_index": "validated"
-  })
-  console.log(response)
-
-  client.disconnect()
-}
-main()
-```
-
-For more examples, see the [documentation](#documentation).
+Then see the [documentation](#documentation).
 
 ### Using xrpl.js with React Native
 
-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).
+If you want to use `xrpl.js` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
 
-1. Install dependencies (you can use `yarn` as well):
+1. Install dependencies (you can use `npm` as well):
 
     ```shell
     npm install react-native-crypto
@@ -112,7 +87,7 @@ Until official support for [Deno](https://deno.land) is added, you can use the f
 import xrpl from 'https://dev.jspm.io/npm:xrpl';
 
 (async () => {
-  const api = new (xrpl as any).Client('wss://s.altnet.rippletest.net:51233');
+  const api = new (xrpl as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
   const address = 'rH8NxV12EuV...khfJ5uw9kT';
 
   api.connect().then(() => {
@@ -125,22 +100,51 @@ import xrpl from 'https://dev.jspm.io/npm:xrpl';
 
 ## 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)
++ [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html)
++ [RippleAPI Full Reference Documentation](https://xrpl.org/rippleapi-reference.html) ([in this repo](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md))
++ [Code Samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
 
 ### Mailing Lists
 
-We have a low-traffic mailing list for announcements of new `xrpl.js` releases. (About 1 email per week)
+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)
++ [Subscribe to ripple-lib-announce](https://groups.google.com/forum/#!forum/ripple-lib-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)
++ [Subscribe to ripple-server](https://groups.google.com/forum/#!forum/ripple-server)
+
+## Development
+
+To build the library for Node.js and the browser:
+```
+$ npm run build
+```
+
+The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
+
+webpack will output the resulting JS files in `./build/`.
+
+For details, see the `scripts` in `package.json`.
+
+## Running Tests
+
+### Unit Tests
+
+1. Clone the repository
+2. `cd` into the repository and install dependencies with `npm install`
+3. `npm test`
+
+### Linting
+
+Run `npm run lint` to lint the code with `eslint`.
+
+## Generating Documentation
+
+Update the documentation by running `npm run docgen`.
 
 ## 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)
++ [ripple-lib-announce mailing list](https://groups.google.com/forum/#!forum/ripple-lib-announce) - subscribe for release announcements
++ [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal
++ [XRP Ledger Dev Portal](https://xrpl.org/)

docs/.nojekyll

@@ -1 +0,0 @@
-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

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

docs/assets/highlight.css

@@ -1,106 +0,0 @@
-: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: #F5F5F5;
-    --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/enums/AccountSetAsfFlags.html

@@ -1,28 +0,0 @@
-<!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#asfAuthorizedNFTokenMinter" class="tsd-kind-icon">asf<wbr/>AuthorizedNFToken<wbr/>Minter</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 class="tsd-anchor-link">asf<wbr/>Account<wbr/>TxnID<a href="#asfAccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L31">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="asfAuthorizedNFTokenMinter" class="tsd-anchor"></a><h3 class="tsd-anchor-link">asf<wbr/>AuthorizedNFToken<wbr/>Minter<a href="#asfAuthorizedNFTokenMinter" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>AuthorizedNFToken<wbr/>Minter<span class="tsd-signature-symbol"> = 10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L46">packages/xrpl/src/models/transactions/accountSet.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Allow another account to mint and burn tokens on behalf of this account.</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 class="tsd-anchor-link">asf<wbr/>Default<wbr/>Ripple<a href="#asfDefaultRipple" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L40">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 class="tsd-anchor-link">asf<wbr/>Deposit<wbr/>Auth<a href="#asfDepositAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L42">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 class="tsd-anchor-link">asf<wbr/>Disable<wbr/>Master<a href="#asfDisableMaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L26">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 class="tsd-anchor-link">asf<wbr/>DisallowXRP<a href="#asfDisallowXRP" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L20">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 class="tsd-anchor-link">asf<wbr/>Global<wbr/>Freeze<a href="#asfGlobalFreeze" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L38">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 class="tsd-anchor-link">asf<wbr/>No<wbr/>Freeze<a href="#asfNoFreeze" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L36">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 class="tsd-anchor-link">asf<wbr/>Require<wbr/>Auth<a href="#asfRequireAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L18">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 class="tsd-anchor-link">asf<wbr/>Require<wbr/>Dest<a href="#asfRequireDest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L13">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#asfAuthorizedNFTokenMinter" class="tsd-kind-icon">asf<wbr/>AuthorizedNFToken<wbr/>Minter</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

@@ -1,15 +0,0 @@
-<!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 class="tsd-anchor-link">tf<wbr/>AllowXRP<a href="#tfAllowXRP" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L66">packages/xrpl/src/models/transactions/accountSet.ts:66</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 class="tsd-anchor-link">tf<wbr/>DisallowXRP<a href="#tfDisallowXRP" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L64">packages/xrpl/src/models/transactions/accountSet.ts:64</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 class="tsd-anchor-link">tf<wbr/>Optional<wbr/>Auth<a href="#tfOptionalAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L62">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: 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 class="tsd-anchor-link">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag<a href="#tfOptionalDestTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L58">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: 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 class="tsd-anchor-link">tf<wbr/>Require<wbr/>Auth<a href="#tfRequireAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L60">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: 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 class="tsd-anchor-link">tf<wbr/>Require<wbr/>Dest<wbr/>Tag<a href="#tfRequireDestTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountSet.ts#L56">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: 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/NFTokenCreateOfferFlags.html

@@ -1,6 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NFTokenCreateOfferFlags | 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="NFTokenCreateOfferFlags.html">NFTokenCreateOfferFlags</a></li></ul><h1>Enumeration NFTokenCreateOfferFlags</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 NFTokenCreateOffer 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="NFTokenCreateOfferFlags.html#tfSellToken" class="tsd-kind-icon">tf<wbr/>Sell<wbr/>Token</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="tfSellToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tf<wbr/>Sell<wbr/>Token<a href="#tfSellToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Sell<wbr/>Token<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L23">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>If set, indicates that the offer is a sell offer.
-Otherwise, it is a buy offer.</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="NFTokenCreateOfferFlags.html" class="tsd-kind-icon">NFToken<wbr/>Create<wbr/>Offer<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenCreateOfferFlags.html#tfSellToken" class="tsd-kind-icon">tf<wbr/>Sell<wbr/>Token</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/NFTokenMintFlags.html

@@ -1,16 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NFTokenMintFlags | 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="NFTokenMintFlags.html">NFTokenMintFlags</a></li></ul><h1>Enumeration NFTokenMintFlags</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 NFTokenMint 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="NFTokenMintFlags.html#tfBurnable" class="tsd-kind-icon">tf<wbr/>Burnable</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfOnlyXRP" class="tsd-kind-icon">tf<wbr/>OnlyXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfTransferable" class="tsd-kind-icon">tf<wbr/>Transferable</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfTrustLine" class="tsd-kind-icon">tf<wbr/>Trust<wbr/>Line</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="tfBurnable" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tf<wbr/>Burnable<a href="#tfBurnable" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Burnable<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/NFTokenMint.ts#L16">packages/xrpl/src/models/transactions/NFTokenMint.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>If set, indicates that the minted token may be burned by the issuer even
-if the issuer does not currently hold the token. The current holder of
-the token may always burn it.</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfOnlyXRP" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tf<wbr/>OnlyXRP<a href="#tfOnlyXRP" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>OnlyXRP<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/NFTokenMint.ts#L20">packages/xrpl/src/models/transactions/NFTokenMint.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>If set, indicates that the token may only be offered or sold for XRP.</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfTransferable" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tf<wbr/>Transferable<a href="#tfTransferable" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Transferable<span class="tsd-signature-symbol"> = 8</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/NFTokenMint.ts#L31">packages/xrpl/src/models/transactions/NFTokenMint.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>If set, indicates that this NFT can be transferred. This flag has no
-effect if the token is being transferred from the issuer or to the
-issuer.</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="tfTrustLine" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tf<wbr/>Trust<wbr/>Line<a href="#tfTrustLine" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Trust<wbr/>Line<span class="tsd-signature-symbol"> = 4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/NFTokenMint.ts#L25">packages/xrpl/src/models/transactions/NFTokenMint.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>If set, indicates that the issuer wants a trustline to be automatically
-created.</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="NFTokenMintFlags.html" class="tsd-kind-icon">NFToken<wbr/>Mint<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfBurnable" class="tsd-kind-icon">tf<wbr/>Burnable</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfOnlyXRP" class="tsd-kind-icon">tf<wbr/>OnlyXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfTransferable" class="tsd-kind-icon">tf<wbr/>Transferable</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="NFTokenMintFlags.html#tfTrustLine" class="tsd-kind-icon">tf<wbr/>Trust<wbr/>Line</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

@@ -1,23 +0,0 @@
-<!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 class="tsd-anchor-link">tf<wbr/>Fill<wbr/>Or<wbr/>Kill<a href="#tfFillOrKill" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/offerCreate.ts#L40">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 class="tsd-anchor-link">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel<a href="#tfImmediateOrCancel" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/offerCreate.ts#L31">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 class="tsd-anchor-link">tf<wbr/>Passive<a href="#tfPassive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/offerCreate.ts#L23">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 class="tsd-anchor-link">tf<wbr/>Sell<a href="#tfSell" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/offerCreate.ts#L45">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

@@ -1,19 +0,0 @@
-<!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 class="tsd-anchor-link">tf<wbr/>Close<a href="#tfClose" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/paymentChannelClaim.ts#L31">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 class="tsd-anchor-link">tf<wbr/>Renew<a href="#tfRenew" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/paymentChannelClaim.ts#L17">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

@@ -1,15 +0,0 @@
-<!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 class="tsd-anchor-link">tf<wbr/>Limit<wbr/>Quality<a href="#tfLimitQuality" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/payment.ts#L36">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 class="tsd-anchor-link">tf<wbr/>No<wbr/>Direct<wbr/>Ripple<a href="#tfNoDirectRipple" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/payment.ts#L24">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 class="tsd-anchor-link">tf<wbr/>Partial<wbr/>Payment<a href="#tfPartialPayment" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/payment.ts#L30">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

@@ -1,15 +0,0 @@
-<!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 class="tsd-anchor-link">tf<wbr/>Clear<wbr/>Freeze<a href="#tfClearFreeze" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/trustSet.ts#L32">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 class="tsd-anchor-link">tf<wbr/>Clear<wbr/>No<wbr/>Ripple<a href="#tfClearNoRipple" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/trustSet.ts#L28">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 class="tsd-anchor-link">tf<wbr/>Set<wbr/>Freeze<a href="#tfSetFreeze" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/trustSet.ts#L30">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 class="tsd-anchor-link">tf<wbr/>Set<wbr/>No<wbr/>Ripple<a href="#tfSetNoRipple" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/trustSet.ts#L26">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 class="tsd-anchor-link">tf<wbr/>Setf<wbr/>Auth<a href="#tfSetfAuth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/trustSet.ts#L21">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

@@ -1,31 +1,283 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L36">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L30">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> destination_<wbr/>account<a href="#destination_account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L42">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L44">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L49">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L54">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> marker<a href="#marker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountChannels.ts#L59">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountChannelsRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/accountChannels.ts#L22">src/models/methods/accountChannels.ts:22</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountChannels.ts#L21">src/models/methods/accountChannels.ts:21</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountChannels.ts#L23">src/models/methods/accountChannels.ts:23</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountChannels.ts#L24">src/models/methods/accountChannels.ts:24</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountChannels.ts#L25">src/models/methods/accountChannels.ts:25</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="limit" class="tsd-anchor"></a>
+					<h3>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/0c571f2e/src/models/methods/accountChannels.ts#L26">src/models/methods/accountChannels.ts:26</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountChannels.ts#L27">src/models/methods/accountChannels.ts:27</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/AccountCurrenciesRequest.html

@@ -1,22 +1,269 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountCurrencies.ts#L15">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountCurrencies.ts#L13">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountCurrencies.ts#L17">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountCurrencies.ts#L22">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> strict<a href="#strict" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountCurrencies.ts#L28">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountCurrenciesRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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"><a href="AccountCurrenciesRequest.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="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 name="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/0c571f2e/src/models/methods/accountCurrencies.ts#L7">src/models/methods/accountCurrencies.ts:7</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountCurrencies.ts#L6">src/models/methods/accountCurrencies.ts:6</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountCurrencies.ts#L8">src/models/methods/accountCurrencies.ts:8</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountCurrencies.ts#L9">src/models/methods/accountCurrencies.ts:9</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountCurrencies.ts#L10">src/models/methods/accountCurrencies.ts:10</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountCurrencies.ts#L11">src/models/methods/accountCurrencies.ts:11</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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">
+								<a href="AccountCurrenciesRequest.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="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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/AccountDelete.html

@@ -1,53 +0,0 @@
-<!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 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</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 class="tsd-anchor-link">Destination<a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountDelete.ts#L19">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr/>Tag<a href="#DestinationTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountDelete.ts#L24">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</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 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/accountDelete.ts#L13">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</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

@@ -1,28 +1,283 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L16">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L14">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L18">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L23">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> queue<a href="#queue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L29">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> signer_<wbr/>lists<a href="#signer_lists" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L33">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> strict<a href="#strict" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountInfo.ts#L39">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountInfoRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/accountInfo.ts#L8">src/models/methods/accountInfo.ts:8</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountInfo.ts#L7">src/models/methods/accountInfo.ts:7</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountInfo.ts#L9">src/models/methods/accountInfo.ts:9</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountInfo.ts#L10">src/models/methods/accountInfo.ts:10</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountInfo.ts#L11">src/models/methods/accountInfo.ts:11</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountInfo.ts#L12">src/models/methods/accountInfo.ts:12</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountInfo.ts#L13">src/models/methods/accountInfo.ts:13</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/AccountLinesRequest.html

@@ -1,28 +1,283 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L80">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L78">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L82">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L87">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L97">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> marker<a href="#marker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L102">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> peer<a href="#peer" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountLines.ts#L92">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountLinesRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/accountLines.ts#L23">src/models/methods/accountLines.ts:23</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountLines.ts#L22">src/models/methods/accountLines.ts:22</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountLines.ts#L24">src/models/methods/accountLines.ts:24</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountLines.ts#L25">src/models/methods/accountLines.ts:25</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountLines.ts#L27">src/models/methods/accountLines.ts:27</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountLines.ts#L28">src/models/methods/accountLines.ts:28</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountLines.ts#L26">src/models/methods/accountLines.ts:26</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/AccountNFTsRequest.html

@@ -1,18 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AccountNFTsRequest | 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="AccountNFTsRequest.html">AccountNFTsRequest</a></li></ul><h1>Interface AccountNFTsRequest</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_nfts</code> method retrieves all of the NFTs currently owned by the
-specified account.</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">AccountNFTsRequest</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="AccountNFTsRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountNFTsRequest.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="AccountNFTsRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountNFTsRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountNFTsRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountNFTsRequest.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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountNFTs.ts#L15">packages/xrpl/src/models/methods/accountNFTs.ts:15</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 NFTs owned by this account.</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_nfts&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountNFTs.ts#L10">packages/xrpl/src/models/methods/accountNFTs.ts:10</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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="limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountNFTs.ts#L19">packages/xrpl/src/models/methods/accountNFTs.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
-<p>Limit the number of NFTokens to retrieve.</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> marker<a href="#marker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountNFTs.ts#L24">packages/xrpl/src/models/methods/accountNFTs.ts:24</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="AccountNFTsRequest.html" class="tsd-kind-icon">AccountNFTs<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountNFTsRequest.html#account" class="tsd-kind-icon">account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountNFTsRequest.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="AccountNFTsRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountNFTsRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountNFTsRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountNFTsRequest.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/AccountObjectsRequest.html

@@ -1,32 +1,297 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L26">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L24">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> deletion_<wbr/>blockers_<wbr/>only<a href="#deletion_blockers_only" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L37">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L39">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L44">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L49">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> marker<a href="#marker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L54">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountObjects.ts#L32">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountObjectsRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/accountObjects.ts#L17">src/models/methods/accountObjects.ts:17</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L16">src/models/methods/accountObjects.ts:16</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L19">src/models/methods/accountObjects.ts:19</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L20">src/models/methods/accountObjects.ts:20</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L21">src/models/methods/accountObjects.ts:21</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L22">src/models/methods/accountObjects.ts:22</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L23">src/models/methods/accountObjects.ts:23</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountObjects.ts#L18">src/models/methods/accountObjects.ts:18</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/AccountOffersRequest.html

@@ -1,28 +1,283 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L15">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L13">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L17">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L22">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L27">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> marker<a href="#marker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L32">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> strict<a href="#strict" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountOffers.ts#L38">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountOffersRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/accountOffers.ts#L7">src/models/methods/accountOffers.ts:7</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountOffers.ts#L6">src/models/methods/accountOffers.ts:6</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountOffers.ts#L8">src/models/methods/accountOffers.ts:8</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountOffers.ts#L9">src/models/methods/accountOffers.ts:9</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountOffers.ts#L10">src/models/methods/accountOffers.ts:10</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountOffers.ts#L11">src/models/methods/accountOffers.ts:11</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountOffers.ts#L12">src/models/methods/accountOffers.ts:12</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/AccountTxRequest.html

@@ -1,37 +1,325 @@
-<!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 class="tsd-anchor-link">account<a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L16">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> binary<a href="#binary" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L37">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L14">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> forward<a href="#forward" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L42">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L30">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L32">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index_<wbr/>max<a href="#ledger_index_max" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L28">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index_<wbr/>min<a href="#ledger_index_min" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L22">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L47">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> marker<a href="#marker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/accountTx.ts#L53">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AccountTxRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/accountTx.ts#L9">src/models/methods/accountTx.ts:9</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L14">src/models/methods/accountTx.ts:14</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L8">src/models/methods/accountTx.ts:8</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L15">src/models/methods/accountTx.ts:15</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L12">src/models/methods/accountTx.ts:12</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L13">src/models/methods/accountTx.ts:13</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L11">src/models/methods/accountTx.ts:11</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L10">src/models/methods/accountTx.ts:10</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L16">src/models/methods/accountTx.ts:16</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/accountTx.ts#L17">src/models/methods/accountTx.ts:17</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface">
+						<a href="AccountTxRequest.html" class="tsd-kind-icon">Account<wbr>TxRequest</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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/BookOffersRequest.html

@@ -1,30 +1,283 @@
-<!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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L18">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L20">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L25">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L31">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> taker<a href="#taker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L36">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 class="tsd-anchor-link">taker_<wbr/>gets<a href="#taker_gets" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L42">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 class="tsd-anchor-link">taker_<wbr/>pays<a href="#taker_pays" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/bookOffers.ts#L48">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>BookOffersRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L12">src/models/methods/bookOffers.ts:12</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L13">src/models/methods/bookOffers.ts:13</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L14">src/models/methods/bookOffers.ts:14</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L15">src/models/methods/bookOffers.ts:15</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L16">src/models/methods/bookOffers.ts:16</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L17">src/models/methods/bookOffers.ts:17</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/bookOffers.ts#L18">src/models/methods/bookOffers.ts:18</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/ChannelVerifyRequest.html

@@ -1,21 +1,255 @@
-<!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 class="tsd-anchor-link">amount<a href="#amount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/channelVerify.ts#L13">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">channel_<wbr/>id<a href="#channel_id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/channelVerify.ts#L18">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/channelVerify.ts#L11">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link">public_<wbr/>key<a href="#public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/channelVerify.ts#L23">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 class="tsd-anchor-link">signature<a href="#signature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/channelVerify.ts#L25">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>ChannelVerifyRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/channelVerify.ts#L5">src/models/methods/channelVerify.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/channelVerify.ts#L6">src/models/methods/channelVerify.ts:6</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/channelVerify.ts#L4">src/models/methods/channelVerify.ts:4</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/channelVerify.ts#L7">src/models/methods/channelVerify.ts:7</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/channelVerify.ts#L8">src/models/methods/channelVerify.ts:8</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/CheckCancel.html

@@ -1,50 +0,0 @@
-<!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 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</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 class="tsd-anchor-link">CheckID<a href="#CheckID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/checkCancel.ts#L19">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</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 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/checkCancel.ts#L14">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</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

@@ -1,57 +0,0 @@
-<!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 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Amount<a href="#Amount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/checkCash.ts#L26">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 class="tsd-anchor-link">CheckID<a href="#CheckID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/checkCash.ts#L20">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Deliver<wbr/>Min<a href="#DeliverMin" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/checkCash.ts#L32">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</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 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/checkCash.ts#L15">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</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

@@ -1,8 +1,183 @@
-<!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 class="tsd-anchor-link">consensus<a href="#consensus" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/subscribe.ts#L372">packages/xrpl/src/models/methods/subscribe.ts:372</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 class="tsd-anchor-link">type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/subscribe.ts#L367">packages/xrpl/src/models/methods/subscribe.ts:367</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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>ConsensusStream | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/subscribe.ts#L111">src/models/methods/subscribe.ts:111</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/subscribe.ts#L110">src/models/methods/subscribe.ts:110</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/DepositAuthorizedRequest.html

@@ -1,19 +1,255 @@
-<!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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/depositAuthorized.ts#L13">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 class="tsd-anchor-link">destination_<wbr/>account<a href="#destination_account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/depositAuthorized.ts#L17">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/depositAuthorized.ts#L19">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/depositAuthorized.ts#L24">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 class="tsd-anchor-link">source_<wbr/>account<a href="#source_account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/depositAuthorized.ts#L15">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>DepositAuthorizedRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/depositAuthorized.ts#L6">src/models/methods/depositAuthorized.ts:6</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/depositAuthorized.ts#L8">src/models/methods/depositAuthorized.ts:8</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/depositAuthorized.ts#L9">src/models/methods/depositAuthorized.ts:9</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/depositAuthorized.ts#L10">src/models/methods/depositAuthorized.ts:10</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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/0c571f2e/src/models/methods/depositAuthorized.ts#L7">src/models/methods/depositAuthorized.ts:7</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/DepositPreauth.html

@@ -1,51 +0,0 @@
-<!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 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Authorize<a href="#Authorize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/depositPreauth.ts#L16">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</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 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/depositPreauth.ts#L14">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Unauthorize<a href="#Unauthorize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/depositPreauth.ts#L21">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

@@ -1,49 +0,0 @@
-<!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 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</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 class="tsd-anchor-link">Offer<wbr/>Sequence<a href="#OfferSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowCancel.ts#L18">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 class="tsd-anchor-link">Owner<a href="#Owner" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowCancel.ts#L13">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</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 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowCancel.ts#L11">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</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

@@ -1,55 +0,0 @@
-<!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 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Condition<a href="#Condition" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowFinish.ts#L23">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fulfillment<a href="#Fulfillment" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowFinish.ts#L28">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</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 class="tsd-anchor-link">Offer<wbr/>Sequence<a href="#OfferSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowFinish.ts#L18">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 class="tsd-anchor-link">Owner<a href="#Owner" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowFinish.ts#L13">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</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 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/escrowFinish.ts#L11">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</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/FederatorInfoRequest.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FederatorInfoRequest | 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="FederatorInfoRequest.html">FederatorInfoRequest</a></li></ul><h1>Interface FederatorInfoRequest</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>federator_info</code> command asks the federator for information
-about the door account and other bridge-related information. This
-method only exists on sidechain federators. Expects a response in
-the form of a <a href="FederatorInfoResponse.html">FederatorInfoResponse</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">FederatorInfoRequest</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="FederatorInfoRequest.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="FederatorInfoRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FederatorInfoRequest.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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;federator_info&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/federatorInfo.ts#L12">packages/xrpl/src/models/methods/federatorInfo.ts:12</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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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="FederatorInfoRequest.html" class="tsd-kind-icon">Federator<wbr/>Info<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FederatorInfoRequest.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="FederatorInfoRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FederatorInfoRequest.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/FeeRequest.html

@@ -1,13 +1,199 @@
-<!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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L14">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 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/fee.ts#L18">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 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/02a5599b/packages/xrpl/src/models/methods/baseMethod.ts#L10">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>
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>FeeRequest | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</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-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 name="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/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
+					<a name="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/0c571f2e/src/models/methods/fee.ts#L4">src/models/methods/fee.ts:4</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
+					<a name="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/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<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>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/FormattedOrderCancellation.html

@@ -0,0 +1,163 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>FormattedOrderCancellation | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</a>
+				</li>
+				<li>
+					<a href="FormattedOrderCancellation.html">FormattedOrderCancellation</a>
+				</li>
+			</ul>
+			<h1>Interface FormattedOrderCancellation</h1>
+		</div>
+	</div>
+</header>
+<div class="container container-main">
+	<div class="row">
+		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-hierarchy">
+				<h3>Hierarchy</h3>
+				<ul class="tsd-hierarchy">
+					<li>
+						<span class="target">FormattedOrderCancellation</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>Properties</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellation.html#orderSequence" class="tsd-kind-icon">order<wbr>Sequence</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 name="orderSequence" class="tsd-anchor"></a>
+					<h3>order<wbr>Sequence</h3>
+					<div class="tsd-signature tsd-kind-icon">order<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/0c571f2e/src/transaction/types.ts#L100">src/transaction/types.ts:100</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface">
+						<a href="FormattedOrderCancellation.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellation.html#orderSequence" class="tsd-kind-icon">order<wbr>Sequence</a>
+							</li>
+						</ul>
+					</li>
+				</ul>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/FormattedOrderCancellationTransaction.html

@@ -0,0 +1,233 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>FormattedOrderCancellationTransaction | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</a>
+				</li>
+				<li>
+					<a href="FormattedOrderCancellationTransaction.html">FormattedOrderCancellationTransaction</a>
+				</li>
+			</ul>
+			<h1>Interface FormattedOrderCancellationTransaction</h1>
+		</div>
+	</div>
+</header>
+<div class="container container-main">
+	<div class="row">
+		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-hierarchy">
+				<h3>Hierarchy</h3>
+				<ul class="tsd-hierarchy">
+					<li>
+						<span class="target">FormattedOrderCancellationTransaction</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>Properties</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#address" class="tsd-kind-icon">address</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#id" class="tsd-kind-icon">id</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.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 name="address" class="tsd-anchor"></a>
+					<h3>address</h3>
+					<div class="tsd-signature tsd-kind-icon">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/0c571f2e/src/transaction/types.ts#L137">src/transaction/types.ts:137</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="id" class="tsd-anchor"></a>
+					<h3>id</h3>
+					<div class="tsd-signature tsd-kind-icon">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/0c571f2e/src/transaction/types.ts#L136">src/transaction/types.ts:136</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="outcome" class="tsd-anchor"></a>
+					<h3>outcome</h3>
+					<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L135">src/transaction/types.ts:135</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="sequence" class="tsd-anchor"></a>
+					<h3>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">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L138">src/transaction/types.ts:138</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="specification" class="tsd-anchor"></a>
+					<h3>specification</h3>
+					<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <a href="FormattedOrderCancellation.html" class="tsd-signature-type" data-tsd-kind="Interface">FormattedOrderCancellation</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L134">src/transaction/types.ts:134</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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">string</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L133">src/transaction/types.ts:133</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface">
+						<a href="FormattedOrderCancellationTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation<wbr>Transaction</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellationTransaction.html#address" class="tsd-kind-icon">address</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellationTransaction.html#id" class="tsd-kind-icon">id</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellationTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellationTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellationTransaction.html#specification" class="tsd-kind-icon">specification</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderCancellationTransaction.html#type" class="tsd-kind-icon">type</a>
+							</li>
+						</ul>
+					</li>
+				</ul>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/FormattedOrderTransaction.html

@@ -0,0 +1,233 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>FormattedOrderTransaction | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</a>
+				</li>
+				<li>
+					<a href="FormattedOrderTransaction.html">FormattedOrderTransaction</a>
+				</li>
+			</ul>
+			<h1>Interface FormattedOrderTransaction</h1>
+		</div>
+	</div>
+</header>
+<div class="container container-main">
+	<div class="row">
+		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-hierarchy">
+				<h3>Hierarchy</h3>
+				<ul class="tsd-hierarchy">
+					<li>
+						<span class="target">FormattedOrderTransaction</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>Properties</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#address" class="tsd-kind-icon">address</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#id" class="tsd-kind-icon">id</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.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 name="address" class="tsd-anchor"></a>
+					<h3>address</h3>
+					<div class="tsd-signature tsd-kind-icon">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/0c571f2e/src/transaction/types.ts#L128">src/transaction/types.ts:128</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="id" class="tsd-anchor"></a>
+					<h3>id</h3>
+					<div class="tsd-signature tsd-kind-icon">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/0c571f2e/src/transaction/types.ts#L127">src/transaction/types.ts:127</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="outcome" class="tsd-anchor"></a>
+					<h3>outcome</h3>
+					<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L126">src/transaction/types.ts:126</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="sequence" class="tsd-anchor"></a>
+					<h3>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">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L129">src/transaction/types.ts:129</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="specification" class="tsd-anchor"></a>
+					<h3>specification</h3>
+					<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FormattedOrderSpecification</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L125">src/transaction/types.ts:125</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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">string</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L124">src/transaction/types.ts:124</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface">
+						<a href="FormattedOrderTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Transaction</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderTransaction.html#address" class="tsd-kind-icon">address</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderTransaction.html#id" class="tsd-kind-icon">id</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderTransaction.html#specification" class="tsd-kind-icon">specification</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedOrderTransaction.html#type" class="tsd-kind-icon">type</a>
+							</li>
+						</ul>
+					</li>
+				</ul>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>

docs/interfaces/FormattedPayment.html

@@ -0,0 +1,261 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>FormattedPayment | ripple-lib</title>
+	<meta name="description" content="Documentation for ripple-lib">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</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">ripple-lib</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">ripple-lib</a>
+				</li>
+				<li>
+					<a href="FormattedPayment.html">FormattedPayment</a>
+				</li>
+			</ul>
+			<h1>Interface FormattedPayment</h1>
+		</div>
+	</div>
+</header>
+<div class="container container-main">
+	<div class="row">
+		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-hierarchy">
+				<h3>Hierarchy</h3>
+				<ul class="tsd-hierarchy">
+					<li>
+						<span class="target">FormattedPayment</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>Properties</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#allowPartialPayment" class="tsd-kind-icon">allow<wbr>Partial<wbr>Payment</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#destination" class="tsd-kind-icon">destination</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#invoiceID" class="tsd-kind-icon">invoiceID</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#limitQuality" class="tsd-kind-icon">limit<wbr>Quality</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#memos" class="tsd-kind-icon">memos</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#noDirectRipple" class="tsd-kind-icon">no<wbr>Direct<wbr>Ripple</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#paths" class="tsd-kind-icon">paths</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#source" class="tsd-kind-icon">source</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 name="allowPartialPayment" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Partial<wbr>Payment</h3>
+					<div class="tsd-signature tsd-kind-icon">allow<wbr>Partial<wbr>Payment<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/0c571f2e/src/transaction/types.ts#L109">src/transaction/types.ts:109</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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">Adjustment</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L105">src/transaction/types.ts:105</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="invoiceID" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> invoiceID</h3>
+					<div class="tsd-signature tsd-kind-icon">invoiceID<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/0c571f2e/src/transaction/types.ts#L108">src/transaction/types.ts:108</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="limitQuality" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit<wbr>Quality</h3>
+					<div class="tsd-signature tsd-kind-icon">limit<wbr>Quality<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/0c571f2e/src/transaction/types.ts#L111">src/transaction/types.ts:111</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="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">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L107">src/transaction/types.ts:107</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="noDirectRipple" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> no<wbr>Direct<wbr>Ripple</h3>
+					<div class="tsd-signature tsd-kind-icon">no<wbr>Direct<wbr>Ripple<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/0c571f2e/src/transaction/types.ts#L110">src/transaction/types.ts:110</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="paths" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
+					<div class="tsd-signature tsd-kind-icon">paths<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/0c571f2e/src/transaction/types.ts#L106">src/transaction/types.ts:106</a></li>
+						</ul>
+					</aside>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="source" class="tsd-anchor"></a>
+					<h3>source</h3>
+					<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Adjustment</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L104">src/transaction/types.ts:104</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>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface">
+						<a href="FormattedPayment.html" class="tsd-kind-icon">Formatted<wbr>Payment</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#allowPartialPayment" class="tsd-kind-icon">allow<wbr>Partial<wbr>Payment</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#destination" class="tsd-kind-icon">destination</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#invoiceID" class="tsd-kind-icon">invoiceID</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#limitQuality" class="tsd-kind-icon">limit<wbr>Quality</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#memos" class="tsd-kind-icon">memos</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#noDirectRipple" class="tsd-kind-icon">no<wbr>Direct<wbr>Ripple</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#paths" class="tsd-kind-icon">paths</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="FormattedPayment.html#source" class="tsd-kind-icon">source</a>
+							</li>
+						</ul>
+					</li>
+				</ul>
+				<ul class="after-current">
+				</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-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>
+	</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/js/main.js"></script>
+</body>
+</html>