mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-15 10:05:48 +00:00
e813ec4bd3
Make all exported function parameters and return types show their shapes so that new developers can see how to use them in the docs.
18 lines
14 KiB
HTML
18 lines
14 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TrustSetFlagsInterface | 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="TrustSetFlagsInterface.html">TrustSetFlagsInterface</a></li></ul><h1>Interface TrustSetFlagsInterface</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="TrustSet.html">TrustSet</a> transaction
|
|
flags.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-typescript"><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">trustSetTx</span><span class="hl-1">: </span><span class="hl-8">TrustSet</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">'TrustSet'</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-0">wallet2</span><span class="hl-1">.</span><span class="hl-4">getClassicAddress</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-0">LimitAmount:</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">issuer:</span><span class="hl-1"> </span><span class="hl-0">wallet1</span><span class="hl-1">.</span><span class="hl-4">getClassicAddress</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">'10000000000'</span><span class="hl-1">,</span><br/><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">tfSetNoRipple:</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">trustSetTx</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">// TransactionType: 'TrustSet',</span><br/><span class="hl-7">// Account: 'r9dAdQQCBcGajVSeC9CqW3LCugjPDnAkEb',</span><br/><span class="hl-7">// LimitAmount: {</span><br/><span class="hl-7">// currency: 'FOO',</span><br/><span class="hl-7">// issuer: 'rWZzUjo5xGiAoRBqzsndyzonXz47UV8u1',</span><br/><span class="hl-7">// value: '10000000000'</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// Flags: 131072,</span><br/><span class="hl-7">// Sequence: 21971483,</span><br/><span class="hl-7">// Fee: '12',</span><br/><span class="hl-7">// LastLedgerSequence: 21971503</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">TrustSetFlagsInterface</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="TrustSetFlagsInterface.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfSetfAuth" class="tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth</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="tfClearFreeze" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Clear<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze<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/trustSet.ts#L91">src/models/transactions/trustSet.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Unfreeze the trust line.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfClearNoRipple" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Clear<wbr/>No<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple<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/trustSet.ts#L87">src/models/transactions/trustSet.ts:87</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Disable the No Ripple flag, allowing rippling on this trust line.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfSetFreeze" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Set<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze<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/trustSet.ts#L89">src/models/transactions/trustSet.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Freeze the trust line.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfSetNoRipple" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Set<wbr/>No<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple<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/trustSet.ts#L85">src/models/transactions/trustSet.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Enable the No Ripple flag, which blocks rippling between two trust lines
|
|
of the same currency if this flag is enabled on both.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tfSetfAuth" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> tf<wbr/>Setf<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth<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/trustSet.ts#L80">src/models/transactions/trustSet.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Authorize the other party to hold currency issued by this account. (No
|
|
effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.</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="TrustSetFlagsInterface.html" class="tsd-kind-icon">Trust<wbr/>Set<wbr/>Flags<wbr/>Interface</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="TrustSetFlagsInterface.html#tfSetfAuth" class="tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth</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> |