Compare commits

...

390 Commits

Author SHA1 Message Date
Mayukha Vadari
44e860f617 fix broadcast tests 2021-10-05 15:07:32 -04:00
Mayukha Vadari
14d8753c15 get tests working on BroadcastClient 2021-10-05 15:07:31 -04:00
Mukul Jangid
90dae91fb9 test: Add Integration tests for Escrow Transactions (#1680)
* test: Add Integration tests for Escrow Transactions
2021-10-05 13:04:34 -04:00
dependabot[bot]
537401e161 build(deps-dev): bump ts-loader from 9.2.5 to 9.2.6 (#1658)
Bumps [ts-loader](https://github.com/TypeStrong/ts-loader) from 9.2.5 to 9.2.6.
- [Release notes](https://github.com/TypeStrong/ts-loader/releases)
- [Changelog](https://github.com/TypeStrong/ts-loader/blob/main/CHANGELOG.md)
- [Commits](https://github.com/TypeStrong/ts-loader/compare/v9.2.5...v9.2.6)

---
updated-dependencies:
- dependency-name: ts-loader
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-10-04 14:40:49 -04:00
Nathan Nichols
403b0c402a docs: Add @beta to npm install instructions 2021-10-04 14:11:26 -04:00
Nathan Nichols
0644e0467b docs: updates README adding @beta to npm install 2021-10-04 14:11:26 -04:00
Nathan Nichols
578f35dd35 fix: convert uint8Array to Buffer (#1679) 2021-10-04 14:11:26 -04:00
Mukul Jangid
a1dce6b1e0 test: Integration tests for Account Transactions (#1673)
* test: Integration tests for Account Transactions
2021-10-04 14:11:26 -04:00
Nathan Nichols
8df224232c fix: remove undefined from generateFaucetWallet return type (#1676)
* fix: remove undefined from generateFaucetWallet return type
2021-10-04 14:11:26 -04:00
Nathan Nichols
c3e68cc83f fix: set ledger_index to validated (#1675)
* fix: adds ledger_index: validated
2021-10-04 14:11:26 -04:00
Nathan Nichols
02fd0ce323 refactor: clean up getFaucetWallet starting balance (#1677) 2021-10-04 14:11:26 -04:00
Nathan Nichols
5b9e3dbdc4 refactor: separate out webpacking for tests (#1678) 2021-10-04 14:11:26 -04:00
Mayukha Vadari
e65d686cc7 build: update beta version to beta.2 (#1674) 2021-10-04 14:11:26 -04:00
Mukul Jangid
b77e2590b3 test: add integration tests for Server Info requests (#1650)
* add Integration tests for Server Info requests
2021-10-04 14:11:26 -04:00
Nathan Nichols
9e3654d7d6 fix: fix error handling in generateFaucetWallet (#1671)
* fix: handle error correctly in generateFaucetWallet
* test: Adds generateFaucetWallet integration + browser tests
2021-10-04 14:11:26 -04:00
Nathan Nichols
edcdd3a0fc feat: adds isValidAddress (#1672)
* feat: adds isValidAddress
2021-10-04 14:11:26 -04:00
Mayukha Vadari
f5dee87ca7 fix: make generateFaucetWallet functional (#1669) 2021-10-04 14:11:26 -04:00
Mayukha Vadari
b522e703b4 feat: add client.getLedgerIndex (#1668)
* write getLedgerIndex

* add to client

* rename file

* add tests

* remove unused import

* fix browser tests

* respond to comments, more cleanup
2021-10-04 14:11:26 -04:00
Nathan Nichols
0be819cf37 feat: Add warning for partial payment (#1641) 2021-10-04 14:11:26 -04:00
Jackson Mills
afe06451ac Add trustSet integration test and browser test (#1667) 2021-10-04 14:11:26 -04:00
Mayukha Vadari
da92bb7f1a fix: resolve browser issue with Error.captureStackTrace (#1663)
* fix webpacking error issue

* fix eslint comment
2021-10-04 14:11:26 -04:00
Nathan Nichols
0996dc13b7 fix: adds mode to webpack to stop warning (#1666) 2021-10-04 14:11:26 -04:00
Nathan Nichols
b3a72588ea Autofills AccountDelete Fee w/ reserve_inc_xrp (#1639)
* fix: fetch Owner Reserves from ledger
2021-10-04 14:11:26 -04:00
Mayukha Vadari
1747b31a02 chore: remove ripple-lib-transactionparser (#1661) 2021-10-04 14:11:26 -04:00
Mayukha Vadari
b7c4b16a8d feat: extra protection for AccountDelete transactions (#1626)
* add deletion blockers check to autofill

* add tests

* add fail_hard: true

* pass in account_objects response to error

* only fail_hard for AccountDelete

* reject promise instead of throwing error

* fix rebase issue
2021-10-04 14:11:26 -04:00
Mayukha Vadari
bfeb737ad7 fix: disallow two pending requests with the same id (#1628)
* only increment nextId if id used

* throw error if promise already pending with id

* add test

* modify existing tests

* fix bug + tests
2021-10-04 14:11:26 -04:00
Jackson Mills
cc0b5a4ac9 test: Add PayChannel Transaction Integration Tests (#1662)
* Add test for PaymentChannelCreate

* Add PaymentChannelFund test

* Add PaymentChannelClaim test
2021-10-04 14:11:26 -04:00
Jackson Mills
dcfc31a036 Add Payment Channel Tests (#1646)
* Add ChannelVerify integration and browser test
2021-10-04 14:11:26 -04:00
Jackson Mills
955e21717a Add Path and Orderbook integration tests (#1644)
Add bookOrder, depositAuthorized, and ripplePathFind, and pathFind integration and browser tests
2021-10-04 14:11:26 -04:00
Mayukha Vadari
5200682915 build: prepare repo for beta release (#1665)
* fix github links

* fix webpacking

* more cleanup

* add 2.x to SECURITY.md

* update beta version
2021-10-04 14:11:20 -04:00
Jackson Mills
297dee9b8f Add Ledger Method Integration Tests (#1640)
Add integration tests for ledger, ledgerEntry, ledgerData, ledgerClosed and ledgerCurrent, plus add them to the browser tests.
2021-10-04 14:10:14 -04:00
Mayukha Vadari
5d67f14ea3 test: integration tests for CheckCreate, CheckCancel, CheckCash (#1664)
* test checkCreate

* test CheckCancel

* test CheckCash

* add browser tests
2021-10-04 14:10:14 -04:00
Mayukha Vadari
564001515d test: add integration tests for Account requests (#1643) 2021-10-04 14:10:14 -04:00
Jackson Mills
b5b2909fed Add integration tests for Transaction methods (#1636)
Add tx, submit, and submit_multisign integration tests, along with browser tests.
2021-10-04 14:10:14 -04:00
Mayukha Vadari
2a93f85f41 test: integration tests for DepositPreauth (#1648) 2021-10-04 14:10:13 -04:00
Nathan Nichols
dd068c2710 build: adjust for updates to @xrplf/eslint-config (#1633) 2021-10-04 14:10:13 -04:00
Mukul Jangid
f2216446e5 test: write tests for sugar functions (#1631)
* test: write tests for sugar functions
2021-10-04 14:10:13 -04:00
Mayukha Vadari
98c9b9bc14 ci: run lint tests (#1603)
* turn on lint tests

* remove tsc

* fix errors in src/utils/hashes

* fix linter errors in src/utils

* fix lint issues in test/

* resolve lint issues in src/client

* resolve dependency cycle

* resolve other linting issues in src/models

* resolve rest of linting issues

* fix tests

* fix linting errors in test/integration

* fix rest of linting issues

* fix test name
2021-10-04 14:10:13 -04:00
Mayukha Vadari
57a6586898 fix: run browser tests on all integration tests (#1649)
* attempt to webpack all tests

* fix browser tests

* remove console.log
2021-10-04 14:10:13 -04:00
Nathan Nichols
c5f47cbffc rename browser library (#1637)
* rename browser library
2021-10-04 14:10:13 -04:00
Mayukha Vadari
6dba1b142c refactor: remove client.combine (#1632)
* remove combine

* remove tests

* fix tests
2021-10-04 14:10:13 -04:00
Nathan Nichols
d734d886c4 Resolves TODOs in ./src/client (#1617)
* fix: fixes TODO's in ./src/client
2021-10-04 14:10:13 -04:00
Mayukha Vadari
8e1ab6c32b test: add integration tests for OfferCreate, OfferCancel (#1634)
* test OfferCreate

* test OfferCancel
2021-10-04 14:10:13 -04:00
Mayukha Vadari
dac8c27b49 test: integration tests for Payment (#1635)
* test payment

* use new helper function elsewhere

* remove unneeded comment
2021-10-04 14:10:13 -04:00
Mayukha Vadari
6eec7b0b77 refactor: move everything out of the common folder (#1629)
* remove common/constants (all in models now)

* remove common/txFlags (all in models now)

* move ecdsa from src/common to src

* move errors from src/common to src, export at top level
2021-10-04 14:10:13 -04:00
Jackson Mills
94a8c65200 Remove old types (#1630)
* Remove transaction/types

* Delete common/types/commands

* Delete common/types
2021-10-04 14:10:13 -04:00
Jackson Mills
6fac420d9f Remove sign.ts and move functionality into Wallet (#1620)
* Move sign.ts functionality into Wallet
* Move the corresponding tests to wallet's test cases and simplify them for readability
* Delete sign.ts
2021-10-04 14:10:13 -04:00
Mayukha Vadari
05e1d4d3c5 test: SignerListSet transaction integration tests (#1621)
* add tests

* clean up helper functions

* fix account funding

* remove unneeded method

* use new wallets for each test

* automatically fund wallets

* fix TODO
2021-10-04 14:10:13 -04:00
Mayukha Vadari
e53df109b0 refactor: move address-codec methods from client to utils (#1627) 2021-10-04 14:10:13 -04:00
Mayukha Vadari
dbb134839a refactor: remove unused methods/types in src/sugar (#1625)
* remove sugar/utils

* remove sugar/pathfind-types

* clean up src/sugar/index
2021-10-04 14:10:13 -04:00
Mayukha Vadari
13c52859eb fix: renames verify... methods to validate... (#1624)
* rename verify -> validate

* fix imports

* run eslint --fix on test/
2021-10-04 14:10:13 -04:00
Mayukha Vadari
eb0445817e refactor: adds error response object (#1619)
* add error response object

* export error response properly

* type mockRippled

* fix linter

* fix ts

* fix comments
2021-10-04 14:10:13 -04:00
Mukul Jangid
10445cff01 Refactor: Lint test/client (#1602)
* lint test/client
2021-10-04 14:10:13 -04:00
Nathan Nichols
3cbdbac4f9 fix: remove the sugar/parse directory (#1622)
* fix: remove the sugar/parse directory

* feat: adds lsf flags
2021-10-04 14:10:13 -04:00
Mukul Jangid
fd78d1edcd refactor: Reimplement sugar functions and clean up (#1559)
* refactor: Reimplement sugar functions and clean up
2021-10-04 14:10:13 -04:00
Jackson Mills
603b7ae85c Add Wallet.fromSecret(...) as an alias for Wallet.fromSeed(...) (#1618)
* Add alias to fromSeed for fromSecret

* Switch syntax to direct usage
2021-10-04 14:10:12 -04:00
Mayukha Vadari
fcc8977623 test: adds integration tests for rippled utility methods (#1597)
* add utility tests

* type client better

* simplify ledgerAccept
2021-10-04 14:10:12 -04:00
Nathan Nichols
b9b32eb3d2 docs: generate documentation with typedoc (#1607)
* docs: generate documentation with typedoc
2021-10-04 14:10:12 -04:00
Jackson Mills
1037e0da88 Remove deprecated deriveAddress from Client (#1614)
* Removing deriveAddress and X from client

* Remove deriveAddress from derive.ts

* Remove linting exception for function lines
2021-10-04 14:10:12 -04:00
Jackson Mills
29c0b84ad5 Update integration test with multisign changes (#1616) 2021-10-04 14:10:12 -04:00
Jackson Mills
4f1e1d653c Change multisign to return an encoded transaction (#1615) 2021-10-04 14:10:12 -04:00
Mayukha Vadari
fe919315d4 Lints src/wallet and test/wallet (#1600)
* lint src/wallet/index

* lint generateFaucetWallet

* lint tests

* respond to comments

* change max-lines-per-function to 40

* remove * import

* fix TS issues
2021-10-04 14:10:12 -04:00
Mayukha Vadari
3f29e5781d Lint integration test files and browser test files (#1612)
* clean up utils

* more cleanup

* remove client.sign

* remove unneeded tests

* remove unneeded infra

* move helper functions to separate files

* fix linter issues

* more cleanup

* make helper functions more generally useful

* fix test account funding

* add import note to README

* lint browser tests

* run eslint --fix
2021-10-04 14:10:12 -04:00
Nathan Nichols
0dc1e08350 build: update typescript version (#1601) 2021-10-04 14:10:12 -04:00
Mukul Jangid
148cac6f3f refactor: add verify() function (#1552)
* refactor: add verify() function
2021-10-04 14:10:12 -04:00
Nathan Nichols
0d32071e0e build: bump ws version (#1606) 2021-10-04 14:10:12 -04:00
Mayukha Vadari
e7e0ece78b build: update version for beta (#1613) 2021-10-04 14:10:12 -04:00
Omar Khan
dc6baf7f39 add submit transaction methods (#1611)
Adds submit transaction methods: submitTransaction and submitSignedTransaction.
2021-10-04 14:10:12 -04:00
Nathan Nichols
851b352f32 feat: cleanup flag naming (#1609)
* feat: cleanup flag naming
2021-10-04 14:10:12 -04:00
Nathan Nichols
633032ddd8 Lint utils directory (#1563)
* Lint the utils directory

* Modify computeLedgerHash to take new Ledger format.
2021-10-04 14:10:12 -04:00
Nathan Nichols
33f83947f1 build: rename ripple-lib to xrpl.js (#1608)
* build: rename ripple-lib to xrpl.js
2021-10-04 14:10:12 -04:00
Mayukha Vadari
af7b187dc7 Removes all prepare methods (#1605)
* deprecate and alias prepareTransaction

* delete prepareTransaction and replace methods in check-cancel

* WIP update check-cash

* remove all prepares

* remove prepares from client

* fix ts issues

* remove tests

* fix tests

* additional cleanup

* fix integration tests

* remove console statement

* re-add helper function

* fix imports

* fix more issues with integration tests

Co-authored-by: Omar Khan <khancodegt@gmail.com>
2021-10-04 14:10:12 -04:00
Jackson Mills
1115f17a3e Refactoring existing hash utils and adding tests (#1557)
Write toHash utils and tests, then fix naming to match our standards of camelCase
2021-10-04 14:10:12 -04:00
Nathan Nichols
ac66c2174a build: remove linter rules already in base config (#1599) 2021-10-04 14:10:12 -04:00
Jackson Mills
eb56eb181a Signer fixes (#1604)
* Factor out reused wallet generation
* Remove extraneous types
* Clarify that multisign takes signed transactions

Co-authored-by: Mayukha Vadari <mvadari@ripple.com>
2021-10-04 14:10:12 -04:00
Jackson Mills
c401f703c7 Signer (#1573)
Create Signer class to allow for offline signing, multisigning and signing authorizeChannel requests.
2021-10-04 14:10:12 -04:00
Omar Khan
04dd65af38 implement Autofill Transaction (#1574)
Implements autofill() and setTransactionFlagsToNumber() to allow a Client to autofill fields in a Transaction.
2021-10-04 14:10:12 -04:00
Mayukha Vadari
949cc031ee Lints top-level test files (#1594)
* lint broadcastClient

* lint client

* fix most of connection

* remove unused files

* lint mockRippled

* lint mockRippledTest

* lint runClientTests

* lint setupClient

* lint setupClientWeb

* lint shamap

* lint testUtils

* resolve tsc issues

* Fix tests

* lint rest of connection

* respond to comments
2021-10-04 14:10:12 -04:00
Nathan Nichols
c8a2a6690b feat: Add typescript types to subscribe (#1576)
feat: Add typescript types to subscribe (#1576)
2021-10-04 14:10:12 -04:00
Mayukha Vadari
a996fafe79 Lints src/common (#1595)
* lint errors (and remove unused error types)

* lint fee

* lint index

* lint ecdsa

* fix tests

* remove address tests from getFee

* fix more tests

* fix tests

* respond to comments
2021-10-04 14:10:11 -04:00
Nathan Nichols
e200de3073 Adds @xrplf prettier config (#1598)
* build: new prettier config
2021-10-04 14:10:11 -04:00
Mayukha Vadari
8c5bc22317 Lints src/client (#1577)
* lint backoff

* lint wsWrapper

* remove rangeset - not used

* split out connection.ts classes

* lint requestManager

* lint connectionManager

* lint most of connection

* fix most of client

* lint broadcastClient

* resolve more linter issues

* resolve magic numbers

* clean up more linting

* resolve rest of issues

* fix tests

* fix browser tests

* fix tests after rebase

* respond to comments

* fix dependency cycles
2021-10-04 14:10:11 -04:00
Mayukha Vadari
aa6cef520c Removes jsonschemas (#1593)
* remove jsonschemas stuff

* fix ts issues

* fix tests

* remove package

* remove scripts

* replace isValidAddress
2021-10-04 14:10:11 -04:00
Mayukha Vadari
2ca164311b Lints test/models (#1578) 2021-10-04 14:10:11 -04:00
Nathan Nichols
3f365d8591 update integration testing readme (#1589)
* update integration testing `README.md`
2021-10-04 14:10:11 -04:00
Omar Khan
e0f4d99d86 Refactor generateFaucetWallet to return a Wallet (#1564)
* add Wallet.generate() and 

* return Wallet in generateFaucetWallet

* refactor Wallet tests

* rename wallet-generation.ts to generateFaucetWallet.ts

* rename and move Wallet.ts to src/wallet/index.ts and update webpack config
2021-10-04 14:10:11 -04:00
Mayukha Vadari
62538a75b1 Switches from yarn to npm (#1591)
* remove yarn.lock

* reinstall with npm

* fix package.json

* update xrplf eslint

* fix all other instances of yarn
2021-10-04 14:10:11 -04:00
Mayukha Vadari
91cc9e0461 Lints test/utils (#1575)
* rename model tests

* rename util tests

* turn off `any` complaints in linter

* other linter changes

* fix xrp <-> drops methods

* lint generateAddress

* fix rest of tests
2021-10-04 14:10:11 -04:00
Mayukha Vadari
b53bc2bc97 Lints src/models (#1572)
* resolve src/models/methods

* PaymentTransaction => Payment, remove empty returns

* fix common, method signatures

* fix checkCash

* handle complexity complaints

* fix jsdocs

* handle magic numbers

* finish models/transactions

* fix models/utils

* fix models/ledger

* fix ts issues

* fix tests

* fix modifiedoffercreatetransaction

* remove comments, fix additional TODO
2021-10-04 14:10:11 -04:00
Nathan Nichols
75f0bb4617 refactor: migrate fixtures to use typescript (#1565)
* refactor: migrate fixtures to typescript
2021-10-04 14:10:11 -04:00
Mayukha Vadari
6268b9ea26 test: removes the use of TestSuite (#1566)* switch all methods to new format* clean up rippleClient* rename files to remove ripple from name* additional cleanup 2021-10-04 14:10:11 -04:00
Omar Khan
43802f9e22 add getXAddress to Wallet (#1558)
- add getXAddress to Wallet
- refactor wallet tests
2021-10-04 14:10:11 -04:00
Mayukha Vadari
b8be6c2f1b refactor: improves mock rippled structure (#1569)
* better error handling + tests

* fix tests

* change addResponse to take a string instead of a Request

* remove unneeded change

* respond to comments

* fix tests, re-lint

* improve error message
2021-10-04 14:10:11 -04:00
Mayukha Vadari
759e075e54 refactor: use chai instead of assert-diff (#1570)
* assert-diff -> chai

* fix tests

* remove package

* fix rebase
2021-10-04 14:10:11 -04:00
Nathan Nichols
8b95ee5fab build: Initial linting setup (#1560)
* sets up linting config and runs `yarn lint --fix` once, so that all changes will show up correctly in future PRs.

* Note that there are still a lot of linter errors.
2021-10-04 14:10:10 -04:00
Mayukha Vadari
12cfed5c17 refactor: clean up Client and associated files (#1556)
* remove _PRIVATE

* make requestAll public

* un-type connection.request

* fix lodash imports

* add comments

* Rename files to camelCase
2021-10-04 14:10:10 -04:00
Mayukha Vadari
09ef8595e7 refactor: move fixtures closer to tests (part 2) (#1561)
* move echo

* move fee

* move subscribe/unsubscribe

* move ledger_current

* move ledger_data

* move submit/submit_multisigned

* remove account_tx/account_offers/gateway_balances

* move account_info

* remove ledger_entry

* remove tx

* remove account_lines

* remove ripple_path_find

* remove ledger

* remove book_offers

* move ping

* remove global_config

* move test_command

* additional mock-rippled cleanup

* add explanatory comment to mock.addResponse
2021-10-04 14:10:10 -04:00
Mayukha Vadari
f9fe5936b1 refactor: rename all test files to camelCase (#1562)
* rename files to camelCase

* fix imports

* more renames

* pull all client tests out of individual folders

* fix imports

* fix tests
2021-10-04 14:10:10 -04:00
Jackson Mills
da9feffada Remove deprecated functions from api.ts (aka client.ts) (#1534)
* Removed deprecated functions from client.ts

* Renamed files to be camelCase

* Created top-level utils folder and tied all sub-references to it

* Grouped tests for those utils into their own section

Co-authored-by: Nathan Nichols <natenichols@cox.net>
2021-10-04 14:10:09 -04:00
Mayukha Vadari
8e52854773 fix: websocket wouldn't close properly on erroring test (#1554)
* fix: websocket wouldn't close properly on erroring test

* test: add test
2021-10-04 14:10:09 -04:00
Mayukha Vadari
5120b0fc83 refactor: moves fixtures closer to tests (#1551)
* modify account_info mocks

* move account_objects

* move server_info

* remove config (no longer needed)

* switch to simple dictionary instead of handlers

* fix rebase issues

* refactor: addResponse method on mock server object (#1555)

Co-authored-by: Elliot Lee <github.public@intelliot.com>
2021-10-04 14:10:09 -04:00
Mayukha Vadari
52f1789ecd Remove ledger methods from Connection (#1543)
* remove ledger subscription from connection

* remove more client ledger stuff

* resolve TS concerns

* fix all tests except broadcast tests

* fix broadcast tests

* clean up more ledger stuff in testing

* respond to comments
2021-10-04 14:10:09 -04:00
Mayukha Vadari
0b08de5956 Removes methods that were just rippled wrappers (#1550)
* remove getAccountInfo

* remove getAccountObjects

* remove getBalanceSheet (gateway_balances)

* remove getLedger

* remove getOrders (account_orders)

* remove getPaymentChannel (ledger_entry)

* remove getTransaction(s) (tx/account_tx)

* remove getSettings (account_info)

* remove getServerInfo (server_info)

* fix integ tests

* remove submit (also deprecated)

* fix integ tests

* add TODO
2021-10-04 14:10:09 -04:00
Mayukha Vadari
59396c3f8f Edit Client constructor to take a server URI (#1544)
* edit Client

* fix TS issues + tests

* minor edits

* rename ClientBroadcast -> BroadcastClient
2021-10-04 14:10:09 -04:00
Mayukha Vadari
f49b9d4b0e Rewrite XrplClient.request and general cleanup (#1519)
* first attempt at overloading

* fix TS issues

* improve connection typing

* more cleanup

* edit all ledger files

* more renames

* fix all other request calls

* clean up serverinfo

* fixes more request calls

* remove old legacy browser stuff

* remove unused types

* remove exports from objects

* add type to method signatures

* add ledger requests

* fix most tests

* comment out formatBidsAndAsks

* fix proxy test

* comment out failing tests

* move client-related files into client

* add payment channel requests

* fix imports

* remove finished TODOs

* fix tests

* fix integ tests

* remove exported types

* better ci
2021-10-04 14:10:09 -04:00
Mukul Jangid
478e147ae0 refactor: define typescript type for SetRegularKey transaction (#1548)
* refactor: define typescript type for SetRegularKey transaction
2021-10-04 14:10:09 -04:00
Nathan Nichols
d324056203 refactor: Define PaymentChannelFund transaction model (#1535)
refactor: Define PaymentChannelFund transaction model (#1535)
2021-10-04 14:10:09 -04:00
Nathan Nichols
db8f7c1bcb refactor: Define EscrowCreate transaction model (#1530)
refactor: Define EscrowCreate transaction model (#1530)
2021-10-04 14:10:09 -04:00
Nathan Nichols
4469d1cbf8 refactor: Define PaymentChannelClaim transaction model (#1536)
refactor: Define PaymentChannelClaim transaction model (#1536)
2021-10-04 14:10:08 -04:00
Nathan Nichols
05365a8690 refactor: Define PaymentChannelCreate transaction (#1533)
refactor: Define PaymentChannelCreate transaction model (#1533)
2021-10-04 14:10:08 -04:00
Omar Khan
f6b9878334 refactor: define TicketCreate transaction model (#1547)
- Defines a TypeScript type for TicketCreate
- Provides an optional function to users for verifying a TicketCreate instance at runtime: verifyTicketCreate()
- Adds tests for verifyTicketCreate()
2021-10-04 14:10:08 -04:00
Nathan Nichols
f68eb37565 refactor: Define EscrowFinish transaction model (#1531)
refactor: Define EscrowFinish transaction model (#1531)
2021-10-04 14:10:08 -04:00
Nathan Nichols
f95ffee0b0 refactor: define models for EscrowCancel (#1511)
refactor: define models for EscrowCancel (#1511)
2021-10-04 14:10:08 -04:00
Omar Khan
d5d996a92e refactor: define TrustSet transaction model (#1549)
- Defines a TypeScript type for TrustSet
- Provides an optional function to users for verifying a TrustSet instance at runtime: verifyTrustSet()
- Adds tests for verifyTrustSet()
2021-10-04 14:10:08 -04:00
Omar Khan
2ff0dde91d refactor: define DepositPreauth transaction model (#1545)
- Defines a TypeScript type for DepositPreauth
- Provides an optional function to users for verifying a DepositPreauth instance at runtime: verifyDepositPreauth()
- Adds tests for verifyDepositPreauth()
2021-10-04 14:10:08 -04:00
Omar Khan
bec487cf71 refactor: Define PaymentTransaction model (#1542)
- Defines a TypeScript type for PaymentTransaction
- Provides an optional function to users for verifying a PaymentTransaction instance at runtime: verifyPaymentTransaction()
- Adds tests for verifyPaymentTransaction()
- Adds isFlagEnabled() util to be used for models
2021-10-04 14:10:08 -04:00
Mukul Jangid
c1edab547a refactor: define typescript type for AccountDelete transaction (#1537)
* refactor: define typescript type for AccountDelete transaction
2021-10-04 14:10:08 -04:00
Mukul Jangid
fef5f858fd fix: resolve OfferCancel merge issues (#1546)
* fix: resolve OfferCancel git issues
2021-10-04 14:10:08 -04:00
Mukul Jangid
72f34d9388 refactor: define typescript type for AccountSet transaction (#1515)
* define typescript type for AccountSet transaction
2021-10-04 14:10:08 -04:00
Mukul Jangid
930d214107 refactor: define typescript types for OfferCancel Transaction Model (#1512)
* define typescript types for OfferCancel Transaction Model
2021-10-04 14:10:08 -04:00
Mukul Jangid
57c4d8be39 refactor: define SignerListSet model and tests (#1538)
* define typescript type for SignerListSet transaction
2021-10-04 14:10:08 -04:00
Mayukha Vadari
73109295b4 Rename RippleAPI client to Client (#1520)
* rename RippleAPI -> XrplClient

* more renames

* move API stuff to client folder

* rename all api -> client

* fix tests

* make tests run

* fix integ tests

* fix urls

* fix merge issues

* XrplClient -> Client

* fix merge issues

* rename xrpl-client npm symlink to xrpl-local
2021-10-04 14:10:08 -04:00
Mukul Jangid
6d08b9e12c refactor: define typescript types for CheckCash Transaction Model (#1522)
* Define Typescript types for CheckCash Transaction Model
2021-10-04 14:10:08 -04:00
Mukul Jangid
293f09d409 refactor: define typescript types for CheckCancel Transaction Model (#1526)
* offer

* accountroot

* amendments

* check

* deposit preauth

* directory node

* escrow

* fee settings

* ledger hashes

* negative unl

* pay channel

* ripple state

* signer list

* ticket

* export

* account_channels

* account_currencies

* account_info

* account_lines

* account_objects

* account_offers

* account_tx

* gateway_balances

* no ripple check

* respond to comments

* rename files to camelCase

* account_channels

* account_currencies

* account_info

* account_lines

* account_objects

* account_offers

* account_tx

* gateway_balances

* no ripple check

* respond to comments

* export methods

* fix typos

* refactor: Define type for CommonFields

* refactor: Define OfferCreate transaction type

* add a commented out SignedTransaction

* add tests for verifyCommonFields

* remove outdated files

* refactor: Define OfferCreate transaction

* define checkCancel model

* add tests

* fix: add tests and resolve conflicts

* fix: resolve typos and seperate out test

* fix: commenting issue

* refactor: add checkCreate to tx/index

Co-authored-by: Mayukha Vadari <mvadari@ripple.com>
Co-authored-by: Nathan Nichols <natenichols@cox.net>
2021-10-04 14:10:08 -04:00
Mukul Jangid
f9bce29174 refactor: define typescript types for CheckCreate Transaction Model (#1524)
* feat: define checkCreate model

* test: add tests
2021-10-04 14:10:08 -04:00
Nathan Nichols
7fde5a2658 refactor: Define typescript definition for OfferCreate (#1508)
* refactor: Define OfferCreate transaction type
2021-10-04 14:10:08 -04:00
Nathan Nichols
d438430100 refactor: Add common transaction fields Typescript definition (#1507)
refactor: Add common transaction fields Typescript definition (#1507)
2021-10-04 14:10:08 -04:00
Omar Khan
c431e70900 define Wallet class (#1509)
* define Wallet class
- Wallet class is a utility for deriving a wallet composed of a keypair (publicKey/privateKey).
- A wallet can be derived from either a seed, mnemnoic, or entropy (array of random numbers).
- It provides functionality to sign/verify transactions offline.
2021-10-04 14:10:08 -04:00
Omar Khan
51b4ff7a2c define TypeScript types for Payment Channel methods (#1518)
add TypeScript type for payment channel methods
2021-10-04 14:10:08 -04:00
Jackson Mills
ec54841617 Added Ledger Method Interfaces (#1502)
Added request and response method interfaces for the api.
2021-10-04 14:10:08 -04:00
Mayukha Vadari
2166d8349e Implements TypeScript types for transaction method requests/responses (#1517)
* submit

* submit_multisigned

* transaction_entry

* tx

* export

* move searched_all to TxResponse
2021-10-04 14:10:08 -04:00
Mayukha Vadari
1ecd6a7e2a Implements TypeScript types for server info method requests/responses (#1514)
* fee

* manifest

* server_info

* server_state

* export

* fix amendment_blocked type

* fix typo
2021-10-04 14:10:07 -04:00
Mayukha Vadari
a0907472c9 Implements TypeScript types for utility method requests/responses (#1516)
* ping

* random

* export
2021-10-04 14:10:07 -04:00
Mayukha Vadari
57112c086c Implements TypeScript types for subscribe requests/responses/streams (#1510)
* subscribe

* streams

* unsubscribe

* exports

* fix merge issues

* respond to comments
2021-10-04 14:10:07 -04:00
Jackson Mills
b7f39e7225 Removed legacy exit code conversion (#1504) 2021-10-04 14:10:07 -04:00
Mayukha Vadari
f16876014c Implements TypeScript types for path and order book methods (#1503)
* book offers

* deposit authorized

* path_find

* ripple_path_find

* export

* fix typos

* fix issues

* respond to comments

* make `pathFind` id optional

* make source_currencies optional
2021-10-04 14:10:07 -04:00
Mayukha Vadari
68ac32fc06 Defines TypeScript types for rippled account method requests & responses (#1498)
* account_channels

* account_currencies

* account_info

* account_lines

* account_objects

* account_offers

* account_tx

* gateway_balances

* no ripple check

* respond to comments

* export methods

* fix typos

* respond to comments

* edit BaseResponse to be more specific
2021-10-04 14:10:07 -04:00
Mayukha Vadari
0886af33fd Defines TypeScript types for all ledger objects (#1499)
* offer

* accountroot

* amendments

* check

* deposit preauth

* directory node

* escrow

* fee settings

* ledger hashes

* negative unl

* pay channel

* ripple state

* signer list

* ticket

* export

* respond to comments

* rename files to camelCase
2021-10-04 14:10:07 -04:00
Elliot Lee
6e4868e6c7 Update repository.url (#1670) 2021-09-27 07:04:26 -07:00
Bharath Chari
718b0ac5a5 Update LICENSE (#1660) 2021-09-23 14:41:47 +03:00
Nathan Nichols
8a815e17ca Correctly export txFlags and accountSetFlags (#1571)
* fix: export txFlags and accountSetFlags
2021-09-09 08:52:07 -07:00
dependabot[bot]
25d5d408d8 build(deps-dev): bump ts-node from 10.1.0 to 10.2.1 (#1590)
Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 10.1.0 to 10.2.1.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Commits](https://github.com/TypeStrong/ts-node/compare/v10.1.0...v10.2.1)

---
updated-dependencies:
- dependency-name: ts-node
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 15:03:28 -05:00
dependabot[bot]
0845ff786b build(deps-dev): bump ts-loader from 8.3.0 to 9.2.5 (#1585)
Bumps [ts-loader](https://github.com/TypeStrong/ts-loader) from 8.3.0 to 9.2.5.
- [Release notes](https://github.com/TypeStrong/ts-loader/releases)
- [Changelog](https://github.com/TypeStrong/ts-loader/blob/main/CHANGELOG.md)
- [Commits](https://github.com/TypeStrong/ts-loader/compare/v8.3.0...v9.2.5)

---
updated-dependencies:
- dependency-name: ts-loader
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 12:35:52 -07:00
dependabot[bot]
ecdeaf700e build(deps-dev): bump webpack from 5.48.0 to 5.51.1 (#1584)
Bumps [webpack](https://github.com/webpack/webpack) from 5.48.0 to 5.51.1.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.48.0...v5.51.1)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 14:12:37 -05:00
dependabot[bot]
4413f78d22 build(deps-dev): bump stream-http from 3.1.1 to 3.2.0 (#1587)
Bumps [stream-http](https://github.com/jhiesey/stream-http) from 3.1.1 to 3.2.0.
- [Release notes](https://github.com/jhiesey/stream-http/releases)
- [Commits](https://github.com/jhiesey/stream-http/compare/v3.1.1...v3.2.0)

---
updated-dependencies:
- dependency-name: stream-http
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 14:07:53 -05:00
dependabot[bot]
d3c6d775af build(deps-dev): bump @types/node from 16.4.10 to 16.7.10 (#1586)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 16.4.10 to 16.7.10.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 14:07:39 -05:00
dependabot[bot]
49092d5dc1 build(deps-dev): bump webpack-cli from 4.7.2 to 4.8.0 (#1583)
Bumps [webpack-cli](https://github.com/webpack/webpack-cli) from 4.7.2 to 4.8.0.
- [Release notes](https://github.com/webpack/webpack-cli/releases)
- [Changelog](https://github.com/webpack/webpack-cli/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack-cli/compare/webpack-cli@4.7.2...webpack-cli@4.8.0)

---
updated-dependencies:
- dependency-name: webpack-cli
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 13:33:44 -05:00
dependabot[bot]
3e79959e11 build(deps-dev): bump mocha from 9.0.3 to 9.1.1 (#1582)
Bumps [mocha](https://github.com/mochajs/mocha) from 9.0.3 to 9.1.1.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v9.0.3...v9.1.1)

---
updated-dependencies:
- dependency-name: mocha
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 13:33:00 -05:00
dependabot[bot]
7c528f7ac0 build(deps): bump @types/lodash from 4.14.171 to 4.14.172 (#1581)
Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.14.171 to 4.14.172.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

---
updated-dependencies:
- dependency-name: "@types/lodash"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 13:32:46 -05:00
dependabot[bot]
e5a2096c57 build(deps-dev): bump puppeteer from 5.4.1 to 10.2.0 (#1579)
Bumps [puppeteer](https://github.com/puppeteer/puppeteer) from 5.4.1 to 10.2.0.
- [Release notes](https://github.com/puppeteer/puppeteer/releases)
- [Changelog](https://github.com/puppeteer/puppeteer/blob/main/CHANGELOG.md)
- [Commits](https://github.com/puppeteer/puppeteer/compare/v5.4.1...v10.2.0)

---
updated-dependencies:
- dependency-name: puppeteer
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-01 13:32:26 -05:00
Nathan Nichols
418f80bf6d chore: update HISTORY.md and package version (#1527)
* chore: update HISTORY.md and package version
2021-08-17 14:32:29 -05:00
Nathan Nichols
ec121ee62d docs: Add documentation for generateFaucetWallet() (#1529)
* docs: Add documentation for generateFaucetWallet()
2021-08-17 14:32:06 -05:00
Nathan Nichols
decc395e5b docs: export and document asf Flags (#1525)
* docs: export and document asf Flags
2021-08-12 11:30:26 -07:00
Jackson Mills
8b79fe6ba1 Update sign docs with more info about keypairs (#1523)
* Add links to how to derive keypairs and examples of keypairs to the 'sign' docs
2021-08-11 13:01:53 -07:00
Nathan Nichols
5f0c38531c build: include lodash in webpack build (#1500)
* build: include lodash in webpack build
2021-08-10 07:43:52 -07:00
Florent
69113de552 Generate faucet wallet Testnet and Devnet (#1497)
* generate faucet wallet

* updated comments

* added example in documentation

* updated documentation

* Added xprl.org link in docs

* updated code snippet

* Made changes from comments

* new changes from comments

* yarn.lock

* removed axios and use https.request

* updated webpack to include http and https fallback

* fixed files formatting

* small fixes

* Fix typo for Testnet

Co-authored-by: Elliot Lee <github.public@intelliot.com>

Co-authored-by: Elliot Lee <github.public@intelliot.com>
2021-08-10 15:20:43 +08:00
Mayukha Vadari
b81c1dab35 fix: ledger version in getTrustlines (#1505)
* fix: correctly propagate options.ledgerVersion 

* test: verify that `account_lines` uses correct `ledger_index`
2021-08-06 12:18:53 -05:00
dependabot[bot]
20ed4640a7 build(deps-dev): bump @types/mocha from 8.2.3 to 9.0.0 (#1491)
Bumps [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/mocha) from 8.2.3 to 9.0.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/mocha)

---
updated-dependencies:
- dependency-name: "@types/mocha"
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-08-04 13:07:27 -07:00
Jackson Mills
42464b84de refactor combine logic for clarity (#1486)
refactor combine logic for clarity by using functional styles and breaking down the logic into digestible pieces
2021-08-04 12:52:55 -07:00
Nathan Nichols
76780c8a8e Run Integration Tests in Browser (#1468)
* ci: Adds github actions testing for webpacked integration test
2021-08-02 16:29:35 -05:00
Elliot Lee
25a2bcd3be release: 1.9.8 (#1489) 2021-07-30 12:04:02 -07:00
Nathan Nichols
d9a42c8669 Allow XAddress Issuers (#1471)
* feat: Allow clients to use XAddresses for issuers
2021-07-30 13:16:01 -05:00
Mayukha Vadari
6e0fff2ad6 Reduce dependencies on lodash (#1467)
* assign -> Object.assign

* replace isundefined

* remove forEach

* remove some

* remove reduce

* remove keys

* remove map

* remove includes

* remove filter

* remove last

* remove isstring

* remove every

* remove rearg

* remove indexOf

* remove values

* remove startswith

* remove first and pick

* build smaller lodash

* remove lodash.isequal package

* add lodash-cli dev dependency

* add lodash script

* test fix

* Revert "build smaller lodash" This reverts commit 979446e57f60b29cb5d377b54efe91cfbeae0707.

* upgrade npm

* change ===/!== undefined to ==/!= null
2021-07-29 20:18:08 -04:00
Rome Reginelli
4e49b6a99c docs: edit style and update old URLs (#1420)
Use example.com instead of ripple.com

Co-authored-by: Elliot Lee <github.public@intelliot.com>
2021-07-27 16:15:56 -07:00
Nathan Nichols
10efd5eedb chore: update ripple-binary-codec to 1.1.3 (#1482) 2021-07-27 16:54:41 -05:00
Omar Khan
de293de1e6 export offline methods to top-level of package (#1479)
* export offline methods to top-level of package
- All methods that don’t require a network connection are exported at the top-level of the package.
- These instance methods are now marked as deprecated.
- Removed an empty ts file
2021-07-27 17:41:50 -04:00
dependabot[bot]
5df32e2e6e build(deps-dev): bump ts-node from 9.1.1 to 10.1.0 (#1470)
Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 9.1.1 to 10.1.0.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Commits](https://github.com/TypeStrong/ts-node/compare/v9.1.1...v10.1.0)

---
updated-dependencies:
- dependency-name: ts-node
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-27 15:14:59 -04:00
dependabot[bot]
31e012bde5 build(deps-dev): bump @types/node from 15.12.5 to 16.4.3 (#1480)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 15.12.5 to 16.4.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-27 15:14:43 -04:00
nutbreaker
1e66f40348 Fix ripple/ripple-lib#1472: test:watch missing configuration (#1473)
Co-authored-by: Nathan Nichols <natenichols@cox.net>
2021-07-27 15:09:56 -04:00
Nathan Nichols
9adfd404e5 GitHub Actions Integration Tests (#1466)
* ci: Add Github Actions integration testing against standalone rippled
2021-07-27 12:47:55 -05:00
Aaron Huang
d941653477 fix: multisig example in documentation (#1463)
Co-authored-by: Elliot Lee <github.public@intelliot.com>
2021-07-27 10:33:27 -07:00
Mayukha Vadari
cdf9e33ad2 Fixes miscommunication with ripplingDisabled in trustlines (#1481) 2021-07-27 13:23:13 -04:00
Elliot Lee
b7de3b0ea9 feat: minor improvement to docs (#1251) 2021-07-26 16:12:15 -07:00
Elliot Lee
aa081a4348 refactor!: remove deprecated ledger fields (#1160)
Per https://github.com/ripple/rippled/issues/3214

The following fields are deprecated and may be removed without further notice: accepted, hash (use ledger_hash instead), seqNum (use ledger_index instead), totalCoins (use total_coins instead).
2021-07-26 16:10:55 -07:00
Nathan Nichols
e3752c9057 Adds Github Actions Testing (#1464)
* ci: Adds github actions testing
2021-07-26 16:49:39 -05:00
Elliot Lee
be1267fb14 fix: lint errors (#1478) 2021-07-26 16:22:05 -05:00
Elliot Lee
dd30e33e8e fix: add void return type to Promises (#1477)
Follow-up to #1476
2021-07-26 14:04:46 -05:00
Elliot Lee
a973266434 fix #1474: add type argument to Promise (#1476) 2021-07-26 11:30:03 -07:00
Jackson Mills
0ac1061d26 Added test for lowercase memo hex (#1475)
Added test for lowercase hex in transaction memo
* Relaxed existing test to accept case change in memo after decoding
* Added check of resulting signature
2021-07-26 10:41:21 -07:00
dependabot[bot]
6938773a22 build(deps): bump ws from 7.5.2 to 7.5.3 (#1461)
Bumps [ws](https://github.com/websockets/ws) from 7.5.2 to 7.5.3.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.5.2...7.5.3)

---
updated-dependencies:
- dependency-name: ws
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-22 15:52:25 -04:00
dependabot[bot]
81668a8282 build(deps-dev): bump typescript from 3.9.9 to 4.3.5 (#1437)
Bumps [typescript](https://github.com/Microsoft/TypeScript) from 3.9.9 to 4.3.5.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](https://github.com/Microsoft/TypeScript/compare/v3.9.9...v4.3.5)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-22 15:51:34 -04:00
Mayukha Vadari
22a77653af Add PR template (#1469) 2021-07-22 15:45:13 -04:00
Elliot Lee
6e1e2081c9 release: 1.9.7 2021-07-14 17:15:47 -07:00
dependabot[bot]
97cc99a1c0 build(deps): bump ws from 7.4.6 to 7.5.2 (#1450)
Bumps [ws](https://github.com/websockets/ws) from 7.4.6 to 7.5.2.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.4.6...7.5.2)

---
updated-dependencies:
- dependency-name: ws
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-14 17:07:48 -07:00
dependabot[bot]
fee832be3a build(deps): bump @types/ws from 7.4.4 to 7.4.6 (#1452)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.4.4 to 7.4.6.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

---
updated-dependencies:
- dependency-name: "@types/ws"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-14 17:07:20 -07:00
dependabot[bot]
e35aca7a40 build(deps-dev): bump mocha from 8.4.0 to 9.0.2 (#1456)
Bumps [mocha](https://github.com/mochajs/mocha) from 8.4.0 to 9.0.2.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v8.4.0...v9.0.2)

---
updated-dependencies:
- dependency-name: mocha
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-14 17:06:05 -07:00
Rome Reginelli
53f35b5a99 Update boilerplate (#1459)
- Suggest XRPLF's public cluster; this is a better starter experience since
  it's full-history and blocks known scam accounts
- Update the Node.js compatibility language to match the README.
- Remove dated language about ES5/ES6 Promises.
- Re-gen docs (this seems to have added a memo field that was previously
  modified in some other PR)
2021-07-14 17:05:54 -07:00
Matthew Rosendin
44d91d8d96 fix: TrustlineTransaction type (#1458) (#1460) 2021-07-14 08:59:09 -07:00
dependabot[bot]
14d47f62e8 build(deps-dev): bump doctoc from 2.0.0 to 2.0.1 (#1440)
Bumps [doctoc](https://github.com/thlorenz/doctoc) from 2.0.0 to 2.0.1.
- [Release notes](https://github.com/thlorenz/doctoc/releases)
- [Commits](https://github.com/thlorenz/doctoc/compare/v2.0.0...v2.0.1)

---
updated-dependencies:
- dependency-name: doctoc
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:34:16 -07:00
dependabot[bot]
be04427145 build(deps-dev): bump @types/mocha from 8.2.2 to 8.2.3 (#1455)
Bumps [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/mocha) from 8.2.2 to 8.2.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/mocha)

---
updated-dependencies:
- dependency-name: "@types/mocha"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:34:03 -07:00
dependabot[bot]
d0229d2c9d build(deps): bump @types/lodash from 4.14.170 to 4.14.171 (#1454)
Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.14.170 to 4.14.171.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

---
updated-dependencies:
- dependency-name: "@types/lodash"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:33:38 -07:00
dependabot[bot]
250d0763d7 build(deps-dev): bump webpack-cli from 4.7.0 to 4.7.2 (#1453)
Bumps [webpack-cli](https://github.com/webpack/webpack-cli) from 4.7.0 to 4.7.2.
- [Release notes](https://github.com/webpack/webpack-cli/releases)
- [Changelog](https://github.com/webpack/webpack-cli/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack-cli/compare/webpack-cli@4.7.0...webpack-cli@4.7.2)

---
updated-dependencies:
- dependency-name: webpack-cli
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:33:26 -07:00
dependabot[bot]
3db42279e1 build(deps): bump ws from 7.4.6 to 7.5.1 (#1442)
Bumps [ws](https://github.com/websockets/ws) from 7.4.6 to 7.5.1.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.4.6...7.5.1)

---
updated-dependencies:
- dependency-name: ws
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:29:33 -07:00
dependabot[bot]
ba7c589545 build(deps): bump @types/ws from 7.4.4 to 7.4.5 (#1443)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.4.4 to 7.4.5.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

---
updated-dependencies:
- dependency-name: "@types/ws"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:29:23 -07:00
dependabot[bot]
eaf8593960 build(deps): bump ripple-binary-codec from 1.1.2 to 1.1.3 (#1444)
Bumps [ripple-binary-codec](https://github.com/ripple/ripple-binary-codec) from 1.1.2 to 1.1.3.
- [Release notes](https://github.com/ripple/ripple-binary-codec/releases)
- [Changelog](https://github.com/ripple/ripple-binary-codec/blob/master/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-binary-codec/compare/1.1.2...1.1.3)

---
updated-dependencies:
- dependency-name: ripple-binary-codec
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:29:14 -07:00
dependabot[bot]
ee30927304 build(deps-dev): bump prettier from 2.3.0 to 2.3.2 (#1445)
Bumps [prettier](https://github.com/prettier/prettier) from 2.3.0 to 2.3.2.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.3.0...2.3.2)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:29:02 -07:00
dependabot[bot]
b58ef11e57 build(deps-dev): bump webpack from 5.38.1 to 5.41.1 (#1446)
Bumps [webpack](https://github.com/webpack/webpack) from 5.38.1 to 5.41.1.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.38.1...v5.41.1)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:28:51 -07:00
dependabot[bot]
c726a5eab8 build(deps-dev): bump @types/node from 15.6.1 to 15.12.5 (#1447)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 15.6.1 to 15.12.5.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-07-07 20:28:40 -07:00
Elliot Lee
1e86ba0aa0 release: 1.9.6 (#1436) 2021-06-30 23:34:18 -07:00
Elliot Lee
cabd4cc88d fix: allow multiple settings at once (#1435) 2021-06-30 23:27:04 -07:00
Elliot Lee
28d2fc2a3a fix #999: use 'current' ledger when preparing txs (#1429) 2021-06-07 15:34:02 -07:00
dependabot[bot]
42db44fb59 build(deps-dev): bump mocha from 7.2.0 to 8.4.0 (#1414)
Bumps [mocha](https://github.com/mochajs/mocha) from 7.2.0 to 8.4.0.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v7.2.0...v8.4.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-07 12:54:00 -07:00
dependabot[bot]
ad0165cf22 build(deps-dev): bump prettier from 2.2.1 to 2.3.0 (#1430)
Bumps [prettier](https://github.com/prettier/prettier) from 2.2.1 to 2.3.0.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.2.1...2.3.0)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-07 12:42:15 -07:00
dependabot[bot]
708d8c0bb5 build(deps): bump ripple-address-codec from 4.1.2 to 4.1.3 (#1432)
Bumps [ripple-address-codec](https://github.com/ripple/ripple-address-codec) from 4.1.2 to 4.1.3.
- [Release notes](https://github.com/ripple/ripple-address-codec/releases)
- [Changelog](https://github.com/ripple/ripple-address-codec/blob/master/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-address-codec/compare/4.1.2...4.1.3)

---
updated-dependencies:
- dependency-name: ripple-address-codec
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-07 12:42:02 -07:00
Elliot Lee
5074441b3b release: 1.9.5 2021-06-01 16:25:38 -07:00
Antonio Campos
a1edc0b2d5 fix #1113: return promise inside catch block of reconnect to propagate promise (#1418) 2021-06-01 15:58:52 -07:00
dependabot[bot]
3afdc1fca0 build(deps): bump @types/lodash from 4.14.168 to 4.14.170 (#1427)
Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.14.168 to 4.14.170.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:58:25 -07:00
dependabot[bot]
6b7cdfc413 build(deps-dev): bump @types/node from 15.0.1 to 15.6.1 (#1426)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 15.0.1 to 15.6.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:58:12 -07:00
dependabot[bot]
95e1314eb9 build(deps-dev): bump webpack from 5.36.2 to 5.38.1 (#1425)
Bumps [webpack](https://github.com/webpack/webpack) from 5.36.2 to 5.38.1.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.36.2...v5.38.1)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:58:01 -07:00
dependabot[bot]
ad0cc209af build(deps-dev): bump webpack-cli from 4.6.0 to 4.7.0 (#1424)
Bumps [webpack-cli](https://github.com/webpack/webpack-cli) from 4.6.0 to 4.7.0.
- [Release notes](https://github.com/webpack/webpack-cli/releases)
- [Changelog](https://github.com/webpack/webpack-cli/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack-cli/compare/webpack-cli@4.6.0...webpack-cli@4.7.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:57:46 -07:00
dependabot[bot]
dd11ce480d build(deps-dev): bump webpack-bundle-analyzer from 4.4.1 to 4.4.2 (#1423)
Bumps [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) from 4.4.1 to 4.4.2.
- [Release notes](https://github.com/webpack-contrib/webpack-bundle-analyzer/releases)
- [Changelog](https://github.com/webpack-contrib/webpack-bundle-analyzer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack-contrib/webpack-bundle-analyzer/compare/v4.4.1...v4.4.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:57:33 -07:00
dependabot[bot]
10ace18d27 build(deps): bump @types/ws from 7.4.2 to 7.4.4 (#1422)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.4.2 to 7.4.4.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:57:20 -07:00
dependabot[bot]
e8ca25f792 build(deps): bump ws from 7.4.5 to 7.4.6 (#1421)
Bumps [ws](https://github.com/websockets/ws) from 7.4.5 to 7.4.6.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.4.5...7.4.6)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:57:04 -07:00
dependabot[bot]
95d626f69e build(deps): bump browserslist from 4.16.3 to 4.16.6 (#1419)
Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.16.3 to 4.16.6.
- [Release notes](https://github.com/browserslist/browserslist/releases)
- [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md)
- [Commits](https://github.com/browserslist/browserslist/compare/4.16.3...4.16.6)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-01 15:56:44 -07:00
Antonio Campos
3fdc56ab90 fix #1210: update mocha to use RC file config (#1417) 2021-06-01 15:56:07 -07:00
dependabot-preview[bot]
bb44598e32 build(deps-dev): bump assert-diff from 3.0.1 to 3.0.2 (#1371)
Bumps [assert-diff](https://github.com/pihvi/assert-diff) from 3.0.1 to 3.0.2.
- [Release notes](https://github.com/pihvi/assert-diff/releases)
- [Commits](https://github.com/pihvi/assert-diff/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-06-01 08:23:39 -07:00
Lathan
3c86b04fee docs: add ODL monitors (#1408)
* new additions ODL monitors

utility scan and xrpl-rosetta https://github.com/mouradski/xrapid_alert and https://github.com/lathanbritz/xrpl-rosetta

* Update APPLICATIONS.md

Co-authored-by: Elliot Lee <github.public@intelliot.com>
2021-05-11 18:06:13 -07:00
dependabot[bot]
7ee87f2625 build(deps): bump ws from 7.4.4 to 7.4.5 (#1409)
Bumps [ws](https://github.com/websockets/ws) from 7.4.4 to 7.4.5.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.4.4...7.4.5)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-11 18:05:44 -07:00
dependabot[bot]
2f03347dda build(deps-dev): bump webpack-bundle-analyzer from 4.4.0 to 4.4.1 (#1410)
Bumps [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) from 4.4.0 to 4.4.1.
- [Release notes](https://github.com/webpack-contrib/webpack-bundle-analyzer/releases)
- [Changelog](https://github.com/webpack-contrib/webpack-bundle-analyzer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack-contrib/webpack-bundle-analyzer/compare/v4.4.0...v4.4.1)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-11 18:05:33 -07:00
dependabot[bot]
bbb19dce9f build(deps): bump @types/ws from 7.4.0 to 7.4.2 (#1411)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.4.0 to 7.4.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-11 18:05:24 -07:00
Elliot Lee
c8b0035897 fix: prevent getFee from returning NaN from Reporting Mode (#1401)
When using a rippled server in Reporting Mode, the server_info response does not have a load_factor property.

https://xrpl.org/rippled-server-modes.html#reporting-mode

https://github.com/ripple/rippled/issues/3812

Now, when load_factor is missing, we default to a load_factor of 1.

Fix #1398
2021-05-10 13:56:31 -07:00
dependabot[bot]
67d1b5278d build(deps-dev): bump webpack from 5.25.1 to 5.36.2 (#1412)
Bumps [webpack](https://github.com/webpack/webpack) from 5.25.1 to 5.36.2.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.25.1...v5.36.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-10 13:54:23 -07:00
dependabot[bot]
43e444b47d build(deps-dev): bump @types/node from 14.14.34 to 15.0.1 (#1413)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 14.14.34 to 15.0.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-10 13:54:12 -07:00
Elliot Lee
f3fd468566 release: 1.9.4 2021-04-18 17:09:21 -07:00
dependabot[bot]
97d4f1f2ce build(deps-dev): bump webpack-cli from 4.5.0 to 4.6.0 (#1391)
Bumps [webpack-cli](https://github.com/webpack/webpack-cli) from 4.5.0 to 4.6.0.
- [Release notes](https://github.com/webpack/webpack-cli/releases)
- [Changelog](https://github.com/webpack/webpack-cli/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack-cli/compare/webpack-cli@4.5.0...webpack-cli@4.6.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-18 17:04:53 -07:00
dependabot[bot]
fbecaf2ddc build(deps-dev): bump @types/mocha from 8.2.1 to 8.2.2 (#1396)
Bumps [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/mocha) from 8.2.1 to 8.2.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/mocha)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-16 09:40:00 -07:00
elmurci
978a5bcd99 docs(#1387): add Deno and React instructions 2021-04-09 07:29:59 +02:00
elmurci
650d722609 Fix #1353: add memos support for multiple transaction types in getTransactions (#1397)
* fix(#1353): adds memos support for the following transaction types in `getTransactions`:

- AccountDelete
- OfferCreate
- OfferCancel
- CheckCancel
- CheckCash
- CheckCreate
- DepositPreauth
- SetFee
- PaymentChannelFund
- PaymentChannelClaim
- PaymentChannelCreate
- TicketCreate
2021-04-08 11:46:54 +02:00
Elliot Lee
ef1f8752d9 docs: update HISTORY regarding rippled v1.7 issue 2021-03-23 16:22:57 -07:00
Elliot Lee
6fd0b3a5f1 release: add checksums for 1.9.3 2021-03-16 22:22:11 -07:00
Elliot Lee
362bb13da1 release: 1.9.3 2021-03-16 22:18:58 -07:00
dependabot-preview[bot]
d76a5fc87a build(deps-dev): bump @types/mocha from 7.0.2 to 8.2.1 (#1374)
Bumps [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/mocha) from 7.0.2 to 8.2.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/mocha)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-16 20:58:55 -07:00
Elliot Lee
824f87a692 fix: remove start script (#1384)
Close #1383
2021-03-16 20:58:42 -07:00
Elliot Lee
fa2385ee1c feat: expose address codec methods (#1386)
Fix #1385

* docs: add classicAddressToXAddress and xAddressToClassicAddress static methods
2021-03-16 20:58:16 -07:00
dependabot-preview[bot]
2be7a8fa94 build(deps-dev): bump ejs from 3.1.5 to 3.1.6 (#1362)
Bumps [ejs](https://github.com/mde/ejs) from 3.1.5 to 3.1.6.
- [Release notes](https://github.com/mde/ejs/releases)
- [Changelog](https://github.com/mde/ejs/blob/main/CHANGELOG.md)
- [Commits](https://github.com/mde/ejs/compare/v3.1.5...v3.1.6)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-14 16:46:14 -07:00
dependabot-preview[bot]
7d6a3a7518 build(deps-dev): bump eventemitter2 from 6.4.3 to 6.4.4 (#1375)
Bumps [eventemitter2](https://github.com/hij1nx/EventEmitter2) from 6.4.3 to 6.4.4.
- [Release notes](https://github.com/hij1nx/EventEmitter2/releases)
- [Changelog](https://github.com/EventEmitter2/EventEmitter2/blob/master/CHANGELOG.md)
- [Commits](https://github.com/hij1nx/EventEmitter2/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-14 16:45:43 -07:00
dependabot-preview[bot]
61692a5e34 build(deps): bump @types/lodash from 4.14.165 to 4.14.168 (#1361)
Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.14.165 to 4.14.168.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-12 22:34:09 -08:00
dependabot-preview[bot]
e82c585955 build(deps-dev): bump doctoc from 1.4.0 to 2.0.0 (#1359)
Bumps [doctoc](https://github.com/thlorenz/doctoc) from 1.4.0 to 2.0.0.
- [Release notes](https://github.com/thlorenz/doctoc/releases)
- [Commits](https://github.com/thlorenz/doctoc/compare/v1.4.0...v2.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-12 22:33:55 -08:00
Elliot Lee
bc50603111 docs: add 1.9.2 release notes 2021-03-12 16:23:00 -08:00
Elliot Lee
debb9cb3a5 fix: deserialization and verification of payment paths (#1382)
Fixes #1347

Ref #1376
2021-03-12 16:17:48 -08:00
Elliot Lee
4fd74b3671 fix: remove XRP Vanity (defunct) 2021-03-10 17:04:58 -08:00
dependabot-preview[bot]
eb4ac74ce6 build(deps-dev): bump @types/node from 14.14.10 to 14.14.31 (#1360)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 14.14.10 to 14.14.31.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-08 13:44:20 -08:00
dependabot-preview[bot]
cf4d2b2c1a build(deps): bump ripple-address-codec from 4.1.1 to 4.1.2 (#1358)
Bumps [ripple-address-codec](https://github.com/ripple/ripple-address-codec) from 4.1.1 to 4.1.2.
- [Release notes](https://github.com/ripple/ripple-address-codec/releases)
- [Changelog](https://github.com/ripple/ripple-address-codec/blob/master/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-address-codec/compare/4.1.1...4.1.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-08 13:43:46 -08:00
dependabot-preview[bot]
c79b044aaa build(deps-dev): bump ts-node from 8.10.2 to 9.1.1 (#1357)
Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 8.10.2 to 9.1.1.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Commits](https://github.com/TypeStrong/ts-node/compare/v8.10.2...v9.1.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-03-08 13:43:32 -08:00
Rome Reginelli
32718d583b docs: add missing transaction type links (#1378)
https://github.com/ripple/ripple-lib/pull/1352 had empty placeholder links for a few transaction types. This adds those.
2021-03-03 16:07:03 -08:00
dependabot-preview[bot]
c3965f325b build(deps): bump lodash from 4.17.20 to 4.17.21 (#1356)
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.20...4.17.21)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-02-26 22:57:47 -08:00
dependabot-preview[bot]
7b77177962 Create Dependabot config file (#1368)
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-02-25 20:04:24 -08:00
Elliot Lee
3781b798a1 fix: remove copypasta in release notes 2021-02-25 19:55:03 -08:00
Elliot Lee
31314212a5 release: 1.9.1 2021-02-25 19:37:20 -08:00
Elliot Lee
7d36cfa068 deps: use ripple-keypairs ^1.0.3 and resolve to elliptic ^6.5.4 2021-02-25 17:13:50 -08:00
dependabot-preview[bot]
848c179fd4 build(deps): bump ripple-keypairs from 1.0.2 to 1.0.3 (#1373)
Bumps [ripple-keypairs](https://github.com/ripple/ripple-keypairs) from 1.0.2 to 1.0.3.
- [Release notes](https://github.com/ripple/ripple-keypairs/releases)
- [Changelog](https://github.com/ripple/ripple-keypairs/blob/master/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-keypairs/compare/1.0.2...1.0.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2021-02-25 15:16:50 -08:00
Elliot Lee
e2cecd07e4 Create codeql-analysis.yml 2021-02-22 22:36:12 -08:00
Matthew Rosendin
08b76fba22 docs: update transactions.md.ejs (#1348)
Co-authored-by: Elliot Lee <github.public@intelliot.com>
2021-02-22 19:46:11 -08:00
Elliot Lee
2642589ea4 fix: update link to subscribe page (#1354) 2021-02-22 19:42:07 -08:00
Elliot Lee
965dc4bd87 fix: allow connectionTimeout option to be customized (#1355)
- Ref #1044
- Fix #1174
- Fix #1196
2021-02-11 23:55:33 -08:00
Rome Reginelli
c9689ec2a8 docs: add missing transaction specifications (#1352)
Add the following missing specifications to the list of transactionType
specifications:

- Ticket Create
- Account Delete
- Deposit Preauth

Rearrange the transaction type specifications to be in alphabetical
order.
2021-01-25 09:09:10 -08:00
Elliot Lee
9a3ef216f9 Release 1.9.0 2020-12-07 14:42:32 -08:00
Nathan Nichols
e8817d9e0b build(webpack): update to webpack 5 (#1336)
Co-authored-by: Elliot Lee <github.public@intelliot.com>
2020-12-07 10:00:57 -08:00
Elliot Lee
abb1d23ee2 docs: replace 'Install' with 'Getting Started' 2020-12-07 08:56:11 -08:00
Elliot Lee
9636849c63 docs: update README 2020-12-07 08:55:00 -08:00
elmurci
4aa76b38f9 Merge pull request #1324 from elmurci/develop
Tickets Support
2020-12-04 07:10:45 -05:00
Elliot Lee
03655b4ed2 fix(tickets): rename docs/src/prepareTicket.md.ejs to prepareTicketCreate.md.ejs
- Add note that TicketBatch amendment is required and is not yet
  activated
2020-11-24 09:43:35 -08:00
Elliot Lee
f1ec45769b fix: enable TicketCreate encoding by updating ripple-binary-codec 2020-11-23 19:58:54 -08:00
Elliot Lee
5db1f5668c feat(types): add LedgerClosedEvent and export more types (#1333)
- Export AccountInfoResponse and other types
2020-11-23 19:58:54 -08:00
Rome Reginelli
dd4c6a0353 Improve descriptions of get-ledger response time fields. (#1326) 2020-11-23 19:58:54 -08:00
Elliot Lee
95a2655501 Add example of reliable transaction submission (#1059) 2020-11-23 19:58:54 -08:00
Elliot Lee
2ba31c5b75 feat(types): add LedgerClosedEvent and export more types (#1333)
- Export AccountInfoResponse and other types
2020-11-23 18:58:05 -08:00
Rome Reginelli
33fb35138f Improve descriptions of get-ledger response time fields. (#1326) 2020-11-17 13:58:14 -08:00
Elliot Lee
ed26f9a763 Add example of reliable transaction submission (#1059) 2020-11-17 13:57:57 -08:00
Elliot Lee
415a61f06a Merge branch 'develop' into develop 2020-11-14 00:08:59 -08:00
Elliot Lee
4eb64b5e72 style: yarn format (run prettier) (#1327) 2020-11-12 11:49:53 -08:00
Elliot Lee
9e96fa3473 APPLICATIONS.md - Add Bithomp explorer 2020-11-09 16:06:41 -08:00
Javi
1c1a3fa583 fix(refactor): rename prepareTicket to prepareTicketCreate (https://github.com/ripple/ripple-lib/pull/1324#discussion_r519027049) 2020-11-08 09:53:17 +01:00
Javi
c985838cdd fix(docs): Update docs 2020-11-06 11:35:10 +01:00
Javi
81dfd99642 fix(docs): Update docs 2020-11-06 11:23:14 +01:00
Javi
9f6fa6a4fd fix: sequence 0 check, lint and format 2020-11-06 10:58:21 +01:00
Javi
6b4fa159ea fix(doc): docgen 2020-11-06 10:48:06 +01:00
Javi
782787a5b9 fix(tests): remove filter from test script 2020-11-06 10:46:23 +01:00
Javi
fd0f64fe54 fix(tests): more unit tests 2020-11-06 10:44:46 +01:00
Javi
c7e08378ac feat(tickets): first commit, preparePayment and prepareTicket 2020-11-05 12:41:54 +01:00
Elliot Lee
382cf4cb1f Update mocha, nyc 2020-10-23 14:26:13 -07:00
Elliot Lee
be71af5c55 Update webpack, webpack-cli; require node 10.13.0+ 2020-10-23 14:13:33 -07:00
Elliot Lee
97f9812876 Merge branch 'master' into develop 2020-10-23 13:53:33 -07:00
Elliot Lee
dcc50e1b36 Add 1.8.2 checksums 2020-10-23 13:51:49 -07:00
Elliot Lee
ae8824fb11 Release 1.8.2 (#1320) 2020-10-23 13:48:13 -07:00
Elliot Lee
337ab2993b Use ripple-binary-codec 0.2.x (#1321) 2020-10-23 13:37:39 -07:00
Elliot Lee
a4782764dd getSettings: allow ledgerVersion to be validated, closed, or current (#1298) 2020-10-16 14:45:53 -07:00
Elliot Lee
0a4c28f799 Update APPLICATIONS.md 2020-10-16 13:32:40 -07:00
Elliot Lee
1470a0d234 Update APPLICATIONS.md (#1315)
Add XUMM, Xpring Wallet, and move wallets section up
2020-10-11 21:04:59 -07:00
Elliot Lee
bc19db9ddd Proposed 1.8.2-beta.0 (#1316)
* Clear awaiting response promises when handled (#1302)

Co-authored-by: Elliot Lee <github.public@intelliot.com>

Co-authored-by: southbite <simon@tenacious.digital>
2020-10-11 21:03:52 -07:00
southbite
d96b0d3986 Clear awaiting response promises when handled (#1302)
* clearing of awaiting response promises when response handled

* Apply suggestions from code review

Co-authored-by: Elliot Lee <github.public@intelliot.com>
2020-09-28 12:57:01 -07:00
Elliot Lee
a5c35586f7 Add SHA-256 checksums for 1.8.1 2020-09-28 12:37:47 -07:00
Elliot Lee
a54655c0ff Release 1.8.1 (#1313)
* Update to ripple-binary-codec 1.0.2
2020-09-25 14:08:20 -07:00
dependabot-preview[bot]
2681e81d6b [Security] Bump elliptic from 6.5.2 to 6.5.3 (#1308)
Bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.2 to 6.5.3. **This update includes a security fix.**
- [Release notes](https://github.com/indutny/elliptic/releases)
- [Commits](https://github.com/indutny/elliptic/compare/v6.5.2...v6.5.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-09-11 08:32:12 -07:00
dependabot[bot]
2a0234e5ce Bump lodash from 4.17.15 to 4.17.19 (#1305)
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-07-27 13:57:13 -07:00
Elliot Lee
6b326a6efd Release 1.8.0 2020-07-06 21:25:17 -07:00
Mo Morsi
48d2bf849f Update APPLICATIONS.md to reflect latest Dev Null Productions products (#1300)
* s/xrp1ntel/xrpintel

* Add zerptracker to APPLICATIONS
2020-06-26 10:04:44 -07:00
Elliot Lee
4ab808b6de Deprecate submit() in favor of request('submit', {...}) (#1294)
Using request('submit', ...) allows the ripple-lib API to be effectively
identical to the underlying rippled API. Whereas submit() returns only
certain fields from rippled, using request('submit') gives you rippled's
full response, including the new fields added in rippled v1.5.0.
2020-06-09 09:04:01 -07:00
Elliot Lee
e5496e84a6 Release 1.7.1 2020-05-26 15:56:14 -07:00
Elliot Lee
83b5c7f678 Fix preparePayment when using source.amount/destination.minAmount (#1295)
See: https://github.com/ripple/ripple-lib/issues/1237#issuecomment-631670946

Fix #1237

Thanks to @leobel
2020-05-26 15:48:50 -07:00
dependabot-preview[bot]
e6c9617e01 Bump eventemitter2 from 6.3.1 to 6.4.0 (#1287)
Bumps [eventemitter2](https://github.com/hij1nx/EventEmitter2) from 6.3.1 to 6.4.0.
- [Release notes](https://github.com/hij1nx/EventEmitter2/releases)
- [Changelog](https://github.com/EventEmitter2/EventEmitter2/blob/master/CHANGELOG.md)
- [Commits](https://github.com/hij1nx/EventEmitter2/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-14 21:42:17 -07:00
dependabot-preview[bot]
6c5fcc3dc6 Bump @types/node from 13.13.4 to 14.0.1 (#1292)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.13.4 to 14.0.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-14 21:41:52 -07:00
dependabot-preview[bot]
2931bb2863 Bump @typescript-eslint/parser from 2.30.0 to 2.31.0 (#1289)
Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 2.30.0 to 2.31.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.31.0/packages/parser)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-14 20:54:04 -07:00
dependabot-preview[bot]
d745b128e3 Bump ws from 7.2.5 to 7.3.0 (#1290)
Bumps [ws](https://github.com/websockets/ws) from 7.2.5 to 7.3.0.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.2.5...7.3.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-14 20:53:05 -07:00
dependabot-preview[bot]
73b952ec0d Bump @typescript-eslint/eslint-plugin from 2.30.0 to 2.31.0 (#1291)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.30.0 to 2.31.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.31.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-14 20:52:38 -07:00
Yusuf Şahin HAMZA
be961fb9a7 Fix generateXAddress example (#1286) 2020-05-08 19:36:12 -07:00
Elliot Lee
851d84bde8 Update docs 2020-05-07 00:06:02 -07:00
Elliot Lee
854c4ebfdd Update Transaction Streams link (#1278) 2020-05-06 14:55:44 -07:00
dependabot-preview[bot]
a77448f7c0 Bump ts-node from 8.9.1 to 8.10.1 (#1279)
Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 8.9.1 to 8.10.1.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Commits](https://github.com/TypeStrong/ts-node/compare/v8.9.1...v8.10.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:30:34 -07:00
dependabot-preview[bot]
0dc33f3d88 Bump ws from 7.2.3 to 7.2.5 (#1280)
Bumps [ws](https://github.com/websockets/ws) from 7.2.3 to 7.2.5.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.2.3...7.2.5)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:30:06 -07:00
dependabot-preview[bot]
aaff0257b0 Bump @types/ws from 7.2.3 to 7.2.4 (#1281)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.2.3 to 7.2.4.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:29:46 -07:00
dependabot-preview[bot]
3557a57bbd Bump @typescript-eslint/parser from 2.27.0 to 2.30.0 (#1282)
Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 2.27.0 to 2.30.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.30.0/packages/parser)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:29:31 -07:00
dependabot-preview[bot]
051d23edff Bump webpack-bundle-analyzer from 3.6.1 to 3.7.0 (#1283)
Bumps [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) from 3.6.1 to 3.7.0.
- [Release notes](https://github.com/webpack-contrib/webpack-bundle-analyzer/releases)
- [Changelog](https://github.com/webpack-contrib/webpack-bundle-analyzer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack-contrib/webpack-bundle-analyzer/compare/v3.6.1...v3.7.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:29:19 -07:00
dependabot-preview[bot]
ccb91c1268 Bump mocha from 7.1.1 to 7.1.2 (#1284)
Bumps [mocha](https://github.com/mochajs/mocha) from 7.1.1 to 7.1.2.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v7.1.1...v7.1.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:29:04 -07:00
dependabot-preview[bot]
6c1c0eee59 Bump assert-diff from 3.0.0 to 3.0.1 (#1285)
Bumps [assert-diff](https://github.com/pihvi/assert-diff) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/pihvi/assert-diff/releases)
- [Commits](https://github.com/pihvi/assert-diff/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-05 13:28:49 -07:00
Elliot Lee
f1c1c7033a Release 1.7.0 (Merge #1276) 2020-04-28 23:31:01 -07:00
Elliot Lee
bc352c4cf0 Document computeBinaryTransactionHash 2020-04-28 23:29:46 -07:00
Elliot Lee
1980fa9fa4 HISTORY: Add 1.7.0 2020-04-28 14:44:22 -07:00
Elliot Lee
6cabb2e935 Release 1.7.0 2020-04-28 14:34:49 -07:00
AGallouin
05411527ee Add failHard (fail_hard) option in submit method (#1029)
See https://xrpl.org/submit.html

Co-authored-by: Elliot Lee <github.public@intelliot.com>
2020-04-28 14:32:25 -07:00
Elliot Lee
3c13da66b3 Export hashing functions (#1275)
The now-deprecated ripple-hashes library provided a number of hash
functions for users to compute the hashes/IDs for various XRP Ledger
objects:

* Transactions (to generate transaction hashes, also known as IDs)
* Transaction signing hashes (to sign transactions)
* Ledger Object IDs (to look up specific ledger objects in a ledger's
  state tree; see https://xrpl.org/ledger-object-ids.html)

This commit exports these utility methods from ripple-lib as static
methods. Access them on the RippleAPI class. Example:

import {RippleAPI} from 'ripple-lib'
const hash = RippleAPI.computeBinaryTransactionHash(...)
2020-04-28 14:19:36 -07:00
dependabot-preview[bot]
5d6af09508 Bump @typescript-eslint/eslint-plugin from 2.24.0 to 2.30.0
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.24.0 to 2.30.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.30.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-28 14:16:27 -07:00
dependabot-preview[bot]
15bf721d24 Bump prettier from 1.19.1 to 2.0.5
Bumps [prettier](https://github.com/prettier/prettier) from 1.19.1 to 2.0.5.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/master/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/1.19.1...2.0.5)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-28 14:16:11 -07:00
dependabot-preview[bot]
14351c9512 Bump ts-node from 8.6.2 to 8.9.1
Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 8.6.2 to 8.9.1.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Commits](https://github.com/TypeStrong/ts-node/compare/v8.6.2...v8.9.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-28 14:15:59 -07:00
dependabot-preview[bot]
3b13de5310 Bump webpack from 4.42.0 to 4.43.0
Bumps [webpack](https://github.com/webpack/webpack) from 4.42.0 to 4.43.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v4.42.0...v4.43.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-28 14:15:46 -07:00
dependabot-preview[bot]
f92eff2df8 Bump @types/node from 13.9.3 to 13.13.4
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.9.3 to 13.13.4.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-28 14:15:15 -07:00
dependabot-preview[bot]
a65ac5f8f0 Bump ejs from 3.0.1 to 3.1.2
Bumps [ejs](https://github.com/mde/ejs) from 3.0.1 to 3.1.2.
- [Release notes](https://github.com/mde/ejs/releases)
- [Changelog](https://github.com/mde/ejs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mde/ejs/compare/v3.0.1...v3.1.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-27 12:11:18 -07:00
dependabot-preview[bot]
0e36a1c505 Bump @types/lodash from 4.14.149 to 4.14.150
Bumps [@types/lodash](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/lodash) from 4.14.149 to 4.14.150.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/lodash)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-27 12:10:49 -07:00
dependabot-preview[bot]
f5bed635e0 Bump nyc from 15.0.0 to 15.0.1
Bumps [nyc](https://github.com/istanbuljs/nyc) from 15.0.0 to 15.0.1.
- [Release notes](https://github.com/istanbuljs/nyc/releases)
- [Changelog](https://github.com/istanbuljs/nyc/blob/master/CHANGELOG.md)
- [Commits](https://github.com/istanbuljs/nyc/compare/v15.0.0...v15.0.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-27 12:08:23 -07:00
dependabot-preview[bot]
905ab9f2e4 Bump eventemitter2 from 6.0.0 to 6.3.1
Bumps [eventemitter2](https://github.com/hij1nx/EventEmitter2) from 6.0.0 to 6.3.1.
- [Release notes](https://github.com/hij1nx/EventEmitter2/releases)
- [Changelog](https://github.com/EventEmitter2/EventEmitter2/blob/master/CHANGELOG.md)
- [Commits](https://github.com/hij1nx/EventEmitter2/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-27 12:08:04 -07:00
Elliot Lee
547b63b891 Run prettier (yarn format) 2020-04-27 12:06:18 -07:00
Elliot Lee
c26ddb497e Add api.connection.getReserveBase() (#1259)
* Returns the current minimum reserve, in drops of XRP, that is required
for an account.

* Release 1.6.6-beta.2
2020-04-27 10:02:03 -07:00
Elliot Lee
2e81cfb56f Add type for parseAccountFlags (#1258)
* Return type is `Settings`
* Bump @typescript-eslint/parser to 2.27.0
* Bump yarn.lock
* Release 1.6.6-beta.1
2020-04-27 10:02:03 -07:00
dependabot-preview[bot]
337cb6574a Bump https-proxy-agent from 4.0.0 to 5.0.0 (#1204)
Bumps [https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent) from 4.0.0 to 5.0.0.
- [Release notes](https://github.com/TooTallNate/node-https-proxy-agent/releases)
- [Commits](https://github.com/TooTallNate/node-https-proxy-agent/compare/4.0.0...5.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-04-27 10:00:53 -07:00
Elliot Lee
abcb6bfecb Travis: remove node 8 (#1257)
ripple-address-codec 4.1.1 requires node 10+
2020-04-07 11:56:39 -07:00
Elliot Lee
797fda3363 Update ripple-address-codec to 4.1.1 2020-04-03 14:08:11 -07:00
dependabot-preview[bot]
bd920ee5bb Bump @types/ws from 7.2.2 to 7.2.3 (#1239)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.2.2 to 7.2.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-04-03 14:06:04 -07:00
Elliot Lee
2720970e1f Release 1.6.5 2020-03-23 14:53:13 -07:00
dependabot-preview[bot]
b7a12d4bbb Bump assert-diff from 2.0.3 to 3.0.0 (#1228)
Bumps [assert-diff](https://github.com/pihvi/assert-diff) from 2.0.3 to 3.0.0.
- [Release notes](https://github.com/pihvi/assert-diff/releases)
- [Commits](https://github.com/pihvi/assert-diff/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-03-23 14:38:51 -07:00
dependabot-preview[bot]
b4f6135b96 Bump @types/node from 13.7.7 to 13.9.3 (#1240)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.7.7 to 13.9.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-03-23 14:37:47 -07:00
Elliot Lee
7d65bf4641 Upgrade webpack 2020-03-23 14:37:18 -07:00
Elliot Lee
656c81a72c Upgrade mocha and remove mocha-junit-reporter 2020-03-23 14:33:34 -07:00
dependabot-preview[bot]
bfd0374ef6 Bump @typescript-eslint/eslint-plugin from 2.22.0 to 2.24.0 (#1243)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.22.0 to 2.24.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.24.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-03-23 11:06:25 -07:00
Rahul Kulkarni
bf1a772e40 Fix typo in comment (#1236) 2020-03-20 14:36:24 -07:00
Elliot Lee
8ede100594 Add link to release announcement mailing list 2020-03-17 12:35:35 -07:00
dependabot-preview[bot]
927f1f6d9a Bump ws from 7.2.1 to 7.2.3 (#1235)
Bumps [ws](https://github.com/websockets/ws) from 7.2.1 to 7.2.3.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.2.1...7.2.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-03-16 14:45:25 -07:00
dependabot-preview[bot]
0be4c6f233 Bump @types/mocha from 7.0.1 to 7.0.2
Bumps [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/mocha) from 7.0.1 to 7.0.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/mocha)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-03-07 01:43:44 +00:00
Elliot Lee
912eea5037 Merge branch 'develop' of github.com:ripple/ripple-lib into develop 2020-03-06 12:34:28 -08:00
Elliot Lee
06a029b89c connection.ts: fix typo 2020-03-06 12:33:55 -08:00
dependabot-preview[bot]
df708a77d2 Bump webpack from 4.41.6 to 4.42.0 (#1223)
Bumps [webpack](https://github.com/webpack/webpack) from 4.41.6 to 4.42.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v4.41.6...v4.42.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-03-04 11:28:07 -05:00
dependabot-preview[bot]
31232ad50c Bump @typescript-eslint/eslint-plugin from 2.21.0 to 2.22.0 (#1226)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.21.0 to 2.22.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.22.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-03-04 11:28:01 -05:00
dependabot-preview[bot]
7abaf61e11 Bump @types/node from 13.7.6 to 13.7.7 (#1225)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.7.6 to 13.7.7.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-03-02 09:13:56 -05:00
dependabot-preview[bot]
903a6e31b8 Bump typescript from 3.8.2 to 3.8.3 (#1224)
Bumps [typescript](https://github.com/Microsoft/TypeScript) from 3.8.2 to 3.8.3.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](https://github.com/Microsoft/TypeScript/compare/v3.8.2...v3.8.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-03-02 09:13:43 -05:00
dependabot-preview[bot]
2eb5898e8b Bump @types/ws from 7.2.1 to 7.2.2 (#1219)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.2.1 to 7.2.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-26 23:10:01 -08:00
dependabot-preview[bot]
dc2bc0291b Bump mocha from 7.0.1 to 7.1.0 (#1220)
Bumps [mocha](https://github.com/mochajs/mocha) from 7.0.1 to 7.1.0.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v7.0.1...v7.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-26 22:58:06 -08:00
dependabot-preview[bot]
1357f7eeb4 Bump @types/node from 13.7.4 to 13.7.6 (#1221)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.7.4 to 13.7.6.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-26 22:57:29 -08:00
Thomas Silkjær
b0cb0a759b Added xrplorer.com (#1218) 2020-02-26 22:57:19 -08:00
dependabot-preview[bot]
19d0ca6bfc Bump @typescript-eslint/eslint-plugin from 2.20.0 to 2.21.0 (#1217)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.20.0 to 2.21.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.21.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-25 11:19:09 -08:00
dependabot-preview[bot]
26d03fe2a5 Bump typescript from 3.7.5 to 3.8.2 (#1215)
Bumps [typescript](https://github.com/Microsoft/TypeScript) from 3.7.5 to 3.8.2.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](https://github.com/Microsoft/TypeScript/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-22 12:46:57 -08:00
dependabot-preview[bot]
dfa61df40a Bump @types/node from 13.7.2 to 13.7.4 (#1214)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.7.2 to 13.7.4.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-20 10:54:46 -08:00
dependabot-preview[bot]
d154cced14 Bump @types/node from 13.7.1 to 13.7.2 (#1213)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.7.1 to 13.7.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-19 07:52:27 -08:00
Elliot Lee
80b96d9bc9 Release 1.6.4 2020-02-18 11:19:03 -08:00
dependabot-preview[bot]
8fa30f71eb Bump @typescript-eslint/eslint-plugin from 2.19.2 to 2.20.0 (#1212)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.19.2 to 2.20.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.20.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-18 11:14:57 -08:00
Elliot Lee
804094b1ce Fix generateXAddress() and generateXAddress() with no entropy (#1211)
Fix #1209

Calling: Uint8Array.from(undefined)
Throws:
  TypeError: undefined is not iterable (cannot read property Symbol(Symbol.iterator))
    at Function.from (<anonymous>)

* generateSeed: Pass only entropy and algorithm

* Update typescript and ripple-keypairs

* Improve unit tests

* Rename [Original Address] to [Classic Address] in test output
2020-02-18 11:14:09 -08:00
dependabot-preview[bot]
9caf077b58 Bump @typescript-eslint/eslint-plugin from 2.19.0 to 2.19.2 (#1205)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.19.0 to 2.19.2.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.19.2/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-12 10:30:19 -08:00
dependabot-preview[bot]
1a5ba06ca3 Bump webpack from 4.41.4 to 4.41.6 (#1206)
Bumps [webpack](https://github.com/webpack/webpack) from 4.41.4 to 4.41.6.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v4.41.4...v4.41.6)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-12 10:30:05 -08:00
dependabot-preview[bot]
657cad9ffd Bump @types/node from 13.7.0 to 13.7.1 (#1207)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.7.0 to 13.7.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-12 10:29:46 -08:00
dependabot-preview[bot]
a338a936db Bump webpack-cli from 3.3.10 to 3.3.11 (#1208)
Bumps [webpack-cli](https://github.com/webpack/webpack-cli) from 3.3.10 to 3.3.11.
- [Release notes](https://github.com/webpack/webpack-cli/releases)
- [Changelog](https://github.com/webpack/webpack-cli/blob/next/CHANGELOG_v3.md)
- [Commits](https://github.com/webpack/webpack-cli/compare/v3.3.10...v3.3.11)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-12 10:29:33 -08:00
Elliot Lee
226e10bca2 Release 1.6.3 2020-02-05 22:19:47 -08:00
dependabot-preview[bot]
3a5a989011 Bump ripple-keypairs from 1.0.0-beta.6 to 1.0.0 (#1203)
Bumps [ripple-keypairs](https://github.com/ripple/ripple-keypairs) from 1.0.0-beta.6 to 1.0.0.
- [Release notes](https://github.com/ripple/ripple-keypairs/releases)
- [Changelog](https://github.com/ripple/ripple-keypairs/blob/master/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-keypairs/commits/1.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-05 18:36:50 -08:00
dependabot-preview[bot]
c9720ef061 Bump @types/node from 13.5.3 to 13.7.0 (#1201)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.5.3 to 13.7.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-05 10:33:54 -08:00
dependabot-preview[bot]
b6927f178f Bump @typescript-eslint/eslint-plugin from 2.18.0 to 2.19.0 (#1202)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.18.0 to 2.19.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.19.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-02-05 10:33:42 -08:00
Elliot Lee
6b40e4fe9d Release 1.6.3-beta.1 (#1195)
* Update ripple-keypairs and fix types
2020-02-02 15:14:44 -08:00
Elliot Lee
59ec56db4c Update README.md 2020-01-31 13:59:11 -08:00
dependabot-preview[bot]
a8119d678a Bump @types/node from 13.5.2 to 13.5.3 (#1200)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.5.2 to 13.5.3.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-31 10:51:36 -08:00
dependabot-preview[bot]
8e38e313b2 Bump @types/ws from 7.2.0 to 7.2.1 (#1197)
Bumps [@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws) from 7.2.0 to 7.2.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-31 00:40:07 -08:00
dependabot-preview[bot]
b7b75d78ae Bump @types/node from 13.5.1 to 13.5.2 (#1198)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.5.1 to 13.5.2.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-31 00:39:52 -08:00
dependabot-preview[bot]
824efb6b59 Bump @types/mocha from 5.2.7 to 7.0.1 (#1199)
Bumps [@types/mocha](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/mocha) from 5.2.7 to 7.0.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/mocha)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-31 00:39:41 -08:00
dependabot-preview[bot]
c151ca202c Bump ripple-address-codec from 4.0.0 to 4.1.0 (#1184)
Bumps [ripple-address-codec](https://github.com/ripple/ripple-address-codec) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/ripple/ripple-address-codec/releases)
- [Changelog](https://github.com/ripple/ripple-address-codec/blob/master/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-address-codec/compare/4.0.0...4.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-29 10:00:09 -08:00
dependabot-preview[bot]
b9a64c92e7 Bump @typescript-eslint/eslint-plugin from 2.16.0 to 2.18.0 (#1189)
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 2.16.0 to 2.18.0.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v2.18.0/packages/eslint-plugin)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-29 09:59:51 -08:00
dependabot-preview[bot]
bcaa06721a Bump ripple-keypairs from 0.11.0 to 0.11.1 (#1190)
Bumps [ripple-keypairs](https://github.com/ripple/ripple-keypairs) from 0.11.0 to 0.11.1.
- [Release notes](https://github.com/ripple/ripple-keypairs/releases)
- [Changelog](https://github.com/ripple/ripple-keypairs/blob/0.11.1/HISTORY.md)
- [Commits](https://github.com/ripple/ripple-keypairs/compare/0.11.0...0.11.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-29 09:58:35 -08:00
dependabot-preview[bot]
06227ef12b Bump @types/node from 13.5.0 to 13.5.1 (#1193)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.5.0 to 13.5.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-29 09:57:21 -08:00
Nicholas Smith
c17827e030 Assign event listener to socket close event on open before attempting post-open logic (#1186)
* Assign event listener to socket close event on open before attempting to execute post-connection logic, prottects possible unhandled rejection in disconnect
* Remove try/catch for linting failure
* Up timeout for CI failure
* Feedback emit error for disconnection failure on connect failure
* Feedback ignore error on disconnect, propagate root cause
* Feedback add extra test check for expected error on connect
* Feedback remove setTimeout for await reconnect
2020-01-28 09:08:47 -05:00
dependabot-preview[bot]
97ca0f0b21 Bump @types/node from 13.1.8 to 13.5.0 (#1187)
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.1.8 to 13.5.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-28 02:23:50 -08:00
dependabot-preview[bot]
e4e6419e50 Bump mocha from 7.0.0 to 7.0.1 (#1188)
Bumps [mocha](https://github.com/mochajs/mocha) from 7.0.0 to 7.0.1.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v7.0.0...v7.0.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-28 02:23:35 -08:00
Elliot Lee
fd8c883cf4 Update tsconfig-base.json - remove comments 2020-01-21 13:52:53 -08:00
FKSRipple
6b66a59673 Merge pull request #1180 from ripple/dependabot/npm_and_yarn/mocha-junit-reporter-1.23.3
Bump mocha-junit-reporter from 1.23.2 to 1.23.3
2020-01-20 20:55:40 -08:00
FKSRipple
46177338c2 Merge pull request #1182 from ripple/dependabot/npm_and_yarn/types/node-13.1.8
Bump @types/node from 13.1.7 to 13.1.8
2020-01-20 20:55:28 -08:00
dependabot-preview[bot]
6fcff9b106 Bump @types/node from 13.1.7 to 13.1.8
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 13.1.7 to 13.1.8.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-20 13:27:16 +00:00
dependabot-preview[bot]
4f9b6b9186 Bump mocha-junit-reporter from 1.23.2 to 1.23.3
Bumps [mocha-junit-reporter](https://github.com/michaelleeallen/mocha-junit-reporter) from 1.23.2 to 1.23.3.
- [Release notes](https://github.com/michaelleeallen/mocha-junit-reporter/releases)
- [Commits](https://github.com/michaelleeallen/mocha-junit-reporter/compare/v1.23.2...v1.23.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-01-17 13:26:35 +00:00
1093 changed files with 79170 additions and 38220 deletions

4
.eslintignore Normal file
View File

@@ -0,0 +1,4 @@
dist
node_modules
.github
.vscode

128
.eslintrc.js Normal file
View File

@@ -0,0 +1,128 @@
module.exports = {
root: true,
// Make ESLint compatible with TypeScript
parser: '@typescript-eslint/parser',
parserOptions: {
// Enable linting rules with type information from our tsconfig
tsconfigRootDir: __dirname,
project: ['./tsconfig.eslint.json'],
// Allow the use of imports / ES modules
sourceType: 'module',
ecmaFeatures: {
// Enable global strict mode
impliedStrict: true,
},
},
// Specify global variables that are predefined
env: {
// Enable node global variables & Node.js scoping
node: true,
// Add all ECMAScript 2020 globals and automatically set the ecmaVersion parser option to ES2020
es2020: true,
},
plugins: [],
extends: ['@xrplf/eslint-config/base', 'plugin:mocha/recommended'],
rules: {
// Certain rippled APIs require snake_case naming
'@typescript-eslint/naming-convention': [
'error',
{
selector: 'interface',
format: ['PascalCase', 'snake_case'],
},
],
'max-lines-per-function': [
'warn',
{ max: 40, skipBlankLines: true, skipComments: true },
],
'max-statements': ['warn', 25],
// exception for lodash
'id-length': ['error', { exceptions: ['_'] }],
// no-shadow has false-positives for enum, @typescript-eslint version fixes that
'no-shadow': 'off',
'@typescript-eslint/no-shadow': ['error'],
},
overrides: [
{
files: ['.eslintrc.js'],
rules: {
'import/no-unused-modules': 'off',
'@typescript-eslint/no-magic-numbers': 'off',
},
},
{
// TODO: remove when snippets are written
files: ['snippets/src/*.ts'],
rules: {
'max-len': 'off',
'import/unambiguous': 'off',
'import/no-unused-modules': 'off',
},
},
{
files: ['test/**/*.ts'],
rules: {
// We have lots of magic numbers in tests
'@typescript-eslint/no-magic-numbers': 'off',
// We have files with a lot of tests
'max-lines-per-function': 'off',
'max-lines': 'off',
// We need to test things without type guards sometimes
'@typescript-eslint/no-unsafe-assignment': 'off',
'@typescript-eslint/no-unsafe-call': 'off',
'@typescript-eslint/consistent-type-assertions': 'off',
// 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',
},
},
{
files: ['test/client/*.ts'],
rules: {
// Rule does not work with dynamically generated tests.
'mocha/no-setup-in-describe': 'off',
},
},
{
files: ['test/models/*.ts'],
rules: {
'@typescript-eslint/no-explicit-any': 'off',
},
},
{
files: ['.eslintrc.js', 'jest.config.js'],
rules: {
// Removed no-commonjs requirement as eslint must be in common js format
'import/no-commonjs': 'off',
// Removed this as eslint prevents us from doing this differently
'import/unambiguous': 'off',
// Javascript files have CommonJS exports
'import/no-unused-modules': 'off',
},
},
],
}

View File

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

13
.github/dependabot.yml vendored Normal file
View File

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

50
.github/pull_request_template.md vendored Normal file
View File

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

67
.github/workflows/codeql-analysis.yml vendored Normal file
View File

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

96
.github/workflows/nodejs.yml vendored Normal file
View File

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

7
.gitignore vendored
View File

@@ -1,7 +1,7 @@
# .gitignore
# Ignore package locks other than Yarn.
package-lock.json
# Ignore package locks other than npm.
yarn.lock
npm-shrinkwrap.json
# Ignore vim swap files.
@@ -68,3 +68,6 @@ scripts/cache
# nyc (istanbul)
.nyc_output
# browser tests
testCompiledForWeb

2
.nvmrc
View File

@@ -1 +1 @@
v10
v12

View File

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

View File

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

6
.vscode/extensions.json vendored Normal file
View File

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

35
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,35 @@
{
"editor.tabSize": 2,
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[javascriptreact]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[typescriptreact]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"eslint.alwaysShowStatus": true,
"eslint.lintTask.enable": true,
"eslint.codeAction.showDocumentation": {
"enable": true
},
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
"files.trimTrailingWhitespace": true,
"files.watcherExclude": {
"**/.git/objects/**": true,
"**/.git/subtree-cache/**": true,
"**/.hg/store/**": true
},
}

View File

@@ -1,6 +1,6 @@
# Applications using ripple-lib (RippleAPI)
# Applications using xrpl.js
A curated list of some of the projects and apps that leverage `ripple-lib` in some way.
A curated list of some of the projects and apps that leverage `xrpl.js` in some way.
**Have one to add?** Please edit this file and open a PR!
@@ -10,9 +10,19 @@ These sites are independent of Ripple and have not been authorized, endorsed, sp
Warning: Use at your own risk.
## Data and visualizations
## Exchanges
- **[xrp1ntel - XRP Intelligence](https://xrp1ntel.com/)**
- **[The World Exchange](https://www.theworldexchange.net/)**
Trade, issue, and send directly on the XRP Ledger. A user interface for the XRPL's decentralized exchange.
- **[Bitso](https://bitso.com/)**
Exchange allowing clients to buy and sell XRP, based in Mexico.
## Explorers
- **[xrpintel - XRP Intelligence](https://xrpintel.com/)**
Monitor the XRP Network in real time and explore historical statistics.
@@ -32,6 +42,10 @@ Warning: Use at your own risk.
Real-time XRP price, trades, and orderbook data from the XRP Ledger.
- **[Bithomp - XRP Explorer](https://bithomp.com/explorer/)**
Look up information by entering an address, transaction hash, username, or PayID.
- **[Bithomp - XRPL validators](https://bithomp.com/validators)**
List of XRPL validators, nodes, and testnet validators.
@@ -40,26 +54,34 @@ Warning: Use at your own risk.
XRP Ledger explorer, metrics and analytics.
## Send and request payments
- **[xrplorer](https://xrplorer.com)**
- **[XRP Tip Bot](https://www.xrptipbot.com/)**
XRP Ledger explorer, API, metrics, and analytics using a graph database that is synchronized live with the XRPL.
A bot that enables users on reddit, Twitter and Discord to send XRP to each other through reddit comments and Twitter tweets.
## Data monitoring
- **[XRP Text](https://xrptext.com/)**
- **[zerptracker](https://zerptracker.com)**
Send XRP using SMS text messages.
Monitor the XRPL using powerful JSONPath expressions, and receive notifications via email, SMS, webhooks, and more.
- **[XRParrot](https://xrparrot.com/)** (uses `ripple-address-codec`)
- **[Utility-Scan](https://utility-scan.com)**
Easy EUR (SEPA) to XRP transfer (currency conversion).
Attempts to detect RippleNet on-demand liquidity (ODL) transactions through known fiat corridors and report these transactions in real time.
- **[XRP Payment](https://xrpayments.co/)** (xrpayments.co)
- **[XRPL Rosetta](https://xrpl-rosetta-oepox.ondigitalocean.app)**
Tool for generating a XRP payment request URI in a QR code, with currency converter.
3D Globe written in three.js connected to a Node.js websocket server that is listening to exchanges and the XRPL. The visualization aims to show trading, ODL, and liquidity at exchanges, intra-exchange volume, and flows.
## Wallets and wallet tools
- **[XUMM](https://xumm.app/)**
Users can use the xumm application to track their accounts, balances and transactions. The true power of xumm is the platform available for developers.
- **[Xpring Wallet](https://xpring.io)** (uses `ripple-keypairs`)
Non-custodial XRP wallet.
- **[XRP Toolkit](https://www.xrptoolkit.com)**
A web interface to the XRP Ledger, supporting both hardware and software wallets.
@@ -88,11 +110,29 @@ Warning: Use at your own risk.
Recover a 24 word mnemonic if one word is wrong or one word is missing.
## Send and request payments
- **[XRP Tip Bot](https://www.xrptipbot.com/)**
A bot that enables users on reddit, Twitter and Discord to send XRP to each other through reddit comments and Twitter tweets.
- **[XRP Text](https://xrptext.com/)**
Send XRP using SMS text messages.
- **[XRParrot](https://xrparrot.com/)** (uses `ripple-address-codec`)
Easy EUR (SEPA) to XRP transfer (currency conversion).
- **[XRP Payment](https://xrpayments.co/)** (xrpayments.co)
Tool for generating a XRP payment request URI in a QR code, with currency converter.
## Development tools
- **[XRP Test Net Faucet](https://developers.ripple.com/xrp-test-net-faucet.html)**
- **[XRP Faucets for Testnet and Devnet](https://xrpl.org/xrp-testnet-faucet.html)**
Get some test funds for development on the test network. The faucet was built using `ripple-lib`.
Get some test funds for development on the test network. The faucet uses `xrpl.js`.
## Code samples and libraries
@@ -116,12 +156,8 @@ Warning: Use at your own risk.
For about $30 in parts (Raspberry Pi, 3.3V Relay board and a few wires) you can build your own power switch that will switch on if a streaming ILP payment comes in. When the payment stream stops, the power turns off.
## Related apps that do not appear to use ripple-lib
## Related apps that do not appear to use xrpl.js
- **[XRP Stats](https://ledger.exposed/)** (ledger.exposed)
Rich list, live ledger stats and XRP distribution. Visualize escrows and flow of funds.
- **[XRP Vanity](https://xrpvanity.com/)** (xrpvanity.com)
Custom XRP addresses for sale, delivered by SetRegularKey.

View File

@@ -1,5 +1,310 @@
# ripple-lib Release History
Subscribe to [the **ripple-lib-announce** mailing list](https://groups.google.com/forum/#!forum/ripple-lib-announce) for release announcements. We recommend that ripple-lib users stay up-to-date with the latest stable release.
## 1.10.0 (2021-08-12)
* Add address generation from Devnet/Testnet faucets (#1497)
* Fix bug with `getBalances()` ledgerVersion (#1505)
* Include lodash in webpack build (#1500)
* Documentation Updates:
* Export and document AccountSetFlags (#1525)
* Add links to example keypair derivation (#1523)
## 1.9.8 (2021-07-30)
* Export offline methods to top level of package (#1479)
* Remove deprecated ledger fields (#1160)
* These fields have been deprecated for many years: accepted, hash (use ledger_hash instead), seqNum (use ledger_index instead), totalCoins (use total_coins instead)
* Docs improvements (#1251, #1420, #1463)
* Reduce dependencies on lodash (#1467)
* Bug fixes
* Allow lowercase hex for memos (#1475)
* Add type argument to Promise (#1474)
* Fix miscommunication with ripplingDisabled in trustlines (#1481)
* Allow X-address for issuer (#1471)
* Dependencies
* ws, ripple-binary-codec
* deps-dev: typescript, @types/node, ts-node
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
f3a0efb9f8bb618da6b10425a9b55a8492359a331a22d0ab4de7d3551870eb3d build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
fd40457a89a14732ce261148e129cdda5aa963d9a433c57700353083faa1bffe build/ripple-latest.js
```
## 1.9.7 (2021-07-14)
* Bug fixes
* TypeScript: fix TrustlineTransaction type (#1458) (#1460) (thanks @mrosendin)
* Docs
* Update boilerplate (#1459) (thanks @mDuo13)
* Dependencies
* @types/node, @types/ws, @types/lodash, @types/mocha, prettier, mocha, webpack, ripple-binary-codec, ws, webpack-cli, doctoc
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
a994422648c040076251c9a040fd494bc2ee30de23867607985b953022853afc build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
2e22b6187ff5f9300520c29a538013067609b439181f1f2184d6a80fcfa2449c build/ripple-latest.js
```
## 1.9.6 (2021-07-01)
* Bug fixes
* Use 'current' ledger when preparing txs (#1429) (#999)
* Allow multiple settings at once (#1435)
* Dependencies
* ripple-address-codec, prettier, mocha
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
cac7f6f3be93efbd61dc5fd527c40f0d1baec06f2f9faa64e9eeb191cc85a710 build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
5737483e940dca8b73768d8a1de8217c7e921a9cebaadef02d2b16867658f331 build/ripple-latest.js
```
## 1.9.5 (2021-06-01)
* Bug fixes
* Prevent getFee from returning NaN from Reporting Mode (#1401) (#1398)
* Return promise inside catch block of reconnect to propagate promise (#1418) (#1113) (thanks @camposfyi)
* Internal
* Update mocha to use RC file config (#1417) (#1210) (thanks @camposfyi)
* Dependencies
* @types/ws, ws, browserslist, @types/lodash
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
fcdc4aa1e1df7cb788b68f3d036e168aa64f9e818f441b99fef62d4571c0387d build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
dfb7a92c4156fb3ee367254b5ea0935cda741cd3b5c36cdca695e7d89f88605e build/ripple-latest.js
```
## 1.9.4 (2021-04-18)
* Add memos support for all transaction types for getTransactions (#1353, #1397)
* Add Deno and React instructions (#1387)
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
daa2b892a18037e89fea6fcf7de67624a782971956cb8df17cd765a4b0201ee9 build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
b1d0bab54c6dbc76091610ede54a4269e73dea8cc6a9c25738d62bd7671920e4 build/ripple-latest.js
```
## 1.9.3 (2021-03-16)
* Expose ripple-address-codec methods. These are static methods on RippleAPI, so you do not need to create a RippleAPI instance.
* `classicAddressToXAddress` / `xAddressToClassicAddress`
* `isValidXAddress` / `isValidClassicAddress`
* `encodeSeed` / `decodeSeed`
* `encodeAccountID` / `decodeAccountID`
* `encodeNodePublic` / `decodeNodePublic`
* `encodeAccountPublic` / `decodeAccountPublic`
* `encodeXAddress` / `decodeXAddress`
Example 1. Encode an X-address with tag 4294967295:
```js
const RippleAPI = require('ripple-lib').RippleAPI
const xAddress = RippleAPI.classicAddressToXAddress('rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf', 4294967295)
console.log(xAddress)
```
Output for Example 1:
```
XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi
```
Example 2. Encode a test address for use with Testnet or Devnet:
```js
const RippleAPI = require('ripple-lib').RippleAPI
const address = RippleAPI.classicAddressToXAddress('r3SVzk8ApofDJuVBPKdmbbLjWGCCXpBQ2g', 123, true)
console.log(address)
```
Output for Example 2:
```
T7oKJ3q7s94kDH6tpkBowhetT1JKfcfdSCmAXbS75iATyLD
```
Example 3. Decode an X-address:
```js
const RippleAPI = require('ripple-lib').RippleAPI
const address = RippleAPI.xAddressToClassicAddress('XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi')
console.log(address)
```
Output for Example 3:
```js
{
classicAddress: 'rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf',
tag: 4294967295,
test: false
}
```
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
bcc8db4e5464197151a267d9f240693794bf1eb4d26a4e0b3637f82a1d66e440 build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
99c2825685d249c074abe7b59abaf197afce67ece7ad08ded6db67185e916dd2 build/ripple-latest.js
```
## 1.9.2 (2021-03-12)
* Docs
* Add missing transaction type links (#1378)
* Bug fixes
* Deserialization and verification of payment paths (#1382) (#1347) (#1376)
* Dependencies
* Bump ripple-binary-codec to 1.1.2
* Fix edge case when constructing a value from "0", which can occur when using rippled v1.7.0
* Bump lodash, ripple-address-codec
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
a1fd24b65d81ea5dbc36d74da7a6317267a048bba084effff5380d47299c3c63 build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
410f78105c4f23c13671ec94f963ef47179393bfcad65ff610bc838c5a3c6a65 build/ripple-latest.js
```
## 1.9.1 (2021-02-25)
* Docs
* Add transaction specifications: (#1352)
* Ticket Create
* Account Delete
* Deposit Preauth
* Update link to subscribe page (#1354)
* Bug fixes
* Allow connectionTimeout option to be customized (#1355)
* Dependencies
* Bump ripple-keypairs to 1.0.3
* Bump elliptic to 6.5.4 (this patches a potential security issue, although we do not believe that the issue affects ripple-lib: [details](https://github.com/ripple/ripple-keypairs/security/advisories/GHSA-w6x3-9ph2-7x54))
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
f59e0221a7218460eea59b0441a0ee2d2a14484dd473ed5373283852798516c7 build/ripple-latest-min.js
fc17a5572001d814ea6b81aa701fcb66882ec031c68afb769a8ea8b71c6529a6 build/ripple-latest-min.js.LICENSE.txt
731ed44cbff8db26bcf256e0e3f3ac3fe90a10b6c227701d67918a5d643c5b29 build/ripple-latest.js
```
## 1.9.0 (2020-12-07)
* New features
* Support for tickets (TicketBatch amendment required - not yet activated on live/main network)
* `prepareTicketCreate`
* Types: Add LedgerClosedEvent and export more types
* Docs
* Improve descriptions of get-ledger response time fields
* Applications
* Add Bithomp explorer
* Add example of reliable transaction submission
* Node.js
* Require Node.js version 10.13.0+
* Internal
* Update webpack, webpack-cli, mocha, nyc, ripple-binary-codec
* Run prettier to format code
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 build/*
2d3ae057ad637df272f98cfe940ea9e1317588e5bbf4fee47c8b16d6e6e71d85 build/ripple-latest-min.js
8cbbc7bb482f68bcc8d411bae2e42effdb14ddfa562fcbc329a373910b85cf8c build/ripple-latest.js
```
## 1.8.2 (2020-10-23)
* Bug fixes
* Browser compatibility: Use ripple-binary-codec 0.2.x to prevent browser issues (#1321)
* Memory leak: Clear awaiting response promises to prevent memory leak (#1302)
* Feature: getSettings() - allow ledgerVersion to be 'validated', 'closed', or 'current' (#1298)
* Docs: Update APPLICATIONS.md
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 *
ba760c36028b8a3ce267386e188a422890dfb1b03bc87c852a4c2034ea9bac2e ripple-latest-min.js
7e5281eb9623602284b9f11564f0f3a36cfde305f2c2f7a32e0d29a04913c817 ripple-latest.js
```
## 1.8.1 (2020-09-25)
* Internal
* Bump elliptic to 6.5.3 (this patches a potential security issue, although we do not believe that the issue affects ripple-lib)
* Bump ripple-binary-codec to 1.0.2
* Bump lodash to 4.17.19
The SHA-256 checksums for the browser version of this release can be found below.
```
% shasum -a 256 *
0895f349944fa11bb1976b2c350c0eb143dfd09abbfc7c2be33aed5c2a4b9ee8 ripple-latest-min.js
7c00188a28f9d295d8e66aa08b340294d2fe49f635d154fb0df049ae8572c195 ripple-latest.js
```
## 1.8.0 (2020-07-06)
* [Document `request('submit', ...)` method](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md#submit), which includes additional useful information in the response
* Update [list of applications using ripple-lib](https://github.com/ripple/ripple-lib/blob/1.7.0/APPLICATIONS.md)
## 1.7.1 (2020-05-26)
* Fix preparePayment when using source.amount/destination.minAmount (#1295) (Fix #1237) (Thanks to @leobel)
* Docs
* Fix generateXAddress example (#1286)
* Update Transaction Streams link (#1278)
* Dependencies
* Update assert-diff, mocha, webpack-bundle-analyzer, @typescript-eslint/parser, @typescript-eslint/eslint-plugin, @types/ws, @types/node, ws, ts-node, eventemitter2
## 1.7.0 (2020-04-28)
* Export hashing functions (#1275)
* Add failHard (fail_hard) option in `submit` method (#1029)
* Add type for parseAccountFlags (#1258)
* Add api.connection.getReserveBase() (#1259)
* Travis: remove node 8 (#1257)
* Dependencies
* Update ripple-address-codec, @types/ws, @types/lodash, https-proxy-agent
* Update devDependencies: eventemitter2, nyc, ejs, @types/node, webpack, ts-node, prettier, @typescript-eslint/eslint-plugin
## 1.6.5 (2020-03-23)
* APPLICATIONS.md: Add xrplorer.com
* Internal: Fix typos
* Dependencies
* Update @types/ws, @types/node, @typescript-eslint/eslint-plugin, @types/mocha, webpack, typescript, mocha, assert-diff
* Remove mocha-junit-reporter
## 1.6.4 (2020-02-18)
* Fix generateXAddress() and generateAddress() with no entropy (#1211, #1209)
* Internal
* Improve unit tests
* Dependencies
* Update webpack-cli, @types/node, webpack, @typescript-eslint/eslint-plugin,
typescript, ripple-keypairs
## 1.6.3 (2020-02-05)
* Update ripple-keypairs to 1.0.0
* Bug fix: Assign event listener to socket close event on open before attempting post-open logic (#1186)
* Protects against possible unhandled rejection in disconnect
* Adds the Connection `_ws.close` event listener post `_ws.open` before executing any post `_ws.open` logic, i.e. `Connection._subscribeToLedger`
* This prevents a reconnection error loop that occurs if `Connection._ws` is never cleaned up by the unreachable `_ws.close` event listener
* Also ensures that a possible disconnect() promise rejection is not unhandled if any `_ws.open` logic in `Connection.connect()` throws
* Dependencies
* Update mocha-junit-reporter, @types/node, mocha, @typescript-eslint/eslint-plugin, ripple-address-codec
## 1.6.2 (2020-01-17)
* Bug fix: Catch possible error in reconnect() on _heartbeat(), emit reconnect error (#1179)

View File

@@ -1,6 +1,6 @@
ISC License
Copyright (c) 2012-2015 Ripple Labs Inc.
Copyright (c) 2012-2021 Contributers to xrpl.js
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above

106
README.md
View File

@@ -1,12 +1,18 @@
# ripple-lib (RippleAPI)
# xrpl.js
A JavaScript/TypeScript API for interacting with the XRP Ledger
A JavaScript/TypeScript library for interacting with the XRP Ledger
[![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib)
[![NPM](https://nodei.co/npm/xrpl.png)](https://www.npmjs.org/package/xrpl)
This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.
**What is ripple-lib used for?** Here's a [list of applications](APPLICATIONS.md) that use `ripple-lib`. Open a PR to add your app or project to the list!
## [➡️ Reference Documentation](https://xrpl.org/rippleapi-reference.html)
See the full reference documentation on the XRP Ledger Dev Portal.
## [➡️ 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
@@ -18,14 +24,78 @@ This is the recommended library for integrating a JavaScript/TypeScript app with
### Requirements
+ **[Node v10](https://nodejs.org/)** is recommended. Other versions may work but are not frequently tested.
+ **[Yarn](https://yarnpkg.com/)** is recommended. `npm` may work but we use `yarn.lock`.
+ **[Node.js 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`.
### Install
## Getting Started
In an existing project (with `package.json`), install `ripple-lib`:
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`:
```
$ yarn add ripple-lib
$ npm install xrpl@beta
```
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 have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify).
1. Install dependencies (you can use `npm` as well):
```shell
npm install react-native-crypto
npm install xrpl@beta
# install peer deps
npm install react-native-randombytes
# install latest rn-nodeify
npm install rn-nodeify@latest --dev
```
2. After that, run the following command:
```shell
# install node core shims and recursively hack package.json files
# in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings
./node_modules/.bin/rn-nodeify --hack --install
```
3. Enable `crypto`:
`rn-nodeify` will create a `shim.js` file in the project root directory.
Open it and uncomment the line that requires the crypto module:
```javascript
// If using the crypto shim, uncomment the following line to ensure
// crypto is loaded first, so it can populate global.crypto
require('crypto')
```
4. Import `shim` in your project (it must be the first line):
```javascript
import './shim'
...
```
### Using xrpl.js with Deno
Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `xrpl.js` with Deno:
```javascript
import xrpl from 'https://dev.jspm.io/npm:xrpl';
(async () => {
const api = new (xrpl as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
const address = 'rH8NxV12EuV...khfJ5uw9kT';
api.connect().then(() => {
api.getBalances(address).then((balances: any) => {
console.log(JSON.stringify(balances, null, 2));
});
});
})();
```
## Documentation
@@ -36,7 +106,7 @@ $ yarn add ripple-lib
### Mailing Lists
We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)
We have a low-traffic mailing list for announcements of new xrpl.js releases. (About 1 email per week)
+ [Subscribe to ripple-lib-announce](https://groups.google.com/forum/#!forum/ripple-lib-announce)
@@ -48,7 +118,7 @@ If you're using the XRP Ledger in production, you should run a [rippled server](
To build the library for Node.js and the browser:
```
$ yarn build
$ npm run build
```
The TypeScript compiler will [output](./tsconfig.json#L7) the resulting JS files in `./dist/npm/`.
@@ -62,25 +132,19 @@ For details, see the `scripts` in `package.json`.
### Unit Tests
1. Clone the repository
2. `cd` into the repository and install dependencies with `yarn install`
3. `yarn test`
2. `cd` into the repository and install dependencies with `npm install`
3. `npm test`
### Linting
Run `yarn lint` to lint the code with `tslint`.
Run `npm run lint` to lint the code with `eslint`.
## Generating Documentation
Do not edit `./docs/index.md` directly because it is a generated file.
Instead, edit the appropriate `.md.ejs` files in `./docs/src/`.
If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running `yarn run docgen`.
Update the documentation by running `npm run docgen`.
## More Information
+ [ripple-lib-announce mailing list](https://groups.google.com/forum/#!forum/ripple-lib-announce) - subscribe for release announcements
+ [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal
+ [XRP Ledger Dev Portal](https://xrpl.org/)
[![Build Status](https://travis-ci.org/ripple/ripple-lib.svg?branch=master)](https://travis-ci.org/ripple/ripple-lib)

View File

@@ -2,10 +2,11 @@
## Supported Versions
This table shows which versions of ripple-lib are currently supported with security updates:
This table shows which versions of xrpl.js are currently supported with security updates:
| Version | Supported |
| ------- | ---------------------- |
| 2.x | :white_check_mark: Yes |
| 1.x | :white_check_mark: Yes |
| 0.x | :x: No |

View File

@@ -1,18 +0,0 @@
machine:
node:
version: 6.11.3
hosts:
testripple.circleci.com: 127.0.0.1
dependencies:
pre:
- wget https://s3-us-west-2.amazonaws.com/ripple-debs/rippled_0.30.1-b11-1.deb
- sudo dpkg -i rippled_0.30.1-b11-1.deb
test:
pre:
- rippled -a --start --conf "$HOME/$CIRCLE_PROJECT_REPONAME/test/integration/rippled.cfg":
background: true
override:
- scripts/ci.sh "$CIRCLE_NODE_INDEX" "$CIRCLE_NODE_TOTAL":
parallel: true
post:
- killall /usr/bin/rippled

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

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 480 B

Binary file not shown.

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

4476
docs/classes/Client.html Normal file

File diff suppressed because it is too large Load Diff

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

@@ -0,0 +1,630 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Wallet | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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, mnemnoic, or entropy (array of random numbers).
It provides functionality to sign/verify transactions offline.</p>
</div>
</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-private tsd-is-static"><a href="Wallet.html#defaultAlgorithm" class="tsd-kind-icon">default<wbr>Algorithm</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="Wallet.html#defaultDerivationPath" class="tsd-kind-icon">default<wbr>Derivation<wbr>Path</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="Wallet.html#getXAddress" class="tsd-kind-icon">getXAddress</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Wallet.html#signTransaction" class="tsd-kind-icon">sign<wbr>Transaction</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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="Wallet.html#hexFromBuffer" class="tsd-kind-icon">hex<wbr>From<wbr>Buffer</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L31">src/wallet/index.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>publicKey: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> seed: <span class="tsd-signature-type">string</span></h5>
</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L26">src/wallet/index.ts:26</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L25">src/wallet/index.ts:25</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L24">src/wallet/index.ts:24</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L27">src/wallet/index.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="defaultAlgorithm" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> default<wbr>Algorithm</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Algorithm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L28">src/wallet/index.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="defaultDerivationPath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> default<wbr>Derivation<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Derivation<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;m/44&#x27;/144&#x27;/0&#x27;/0/0&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L29">src/wallet/index.ts:29</a></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="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>, test<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L153">src/wallet/index.ts:153</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></h5>
<div class="tsd-comment tsd-typography">
<p>A tag to be included within the X-address.</p>
</div>
</li>
<li>
<h5>test: <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="signTransaction" class="tsd-anchor"></a>
<h3>sign<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sign<wbr>Transaction<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/SignOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SignOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SignedTransaction</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L126">src/wallet/index.ts:126</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signs a transaction offline.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transaction: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>A transaction to be signed offline.</p>
</div>
</li>
<li>
<h5>options: <a href="../interfaces/SignOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SignOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Options to include for signing.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SignedTransaction</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L139">src/wallet/index.ts:139</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L111">src/wallet/index.ts:111</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>seed: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>algorithm: <span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol"> = ...</span></h5>
</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 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">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span>, algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L95">src/wallet/index.ts:95</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">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L70">src/wallet/index.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derives a wallet from a mnemonic.</p>
</div>
</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L56">src/wallet/index.ts:56</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/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L44">src/wallet/index.ts:44</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 class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="hexFromBuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> hex<wbr>From<wbr>Buffer</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">hex<wbr>From<wbr>Buffer<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/wallet/index.ts#L107">src/wallet/index.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>buffer: <span class="tsd-signature-type">Buffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="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-private tsd-is-static">
<a href="Wallet.html#defaultAlgorithm" class="tsd-kind-icon">default<wbr>Algorithm</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="Wallet.html#defaultDerivationPath" class="tsd-kind-icon">default<wbr>Derivation<wbr>Path</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#signTransaction" class="tsd-kind-icon">sign<wbr>Transaction</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>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="Wallet.html#hexFromBuffer" class="tsd-kind-icon">hex<wbr>From<wbr>Buffer</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

622
docs/index.html Normal file
View File

@@ -0,0 +1,622 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>ripple-lib</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="#ripple-lib-rippleapi" id="ripple-lib-rippleapi" style="color: inherit; text-decoration: none;">
<h1>ripple-lib (RippleAPI)</h1>
</a>
<p>A JavaScript/TypeScript API for interacting with the XRP Ledger</p>
<p><a href="https://www.npmjs.org/package/ripple-lib"><img src="https://nodei.co/npm/ripple-lib.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="#➡️-reference-documentation" id="➡️-reference-documentation" style="color: inherit; text-decoration: none;">
<h2><a href="https://xrpl.org/rippleapi-reference.html">➡️ Reference Documentation</a></h2>
</a>
<p>See the full reference documentation on the XRP Ledger Dev Portal.</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 ripple-lib used for? The applications on the list linked above use <code>ripple-lib</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>ripple-lib</code>:</p>
<pre><code><span style="color: #001080">$</span><span style="color: #000000"> </span><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> </span><span style="color: #001080">ripple</span><span style="color: #000000">-</span><span style="color: #001080">lib</span>
</code></pre>
<p>Then see the <a href="#documentation">documentation</a>.</p>
<a href="#using-ripple-lib-with-react-native" id="using-ripple-lib-with-react-native" style="color: inherit; text-decoration: none;">
<h3>Using ripple-lib with React Native</h3>
</a>
<p>If you want to use <code>ripple-lib</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 ripple-lib</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-ripple-lib-with-deno" id="using-ripple-lib-with-deno" style="color: inherit; text-decoration: none;">
<h3>Using ripple-lib 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>ripple-lib</code> with Deno:</p>
<pre><code class="language-javascript"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">ripple</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:ripple-lib&#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">ripple</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">RippleAPI</span><span style="color: #000000">({ </span><span style="color: #001080">server:</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 ripple-lib releases. (About 1 email per week)</p>
<ul>
<li><a href="https://groups.google.com/forum/#!forum/ripple-lib-announce">Subscribe to ripple-lib-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/forum/#!forum/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><span style="color: #001080">$</span><span style="color: #000000"> </span><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">run</span><span style="color: #000000"> </span><span style="color: #001080">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>Do not edit <code>./docs/index.md</code> directly because it is a generated file.</p>
<p>Instead, edit the appropriate <code>.md.ejs</code> files in <code>./docs/src/</code>.</p>
<p>If you make changes to the JSON schemas, fixtures, or documentation sources, 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/forum/#!forum/ripple-lib-announce">ripple-lib-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>
<p> <a href="https://travis-ci.org/ripple/ripple-lib"><img src="https://travis-ci.org/ripple/ripple-lib.svg?branch=master" alt="Build Status"></a></p>
</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-reference">
<a href="modules.html#deriveXAddress" class="tsd-kind-icon">deriveXAddress</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/Wallet.html" class="tsd-kind-icon">Wallet</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/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/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/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/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/FormattedOrderCancellation.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FormattedOrderCancellationTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation<wbr>Transaction</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FormattedOrderTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Transaction</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FormattedPayment.html" class="tsd-kind-icon">Formatted<wbr>Payment</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FormattedPaymentTransaction.html" class="tsd-kind-icon">Formatted<wbr>Payment<wbr>Transaction</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FormattedSettingsTransaction.html" class="tsd-kind-icon">Formatted<wbr>Settings<wbr>Transaction</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FormattedTrustlineTransaction.html" class="tsd-kind-icon">Formatted<wbr>Trustline<wbr>Transaction</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/Instructions.html" class="tsd-kind-icon">Instructions</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/KeyPair.html" class="tsd-kind-icon">Key<wbr>Pair</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/Ledger.html" class="tsd-kind-icon">Ledger</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerClosedEvent.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Event</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/OfferCreateTransaction.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Transaction</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/Outcome.html" class="tsd-kind-icon">Outcome</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/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/Prepare.html" class="tsd-kind-icon">Prepare</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/SettingsTransaction.html" class="tsd-kind-icon">Settings<wbr>Transaction</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SignOptions.html" class="tsd-kind-icon">Sign<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/Submit.html" class="tsd-kind-icon">Submit</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/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/TransactionJSON.html" class="tsd-kind-icon">TransactionJSON</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/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#FormattedTransactionType" class="tsd-kind-icon">Formatted<wbr>Transaction<wbr>Type</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-property tsd-is-external">
<a href="modules.html#deriveAddress" class="tsd-kind-icon">derive<wbr>Address</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-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#computeAccountRootIndex" class="tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeBinaryTransactionHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeBinaryTransactionSigningHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeEscrowHash" class="tsd-kind-icon">compute<wbr>Escrow<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeLedgerHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeLedgerHeaderHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeOfferIndex" class="tsd-kind-icon">compute<wbr>Offer<wbr>Index</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computePaymentChannelHash" class="tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeSignerListIndex" class="tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeStateTreeHash" class="tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeTransactionHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeTransactionTreeHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#computeTrustlineHash" class="tsd-kind-icon">compute<wbr>Trustline<wbr>Hash</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#convertKeysFromSnakeCaseToCamelCase" class="tsd-kind-icon">convert<wbr>Keys<wbr>From<wbr>Snake<wbr>Case<wbr>ToCamel<wbr>Case</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">
<a href="modules.html#generateXAddress" class="tsd-kind-icon">generateXAddress</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-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#signPaymentChannelClaim" class="tsd-kind-icon">sign<wbr>Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#toRippledAmount" class="tsd-kind-icon">to<wbr>Rippled<wbr>Amount</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#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-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>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountChannelsRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountChannelsRequest.html">AccountChannelsRequest</a>
</li>
</ul>
<h1>Interface AccountChannelsRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountChannelsRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountChannelsRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountChannelsRequest.html#marker" class="tsd-kind-icon">marker</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L22">src/models/methods/accountChannels.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_channels&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L21">src/models/methods/accountChannels.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="destination_account" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> destination_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">destination_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L23">src/models/methods/accountChannels.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L24">src/models/methods/accountChannels.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L25">src/models/methods/accountChannels.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3>limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L26">src/models/methods/accountChannels.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="marker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3>
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L27">src/models/methods/accountChannels.ts:27</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountChannelsRequest.html" class="tsd-kind-icon">Account<wbr>Channels<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountChannelsRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountChannelsRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountChannelsRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountChannelsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountChannelsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountChannelsRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountChannelsRequest.html#marker" class="tsd-kind-icon">marker</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,345 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountChannelsResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountChannelsResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountChannelsResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountChannels.ts#L31">src/models/methods/accountChannels.ts:31</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>
</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>
</li>
<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>
<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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountChannelsResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountChannelsResponse.html#request" class="tsd-kind-icon">request</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-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,269 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountCurrenciesRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountCurrenciesRequest.html">AccountCurrenciesRequest</a>
</li>
</ul>
<h1>Interface AccountCurrenciesRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountCurrenciesRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountCurrenciesRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountCurrenciesRequest.html#strict" class="tsd-kind-icon">strict</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L7">src/models/methods/accountCurrencies.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_currencies&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L6">src/models/methods/accountCurrencies.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="destination_account" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> destination_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">destination_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L8">src/models/methods/accountCurrencies.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L9">src/models/methods/accountCurrencies.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L10">src/models/methods/accountCurrencies.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="strict" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L11">src/models/methods/accountCurrencies.ts:11</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountCurrenciesRequest.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountCurrenciesRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountCurrenciesRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountCurrenciesRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountCurrenciesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountCurrenciesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountCurrenciesRequest.html#strict" class="tsd-kind-icon">strict</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,339 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountCurrenciesResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountCurrenciesResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountCurrenciesResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountCurrencies.ts#L15">src/models/methods/accountCurrencies.ts:15</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>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</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>
</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>
</li>
<li class="tsd-parameter">
<h5>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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountCurrenciesResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountCurrenciesResponse.html#request" class="tsd-kind-icon">request</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-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,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountInfoRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountInfoRequest.html">AccountInfoRequest</a>
</li>
</ul>
<h1>Interface AccountInfoRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountInfoRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountInfoRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#queue" class="tsd-kind-icon">queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#signer_lists" class="tsd-kind-icon">signer_<wbr>lists</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountInfoRequest.html#strict" class="tsd-kind-icon">strict</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L8">src/models/methods/accountInfo.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_info&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L7">src/models/methods/accountInfo.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L9">src/models/methods/accountInfo.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L10">src/models/methods/accountInfo.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="queue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> queue</h3>
<div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L11">src/models/methods/accountInfo.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="signer_lists" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> signer_<wbr>lists</h3>
<div class="tsd-signature tsd-kind-icon">signer_<wbr>lists<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L12">src/models/methods/accountInfo.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="strict" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L13">src/models/methods/accountInfo.ts:13</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountInfoRequest.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountInfoRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountInfoRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountInfoRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountInfoRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountInfoRequest.html#queue" class="tsd-kind-icon">queue</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountInfoRequest.html#signer_lists" class="tsd-kind-icon">signer_<wbr>lists</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountInfoRequest.html#strict" class="tsd-kind-icon">strict</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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>AccountInfoResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountInfoResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountInfoResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountInfo.ts#L34">src/models/methods/accountInfo.ts:34</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>
</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>
</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>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountInfoResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountInfoResponse.html#request" class="tsd-kind-icon">request</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-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,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountLinesRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountLinesRequest.html">AccountLinesRequest</a>
</li>
</ul>
<h1>Interface AccountLinesRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountLinesRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountLinesRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#marker" class="tsd-kind-icon">marker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountLinesRequest.html#peer" class="tsd-kind-icon">peer</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L23">src/models/methods/accountLines.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_lines&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L22">src/models/methods/accountLines.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L24">src/models/methods/accountLines.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L25">src/models/methods/accountLines.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L27">src/models/methods/accountLines.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="marker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3>
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L28">src/models/methods/accountLines.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="peer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> peer</h3>
<div class="tsd-signature tsd-kind-icon">peer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L26">src/models/methods/accountLines.ts:26</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountLinesRequest.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountLinesRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountLinesRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountLinesRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountLinesRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountLinesRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountLinesRequest.html#marker" class="tsd-kind-icon">marker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountLinesRequest.html#peer" class="tsd-kind-icon">peer</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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 | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountLinesResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountLinesResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountLines.ts#L32">src/models/methods/accountLines.ts:32</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>
</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>
</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>
</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>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountLinesResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountLinesResponse.html#request" class="tsd-kind-icon">request</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-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>AccountObjectsRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountObjectsRequest.html">AccountObjectsRequest</a>
</li>
</ul>
<h1>Interface AccountObjectsRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountObjectsRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountObjectsRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#deletion_blockers_only" class="tsd-kind-icon">deletion_<wbr>blockers_<wbr>only</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#marker" class="tsd-kind-icon">marker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountObjectsRequest.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L17">src/models/methods/accountObjects.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_objects&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L16">src/models/methods/accountObjects.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="deletion_blockers_only" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> deletion_<wbr>blockers_<wbr>only</h3>
<div class="tsd-signature tsd-kind-icon">deletion_<wbr>blockers_<wbr>only<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L19">src/models/methods/accountObjects.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L20">src/models/methods/accountObjects.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L21">src/models/methods/accountObjects.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L22">src/models/methods/accountObjects.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="marker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3>
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L23">src/models/methods/accountObjects.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AccountObjectType</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L18">src/models/methods/accountObjects.ts:18</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountObjectsRequest.html" class="tsd-kind-icon">Account<wbr>Objects<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountObjectsRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#deletion_blockers_only" class="tsd-kind-icon">deletion_<wbr>blockers_<wbr>only</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#marker" class="tsd-kind-icon">marker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountObjectsRequest.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,348 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountObjectsResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountObjectsResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountObjectsResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountObjects.ts#L37">src/models/methods/accountObjects.ts:37</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>
</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>
</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>
</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>
</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>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountObjectsResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountObjectsResponse.html#request" class="tsd-kind-icon">request</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-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,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountOffersRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountOffersRequest.html">AccountOffersRequest</a>
</li>
</ul>
<h1>Interface AccountOffersRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountOffersRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountOffersRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#marker" class="tsd-kind-icon">marker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountOffersRequest.html#strict" class="tsd-kind-icon">strict</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L7">src/models/methods/accountOffers.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_offers&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L6">src/models/methods/accountOffers.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L8">src/models/methods/accountOffers.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L9">src/models/methods/accountOffers.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L10">src/models/methods/accountOffers.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="marker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3>
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L11">src/models/methods/accountOffers.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="strict" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L12">src/models/methods/accountOffers.ts:12</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountOffersRequest.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountOffersRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountOffersRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountOffersRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountOffersRequest.html#marker" class="tsd-kind-icon">marker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountOffersRequest.html#strict" class="tsd-kind-icon">strict</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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 | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountOffersResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L25">src/models/methods/accountOffers.ts:25</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>
</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>
</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>
</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>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountOffersResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountOffersResponse.html#request" class="tsd-kind-icon">request</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-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>AccountTxRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="AccountTxRequest.html">AccountTxRequest</a>
</li>
</ul>
<h1>Interface AccountTxRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AccountTxRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#account" class="tsd-kind-icon">account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#binary" class="tsd-kind-icon">binary</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountTxRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index_max" class="tsd-kind-icon">ledger_<wbr>index_<wbr>max</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#ledger_index_min" class="tsd-kind-icon">ledger_<wbr>index_<wbr>min</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="AccountTxRequest.html#marker" class="tsd-kind-icon">marker</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account" class="tsd-anchor"></a>
<h3>account</h3>
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L9">src/models/methods/accountTx.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="binary" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3>
<div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L14">src/models/methods/accountTx.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;account_tx&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L8">src/models/methods/accountTx.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="forward" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forward</h3>
<div class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L15">src/models/methods/accountTx.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L12">src/models/methods/accountTx.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L13">src/models/methods/accountTx.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index_max" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index_<wbr>max</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index_<wbr>max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L11">src/models/methods/accountTx.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index_min" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index_<wbr>min</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index_<wbr>min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L10">src/models/methods/accountTx.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L16">src/models/methods/accountTx.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="marker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3>
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L17">src/models/methods/accountTx.ts:17</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="AccountTxRequest.html" class="tsd-kind-icon">Account<wbr>TxRequest</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#account" class="tsd-kind-icon">account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#binary" class="tsd-kind-icon">binary</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="AccountTxRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#ledger_index_max" class="tsd-kind-icon">ledger_<wbr>index_<wbr>max</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#ledger_index_min" class="tsd-kind-icon">ledger_<wbr>index_<wbr>min</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="AccountTxRequest.html#marker" class="tsd-kind-icon">marker</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,345 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountTxResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountTxResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="AccountTxResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountTx.ts#L29">src/models/methods/accountTx.ts:29</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>
</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>
</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>
</li>
<li class="tsd-parameter">
<h5>limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="AccountTxResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="AccountTxResponse.html#request" class="tsd-kind-icon">request</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-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,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BookOffersRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="BookOffersRequest.html">BookOffersRequest</a>
</li>
</ul>
<h1>Interface BookOffersRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">BookOffersRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="BookOffersRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker" class="tsd-kind-icon">taker</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_gets" class="tsd-kind-icon">taker_<wbr>gets</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_pays" class="tsd-kind-icon">taker_<wbr>pays</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;book_offers&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L12">src/models/methods/bookOffers.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L13">src/models/methods/bookOffers.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L14">src/models/methods/bookOffers.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L15">src/models/methods/bookOffers.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="taker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> taker</h3>
<div class="tsd-signature tsd-kind-icon">taker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L16">src/models/methods/bookOffers.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="taker_gets" class="tsd-anchor"></a>
<h3>taker_<wbr>gets</h3>
<div class="tsd-signature tsd-kind-icon">taker_<wbr>gets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TakerAmount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L17">src/models/methods/bookOffers.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="taker_pays" class="tsd-anchor"></a>
<h3>taker_<wbr>pays</h3>
<div class="tsd-signature tsd-kind-icon">taker_<wbr>pays<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TakerAmount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L18">src/models/methods/bookOffers.ts:18</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="BookOffersRequest.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="BookOffersRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="BookOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="BookOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="BookOffersRequest.html#limit" class="tsd-kind-icon">limit</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="BookOffersRequest.html#taker" class="tsd-kind-icon">taker</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="BookOffersRequest.html#taker_gets" class="tsd-kind-icon">taker_<wbr>gets</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="BookOffersRequest.html#taker_pays" class="tsd-kind-icon">taker_<wbr>pays</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,336 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BookOffersResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="BookOffersResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/bookOffers.ts#L29">src/models/methods/bookOffers.ts:29</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>
</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>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="BookOffersResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="BookOffersResponse.html#request" class="tsd-kind-icon">request</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-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,255 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ChannelVerifyRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="ChannelVerifyRequest.html">ChannelVerifyRequest</a>
</li>
</ul>
<h1>Interface ChannelVerifyRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ChannelVerifyRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#amount" class="tsd-kind-icon">amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#channel_id" class="tsd-kind-icon">channel_<wbr>id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ChannelVerifyRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#public_key" class="tsd-kind-icon">public_<wbr>key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ChannelVerifyRequest.html#signature" class="tsd-kind-icon">signature</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="amount" class="tsd-anchor"></a>
<h3>amount</h3>
<div class="tsd-signature tsd-kind-icon">amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/channelVerify.ts#L5">src/models/methods/channelVerify.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="channel_id" class="tsd-anchor"></a>
<h3>channel_<wbr>id</h3>
<div class="tsd-signature tsd-kind-icon">channel_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/channelVerify.ts#L6">src/models/methods/channelVerify.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;channel_verify&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/channelVerify.ts#L4">src/models/methods/channelVerify.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="public_key" class="tsd-anchor"></a>
<h3>public_<wbr>key</h3>
<div class="tsd-signature tsd-kind-icon">public_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/channelVerify.ts#L7">src/models/methods/channelVerify.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="signature" class="tsd-anchor"></a>
<h3>signature</h3>
<div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/channelVerify.ts#L8">src/models/methods/channelVerify.ts:8</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ChannelVerifyRequest.html" class="tsd-kind-icon">Channel<wbr>Verify<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ChannelVerifyRequest.html#amount" class="tsd-kind-icon">amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ChannelVerifyRequest.html#channel_id" class="tsd-kind-icon">channel_<wbr>id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="ChannelVerifyRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ChannelVerifyRequest.html#public_key" class="tsd-kind-icon">public_<wbr>key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ChannelVerifyRequest.html#signature" class="tsd-kind-icon">signature</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,327 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ChannelVerifyResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ChannelVerifyResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="ChannelVerifyResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/channelVerify.ts#L12">src/models/methods/channelVerify.ts:12</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ChannelVerifyResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="ChannelVerifyResponse.html#request" class="tsd-kind-icon">request</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-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,183 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ConsensusStream | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="ConsensusStream.html">ConsensusStream</a>
</li>
</ul>
<h1>Interface ConsensusStream</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseStream</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ConsensusStream</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConsensusStream.html#consensus" class="tsd-kind-icon">consensus</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ConsensusStream.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="consensus" class="tsd-anchor"></a>
<h3>consensus</h3>
<div class="tsd-signature tsd-kind-icon">consensus<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;open&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;establish&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;accepted&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L111">src/models/methods/subscribe.ts:111</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;consensusPhase&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L110">src/models/methods/subscribe.ts:110</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ConsensusStream.html" class="tsd-kind-icon">Consensus<wbr>Stream</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ConsensusStream.html#consensus" class="tsd-kind-icon">consensus</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="ConsensusStream.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,255 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DepositAuthorizedRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="DepositAuthorizedRequest.html">DepositAuthorizedRequest</a>
</li>
</ul>
<h1>Interface DepositAuthorizedRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DepositAuthorizedRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="DepositAuthorizedRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DepositAuthorizedRequest.html#source_account" class="tsd-kind-icon">source_<wbr>account</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;deposit_authorized&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/depositAuthorized.ts#L6">src/models/methods/depositAuthorized.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="destination_account" class="tsd-anchor"></a>
<h3>destination_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">destination_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/depositAuthorized.ts#L8">src/models/methods/depositAuthorized.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/depositAuthorized.ts#L9">src/models/methods/depositAuthorized.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/depositAuthorized.ts#L10">src/models/methods/depositAuthorized.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="source_account" class="tsd-anchor"></a>
<h3>source_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">source_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/depositAuthorized.ts#L7">src/models/methods/depositAuthorized.ts:7</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="DepositAuthorizedRequest.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="DepositAuthorizedRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DepositAuthorizedRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DepositAuthorizedRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DepositAuthorizedRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DepositAuthorizedRequest.html#source_account" class="tsd-kind-icon">source_<wbr>account</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,345 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DepositAuthorizedResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DepositAuthorizedResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="DepositAuthorizedResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/depositAuthorized.ts#L14">src/models/methods/depositAuthorized.ts:14</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>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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>
</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>
</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>
</li>
<li class="tsd-parameter">
<h5>source_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DepositAuthorizedResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="DepositAuthorizedResponse.html#request" class="tsd-kind-icon">request</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-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>FeeRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FeeRequest.html">FeeRequest</a>
</li>
</ul>
<h1>Interface FeeRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FeeRequest</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="FeeRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeRequest.html#id" class="tsd-kind-icon">id</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fee&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/fee.ts#L4">src/models/methods/fee.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="FeeRequest.html" class="tsd-kind-icon">Fee<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeRequest.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="FeeRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeRequest.html#id" class="tsd-kind-icon">id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,373 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FeeResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="FeeResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="FeeResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/fee.ts#L8">src/models/methods/fee.ts:8</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>
</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>
</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>
</li>
<li class="tsd-parameter">
<h5>median_<wbr>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>minimum_<wbr>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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>
</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>
</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>
</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>
</li>
<li class="tsd-parameter">
<h5>minimum_<wbr>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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>
</li>
<li class="tsd-parameter">
<h5>reference_<wbr>level<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="FeeResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="FeeResponse.html#request" class="tsd-kind-icon">request</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-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,163 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedOrderCancellation | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedOrderCancellation.html">FormattedOrderCancellation</a>
</li>
</ul>
<h1>Interface FormattedOrderCancellation</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedOrderCancellation</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellation.html#orderSequence" class="tsd-kind-icon">order<wbr>Sequence</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="orderSequence" class="tsd-anchor"></a>
<h3>order<wbr>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">order<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L100">src/transaction/types.ts:100</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="FormattedOrderCancellation.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellation.html#orderSequence" class="tsd-kind-icon">order<wbr>Sequence</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,233 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedOrderCancellationTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedOrderCancellationTransaction.html">FormattedOrderCancellationTransaction</a>
</li>
</ul>
<h1>Interface FormattedOrderCancellationTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedOrderCancellationTransaction</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderCancellationTransaction.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L137">src/transaction/types.ts:137</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L136">src/transaction/types.ts:136</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="outcome" class="tsd-anchor"></a>
<h3>outcome</h3>
<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L135">src/transaction/types.ts:135</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sequence" class="tsd-anchor"></a>
<h3>sequence</h3>
<div class="tsd-signature tsd-kind-icon">sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L138">src/transaction/types.ts:138</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="specification" class="tsd-anchor"></a>
<h3>specification</h3>
<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <a href="FormattedOrderCancellation.html" class="tsd-signature-type" data-tsd-kind="Interface">FormattedOrderCancellation</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L134">src/transaction/types.ts:134</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L133">src/transaction/types.ts:133</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="FormattedOrderCancellationTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellationTransaction.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellationTransaction.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellationTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellationTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellationTransaction.html#specification" class="tsd-kind-icon">specification</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderCancellationTransaction.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,233 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedOrderTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedOrderTransaction.html">FormattedOrderTransaction</a>
</li>
</ul>
<h1>Interface FormattedOrderTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedOrderTransaction</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedOrderTransaction.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L128">src/transaction/types.ts:128</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L127">src/transaction/types.ts:127</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="outcome" class="tsd-anchor"></a>
<h3>outcome</h3>
<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L126">src/transaction/types.ts:126</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sequence" class="tsd-anchor"></a>
<h3>sequence</h3>
<div class="tsd-signature tsd-kind-icon">sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L129">src/transaction/types.ts:129</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="specification" class="tsd-anchor"></a>
<h3>specification</h3>
<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FormattedOrderSpecification</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L125">src/transaction/types.ts:125</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L124">src/transaction/types.ts:124</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="FormattedOrderTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderTransaction.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderTransaction.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderTransaction.html#specification" class="tsd-kind-icon">specification</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedOrderTransaction.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,261 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedPayment | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedPayment.html">FormattedPayment</a>
</li>
</ul>
<h1>Interface FormattedPayment</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedPayment</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#allowPartialPayment" class="tsd-kind-icon">allow<wbr>Partial<wbr>Payment</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#destination" class="tsd-kind-icon">destination</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#invoiceID" class="tsd-kind-icon">invoiceID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#limitQuality" class="tsd-kind-icon">limit<wbr>Quality</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#memos" class="tsd-kind-icon">memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#noDirectRipple" class="tsd-kind-icon">no<wbr>Direct<wbr>Ripple</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#paths" class="tsd-kind-icon">paths</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPayment.html#source" class="tsd-kind-icon">source</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="allowPartialPayment" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Partial<wbr>Payment</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Partial<wbr>Payment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L109">src/transaction/types.ts:109</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="destination" class="tsd-anchor"></a>
<h3>destination</h3>
<div class="tsd-signature tsd-kind-icon">destination<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Adjustment</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L105">src/transaction/types.ts:105</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="invoiceID" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> invoiceID</h3>
<div class="tsd-signature tsd-kind-icon">invoiceID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L108">src/transaction/types.ts:108</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limitQuality" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit<wbr>Quality</h3>
<div class="tsd-signature tsd-kind-icon">limit<wbr>Quality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L111">src/transaction/types.ts:111</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="memos" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> memos</h3>
<div class="tsd-signature tsd-kind-icon">memos<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L107">src/transaction/types.ts:107</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="noDirectRipple" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> no<wbr>Direct<wbr>Ripple</h3>
<div class="tsd-signature tsd-kind-icon">no<wbr>Direct<wbr>Ripple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L110">src/transaction/types.ts:110</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="paths" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L106">src/transaction/types.ts:106</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="source" class="tsd-anchor"></a>
<h3>source</h3>
<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Adjustment</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L104">src/transaction/types.ts:104</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="FormattedPayment.html" class="tsd-kind-icon">Formatted<wbr>Payment</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#allowPartialPayment" class="tsd-kind-icon">allow<wbr>Partial<wbr>Payment</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#destination" class="tsd-kind-icon">destination</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#invoiceID" class="tsd-kind-icon">invoiceID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#limitQuality" class="tsd-kind-icon">limit<wbr>Quality</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#memos" class="tsd-kind-icon">memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#noDirectRipple" class="tsd-kind-icon">no<wbr>Direct<wbr>Ripple</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#paths" class="tsd-kind-icon">paths</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPayment.html#source" class="tsd-kind-icon">source</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,233 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedPaymentTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedPaymentTransaction.html">FormattedPaymentTransaction</a>
</li>
</ul>
<h1>Interface FormattedPaymentTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedPaymentTransaction</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="FormattedPaymentTransaction.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPaymentTransaction.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPaymentTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPaymentTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPaymentTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedPaymentTransaction.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L119">src/transaction/types.ts:119</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L118">src/transaction/types.ts:118</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="outcome" class="tsd-anchor"></a>
<h3>outcome</h3>
<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L117">src/transaction/types.ts:117</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sequence" class="tsd-anchor"></a>
<h3>sequence</h3>
<div class="tsd-signature tsd-kind-icon">sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L120">src/transaction/types.ts:120</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="specification" class="tsd-anchor"></a>
<h3>specification</h3>
<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <a href="FormattedPayment.html" class="tsd-signature-type" data-tsd-kind="Interface">FormattedPayment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L116">src/transaction/types.ts:116</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L115">src/transaction/types.ts:115</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="FormattedPaymentTransaction.html" class="tsd-kind-icon">Formatted<wbr>Payment<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPaymentTransaction.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPaymentTransaction.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPaymentTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPaymentTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPaymentTransaction.html#specification" class="tsd-kind-icon">specification</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedPaymentTransaction.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,233 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedSettingsTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedSettingsTransaction.html">FormattedSettingsTransaction</a>
</li>
</ul>
<h1>Interface FormattedSettingsTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedSettingsTransaction</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="FormattedSettingsTransaction.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedSettingsTransaction.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedSettingsTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedSettingsTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedSettingsTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedSettingsTransaction.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L155">src/transaction/types.ts:155</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L154">src/transaction/types.ts:154</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="outcome" class="tsd-anchor"></a>
<h3>outcome</h3>
<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L153">src/transaction/types.ts:153</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sequence" class="tsd-anchor"></a>
<h3>sequence</h3>
<div class="tsd-signature tsd-kind-icon">sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L156">src/transaction/types.ts:156</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="specification" class="tsd-anchor"></a>
<h3>specification</h3>
<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FormattedSettings</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L152">src/transaction/types.ts:152</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L151">src/transaction/types.ts:151</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="FormattedSettingsTransaction.html" class="tsd-kind-icon">Formatted<wbr>Settings<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedSettingsTransaction.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedSettingsTransaction.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedSettingsTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedSettingsTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedSettingsTransaction.html#specification" class="tsd-kind-icon">specification</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedSettingsTransaction.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,233 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FormattedTrustlineTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="FormattedTrustlineTransaction.html">FormattedTrustlineTransaction</a>
</li>
</ul>
<h1>Interface FormattedTrustlineTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FormattedTrustlineTransaction</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="FormattedTrustlineTransaction.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedTrustlineTransaction.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedTrustlineTransaction.html#outcome" class="tsd-kind-icon">outcome</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedTrustlineTransaction.html#sequence" class="tsd-kind-icon">sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedTrustlineTransaction.html#specification" class="tsd-kind-icon">specification</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="FormattedTrustlineTransaction.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="address" class="tsd-anchor"></a>
<h3>address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L146">src/transaction/types.ts:146</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L145">src/transaction/types.ts:145</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="outcome" class="tsd-anchor"></a>
<h3>outcome</h3>
<div class="tsd-signature tsd-kind-icon">outcome<span class="tsd-signature-symbol">:</span> <a href="Outcome.html" class="tsd-signature-type" data-tsd-kind="Interface">Outcome</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L144">src/transaction/types.ts:144</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sequence" class="tsd-anchor"></a>
<h3>sequence</h3>
<div class="tsd-signature tsd-kind-icon">sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L147">src/transaction/types.ts:147</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="specification" class="tsd-anchor"></a>
<h3>specification</h3>
<div class="tsd-signature tsd-kind-icon">specification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FormattedTrustlineSpecification</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L143">src/transaction/types.ts:143</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L142">src/transaction/types.ts:142</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="FormattedTrustlineTransaction.html" class="tsd-kind-icon">Formatted<wbr>Trustline<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedTrustlineTransaction.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedTrustlineTransaction.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedTrustlineTransaction.html#outcome" class="tsd-kind-icon">outcome</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedTrustlineTransaction.html#sequence" class="tsd-kind-icon">sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedTrustlineTransaction.html#specification" class="tsd-kind-icon">specification</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="FormattedTrustlineTransaction.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,269 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>GatewayBalancesRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L7">src/models/methods/gatewayBalances.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;gateway_balances&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L6">src/models/methods/gatewayBalances.ts:6</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>hotwallet</h3>
<div class="tsd-signature tsd-kind-icon">hotwallet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L9">src/models/methods/gatewayBalances.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L10">src/models/methods/gatewayBalances.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L11">src/models/methods/gatewayBalances.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="strict" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L8">src/models/methods/gatewayBalances.ts:8</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="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-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>GatewayBalancesResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="GatewayBalancesResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="GatewayBalancesResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/gatewayBalances.ts#L20">src/models/methods/gatewayBalances.ts:20</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>
</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>
<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>
<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>
</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>
</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>
</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>
<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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="GatewayBalancesResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="GatewayBalancesResponse.html#request" class="tsd-kind-icon">request</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-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,247 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Instructions | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="Instructions.html">Instructions</a>
</li>
</ul>
<h1>Interface Instructions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Instructions</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="Instructions.html#fee" class="tsd-kind-icon">fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Instructions.html#maxFee" class="tsd-kind-icon">max<wbr>Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Instructions.html#maxLedgerVersion" class="tsd-kind-icon">max<wbr>Ledger<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Instructions.html#maxLedgerVersionOffset" class="tsd-kind-icon">max<wbr>Ledger<wbr>Version<wbr>Offset</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Instructions.html#sequence" class="tsd-kind-icon">sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Instructions.html#signersCount" class="tsd-kind-icon">signers<wbr>Count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Instructions.html#ticketSequence" class="tsd-kind-icon">ticket<wbr>Sequence</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L24">src/transaction/types.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="maxFee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Fee</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L26">src/transaction/types.ts:26</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="maxLedgerVersion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Ledger<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Ledger<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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L27">src/transaction/types.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="maxLedgerVersionOffset" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Ledger<wbr>Version<wbr>Offset</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Ledger<wbr>Version<wbr>Offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L28">src/transaction/types.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sequence" class="tsd-anchor"></a>
<h3><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">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L22">src/transaction/types.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="signersCount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> signers<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">signers<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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L29">src/transaction/types.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L23">src/transaction/types.ts:23</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="Instructions.html" class="tsd-kind-icon">Instructions</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#fee" class="tsd-kind-icon">fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#maxFee" class="tsd-kind-icon">max<wbr>Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#maxLedgerVersion" class="tsd-kind-icon">max<wbr>Ledger<wbr>Version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#maxLedgerVersionOffset" class="tsd-kind-icon">max<wbr>Ledger<wbr>Version<wbr>Offset</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#sequence" class="tsd-kind-icon">sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#signersCount" class="tsd-kind-icon">signers<wbr>Count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Instructions.html#ticketSequence" class="tsd-kind-icon">ticket<wbr>Sequence</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,177 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>KeyPair | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="KeyPair.html">KeyPair</a>
</li>
</ul>
<h1>Interface KeyPair</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">KeyPair</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="KeyPair.html#privateKey" class="tsd-kind-icon">private<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="KeyPair.html#publicKey" 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">
<a name="privateKey" class="tsd-anchor"></a>
<h3>private<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L71">src/transaction/types.ts:71</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="publicKey" class="tsd-anchor"></a>
<h3>public<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L70">src/transaction/types.ts:70</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="KeyPair.html" class="tsd-kind-icon">Key<wbr>Pair</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="KeyPair.html#privateKey" class="tsd-kind-icon">private<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="KeyPair.html#publicKey" 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-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>

359
docs/interfaces/Ledger.html Normal file
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>Ledger | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="Ledger.html">Ledger</a>
</li>
</ul>
<h1>Interface Ledger</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Ledger</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="Ledger.html#accountState" class="tsd-kind-icon">account<wbr>State</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#account_hash" class="tsd-kind-icon">account_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#close_flags" class="tsd-kind-icon">close_<wbr>flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#close_time" class="tsd-kind-icon">close_<wbr>time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#close_time_human" class="tsd-kind-icon">close_<wbr>time_<wbr>human</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#close_time_resolution" class="tsd-kind-icon">close_<wbr>time_<wbr>resolution</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#closed" class="tsd-kind-icon">closed</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#parent_close_time" class="tsd-kind-icon">parent_<wbr>close_<wbr>time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#parent_hash" class="tsd-kind-icon">parent_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#total_coins" class="tsd-kind-icon">total_<wbr>coins</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#transaction_hash" class="tsd-kind-icon">transaction_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.html#transactions" class="tsd-kind-icon">transactions</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ledger.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="accountState" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> account<wbr>State</h3>
<div class="tsd-signature tsd-kind-icon">account<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L15">src/common/types/objects/ledger.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="account_hash" class="tsd-anchor"></a>
<h3>account_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">account_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L2">src/common/types/objects/ledger.ts:2</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="close_flags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> close_<wbr>flags</h3>
<div class="tsd-signature tsd-kind-icon">close_<wbr>flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L13">src/common/types/objects/ledger.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="close_time" class="tsd-anchor"></a>
<h3>close_<wbr>time</h3>
<div class="tsd-signature tsd-kind-icon">close_<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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L3">src/common/types/objects/ledger.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="close_time_human" class="tsd-anchor"></a>
<h3>close_<wbr>time_<wbr>human</h3>
<div class="tsd-signature tsd-kind-icon">close_<wbr>time_<wbr>human<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L4">src/common/types/objects/ledger.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="close_time_resolution" class="tsd-anchor"></a>
<h3>close_<wbr>time_<wbr>resolution</h3>
<div class="tsd-signature tsd-kind-icon">close_<wbr>time_<wbr>resolution<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L5">src/common/types/objects/ledger.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="closed" class="tsd-anchor"></a>
<h3>closed</h3>
<div class="tsd-signature tsd-kind-icon">closed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L6">src/common/types/objects/ledger.ts:6</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>ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L7">src/common/types/objects/ledger.ts:7</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>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">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L8">src/common/types/objects/ledger.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_close_time" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> parent_<wbr>close_<wbr>time</h3>
<div class="tsd-signature tsd-kind-icon">parent_<wbr>close_<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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L14">src/common/types/objects/ledger.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_hash" class="tsd-anchor"></a>
<h3>parent_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">parent_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L9">src/common/types/objects/ledger.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="total_coins" class="tsd-anchor"></a>
<h3>total_<wbr>coins</h3>
<div class="tsd-signature tsd-kind-icon">total_<wbr>coins<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L10">src/common/types/objects/ledger.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transaction_hash" class="tsd-anchor"></a>
<h3>transaction_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">transaction_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L11">src/common/types/objects/ledger.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transactions" class="tsd-anchor"></a>
<h3>transactions</h3>
<div class="tsd-signature tsd-kind-icon">transactions<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">object</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L12">src/common/types/objects/ledger.ts:12</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><span class="tsd-flag ts-flagOptional">Optional</span> 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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L16">src/common/types/objects/ledger.ts:16</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="Ledger.html" class="tsd-kind-icon">Ledger</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#accountState" class="tsd-kind-icon">account<wbr>State</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#account_hash" class="tsd-kind-icon">account_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#close_flags" class="tsd-kind-icon">close_<wbr>flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#close_time" class="tsd-kind-icon">close_<wbr>time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#close_time_human" class="tsd-kind-icon">close_<wbr>time_<wbr>human</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#close_time_resolution" class="tsd-kind-icon">close_<wbr>time_<wbr>resolution</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#closed" class="tsd-kind-icon">closed</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#parent_close_time" class="tsd-kind-icon">parent_<wbr>close_<wbr>time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#parent_hash" class="tsd-kind-icon">parent_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#total_coins" class="tsd-kind-icon">total_<wbr>coins</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#transaction_hash" class="tsd-kind-icon">transaction_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.html#transactions" class="tsd-kind-icon">transactions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Ledger.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-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,289 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerClosedEvent | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="LedgerClosedEvent.html">LedgerClosedEvent</a>
</li>
</ul>
<h1>Interface LedgerClosedEvent</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">LedgerClosedEvent</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="LedgerClosedEvent.html#fee_base" class="tsd-kind-icon">fee_<wbr>base</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#fee_ref" class="tsd-kind-icon">fee_<wbr>ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#ledger_time" class="tsd-kind-icon">ledger_<wbr>time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#txn_count" class="tsd-kind-icon">txn_<wbr>count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerClosedEvent.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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L22">src/common/types/objects/ledger.ts:22</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L23">src/common/types/objects/ledger.ts:23</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>ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L24">src/common/types/objects/ledger.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3>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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L25">src/common/types/objects/ledger.ts:25</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L26">src/common/types/objects/ledger.ts:26</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L27">src/common/types/objects/ledger.ts:27</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L28">src/common/types/objects/ledger.ts:28</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L29">src/common/types/objects/ledger.ts:29</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">&quot;ledgerClosed&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L21">src/common/types/objects/ledger.ts:21</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>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/ripple/ripple-lib/blob/0c571f2e/src/common/types/objects/ledger.ts#L30">src/common/types/objects/ledger.ts:30</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="LedgerClosedEvent.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Event</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#fee_base" class="tsd-kind-icon">fee_<wbr>base</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#fee_ref" class="tsd-kind-icon">fee_<wbr>ref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#ledger_time" class="tsd-kind-icon">ledger_<wbr>time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#txn_count" class="tsd-kind-icon">txn_<wbr>count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="LedgerClosedEvent.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-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>LedgerClosedRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledger_closed&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerClosed.ts#L4">src/models/methods/ledgerClosed.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="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-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,330 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerClosedResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerClosedResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="LedgerClosedResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerClosed.ts#L8">src/models/methods/ledgerClosed.ts:8</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerClosedResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="LedgerClosedResponse.html#request" class="tsd-kind-icon">request</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-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>LedgerCurrentRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledger_current&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerCurrent.ts#L4">src/models/methods/ledgerCurrent.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="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-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,327 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerCurrentResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerCurrentResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="LedgerCurrentResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerCurrent.ts#L8">src/models/methods/ledgerCurrent.ts:8</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerCurrentResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="LedgerCurrentResponse.html#request" class="tsd-kind-icon">request</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-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,269 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerDataRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="binary" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3>
<div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L10">src/models/methods/ledgerData.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledger_data&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L7">src/models/methods/ledgerData.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L8">src/models/methods/ledgerData.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L9">src/models/methods/ledgerData.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="limit" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> limit</h3>
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L11">src/models/methods/ledgerData.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="marker" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> marker</h3>
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L12">src/models/methods/ledgerData.ts:12</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="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-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,336 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerDataResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerDataResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="LedgerDataResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerData.ts#L24">src/models/methods/ledgerData.ts:24</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>
<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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerDataResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="LedgerDataResponse.html#request" class="tsd-kind-icon">request</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-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,392 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerEntryRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L17">src/models/methods/ledgerEntry.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="binary" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3>
<div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L8">src/models/methods/ledgerEntry.ts:8</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L39">src/models/methods/ledgerEntry.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledger_entry&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L7">src/models/methods/ledgerEntry.ts:7</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L50">src/models/methods/ledgerEntry.ts:50</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L19">src/models/methods/ledgerEntry.ts:19</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/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 tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L15">src/models/methods/ledgerEntry.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L9">src/models/methods/ledgerEntry.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L10">src/models/methods/ledgerEntry.ts:10</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L27">src/models/methods/ledgerEntry.ts:27</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L48">src/models/methods/ledgerEntry.ts:48</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L34">src/models/methods/ledgerEntry.ts:34</a></li>
</ul>
</aside>
<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>
</li>
<li class="tsd-parameter">
<h5>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L57">src/models/methods/ledgerEntry.ts:57</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="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-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,336 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerEntryResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="LedgerEntryResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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_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></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledgerEntry.ts#L66">src/models/methods/ledgerEntry.ts:66</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>
</li>
<li class="tsd-parameter">
<h5>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</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>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerEntryResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="LedgerEntryResponse.html#request" class="tsd-kind-icon">request</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-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>LedgerRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L13">src/models/methods/ledger.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="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="binary" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3>
<div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L17">src/models/methods/ledger.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledger&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L9">src/models/methods/ledger.ts:9</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L15">src/models/methods/ledger.ts:15</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L12">src/models/methods/ledger.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L10">src/models/methods/ledger.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L11">src/models/methods/ledger.ts:11</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L16">src/models/methods/ledger.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="queue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> queue</h3>
<div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L18">src/models/methods/ledger.ts:18</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L14">src/models/methods/ledger.ts:14</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="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-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,339 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LedgerResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="LedgerResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ledger.ts#L52">src/models/methods/ledger.ts:52</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>
</li>
<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>
<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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="LedgerResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="LedgerResponse.html#request" class="tsd-kind-icon">request</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-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>LedgerStream | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L39">src/models/methods/subscribe.ts:39</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L40">src/models/methods/subscribe.ts:40</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>ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L41">src/models/methods/subscribe.ts:41</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L42">src/models/methods/subscribe.ts:42</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L43">src/models/methods/subscribe.ts:43</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L44">src/models/methods/subscribe.ts:44</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L45">src/models/methods/subscribe.ts:45</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L46">src/models/methods/subscribe.ts:46</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;ledgerClosed&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L38">src/models/methods/subscribe.ts:38</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L47">src/models/methods/subscribe.ts:47</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="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-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,213 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ManifestRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;manifest&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/manifest.ts#L4">src/models/methods/manifest.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="public_key" class="tsd-anchor"></a>
<h3>public_<wbr>key</h3>
<div class="tsd-signature tsd-kind-icon">public_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/manifest.ts#L5">src/models/methods/manifest.ts:5</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="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-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,347 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ManifestResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ManifestResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="ManifestResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/manifest.ts#L9">src/models/methods/manifest.ts:9</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>
<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>
</li>
<li class="tsd-parameter">
<h5>requested<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ManifestResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="ManifestResponse.html#request" class="tsd-kind-icon">request</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-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,269 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NoRippleCheckRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L8">src/models/methods/norippleCheck.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;noripple_check&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L7">src/models/methods/norippleCheck.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L11">src/models/methods/norippleCheck.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L12">src/models/methods/norippleCheck.ts:12</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L9">src/models/methods/norippleCheck.ts:9</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L10">src/models/methods/norippleCheck.ts:10</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="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#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-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,333 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NoRippleCheckResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NoRippleCheckResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="NoRippleCheckResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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><span class="tsd-signature-type">Transaction</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/norippleCheck.ts#L16">src/models/methods/norippleCheck.ts:16</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>
</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>
</li>
<li class="tsd-parameter">
<h5>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">[]</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="NoRippleCheckResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="NoRippleCheckResponse.html#request" class="tsd-kind-icon">request</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-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,327 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OfferCreateTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="OfferCreateTransaction.html">OfferCreateTransaction</a>
</li>
</ul>
<h1>Interface OfferCreateTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="TransactionJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionJSON</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">OfferCreateTransaction</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-overwrite"><a href="OfferCreateTransaction.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#Expiration" class="tsd-kind-icon">Expiration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#Fee" class="tsd-kind-icon">Fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="OfferCreateTransaction.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#TakerGets" class="tsd-kind-icon">Taker<wbr>Gets</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="OfferCreateTransaction.html#TakerPays" class="tsd-kind-icon">Taker<wbr>Pays</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="OfferCreateTransaction.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>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 tsd-is-overwrite">
<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>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Account">Account</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L53">src/transaction/types.ts:53</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L60">src/transaction/types.ts:60</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Fee" class="tsd-anchor"></a>
<h3>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">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L54">src/transaction/types.ts:54</a></li>
</ul>
</aside>
</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>Flags</h3>
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Flags">Flags</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L55">src/transaction/types.ts:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Fulfillment">Fulfillment</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L17">src/transaction/types.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="LastLedgerSequence" class="tsd-anchor"></a>
<h3>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">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L56">src/transaction/types.ts:56</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<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">ApiMemo</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Memos">Memos</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L62">src/transaction/types.ts:62</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L61">src/transaction/types.ts:61</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="Sequence" class="tsd-anchor"></a>
<h3>Sequence</h3>
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L57">src/transaction/types.ts:57</a></li>
</ul>
</aside>
</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">RippledAmount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L58">src/transaction/types.ts:58</a></li>
</ul>
</aside>
</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">RippledAmount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L59">src/transaction/types.ts:59</a></li>
</ul>
</aside>
</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 <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#TransactionType">TransactionType</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L52">src/transaction/types.ts:52</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="OfferCreateTransaction.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="OfferCreateTransaction.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#Expiration" class="tsd-kind-icon">Expiration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#Fee" class="tsd-kind-icon">Fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="OfferCreateTransaction.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="OfferCreateTransaction.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="OfferCreateTransaction.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#OfferSequence" class="tsd-kind-icon">Offer<wbr>Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#Sequence" class="tsd-kind-icon">Sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#TakerGets" class="tsd-kind-icon">Taker<wbr>Gets</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="OfferCreateTransaction.html#TakerPays" class="tsd-kind-icon">Taker<wbr>Pays</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="OfferCreateTransaction.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,309 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OrderBookStream | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L98">src/models/methods/subscribe.ts:98</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L99">src/models/methods/subscribe.ts:99</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L100">src/models/methods/subscribe.ts:100</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L101">src/models/methods/subscribe.ts:101</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L102">src/models/methods/subscribe.ts:102</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L103">src/models/methods/subscribe.ts:103</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L104">src/models/methods/subscribe.ts:104</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L96">src/models/methods/subscribe.ts:96</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> <span class="tsd-signature-type">Transaction</span><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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L105">src/models/methods/subscribe.ts:105</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L97">src/models/methods/subscribe.ts:97</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L106">src/models/methods/subscribe.ts:106</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-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,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Outcome | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="Outcome.html">Outcome</a>
</li>
</ul>
<h1>Interface Outcome</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Outcome</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="Outcome.html#balanceChanges" class="tsd-kind-icon">balance<wbr>Changes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#deliveredAmount" class="tsd-kind-icon">delivered<wbr>Amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#fee" class="tsd-kind-icon">fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#indexInLedger" class="tsd-kind-icon">index<wbr>InLedger</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#ledgerVersion" class="tsd-kind-icon">ledger<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#orderbookChanges" class="tsd-kind-icon">orderbook<wbr>Changes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Outcome.html#timestamp" class="tsd-kind-icon">timestamp</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="balanceChanges" class="tsd-anchor"></a>
<h3>balance<wbr>Changes</h3>
<div class="tsd-signature tsd-kind-icon">balance<wbr>Changes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L83">src/transaction/types.ts:83</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">{ </span>counterparty<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="deliveredAmount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> delivered<wbr>Amount</h3>
<div class="tsd-signature tsd-kind-icon">delivered<wbr>Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>counterparty<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L91">src/transaction/types.ts:91</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> counterparty<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fee" class="tsd-anchor"></a>
<h3>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">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L82">src/transaction/types.ts:82</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="indexInLedger" class="tsd-anchor"></a>
<h3>index<wbr>InLedger</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>InLedger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L81">src/transaction/types.ts:81</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledgerVersion" class="tsd-anchor"></a>
<h3>ledger<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">ledger<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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L80">src/transaction/types.ts:80</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="orderbookChanges" class="tsd-anchor"></a>
<h3>orderbook<wbr>Changes</h3>
<div class="tsd-signature tsd-kind-icon">orderbook<wbr>Changes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L90">src/transaction/types.ts:90</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<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-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L79">src/transaction/types.ts:79</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="timestamp" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> timestamp</h3>
<div class="tsd-signature tsd-kind-icon">timestamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L96">src/transaction/types.ts:96</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="Outcome.html" class="tsd-kind-icon">Outcome</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#balanceChanges" class="tsd-kind-icon">balance<wbr>Changes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#deliveredAmount" class="tsd-kind-icon">delivered<wbr>Amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#fee" class="tsd-kind-icon">fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#indexInLedger" class="tsd-kind-icon">index<wbr>InLedger</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#ledgerVersion" class="tsd-kind-icon">ledger<wbr>Version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#orderbookChanges" class="tsd-kind-icon">orderbook<wbr>Changes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Outcome.html#timestamp" class="tsd-kind-icon">timestamp</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,348 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PathFindResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PathFindResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited"><a href="PathFindResponse.html#request" class="tsd-kind-icon">request</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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/pathFind.ts#L38">src/models/methods/pathFind.ts:38</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>
</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>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span></h5>
</li>
<li class="tsd-parameter">
<h5>full_<wbr>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</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>
</li>
<li class="tsd-parameter">
<h5>source_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</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>
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PathFindResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</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-inherited">
<a href="PathFindResponse.html#request" class="tsd-kind-icon">request</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-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,278 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PathFindStream | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="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-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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L122">src/models/methods/subscribe.ts:122</a></li>
</ul>
</aside>
<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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L117">src/models/methods/subscribe.ts:117</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L118">src/models/methods/subscribe.ts:118</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L119">src/models/methods/subscribe.ts:119</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L120">src/models/methods/subscribe.ts:120</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L121">src/models/methods/subscribe.ts:121</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="source_account" class="tsd-anchor"></a>
<h3>source_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">source_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L116">src/models/methods/subscribe.ts:116</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;path_find&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L115">src/models/methods/subscribe.ts:115</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-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,253 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PeerStatusStream | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="PeerStatusStream.html">PeerStatusStream</a>
</li>
</ul>
<h1>Interface PeerStatusStream</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseStream</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">PeerStatusStream</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="PeerStatusStream.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerStatusStream.html#date" class="tsd-kind-icon">date</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerStatusStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerStatusStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PeerStatusStream.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="PeerStatusStream.html#ledger_index_min" class="tsd-kind-icon">ledger_<wbr>index_<wbr>min</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PeerStatusStream.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="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;CLOSING_LEDGER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ACCEPTED_LEDGER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;SWITCHED_LEDGER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LOST_SYNC&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L83">src/models/methods/subscribe.ts:83</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="date" class="tsd-anchor"></a>
<h3>date</h3>
<div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L84">src/models/methods/subscribe.ts:84</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L85">src/models/methods/subscribe.ts:85</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L86">src/models/methods/subscribe.ts:86</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index_max" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index_<wbr>max</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index_<wbr>max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L87">src/models/methods/subscribe.ts:87</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index_min" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index_<wbr>min</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index_<wbr>min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L88">src/models/methods/subscribe.ts:88</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;peerStatusChange&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L82">src/models/methods/subscribe.ts:82</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="PeerStatusStream.html" class="tsd-kind-icon">Peer<wbr>Status<wbr>Stream</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PeerStatusStream.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PeerStatusStream.html#date" class="tsd-kind-icon">date</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PeerStatusStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PeerStatusStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="PeerStatusStream.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="PeerStatusStream.html#ledger_index_min" class="tsd-kind-icon">ledger_<wbr>index_<wbr>min</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="PeerStatusStream.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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>PingRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="PingRequest.html">PingRequest</a>
</li>
</ul>
<h1>Interface PingRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">PingRequest</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="PingRequest.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="PingRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingRequest.html#id" class="tsd-kind-icon">id</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ping&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ping.ts#L4">src/models/methods/ping.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="PingRequest.html" class="tsd-kind-icon">Ping<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingRequest.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="PingRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingRequest.html#id" class="tsd-kind-icon">id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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>PingResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="PingResponse.html">PingResponse</a>
</li>
</ul>
<h1>Interface PingResponse</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">PingResponse</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="PingResponse.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="PingResponse.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PingResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PingResponse.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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ping.ts#L10">src/models/methods/ping.ts:10</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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="PingResponse.html" class="tsd-kind-icon">Ping<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.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="PingResponse.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="PingResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="PingResponse.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-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,194 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Prepare | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="Prepare.html">Prepare</a>
</li>
</ul>
<h1>Interface Prepare</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Prepare</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="Prepare.html#instructions" class="tsd-kind-icon">instructions</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Prepare.html#txJSON" class="tsd-kind-icon">txJSON</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="instructions" class="tsd-anchor"></a>
<h3>instructions</h3>
<div class="tsd-signature tsd-kind-icon">instructions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>maxLedgerVersion<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>sequence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ticketSequence<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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L34">src/transaction/types.ts:34</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Ledger<wbr>Version<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> sequence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ticket<wbr>Sequence<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">
<a name="txJSON" class="tsd-anchor"></a>
<h3>txJSON</h3>
<div class="tsd-signature tsd-kind-icon">txJSON<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L33">src/transaction/types.ts:33</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="Prepare.html" class="tsd-kind-icon">Prepare</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Prepare.html#instructions" class="tsd-kind-icon">instructions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Prepare.html#txJSON" class="tsd-kind-icon">txJSON</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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>RandomRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="RandomRequest.html">RandomRequest</a>
</li>
</ul>
<h1>Interface RandomRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">RandomRequest</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="RandomRequest.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="RandomRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomRequest.html#id" class="tsd-kind-icon">id</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;random&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/random.ts#L4">src/models/methods/random.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="RandomRequest.html" class="tsd-kind-icon">Random<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomRequest.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="RandomRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomRequest.html#id" class="tsd-kind-icon">id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,327 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RandomResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="RandomResponse.html">RandomResponse</a>
</li>
</ul>
<h1>Interface RandomResponse</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">RandomResponse</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="RandomResponse.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="RandomResponse.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="RandomResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RandomResponse.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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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>random<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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/random.ts#L8">src/models/methods/random.ts:8</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>random<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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="RandomResponse.html" class="tsd-kind-icon">Random<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.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="RandomResponse.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="RandomResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RandomResponse.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-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>RipplePathFindRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="RipplePathFindRequest.html">RipplePathFindRequest</a>
</li>
</ul>
<h1>Interface RipplePathFindRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">RipplePathFindRequest</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="RipplePathFindRequest.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="RipplePathFindRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#destination_amount" class="tsd-kind-icon">destination_<wbr>amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindRequest.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#send_max" class="tsd-kind-icon">send_<wbr>max</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#source_account" class="tsd-kind-icon">source_<wbr>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="RipplePathFindRequest.html#source_currencies" class="tsd-kind-icon">source_<wbr>currencies</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ripple_path_find&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L11">src/models/methods/ripplePathFind.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="destination_account" class="tsd-anchor"></a>
<h3>destination_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">destination_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L13">src/models/methods/ripplePathFind.ts:13</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L14">src/models/methods/ripplePathFind.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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_hash" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L17">src/models/methods/ripplePathFind.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ledger_index" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index</h3>
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L18">src/models/methods/ripplePathFind.ts:18</a></li>
</ul>
</aside>
</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L15">src/models/methods/ripplePathFind.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="source_account" class="tsd-anchor"></a>
<h3>source_<wbr>account</h3>
<div class="tsd-signature tsd-kind-icon">source_<wbr>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L12">src/models/methods/ripplePathFind.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="source_currencies" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> source_<wbr>currencies</h3>
<div class="tsd-signature tsd-kind-icon">source_<wbr>currencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SourceCurrencyAmount</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L16">src/models/methods/ripplePathFind.ts:16</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="RipplePathFindRequest.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindRequest.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="RipplePathFindRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#destination_account" class="tsd-kind-icon">destination_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#destination_amount" class="tsd-kind-icon">destination_<wbr>amount</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindRequest.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#send_max" class="tsd-kind-icon">send_<wbr>max</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#source_account" class="tsd-kind-icon">source_<wbr>account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="RipplePathFindRequest.html#source_currencies" class="tsd-kind-icon">source_<wbr>currencies</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

View File

@@ -0,0 +1,333 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RipplePathFindResponse | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="RipplePathFindResponse.html">RipplePathFindResponse</a>
</li>
</ul>
<h1>Interface RipplePathFindResponse</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseResponse</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">RipplePathFindResponse</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="RipplePathFindResponse.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="RipplePathFindResponse.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="RipplePathFindResponse.html#result" class="tsd-kind-icon">result</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#status" class="tsd-kind-icon">status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.html#warning" class="tsd-kind-icon">warning</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="RipplePathFindResponse.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/ripple/ripple-lib/blob/0c571f2e/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="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">
<p>Inherited from BaseResponse.error</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">
<p>Inherited from BaseResponse.error_message</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.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="request" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseResponse.request</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/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-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>destination_account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>destination_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></div>
<aside class="tsd-sources">
<p>Overrides BaseResponse.result</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/ripplePathFind.ts#L27">src/models/methods/ripplePathFind.ts:27</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>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>destination_<wbr>currencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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>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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.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="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/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</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="RipplePathFindResponse.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Response</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.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="RipplePathFindResponse.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="RipplePathFindResponse.html#result" class="tsd-kind-icon">result</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#status" class="tsd-kind-icon">status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.html#warning" class="tsd-kind-icon">warning</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="RipplePathFindResponse.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-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>ServerInfoRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="ServerInfoRequest.html">ServerInfoRequest</a>
</li>
</ul>
<h1>Interface ServerInfoRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ServerInfoRequest</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="ServerInfoRequest.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="ServerInfoRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoRequest.html#id" class="tsd-kind-icon">id</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;server_info&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/serverInfo.ts#L4">src/models/methods/serverInfo.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ServerInfoRequest.html" class="tsd-kind-icon">Server<wbr>Info<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ServerInfoRequest.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="ServerInfoRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ServerInfoRequest.html#id" class="tsd-kind-icon">id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

File diff suppressed because one or more lines are too long

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>ServerStateRequest | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="ServerStateRequest.html">ServerStateRequest</a>
</li>
</ul>
<h1>Interface ServerStateRequest</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseRequest</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ServerStateRequest</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="ServerStateRequest.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="ServerStateRequest.html#command" class="tsd-kind-icon">command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerStateRequest.html#id" class="tsd-kind-icon">id</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="api_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L5">src/models/methods/baseMethod.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="command" class="tsd-anchor"></a>
<h3>command</h3>
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;server_state&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/serverState.ts#L5">src/models/methods/serverState.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L3">src/models/methods/baseMethod.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ServerStateRequest.html" class="tsd-kind-icon">Server<wbr>State<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ServerStateRequest.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="ServerStateRequest.html#command" class="tsd-kind-icon">command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="ServerStateRequest.html#id" class="tsd-kind-icon">id</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,243 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SettingsTransaction | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
</li>
<li>
<a href="SettingsTransaction.html">SettingsTransaction</a>
</li>
</ul>
<h1>Interface SettingsTransaction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="TransactionJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionJSON</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">SettingsTransaction</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="SettingsTransaction.html#Account" class="tsd-kind-icon">Account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SettingsTransaction.html#Flags" class="tsd-kind-icon">Flags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SettingsTransaction.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SettingsTransaction.html#Memos" class="tsd-kind-icon">Memos</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SettingsTransaction.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SettingsTransaction.html#TransferRate" class="tsd-kind-icon">Transfer<wbr>Rate</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 <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Account">Account</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L13">src/transaction/types.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="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></div>
<aside class="tsd-sources">
<p>Inherited from <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Flags">Flags</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L16">src/transaction/types.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<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">
<p>Inherited from <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Fulfillment">Fulfillment</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L17">src/transaction/types.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="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">ApiMemo</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#Memos">Memos</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L15">src/transaction/types.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="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">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="TransactionJSON.html">TransactionJSON</a>.<a href="TransactionJSON.html#TransactionType">TransactionType</a></p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L14">src/transaction/types.ts:14</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/ripple/ripple-lib/blob/0c571f2e/src/transaction/types.ts#L66">src/transaction/types.ts:66</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="SettingsTransaction.html" class="tsd-kind-icon">Settings<wbr>Transaction</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="SettingsTransaction.html#Account" class="tsd-kind-icon">Account</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="SettingsTransaction.html#Flags" class="tsd-kind-icon">Flags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="SettingsTransaction.html#Fulfillment" class="tsd-kind-icon">Fulfillment</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="SettingsTransaction.html#Memos" class="tsd-kind-icon">Memos</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="SettingsTransaction.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SettingsTransaction.html#TransferRate" class="tsd-kind-icon">Transfer<wbr>Rate</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

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