mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 20:25:48 +00:00
414 lines
35 KiB
HTML
414 lines
35 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>SubmitResponse | xrpl</title>
|
|
<meta name="description" content="Documentation for xrpl">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">xrpl</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">xrpl</a>
|
|
</li>
|
|
<li>
|
|
<a href="SubmitResponse.html">SubmitResponse</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface SubmitResponse</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Response expected from a <a href="SubmitRequest.html">SubmitRequest</a>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="tsd-signature-type">BaseResponse</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">SubmitResponse</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#id" class="tsd-kind-icon">id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="SubmitResponse.html#result" class="tsd-kind-icon">result</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#status" class="tsd-kind-icon">status</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#type" class="tsd-kind-icon">type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#warning" class="tsd-kind-icon">warning</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="SubmitResponse.html#warnings" class="tsd-kind-icon">warnings</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="api_version" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr>version</h3>
|
|
<div class="tsd-signature tsd-kind-icon">api_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.api_version</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="forwarded" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3>
|
|
<div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.forwarded</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="id" class="tsd-anchor"></a>
|
|
<h3>id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.id</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="result" class="tsd-anchor"></a>
|
|
<h3>result</h3>
|
|
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>accepted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>account_sequence_available<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>account_sequence_next<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>applied<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>broadcast<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>engine_result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>engine_result_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>engine_result_message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>kept<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>open_ledger_cost<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>queued<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>tx_blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tx_json<span class="tsd-signature-symbol">: </span><a href="AccountDelete.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDelete</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="AccountSet.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="CheckCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="CheckCash.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCash</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="CheckCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="EscrowCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="EscrowCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="EscrowFinish.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowFinish</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="OfferCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="OfferCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="Payment.html" class="tsd-signature-type" data-tsd-kind="Interface">Payment</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="PaymentChannelClaim.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaim</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="PaymentChannelCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="PaymentChannelFund.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelFund</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="SetRegularKey.html" class="tsd-signature-type" data-tsd-kind="Interface">SetRegularKey</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="SignerListSet.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerListSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="TicketCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">TicketCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="TrustSet.html" class="tsd-signature-type" data-tsd-kind="Interface">TrustSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>validated_ledger_index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides BaseResponse.result</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/submit.ts#L29">src/models/methods/submit.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>accepted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The value true indicates that the transaction was applied, queued,
|
|
broadcast, or kept for later. The value <code>false</code> indicates that none of
|
|
those happened, so the transaction cannot possibly succeed as long as you
|
|
do not submit it again and have not already submitted it another time.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>account_<wbr>sequence_<wbr>available<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The next Sequence Number available for the sending account after all
|
|
pending and queued transactions.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>account_<wbr>sequence_<wbr>next<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The next Sequence number for the sending account after all transactions
|
|
that have been provisionally applied, but not transactions in the queue.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>applied<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The value true indicates that this transaction was applied to the open
|
|
ledger. In this case, the transaction is likely, but not guaranteed, to
|
|
be validated in the next ledger version.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>broadcast<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The value true indicates this transaction was broadcast to peer servers
|
|
in the peer-to-peer XRP Ledger network.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>engine_<wbr>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Text result code indicating the preliminary result of the transaction,
|
|
for example <code>tesSUCCESS</code>.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>engine_<wbr>result_<wbr>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Numeric version of the result code.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>engine_<wbr>result_<wbr>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Human-readable explanation of the transaction's preliminary result.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>kept<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The value true indicates that the transaction was kept to be retried
|
|
later.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>open_<wbr>ledger_<wbr>cost<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The current open ledger cost before processing this transaction
|
|
transactions with a lower cost are likely to be queued.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>queued<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The value true indicates the transaction was put in the Transaction
|
|
Queue, which means it is likely to be included in a future ledger
|
|
version.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>tx_<wbr>blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The complete transaction in hex string format.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>tx_<wbr>json<span class="tsd-signature-symbol">: </span><a href="AccountDelete.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDelete</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="AccountSet.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="CheckCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="CheckCash.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCash</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="CheckCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="EscrowCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="EscrowCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="EscrowFinish.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowFinish</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="OfferCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCancel</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="OfferCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="Payment.html" class="tsd-signature-type" data-tsd-kind="Interface">Payment</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="PaymentChannelClaim.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaim</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="PaymentChannelCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="PaymentChannelFund.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelFund</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="SetRegularKey.html" class="tsd-signature-type" data-tsd-kind="Interface">SetRegularKey</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="SignerListSet.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerListSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="TicketCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">TicketCreate</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="TrustSet.html" class="tsd-signature-type" data-tsd-kind="Interface">TrustSet</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The complete transaction in JSON format.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>validated_<wbr>ledger_<wbr>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The ledger index of the newest validated ledger at the time of
|
|
submission. This provides a lower bound on the ledger versions that the
|
|
transaction can appear in as a result of this request.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="status" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
|
|
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.status</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="type" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.type</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="warning" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3>
|
|
<div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"load"</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.warning</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="warnings" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3>
|
|
<div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseResponse.warnings</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="SubmitResponse.html" class="tsd-kind-icon">Submit<wbr>Response</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#id" class="tsd-kind-icon">id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="SubmitResponse.html#result" class="tsd-kind-icon">result</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#status" class="tsd-kind-icon">status</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#type" class="tsd-kind-icon">type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#warning" class="tsd-kind-icon">warning</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="SubmitResponse.html#warnings" class="tsd-kind-icon">warnings</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |