mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-06 17:27:59 +00:00
535 lines
29 KiB
HTML
535 lines
29 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>PaymentChannelClaim | xrpl</title>
|
|
<meta name="description" content="Documentation for xrpl">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">xrpl</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">xrpl</a>
|
|
</li>
|
|
<li>
|
|
<a href="PaymentChannelClaim.html">PaymentChannelClaim</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface PaymentChannelClaim</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Claim XRP from a payment channel, adjust the payment channel's expiration,
|
|
or both.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="tsd-signature-type">BaseTransaction</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">PaymentChannelClaim</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Account" class="tsd-kind-icon">Account</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Amount" class="tsd-kind-icon">Amount</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Balance" class="tsd-kind-icon">Balance</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Channel" class="tsd-kind-icon">Channel</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Fee" class="tsd-kind-icon">Fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PaymentChannelClaim.html#Flags" class="tsd-kind-icon">Flags</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Memos" class="tsd-kind-icon">Memos</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#PublicKey" class="tsd-kind-icon">Public<wbr>Key</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Sequence" class="tsd-kind-icon">Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaim.html#Signature" class="tsd-kind-icon">Signature</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#Signers" class="tsd-kind-icon">Signers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr>Pub<wbr>Key</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#SourceTag" class="tsd-kind-icon">Source<wbr>Tag</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="PaymentChannelClaim.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="PaymentChannelClaim.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>Signature</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="Account" class="tsd-anchor"></a>
|
|
<h3>Account</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Account</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L112">src/models/transactions/common.ts:112</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The unique address of the account that initiated the transaction.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="AccountTxnID" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr>TxnID</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.AccountTxnID</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L138">src/models/transactions/common.ts:138</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Hash value identifying another transaction. If provided, this transaction
|
|
is only valid if the sending account's previously-sent transaction matches
|
|
the provided hash.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Amount" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Amount</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L84">src/models/transactions/paymentChannelClaim.ts:84</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The amount of XRP, in drops, authorized by the Signature. This must match
|
|
the amount in the signed message. This is the cumulative amount of XRP that
|
|
can be dispensed by the channel, including XRP previously redeemed.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Balance" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Balance</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L78">src/models/transactions/paymentChannelClaim.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Total amount of XRP, in drops, delivered by this channel after processing
|
|
this claim. Required to deliver XRP. Must be more than the total amount
|
|
delivered by the channel so far, but not greater than the Amount of the
|
|
signed claim. Must be provided except when closing the channel.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Channel" class="tsd-anchor"></a>
|
|
<h3>Channel</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Channel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L71">src/models/transactions/paymentChannelClaim.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The unique ID of the channel as a 64-character hexadecimal string.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="Fee" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Fee</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Fee</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L125">src/models/transactions/common.ts:125</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Integer amount of XRP, in drops, to be destroyed as a cost for
|
|
distributing this transaction to the network. Some transaction types have
|
|
different minimum requirements.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="Flags" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Flags</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="PaymentChannelClaimFlagsInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaimFlagsInterface</a></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides BaseTransaction.Flags</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L69">src/models/transactions/paymentChannelClaim.ts:69</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="LastLedgerSequence" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Ledger<wbr>Sequence</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L146">src/models/transactions/common.ts:146</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Highest ledger index this transaction can appear in. Specifying this field
|
|
places a strict upper limit on how long the transaction can wait to be
|
|
validated or rejected.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="Memos" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Memos</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Memos<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>Memo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Memos</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L151">src/models/transactions/common.ts:151</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Additional arbitrary information used to identify this transaction.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="PublicKey" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Public<wbr>Key</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L97">src/models/transactions/paymentChannelClaim.ts:97</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The public key used for the signature, as hexadecimal. This must match the
|
|
PublicKey stored in the ledger for the channel. Required unless the sender
|
|
of the transaction is the source address of the channel and the Signature
|
|
field is omitted.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="Sequence" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Sequence</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Sequence</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L132">src/models/transactions/common.ts:132</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The sequence number of the account sending the transaction. A transaction
|
|
is only valid if the Sequence number is exactly 1 greater than the previous
|
|
transaction from the same account. The special case 0 means the transaction
|
|
is using a Ticket instead.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="Signature" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signature</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L90">src/models/transactions/paymentChannelClaim.ts:90</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The signature of this claim, as hexadecimal. The signed message contains
|
|
the channel ID and the amount of the claim. Required unless the sender of
|
|
the transaction is the source address of the channel.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="Signers" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signers</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Signers</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L156">src/models/transactions/common.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Array of objects that represent a multi-signature which authorizes this
|
|
transaction.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="SigningPubKey" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr>Pub<wbr>Key</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Signing<wbr>Pub<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.SigningPubKey</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L169">src/models/transactions/common.ts:169</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Hex representation of the public key that corresponds to the private key
|
|
used to sign this transaction. If an empty string, indicates a
|
|
multi-signature is present in the Signers field instead.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="SourceTag" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr>Tag</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Source<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.SourceTag</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L163">src/models/transactions/common.ts:163</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Arbitrary integer used to identify the reason for this payment, or a sender
|
|
on whose behalf this transaction is made. Conventionally, a refund should
|
|
specify the initial payment's SourceTag as the refund payment's
|
|
DestinationTag.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="TicketSequence" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr>Sequence</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Ticket<wbr>Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.TicketSequence</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L174">src/models/transactions/common.ts:174</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The sequence number of the ticket to use in place of a Sequence number. If
|
|
this is provided, Sequence must be 0. Cannot be used with AccountTxnID.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="TransactionType" class="tsd-anchor"></a>
|
|
<h3>Transaction<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Transaction<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"PaymentChannelClaim"</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides BaseTransaction.TransactionType</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/paymentChannelClaim.ts#L68">src/models/transactions/paymentChannelClaim.ts:68</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a name="TxnSignature" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr>Signature</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Txn<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.TxnSignature</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/common.ts#L179">src/models/transactions/common.ts:179</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The signature that verifies this transaction as originating from the
|
|
account it says it is from.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="PaymentChannelClaim.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#Account" class="tsd-kind-icon">Account</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#AccountTxnID" class="tsd-kind-icon">Account<wbr>TxnID</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="PaymentChannelClaim.html#Amount" class="tsd-kind-icon">Amount</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="PaymentChannelClaim.html#Balance" class="tsd-kind-icon">Balance</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="PaymentChannelClaim.html#Channel" class="tsd-kind-icon">Channel</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#Fee" class="tsd-kind-icon">Fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="PaymentChannelClaim.html#Flags" class="tsd-kind-icon">Flags</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr>Ledger<wbr>Sequence</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#Memos" class="tsd-kind-icon">Memos</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="PaymentChannelClaim.html#PublicKey" class="tsd-kind-icon">Public<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#Sequence" class="tsd-kind-icon">Sequence</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="PaymentChannelClaim.html#Signature" class="tsd-kind-icon">Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#Signers" class="tsd-kind-icon">Signers</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr>Pub<wbr>Key</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#SourceTag" class="tsd-kind-icon">Source<wbr>Tag</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr>Sequence</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="PaymentChannelClaim.html#TransactionType" class="tsd-kind-icon">Transaction<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
|
<a href="PaymentChannelClaim.html#TxnSignature" class="tsd-kind-icon">Txn<wbr>Signature</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |