Compare commits

..

4 Commits

Author SHA1 Message Date
Mayukha Vadari
9fa3f73d5a import from lodash/ 2021-10-18 18:30:25 -04:00
Mayukha Vadari
9bf7df868e remove omitBy 2021-10-18 18:30:25 -04:00
Mayukha Vadari
3134dc112f remove flatmap 2021-10-18 18:30:25 -04:00
Mayukha Vadari
915118265f remove flatten 2021-10-18 18:30:25 -04:00
763 changed files with 57739 additions and 48840 deletions

View File

@@ -50,6 +50,8 @@ module.exports = {
'multiline-comment-style': ['error', 'starred-block'],
'jsdoc/check-examples': 'off',
// Allows the usage of @category -- TODO: try to add this in base config
'jsdoc/check-tag-names': 'off',
'tsdoc/syntax': 'off',
'jsdoc/require-description-complete-sentence': 'off',
},
@@ -62,24 +64,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 +90,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',
},
},
{

View File

@@ -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

3
.gitignore vendored
View File

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

9
.travis.yml Normal file
View File

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

View File

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

View File

@@ -1,149 +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](js.xrpl.org). You can also generate them locally using `typedoc`:
```bash
npm run docgen
```
## 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 `develop` 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 `develop`.
2. Open a PR to update the docs if docs were modified.
3. Create a branch off `develop` that ensures that `HISTORY.md` is updated appropriately for each package.
* Use `shasum -a 256 build/*` to get the SHA-256 checksums. Add these to `HISTORY.md` as well.
4. Merge this branch into `develop`.
5. If this is not a beta release: Merge `develop` into `master` (`--ff-only`) and push to github. This is important because we have docs telling developers to use master to get the latest release.
6. Create a new Github release/tag off of this branch.
7. Run `npm publish --dry-run` and make sure everything looks good.
8. Publish the release to `npm`.
* If this is a beta release, run `npm publish --tag beta`. This allows someone else to install this version of the package with `npm install xrpl@beta`.
* If this is a stable release, run `npm publish`.
* This will require entering `npm` login info.
9. 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)

1613
HISTORY.md

File diff suppressed because it is too large Load Diff

View File

@@ -7,71 +7,43 @@ A JavaScript/TypeScript library for interacting with the XRP Ledger
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)
See the full reference documentation for all classes, methods, and utilities.
## [➡️ Applications and Projects](https://github.com/XRPLF/xrpl.js/blob/master/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!
### 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
```shell
npm install xrpl@beta
```
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
npm install xrpl
npm install xrpl@beta
# install peer deps
npm install react-native-randombytes
# install latest rn-nodeify
@@ -125,9 +97,9 @@ 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/develop/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
@@ -139,8 +111,37 @@ If you're using the XRP Ledger in production, you should run a [rippled server](
+ [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)
## Development
To build the library for Node.js and the browser:
```shell
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)
+ [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal
+ [XRP Ledger Dev Portal](https://xrpl.org/)

1
docs/CNAME Normal file
View File

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

2660
docs/assets/css/main.css Normal file

File diff suppressed because it is too large Load Diff

View File

Before

Width:  |  Height:  |  Size: 9.4 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

Before

Width:  |  Height:  |  Size: 480 B

After

Width:  |  Height:  |  Size: 480 B

View File

Before

Width:  |  Height:  |  Size: 855 B

After

Width:  |  Height:  |  Size: 855 B

248
docs/assets/js/main.js Normal file

File diff suppressed because one or more lines are too long

1
docs/assets/js/search.js Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

3397
docs/classes/Client.html Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,450 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ConnectionError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="ConnectionError.html">ConnectionError</a>
</li>
</ul>
<h1>Class ConnectionError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js has an error with connection to rippled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">ConnectionError</span>
<ul class="tsd-hierarchy">
<li>
<a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a>
</li>
<li>
<a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a>
</li>
<li>
<a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a>
</li>
<li>
<a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a>
</li>
<li>
<a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ConnectionError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ConnectionError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ConnectionError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Connection<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="ConnectionError.html" class="tsd-kind-icon">Connection<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="ConnectionError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ConnectionError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ConnectionError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ConnectionError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="ConnectionError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ConnectionError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ConnectionError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ConnectionError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ConnectionError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ConnectionError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DisconnectedError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="DisconnectedError.html">DisconnectedError</a>
</li>
</ul>
<h1>Class DisconnectedError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js has disconnected from rippled server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DisconnectedError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="DisconnectedError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="DisconnectedError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="DisconnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Disconnected<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="DisconnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">DisconnectedError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="DisconnectedError.html" class="tsd-kind-icon">Disconnected<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="DisconnectedError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="DisconnectedError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="DisconnectedError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="DisconnectedError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="DisconnectedError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="DisconnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="DisconnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="DisconnectedError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="DisconnectedError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="DisconnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NotConnectedError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="NotConnectedError.html">NotConnectedError</a>
</li>
</ul>
<h1>Class NotConnectedError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js is not connected to rippled server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">NotConnectedError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotConnectedError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotConnectedError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotConnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Not<wbr>Connected<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="NotConnectedError.html" class="tsd-signature-type" data-tsd-kind="Class">NotConnectedError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="NotConnectedError.html" class="tsd-kind-icon">Not<wbr>Connected<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="NotConnectedError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="NotConnectedError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="NotConnectedError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="NotConnectedError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="NotConnectedError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="NotConnectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="NotConnectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="NotConnectedError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="NotConnectedError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="NotConnectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,430 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NotFoundError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="NotFoundError.html">NotFoundError</a>
</li>
</ul>
<h1>Class NotFoundError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js cannot retrieve a transaction, ledger, account, etc.
From rippled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">NotFoundError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="NotFoundError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="NotFoundError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="NotFoundError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="NotFoundError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Not<wbr>Found<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L145">src/errors.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;Not found&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The error message. Defaults to &quot;Not found&quot;.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="NotFoundError.html" class="tsd-kind-icon">Not<wbr>Found<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="NotFoundError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="NotFoundError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="NotFoundError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="NotFoundError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="NotFoundError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="NotFoundError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="NotFoundError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="NotFoundError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="NotFoundError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="NotFoundError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ResponseFormatError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="ResponseFormatError.html">ResponseFormatError</a>
</li>
</ul>
<h1>Class ResponseFormatError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js sees a response in the wrong format.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">ResponseFormatError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ResponseFormatError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ResponseFormatError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ResponseFormatError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Response<wbr>Format<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ResponseFormatError.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseFormatError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="ResponseFormatError.html" class="tsd-kind-icon">Response<wbr>Format<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="ResponseFormatError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ResponseFormatError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ResponseFormatError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ResponseFormatError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="ResponseFormatError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ResponseFormatError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ResponseFormatError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ResponseFormatError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ResponseFormatError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ResponseFormatError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RippledError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="RippledError.html">RippledError</a>
</li>
</ul>
<h1>Class RippledError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when rippled responds with an error.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">RippledError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Rippled<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="RippledError.html" class="tsd-kind-icon">Rippled<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="RippledError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="RippledError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="RippledError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="RippledError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="RippledError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="RippledError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="RippledError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="RippledError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="RippledError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="RippledError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RippledNotInitializedError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="RippledNotInitializedError.html">RippledNotInitializedError</a>
</li>
</ul>
<h1>Class RippledNotInitializedError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when rippled is not initialized.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">RippledNotInitializedError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="RippledNotInitializedError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="RippledNotInitializedError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="RippledNotInitializedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Rippled<wbr>Not<wbr>Initialized<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="RippledNotInitializedError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledNotInitializedError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="RippledNotInitializedError.html" class="tsd-kind-icon">Rippled<wbr>Not<wbr>Initialized<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="RippledNotInitializedError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="RippledNotInitializedError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="RippledNotInitializedError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="RippledNotInitializedError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="RippledNotInitializedError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="RippledNotInitializedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="RippledNotInitializedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="RippledNotInitializedError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="RippledNotInitializedError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="RippledNotInitializedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TimeoutError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="TimeoutError.html">TimeoutError</a>
</li>
</ul>
<h1>Class TimeoutError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js times out.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">TimeoutError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TimeoutError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="TimeoutError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TimeoutError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Timeout<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="TimeoutError.html" class="tsd-signature-type" data-tsd-kind="Class">TimeoutError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ConnectionError.html">ConnectionError</a>.<a href="ConnectionError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="TimeoutError.html" class="tsd-kind-icon">Timeout<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="TimeoutError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="TimeoutError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="TimeoutError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="TimeoutError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="TimeoutError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="TimeoutError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="TimeoutError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="TimeoutError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="TimeoutError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="TimeoutError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UnexpectedError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="UnexpectedError.html">UnexpectedError</a>
</li>
</ul>
<h1>Class UnexpectedError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js cannot specify error type.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">UnexpectedError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="UnexpectedError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="UnexpectedError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="UnexpectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Unexpected<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="UnexpectedError.html" class="tsd-kind-icon">Unexpected<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="UnexpectedError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="UnexpectedError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="UnexpectedError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="UnexpectedError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="UnexpectedError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="UnexpectedError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="UnexpectedError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="UnexpectedError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="UnexpectedError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="UnexpectedError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,433 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ValidationError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="ValidationError.html">ValidationError</a>
</li>
</ul>
<h1>Class ValidationError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when xrpl.js sees a malformed transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">ValidationError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="ValidationError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ValidationError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="ValidationError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Validation<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="ValidationError.html" class="tsd-kind-icon">Validation<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="ValidationError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ValidationError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ValidationError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ValidationError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="ValidationError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ValidationError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ValidationError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ValidationError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ValidationError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="ValidationError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

840
docs/classes/Wallet.html Normal file
View File

@@ -0,0 +1,840 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Wallet | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="Wallet.html">Wallet</a>
</li>
</ul>
<h1>Class Wallet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A utility for deriving a wallet composed of a keypair (publicKey/privateKey).
A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers).
It provides functionality to sign/verify transactions offline.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-typescript"><span style="color: #008000">// Derive a wallet from a bip38 Mnemonic</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">wallet</span><span style="color: #000000"> = </span><span style="color: #001080">Wallet</span><span style="color: #000000">.</span><span style="color: #795E26">fromMnemonic</span><span style="color: #000000">(</span>
<span style="color: #000000"> </span><span style="color: #A31515">&#039;jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry&#039;</span>
<span style="color: #000000">)</span>
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">wallet</span><span style="color: #000000">)</span>
<span style="color: #008000">// Wallet {</span>
<span style="color: #008000">// publicKey: &#039;02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2&#039;,</span>
<span style="color: #008000">// privateKey: &#039;00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2&#039;,</span>
<span style="color: #008000">// classicAddress: &#039;rwZiksrExmVkR64pf87Jor4cYbmff47SUm&#039;,</span>
<span style="color: #008000">// seed: undefined</span>
<span style="color: #008000">// }.</span>
<span style="color: #008000">// Derive a wallet from a base58 encoded seed.</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">seedWallet</span><span style="color: #000000"> = </span><span style="color: #001080">Wallet</span><span style="color: #000000">.</span><span style="color: #795E26">fromSeed</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;ssZkdwURFMBXenJPbrpE14b6noJSu&#039;</span><span style="color: #000000">)</span>
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">seedWallet</span><span style="color: #000000">)</span>
<span style="color: #008000">// Wallet {</span>
<span style="color: #008000">// publicKey: &#039;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#039;,</span>
<span style="color: #008000">// privateKey: &#039;00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7&#039;,</span>
<span style="color: #008000">// classicAddress: &#039;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#039;,</span>
<span style="color: #008000">// seed: &#039;ssZkdwURFMBXenJPbrpE14b6noJSu&#039;</span>
<span style="color: #008000">// }.</span>
<span style="color: #008000">// Sign a JSON Transaction</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">signed</span><span style="color: #000000"> = </span><span style="color: #001080">seedWallet</span><span style="color: #000000">.</span><span style="color: #795E26">signTransaction</span><span style="color: #000000">({</span>
<span style="color: #000000"> </span><span style="color: #001080">TransactionType:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;Payment&#039;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #001080">Account:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#039;</span>
<span style="color: #000000"> ...........</span>
<span style="color: #000000">}).</span>
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">signed</span><span style="color: #000000">)</span>
<span style="color: #008000">// &#039;1200007321......B01BE1DFF3&#039;.</span>
<span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #795E26">decode</span><span style="color: #000000">(</span><span style="color: #001080">signed</span><span style="color: #000000">))</span>
<span style="color: #008000">// {</span>
<span style="color: #008000">// TransactionType: &#039;Payment&#039;,</span>
<span style="color: #008000">// SigningPubKey: &#039;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#039;,</span>
<span style="color: #008000">// TxnSignature: &#039;3045022100AAD......5B631ABD21171B61B07D304&#039;,</span>
<span style="color: #008000">// Account: &#039;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#039;</span>
<span style="color: #008000">// ...........</span>
<span style="color: #008000">// }</span>
</code></pre>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Wallet</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Wallet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#classicAddress" class="tsd-kind-icon">classic<wbr>Address</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#privateKey" class="tsd-kind-icon">private<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Wallet.html#seed" class="tsd-kind-icon">seed</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromSecret" class="tsd-kind-icon">from<wbr>Secret</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Wallet.html#address" class="tsd-kind-icon">address</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="Wallet.html#checkTxSerialization" class="tsd-kind-icon">check<wbr>TxSerialization</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#getClassicAddress" class="tsd-kind-icon">get<wbr>Classic<wbr>Address</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#getXAddress" class="tsd-kind-icon">getXAddress</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#sign" class="tsd-kind-icon">sign</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#verifyTransaction" class="tsd-kind-icon">verify<wbr>Transaction</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="Wallet.html#deriveWallet" class="tsd-kind-icon">derive<wbr>Wallet</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromEntropy" class="tsd-kind-icon">from<wbr>Entropy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromMnemonic" class="tsd-kind-icon">from<wbr>Mnemonic</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#fromSeed" class="tsd-kind-icon">from<wbr>Seed</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Wallet.html#generate" class="tsd-kind-icon">generate</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Wallet<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, seed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L117">src/wallet/index.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new Wallet.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>publicKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The public key for the account.</p>
</div>
</div>
</li>
<li>
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The private key used for signing transactions for the account.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> seed: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>(Optional) The seed used to derive the account keys.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="classicAddress" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> classic<wbr>Address</h3>
<div class="tsd-signature tsd-kind-icon">classic<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L98">src/wallet/index.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This only is correct if this wallet corresponds to your
<a href="https://xrpl.org/cryptographic-keys.html#master-key-pair">master keypair</a>. If this wallet represents a
<a href="https://xrpl.org/cryptographic-keys.html#regular-key-pair">regular keypair</a> this will provide an incorrect address.
TODO: Add support for Regular Keys to Wallet (And their corresponding impact on figuring out classicAddress).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="privateKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> private<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L91">src/wallet/index.ts:91</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="publicKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> public<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L90">src/wallet/index.ts:90</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="seed" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> seed</h3>
<div class="tsd-signature tsd-kind-icon">seed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L99">src/wallet/index.ts:99</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="fromSecret" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Secret</h3>
<div class="tsd-signature tsd-kind-icon">from<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L157">src/wallet/index.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derives a wallet from a secret (AKA a seed).</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derives a wallet from a seed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>seed: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string used to generate a keypair (publicKey/privateKey) to derive a wallet.</p>
</div>
</li>
<li>
<h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The digital signature algorithm to generate an address fro.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
<p>A Wallet derived from a seed.</p>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L106">src/wallet/index.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias for wallet.classicAddress.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The wallet&#39;s classic address.</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="checkTxSerialization" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>TxSerialization</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">check<wbr>TxSerialization<span class="tsd-signature-symbol">(</span>serialized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tx<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L322">src/wallet/index.ts:322</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p> Decode a serialized transaction, remove the fields that are added during the signing process,
and verify that it matches the transaction prior to signing. This gives the user a sanity check
to ensure that what they try to encode matches the message that will be recieved by rippled.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>A ValidationError if the transaction does not have a TxnSignature/Signers property, or if
the serialized Transaction desn&#39;t match the original transaction.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>serialized: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A signed and serialized transaction.</p>
</div>
</li>
<li>
<h5>tx: <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<p>The transaction prior to signing.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getClassicAddress" class="tsd-anchor"></a>
<h3>get<wbr>Classic<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Classic<wbr>Address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L307">src/wallet/index.ts:307</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets the classic address of the account this wallet represents. This only is correct if this wallet corresponds
to your <a href="https://xrpl.org/cryptographic-keys.html#master-key-pair">master keypair</a>. If this wallet represents a
<a href="https://xrpl.org/cryptographic-keys.html#regular-key-pair">regular keypair</a> this will provide an incorrect address.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>A classic address.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getXAddress" class="tsd-anchor"></a>
<h3>getXAddress</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">getXAddress<span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span>, isTestnet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L296">src/wallet/index.ts:296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets an X-address in Testnet/Mainnet format.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tag: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>A tag to be included within the X-address.</p>
</div>
</li>
<li>
<h5>isTestnet: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>A boolean to indicate if X-address should be in Testnet (true) or Mainnet (false) format.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>An X-address.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sign" class="tsd-anchor"></a>
<h3>sign</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a>, multisign<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SignedTxBlobHash</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L229">src/wallet/index.ts:229</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signs a transaction offline.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>ValidationError if the transaction is already signed or does not encode/decode to same result.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transaction: <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<p>A transaction to be signed offline.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> multisign: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SignedTxBlobHash</span></h4>
<p>A signed transaction.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="verifyTransaction" class="tsd-anchor"></a>
<h3>verify<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">verify<wbr>Transaction<span class="tsd-signature-symbol">(</span>signedTransaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L282">src/wallet/index.ts:282</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Verifies a signed transaction offline.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>signedTransaction: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A signed transaction (hex string of signTransaction result) to be verified offline.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Returns true if a signedTransaction is valid.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="deriveWallet" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> derive<wbr>Wallet</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<li class="tsd-signature tsd-kind-icon">derive<wbr>Wallet<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L211">src/wallet/index.ts:211</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derive a Wallet from a seed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>seed: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The seed used to derive the wallet.</p>
</div>
</li>
<li>
<h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The algorithm used to do the derivation.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
<p>A Wallet derived from the seed.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="fromEntropy" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Entropy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<wbr>Entropy<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L192">src/wallet/index.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derives a wallet from an entropy (array of random numbers).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>entropy: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>An array of random numbers to generate a seed used to derive a wallet.</p>
</div>
</li>
<li>
<h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The digital signature algorithm to generate an address for.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
<p>A Wallet derived from an entropy.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="fromMnemonic" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Mnemonic</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, derivationPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L167">src/wallet/index.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derives a wallet from a mnemonic.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>ValidationError if unable to derive private key from mnemonic input.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string consisting of words (whitespace delimited) used to derive a wallet.</p>
</div>
</li>
<li>
<h5>derivationPath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The path to derive a keypair (publicKey/privateKey) from a seed (that was converted from a mnemonic).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
<p>A Wallet derived from a mnemonic.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="fromSeed" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Seed</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">from<wbr>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L142">src/wallet/index.ts:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derives a wallet from a seed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>seed: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string used to generate a keypair (publicKey/privateKey) to derive a wallet.</p>
</div>
</li>
<li>
<h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The digital signature algorithm to generate an address for.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
<p>A Wallet derived from a seed.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="generate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> generate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/index.ts#L130">src/wallet/index.ts:130</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a new Wallet using a generated seed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>The digital signature algorithm to generate an address for.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4>
<p>A new Wallet derived from a generated seed.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="Wallet.html" class="tsd-kind-icon">Wallet</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="Wallet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="Wallet.html#classicAddress" class="tsd-kind-icon">classic<wbr>Address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="Wallet.html#privateKey" class="tsd-kind-icon">private<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="Wallet.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="Wallet.html#seed" class="tsd-kind-icon">seed</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a href="Wallet.html#fromSecret" class="tsd-kind-icon">from<wbr>Secret</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="Wallet.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="Wallet.html#checkTxSerialization" class="tsd-kind-icon">check<wbr>TxSerialization</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="Wallet.html#getClassicAddress" class="tsd-kind-icon">get<wbr>Classic<wbr>Address</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="Wallet.html#getXAddress" class="tsd-kind-icon">getXAddress</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="Wallet.html#sign" class="tsd-kind-icon">sign</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="Wallet.html#verifyTransaction" class="tsd-kind-icon">verify<wbr>Transaction</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="Wallet.html#deriveWallet" class="tsd-kind-icon">derive<wbr>Wallet</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="Wallet.html#fromEntropy" class="tsd-kind-icon">from<wbr>Entropy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="Wallet.html#fromMnemonic" class="tsd-kind-icon">from<wbr>Mnemonic</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="Wallet.html#fromSeed" class="tsd-kind-icon">from<wbr>Seed</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="Wallet.html#generate" class="tsd-kind-icon">generate</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,435 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>XRPLFaucetError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="XRPLFaucetError.html">XRPLFaucetError</a>
</li>
</ul>
<h1>Class XRPLFaucetError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Error thrown when a client cannot generate a wallet from the testnet/devnet
faucets, or when the client cannot infer the faucet URL (i.e. when the Client
is connected to mainnet).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">XRPLFaucetError</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XRPLFaucetError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="XRPLFaucetError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XRPLFaucetError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new XRPLFaucet<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The error message.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data that caused the error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stack">stack</a></p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#prepareStackTrace">prepareStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#stackTraceLimit">stackTraceLimit</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#captureStackTrace">captureStackTrace</a></p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="XRPLFaucetError.html" class="tsd-kind-icon">XRPLFaucet<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="XRPLFaucetError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="XRPLFaucetError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="XRPLFaucetError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="XRPLFaucetError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="XRPLFaucetError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="XRPLFaucetError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="XRPLFaucetError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="XRPLFaucetError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="XRPLFaucetError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="XRPLFaucetError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

455
docs/classes/XrplError.html Normal file
View File

@@ -0,0 +1,455 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>XrplError | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="XrplError.html">XrplError</a>
</li>
</ul>
<h1>Class XrplError</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Base Error class for xrpl.js. All Errors thrown by xrpl.js should throw
XrplErrors.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Error</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">XrplError</span>
<ul class="tsd-hierarchy">
<li>
<a href="UnexpectedError.html" class="tsd-signature-type" data-tsd-kind="Class">UnexpectedError</a>
</li>
<li>
<a href="ConnectionError.html" class="tsd-signature-type" data-tsd-kind="Class">ConnectionError</a>
</li>
<li>
<a href="RippledError.html" class="tsd-signature-type" data-tsd-kind="Class">RippledError</a>
</li>
<li>
<a href="ValidationError.html" class="tsd-signature-type" data-tsd-kind="Class">ValidationError</a>
</li>
<li>
<a href="NotFoundError.html" class="tsd-signature-type" data-tsd-kind="Class">NotFoundError</a>
</li>
<li>
<a href="XRPLFaucetError.html" class="tsd-signature-type" data-tsd-kind="Class">XRPLFaucetError</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="XrplError.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XrplError.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="XrplError.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#inspect" class="tsd-kind-icon">inspect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="XrplError.html#toString" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="XrplError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Xrpl<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L23">src/errors.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an XrplError.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The error message.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The data that caused the error.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="XrplError.html" class="tsd-signature-type" data-tsd-kind="Class">XrplError</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a name="message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Error.message</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L14">src/errors.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides Error.name</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L13">src/errors.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Error.stack</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="prepareStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOptional">Optional</span> prepare<wbr>Stack<wbr>Trace</h3>
<div class="tsd-signature tsd-kind-icon">prepare<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from Error.prepareStackTrace</p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:11</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional override for formatting stack traces</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>err: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>stackTraces: <span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="stackTraceLimit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> stack<wbr>Trace<wbr>Limit</h3>
<div class="tsd-signature tsd-kind-icon">stack<wbr>Trace<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from Error.stackTraceLimit</p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:13</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="inspect" class="tsd-anchor"></a>
<h3>inspect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L56">src/errors.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Console.log in node uses util.inspect on object, and util.inspect allows
us to customize its output:
<a href="https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects">https://nodejs.org/api/util.html#util_custom_inspect_function_on_objects</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="toString" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/errors.ts#L40">src/errors.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts the Error to a human-readable String form.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The String output of the Error.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="captureStackTrace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr>Stack<wbr>Trace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Stack<wbr>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Error.captureStackTrace</p>
<ul>
<li>Defined in node_modules/@types/node/globals.d.ts:4</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create .stack property on a target object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>targetObject: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> constructorOpt: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="XrplError.html" class="tsd-kind-icon">Xrpl<wbr>Error</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="XrplError.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="XrplError.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a href="XrplError.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a href="XrplError.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a href="XrplError.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="XrplError.html#prepareStackTrace" class="tsd-kind-icon">prepare<wbr>Stack<wbr>Trace</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="XrplError.html#stackTraceLimit" class="tsd-kind-icon">stack<wbr>Trace<wbr>Limit</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="XrplError.html#inspect" class="tsd-kind-icon">inspect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="XrplError.html#toString" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a href="XrplError.html#captureStackTrace" class="tsd-kind-icon">capture<wbr>Stack<wbr>Trace</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,325 @@
<!doctype html>
<html class="default no-js">
<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/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="AccountSetAsfFlags.html">AccountSetAsfFlags</a>
</li>
</ul>
<h1>Enumeration AccountSetAsfFlags</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enum for AccountSet Flags.</p>
</div>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr>Account<wbr>TxnID</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr>Default<wbr>Ripple</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr>Deposit<wbr>Auth</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr>Disable<wbr>Master</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr>DisallowXRP</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr>Global<wbr>Freeze</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr>NoFreeze</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 name="asfAccountTxnID" class="tsd-anchor"></a>
<h3>asf<wbr>Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L31">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 name="asfDefaultRipple" class="tsd-anchor"></a>
<h3>asf<wbr>Default<wbr>Ripple</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Default<wbr>Ripple<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L40">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 name="asfDepositAuth" class="tsd-anchor"></a>
<h3>asf<wbr>Deposit<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Deposit<wbr>Auth<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L42">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 name="asfDisableMaster" class="tsd-anchor"></a>
<h3>asf<wbr>Disable<wbr>Master</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Disable<wbr>Master<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L26">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 name="asfDisallowXRP" class="tsd-anchor"></a>
<h3>asf<wbr>DisallowXRP</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>DisallowXRP<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L20">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 name="asfGlobalFreeze" class="tsd-anchor"></a>
<h3>asf<wbr>Global<wbr>Freeze</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Global<wbr>Freeze<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L38">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 name="asfNoFreeze" class="tsd-anchor"></a>
<h3>asf<wbr>NoFreeze</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>NoFreeze<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L36">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 name="asfRequireAuth" class="tsd-anchor"></a>
<h3>asf<wbr>Require<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Require<wbr>Auth<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L18">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 name="asfRequireDest" class="tsd-anchor"></a>
<h3>asf<wbr>Require<wbr>Dest</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Require<wbr>Dest<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L13">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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Asf<wbr>Flags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr>Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr>Default<wbr>Ripple</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr>Deposit<wbr>Auth</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr>Disable<wbr>Master</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr>DisallowXRP</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr>Global<wbr>Freeze</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr>NoFreeze</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>
<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-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>
</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>

View File

@@ -0,0 +1,263 @@
<!doctype html>
<html class="default no-js">
<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/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">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 name="tfAllowXRP" class="tsd-anchor"></a>
<h3>tf<wbr>AllowXRP</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>AllowXRP<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L62">src/models/transactions/accountSet.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as ClearFlag: asfDisallowXRP.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfDisallowXRP" class="tsd-anchor"></a>
<h3>tf<wbr>DisallowXRP</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>DisallowXRP<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L60">src/models/transactions/accountSet.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as SetFlag: asfDisallowXRP.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfOptionalAuth" class="tsd-anchor"></a>
<h3>tf<wbr>Optional<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Optional<wbr>Auth<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L58">src/models/transactions/accountSet.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as ClearFlag: asfRequireAuth.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfOptionalDestTag" class="tsd-anchor"></a>
<h3>tf<wbr>Optional<wbr>Dest<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L54">src/models/transactions/accountSet.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as ClearFlag: asfRequireDest.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfRequireAuth" class="tsd-anchor"></a>
<h3>tf<wbr>Require<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Require<wbr>Auth<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L56">src/models/transactions/accountSet.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as SetFlag: asfRequireAuth.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfRequireDestTag" class="tsd-anchor"></a>
<h3>tf<wbr>Require<wbr>Dest<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Require<wbr>Dest<wbr>Tag<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/accountSet.ts#L52">src/models/transactions/accountSet.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as SetFlag: asfRequireDest.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>TfFlags</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>
<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-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>
</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>

View File

@@ -0,0 +1,237 @@
<!doctype html>
<html class="default no-js">
<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/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">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>OrKill</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>OrCancel</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 name="tfFillOrKill" class="tsd-anchor"></a>
<h3>tf<wbr>Fill<wbr>OrKill</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Fill<wbr>OrKill<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/offerCreate.ts#L40">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 name="tfImmediateOrCancel" class="tsd-anchor"></a>
<h3>tf<wbr>Immediate<wbr>OrCancel</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/offerCreate.ts#L31">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 name="tfPassive" class="tsd-anchor"></a>
<h3>tf<wbr>Passive</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Passive<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/offerCreate.ts#L23">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 name="tfSell" class="tsd-anchor"></a>
<h3>tf<wbr>Sell</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Sell<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/offerCreate.ts#L45">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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<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>OrKill</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>OrCancel</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>
<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-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>
</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>

View File

@@ -0,0 +1,199 @@
<!doctype html>
<html class="default no-js">
<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/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">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 name="tfClose" class="tsd-anchor"></a>
<h3>tf<wbr>Close</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Close<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/paymentChannelClaim.ts#L31">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 name="tfRenew" class="tsd-anchor"></a>
<h3>tf<wbr>Renew</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Renew<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/paymentChannelClaim.ts#L17">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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<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>
<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-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>
</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>

View File

@@ -0,0 +1,212 @@
<!doctype html>
<html class="default no-js">
<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/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">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>NoDirect<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 name="tfLimitQuality" class="tsd-anchor"></a>
<h3>tf<wbr>Limit<wbr>Quality</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Limit<wbr>Quality<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/payment.ts#L36">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 name="tfNoDirectRipple" class="tsd-anchor"></a>
<h3>tf<wbr>NoDirect<wbr>Ripple</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>NoDirect<wbr>Ripple<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/payment.ts#L24">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 name="tfPartialPayment" class="tsd-anchor"></a>
<h3>tf<wbr>Partial<wbr>Payment</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Partial<wbr>Payment<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/payment.ts#L30">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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<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>NoDirect<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>
<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-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>
</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>

View File

@@ -0,0 +1,246 @@
<!doctype html>
<html class="default no-js">
<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/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">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>NoRipple</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>NoRipple</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 name="tfClearFreeze" class="tsd-anchor"></a>
<h3>tf<wbr>Clear<wbr>Freeze</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Clear<wbr>Freeze<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/trustSet.ts#L32">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 name="tfClearNoRipple" class="tsd-anchor"></a>
<h3>tf<wbr>Clear<wbr>NoRipple</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Clear<wbr>NoRipple<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/trustSet.ts#L28">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 name="tfSetFreeze" class="tsd-anchor"></a>
<h3>tf<wbr>Set<wbr>Freeze</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Set<wbr>Freeze<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/trustSet.ts#L30">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 name="tfSetNoRipple" class="tsd-anchor"></a>
<h3>tf<wbr>Set<wbr>NoRipple</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Set<wbr>NoRipple<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/trustSet.ts#L26">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 name="tfSetfAuth" class="tsd-anchor"></a>
<h3>tf<wbr>Setf<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Setf<wbr>Auth<span class="tsd-signature-symbol">:</span> <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/615504db/src/models/transactions/trustSet.ts#L21">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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<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>NoRipple</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>NoRipple</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>
<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-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>
</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>

718
docs/index.html Normal file
View File

@@ -0,0 +1,718 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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">
<h1>xrpl</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#xrpljs" id="xrpljs" style="color: inherit; text-decoration: none;">
<h1>xrpl.js</h1>
</a>
<p>A JavaScript/TypeScript library for interacting with the XRP Ledger</p>
<p><a href="https://www.npmjs.org/package/xrpl"><img src="https://nodei.co/npm/xrpl.png" alt="NPM"></a></p>
<p>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.</p>
<a href="#➡️-applications-and-projects" id="➡️-applications-and-projects" style="color: inherit; text-decoration: none;">
<h2><a href="APPLICATIONS.md">➡️ Applications and Projects</a></h2>
</a>
<p>What is <code>xrpl.js</code> used for? The applications on the list linked above use <code>xrpl.js</code>. Open a PR to add your app or project to the list!</p>
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h3>Features</h3>
</a>
<ul>
<li>Connect to a <code>rippled</code> server from Node.js or a web browser</li>
<li>Helpers for creating requests and parsing responses for the <a href="https://developers.ripple.com/rippled-api.html">rippled API</a></li>
<li>Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)</li>
<li>Sign and submit transactions to the XRP Ledger</li>
<li>Type definitions for TypeScript</li>
</ul>
<a href="#requirements" id="requirements" style="color: inherit; text-decoration: none;">
<h3>Requirements</h3>
</a>
<ul>
<li><strong><a href="https://nodejs.org/">Node.js v14</a></strong> is recommended. Other versions may work but are not frequently tested.</li>
<li><strong><a href="https://www.npmjs.com/">npm</a></strong> is recommended. <code>yarn</code> may work but we use <code>package-lock.json</code>.</li>
</ul>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting Started</h2>
</a>
<p>See also: <a href="https://xrpl.org/get-started-with-rippleapi-for-javascript.html">RippleAPI Beginners Guide</a></p>
<p>In an existing project (with <code>package.json</code>), install <code>xrpl.js</code>:</p>
<pre><code class="language-shell"><span style="color: #000000">npm install xrpl@beta</span>
</code></pre>
<p>Then see the <a href="#documentation">documentation</a>.</p>
<a href="#using-xrpljs-with-react-native" id="using-xrpljs-with-react-native" style="color: inherit; text-decoration: none;">
<h3>Using xrpl.js with React Native</h3>
</a>
<p>If you want to use <code>xrpl.js</code> with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like <a href="https://github.com/tradle/rn-nodeify">rn-nodeify</a>.</p>
<ol>
<li><p>Install dependencies (you can use <code>npm</code> as well):</p>
<pre><code class="language-shell"><span style="color: #000000">npm install react-native-crypto</span>
<span style="color: #000000">npm install xrpl@beta</span>
<span style="color: #008000"># install peer deps</span>
<span style="color: #000000">npm install react-native-randombytes</span>
<span style="color: #008000"># install latest rn-nodeify</span>
<span style="color: #000000">npm install rn-nodeify@latest --dev</span>
</code></pre>
</li>
<li><p>After that, run the following command:</p>
<pre><code class="language-shell"><span style="color: #008000"># install node core shims and recursively hack package.json files</span>
<span style="color: #008000"># in ./node_modules to add/update the &quot;browser&quot;/&quot;react-native&quot; field with relevant mappings</span>
<span style="color: #000000">./node_modules/.bin/rn-nodeify --hack --install</span>
</code></pre>
</li>
<li><p>Enable <code>crypto</code>:</p>
<p> <code>rn-nodeify</code> will create a <code>shim.js</code> file in the project root directory.
Open it and uncomment the line that requires the crypto module:</p>
<pre><code class="language-javascript"><span style="color: #008000">// If using the crypto shim, uncomment the following line to ensure</span>
<span style="color: #008000">// crypto is loaded first, so it can populate global.crypto</span>
<span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;crypto&#039;</span><span style="color: #000000">)</span>
</code></pre>
</li>
<li><p>Import <code>shim</code> in your project (it must be the first line):</p>
</li>
</ol>
<pre><code class="language-javascript"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;./shim&#039;</span>
<span style="color: #000000">...</span>
</code></pre>
<a href="#using-xrpljs-with-deno" id="using-xrpljs-with-deno" style="color: inherit; text-decoration: none;">
<h3>Using xrpl.js with Deno</h3>
</a>
<p>Until official support for <a href="https://deno.land">Deno</a> is added, you can use the following work-around to use <code>xrpl.js</code> with Deno:</p>
<pre><code class="language-javascript"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">xrpl</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;https://dev.jspm.io/npm:xrpl&#039;</span><span style="color: #000000">;</span>
<span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">api</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> (</span><span style="color: #001080">xrpl</span><span style="color: #000000"> </span><span style="color: #AF00DB">as</span><span style="color: #000000"> </span><span style="color: #267F99">any</span><span style="color: #000000">).</span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;wss://s.altnet.rippletest.net:51233&#039;</span><span style="color: #000000">);</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">address</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;rH8NxV12EuV...khfJ5uw9kT&#039;</span><span style="color: #000000">;</span>
<span style="color: #000000"> </span><span style="color: #001080">api</span><span style="color: #000000">.</span><span style="color: #795E26">connect</span><span style="color: #000000">().</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">api</span><span style="color: #000000">.</span><span style="color: #795E26">getBalances</span><span style="color: #000000">(</span><span style="color: #001080">address</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">balances</span><span style="color: #000000">: </span><span style="color: #267F99">any</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #267F99">JSON</span><span style="color: #000000">.</span><span style="color: #795E26">stringify</span><span style="color: #000000">(</span><span style="color: #001080">balances</span><span style="color: #000000">, </span><span style="color: #0000FF">null</span><span style="color: #000000">, </span><span style="color: #098658">2</span><span style="color: #000000">));</span>
<span style="color: #000000"> });</span>
<span style="color: #000000"> });</span>
<span style="color: #000000">})();</span>
</code></pre>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h2>Documentation</h2>
</a>
<ul>
<li><a href="https://xrpl.org/get-started-with-rippleapi-for-javascript.html">RippleAPI Beginners Guide</a></li>
<li><a href="https://xrpl.org/rippleapi-reference.html">RippleAPI Full Reference Documentation</a> (<a href="https://github.com/ripple/ripple-lib/blob/develop/docs/index.md">in this repo</a>)</li>
<li><a href="https://github.com/ripple/ripple-lib/tree/develop/docs/samples">Code Samples</a></li>
</ul>
<a href="#mailing-lists" id="mailing-lists" style="color: inherit; text-decoration: none;">
<h3>Mailing Lists</h3>
</a>
<p>We have a low-traffic mailing list for announcements of new <code>xrpl.js</code> releases. (About 1 email per week)</p>
<ul>
<li><a href="https://groups.google.com/g/xrpl-announce">Subscribe to xrpl-announce</a></li>
</ul>
<p>If you&#39;re using the XRP Ledger in production, you should run a <a href="https://github.com/ripple/rippled">rippled server</a> and subscribe to the ripple-server mailing list as well.</p>
<ul>
<li><a href="https://groups.google.com/g/ripple-server">Subscribe to ripple-server</a></li>
</ul>
<a href="#development" id="development" style="color: inherit; text-decoration: none;">
<h2>Development</h2>
</a>
<p>To build the library for Node.js and the browser:</p>
<pre><code class="language-shell"><span style="color: #000000">npm run build</span>
</code></pre>
<p>The TypeScript compiler will <a href="./tsconfig.json#L7">output</a> the resulting JS files in <code>./dist/npm/</code>.</p>
<p>webpack will output the resulting JS files in <code>./build/</code>.</p>
<p>For details, see the <code>scripts</code> in <code>package.json</code>.</p>
<a href="#running-tests" id="running-tests" style="color: inherit; text-decoration: none;">
<h2>Running Tests</h2>
</a>
<a href="#unit-tests" id="unit-tests" style="color: inherit; text-decoration: none;">
<h3>Unit Tests</h3>
</a>
<ol>
<li>Clone the repository</li>
<li><code>cd</code> into the repository and install dependencies with <code>npm install</code></li>
<li><code>npm test</code></li>
</ol>
<a href="#linting" id="linting" style="color: inherit; text-decoration: none;">
<h3>Linting</h3>
</a>
<p>Run <code>npm run lint</code> to lint the code with <code>eslint</code>.</p>
<a href="#generating-documentation" id="generating-documentation" style="color: inherit; text-decoration: none;">
<h2>Generating Documentation</h2>
</a>
<p>Update the documentation by running <code>npm run docgen</code>.</p>
<a href="#more-information" id="more-information" style="color: inherit; text-decoration: none;">
<h2>More Information</h2>
</a>
<ul>
<li><a href="https://groups.google.com/g/xrpl-announce">xrpl-announce mailing list</a> - subscribe for release announcements</li>
<li><a href="https://xrpl.org/rippleapi-reference.html">RippleAPI Reference</a> - XRP Ledger Dev Portal</li>
<li><a href="https://xrpl.org/">XRP Ledger Dev Portal</a></li>
</ul>
</div>
</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">
<li class=" tsd-kind-enum">
<a href="enums/AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Asf<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>TfFlags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/PaymentFlags.html" class="tsd-kind-icon">Payment<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/BroadcastClient.html" class="tsd-kind-icon">Broadcast<wbr>Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ConnectionError.html" class="tsd-kind-icon">Connection<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/DisconnectedError.html" class="tsd-kind-icon">Disconnected<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/NotConnectedError.html" class="tsd-kind-icon">Not<wbr>Connected<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/NotFoundError.html" class="tsd-kind-icon">Not<wbr>Found<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ResponseFormatError.html" class="tsd-kind-icon">Response<wbr>Format<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/RippledError.html" class="tsd-kind-icon">Rippled<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/RippledNotInitializedError.html" class="tsd-kind-icon">Rippled<wbr>Not<wbr>Initialized<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/TimeoutError.html" class="tsd-kind-icon">Timeout<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/UnexpectedError.html" class="tsd-kind-icon">Unexpected<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ValidationError.html" class="tsd-kind-icon">Validation<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Wallet.html" class="tsd-kind-icon">Wallet</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/XRPLFaucetError.html" class="tsd-kind-icon">XRPLFaucet<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/XrplError.html" class="tsd-kind-icon">Xrpl<wbr>Error</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountChannelsRequest.html" class="tsd-kind-icon">Account<wbr>Channels<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountChannelsResponse.html" class="tsd-kind-icon">Account<wbr>Channels<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountCurrenciesRequest.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountCurrenciesResponse.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountDelete.html" class="tsd-kind-icon">Account<wbr>Delete</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountInfoRequest.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountInfoResponse.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountLinesRequest.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountLinesResponse.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountObjectsRequest.html" class="tsd-kind-icon">Account<wbr>Objects<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountObjectsResponse.html" class="tsd-kind-icon">Account<wbr>Objects<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountOffersRequest.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountOffersResponse.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountSet.html" class="tsd-kind-icon">Account<wbr>Set</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountSetFlagsInterface.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountTxRequest.html" class="tsd-kind-icon">Account<wbr>TxRequest</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountTxResponse.html" class="tsd-kind-icon">Account<wbr>TxResponse</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/BookOffersRequest.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/BookOffersResponse.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ChannelVerifyRequest.html" class="tsd-kind-icon">Channel<wbr>Verify<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ChannelVerifyResponse.html" class="tsd-kind-icon">Channel<wbr>Verify<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/CheckCancel.html" class="tsd-kind-icon">Check<wbr>Cancel</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/CheckCash.html" class="tsd-kind-icon">Check<wbr>Cash</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/CheckCreate.html" class="tsd-kind-icon">Check<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ConsensusStream.html" class="tsd-kind-icon">Consensus<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/DepositAuthorizedRequest.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/DepositAuthorizedResponse.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr>Preauth</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ErrorResponse.html" class="tsd-kind-icon">Error<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/EscrowCancel.html" class="tsd-kind-icon">Escrow<wbr>Cancel</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/EscrowCreate.html" class="tsd-kind-icon">Escrow<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/EscrowFinish.html" class="tsd-kind-icon">Escrow<wbr>Finish</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FeeRequest.html" class="tsd-kind-icon">Fee<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FeeResponse.html" class="tsd-kind-icon">Fee<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/GatewayBalancesRequest.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/GatewayBalancesResponse.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerClosedRequest.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerClosedResponse.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerCurrentRequest.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerCurrentResponse.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerDataRequest.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerDataResponse.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerEntryRequest.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerEntryResponse.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerRequest.html" class="tsd-kind-icon">Ledger<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerResponse.html" class="tsd-kind-icon">Ledger<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerStream.html" class="tsd-kind-icon">Ledger<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ManifestRequest.html" class="tsd-kind-icon">Manifest<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ManifestResponse.html" class="tsd-kind-icon">Manifest<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/NoRippleCheckRequest.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/NoRippleCheckResponse.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OfferCancel.html" class="tsd-kind-icon">Offer<wbr>Cancel</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OfferCreate.html" class="tsd-kind-icon">Offer<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OfferCreateFlagsInterface.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OrderBookStream.html" class="tsd-kind-icon">Order<wbr>Book<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PathFindResponse.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PathFindStream.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/Payment.html" class="tsd-kind-icon">Payment</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelClaim.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelClaimFlagsInterface.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelCreate.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelFund.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Fund</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentFlagsInterface.html" class="tsd-kind-icon">Payment<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PeerStatusStream.html" class="tsd-kind-icon">Peer<wbr>Status<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PingRequest.html" class="tsd-kind-icon">Ping<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PingResponse.html" class="tsd-kind-icon">Ping<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RandomRequest.html" class="tsd-kind-icon">Random<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RandomResponse.html" class="tsd-kind-icon">Random<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RipplePathFindRequest.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RipplePathFindResponse.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerInfoRequest.html" class="tsd-kind-icon">Server<wbr>Info<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerInfoResponse.html" class="tsd-kind-icon">Server<wbr>Info<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerStateRequest.html" class="tsd-kind-icon">Server<wbr>State<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerStateResponse.html" class="tsd-kind-icon">Server<wbr>State<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SetRegularKey.html" class="tsd-kind-icon">Set<wbr>Regular<wbr>Key</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SignerListSet.html" class="tsd-kind-icon">Signer<wbr>List<wbr>Set</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitMultisignedRequest.html" class="tsd-kind-icon">Submit<wbr>Multisigned<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitMultisignedResponse.html" class="tsd-kind-icon">Submit<wbr>Multisigned<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitRequest.html" class="tsd-kind-icon">Submit<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitResponse.html" class="tsd-kind-icon">Submit<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubscribeRequest.html" class="tsd-kind-icon">Subscribe<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubscribeResponse.html" class="tsd-kind-icon">Subscribe<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TicketCreate.html" class="tsd-kind-icon">Ticket<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionAndMetadata.html" class="tsd-kind-icon">Transaction<wbr>And<wbr>Metadata</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionEntryRequest.html" class="tsd-kind-icon">Transaction<wbr>Entry<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionEntryResponse.html" class="tsd-kind-icon">Transaction<wbr>Entry<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionStream.html" class="tsd-kind-icon">Transaction<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TrustSet.html" class="tsd-kind-icon">Trust<wbr>Set</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TrustSetFlagsInterface.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TxRequest.html" class="tsd-kind-icon">Tx<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TxResponse.html" class="tsd-kind-icon">Tx<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/UnsubscribeRequest.html" class="tsd-kind-icon">Unsubscribe<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/UnsubscribeResponse.html" class="tsd-kind-icon">Unsubscribe<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ValidationStream.html" class="tsd-kind-icon">Validation<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#PathFindRequest" class="tsd-kind-icon">Path<wbr>Find<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Request" class="tsd-kind-icon">Request</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Response" class="tsd-kind-icon">Response</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Stream" class="tsd-kind-icon">Stream</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Transaction" class="tsd-kind-icon">Transaction</a>
</li>
<li class=" tsd-kind-property tsd-is-external">
<a href="modules.html#deriveKeypair" class="tsd-kind-icon">derive<wbr>Keypair</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#hashes" class="tsd-kind-icon">hashes</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#ISOTimeToRippleTime" class="tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#authorizeChannel" class="tsd-kind-icon">authorize<wbr>Channel</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#classicAddressToXAddress" class="tsd-kind-icon">classic<wbr>Address<wbr>ToXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#convertStringToHex" class="tsd-kind-icon">convert<wbr>String<wbr>ToHex</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeAccountID" class="tsd-kind-icon">decode<wbr>AccountID</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeAccountPublic" class="tsd-kind-icon">decode<wbr>Account<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeNodePublic" class="tsd-kind-icon">decode<wbr>Node<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeSeed" class="tsd-kind-icon">decode<wbr>Seed</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeXAddress" class="tsd-kind-icon">decodeXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#deriveXAddress" class="tsd-kind-icon">deriveXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#dropsToXrp" class="tsd-kind-icon">drops<wbr>ToXrp</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeAccountID" class="tsd-kind-icon">encode<wbr>AccountID</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeAccountPublic" class="tsd-kind-icon">encode<wbr>Account<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeNodePublic" class="tsd-kind-icon">encode<wbr>Node<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeSeed" class="tsd-kind-icon">encode<wbr>Seed</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeXAddress" class="tsd-kind-icon">encodeXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#generateXAddress" class="tsd-kind-icon">generateXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getBalanceChanges" class="tsd-kind-icon">get<wbr>Balance<wbr>Changes</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#isValidAddress" class="tsd-kind-icon">is<wbr>Valid<wbr>Address</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#isValidClassicAddress" class="tsd-kind-icon">is<wbr>Valid<wbr>Classic<wbr>Address</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#isValidSecret" class="tsd-kind-icon">is<wbr>Valid<wbr>Secret</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#isValidXAddress" class="tsd-kind-icon">is<wbr>ValidXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#multisign" class="tsd-kind-icon">multisign</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="modules.html#removeUndefined" class="tsd-kind-icon">remove<wbr>Undefined</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#rippleTimeToISOTime" class="tsd-kind-icon">ripple<wbr>Time<wbr>ToISOTime</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#rippleTimeToUnixTime" class="tsd-kind-icon">ripple<wbr>Time<wbr>ToUnix<wbr>Time</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#signPaymentChannelClaim" class="tsd-kind-icon">sign<wbr>Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#unixTimeToRippleTime" class="tsd-kind-icon">unix<wbr>Time<wbr>ToRipple<wbr>Time</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#validate" class="tsd-kind-icon">validate</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#verifyPaymentChannelClaim" class="tsd-kind-icon">verify<wbr>Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#verifySignature" class="tsd-kind-icon">verify<wbr>Signature</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#xAddressToClassicAddress" class="tsd-kind-icon">x<wbr>Address<wbr>ToClassic<wbr>Address</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#xrpToDrops" class="tsd-kind-icon">xrp<wbr>ToDrops</a>
</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>
</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>

View File

@@ -0,0 +1,343 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L36">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L30">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L42">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L44">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L49">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L54">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L59">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>
</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-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>
</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>

View File

@@ -0,0 +1,349 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountChannelsResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountChannelsResponse.html">AccountChannelsResponse</a>
</li>
</ul>
<h1>Interface AccountChannelsResponse</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 expected response from an <a href="AccountChannelsRequest.html">AccountChannelsRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountChannelsResponse</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="AccountChannelsResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountChannelsResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Channel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountChannels.ts#L68">src/models/methods/accountChannels.ts:68</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The address of the source/owner of the payment channels. This
corresponds to the account field of the request.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Channel</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Payment channels owned by this account.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger version used to generate this
response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version used to generate this response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The limit to how many channel objects were actually returned by this
request.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Server-defined value for pagination. Pass this to the next call to
resume getting results where this call left off. Omitted when there are
no additional pages after this one.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, the information in this response comes from a validated ledger
version. Otherwise, the information is subject to change.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountChannelsResponse.html" class="tsd-kind-icon">Account<wbr>Channels<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountChannelsResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,300 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountCurrencies.ts#L15">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountCurrencies.ts#L13">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountCurrencies.ts#L17">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountCurrencies.ts#L22">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountCurrencies.ts#L28">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>
</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 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-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>
</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>

View File

@@ -0,0 +1,328 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountCurrenciesResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountCurrenciesResponse.html">AccountCurrenciesResponse</a>
</li>
</ul>
<h1>Interface AccountCurrenciesResponse</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 expected response from an <a href="AccountCurrenciesRequest.html">AccountCurrenciesRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountCurrenciesResponse</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="AccountCurrenciesResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountCurrenciesResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>receive_currencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>send_currencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountCurrencies.ts#L37">src/models/methods/accountCurrencies.ts:37</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger version used to retrieve this data,
as hex.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version used to retrieve this data.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>receive_<wbr>currencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of Currency Codes for currencies that this account can receive.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>send_<wbr>currencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of Currency Codes for currencies that this account can send.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>validated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, this data comes from a validated ledger.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountCurrenciesResponse.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountCurrenciesResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,477 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountDelete.ts#L19">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 name="DestinationTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Destination<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountDelete.ts#L24">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 name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AccountDelete&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.TransactionType</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountDelete.ts#L13">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 name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="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>
<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-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>
</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>

View File

@@ -0,0 +1,340 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L16">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L18">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L23">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L29">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L33">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L39">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>
</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-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>
</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>

View File

@@ -0,0 +1,346 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountInfoResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountInfoResponse.html">AccountInfoResponse</a>
</li>
</ul>
<h1>Interface AccountInfoResponse</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>Response expected from an <a href="AccountInfoRequest.html">AccountInfoRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountInfoResponse</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="AccountInfoResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountInfoResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account_data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>queue_data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueueData</span><span class="tsd-signature-symbol">; </span>signer_lists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountInfo.ts#L90">src/models/methods/accountInfo.ts:90</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account_<wbr>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">default</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The AccountRoot ledger object with this account&#39;s information, as stored
in the ledger.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current in-progress ledger, which was used when
retrieving this information.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version used when retrieving this
information. The information does not contain any changes from ledger
versions newer than this one.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> queue_<wbr>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">QueueData</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Information about queued transactions sent by this account. This
information describes the state of the local rippled server, which may be
different from other servers in the peer-to-peer XRP Ledger network. Some
fields may be omitted because the values are calculated &quot;lazily&quot; by the
queuing mechanism.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> signer_<wbr>lists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of SignerList ledger objects associated with this account for
Multi-Signing. Since an account can own at most one SignerList, this
array must have exactly one member if it is present.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>True if this data is from a validated ledger version; if omitted or set
to false, this data is not final.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountInfoResponse.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountInfoResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,340 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L80">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L78">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L82">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L87">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L97">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L102">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L92">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>
</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-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>
</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>

View File

@@ -0,0 +1,342 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountLinesResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountLinesResponse.html">AccountLinesResponse</a>
</li>
</ul>
<h1>Interface AccountLinesResponse</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>Response expected from an <a href="AccountLinesRequest.html">AccountLinesRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountLinesResponse</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="AccountLinesResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountLinesResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>lines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Trustline</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountLines.ts#L111">src/models/methods/accountLines.ts:111</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique Address of the account this request corresponds to. This is the
&quot;perspective account&quot; for purpose of the trust lines.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current open ledger, which was used when
retrieving this information.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash the ledger version that was used when retrieving
this data.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version that was used when retrieving
this data.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>lines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Trustline</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of trust line objects. If the number of trust lines is large, only
returns up to the limit at a time.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Server-defined value indicating the response is paginated. Pass this to
the next call to resume where this call left off. Omitted when there are
No additional pages after this one.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountLinesResponse.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountLinesResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,361 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L26">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L24">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L37">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L39">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L44">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L49">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L54">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L32">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>
</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-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>
</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>

View File

@@ -0,0 +1,359 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountObjectsResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountObjectsResponse.html">AccountObjectsResponse</a>
</li>
</ul>
<h1>Interface AccountObjectsResponse</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>Response expected from an <a href="AccountObjectsRequest.html">AccountObjectsRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountObjectsResponse</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="AccountObjectsResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountObjectsResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>account_objects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountObjects.ts#L77">src/models/methods/accountObjects.ts:77</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique Address of the account this request corresponds to.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>account_<wbr>objects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountObject</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of objects owned by this account. Each object is in its raw
ledger format.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current in-progress ledger version, which was
used to generate this response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger that was used to generate this
response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version that was used to generate this
response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The limit that was used in this request, if any.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Server-defined value indicating the response is paginated. Pass this to
the next call to resume where this call left off. Omitted when there are
no additional pages after this one.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If included and set to true, the information in this response comes from
a validated ledger version. Otherwise, the information is subject to
change.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountObjectsResponse.html" class="tsd-kind-icon">Account<wbr>Objects<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountObjectsResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,340 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L15">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L13">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L17">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L22">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L27">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L32">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L38">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>
</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-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>
</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>

View File

@@ -0,0 +1,342 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountOffersResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountOffersResponse.html">AccountOffersResponse</a>
</li>
</ul>
<h1>Interface AccountOffersResponse</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>Response expected from an <a href="AccountOffersRequest.html">AccountOffersRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountOffersResponse</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="AccountOffersResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountOffersResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>offers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AccountOffer</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L74">src/models/methods/accountOffers.ts:74</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique Address identifying the account that made the offers.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current in-progress ledger version, which was
used when retrieving this data.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger version that was used when retrieving
this data.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version that was used when retrieving
this data, as requested.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Server-defined value indicating the response is paginated. Pass this to
the next call to resume where this call left off. Omitted when there are
no pages of information after this one.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> offers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AccountOffer</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of objects, where each object represents an offer made by this
account that is outstanding as of the requested ledger version. If the
number of offers is large, only returns up to limit at a time.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountOffersResponse.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountOffersResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,568 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountSet | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountSet.html">AccountSet</a>
</li>
</ul>
<h1>Interface AccountSet</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 AccountSet transaction modifies the properties of an account in the XRP
Ledger.</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">AccountSet</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="AccountSet.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#ClearFlag" class="tsd-kind-icon">Clear<wbr>Flag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#Domain" class="tsd-kind-icon">Domain</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#EmailHash" class="tsd-kind-icon">Email<wbr>Hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountSet.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.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="AccountSet.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#MessageKey" class="tsd-kind-icon">Message<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#SetFlag" class="tsd-kind-icon">Set<wbr>Flag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.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="AccountSet.html#SourceTag" class="tsd-kind-icon">Source<wbr>Tag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#TickSize" class="tsd-kind-icon">Tick<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.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="AccountSet.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSet.html#TransferRate" class="tsd-kind-icon">Transfer<wbr>Rate</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountSet.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ClearFlag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Clear<wbr>Flag</h3>
<div class="tsd-signature tsd-kind-icon">Clear<wbr>Flag<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/615504db/src/models/transactions/accountSet.ts#L90">src/models/transactions/accountSet.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique identifier of a flag to disable for this account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Domain" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Domain</h3>
<div class="tsd-signature tsd-kind-icon">Domain<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/615504db/src/models/transactions/accountSet.ts#L95">src/models/transactions/accountSet.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The domain that owns this account, as a string of hex representing the.
ASCII for the domain in lowercase.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="EmailHash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Email<wbr>Hash</h3>
<div class="tsd-signature tsd-kind-icon">Email<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/615504db/src/models/transactions/accountSet.ts#L97">src/models/transactions/accountSet.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash of an email address to be used for generating an avatar image.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="AccountSetFlagsInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSetFlagsInterface</a></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L88">src/models/transactions/accountSet.ts:88</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="MessageKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Message<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Message<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/615504db/src/models/transactions/accountSet.ts#L99">src/models/transactions/accountSet.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Public key for sending encrypted messages to this account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="SetFlag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Set<wbr>Flag</h3>
<div class="tsd-signature tsd-kind-icon">Set<wbr>Flag<span class="tsd-signature-symbol">:</span> <a href="../enums/AccountSetAsfFlags.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AccountSetAsfFlags</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L101">src/models/transactions/accountSet.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer flag to enable for this account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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">
<a name="TickSize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Tick<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">Tick<wbr>Size<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/615504db/src/models/transactions/accountSet.ts#L113">src/models/transactions/accountSet.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Tick size to use for offers involving a currency issued by this address.
The exchange rates of those offers is rounded to this many significant
digits. Valid values are 3 to 15 inclusive, or 0 to disable.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AccountSet&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/615504db/src/models/transactions/accountSet.ts#L87">src/models/transactions/accountSet.ts:87</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="TransferRate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Transfer<wbr>Rate</h3>
<div class="tsd-signature tsd-kind-icon">Transfer<wbr>Rate<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/615504db/src/models/transactions/accountSet.ts#L107">src/models/transactions/accountSet.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The fee to charge when users transfer this account&#39;s issued currencies,
represented as billionths of a unit. Cannot be more than 2000000000 or less
than 1000000000, except for the special case 0 meaning no fee.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="AccountSet.html" class="tsd-kind-icon">Account<wbr>Set</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#ClearFlag" class="tsd-kind-icon">Clear<wbr>Flag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#Domain" class="tsd-kind-icon">Domain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#EmailHash" class="tsd-kind-icon">Email<wbr>Hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountSet.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.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="AccountSet.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#MessageKey" class="tsd-kind-icon">Message<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#SetFlag" class="tsd-kind-icon">Set<wbr>Flag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.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="AccountSet.html#SourceTag" class="tsd-kind-icon">Source<wbr>Tag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#TickSize" class="tsd-kind-icon">Tick<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.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="AccountSet.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSet.html#TransferRate" class="tsd-kind-icon">Transfer<wbr>Rate</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountSet.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

View File

@@ -0,0 +1,242 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountSetFlagsInterface | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountSetFlagsInterface.html">AccountSetFlagsInterface</a>
</li>
</ul>
<h1>Interface AccountSetFlagsInterface</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>Map of flags to boolean values representing <a href="AccountSet.html">AccountSet</a> transaction
flags.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountSetFlagsInterface</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="AccountSetFlagsInterface.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr>AllowXRP</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr>DisallowXRP</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr>Optional<wbr>Auth</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr>Require<wbr>Auth</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountSetFlagsInterface.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>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfAllowXRP" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>AllowXRP</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>AllowXRP<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/615504db/src/models/transactions/accountSet.ts#L77">src/models/transactions/accountSet.ts:77</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfDisallowXRP" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>DisallowXRP</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>DisallowXRP<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/615504db/src/models/transactions/accountSet.ts#L76">src/models/transactions/accountSet.ts:76</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfOptionalAuth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Optional<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Optional<wbr>Auth<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/615504db/src/models/transactions/accountSet.ts#L75">src/models/transactions/accountSet.ts:75</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfOptionalDestTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Optional<wbr>Dest<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag<span class="tsd-signature-symbol">:</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/615504db/src/models/transactions/accountSet.ts#L73">src/models/transactions/accountSet.ts:73</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfRequireAuth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Require<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Require<wbr>Auth<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/615504db/src/models/transactions/accountSet.ts#L74">src/models/transactions/accountSet.ts:74</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfRequireDestTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Require<wbr>Dest<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Require<wbr>Dest<wbr>Tag<span class="tsd-signature-symbol">:</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/615504db/src/models/transactions/accountSet.ts#L72">src/models/transactions/accountSet.ts:72</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="AccountSetFlagsInterface.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Flags<wbr>Interface</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSetFlagsInterface.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr>AllowXRP</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSetFlagsInterface.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr>DisallowXRP</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSetFlagsInterface.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr>Optional<wbr>Auth</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSetFlagsInterface.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSetFlagsInterface.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr>Require<wbr>Auth</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountSetFlagsInterface.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr>Require<wbr>Dest<wbr>Tag</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-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>
</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>

View File

@@ -0,0 +1,400 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L17">src/models/methods/accountTx.ts:17</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L38">src/models/methods/accountTx.ts:38</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 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/xrplf/xrpl.js/blob/615504db/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">
<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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L43">src/models/methods/accountTx.ts:43</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L31">src/models/methods/accountTx.ts:31</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L33">src/models/methods/accountTx.ts:33</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L29">src/models/methods/accountTx.ts:29</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L23">src/models/methods/accountTx.ts:23</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L48">src/models/methods/accountTx.ts:48</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L54">src/models/methods/accountTx.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. 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>
</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-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>
</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>

View File

@@ -0,0 +1,349 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountTxResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="AccountTxResponse.html">AccountTxResponse</a>
</li>
</ul>
<h1>Interface AccountTxResponse</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>Expected response from an <a href="AccountTxRequest.html">AccountTxRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountTxResponse</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="AccountTxResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountTxResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index_max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_index_min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountTransaction</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountTx.ts#L82">src/models/methods/accountTx.ts:82</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique Address identifying the related account.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index_<wbr>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the most recent ledger actually searched for
transactions.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index_<wbr>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the earliest ledger actually searched for
transactions.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The limit value used in the request.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Server-defined value indicating the response is paginated. Pass this
to the next call to resume where this call left off.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountTransaction</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of transactions matching the request&#39;s criteria, as explained
below.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If included and set to true, the information in this response comes from
a validated ledger version. Otherwise, the information is subject to
change.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="AccountTxResponse.html" class="tsd-kind-icon">Account<wbr>TxResponse</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountTxResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,342 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L18">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L20">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L25">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L31">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L36">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L42">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L48">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>
</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-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>
</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>

View File

@@ -0,0 +1,325 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BookOffersResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="BookOffersResponse.html">BookOffersResponse</a>
</li>
</ul>
<h1>Interface BookOffersResponse</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>Expected response from a <a href="BookOffersRequest.html">BookOffersRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">BookOffersResponse</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="BookOffersResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="BookOffersResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BookOffer</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/bookOffers.ts#L83">src/models/methods/bookOffers.ts:83</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current in-progress ledger version, which was
used to retrieve this information.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger version that was used when retrieving
this data, as requested.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version that was used when retrieving
this data, as requested.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>offers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BookOffer</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of offer objects, each of which has the fields of an Offer object.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="BookOffersResponse.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="BookOffersResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,299 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/channelVerify.ts#L13">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/channelVerify.ts#L18">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/channelVerify.ts#L11">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/channelVerify.ts#L23">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/channelVerify.ts#L25">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>
</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-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>
</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>

View File

@@ -0,0 +1,296 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ChannelVerifyResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="ChannelVerifyResponse.html">ChannelVerifyResponse</a>
</li>
</ul>
<h1>Interface ChannelVerifyResponse</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>Response expected from an <a href="ChannelVerifyRequest.html">ChannelVerifyRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ChannelVerifyResponse</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="ChannelVerifyResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ChannelVerifyResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>signature_verified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/channelVerify.ts#L34">src/models/methods/channelVerify.ts:34</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>signature_<wbr>verified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, the signature is valid for the stated amount, channel, and
public key.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="ChannelVerifyResponse.html" class="tsd-kind-icon">Channel<wbr>Verify<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="ChannelVerifyResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,457 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="CheckID" class="tsd-anchor"></a>
<h3>CheckID</h3>
<div class="tsd-signature tsd-kind-icon">CheckID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCancel.ts#L19">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 name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CheckCancel&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.TransactionType</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCancel.ts#L14">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 name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="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>
<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-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>
</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>

View File

@@ -0,0 +1,498 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Amount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Amount</h3>
<div class="tsd-signature tsd-kind-icon">Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCash.ts#L26">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 name="CheckID" class="tsd-anchor"></a>
<h3>CheckID</h3>
<div class="tsd-signature tsd-kind-icon">CheckID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCash.ts#L20">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 name="DeliverMin" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Deliver<wbr>Min</h3>
<div class="tsd-signature tsd-kind-icon">Deliver<wbr>Min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCash.ts#L32">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 name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CheckCash&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.TransactionType</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCash.ts#L15">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 name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="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>
<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-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>
</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>

View File

@@ -0,0 +1,538 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CheckCreate | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="CheckCreate.html">CheckCreate</a>
</li>
</ul>
<h1>Interface CheckCreate</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>Create a Check object in the ledger, which is a deferred payment that can be
cashed by its intended destination. The sender of this transaction is the
sender of the Check.</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">CheckCreate</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="CheckCreate.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCreate.html#Destination" class="tsd-kind-icon">Destination</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCreate.html#DestinationTag" class="tsd-kind-icon">Destination<wbr>Tag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCreate.html#Expiration" class="tsd-kind-icon">Expiration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCreate.html#InvoiceID" class="tsd-kind-icon">InvoiceID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.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="CheckCreate.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CheckCreate.html#SendMax" class="tsd-kind-icon">Send<wbr>Max</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CheckCreate.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="CheckCreate.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="CheckCreate.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="CheckCreate.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="CheckCreate.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCreate.ts#L21">src/models/transactions/checkCreate.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that can cash the Check.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="DestinationTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Destination<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCreate.ts#L34">src/models/transactions/checkCreate.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary tag that identifies the reason for the Check, or a hosted.
recipient to pay.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Expiration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Expiration</h3>
<div class="tsd-signature tsd-kind-icon">Expiration<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/615504db/src/models/transactions/checkCreate.ts#L39">src/models/transactions/checkCreate.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Time after which the Check is no longer valid, in seconds since the Ripple.
Epoch.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/transactions/checkCreate.ts#L44">src/models/transactions/checkCreate.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary 256-bit hash representing a specific reason or identifier for.
this Check.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="SendMax" class="tsd-anchor"></a>
<h3>Send<wbr>Max</h3>
<div class="tsd-signature tsd-kind-icon">Send<wbr>Max<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/615504db/src/models/transactions/checkCreate.ts#L29">src/models/transactions/checkCreate.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maximum amount of source currency the Check is allowed to debit the
sender, including transfer fees on non-XRP currencies. The Check can only
credit the destination with the same currency (from the same issuer, for
non-XRP currencies). For non-XRP amounts, the nested field names MUST be.
lower-case.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CheckCreate&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/615504db/src/models/transactions/checkCreate.ts#L19">src/models/transactions/checkCreate.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="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="CheckCreate.html" class="tsd-kind-icon">Check<wbr>Create</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CheckCreate.html#Destination" class="tsd-kind-icon">Destination</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CheckCreate.html#DestinationTag" class="tsd-kind-icon">Destination<wbr>Tag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CheckCreate.html#Expiration" class="tsd-kind-icon">Expiration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CheckCreate.html#InvoiceID" class="tsd-kind-icon">InvoiceID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.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="CheckCreate.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CheckCreate.html#SendMax" class="tsd-kind-icon">Send<wbr>Max</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="CheckCreate.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="CheckCreate.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="CheckCreate.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="CheckCreate.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="CheckCreate.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

View File

@@ -0,0 +1,199 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L313">src/models/methods/subscribe.ts:313</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L308">src/models/methods/subscribe.ts:308</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-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>
</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>

View File

@@ -0,0 +1,297 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/depositAuthorized.ts#L13">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/depositAuthorized.ts#L17">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/depositAuthorized.ts#L19">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/depositAuthorized.ts#L24">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/depositAuthorized.ts#L15">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>
</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-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>
</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>

View File

@@ -0,0 +1,349 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DepositAuthorizedResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="DepositAuthorizedResponse.html">DepositAuthorizedResponse</a>
</li>
</ul>
<h1>Interface DepositAuthorizedResponse</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>Expected response from a <a href="DepositAuthorizedRequest.html">DepositAuthorizedRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DepositAuthorizedResponse</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="DepositAuthorizedResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="DepositAuthorizedResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deposit_authorized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>destination_account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>source_account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/depositAuthorized.ts#L33">src/models/methods/depositAuthorized.ts:33</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>deposit_<wbr>authorized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether the specified source account is authorized to send payments
directly to the destination account. If true, either the destination
account does not require Deposit Authorization or the source account is
preauthorized.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The destination account specified in the request.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current in-progress ledger version, which was
used to generate this response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger that was used to generate this
Response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version that was used to generate this
Response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>source_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The source account specified in the request.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, the information comes from a validated ledger version.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="DepositAuthorizedResponse.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="DepositAuthorizedResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,475 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Authorize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Authorize</h3>
<div class="tsd-signature tsd-kind-icon">Authorize<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/depositPreauth.ts#L16">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 name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;DepositPreauth&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.TransactionType</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/depositPreauth.ts#L14">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 name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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 name="Unauthorize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Unauthorize</h3>
<div class="tsd-signature tsd-kind-icon">Unauthorize<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/depositPreauth.ts#L21">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>
</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="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>
<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-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>
</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>

View File

@@ -0,0 +1,270 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ErrorResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="ErrorResponse.html">ErrorResponse</a>
</li>
</ul>
<h1>Interface ErrorResponse</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 shape of an error response from rippled. xrpl.js handles rejections by
throwing, and allowing the user to handle in the catch block of a promise.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ErrorResponse</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="ErrorResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.html#error_code" class="tsd-kind-icon">error_<wbr>code</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ErrorResponse.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="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">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L48">src/models/methods/baseMethod.ts:48</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="error" class="tsd-anchor"></a>
<h3>error</h3>
<div class="tsd-signature tsd-kind-icon">error<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/615504db/src/models/methods/baseMethod.ts#L44">src/models/methods/baseMethod.ts:44</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="error_code" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> error_<wbr>code</h3>
<div class="tsd-signature tsd-kind-icon">error_<wbr>code<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/615504db/src/models/methods/baseMethod.ts#L45">src/models/methods/baseMethod.ts:45</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="error_message" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> error_<wbr>message</h3>
<div class="tsd-signature tsd-kind-icon">error_<wbr>message<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/615504db/src/models/methods/baseMethod.ts#L46">src/models/methods/baseMethod.ts:46</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><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/615504db/src/models/methods/baseMethod.ts#L41">src/models/methods/baseMethod.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Request" class="tsd-signature-type" data-tsd-kind="Type alias">Request</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L47">src/models/methods/baseMethod.ts:47</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="status" class="tsd-anchor"></a>
<h3>status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;error&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L42">src/models/methods/baseMethod.ts:42</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L43">src/models/methods/baseMethod.ts:43</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="ErrorResponse.html" class="tsd-kind-icon">Error<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#error_code" class="tsd-kind-icon">error_<wbr>code</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ErrorResponse.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-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>
</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>

View File

@@ -0,0 +1,473 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="OfferSequence" class="tsd-anchor"></a>
<h3>Offer<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Offer<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCancel.ts#L18">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 name="Owner" class="tsd-anchor"></a>
<h3>Owner</h3>
<div class="tsd-signature tsd-kind-icon">Owner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCancel.ts#L13">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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EscrowCancel&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.TransactionType</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCancel.ts#L11">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 name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="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>
<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-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>
</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>

View File

@@ -0,0 +1,556 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EscrowCreate | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="EscrowCreate.html">EscrowCreate</a>
</li>
</ul>
<h1>Interface EscrowCreate</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>Sequester XRP until the escrow process either finishes or is canceled.</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">EscrowCreate</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="EscrowCreate.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCreate.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCreate.html#Amount" class="tsd-kind-icon">Amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCreate.html#CancelAfter" class="tsd-kind-icon">Cancel<wbr>After</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCreate.html#Condition" class="tsd-kind-icon">Condition</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCreate.html#Destination" class="tsd-kind-icon">Destination</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCreate.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="EscrowCreate.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="EscrowCreate.html#FinishAfter" class="tsd-kind-icon">Finish<wbr>After</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCreate.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCreate.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="EscrowCreate.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCreate.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCreate.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="EscrowCreate.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="EscrowCreate.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="EscrowCreate.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="EscrowCreate.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="EscrowCreate.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCreate.ts#L18">src/models/transactions/escrowCreate.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Amount of XRP, in drops, to deduct from the sender&#39;s balance and escrow.
Once escrowed, the XRP can either go to the Destination address (after the.
FinishAfter time) or returned to the sender (after the CancelAfter time).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="CancelAfter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Cancel<wbr>After</h3>
<div class="tsd-signature tsd-kind-icon">Cancel<wbr>After<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/615504db/src/models/transactions/escrowCreate.ts#L26">src/models/transactions/escrowCreate.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The time, in seconds since the Ripple Epoch, when this escrow expires.
This value is immutable; the funds can only be returned the sender after.
this time.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Condition" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Condition</h3>
<div class="tsd-signature tsd-kind-icon">Condition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCreate.ts#L37">src/models/transactions/escrowCreate.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hex value representing a PREIMAGE-SHA-256 crypto-condition . The funds can.
only be delivered to the recipient if this condition is fulfilled.</p>
</div>
</div>
</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">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCreate.ts#L20">src/models/transactions/escrowCreate.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Address to receive escrowed XRP.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="DestinationTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Destination<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowCreate.ts#L42">src/models/transactions/escrowCreate.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary tag to further specify the destination for this escrowed.
payment, such as a hosted recipient at the destination address.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="FinishAfter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Finish<wbr>After</h3>
<div class="tsd-signature tsd-kind-icon">Finish<wbr>After<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/615504db/src/models/transactions/escrowCreate.ts#L32">src/models/transactions/escrowCreate.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The time, in seconds since the Ripple Epoch, when the escrowed XRP can be
released to the recipient. This value is immutable; the funds cannot move.
until this time is reached.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EscrowCreate&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/615504db/src/models/transactions/escrowCreate.ts#L12">src/models/transactions/escrowCreate.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="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="EscrowCreate.html" class="tsd-kind-icon">Escrow<wbr>Create</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="EscrowCreate.html#Amount" class="tsd-kind-icon">Amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="EscrowCreate.html#CancelAfter" class="tsd-kind-icon">Cancel<wbr>After</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="EscrowCreate.html#Condition" class="tsd-kind-icon">Condition</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="EscrowCreate.html#Destination" class="tsd-kind-icon">Destination</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="EscrowCreate.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="EscrowCreate.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="EscrowCreate.html#FinishAfter" class="tsd-kind-icon">Finish<wbr>After</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.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="EscrowCreate.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="EscrowCreate.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="EscrowCreate.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="EscrowCreate.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="EscrowCreate.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="EscrowCreate.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

View File

@@ -0,0 +1,513 @@
<!doctype html>
<html class="default no-js">
<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/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">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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Condition" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Condition</h3>
<div class="tsd-signature tsd-kind-icon">Condition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowFinish.ts#L23">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 name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Fulfillment" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fulfillment</h3>
<div class="tsd-signature tsd-kind-icon">Fulfillment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowFinish.ts#L28">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 name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="OfferSequence" class="tsd-anchor"></a>
<h3>Offer<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Offer<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowFinish.ts#L18">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 name="Owner" class="tsd-anchor"></a>
<h3>Owner</h3>
<div class="tsd-signature tsd-kind-icon">Owner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowFinish.ts#L13">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 name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EscrowFinish&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.TransactionType</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/escrowFinish.ts#L11">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 name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="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>
<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-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>
</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>

View File

@@ -0,0 +1,229 @@
<!doctype html>
<html class="default no-js">
<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/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">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 style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">feeRequest</span><span style="color: #000000">: </span><span style="color: #267F99">FeeRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #001080">command:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;fee&#039;</span>
<span style="color: #000000">}</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/fee.ts#L18">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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>
</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-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>
</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>

View File

@@ -0,0 +1,413 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FeeResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="FeeResponse.html">FeeResponse</a>
</li>
</ul>
<h1>Interface FeeResponse</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>Response expected from a <a href="FeeRequest.html">FeeRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FeeResponse</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="FeeResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="FeeResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current_ledger_size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>current_queue_size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>drops<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>base_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>median_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>minimum_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open_ledger_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>expected_ledger_size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>levels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>median_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>minimum_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open_ledger_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reference_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>max_queue_size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/fee.ts#L27">src/models/methods/fee.ts:27</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>current_<wbr>ledger_<wbr>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Number of transactions provisionally included in the in-progress ledger.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>current_<wbr>queue_<wbr>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Number of transactions currently queued for the next ledger.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>drops<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>base_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>median_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>minimum_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open_ledger_fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>base_<wbr>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The transaction cost required for a reference transaction to be
included in a ledger under minimum load, represented in drops of XRP.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>median_<wbr>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An approximation of the median transaction cost among transactions.
Included in the previous validated ledger, represented in drops of XRP.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>minimum_<wbr>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The minimum transaction cost for a reference transaction to be queued
for a later ledger, represented in drops of XRP. If greater than
base_fee, the transaction queue is full.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>open_<wbr>ledger_<wbr>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The minimum transaction cost that a reference transaction must pay to
be included in the current open ledger, represented in drops of XRP.</p>
</div>
</div>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>expected_<wbr>ledger_<wbr>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The approximate number of transactions expected to be included in the
current ledger. This is based on the number of transactions in the
previous ledger.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Ledger Index of the current open ledger these stats describe.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>levels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>median_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>minimum_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open_ledger_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reference_level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>median_<wbr>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The median transaction cost among transactions in the previous
validated ledger, represented in fee levels.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>minimum_<wbr>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The minimum transaction cost required to be queued for a future
ledger, represented in fee levels.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>open_<wbr>ledger_<wbr>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The minimum transaction cost required to be included in the current
open ledger, represented in fee levels.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>reference_<wbr>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The equivalent of the minimum transaction cost, represented in fee
levels.</p>
</div>
</div>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>max_<wbr>queue_<wbr>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The maximum number of transactions that the transaction queue can
currently hold.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="FeeResponse.html" class="tsd-kind-icon">Fee<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="FeeResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,332 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>GatewayBalancesRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/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">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="GatewayBalancesRequest.html">GatewayBalancesRequest</a>
</li>
</ul>
<h1>Interface GatewayBalancesRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The gateway_balances command calculates the total balances issued by a given
account, optionally excluding amounts held by operational addresses. Expects
a response in the form of a <a href="GatewayBalancesResponse.html">GatewayBalancesResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">gatewayBalances</span><span style="color: #000000">: </span><span style="color: #267F99">GatewayBalanceRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;id&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;example_gateway_balances_1&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;gateway_balances&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;account&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;strict&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;hotwallet&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> [</span><span style="color: #A31515">&quot;rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ&quot;</span><span style="color: #000000">,</span><span style="color: #A31515">&quot;ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt&quot;</span><span style="color: #000000">],</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_index&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;validated&quot;</span>
<span style="color: #000000">}</span>
</code></pre>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">GatewayBalancesRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="GatewayBalancesRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#hotwallet" class="tsd-kind-icon">hotwallet</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="GatewayBalancesRequest.html#strict" class="tsd-kind-icon">strict</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/methods/gatewayBalances.ts#L27">src/models/methods/gatewayBalances.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Address to check. This should be the issuing address.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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;gateway_balances&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/615504db/src/models/methods/gatewayBalances.ts#L25">src/models/methods/gatewayBalances.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="hotwallet" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hotwallet</h3>
<div class="tsd-signature tsd-kind-icon">hotwallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/gatewayBalances.ts#L37">src/models/methods/gatewayBalances.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An operational address to exclude from the balances issued, or an array of
Such addresses.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/gatewayBalances.ts#L39">src/models/methods/gatewayBalances.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A 20-byte hex string for the ledger version to use.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/methods/gatewayBalances.ts#L44">src/models/methods/gatewayBalances.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version to use, or a shortcut string to
choose a ledger automatically.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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/xrplf/xrpl.js/blob/615504db/src/models/methods/gatewayBalances.ts#L32">src/models/methods/gatewayBalances.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, only accept an address or public key for the account parameter.
Defaults to false.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</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="GatewayBalancesRequest.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="GatewayBalancesRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="GatewayBalancesRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="GatewayBalancesRequest.html#hotwallet" class="tsd-kind-icon">hotwallet</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="GatewayBalancesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="GatewayBalancesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="GatewayBalancesRequest.html#strict" class="tsd-kind-icon">strict</a>
</li>
</ul>
</li>
</ul>
<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-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>
</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>

View File

@@ -0,0 +1,364 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>GatewayBalancesResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="GatewayBalancesResponse.html">GatewayBalancesResponse</a>
</li>
</ul>
<h1>Interface GatewayBalancesResponse</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>Expected response from a <a href="GatewayBalancesRequest.html">GatewayBalancesRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">GatewayBalancesResponse</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="GatewayBalancesResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="GatewayBalancesResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>assets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>balances<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>obligations<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/gatewayBalances.ts#L58">src/models/methods/gatewayBalances.ts:58</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The address of the account that issued the balances.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> assets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Total amounts held that are issued by others. In the recommended
configuration, the issuing address should have none.</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Balance</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> balances<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Amounts issued to the hotwallet addresses from the request. The keys are
addresses and the values are arrays of currency amounts they hold.</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Balance</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger version that was used to generate this
response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger version that was used to generate
this response.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the current in-progress ledger version, which was
used to retrieve this information.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> obligations<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Total amounts issued to addresses not excluded, as a map of currencies
to the total value issued.</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>currency: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="GatewayBalancesResponse.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="GatewayBalancesResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,231 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerClosedRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerClosedRequest.html">LedgerClosedRequest</a>
</li>
</ul>
<h1>Interface LedgerClosedRequest</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 ledger_closed method returns the unique identifiers of the most recently
closed ledger. Expects a response in the form of a <a href="LedgerClosedResponse.html">LedgerClosedResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><ul>
<li><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ledgerClosed</span><span style="color: #000000">: </span><span style="color: #267F99">LedgerClosedRequest</span><span style="color: #000000"> = {</span>
<span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_closed&quot;</span>
<span style="color: #000000">}</span>
</code></pre>
</li>
</ul>
</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">LedgerClosedRequest</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="LedgerClosedRequest.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="LedgerClosedRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedRequest.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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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;ledger_closed&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/615504db/src/models/methods/ledgerClosed.ts#L19">src/models/methods/ledgerClosed.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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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>
</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="LedgerClosedRequest.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedRequest.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="LedgerClosedRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedRequest.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-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>
</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>

View File

@@ -0,0 +1,293 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerClosedResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerClosedResponse.html">LedgerClosedResponse</a>
</li>
</ul>
<h1>Interface LedgerClosedResponse</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 response expected from a <a href="LedgerClosedRequest.html">LedgerClosedRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">LedgerClosedResponse</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="LedgerClosedResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerClosedResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerClosed.ts#L28">src/models/methods/ledgerClosed.ts:28</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ledger_<wbr>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="LedgerClosedResponse.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerClosedResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,228 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerCurrentRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerCurrentRequest.html">LedgerCurrentRequest</a>
</li>
</ul>
<h1>Interface LedgerCurrentRequest</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 ledger_current method returns the unique identifiers of the current
in-progress ledger. Expects a response in the form of a <a href="LedgerCurrentResponse.html">LedgerCurrentResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ledgerCurrent</span><span style="color: #000000">: </span><span style="color: #267F99">LedgerCurrentRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_current&quot;</span>
<span style="color: #000000">}</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">LedgerCurrentRequest</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="LedgerCurrentRequest.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="LedgerCurrentRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentRequest.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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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;ledger_current&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/615504db/src/models/methods/ledgerCurrent.ts#L18">src/models/methods/ledgerCurrent.ts:18</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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>
</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="LedgerCurrentRequest.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentRequest.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="LedgerCurrentRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentRequest.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-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>
</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>

View File

@@ -0,0 +1,295 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerCurrentResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerCurrentResponse.html">LedgerCurrentResponse</a>
</li>
</ul>
<h1>Interface LedgerCurrentResponse</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>Response expected from a <a href="LedgerCurrentRequest.html">LedgerCurrentRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">LedgerCurrentResponse</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="LedgerCurrentResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerCurrentResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger_current_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerCurrent.ts#L27">src/models/methods/ledgerCurrent.ts:27</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of this ledger version.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="LedgerCurrentResponse.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerCurrentResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,332 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerDataRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerDataRequest.html">LedgerDataRequest</a>
</li>
</ul>
<h1>Interface LedgerDataRequest</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>ledger_data</code> method retrieves contents of the specified ledger. You can
iterate through several calls to retrieve the entire contents of a single
ledger version.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ledgerData</span><span style="color: #000000">: </span><span style="color: #267F99">LedgerDataRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;id&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #098658">2</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_hash&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_data&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;limit&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #098658">5</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;binary&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span>
<span style="color: #000000">}</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">LedgerDataRequest</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="LedgerDataRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerDataRequest.html#binary" class="tsd-kind-icon">binary</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerDataRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerDataRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerDataRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerDataRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerDataRequest.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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerData.ts#L37">src/models/methods/ledgerData.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If set to true, return ledger objects as hashed hex strings instead of
JSON.</p>
</div>
</div>
</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;ledger_data&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/615504db/src/models/methods/ledgerData.ts#L25">src/models/methods/ledgerData.ts:25</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerData.ts#L27">src/models/methods/ledgerData.ts:27</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerData.ts#L32">src/models/methods/ledgerData.ts:32</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerData.ts#L42">src/models/methods/ledgerData.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Limit the number of ledger objects 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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerData.ts#L47">src/models/methods/ledgerData.ts:47</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>
</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="LedgerDataRequest.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerDataRequest.html#binary" class="tsd-kind-icon">binary</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerDataRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerDataRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerDataRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerDataRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerDataRequest.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-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>
</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>

View File

@@ -0,0 +1,324 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerDataResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerDataResponse.html">LedgerDataResponse</a>
</li>
</ul>
<h1>Interface LedgerDataResponse</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 response expected from a <a href="LedgerDataRequest.html">LedgerDataRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">LedgerDataResponse</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="LedgerDataResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerDataResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger_hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerData.ts#L64">src/models/methods/ledgerData.ts:64</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ledger_<wbr>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique identifying hash of this ledger version.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of this ledger version.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Server-defined value indicating the response is paginated. Pass this to
the next call to resume where this call left off.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">State</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of JSON objects containing data from the ledger&#39;s state tree,
as defined below.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="LedgerDataResponse.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerDataResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,508 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerEntryRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerEntryRequest.html">LedgerEntryRequest</a>
</li>
</ul>
<h1>Interface LedgerEntryRequest</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>ledger_entry</code> method returns a single ledger object from the XRP Ledger
in its raw format. Expects a response in the form of a <a href="LedgerEntryResponse.html">LedgerEntryResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ledgerEntry</span><span style="color: #000000">: </span><span style="color: #267F99">LedgerEntryRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #001080">command:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_entry&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #001080">ledger_index:</span><span style="color: #000000"> </span><span style="color: #098658">60102302</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #001080">index:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4&quot;</span>
<span style="color: #000000">}</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">LedgerEntryRequest</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="LedgerEntryRequest.html#account_root" class="tsd-kind-icon">account_<wbr>root</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#binary" class="tsd-kind-icon">binary</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#check" class="tsd-kind-icon">check</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerEntryRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#deposit_preauth" class="tsd-kind-icon">deposit_<wbr>preauth</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#directory" class="tsd-kind-icon">directory</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#escrow" class="tsd-kind-icon">escrow</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#index" class="tsd-kind-icon">index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#offer" class="tsd-kind-icon">offer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#payment_channel" class="tsd-kind-icon">payment_<wbr>channel</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ripple_state" class="tsd-kind-icon">ripple_<wbr>state</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ticket" class="tsd-kind-icon">ticket</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_root" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> account_<wbr>root</h3>
<div class="tsd-signature tsd-kind-icon">account_<wbr>root<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/615504db/src/models/methods/ledgerEntry.ts#L47">src/models/methods/ledgerEntry.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve an AccountRoot object by its address. This is roughly equivalent
to the an <a href="AccountInfoRequest.html">AccountInfoRequest</a>.</p>
</div>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L29">src/models/methods/ledgerEntry.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, return the requested ledger object&#39;s contents as a hex string in
the XRP Ledger&#39;s binary format. Otherwise, return data in JSON format. The
default is false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="check" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> check</h3>
<div class="tsd-signature tsd-kind-icon">check<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/615504db/src/models/methods/ledgerEntry.ts#L95">src/models/methods/ledgerEntry.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The object ID of a Check object to retrieve.</p>
</div>
</div>
</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;ledger_entry&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/615504db/src/models/methods/ledgerEntry.ts#L23">src/models/methods/ledgerEntry.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="deposit_preauth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> deposit_<wbr>preauth</h3>
<div class="tsd-signature tsd-kind-icon">deposit_<wbr>preauth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>authorized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L118">src/models/methods/ledgerEntry.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specify a DepositPreauth object to retrieve. If a string, must be the
object ID of the DepositPreauth object, as hexadecimal. If an object,
requires owner and authorized sub-fields.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="directory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> directory</h3>
<div class="tsd-signature tsd-kind-icon">directory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>dir_root<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sub_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L54">src/models/methods/ledgerEntry.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The DirectoryNode to retrieve. If a string, must be the object ID of the
directory, as hexadecimal. If an object, requires either <code>dir_root</code> o
Owner as a sub-field, plus optionally a <code>sub_index</code> sub-field.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="escrow" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> escrow</h3>
<div class="tsd-signature tsd-kind-icon">escrow<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L101">src/models/methods/ledgerEntry.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Escrow object to retrieve. If a string, must be the object ID of the
escrow, as hexadecimal. If an object, requires owner and seq sub-fields.</p>
</div>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 name="index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> index</h3>
<div class="tsd-signature tsd-kind-icon">index<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/615504db/src/models/methods/ledgerEntry.ts#L41">src/models/methods/ledgerEntry.ts:41</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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L31">src/models/methods/ledgerEntry.ts:31</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L33">src/models/methods/ledgerEntry.ts:33</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.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="offer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> offer</h3>
<div class="tsd-signature tsd-kind-icon">offer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L70">src/models/methods/ledgerEntry.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Offer object to retrieve. If a string, interpret as the unique object
ID to the Offer. If an object, requires the sub-fields <code>account</code> and <code>seq</code>
to uniquely identify the offer.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="payment_channel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> payment_<wbr>channel</h3>
<div class="tsd-signature tsd-kind-icon">payment_<wbr>channel<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/615504db/src/models/methods/ledgerEntry.ts#L111">src/models/methods/ledgerEntry.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The object ID of a PayChannel object to retrieve.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ripple_state" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ripple_<wbr>state</h3>
<div class="tsd-signature tsd-kind-icon">ripple_<wbr>state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L84">src/models/methods/ledgerEntry.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Object specifying the RippleState (trust line) object to retrieve. The
accounts and currency sub-fields are required to uniquely specify the
rippleState entry to retrieve.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>2-length array of account Addresses, defining the two accounts linked by
this RippleState object.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Currency Code of the RippleState object to retrieve.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ticket" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ticket</h3>
<div class="tsd-signature tsd-kind-icon">ticket<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ticket_sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L132">src/models/methods/ledgerEntry.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Ticket object to retrieve. If a string, must be the object ID of the
Ticket, as hexadecimal. If an object, the <code>owner</code> and <code>ticket_sequence</code>
sub-fields are required to uniquely specify the Ticket entry.</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>
</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="LedgerEntryRequest.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#account_root" class="tsd-kind-icon">account_<wbr>root</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#binary" class="tsd-kind-icon">binary</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#check" class="tsd-kind-icon">check</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerEntryRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#deposit_preauth" class="tsd-kind-icon">deposit_<wbr>preauth</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#directory" class="tsd-kind-icon">directory</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#escrow" class="tsd-kind-icon">escrow</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#index" class="tsd-kind-icon">index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#offer" class="tsd-kind-icon">offer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#payment_channel" class="tsd-kind-icon">payment_<wbr>channel</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#ripple_state" class="tsd-kind-icon">ripple_<wbr>state</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerEntryRequest.html#ticket" class="tsd-kind-icon">ticket</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-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>
</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>

View File

@@ -0,0 +1,323 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerEntryResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerEntryResponse.html">LedgerEntryResponse</a>
</li>
</ul>
<h1>Interface LedgerEntryResponse</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>Response expected from a <a href="LedgerEntryRequest.html">LedgerEntryRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">LedgerEntryResponse</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="LedgerEntryResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerEntryResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_current_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>node<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerEntry</span><span class="tsd-signature-symbol">; </span>node_binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledgerEntry.ts#L148">src/models/methods/ledgerEntry.ts:148</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique ID of this ledger object.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger that was used when retrieving this data.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> node<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">LedgerEntry</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Object containing the data of this ledger object, according to the
ledger format.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> node_<wbr>binary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The binary representation of the ledger object, as hexadecimal.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="LedgerEntryResponse.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerEntryResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,418 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerRequest.html">LedgerRequest</a>
</li>
</ul>
<h1>Interface LedgerRequest</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>Retrieve information about the public ledger. Expects a response in the form
of a <a href="LedgerResponse.html">LedgerResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ledger</span><span style="color: #000000">: </span><span style="color: #267F99">LedgerRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;id&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #098658">14</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_index&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;validated&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;full&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;accounts&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;transactions&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;expand&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;owner_funds&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">false</span>
<span style="color: #000000">}</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">LedgerRequest</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="LedgerRequest.html#accounts" class="tsd-kind-icon">accounts</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#binary" class="tsd-kind-icon">binary</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#expand" class="tsd-kind-icon">expand</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#full" class="tsd-kind-icon">full</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#owner_funds" class="tsd-kind-icon">owner_<wbr>funds</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#queue" class="tsd-kind-icon">queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#transactions" class="tsd-kind-icon">transactions</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="accounts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accounts</h3>
<div class="tsd-signature tsd-kind-icon">accounts<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/615504db/src/models/methods/ledger.ts#L46">src/models/methods/ledger.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Admin required. If true, return information on accounts in the ledger.
Ignored if you did not specify a ledger version. Defaults to false.</p>
</div>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L70">src/models/methods/ledger.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, and transactions and expand are both also true, return
transaction information in binary format (hexadecimal string) instead of
JSON format.</p>
</div>
</div>
</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;ledger&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/615504db/src/models/methods/ledger.ts#L29">src/models/methods/ledger.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="expand" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> expand</h3>
<div class="tsd-signature tsd-kind-icon">expand<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/615504db/src/models/methods/ledger.ts#L58">src/models/methods/ledger.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Provide full JSON-formatted information for transaction/account
information instead of only hashes. Defaults to false. Ignored unless you
request transactions, accounts, or both.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="full" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> full</h3>
<div class="tsd-signature tsd-kind-icon">full<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/615504db/src/models/methods/ledger.ts#L41">src/models/methods/ledger.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Admin required If true, return full information on the entire ledger.
Ignored if you did not specify a ledger version. Defaults to false.</p>
</div>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L31">src/models/methods/ledger.ts:31</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L36">src/models/methods/ledger.ts:36</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 name="owner_funds" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> owner_<wbr>funds</h3>
<div class="tsd-signature tsd-kind-icon">owner_<wbr>funds<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/615504db/src/models/methods/ledger.ts#L64">src/models/methods/ledger.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, include owner_funds field in the metadata of OfferCreate
transactions in the response. Defaults to false. Ignored unless
transactions are included and expand is true.</p>
</div>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L75">src/models/methods/ledger.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, and the command is requesting the current ledger, includes an
array of queued transactions in the results.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transactions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transactions</h3>
<div class="tsd-signature tsd-kind-icon">transactions<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/615504db/src/models/methods/ledger.ts#L52">src/models/methods/ledger.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, return information on transactions in the specified ledger
version. Defaults to false. Ignored if you did not specify a ledger
version.</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>
</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="LedgerRequest.html" class="tsd-kind-icon">Ledger<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#accounts" class="tsd-kind-icon">accounts</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#binary" class="tsd-kind-icon">binary</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#expand" class="tsd-kind-icon">expand</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#full" class="tsd-kind-icon">full</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#owner_funds" class="tsd-kind-icon">owner_<wbr>funds</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#queue" class="tsd-kind-icon">queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerRequest.html#transactions" class="tsd-kind-icon">transactions</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-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>
</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>

View File

@@ -0,0 +1,331 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerResponse.html">LedgerResponse</a>
</li>
</ul>
<h1>Interface LedgerResponse</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>Response expected from a <a href="LedgerRequest.html">LedgerRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">LedgerResponse</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="LedgerResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BinaryLedger</span><span class="tsd-signature-symbol">; </span>ledger_hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ledger_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>queue_data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">LedgerQueueData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/ledger.ts#L114">src/models/methods/ledger.ts:114</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BinaryLedger</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The complete header data of this {@link Ledger}.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique identifying hash of the entire ledger.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Ledger Index of this ledger.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> queue_<wbr>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">LedgerQueueData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, this is a validated ledger version. If omitted or set to false,
this ledger&#39;s data is not final.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> validated<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of objects describing queued transactions, in the same order as
the queue. If the request specified expand as true, members contain full
representations of the transactions, in either JSON or binary depending
on whether the request specified binary as true.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="LedgerResponse.html" class="tsd-kind-icon">Ledger<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,359 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerStream | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="LedgerStream.html">LedgerStream</a>
</li>
</ul>
<h1>Interface LedgerStream</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>ledger</code> stream only sends <code>ledgerClosed</code> messages when the consensus
process declares a new validated ledger. The message identifies the ledger
And provides some information about its contents.</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">LedgerStream</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="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr>base</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr>ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr>time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr>count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerStream.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr>ledgers</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="fee_base" class="tsd-anchor"></a>
<h3>fee_<wbr>base</h3>
<div class="tsd-signature tsd-kind-icon">fee_<wbr>base<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/615504db/src/models/methods/subscribe.ts#L95">src/models/methods/subscribe.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The reference transaction cost as of this ledger version, in drops of XRP.
If this ledger version includes a SetFee pseudo-transaction the new.
Transaction cost applies starting with the following ledger version.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fee_ref" class="tsd-anchor"></a>
<h3>fee_<wbr>ref</h3>
<div class="tsd-signature tsd-kind-icon">fee_<wbr>ref<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/615504db/src/models/methods/subscribe.ts#L97">src/models/methods/subscribe.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The reference transaction cost in &quot;fee units&quot;.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3>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/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L99">src/models/methods/subscribe.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The identifying hash of the ledger version that was closed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3>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">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L101">src/models/methods/subscribe.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger that was closed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_time" class="tsd-anchor"></a>
<h3>ledger_<wbr>time</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>time<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/615504db/src/models/methods/subscribe.ts#L103">src/models/methods/subscribe.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The time this ledger was closed, in seconds since the Ripple Epoch.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="reserve_base" class="tsd-anchor"></a>
<h3>reserve_<wbr>base</h3>
<div class="tsd-signature tsd-kind-icon">reserve_<wbr>base<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/615504db/src/models/methods/subscribe.ts#L109">src/models/methods/subscribe.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The minimum reserve, in drops of XRP, that is required for an account. If
this ledger version includes a SetFee pseudo-transaction the new base reserve
applies starting with the following ledger version.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="reserve_inc" class="tsd-anchor"></a>
<h3>reserve_<wbr>inc</h3>
<div class="tsd-signature tsd-kind-icon">reserve_<wbr>inc<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/615504db/src/models/methods/subscribe.ts#L115">src/models/methods/subscribe.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The owner reserve for each object an account owns in the ledger, in drops
of XRP. If the ledger includes a SetFee pseudo-transaction the new owner
reserve applies after this ledger.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="txn_count" class="tsd-anchor"></a>
<h3>txn_<wbr>count</h3>
<div class="tsd-signature tsd-kind-icon">txn_<wbr>count<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/615504db/src/models/methods/subscribe.ts#L117">src/models/methods/subscribe.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Number of new transactions included in this ledger version.</p>
</div>
</div>
</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;ledgerClosed&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/615504db/src/models/methods/subscribe.ts#L89">src/models/methods/subscribe.ts:89</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="validated_ledgers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> validated_<wbr>ledgers</h3>
<div class="tsd-signature tsd-kind-icon">validated_<wbr>ledgers<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/615504db/src/models/methods/subscribe.ts#L124">src/models/methods/subscribe.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Range of ledgers that the server has available. This may be a disjoint
sequence such as 24900901-24900984,24901116-24901158. This field is not
returned if the server is not connected to the network, or if it is
connected but has not yet obtained a ledger from the network.</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>
</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="LedgerStream.html" class="tsd-kind-icon">Ledger<wbr>Stream</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr>base</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr>ref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr>time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr>count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="LedgerStream.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr>ledgers</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-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>
</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>

View File

@@ -0,0 +1,250 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ManifestRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="ManifestRequest.html">ManifestRequest</a>
</li>
</ul>
<h1>Interface ManifestRequest</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>manifest</code> method reports the current &quot;manifest&quot; information for a given
validator public key. The &quot;manifest&quot; is the public portion of that
validator&#39;s configured token. Expects a response in the form of a <a href="ManifestResponse.html">ManifestResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">manifest</span><span style="color: #000000">: </span><span style="color: #267F99">ManifestRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;manifest&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;public_key&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsfkezhhda3p&quot;</span>
<span style="color: #000000">}</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">ManifestRequest</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="ManifestRequest.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="ManifestRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ManifestRequest.html#public_key" class="tsd-kind-icon">public_<wbr>key</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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;manifest&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/615504db/src/models/methods/manifest.ts#L20">src/models/methods/manifest.ts:20</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/manifest.ts#L25">src/models/methods/manifest.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The base58-encoded public key of the validator to look up. This can be the
master public key or ephemeral public key.</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>
</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="ManifestRequest.html" class="tsd-kind-icon">Manifest<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestRequest.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="ManifestRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ManifestRequest.html#public_key" class="tsd-kind-icon">public_<wbr>key</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-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>
</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>

View File

@@ -0,0 +1,328 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ManifestResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="ManifestResponse.html">ManifestResponse</a>
</li>
</ul>
<h1>Interface ManifestResponse</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>Response expected from a <a href="ManifestRequest.html">ManifestRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ManifestResponse</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="ManifestResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ManifestResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>details<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ephemeral_key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>master_key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>manifest<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>requested<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/manifest.ts#L34">src/models/methods/manifest.ts:34</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> details<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ephemeral_key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>master_key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The data contained in this manifest. Omitted if the server does not have
A manifest for the public_key from the request.</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>ephemeral_<wbr>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>master_<wbr>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> manifest<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The full manifest data in base64 format. This data is serialized to
binary before being base64-encoded. Omitted if the server does not have a
manifest for the public_key from the request.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>requested<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The public_key from the request.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="ManifestResponse.html" class="tsd-kind-icon">Manifest<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="ManifestResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,356 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NoRippleCheckRequest | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="NoRippleCheckRequest.html">NoRippleCheckRequest</a>
</li>
</ul>
<h1>Interface NoRippleCheckRequest</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>noripple_check</code> command provides a quick way to check the status of th
default ripple field for an account and the No Ripple flag of its trust
lines, compared with the recommended settings. Expects a response in the form
of an <a href="NoRippleCheckResponse.html">NoRippleCheckResponse</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-ts"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">noRipple</span><span style="color: #000000">: </span><span style="color: #267F99">NoRippleCheckRequest</span><span style="color: #000000"> = {</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;id&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #098658">0</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;command&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;noripple_check&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;account&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;role&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;gateway&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;ledger_index&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;current&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;limit&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #098658">2</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #A31515">&quot;transactions&quot;</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span>
<span style="color: #000000">}</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">NoRippleCheckRequest</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="NoRippleCheckRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckRequest.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="NoRippleCheckRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NoRippleCheckRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NoRippleCheckRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NoRippleCheckRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NoRippleCheckRequest.html#role" class="tsd-kind-icon">role</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NoRippleCheckRequest.html#transactions" class="tsd-kind-icon">transactions</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/xrplf/xrpl.js/blob/615504db/src/models/methods/norippleCheck.ts#L30">src/models/methods/norippleCheck.ts:30</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L14">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 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;noripple_check&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/615504db/src/models/methods/norippleCheck.ts#L28">src/models/methods/norippleCheck.ts:28</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/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L10">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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/norippleCheck.ts#L49">src/models/methods/norippleCheck.ts:49</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/norippleCheck.ts#L54">src/models/methods/norippleCheck.ts:54</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 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/xrplf/xrpl.js/blob/615504db/src/models/methods/norippleCheck.ts#L47">src/models/methods/norippleCheck.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The maximum number of trust line problems to include in the results.
Defaults to 300.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="role" class="tsd-anchor"></a>
<h3>role</h3>
<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;gateway&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;user&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/norippleCheck.ts#L37">src/models/methods/norippleCheck.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether the address refers to a gateway or user. Recommendations depend on
the role of the account. Issuers must have Default Ripple enabled and must
disable No Ripple on all trust lines. Users should have Default Ripple
disabled, and should enable No Ripple on all trust lines.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transactions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transactions</h3>
<div class="tsd-signature tsd-kind-icon">transactions<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/615504db/src/models/methods/norippleCheck.ts#L42">src/models/methods/norippleCheck.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If true, include an array of suggested transactions, as JSON objects,
that you can sign and submit to fix the problems. Defaults to false.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</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="NoRippleCheckRequest.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="NoRippleCheckRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckRequest.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="NoRippleCheckRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="NoRippleCheckRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="NoRippleCheckRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="NoRippleCheckRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="NoRippleCheckRequest.html#role" class="tsd-kind-icon">role</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="NoRippleCheckRequest.html#transactions" class="tsd-kind-icon">transactions</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-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>
</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>

View File

@@ -0,0 +1,318 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NoRippleCheckResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="NoRippleCheckResponse.html">NoRippleCheckResponse</a>
</li>
</ul>
<h1>Interface NoRippleCheckResponse</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>Response expected by a <a href="NoRippleCheckRequest.html">NoRippleCheckRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">NoRippleCheckResponse</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="NoRippleCheckResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="NoRippleCheckResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ledger_current_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>problems<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>transactions<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/norippleCheck.ts#L63">src/models/methods/norippleCheck.ts:63</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ledger index of the ledger used to calculate these results.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>problems<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of strings with human-readable descriptions of the problems.
This includes up to one entry if the account&#39;s Default Ripple setting is
not as recommended, plus up to limit entries for trust lines whose no
ripple setting is not as recommended.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>transactions<span class="tsd-signature-symbol">: </span><a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the request specified transactions as true, this is an array of JSON
objects, each of which is the JSON form of a transaction that should fix
one of the described problems. The length of this array is the same as
the problems array, and each entry is intended to fix the problem
described at the same index into that array.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="NoRippleCheckResponse.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="NoRippleCheckResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,456 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OfferCancel | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="OfferCancel.html">OfferCancel</a>
</li>
</ul>
<h1>Interface OfferCancel</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 OfferCancel transaction removes an Offer object from the XRP Ledger.</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">OfferCancel</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="OfferCancel.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCancel.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="OfferCancel.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCancel.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCancel.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="OfferCancel.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCancel.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCancel.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCancel.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCancel.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="OfferCancel.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="OfferCancel.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="OfferCancel.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="OfferCancel.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L140">src/models/transactions/common.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set of bit-flags for this transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="OfferSequence" class="tsd-anchor"></a>
<h3>Offer<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Offer<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCancel.ts#L18">src/models/transactions/offerCancel.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number (or Ticket number) of a previous OfferCreate
transaction. If specified, cancel any offer object in the ledger that was
created by that transaction. It is not considered an error if the offer.
specified does not exist.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;OfferCancel&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/615504db/src/models/transactions/offerCancel.ts#L11">src/models/transactions/offerCancel.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="OfferCancel.html" class="tsd-kind-icon">Offer<wbr>Cancel</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.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="OfferCancel.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.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="OfferCancel.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCancel.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCancel.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="OfferCancel.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="OfferCancel.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="OfferCancel.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="OfferCancel.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

View File

@@ -0,0 +1,508 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OfferCreate | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="OfferCreate.html">OfferCreate</a>
</li>
</ul>
<h1>Interface OfferCreate</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 OfferCreate transaction is effectively a limit order . It defines an
intent to exchange currencies, and creates an Offer object if not completely.
Fulfilled when placed. Offers can be partially fulfilled.</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">OfferCreate</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="OfferCreate.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreate.html#Expiration" class="tsd-kind-icon">Expiration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreate.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.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="OfferCreate.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreate.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.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="OfferCreate.html#SourceTag" class="tsd-kind-icon">Source<wbr>Tag</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreate.html#TakerGets" class="tsd-kind-icon">Taker<wbr>Gets</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreate.html#TakerPays" class="tsd-kind-icon">Taker<wbr>Pays</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreate.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="OfferCreate.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="OfferCreate.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Expiration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Expiration</h3>
<div class="tsd-signature tsd-kind-icon">Expiration<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/615504db/src/models/transactions/offerCreate.ts#L75">src/models/transactions/offerCreate.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Time after which the offer is no longer active, in seconds since the.
Ripple Epoch.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="OfferCreateFlagsInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreateFlagsInterface</a></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L70">src/models/transactions/offerCreate.ts:70</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="OfferSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Offer<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Offer<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L77">src/models/transactions/offerCreate.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An offer to delete first, specified in the same way as OfferCancel.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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">
<a name="TakerGets" 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">Amount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L79">src/models/transactions/offerCreate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The amount and type of currency being provided by the offer creator.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="TakerPays" 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">Amount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L81">src/models/transactions/offerCreate.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The amount and type of currency being requested by the offer creator.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;OfferCreate&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/615504db/src/models/transactions/offerCreate.ts#L69">src/models/transactions/offerCreate.ts:69</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="OfferCreate.html" class="tsd-kind-icon">Offer<wbr>Create</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreate.html#Expiration" class="tsd-kind-icon">Expiration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="OfferCreate.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.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="OfferCreate.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreate.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.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="OfferCreate.html#SourceTag" class="tsd-kind-icon">Source<wbr>Tag</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreate.html#TakerGets" class="tsd-kind-icon">Taker<wbr>Gets</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreate.html#TakerPays" class="tsd-kind-icon">Taker<wbr>Pays</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreate.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="OfferCreate.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="OfferCreate.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

View File

@@ -0,0 +1,219 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OfferCreateFlagsInterface | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="OfferCreateFlagsInterface.html">OfferCreateFlagsInterface</a>
</li>
</ul>
<h1>Interface OfferCreateFlagsInterface</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>Map of flags to boolean values representing <a href="OfferCreate.html">OfferCreate</a> transaction
flags.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">GlobalFlags</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">OfferCreateFlagsInterface</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="OfferCreateFlagsInterface.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr>Fill<wbr>OrKill</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.html#tfPassive" class="tsd-kind-icon">tf<wbr>Passive</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateFlagsInterface.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>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfFillOrKill" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Fill<wbr>OrKill</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Fill<wbr>OrKill<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/615504db/src/models/transactions/offerCreate.ts#L57">src/models/transactions/offerCreate.ts:57</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfImmediateOrCancel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Immediate<wbr>OrCancel</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel<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/615504db/src/models/transactions/offerCreate.ts#L56">src/models/transactions/offerCreate.ts:56</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfPassive" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Passive</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Passive<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/615504db/src/models/transactions/offerCreate.ts#L55">src/models/transactions/offerCreate.ts:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tfSell" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr>Sell</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Sell<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/615504db/src/models/transactions/offerCreate.ts#L58">src/models/transactions/offerCreate.ts:58</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="OfferCreateFlagsInterface.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags<wbr>Interface</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateFlagsInterface.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr>Fill<wbr>OrKill</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateFlagsInterface.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateFlagsInterface.html#tfPassive" class="tsd-kind-icon">tf<wbr>Passive</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateFlagsInterface.html#tfSell" class="tsd-kind-icon">tf<wbr>Sell</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-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>
</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>

View File

@@ -0,0 +1,320 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OrderBookStream | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="OrderBookStream.html">OrderBookStream</a>
</li>
</ul>
<h1>Interface OrderBookStream</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>When you subscribe to one or more order books with the <code>books</code> field, you
get back any transactions that affect those order books. Has the same format
as a <a href="TransactionStream.html">TransactionStream</a> but the transaction can have a <code>owner_funds</code>
field.</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">OrderBookStream</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="OrderBookStream.html#engine_result" class="tsd-kind-icon">engine_<wbr>result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result_code" class="tsd-kind-icon">engine_<wbr>result_<wbr>code</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#engine_result_message" class="tsd-kind-icon">engine_<wbr>result_<wbr>message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_current_index" class="tsd-kind-icon">ledger_<wbr>current_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#meta" class="tsd-kind-icon">meta</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#transaction" class="tsd-kind-icon">transaction</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OrderBookStream.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OrderBookStream.html#validated" class="tsd-kind-icon">validated</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="engine_result" class="tsd-anchor"></a>
<h3>engine_<wbr>result</h3>
<div class="tsd-signature tsd-kind-icon">engine_<wbr>result<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/615504db/src/models/methods/subscribe.ts#L289">src/models/methods/subscribe.ts:289</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="engine_result_code" class="tsd-anchor"></a>
<h3>engine_<wbr>result_<wbr>code</h3>
<div class="tsd-signature tsd-kind-icon">engine_<wbr>result_<wbr>code<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/615504db/src/models/methods/subscribe.ts#L290">src/models/methods/subscribe.ts:290</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="engine_result_message" class="tsd-anchor"></a>
<h3>engine_<wbr>result_<wbr>message</h3>
<div class="tsd-signature tsd-kind-icon">engine_<wbr>result_<wbr>message<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/615504db/src/models/methods/subscribe.ts#L291">src/models/methods/subscribe.ts:291</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_current_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>current_<wbr>index<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/615504db/src/models/methods/subscribe.ts#L292">src/models/methods/subscribe.ts:292</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/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L293">src/models/methods/subscribe.ts:293</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">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L294">src/models/methods/subscribe.ts:294</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="meta" class="tsd-anchor"></a>
<h3>meta</h3>
<div class="tsd-signature tsd-kind-icon">meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">default</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L295">src/models/methods/subscribe.ts:295</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="status" class="tsd-anchor"></a>
<h3>status</h3>
<div class="tsd-signature tsd-kind-icon">status<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/615504db/src/models/methods/subscribe.ts#L287">src/models/methods/subscribe.ts:287</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transaction" class="tsd-anchor"></a>
<h3>transaction</h3>
<div class="tsd-signature tsd-kind-icon">transaction<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ModifiedOfferCreateTransaction</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L296">src/models/methods/subscribe.ts:296</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;transaction&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/615504db/src/models/methods/subscribe.ts#L288">src/models/methods/subscribe.ts:288</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="validated" class="tsd-anchor"></a>
<h3>validated</h3>
<div class="tsd-signature tsd-kind-icon">validated<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/615504db/src/models/methods/subscribe.ts#L297">src/models/methods/subscribe.ts:297</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="OrderBookStream.html" class="tsd-kind-icon">Order<wbr>Book<wbr>Stream</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#engine_result" class="tsd-kind-icon">engine_<wbr>result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#engine_result_code" class="tsd-kind-icon">engine_<wbr>result_<wbr>code</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#engine_result_message" class="tsd-kind-icon">engine_<wbr>result_<wbr>message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#ledger_current_index" class="tsd-kind-icon">ledger_<wbr>current_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#meta" class="tsd-kind-icon">meta</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#transaction" class="tsd-kind-icon">transaction</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="OrderBookStream.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OrderBookStream.html#validated" class="tsd-kind-icon">validated</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-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>
</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>

View File

@@ -0,0 +1,360 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PathFindResponse | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="PathFindResponse.html">PathFindResponse</a>
</li>
</ul>
<h1>Interface PathFindResponse</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>Response expected from a <a href="../modules.html#PathFindRequest">PathFindRequest</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">PathFindResponse</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="PathFindResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PathFindResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#status-1" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#warnings" class="tsd-kind-icon">warnings</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 BaseResponse.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="forwarded" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.forwarded</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</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>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 BaseResponse.id</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="result" class="tsd-anchor"></a>
<h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>alternatives<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathOption</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>closed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>destination_account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>destination_amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span><span class="tsd-signature-symbol">; </span>full_reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>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><span class="tsd-signature-symbol">; </span>source_account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/pathFind.ts#L74">src/models/methods/pathFind.ts:74</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>alternatives<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathOption</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of objects with suggested paths to take, as described below. If
empty, then no paths were found connecting the source and destination
accounts.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> closed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value true indicates this reply is in response to a path_find close
command.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique address of the account that would receive a transaction.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Currency amount that the destination would receive in a transaction.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>full_<wbr>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If false, this is the result of an incomplete search. A later reply
may have a better path. If true, then this is the best path found. (It is
still theoretically possible that a better path could exist, but rippled
won&#39;t find it.) Until you close the pathfinding request, rippled.
Continues to send updates each time a new ledger closes.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> 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></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ID provided in the WebSocket request is included again at this
level.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5>source_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique address that would send a transaction.</p>
</div>
</div>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value true indicates this reply is in response to a <code>path_find</code>
status command.</p>
</div>
</div>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="status-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.status</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from BaseResponse.type</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warning" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warning</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="warnings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.warnings</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</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="PathFindResponse.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="PathFindResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#status-1" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#warnings" class="tsd-kind-icon">warnings</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-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>
</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>

View File

@@ -0,0 +1,328 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PathFindStream | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="PathFindStream.html">PathFindStream</a>
</li>
</ul>
<h1>Interface PathFindStream</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 path_find method searches for a path along which a transaction can
possibly be made, and periodically sends updates when the path changes over
time.</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">PathFindStream</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="PathFindStream.html#alternatives" class="tsd-kind-icon">alternatives</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_amount" class="tsd-kind-icon">destination_<wbr>amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#full_reply" class="tsd-kind-icon">full_<wbr>reply</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#send_max" class="tsd-kind-icon">send_<wbr>max</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#source_account" class="tsd-kind-icon">source_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PathFindStream.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="alternatives" class="tsd-anchor"></a>
<h3>alternatives</h3>
<div class="tsd-signature tsd-kind-icon">alternatives<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>paths_computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>source_amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L347">src/models/methods/subscribe.ts:347</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of objects with suggested paths to take. If empty, then no paths
were found connecting the source and destination accounts.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>paths_<wbr>computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>source_<wbr>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span></h5>
</li>
</ul>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L328">src/models/methods/subscribe.ts:328</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique address of the account that would receive a transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="destination_amount" class="tsd-anchor"></a>
<h3>destination_<wbr>amount</h3>
<div class="tsd-signature tsd-kind-icon">destination_<wbr>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/615504db/src/models/methods/subscribe.ts#L330">src/models/methods/subscribe.ts:330</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Currency Amount that the destination would receive in a transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="full_reply" class="tsd-anchor"></a>
<h3>full_<wbr>reply</h3>
<div class="tsd-signature tsd-kind-icon">full_<wbr>reply<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/615504db/src/models/methods/subscribe.ts#L338">src/models/methods/subscribe.ts:338</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If false, this is the result of an incomplete search. A later reply may
have a better path. If true, then this is the best path found. (It is still
theoretically possible that a better path could exist, but rippled won&#39;t
find it.) Until you close the pathfinding request, rippled continues to
send updates each time a new ledger closes.</p>
</div>
</div>
</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><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/615504db/src/models/methods/subscribe.ts#L340">src/models/methods/subscribe.ts:340</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ID provided in the WebSocket request is included again at this level.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="send_max" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> send_<wbr>max</h3>
<div class="tsd-signature tsd-kind-icon">send_<wbr>max<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/615504db/src/models/methods/subscribe.ts#L342">src/models/methods/subscribe.ts:342</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Currency Amount that would be spent in the transaction.</p>
</div>
</div>
</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/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L326">src/models/methods/subscribe.ts:326</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Unique address that would send a transaction.</p>
</div>
</div>
</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;path_find&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/615504db/src/models/methods/subscribe.ts#L324">src/models/methods/subscribe.ts:324</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="PathFindStream.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Stream</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#alternatives" class="tsd-kind-icon">alternatives</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#destination_amount" class="tsd-kind-icon">destination_<wbr>amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#full_reply" class="tsd-kind-icon">full_<wbr>reply</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#send_max" class="tsd-kind-icon">send_<wbr>max</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PathFindStream.html#source_account" class="tsd-kind-icon">source_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="PathFindStream.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-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>
</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>

View File

@@ -0,0 +1,575 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Payment | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="Payment.html">Payment</a>
</li>
</ul>
<h1>Interface Payment</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 Payment transaction represents a transfer of value from one account to
another.</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">Payment</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="Payment.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Payment.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.html#Amount" class="tsd-kind-icon">Amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.html#DeliverMin" class="tsd-kind-icon">Deliver<wbr>Min</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.html#Destination" class="tsd-kind-icon">Destination</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.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="Payment.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Payment.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.html#InvoiceID" class="tsd-kind-icon">InvoiceID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Payment.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="Payment.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.html#Paths" class="tsd-kind-icon">Paths</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Payment.html#SendMax" class="tsd-kind-icon">Send<wbr>Max</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Payment.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Payment.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Payment.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="Payment.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="Payment.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="Payment.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="Payment.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a 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">Amount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L79">src/models/transactions/payment.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The amount of currency to deliver. For non-XRP amounts, the nested field
names MUST be lower-case. If the tfPartialPayment flag is set, deliver up
to this amount instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="DeliverMin" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Deliver<wbr>Min</h3>
<div class="tsd-signature tsd-kind-icon">Deliver<wbr>Min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L111">src/models/transactions/payment.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Minimum amount of destination currency this transaction should deliver.
Only valid if this is a partial payment. For non-XRP amounts, the nested
field names are lower-case.</p>
</div>
</div>
</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">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L81">src/models/transactions/payment.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account receiving the payment.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="DestinationTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Destination<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L86">src/models/transactions/payment.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary tag that identifies the reason for the payment to the
destination, or a hosted recipient to pay.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="PaymentFlagsInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentFlagsInterface</a></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L112">src/models/transactions/payment.ts:112</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/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L91">src/models/transactions/payment.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary 256-bit hash representing a specific reason or identifier for
this payment.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 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">Path</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L96">src/models/transactions/payment.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of payment paths to be used for this transaction. Must be omitted
for XRP-to-XRP transactions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="SendMax" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Send<wbr>Max</h3>
<div class="tsd-signature tsd-kind-icon">Send<wbr>Max<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/615504db/src/models/transactions/payment.ts#L105">src/models/transactions/payment.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest amount of source currency this transaction is allowed to cost,
including transfer fees, exchange rates, and slippage . Does not include
the XRP destroyed as a cost for submitting the transaction. For non-XRP
amounts, the nested field names MUST be lower-case. Must be supplied for
cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP
Payments.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Payment&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/615504db/src/models/transactions/payment.ts#L73">src/models/transactions/payment.ts:73</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="Payment.html" class="tsd-kind-icon">Payment</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="Payment.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="Payment.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.html#Amount" class="tsd-kind-icon">Amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.html#DeliverMin" class="tsd-kind-icon">Deliver<wbr>Min</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.html#Destination" class="tsd-kind-icon">Destination</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.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="Payment.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="Payment.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.html#InvoiceID" class="tsd-kind-icon">InvoiceID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="Payment.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="Payment.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.html#Paths" class="tsd-kind-icon">Paths</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Payment.html#SendMax" class="tsd-kind-icon">Send<wbr>Max</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="Payment.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="Payment.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="Payment.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="Payment.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="Payment.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="Payment.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="Payment.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

View File

@@ -0,0 +1,535 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PaymentChannelClaim | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<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">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="PaymentChannelClaim.html">PaymentChannelClaim</a>
</li>
</ul>
<h1>Interface PaymentChannelClaim</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>Claim XRP from a payment channel, adjust the payment channel&#39;s expiration,
or both.</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">PaymentChannelClaim</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="PaymentChannelClaim.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Amount" class="tsd-kind-icon">Amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Balance" class="tsd-kind-icon">Balance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Channel" class="tsd-kind-icon">Channel</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PaymentChannelClaim.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.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="PaymentChannelClaim.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#PublicKey" class="tsd-kind-icon">Public<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Signature" class="tsd-kind-icon">Signature</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Signers" class="tsd-kind-icon">Signers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.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="PaymentChannelClaim.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="PaymentChannelClaim.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="PaymentChannelClaim.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="PaymentChannelClaim.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 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">
<p>Inherited from BaseTransaction.Account</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique address of the account that initiated the transaction.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="AccountTxnID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.AccountTxnID</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash value identifying another transaction. If provided, this transaction
is only valid if the sending account&#39;s previously-sent transaction matches
the provided hash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Amount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Amount</h3>
<div class="tsd-signature tsd-kind-icon">Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L84">src/models/transactions/paymentChannelClaim.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The amount of XRP, in drops, authorized by the Signature. This must match
the amount in the signed message. This is the cumulative amount of XRP that
can be dispensed by the channel, including XRP previously redeemed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Balance" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Balance</h3>
<div class="tsd-signature tsd-kind-icon">Balance<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/615504db/src/models/transactions/paymentChannelClaim.ts#L78">src/models/transactions/paymentChannelClaim.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Total amount of XRP, in drops, delivered by this channel after processing
this claim. Required to deliver XRP. Must be more than the total amount
delivered by the channel so far, but not greater than the Amount of the
signed claim. Must be provided except when closing the channel.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Channel" class="tsd-anchor"></a>
<h3>Channel</h3>
<div class="tsd-signature tsd-kind-icon">Channel<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/615504db/src/models/transactions/paymentChannelClaim.ts#L71">src/models/transactions/paymentChannelClaim.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique ID of the channel 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 name="Fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Fee</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
distributing this transaction to the network. Some transaction types have
different minimum requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="Flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="PaymentChannelClaimFlagsInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaimFlagsInterface</a></div>
<aside class="tsd-sources">
<p>Overrides BaseTransaction.Flags</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L69">src/models/transactions/paymentChannelClaim.ts:69</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Highest ledger index this transaction can appear in. Specifying this field
places a strict upper limit on how long the transaction can wait to be
validated or rejected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a 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-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</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/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</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 name="PublicKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Public<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L97">src/models/transactions/paymentChannelClaim.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The public key used for the signature, as hexadecimal. This must match the
PublicKey stored in the ledger for the channel. Required unless the sender
of the transaction is the source address of the channel and the Signature
field is omitted.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Sequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Sequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The sequence number of the account sending the transaction. A transaction
is only valid if the Sequence number is exactly 1 greater than the previous
transaction from the same account. The special case 0 means the transaction
is using a Ticket instead.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Signature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L90">src/models/transactions/paymentChannelClaim.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The signature of this claim, as hexadecimal. The signed message contains
the channel ID and the amount of the claim. Required unless the sender of
the transaction is the source address of the channel.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="Signers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.Signers</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</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 name="SigningPubKey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SigningPubKey</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</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 name="SourceTag" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.SourceTag</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</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 name="TicketSequence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TicketSequence</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</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 name="TransactionType" class="tsd-anchor"></a>
<h3>Transaction<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PaymentChannelClaim&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/615504db/src/models/transactions/paymentChannelClaim.ts#L68">src/models/transactions/paymentChannelClaim.ts:68</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="TxnSignature" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseTransaction.TxnSignature</p>
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</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>
</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="PaymentChannelClaim.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PaymentChannelClaim.html#Amount" class="tsd-kind-icon">Amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PaymentChannelClaim.html#Balance" class="tsd-kind-icon">Balance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PaymentChannelClaim.html#Channel" class="tsd-kind-icon">Channel</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="PaymentChannelClaim.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.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="PaymentChannelClaim.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PaymentChannelClaim.html#PublicKey" class="tsd-kind-icon">Public<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PaymentChannelClaim.html#Signature" class="tsd-kind-icon">Signature</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.html#Signers" class="tsd-kind-icon">Signers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PaymentChannelClaim.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="PaymentChannelClaim.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="PaymentChannelClaim.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="PaymentChannelClaim.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="PaymentChannelClaim.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>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-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>
</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>

Some files were not shown because too many files have changed in this diff Show More