mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 04:05:52 +00:00
22 lines
11 KiB
HTML
22 lines
11 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PaymentChannelClaimFlagsInterface | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/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-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="PaymentChannelClaimFlagsInterface.html">PaymentChannelClaimFlagsInterface</a></li></ul><h1>Interface PaymentChannelClaimFlagsInterface</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Map of flags to boolean values representing <a href="PaymentChannelClaim.html">PaymentChannelClaim</a>
|
|
transaction flags.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-typescript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">paymentChannelClaim</span><span class="hl-1">: </span><span class="hl-8">PaymentChannelClaim</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj</span><span class="hl-11">,</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType</span><span class="hl-1">: </span><span class="hl-5">'PaymentChannelClaim'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Channel:</span><span class="hl-1"> </span><span class="hl-0">hashes</span><span class="hl-1">.</span><span class="hl-4">hashPaymentChannel</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-5">'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">'rQGYqiyH5Ue9J96p4E6Qt6AvqxK4sDhnS5'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">21970712</span><span class="hl-1">,</span><br/><span class="hl-1"> ),</span><br/><span class="hl-1"> </span><span class="hl-0">Amount:</span><span class="hl-1"> </span><span class="hl-5">'100'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Flags:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">tfClose:</span><span class="hl-1"> </span><span class="hl-2">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-7">// Autofill the tx to see how flags actually look compared to the interface usage.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">autofilledTx</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">autofill</span><span class="hl-1">(</span><span class="hl-0">paymentChannelClaim</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">autofilledTx</span><span class="hl-1">)</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',</span><br/><span class="hl-7">// TransactionType: 'PaymentChannelClaim',</span><br/><span class="hl-7">// Channel: 'FC14BF9245D731DC1749EE0F070765E4EB4E993F8ECEE3D00F7E6E26D6EF98CF',</span><br/><span class="hl-7">// Amount: '100',</span><br/><span class="hl-7">// Flags: 131072,</span><br/><span class="hl-7">// Sequence: 21970713,</span><br/><span class="hl-7">// Fee: '12',</span><br/><span class="hl-7">// LastLedgerSequence: 21970658</span><br/><span class="hl-7">// }</span>
|
|
</code></pre>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GlobalFlags</span><ul class="tsd-hierarchy"><li><span class="target">PaymentChannelClaimFlagsInterface</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html#tfRenew" class="tsd-kind-icon">tf<wbr/>Renew</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfClose" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Close<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/transactions/paymentChannelClaim.ts#L91">src/models/transactions/paymentChannelClaim.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Request to close the channel. Only the channel source and destination
|
|
addresses can use this flag. This flag closes the channel immediately if it
|
|
has no more XRP allocated to it after processing the current claim, or if
|
|
the destination address uses it. If the source address uses this flag when
|
|
the channel still holds XRP, this schedules the channel to close after
|
|
SettleDelay seconds have passed. (Specifically, this sets the Expiration of
|
|
the channel to the close time of the previous ledger plus the channel's
|
|
SettleDelay time, unless the channel already has an earlier Expiration
|
|
time.) If the destination address uses this flag when the channel still
|
|
holds XRP, any XRP that remains after processing the claim is returned to
|
|
the source address.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfRenew" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Renew</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Renew<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/transactions/paymentChannelClaim.ts#L77">src/models/transactions/paymentChannelClaim.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Clear the channel's Expiration time. (Expiration is different from the
|
|
channel's immutable CancelAfter time.) Only the source address of the
|
|
payment channel can use this flag.</p>
|
|
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags<wbr/>Interface</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PaymentChannelClaimFlagsInterface.html#tfRenew" class="tsd-kind-icon">tf<wbr/>Renew</a></li></ul></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><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html> |