mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-02-17 12:22:30 +00:00
8995e3d579
* fix: use .mts extension to emit ES Modules * add comments and Apppliction type * update docs
25 lines
17 KiB
HTML
25 lines
17 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><script src="https://cmp.osano.com/AzyjT6TIZMlgyLyy8/ad2447d5-f101-40df-b92e-d6452b5ecac0/osano.js"></script><script>
|
||
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
|
||
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
|
||
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
|
||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||
})(window,document,'script','dataLayer','GTM-M7HKJJ3');
|
||
</script><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PaymentFlagsInterface | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M7HKJJ3" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="PaymentFlagsInterface.html">PaymentFlagsInterface</a></li></ul><h1>Interface PaymentFlagsInterface</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Map of flags to boolean values representing <a href="Payment.html" class="tsd-kind-interface">Payment</a> transaction
|
||
flags.</p>
|
||
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">partialPayment</span><span class="hl-1">: </span><span class="hl-10">Payment</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">'Payment'</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">'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Amount:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">currency:</span><span class="hl-1"> </span><span class="hl-5">'FOO'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">value:</span><span class="hl-1"> </span><span class="hl-5">'4000'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">issuer:</span><span class="hl-1"> </span><span class="hl-5">'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">Destination:</span><span class="hl-1"> </span><span class="hl-5">'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'</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">tfPartialPayment:</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-9">// 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">partialPayment</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-9">// {</span><br/><span class="hl-9">// TransactionType: 'Payment',</span><br/><span class="hl-9">// Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',</span><br/><span class="hl-9">// Amount: {</span><br/><span class="hl-9">// currency: 'FOO',</span><br/><span class="hl-9">// value: '4000',</span><br/><span class="hl-9">// issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'</span><br/><span class="hl-9">// },</span><br/><span class="hl-9">// Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',</span><br/><span class="hl-9">// Flags: 131072,</span><br/><span class="hl-9">// Sequence: 21970996,</span><br/><span class="hl-9">// Fee: '12',</span><br/><span class="hl-9">// LastLedgerSequence: 21971016</span><br/><span class="hl-9">// }</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PaymentFlagsInterface</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="PaymentFlagsInterface.html#tflimitquality">tfLimitQuality</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="PaymentFlagsInterface.html#tfnorippledirect">tfNoRippleDirect</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="PaymentFlagsInterface.html#tfpartialpayment">tfPartialPayment</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="3194"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">GlobalFlags</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PaymentFlagsInterface</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/payment.ts#L87">packages/xrpl/src/models/transactions/payment.ts:87</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="PaymentFlagsInterface.html#tflimitquality" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tf<wbr/>Limit<wbr/>Quality?</span></a>
|
||
<a href="PaymentFlagsInterface.html#tfnorippledirect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tf<wbr/>No<wbr/>Ripple<wbr/>Direct?</span></a>
|
||
<a href="PaymentFlagsInterface.html#tfpartialpayment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tf<wbr/>Partial<wbr/>Payment?</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="tflimitquality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tf<wbr/>Limit<wbr/>Quality</span><a href="#tflimitquality" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tfLimitQuality</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Only take paths where all the conversions have an input:output ratio that
|
||
is equal or better than the ratio of Amount:SendMax. See Limit Quality for
|
||
details.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/payment.ts#L105">packages/xrpl/src/models/transactions/payment.ts:105</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tfnorippledirect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tf<wbr/>No<wbr/>Ripple<wbr/>Direct</span><a href="#tfnorippledirect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tfNoRippleDirect</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Do not use the default path; only use paths included in the Paths field.
|
||
This is intended to force the transaction to take arbitrage opportunities.
|
||
Most clients do not need this.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/payment.ts#L93">packages/xrpl/src/models/transactions/payment.ts:93</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tfpartialpayment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tf<wbr/>Partial<wbr/>Payment</span><a href="#tfpartialpayment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tfPartialPayment</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If the specified Amount cannot be sent without spending more than SendMax,
|
||
reduce the received amount instead of failing outright. See Partial.
|
||
Payments for more details.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/payment.ts#L99">packages/xrpl/src/models/transactions/payment.ts:99</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#tflimitquality" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tf<wbr/>Limit<wbr/>Quality</span></a><a href="#tfnorippledirect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tf<wbr/>No<wbr/>Ripple<wbr/>Direct</span></a><a href="#tfpartialpayment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tf<wbr/>Partial<wbr/>Payment</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">xrpl</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|