ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 12:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
75e56ca92754ce2ab769988ce28b426efc2804ce
xahau.js/docs/modules.html
Nathan Nichols 75e56ca927 build: generates documentation (#1716)
2021-10-12 15:06:44 -05:00

2418 lines
164 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>xrpl</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Clients</h3>
<ul class="tsd-index-list">
<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>
</ul>
</section>
<section class="tsd-index-section">
<h3>Transaction Models</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/AccountDelete.html" class="tsd-kind-icon">Account<wbr>Delete</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountSet.html" class="tsd-kind-icon">Account<wbr>Set</a></li>
<li class="tsd-kind-interface"><a href="interfaces/CheckCancel.html" class="tsd-kind-icon">Check<wbr>Cancel</a></li>
<li class="tsd-kind-interface"><a href="interfaces/CheckCash.html" class="tsd-kind-icon">Check<wbr>Cash</a></li>
<li class="tsd-kind-interface"><a href="interfaces/CheckCreate.html" class="tsd-kind-icon">Check<wbr>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr>Preauth</a></li>
<li class="tsd-kind-interface"><a href="interfaces/EscrowCancel.html" class="tsd-kind-icon">Escrow<wbr>Cancel</a></li>
<li class="tsd-kind-interface"><a href="interfaces/EscrowCreate.html" class="tsd-kind-icon">Escrow<wbr>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/EscrowFinish.html" class="tsd-kind-icon">Escrow<wbr>Finish</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OfferCancel.html" class="tsd-kind-icon">Offer<wbr>Cancel</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OfferCreate.html" class="tsd-kind-icon">Offer<wbr>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/Payment.html" class="tsd-kind-icon">Payment</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelCreate.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelFund.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Fund</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SetRegularKey.html" class="tsd-kind-icon">Set<wbr>Regular<wbr>Key</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SignerListSet.html" class="tsd-kind-icon">Signer<wbr>List<wbr>Set</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TicketCreate.html" class="tsd-kind-icon">Ticket<wbr>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TrustSet.html" class="tsd-kind-icon">Trust<wbr>Set</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Transaction Flags</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum"><a href="enums/AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Asf<wbr>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>TfFlags</a></li>
<li class="tsd-kind-enum"><a href="enums/OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/PaymentFlags.html" class="tsd-kind-icon">Payment<wbr>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountSetFlagsInterface.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Flags<wbr>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OfferCreateFlagsInterface.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags<wbr>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelClaimFlagsInterface.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags<wbr>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentFlagsInterface.html" class="tsd-kind-icon">Payment<wbr>Flags<wbr>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TrustSetFlagsInterface.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags<wbr>Interface</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Utilities</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="modules.html#isValidSecret" class="tsd-kind-icon">is<wbr>Valid<wbr>Secret</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Requests</h3>
<ul class="tsd-index-list">
<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/AccountCurrenciesRequest.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Request</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/AccountLinesRequest.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Request</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/AccountOffersRequest.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Request</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/BookOffersRequest.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Request</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/DepositAuthorizedRequest.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Request</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/GatewayBalancesRequest.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Request</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/LedgerCurrentRequest.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Request</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/LedgerEntryRequest.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Request</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/ManifestRequest.html" class="tsd-kind-icon">Manifest<wbr>Request</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/PingRequest.html" class="tsd-kind-icon">Ping<wbr>Request</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/RipplePathFindRequest.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Request</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/ServerStateRequest.html" class="tsd-kind-icon">Server<wbr>State<wbr>Request</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/SubmitRequest.html" class="tsd-kind-icon">Submit<wbr>Request</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/TransactionEntryRequest.html" class="tsd-kind-icon">Transaction<wbr>Entry<wbr>Request</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/UnsubscribeRequest.html" class="tsd-kind-icon">Unsubscribe<wbr>Request</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>
</ul>
</section>
<section class="tsd-index-section">
<h3>Responses</h3>
<ul class="tsd-index-list">
<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/AccountCurrenciesResponse.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Response</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/AccountLinesResponse.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Response</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/AccountOffersResponse.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Response</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/BookOffersResponse.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Response</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/DepositAuthorizedResponse.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ErrorResponse.html" class="tsd-kind-icon">Error<wbr>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/FeeResponse.html" class="tsd-kind-icon">Fee<wbr>Response</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/LedgerClosedResponse.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Response</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/LedgerDataResponse.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Response</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/LedgerResponse.html" class="tsd-kind-icon">Ledger<wbr>Response</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/NoRippleCheckResponse.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Response</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/PingResponse.html" class="tsd-kind-icon">Ping<wbr>Response</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/RipplePathFindResponse.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Response</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/ServerStateResponse.html" class="tsd-kind-icon">Server<wbr>State<wbr>Response</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/SubmitResponse.html" class="tsd-kind-icon">Submit<wbr>Response</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/TransactionEntryResponse.html" class="tsd-kind-icon">Transaction<wbr>Entry<wbr>Response</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/UnsubscribeResponse.html" class="tsd-kind-icon">Unsubscribe<wbr>Response</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#Response" class="tsd-kind-icon">Response</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Errors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/ConnectionError.html" class="tsd-kind-icon">Connection<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/DisconnectedError.html" class="tsd-kind-icon">Disconnected<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/NotConnectedError.html" class="tsd-kind-icon">Not<wbr>Connected<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/NotFoundError.html" class="tsd-kind-icon">Not<wbr>Found<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/ResponseFormatError.html" class="tsd-kind-icon">Response<wbr>Format<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/RippledError.html" class="tsd-kind-icon">Rippled<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/RippledNotInitializedError.html" class="tsd-kind-icon">Rippled<wbr>Not<wbr>Initialized<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/TimeoutError.html" class="tsd-kind-icon">Timeout<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/UnexpectedError.html" class="tsd-kind-icon">Unexpected<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/ValidationError.html" class="tsd-kind-icon">Validation<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/XRPLFaucetError.html" class="tsd-kind-icon">XRPLFaucet<wbr>Error</a></li>
<li class="tsd-kind-class"><a href="classes/XrplError.html" class="tsd-kind-icon">Xrpl<wbr>Error</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Offline Signing</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/Wallet.html" class="tsd-kind-icon">Wallet</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Other</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelClaim.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TransactionAndMetadata.html" class="tsd-kind-icon">Transaction<wbr>And<wbr>Metadata</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#Transaction" class="tsd-kind-icon">Transaction</a></li>
<li class="tsd-kind-property tsd-is-external"><a href="modules.html#deriveKeypair" class="tsd-kind-icon">derive<wbr>Keypair</a></li>
<li class="tsd-kind-variable"><a href="modules.html#hashes" class="tsd-kind-icon">hashes</a></li>
<li class="tsd-kind-function"><a href="modules.html#ISOTimeToRippleTime" class="tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time</a></li>
<li class="tsd-kind-function"><a href="modules.html#authorizeChannel" class="tsd-kind-icon">authorize<wbr>Channel</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#classicAddressToXAddress" class="tsd-kind-icon">classic<wbr>Address<wbr>ToXAddress</a></li>
<li class="tsd-kind-function"><a href="modules.html#convertStringToHex" class="tsd-kind-icon">convert<wbr>String<wbr>ToHex</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeAccountID" class="tsd-kind-icon">decode<wbr>AccountID</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeAccountPublic" class="tsd-kind-icon">decode<wbr>Account<wbr>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeNodePublic" class="tsd-kind-icon">decode<wbr>Node<wbr>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeSeed" class="tsd-kind-icon">decode<wbr>Seed</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeXAddress" class="tsd-kind-icon">decodeXAddress</a></li>
<li class="tsd-kind-function"><a href="modules.html#deriveXAddress" class="tsd-kind-icon">deriveXAddress</a></li>
<li class="tsd-kind-function"><a href="modules.html#dropsToXrp" class="tsd-kind-icon">drops<wbr>ToXrp</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeAccountID" class="tsd-kind-icon">encode<wbr>AccountID</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeAccountPublic" class="tsd-kind-icon">encode<wbr>Account<wbr>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeNodePublic" class="tsd-kind-icon">encode<wbr>Node<wbr>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeSeed" class="tsd-kind-icon">encode<wbr>Seed</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeXAddress" class="tsd-kind-icon">encodeXAddress</a></li>
<li class="tsd-kind-function"><a href="modules.html#generateXAddress" class="tsd-kind-icon">generateXAddress</a></li>
<li class="tsd-kind-function"><a href="modules.html#getBalanceChanges" class="tsd-kind-icon">get<wbr>Balance<wbr>Changes</a></li>
<li class="tsd-kind-function"><a href="modules.html#isValidAddress" class="tsd-kind-icon">is<wbr>Valid<wbr>Address</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#isValidClassicAddress" class="tsd-kind-icon">is<wbr>Valid<wbr>Classic<wbr>Address</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#isValidXAddress" class="tsd-kind-icon">is<wbr>ValidXAddress</a></li>
<li class="tsd-kind-function"><a href="modules.html#multisign" class="tsd-kind-icon">multisign</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#removeUndefined" class="tsd-kind-icon">remove<wbr>Undefined</a></li>
<li class="tsd-kind-function"><a href="modules.html#rippleTimeToISOTime" class="tsd-kind-icon">ripple<wbr>Time<wbr>ToISOTime</a></li>
<li class="tsd-kind-function"><a href="modules.html#rippleTimeToUnixTime" class="tsd-kind-icon">ripple<wbr>Time<wbr>ToUnix<wbr>Time</a></li>
<li class="tsd-kind-function"><a href="modules.html#signPaymentChannelClaim" class="tsd-kind-icon">sign<wbr>Payment<wbr>Channel<wbr>Claim</a></li>
<li class="tsd-kind-function"><a href="modules.html#unixTimeToRippleTime" class="tsd-kind-icon">unix<wbr>Time<wbr>ToRipple<wbr>Time</a></li>
<li class="tsd-kind-function"><a href="modules.html#validate" class="tsd-kind-icon">validate</a></li>
<li class="tsd-kind-function"><a href="modules.html#verifyPaymentChannelClaim" class="tsd-kind-icon">verify<wbr>Payment<wbr>Channel<wbr>Claim</a></li>
<li class="tsd-kind-function"><a href="modules.html#verifySignature" class="tsd-kind-icon">verify<wbr>Signature</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="modules.html#xAddressToClassicAddress" class="tsd-kind-icon">x<wbr>Address<wbr>ToClassic<wbr>Address</a></li>
<li class="tsd-kind-function"><a href="modules.html#xrpToDrops" class="tsd-kind-icon">xrp<wbr>ToDrops</a></li>
</ul>
</section>
<section class="tsd-index-section">
<h3>Streams</h3>
<ul class="tsd-index-list">
<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/LedgerStream.html" class="tsd-kind-icon">Ledger<wbr>Stream</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/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/TransactionStream.html" class="tsd-kind-icon">Transaction<wbr>Stream</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#Stream" class="tsd-kind-icon">Stream</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Utilities</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="isValidSecret" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Secret</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Secret<span class="tsd-signature-symbol">(</span>secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/index.ts#L52">src/utils/index.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if a secret is valid.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>secret: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Secret to test for validity.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>True if secret can be derived into a keypair.</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Requests</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="PathFindRequest" class="tsd-anchor"></a>
<h3>Path<wbr>Find<wbr>Request</h3>
<div class="tsd-signature tsd-kind-icon">Path<wbr>Find<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PathFindCreateRequest</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PathFindCloseRequest</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PathFindStatusRequest</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/pathFind.ts#L53">src/models/methods/pathFind.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The <code>path_find</code> method searches for a path along which a transaction can
possibly be made, and periodically sends updates when the path changes over
time. For a simpler version that is supported by JSON-RPC, see the
<code>ripple_path_find</code> method.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="Request" class="tsd-anchor"></a>
<h3>Request</h3>
<div class="tsd-signature tsd-kind-icon">Request<span class="tsd-signature-symbol">:</span> <a href="interfaces/AccountChannelsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountCurrenciesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountLinesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountObjectsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountTxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/GatewayBalancesRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/NoRippleCheckRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerClosedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerCurrentRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerDataRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SubmitRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SubmitMultisignedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TransactionEntryRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TxRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">TxRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/BookOffersRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/DepositAuthorizedRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedRequest</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#PathFindRequest" class="tsd-signature-type" data-tsd-kind="Type alias">PathFindRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/RipplePathFindRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ChannelVerifyRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/UnsubscribeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/FeeRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ManifestRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ServerInfoRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ServerStateRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PingRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">PingRequest</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/RandomRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomRequest</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/index.ts#L66">src/models/methods/index.ts:66</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Responses</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="Response" class="tsd-anchor"></a>
<h3>Response</h3>
<div class="tsd-signature tsd-kind-icon">Response<span class="tsd-signature-symbol">:</span> <a href="interfaces/AccountChannelsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountChannelsResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountCurrenciesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountCurrenciesResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountInfoResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountLinesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountLinesResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountObjectsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountObjectsResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountOffersResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountTxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountTxResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/GatewayBalancesResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">GatewayBalancesResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/NoRippleCheckResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NoRippleCheckResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerClosedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerClosedResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerCurrentResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerCurrentResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerDataResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerDataResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/LedgerEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerEntryResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SubmitResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SubmitMultisignedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubmitMultisignedResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TransactionEntryResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionEntryResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TxResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">TxResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/BookOffersResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">BookOffersResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/DepositAuthorizedResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositAuthorizedResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/RipplePathFindResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RipplePathFindResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ChannelVerifyResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelVerifyResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SubscribeResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/UnsubscribeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UnsubscribeResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/FeeResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ManifestResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ManifestResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ServerInfoResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerInfoResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ServerStateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerStateResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PingResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PingResponse</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/RandomResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RandomResponse</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/index.ts#L109">src/models/methods/index.ts:109</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Other</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="Transaction" class="tsd-anchor"></a>
<h3>Transaction</h3>
<div class="tsd-signature tsd-kind-icon">Transaction<span class="tsd-signature-symbol">:</span> <a href="interfaces/AccountDelete.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDelete</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/AccountSet.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSet</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/CheckCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCancel</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/CheckCash.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCash</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/CheckCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCreate</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/EscrowCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCancel</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/EscrowCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCreate</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/EscrowFinish.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowFinish</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/OfferCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCancel</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/OfferCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreate</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/Payment.html" class="tsd-signature-type" data-tsd-kind="Interface">Payment</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PaymentChannelClaim.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaim</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PaymentChannelCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelCreate</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PaymentChannelFund.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelFund</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SetRegularKey.html" class="tsd-signature-type" data-tsd-kind="Interface">SetRegularKey</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/SignerListSet.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerListSet</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TicketCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">TicketCreate</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TrustSet.html" class="tsd-signature-type" data-tsd-kind="Interface">TrustSet</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/transaction.ts#L40">src/models/transactions/transaction.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-is-external">
<a name="deriveKeypair" class="tsd-anchor"></a>
<h3>derive<wbr>Keypair</h3>
<div class="tsd-signature tsd-kind-icon">derive<wbr>Keypair<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>publicKey<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 node_modules/ripple-keypairs/dist/index.d.ts:16</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">object</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>public<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="hashes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> hashes</h3>
<div class="tsd-signature tsd-kind-icon">hashes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>hashAccountRoot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashEscrow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashLedger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ledger</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">HashLedgerHeaderOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashLedgerHeader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>ledgerHeader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ledger</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashOfferId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashPaymentChannel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dstAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashSignedTx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashSignerListId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashStateTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LedgerEntry</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashTrustline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashTx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>txBlobHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hashTxTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Metadata</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><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/xrplf/xrpl.js/blob/615504db/src/utils/index.ts#L101">src/utils/index.ts:101</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>hash<wbr>Account<wbr>Root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute AccountRoot Ledger Object Index.</p>
</div>
<p>All objects in a ledger&#39;s state tree have a unique Index.
The AccountRoot Ledger Object Index is derived by hashing the
address with a namespace identifier. This ensures every
Index is unique.</p>
<p>See <a href="https://xrpl.org/ledger-object-ids.html">Ledger Object Indexes</a>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The classic account address.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The Ledger Object Index for the account.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Escrow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the Hash of an Escrow LedgerEntry.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Address of the Escrow.</p>
</div>
</li>
<li>
<h5>sequence: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>OfferSequence of the Escrow.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The hash of the Escrow LedgerEntry.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ledger</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">HashLedgerHeaderOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ledger</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">HashLedgerHeaderOptions</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">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the hash of a ledger.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ledger: <span class="tsd-signature-type">Ledger</span></h5>
<div class="tsd-comment tsd-typography">
<p>Ledger to compute the hash for.</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-type">HashLedgerHeaderOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Allow client to recompute Transaction and State Hashes.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The has of ledger.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Ledger<wbr>Header<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>ledgerHeader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ledger</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>ledgerHeader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ledger</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">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the hash of a ledger.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ledgerHeader: <span class="tsd-signature-type">Ledger</span></h5>
<div class="tsd-comment tsd-typography">
<p>Ledger to compute the hash of.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The hash of the ledger.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Offer<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="https://xrpl.org/offer.html#offer-id-format">Offer Index Format</a>.</p>
</div>
<p>The Index of a Offer object is the SHA-512Half of the following values, concatenated in order:</p>
<ul>
<li>The Offer space key (0x006F)</li>
<li>The AccountID of the account placing the offer</li>
<li>The Sequence number of the OfferCreate transaction that created the offer.</li>
</ul>
<p>This method computes an Offer Index.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The classic account address of the SignerList owner (starting with r).</p>
</div>
</li>
<li>
<h5>sequence: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Sequence of the Offer.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The Index of the account&#39;s Offer object.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Payment<wbr>Channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dstAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dstAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the hash of a Payment Channel.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Account of the Payment Channel.</p>
</div>
</li>
<li>
<h5>dstAddress: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Destination Account of the Payment Channel.</p>
</div>
</li>
<li>
<h5>sequence: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Sequence number of the Transaction that created the Payment Channel.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Hash of the Payment Channel.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Signed<wbr>Tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hashes the Transaction object as the ledger does. Throws if the transaction is unsigned.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>ValidationError if the Transaction is unsigned.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A transaction to hash. Tx may be in binary blob form. Tx must be signed.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>A hash of tx.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Signer<wbr>List<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="https://xrpl.org/signerlist.html#signerlist-id-format">SignerList Index Format</a>.</p>
</div>
<p>The Index of a SignerList object is the SHA-512Half of the following values, concatenated in order:</p>
<ul>
<li>The RippleState space key (0x0053)</li>
<li>The AccountID of the owner of the SignerList</li>
<li>The SignerListID (currently always 0).</li>
</ul>
<p>This method computes a SignerList Ledger Object Index.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The classic account address of the SignerList owner (starting with r).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The Index of the account&#39;s SignerList object.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>State<wbr>Tree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LedgerEntry</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LedgerEntry</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the state hash of a list of LedgerEntries.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>entries: <span class="tsd-signature-type">LedgerEntry</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>List of LedgerEntries.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Hash of SHAMap that consists of all entries.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Trustline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>address1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, currency<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the hash of a Trustline.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address1: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>One of the addresses in the Trustline.</p>
</div>
</li>
<li>
<h5>address2: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The other address in the Trustline.</p>
</div>
</li>
<li>
<h5>currency: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Currency in the Trustline.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The hash of the Trustline.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>Tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>txBlobHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>txBlobHex<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hash the given binary transaction data with the single-signing prefix.</p>
</div>
<p>See <a href="https://xrpl.org/serialization.html">Serialization Format</a>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>txBlobHex: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The binary transaction blob as a hexadecimal string.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The hash to sign.</p>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>hash<wbr>TxTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Metadata</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Metadata</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compute the root hash of the SHAMap containing all transactions.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transactions: <span class="tsd-signature-symbol">(</span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Metadata</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>List of Transactions.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The root hash of the SHAMap.</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="ISOTimeToRippleTime" class="tsd-anchor"></a>
<h3>ISOTime<wbr>ToRipple<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time<span class="tsd-signature-symbol">(</span>iso8601<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">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/timeConversion.ts#L39">src/utils/timeConversion.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert an Iso8601 timestmap to a ripple timestamp.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>iso8601: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>International standard date format.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>Seconds since ripple epoch (1/1/2000 GMT).</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="authorizeChannel" class="tsd-anchor"></a>
<h3>authorize<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">authorize<wbr>Channel<span class="tsd-signature-symbol">(</span>wallet<span class="tsd-signature-symbol">: </span><a href="classes/Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a>, channelId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/signer.ts#L77">src/wallet/signer.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a signature that can be used to redeem a specific amount of XRP from a payment channel.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>wallet: <a href="classes/Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h5>
<div class="tsd-comment tsd-typography">
<p>The account that will sign for this payment channel.</p>
</div>
</li>
<li>
<h5>channelId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>An id for the payment channel to redeem XRP from.</p>
</div>
</li>
<li>
<h5>amount: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount in drops to redeem.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>A signature that can be used to redeem a specific amount of XRP from a payment channel.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="classicAddressToXAddress" class="tsd-anchor"></a>
<h3>classic<wbr>Address<wbr>ToXAddress</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">classic<wbr>Address<wbr>ToXAddress<span class="tsd-signature-symbol">(</span>classicAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span>, 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 node_modules/ripple-address-codec/dist/index.d.ts:3</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>classicAddress: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tag: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5>
</li>
<li>
<h5>test: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="convertStringToHex" class="tsd-anchor"></a>
<h3>convert<wbr>String<wbr>ToHex</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">convert<wbr>String<wbr>ToHex<span class="tsd-signature-symbol">(</span>string<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/index.ts#L97">src/utils/index.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts a string to its hex equivalent. Useful for Memos.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>string: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The string to convert to Hex.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The Hex equivalent of the string.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="decodeAccountID" class="tsd-anchor"></a>
<h3>decode<wbr>AccountID</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">decode<wbr>AccountID<span class="tsd-signature-symbol">(</span>accountId<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">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/ripple-address-codec/dist/xrp-codec.d.ts:59</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>accountId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="decodeAccountPublic" class="tsd-anchor"></a>
<h3>decode<wbr>Account<wbr>Public</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">decode<wbr>Account<wbr>Public<span class="tsd-signature-symbol">(</span>base58string<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">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/ripple-address-codec/dist/xrp-codec.d.ts:64</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>base58string: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="decodeNodePublic" class="tsd-anchor"></a>
<h3>decode<wbr>Node<wbr>Public</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">decode<wbr>Node<wbr>Public<span class="tsd-signature-symbol">(</span>base58string<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">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/ripple-address-codec/dist/xrp-codec.d.ts:61</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>base58string: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="decodeSeed" class="tsd-anchor"></a>
<h3>decode<wbr>Seed</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">decode<wbr>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>expectedLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>versionTypes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;ed25519&quot;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;secp256k1&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>versions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">number</span><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-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>version<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/ripple-address-codec/dist/xrp-codec.d.ts:48</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><span class="tsd-flag ts-flagOptional">Optional</span> opts: <span class="tsd-signature-symbol">{ </span>expectedLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>versionTypes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;ed25519&quot;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;secp256k1&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span>versions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">number</span><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-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>expected<wbr>Length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>version<wbr>Types<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;ed25519&quot;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;secp256k1&quot;</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li class="tsd-parameter">
<h5>versions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">number</span><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-symbol">[]</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span>version<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></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
</li>
<li class="tsd-parameter">
<h5>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="decodeXAddress" class="tsd-anchor"></a>
<h3>decodeXAddress</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">decodeXAddress<span class="tsd-signature-symbol">(</span>xAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>accountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/ripple-address-codec/dist/index.d.ts:10</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>xAddress: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>accountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>account<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
</li>
<li class="tsd-parameter">
<h5>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5>
</li>
<li class="tsd-parameter">
<h5>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="deriveXAddress" class="tsd-anchor"></a>
<h3>deriveXAddress</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">deriveXAddress<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DeriveOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/derive.ts#L16">src/utils/derive.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Derive an X-Address from a public key and a destination tag.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <span class="tsd-signature-type">DeriveOptions</span></h5>
<div class="tsd-comment tsd-typography">
<p>Public key and destination tag to encode as an X-Address.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>X-Address.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="dropsToXrp" class="tsd-anchor"></a>
<h3>drops<wbr>ToXrp</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">drops<wbr>ToXrp<span class="tsd-signature-symbol">(</span>dropsToConvert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumber.Value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/xrpConversion.ts#L17">src/utils/xrpConversion.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert Drops to XRP.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>When drops amount is invalid.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>dropsToConvert: <span class="tsd-signature-type">BigNumber.Value</span></h5>
<div class="tsd-comment tsd-typography">
<p>Drops to convert to XRP.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Amount in XRP.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="encodeAccountID" class="tsd-anchor"></a>
<h3>encode<wbr>AccountID</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">encode<wbr>AccountID<span class="tsd-signature-symbol">(</span>bytes<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 node_modules/ripple-address-codec/dist/xrp-codec.d.ts:57</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bytes: <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 class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="encodeAccountPublic" class="tsd-anchor"></a>
<h3>encode<wbr>Account<wbr>Public</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">encode<wbr>Account<wbr>Public<span class="tsd-signature-symbol">(</span>bytes<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 node_modules/ripple-address-codec/dist/xrp-codec.d.ts:63</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bytes: <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 class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="encodeNodePublic" class="tsd-anchor"></a>
<h3>encode<wbr>Node<wbr>Public</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">encode<wbr>Node<wbr>Public<span class="tsd-signature-symbol">(</span>bytes<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 node_modules/ripple-address-codec/dist/xrp-codec.d.ts:62</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bytes: <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 class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="encodeSeed" class="tsd-anchor"></a>
<h3>encode<wbr>Seed</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">encode<wbr>Seed<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ed25519&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;secp256k1&quot;</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 node_modules/ripple-address-codec/dist/xrp-codec.d.ts:47</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>entropy: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>type: <span class="tsd-signature-type">&quot;ed25519&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;secp256k1&quot;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="encodeXAddress" class="tsd-anchor"></a>
<h3>encodeXAddress</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">encodeXAddress<span class="tsd-signature-symbol">(</span>accountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span>, 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 node_modules/ripple-address-codec/dist/index.d.ts:4</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>accountId: <span class="tsd-signature-type">Buffer</span></h5>
</li>
<li>
<h5>tag: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5>
</li>
<li>
<h5>test: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="generateXAddress" class="tsd-anchor"></a>
<h3>generateXAddress</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">generateXAddress<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">GenerateAddressOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GeneratedAddress</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/generateAddress.ts#L39">src/utils/generateAddress.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>TODO: Move this function to be a static function of the Wallet Class.
TODO: Doc this function.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>When cannot generate an address.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <span class="tsd-signature-type">GenerateAddressOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Options for generating X-Address.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GeneratedAddress</span></h4>
<p>A generated address.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getBalanceChanges" class="tsd-anchor"></a>
<h3>get<wbr>Balance<wbr>Changes</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">get<wbr>Balance<wbr>Changes<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TransactionMetadata</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BalanceChanges</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/balanceChanges.ts#L164">src/utils/balanceChanges.ts:164</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p> Computes the complete list of every balance that changed in the ledger
as a result of the given transaction.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>metadata: <span class="tsd-signature-type">TransactionMetadata</span></h5>
<div class="tsd-comment tsd-typography">
<p>Transaction metada.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BalanceChanges</span><span class="tsd-signature-symbol">[]</span></h4>
<p>Parsed balance changes.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="isValidAddress" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/index.ts#L68">src/utils/index.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Validates that a given address is a valid X-Address or a valid classic
address.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Address to validate.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>True if address is a valid X-Address or classic address.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="isValidClassicAddress" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Classic<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Classic<wbr>Address<span class="tsd-signature-symbol">(</span>address<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 node_modules/ripple-address-codec/dist/xrp-codec.d.ts:65</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="isValidXAddress" class="tsd-anchor"></a>
<h3>is<wbr>ValidXAddress</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">is<wbr>ValidXAddress<span class="tsd-signature-symbol">(</span>xAddress<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 node_modules/ripple-address-codec/dist/index.d.ts:15</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>xAddress: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="multisign" class="tsd-anchor"></a>
<h3>multisign</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">multisign<span class="tsd-signature-symbol">(</span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/signer.ts#L30">src/wallet/signer.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Takes several transactions with Signer fields (in object or blob form) and creates a
single transaction with all Signers that then gets signed and returned.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>ValidationError if:</p>
<ul>
<li>There were no transactions given to sign</li>
<li>The SigningPubKey field is not the empty string in any given transaction</li>
<li>Any transaction is missing a Signers field.</li>
</ul>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transactions: <span class="tsd-signature-symbol">(</span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>An array of signed Transactions (in object or blob form) to combine into a single signed Transaction.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>A single signed Transaction which has all Signers from transactions within it.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="removeUndefined" class="tsd-anchor"></a>
<h3>remove<wbr>Undefined</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Undefined&lt;T&gt;<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/index.ts#L78">src/utils/index.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Removes undefined values from an object.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>obj: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>Object to remove undefined values from.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
<p>The same object, but without undefined values.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rippleTimeToISOTime" class="tsd-anchor"></a>
<h3>ripple<wbr>Time<wbr>ToISOTime</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">ripple<wbr>Time<wbr>ToISOTime<span class="tsd-signature-symbol">(</span>rippleTime<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/timeConversion.ts#L29">src/utils/timeConversion.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert a ripple timestamp to an Iso8601 timestamp.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rippleTime: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Is the number of seconds since Ripple Epoch (1/1/2000 GMT).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Iso8601 international standard date format.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rippleTimeToUnixTime" class="tsd-anchor"></a>
<h3>ripple<wbr>Time<wbr>ToUnix<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">ripple<wbr>Time<wbr>ToUnix<wbr>Time<span class="tsd-signature-symbol">(</span>rpepoch<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">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/timeConversion.ts#L9">src/utils/timeConversion.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert a ripple timestamp to a unix timestamp.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rpepoch: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>(seconds since 1/1/2000 GMT).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>Milliseconds since unix epoch.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="signPaymentChannelClaim" class="tsd-anchor"></a>
<h3>sign<wbr>Payment<wbr>Channel<wbr>Claim</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">sign<wbr>Payment<wbr>Channel<wbr>Claim<span class="tsd-signature-symbol">(</span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/signPaymentChannelClaim.ts#L14">src/utils/signPaymentChannelClaim.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sign a payment channel claim.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>channel: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Channel identifier specified by the paymentChannelClaim.</p>
</div>
</li>
<li>
<h5>amount: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount specified by the paymentChannelClaim.</p>
</div>
</li>
<li>
<h5>privateKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Private Key to sign paymentChannelClaim with.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>True if the channel is valid.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="unixTimeToRippleTime" class="tsd-anchor"></a>
<h3>unix<wbr>Time<wbr>ToRipple<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">unix<wbr>Time<wbr>ToRipple<wbr>Time<span class="tsd-signature-symbol">(</span>timestamp<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">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/timeConversion.ts#L19">src/utils/timeConversion.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert a unix timestamp to a ripple timestamp.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>timestamp: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>(ms since unix epoch).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>Seconds since Ripple Epoch (1/1/2000 GMT).</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="validate" class="tsd-anchor"></a>
<h3>validate</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/transaction.ts#L73">src/models/transactions/transaction.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Verifies various Transaction Types.
Encode/decode and individual type validation.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>ValidationError When the Transaction is malformed.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transaction: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>A Transaction.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="verifyPaymentChannelClaim" class="tsd-anchor"></a>
<h3>verify<wbr>Payment<wbr>Channel<wbr>Claim</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">verify<wbr>Payment<wbr>Channel<wbr>Claim<span class="tsd-signature-symbol">(</span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/verifyPaymentChannelClaim.ts#L16">src/utils/verifyPaymentChannelClaim.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Verify the signature of a payment channel claim.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>channel: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Channel identifier specified by the paymentChannelClaim.</p>
</div>
</li>
<li>
<h5>amount: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount specified by the paymentChannelClaim.</p>
</div>
</li>
<li>
<h5>signature: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Signature produced from signing paymentChannelClaim.</p>
</div>
</li>
<li>
<h5>publicKey: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Public key that signed the paymentChannelClaim.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>True if the channel is valid.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="verifySignature" class="tsd-anchor"></a>
<h3>verify<wbr>Signature</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">verify<wbr>Signature<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/wallet/signer.ts#L96">src/wallet/signer.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Verifies that the given transaction has a valid signature based on public-key encryption.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A transaction to verify the signature of. (Can be in object or encoded string format).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Returns true if tx has a valid signature, and returns false otherwise.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-is-external">
<a name="xAddressToClassicAddress" class="tsd-anchor"></a>
<h3>x<wbr>Address<wbr>ToClassic<wbr>Address</h3>
<ul class="tsd-signatures tsd-kind-function tsd-is-external">
<li class="tsd-signature tsd-kind-icon">x<wbr>Address<wbr>ToClassic<wbr>Address<span class="tsd-signature-symbol">(</span>xAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>classicAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/ripple-address-codec/dist/index.d.ts:5</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>xAddress: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>classicAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol">; </span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>classic<wbr>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h5>
</li>
<li class="tsd-parameter">
<h5>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="xrpToDrops" class="tsd-anchor"></a>
<h3>xrp<wbr>ToDrops</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">xrp<wbr>ToDrops<span class="tsd-signature-symbol">(</span>xrpToConvert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNumber.Value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/utils/xrpConversion.ts#L70">src/utils/xrpConversion.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convert an amount in XRP to an amount in drops.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>When amount in xrp is invalid.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>xrpToConvert: <span class="tsd-signature-type">BigNumber.Value</span></h5>
<div class="tsd-comment tsd-typography">
<p>Amount in XRP.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Amount in drops.</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Streams</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="Stream" class="tsd-anchor"></a>
<h3>Stream</h3>
<div class="tsd-signature tsd-kind-icon">Stream<span class="tsd-signature-symbol">:</span> <a href="interfaces/LedgerStream.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerStream</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ValidationStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationStream</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/TransactionStream.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionStream</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PathFindStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PathFindStream</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/PeerStatusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">PeerStatusStream</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/OrderBookStream.html" class="tsd-signature-type" data-tsd-kind="Interface">OrderBookStream</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ConsensusStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ConsensusStream</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L356">src/models/methods/subscribe.ts:356</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="current ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Asf<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>TfFlags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/PaymentFlags.html" class="tsd-kind-icon">Payment<wbr>Flags</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/BroadcastClient.html" class="tsd-kind-icon">Broadcast<wbr>Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ConnectionError.html" class="tsd-kind-icon">Connection<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/DisconnectedError.html" class="tsd-kind-icon">Disconnected<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/NotConnectedError.html" class="tsd-kind-icon">Not<wbr>Connected<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/NotFoundError.html" class="tsd-kind-icon">Not<wbr>Found<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ResponseFormatError.html" class="tsd-kind-icon">Response<wbr>Format<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/RippledError.html" class="tsd-kind-icon">Rippled<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/RippledNotInitializedError.html" class="tsd-kind-icon">Rippled<wbr>Not<wbr>Initialized<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/TimeoutError.html" class="tsd-kind-icon">Timeout<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/UnexpectedError.html" class="tsd-kind-icon">Unexpected<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ValidationError.html" class="tsd-kind-icon">Validation<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Wallet.html" class="tsd-kind-icon">Wallet</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/XRPLFaucetError.html" class="tsd-kind-icon">XRPLFaucet<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/XrplError.html" class="tsd-kind-icon">Xrpl<wbr>Error</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountChannelsRequest.html" class="tsd-kind-icon">Account<wbr>Channels<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountChannelsResponse.html" class="tsd-kind-icon">Account<wbr>Channels<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountCurrenciesRequest.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountCurrenciesResponse.html" class="tsd-kind-icon">Account<wbr>Currencies<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountDelete.html" class="tsd-kind-icon">Account<wbr>Delete</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountInfoRequest.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountInfoResponse.html" class="tsd-kind-icon">Account<wbr>Info<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountLinesRequest.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountLinesResponse.html" class="tsd-kind-icon">Account<wbr>Lines<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountObjectsRequest.html" class="tsd-kind-icon">Account<wbr>Objects<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountObjectsResponse.html" class="tsd-kind-icon">Account<wbr>Objects<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountOffersRequest.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountOffersResponse.html" class="tsd-kind-icon">Account<wbr>Offers<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountSet.html" class="tsd-kind-icon">Account<wbr>Set</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountSetFlagsInterface.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountTxRequest.html" class="tsd-kind-icon">Account<wbr>TxRequest</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/AccountTxResponse.html" class="tsd-kind-icon">Account<wbr>TxResponse</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/BookOffersRequest.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/BookOffersResponse.html" class="tsd-kind-icon">Book<wbr>Offers<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ChannelVerifyRequest.html" class="tsd-kind-icon">Channel<wbr>Verify<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ChannelVerifyResponse.html" class="tsd-kind-icon">Channel<wbr>Verify<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/CheckCancel.html" class="tsd-kind-icon">Check<wbr>Cancel</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/CheckCash.html" class="tsd-kind-icon">Check<wbr>Cash</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/CheckCreate.html" class="tsd-kind-icon">Check<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ConsensusStream.html" class="tsd-kind-icon">Consensus<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/DepositAuthorizedRequest.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/DepositAuthorizedResponse.html" class="tsd-kind-icon">Deposit<wbr>Authorized<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr>Preauth</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ErrorResponse.html" class="tsd-kind-icon">Error<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/EscrowCancel.html" class="tsd-kind-icon">Escrow<wbr>Cancel</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/EscrowCreate.html" class="tsd-kind-icon">Escrow<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/EscrowFinish.html" class="tsd-kind-icon">Escrow<wbr>Finish</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FeeRequest.html" class="tsd-kind-icon">Fee<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/FeeResponse.html" class="tsd-kind-icon">Fee<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/GatewayBalancesRequest.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/GatewayBalancesResponse.html" class="tsd-kind-icon">Gateway<wbr>Balances<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerClosedRequest.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerClosedResponse.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerCurrentRequest.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerCurrentResponse.html" class="tsd-kind-icon">Ledger<wbr>Current<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerDataRequest.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerDataResponse.html" class="tsd-kind-icon">Ledger<wbr>Data<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerEntryRequest.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerEntryResponse.html" class="tsd-kind-icon">Ledger<wbr>Entry<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerRequest.html" class="tsd-kind-icon">Ledger<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerResponse.html" class="tsd-kind-icon">Ledger<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/LedgerStream.html" class="tsd-kind-icon">Ledger<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ManifestRequest.html" class="tsd-kind-icon">Manifest<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ManifestResponse.html" class="tsd-kind-icon">Manifest<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/NoRippleCheckRequest.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/NoRippleCheckResponse.html" class="tsd-kind-icon">No<wbr>Ripple<wbr>Check<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OfferCancel.html" class="tsd-kind-icon">Offer<wbr>Cancel</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OfferCreate.html" class="tsd-kind-icon">Offer<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OfferCreateFlagsInterface.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/OrderBookStream.html" class="tsd-kind-icon">Order<wbr>Book<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PathFindResponse.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PathFindStream.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/Payment.html" class="tsd-kind-icon">Payment</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelClaim.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelClaimFlagsInterface.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelCreate.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentChannelFund.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Fund</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PaymentFlagsInterface.html" class="tsd-kind-icon">Payment<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PeerStatusStream.html" class="tsd-kind-icon">Peer<wbr>Status<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PingRequest.html" class="tsd-kind-icon">Ping<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/PingResponse.html" class="tsd-kind-icon">Ping<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RandomRequest.html" class="tsd-kind-icon">Random<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RandomResponse.html" class="tsd-kind-icon">Random<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RipplePathFindRequest.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/RipplePathFindResponse.html" class="tsd-kind-icon">Ripple<wbr>Path<wbr>Find<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerInfoRequest.html" class="tsd-kind-icon">Server<wbr>Info<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerInfoResponse.html" class="tsd-kind-icon">Server<wbr>Info<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerStateRequest.html" class="tsd-kind-icon">Server<wbr>State<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ServerStateResponse.html" class="tsd-kind-icon">Server<wbr>State<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SetRegularKey.html" class="tsd-kind-icon">Set<wbr>Regular<wbr>Key</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SignerListSet.html" class="tsd-kind-icon">Signer<wbr>List<wbr>Set</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitMultisignedRequest.html" class="tsd-kind-icon">Submit<wbr>Multisigned<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitMultisignedResponse.html" class="tsd-kind-icon">Submit<wbr>Multisigned<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitRequest.html" class="tsd-kind-icon">Submit<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubmitResponse.html" class="tsd-kind-icon">Submit<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubscribeRequest.html" class="tsd-kind-icon">Subscribe<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/SubscribeResponse.html" class="tsd-kind-icon">Subscribe<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TicketCreate.html" class="tsd-kind-icon">Ticket<wbr>Create</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionAndMetadata.html" class="tsd-kind-icon">Transaction<wbr>And<wbr>Metadata</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionEntryRequest.html" class="tsd-kind-icon">Transaction<wbr>Entry<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionEntryResponse.html" class="tsd-kind-icon">Transaction<wbr>Entry<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TransactionStream.html" class="tsd-kind-icon">Transaction<wbr>Stream</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TrustSet.html" class="tsd-kind-icon">Trust<wbr>Set</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TrustSetFlagsInterface.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags<wbr>Interface</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TxRequest.html" class="tsd-kind-icon">Tx<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/TxResponse.html" class="tsd-kind-icon">Tx<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/UnsubscribeRequest.html" class="tsd-kind-icon">Unsubscribe<wbr>Request</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/UnsubscribeResponse.html" class="tsd-kind-icon">Unsubscribe<wbr>Response</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ValidationStream.html" class="tsd-kind-icon">Validation<wbr>Stream</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#PathFindRequest" class="tsd-kind-icon">Path<wbr>Find<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Request" class="tsd-kind-icon">Request</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Response" class="tsd-kind-icon">Response</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Stream" class="tsd-kind-icon">Stream</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#Transaction" class="tsd-kind-icon">Transaction</a>
</li>
<li class=" tsd-kind-property tsd-is-external">
<a href="modules.html#deriveKeypair" class="tsd-kind-icon">derive<wbr>Keypair</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#hashes" class="tsd-kind-icon">hashes</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#ISOTimeToRippleTime" class="tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#authorizeChannel" class="tsd-kind-icon">authorize<wbr>Channel</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#classicAddressToXAddress" class="tsd-kind-icon">classic<wbr>Address<wbr>ToXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#convertStringToHex" class="tsd-kind-icon">convert<wbr>String<wbr>ToHex</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeAccountID" class="tsd-kind-icon">decode<wbr>AccountID</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeAccountPublic" class="tsd-kind-icon">decode<wbr>Account<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeNodePublic" class="tsd-kind-icon">decode<wbr>Node<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeSeed" class="tsd-kind-icon">decode<wbr>Seed</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#decodeXAddress" class="tsd-kind-icon">decodeXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#deriveXAddress" class="tsd-kind-icon">deriveXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#dropsToXrp" class="tsd-kind-icon">drops<wbr>ToXrp</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeAccountID" class="tsd-kind-icon">encode<wbr>AccountID</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeAccountPublic" class="tsd-kind-icon">encode<wbr>Account<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeNodePublic" class="tsd-kind-icon">encode<wbr>Node<wbr>Public</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeSeed" class="tsd-kind-icon">encode<wbr>Seed</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#encodeXAddress" class="tsd-kind-icon">encodeXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#generateXAddress" class="tsd-kind-icon">generateXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getBalanceChanges" class="tsd-kind-icon">get<wbr>Balance<wbr>Changes</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#isValidAddress" class="tsd-kind-icon">is<wbr>Valid<wbr>Address</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#isValidClassicAddress" class="tsd-kind-icon">is<wbr>Valid<wbr>Classic<wbr>Address</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#isValidSecret" class="tsd-kind-icon">is<wbr>Valid<wbr>Secret</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#isValidXAddress" class="tsd-kind-icon">is<wbr>ValidXAddress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#multisign" class="tsd-kind-icon">multisign</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="modules.html#removeUndefined" class="tsd-kind-icon">remove<wbr>Undefined</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#rippleTimeToISOTime" class="tsd-kind-icon">ripple<wbr>Time<wbr>ToISOTime</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#rippleTimeToUnixTime" class="tsd-kind-icon">ripple<wbr>Time<wbr>ToUnix<wbr>Time</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#signPaymentChannelClaim" class="tsd-kind-icon">sign<wbr>Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#unixTimeToRippleTime" class="tsd-kind-icon">unix<wbr>Time<wbr>ToRipple<wbr>Time</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#validate" class="tsd-kind-icon">validate</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#verifyPaymentChannelClaim" class="tsd-kind-icon">verify<wbr>Payment<wbr>Channel<wbr>Claim</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#verifySignature" class="tsd-kind-icon">verify<wbr>Signature</a>
</li>
<li class=" tsd-kind-function tsd-is-external">
<a href="modules.html#xAddressToClassicAddress" class="tsd-kind-icon">x<wbr>Address<wbr>ToClassic<wbr>Address</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#xrpToDrops" class="tsd-kind-icon">xrp<wbr>ToDrops</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink