mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
70 lines
32 KiB
HTML
70 lines
32 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PayChannel | 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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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="../modules/LedgerEntry.html">LedgerEntry</a></li><li><a href="LedgerEntry.PayChannel.html">PayChannel</a></li></ul><h1>Interface PayChannel</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>The PayChannel object type represents a payment channel. Payment channels
|
|
enable small, rapid off-ledger payments of XRP that can be later reconciled
|
|
with the consensus ledger. A payment channel holds a balance of XRP that can
|
|
only be paid out to a specific destination address until the channel is
|
|
closed.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">default</span><ul class="tsd-hierarchy"><li><span class="target">PayChannel</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="LedgerEntry.PayChannel.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Amount" class="tsd-kind-icon">Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Balance" class="tsd-kind-icon">Balance</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#CancelAfter" class="tsd-kind-icon">Cancel<wbr/>After</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#DestinationNode" class="tsd-kind-icon">Destination<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#DestinationTag" class="tsd-kind-icon">Destination<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Expiration" class="tsd-kind-icon">Expiration</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#OwnerNode" class="tsd-kind-icon">Owner<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#PreviousTxnID" class="tsd-kind-icon">Previous<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#PreviousTxnLgrSeq" class="tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#PublicKey" class="tsd-kind-icon">Public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#SettleDelay" class="tsd-kind-icon">Settle<wbr/>Delay</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.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="LedgerEntry.PayChannel.html#index" class="tsd-kind-icon">index</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 id="Account" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L18">packages/xrpl/src/models/ledger/PayChannel.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The source address that owns this payment channel. This comes from the
|
|
sending address of the transaction that created the channel.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Amount<a href="#Amount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L32">packages/xrpl/src/models/ledger/PayChannel.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Total XRP, in drops, that has been allocated to this channel. This
|
|
includes XRP that has been paid to the destination address. This is
|
|
initially set by the transaction that created the channel and can be
|
|
increased if the source address sends a PaymentChannelFund transaction.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Balance" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Balance<a href="#Balance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L39">packages/xrpl/src/models/ledger/PayChannel.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Total XRP, in drops, already paid out by the channel. The difference
|
|
between this value and the Amount field is how much XRP can still be paid
|
|
to the destination address with PaymentChannelClaim transactions. If the
|
|
channel closes, the remaining difference is returned to the source address.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="CancelAfter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Cancel<wbr/>After<a href="#CancelAfter" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Cancel<wbr/>After<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L91">packages/xrpl/src/models/ledger/PayChannel.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The immutable expiration time for this payment channel, in seconds since
|
|
the Ripple Epoch. This channel is expired if this value is present and
|
|
smaller than the previous ledger's close_time field. This is optionally
|
|
set by the transaction that created the channel, and cannot be changed.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Destination<a href="#Destination" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L25">packages/xrpl/src/models/ledger/PayChannel.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The destination address for this payment channel. While the payment
|
|
channel is open, this address is the only one that can receive XRP from the
|
|
channel. This comes from the Destination field of the transaction that
|
|
created the channel.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="DestinationNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr/>Node<a href="#DestinationNode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<wbr/>Node<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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L106">packages/xrpl/src/models/ledger/PayChannel.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A hint indicating which page of the destination's owner directory links to
|
|
this object, in case the directory consists of multiple pages.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="DestinationTag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Destination<wbr/>Tag<a href="#DestinationTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Destination<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L101">packages/xrpl/src/models/ledger/PayChannel.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An arbitrary tag to further specify the destination for this payment
|
|
channel, such as a hosted recipient at the destination address.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Expiration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Expiration<a href="#Expiration" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Expiration<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L84">packages/xrpl/src/models/ledger/PayChannel.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The mutable expiration time for this payment channel, in seconds since the
|
|
Ripple Epoch. The channel is expired if this value is present and smaller
|
|
than the previous ledger's close_time field. See Setting Channel Expiration
|
|
for more details.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L77">packages/xrpl/src/models/ledger/PayChannel.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A bit-map of boolean flags enabled for this payment channel. Currently,
|
|
the protocol defines no flags for PayChannel objects.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LedgerEntryType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Ledger<wbr/>Entry<wbr/>Type<a href="#LedgerEntryType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"PayChannel"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L13">packages/xrpl/src/models/ledger/PayChannel.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="OwnerNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Owner<wbr/>Node<a href="#OwnerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Owner<wbr/>Node<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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L62">packages/xrpl/src/models/ledger/PayChannel.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A hint indicating which page of the source address's owner directory links
|
|
to this object, in case the directory consists of multiple pages.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PreviousTxnID" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Previous<wbr/>TxnID<a href="#PreviousTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Previous<wbr/>TxnID<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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L67">packages/xrpl/src/models/ledger/PayChannel.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The identifying hash of the transaction that most recently modified this
|
|
object.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PreviousTxnLgrSeq" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq<a href="#PreviousTxnLgrSeq" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L72">packages/xrpl/src/models/ledger/PayChannel.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The index of the ledger that contains the transaction that most recently
|
|
modified this object.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PublicKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Public<wbr/>Key<a href="#PublicKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L48">packages/xrpl/src/models/ledger/PayChannel.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Public key, in hexadecimal, of the key pair that can be used to sign
|
|
claims against this channel. This can be any valid secp256k1 or Ed25519
|
|
public key. This is set by the transaction that created the channel and
|
|
must match the public key used in claims against the channel. The channel
|
|
source address can also send XRP from this channel to the destination
|
|
without signed claims.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SettleDelay" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Settle<wbr/>Delay<a href="#SettleDelay" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Settle<wbr/>Delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L57">packages/xrpl/src/models/ledger/PayChannel.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Number of seconds the source address must wait to close the channel if
|
|
it still has any XRP in it. Smaller values mean that the destination
|
|
address has less time to redeem any outstanding claims after the source
|
|
address requests to close the channel. Can be any value that fits in a
|
|
32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that
|
|
creates the channel.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SourceTag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/PayChannel.ts#L96">packages/xrpl/src/models/ledger/PayChannel.ts:96</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An arbitrary tag to further specify the source for this payment channel
|
|
useful for specifying a hosted recipient at the owner's address.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link">index<a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseLedgerEntry.index</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</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><li class="current 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 tsd-parent-kind-namespace"><a href="LedgerEntry.PayChannel.html" class="tsd-kind-icon">Pay<wbr/>Channel</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Amount" class="tsd-kind-icon">Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Balance" class="tsd-kind-icon">Balance</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#CancelAfter" class="tsd-kind-icon">Cancel<wbr/>After</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#DestinationNode" class="tsd-kind-icon">Destination<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#DestinationTag" class="tsd-kind-icon">Destination<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Expiration" class="tsd-kind-icon">Expiration</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#OwnerNode" class="tsd-kind-icon">Owner<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#PreviousTxnID" class="tsd-kind-icon">Previous<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#PreviousTxnLgrSeq" class="tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#PublicKey" class="tsd-kind-icon">Public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.html#SettleDelay" class="tsd-kind-icon">Settle<wbr/>Delay</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.PayChannel.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="LedgerEntry.PayChannel.html#index" class="tsd-kind-icon">index</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> |