ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 04:05:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

build: update package.json version for release (#1755)

Browse Source 
* build: update xrpl.js for release
This commit is contained in:
Nathan Nichols
2021-10-20 11:34:58 -05:00
committed by GitHub
parent 910a5999c9
commit 14395ab58f
156 changed files with 7748 additions and 53858 deletions
Download Patch File Download Diff File Expand all files Collapse all files

351
docs/enums/AccountSetAsfFlags.html
View File

@@ -1,325 +1,26 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountSetAsfFlags | 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="AccountSetAsfFlags.html">AccountSetAsfFlags</a>
</li>
</ul>
<h1>Enumeration AccountSetAsfFlags</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>Enum for AccountSet Flags.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr>Account<wbr>TxnID</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr>Default<wbr>Ripple</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr>Deposit<wbr>Auth</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr>Disable<wbr>Master</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr>DisallowXRP</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr>Global<wbr>Freeze</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr>NoFreeze</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireAuth" class="tsd-kind-icon">asf<wbr>Require<wbr>Auth</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireDest" class="tsd-kind-icon">asf<wbr>Require<wbr>Dest</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfAccountTxnID" class="tsd-anchor"></a>
<h3>asf<wbr>Account<wbr>TxnID</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Account<wbr>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 5</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L31">src/models/transactions/accountSet.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Track the ID of this account&#39;s most recent transaction. Required for
AccountTxnID.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfDefaultRipple" class="tsd-anchor"></a>
<h3>asf<wbr>Default<wbr>Ripple</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Default<wbr>Ripple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L40">src/models/transactions/accountSet.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable rippling on this account&#39;s trust lines by default.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfDepositAuth" class="tsd-anchor"></a>
<h3>asf<wbr>Deposit<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Deposit<wbr>Auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 9</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L42">src/models/transactions/accountSet.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable Deposit Authorization on this account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfDisableMaster" class="tsd-anchor"></a>
<h3>asf<wbr>Disable<wbr>Master</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Disable<wbr>Master<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L26">src/models/transactions/accountSet.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disallow use of the master key pair. Can only be enabled if the account
has configured another way to sign transactions, such as a Regular Key or a
Signer List.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfDisallowXRP" class="tsd-anchor"></a>
<h3>asf<wbr>DisallowXRP</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>DisallowXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L20">src/models/transactions/accountSet.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>XRP should not be sent to this account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfGlobalFreeze" class="tsd-anchor"></a>
<h3>asf<wbr>Global<wbr>Freeze</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Global<wbr>Freeze<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 7</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L38">src/models/transactions/accountSet.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Freeze all assets issued by this account.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfNoFreeze" class="tsd-anchor"></a>
<h3>asf<wbr>NoFreeze</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>NoFreeze<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 6</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L36">src/models/transactions/accountSet.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Permanently give up the ability to freeze individual trust lines or
disable Global Freeze. This flag can never be disabled after being enabled.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfRequireAuth" class="tsd-anchor"></a>
<h3>asf<wbr>Require<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Require<wbr>Auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L18">src/models/transactions/accountSet.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Require authorization for users to hold balances issued by this address
can only be enabled if the address has no trust lines connected to it.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="asfRequireDest" class="tsd-anchor"></a>
<h3>asf<wbr>Require<wbr>Dest</h3>
<div class="tsd-signature tsd-kind-icon">asf<wbr>Require<wbr>Dest<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L13">src/models/transactions/accountSet.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Require a destination tag to send transactions to this account.</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-enum">
<a href="AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>Asf<wbr>Flags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr>Account<wbr>TxnID</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr>Default<wbr>Ripple</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr>Deposit<wbr>Auth</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr>Disable<wbr>Master</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr>DisallowXRP</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr>Global<wbr>Freeze</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr>NoFreeze</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfRequireAuth" class="tsd-kind-icon">asf<wbr>Require<wbr>Auth</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetAsfFlags.html#asfRequireDest" class="tsd-kind-icon">asf<wbr>Require<wbr>Dest</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>
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>AccountSetAsfFlags | 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="AccountSetAsfFlags.html">AccountSetAsfFlags</a></li></ul><h1>Enumeration AccountSetAsfFlags</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>Enum for AccountSet Flags.</p>
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr/>Account<wbr/>TxnID</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr/>Default<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr/>Deposit<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr/>Disable<wbr/>Master</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr/>Global<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr/>No<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireAuth" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireDest" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Dest</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfAccountTxnID" class="tsd-anchor"></a><h3>asf<wbr/>Account<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Account<wbr/>TxnID<span class="tsd-signature-symbol"> = 5</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L31">src/models/transactions/accountSet.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Track the ID of this account&#39;s most recent transaction. Required for
AccountTxnID.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfDefaultRipple" class="tsd-anchor"></a><h3>asf<wbr/>Default<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Default<wbr/>Ripple<span class="tsd-signature-symbol"> = 8</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L40">src/models/transactions/accountSet.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Enable rippling on this account&#39;s trust lines by default.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfDepositAuth" class="tsd-anchor"></a><h3>asf<wbr/>Deposit<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Deposit<wbr/>Auth<span class="tsd-signature-symbol"> = 9</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L42">src/models/transactions/accountSet.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Enable Deposit Authorization on this account.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfDisableMaster" class="tsd-anchor"></a><h3>asf<wbr/>Disable<wbr/>Master</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Disable<wbr/>Master<span class="tsd-signature-symbol"> = 4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L26">src/models/transactions/accountSet.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Disallow use of the master key pair. Can only be enabled if the account
has configured another way to sign transactions, such as a Regular Key or a
Signer List.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfDisallowXRP" class="tsd-anchor"></a><h3>asf<wbr/>DisallowXRP</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>DisallowXRP<span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L20">src/models/transactions/accountSet.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>XRP should not be sent to this account.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfGlobalFreeze" class="tsd-anchor"></a><h3>asf<wbr/>Global<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Global<wbr/>Freeze<span class="tsd-signature-symbol"> = 7</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L38">src/models/transactions/accountSet.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Freeze all assets issued by this account.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfNoFreeze" class="tsd-anchor"></a><h3>asf<wbr/>No<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>No<wbr/>Freeze<span class="tsd-signature-symbol"> = 6</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L36">src/models/transactions/accountSet.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Permanently give up the ability to freeze individual trust lines or
disable Global Freeze. This flag can never be disabled after being enabled.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfRequireAuth" class="tsd-anchor"></a><h3>asf<wbr/>Require<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L18">src/models/transactions/accountSet.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Require authorization for users to hold balances issued by this address
can only be enabled if the address has no trust lines connected to it.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="asfRequireDest" class="tsd-anchor"></a><h3>asf<wbr/>Require<wbr/>Dest</h3><div class="tsd-signature tsd-kind-icon">asf<wbr/>Require<wbr/>Dest<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L13">src/models/transactions/accountSet.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Require a destination tag to send transactions to this account.</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-enum"><a href="AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Asf<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfAccountTxnID" class="tsd-kind-icon">asf<wbr/>Account<wbr/>TxnID</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDefaultRipple" class="tsd-kind-icon">asf<wbr/>Default<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDepositAuth" class="tsd-kind-icon">asf<wbr/>Deposit<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisableMaster" class="tsd-kind-icon">asf<wbr/>Disable<wbr/>Master</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfDisallowXRP" class="tsd-kind-icon">asf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfGlobalFreeze" class="tsd-kind-icon">asf<wbr/>Global<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfNoFreeze" class="tsd-kind-icon">asf<wbr/>No<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireAuth" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetAsfFlags.html#asfRequireDest" class="tsd-kind-icon">asf<wbr/>Require<wbr/>Dest</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>

278
docs/enums/AccountSetTfFlags.html
View File

@@ -1,263 +1,15 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AccountSetTfFlags | 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="AccountSetTfFlags.html">AccountSetTfFlags</a>
</li>
</ul>
<h1>Enumeration AccountSetTfFlags</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>Enum for AccountSet Transaction Flags.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr>AllowXRP</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr>DisallowXRP</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr>Optional<wbr>Auth</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr>Require<wbr>Auth</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr>Require<wbr>Dest<wbr>Tag</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfAllowXRP" class="tsd-anchor"></a>
<h3>tf<wbr>AllowXRP</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>AllowXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2097152</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L62">src/models/transactions/accountSet.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as ClearFlag: asfDisallowXRP.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfDisallowXRP" class="tsd-anchor"></a>
<h3>tf<wbr>DisallowXRP</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>DisallowXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1048576</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L60">src/models/transactions/accountSet.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as SetFlag: asfDisallowXRP.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfOptionalAuth" class="tsd-anchor"></a>
<h3>tf<wbr>Optional<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Optional<wbr>Auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 524288</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L58">src/models/transactions/accountSet.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as ClearFlag: asfRequireAuth.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfOptionalDestTag" class="tsd-anchor"></a>
<h3>tf<wbr>Optional<wbr>Dest<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 131072</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L54">src/models/transactions/accountSet.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as ClearFlag: asfRequireDest.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfRequireAuth" class="tsd-anchor"></a>
<h3>tf<wbr>Require<wbr>Auth</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Require<wbr>Auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 262144</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L56">src/models/transactions/accountSet.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as SetFlag: asfRequireAuth.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfRequireDestTag" class="tsd-anchor"></a>
<h3>tf<wbr>Require<wbr>Dest<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Require<wbr>Dest<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 65536</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/accountSet.ts#L52">src/models/transactions/accountSet.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The same as SetFlag: asfRequireDest.</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-enum">
<a href="AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr>Set<wbr>TfFlags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetTfFlags.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr>AllowXRP</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetTfFlags.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr>DisallowXRP</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetTfFlags.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr>Optional<wbr>Auth</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetTfFlags.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr>Optional<wbr>Dest<wbr>Tag</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetTfFlags.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr>Require<wbr>Auth</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="AccountSetTfFlags.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr>Require<wbr>Dest<wbr>Tag</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>
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>AccountSetTfFlags | 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="AccountSetTfFlags.html">AccountSetTfFlags</a></li></ul><h1>Enumeration AccountSetTfFlags</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>Enum for AccountSet Transaction Flags.</p>
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr/>AllowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfAllowXRP" class="tsd-anchor"></a><h3>tf<wbr/>AllowXRP</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>AllowXRP<span class="tsd-signature-symbol"> = 2097152</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L62">src/models/transactions/accountSet.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The same as ClearFlag: asfDisallowXRP.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfDisallowXRP" class="tsd-anchor"></a><h3>tf<wbr/>DisallowXRP</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>DisallowXRP<span class="tsd-signature-symbol"> = 1048576</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L60">src/models/transactions/accountSet.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The same as SetFlag: asfDisallowXRP.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfOptionalAuth" class="tsd-anchor"></a><h3>tf<wbr/>Optional<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth<span class="tsd-signature-symbol"> = 524288</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L58">src/models/transactions/accountSet.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The same as ClearFlag: asfRequireAuth.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfOptionalDestTag" class="tsd-anchor"></a><h3>tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L54">src/models/transactions/accountSet.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The same as ClearFlag: asfRequireDest.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfRequireAuth" class="tsd-anchor"></a><h3>tf<wbr/>Require<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L56">src/models/transactions/accountSet.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The same as SetFlag: asfRequireAuth.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfRequireDestTag" class="tsd-anchor"></a><h3>tf<wbr/>Require<wbr/>Dest<wbr/>Tag</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/accountSet.ts#L52">src/models/transactions/accountSet.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The same as SetFlag: asfRequireDest.</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-enum"><a href="AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Tf<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfAllowXRP" class="tsd-kind-icon">tf<wbr/>AllowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfDisallowXRP" class="tsd-kind-icon">tf<wbr/>DisallowXRP</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalAuth" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfOptionalDestTag" class="tsd-kind-icon">tf<wbr/>Optional<wbr/>Dest<wbr/>Tag</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireAuth" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="AccountSetTfFlags.html#tfRequireDestTag" class="tsd-kind-icon">tf<wbr/>Require<wbr/>Dest<wbr/>Tag</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>

1
docs/enums/LedgerEntry.AccountRootFlags.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/enums/LedgerEntry.OfferFlags.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/enums/LedgerEntry.RippleStateFlags.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/enums/LedgerEntry.SignerListFlags.html Normal file
View File

File diff suppressed because one or more lines are too long

260
docs/enums/OfferCreateFlags.html
View File

@@ -1,237 +1,23 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OfferCreateFlags | 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="OfferCreateFlags.html">OfferCreateFlags</a>
</li>
</ul>
<h1>Enumeration OfferCreateFlags</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>Transaction Flags for an OfferCreate Transaction.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr>Fill<wbr>OrKill</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfPassive" class="tsd-kind-icon">tf<wbr>Passive</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfSell" class="tsd-kind-icon">tf<wbr>Sell</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfFillOrKill" class="tsd-anchor"></a>
<h3>tf<wbr>Fill<wbr>OrKill</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Fill<wbr>OrKill<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 262144</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L40">src/models/transactions/offerCreate.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Treat the offer as a Fill or Kill order . Only try to match existing
offers in the ledger, and only do so if the entire TakerPays quantity can
be obtained. If the fix1578 amendment is enabled and the offer cannot be
executed when placed, the transaction has the result code tecKILLED;
otherwise, the transaction uses the result code tesSUCCESS even when it was
killed without trading any currency.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfImmediateOrCancel" class="tsd-anchor"></a>
<h3>tf<wbr>Immediate<wbr>OrCancel</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 131072</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L31">src/models/transactions/offerCreate.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Treat the offer as an Immediate or Cancel order. If enabled, the offer
never becomes a ledger object: it only tries to match existing offers in
the ledger. If the offer cannot match any offers immediately, it executes
&quot;successfully&quot; without trading any currency. In this case, the transaction
has the result code tesSUCCESS, but creates no Offer objects in the ledger.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfPassive" class="tsd-anchor"></a>
<h3>tf<wbr>Passive</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Passive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 65536</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L23">src/models/transactions/offerCreate.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If enabled, the offer does not consume offers that exactly match it, and
instead becomes an Offer object in the ledger. It still consumes offers
that cross it.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfSell" class="tsd-anchor"></a>
<h3>tf<wbr>Sell</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Sell<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 524288</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/offerCreate.ts#L45">src/models/transactions/offerCreate.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Exchange the entire TakerGets amount, even if it means obtaining more than
the TakerPays amount in exchange.</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-enum">
<a href="OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Flags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="OfferCreateFlags.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr>Fill<wbr>OrKill</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="OfferCreateFlags.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr>Immediate<wbr>OrCancel</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="OfferCreateFlags.html#tfPassive" class="tsd-kind-icon">tf<wbr>Passive</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="OfferCreateFlags.html#tfSell" class="tsd-kind-icon">tf<wbr>Sell</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>
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>OfferCreateFlags | 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="OfferCreateFlags.html">OfferCreateFlags</a></li></ul><h1>Enumeration OfferCreateFlags</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>Transaction Flags for an OfferCreate Transaction.</p>
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfPassive" class="tsd-kind-icon">tf<wbr/>Passive</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfSell" class="tsd-kind-icon">tf<wbr/>Sell</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfFillOrKill" class="tsd-anchor"></a><h3>tf<wbr/>Fill<wbr/>Or<wbr/>Kill</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L40">src/models/transactions/offerCreate.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Treat the offer as a Fill or Kill order . Only try to match existing
offers in the ledger, and only do so if the entire TakerPays quantity can
be obtained. If the fix1578 amendment is enabled and the offer cannot be
executed when placed, the transaction has the result code tecKILLED;
otherwise, the transaction uses the result code tesSUCCESS even when it was
killed without trading any currency.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfImmediateOrCancel" class="tsd-anchor"></a><h3>tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L31">src/models/transactions/offerCreate.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Treat the offer as an Immediate or Cancel order. If enabled, the offer
never becomes a ledger object: it only tries to match existing offers in
the ledger. If the offer cannot match any offers immediately, it executes
&quot;successfully&quot; without trading any currency. In this case, the transaction
has the result code tesSUCCESS, but creates no Offer objects in the ledger.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfPassive" class="tsd-anchor"></a><h3>tf<wbr/>Passive</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Passive<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L23">src/models/transactions/offerCreate.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>If enabled, the offer does not consume offers that exactly match it, and
instead becomes an Offer object in the ledger. It still consumes offers
that cross it.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfSell" class="tsd-anchor"></a><h3>tf<wbr/>Sell</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Sell<span class="tsd-signature-symbol"> = 524288</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/offerCreate.ts#L45">src/models/transactions/offerCreate.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Exchange the entire TakerGets amount, even if it means obtaining more than
the TakerPays amount in exchange.</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-enum"><a href="OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr/>Create<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfFillOrKill" class="tsd-kind-icon">tf<wbr/>Fill<wbr/>Or<wbr/>Kill</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfImmediateOrCancel" class="tsd-kind-icon">tf<wbr/>Immediate<wbr/>Or<wbr/>Cancel</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfPassive" class="tsd-kind-icon">tf<wbr/>Passive</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="OfferCreateFlags.html#tfSell" class="tsd-kind-icon">tf<wbr/>Sell</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>

218
docs/enums/PaymentChannelClaimFlags.html
View File

@@ -1,199 +1,19 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PaymentChannelClaimFlags | 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="PaymentChannelClaimFlags.html">PaymentChannelClaimFlags</a>
</li>
</ul>
<h1>Enumeration PaymentChannelClaimFlags</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>Enum representing values for PaymentChannelClaim transaction flags.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfClose" class="tsd-kind-icon">tf<wbr>Close</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.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>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfClose" class="tsd-anchor"></a>
<h3>tf<wbr>Close</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 131072</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#L31">src/models/transactions/paymentChannelClaim.ts:31</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&#39;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-enum-member tsd-parent-kind-enum">
<a name="tfRenew" class="tsd-anchor"></a>
<h3>tf<wbr>Renew</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Renew<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 65536</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#L17">src/models/transactions/paymentChannelClaim.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Clear the channel&#39;s Expiration time. (Expiration is different from the
channel&#39;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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr>Channel<wbr>Claim<wbr>Flags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="PaymentChannelClaimFlags.html#tfClose" class="tsd-kind-icon">tf<wbr>Close</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="PaymentChannelClaimFlags.html#tfRenew" class="tsd-kind-icon">tf<wbr>Renew</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>
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PaymentChannelClaimFlags | 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="PaymentChannelClaimFlags.html">PaymentChannelClaimFlags</a></li></ul><h1>Enumeration PaymentChannelClaimFlags</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>Enum representing values for PaymentChannelClaim transaction flags.</p>
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.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>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfClose" class="tsd-anchor"></a><h3>tf<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Close<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/paymentChannelClaim.ts#L31">src/models/transactions/paymentChannelClaim.ts:31</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&#39;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-enum-member tsd-parent-kind-enum"><a name="tfRenew" class="tsd-anchor"></a><h3>tf<wbr/>Renew</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Renew<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/paymentChannelClaim.ts#L17">src/models/transactions/paymentChannelClaim.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Clear the channel&#39;s Expiration time. (Expiration is different from the
channel&#39;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-enum"><a href="PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.html#tfClose" class="tsd-kind-icon">tf<wbr/>Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentChannelClaimFlags.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>

227
docs/enums/PaymentFlags.html
View File

@@ -1,212 +1,15 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PaymentFlags | 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="PaymentFlags.html">PaymentFlags</a>
</li>
</ul>
<h1>Enumeration PaymentFlags</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>Enum representing values for Payment Transaction Flags.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfLimitQuality" class="tsd-kind-icon">tf<wbr>Limit<wbr>Quality</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfNoDirectRipple" class="tsd-kind-icon">tf<wbr>NoDirect<wbr>Ripple</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfPartialPayment" class="tsd-kind-icon">tf<wbr>Partial<wbr>Payment</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfLimitQuality" class="tsd-anchor"></a>
<h3>tf<wbr>Limit<wbr>Quality</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Limit<wbr>Quality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 262144</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L36">src/models/transactions/payment.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfNoDirectRipple" class="tsd-anchor"></a>
<h3>tf<wbr>NoDirect<wbr>Ripple</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>NoDirect<wbr>Ripple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 65536</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L24">src/models/transactions/payment.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfPartialPayment" class="tsd-anchor"></a>
<h3>tf<wbr>Partial<wbr>Payment</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Partial<wbr>Payment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 131072</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/payment.ts#L30">src/models/transactions/payment.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</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-enum">
<a href="PaymentFlags.html" class="tsd-kind-icon">Payment<wbr>Flags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="PaymentFlags.html#tfLimitQuality" class="tsd-kind-icon">tf<wbr>Limit<wbr>Quality</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="PaymentFlags.html#tfNoDirectRipple" class="tsd-kind-icon">tf<wbr>NoDirect<wbr>Ripple</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="PaymentFlags.html#tfPartialPayment" class="tsd-kind-icon">tf<wbr>Partial<wbr>Payment</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>
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PaymentFlags | 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="PaymentFlags.html">PaymentFlags</a></li></ul><h1>Enumeration PaymentFlags</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>Enum representing values for Payment Transaction Flags.</p>
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfLimitQuality" class="tsd-kind-icon">tf<wbr/>Limit<wbr/>Quality</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfNoDirectRipple" class="tsd-kind-icon">tf<wbr/>No<wbr/>Direct<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfPartialPayment" class="tsd-kind-icon">tf<wbr/>Partial<wbr/>Payment</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfLimitQuality" class="tsd-anchor"></a><h3>tf<wbr/>Limit<wbr/>Quality</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Limit<wbr/>Quality<span class="tsd-signature-symbol"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/payment.ts#L36">src/models/transactions/payment.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfNoDirectRipple" class="tsd-anchor"></a><h3>tf<wbr/>No<wbr/>Direct<wbr/>Ripple</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>No<wbr/>Direct<wbr/>Ripple<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/payment.ts#L24">src/models/transactions/payment.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfPartialPayment" class="tsd-anchor"></a><h3>tf<wbr/>Partial<wbr/>Payment</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Partial<wbr/>Payment<span class="tsd-signature-symbol"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/payment.ts#L30">src/models/transactions/payment.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<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></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-enum"><a href="PaymentFlags.html" class="tsd-kind-icon">Payment<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfLimitQuality" class="tsd-kind-icon">tf<wbr/>Limit<wbr/>Quality</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfNoDirectRipple" class="tsd-kind-icon">tf<wbr/>No<wbr/>Direct<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="PaymentFlags.html#tfPartialPayment" class="tsd-kind-icon">tf<wbr/>Partial<wbr/>Payment</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>

261
docs/enums/TrustSetFlags.html
View File

@@ -1,246 +1,15 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TrustSetFlags | 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="TrustSetFlags.html">TrustSetFlags</a>
</li>
</ul>
<h1>Enumeration TrustSetFlags</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>Enum representing values of <a href="../interfaces/TrustSet.html">TrustSet</a> transaction flags.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr>Clear<wbr>Freeze</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr>Clear<wbr>NoRipple</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr>Set<wbr>Freeze</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr>Set<wbr>NoRipple</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.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>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="tfClearFreeze" class="tsd-anchor"></a>
<h3>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-symbol"> = 2097152</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/trustSet.ts#L32">src/models/transactions/trustSet.ts:32</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-enum-member tsd-parent-kind-enum">
<a name="tfClearNoRipple" class="tsd-anchor"></a>
<h3>tf<wbr>Clear<wbr>NoRipple</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Clear<wbr>NoRipple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 262144</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/trustSet.ts#L28">src/models/transactions/trustSet.ts:28</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-enum-member tsd-parent-kind-enum">
<a name="tfSetFreeze" class="tsd-anchor"></a>
<h3>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-symbol"> = 1048576</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/trustSet.ts#L30">src/models/transactions/trustSet.ts:30</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-enum-member tsd-parent-kind-enum">
<a name="tfSetNoRipple" class="tsd-anchor"></a>
<h3>tf<wbr>Set<wbr>NoRipple</h3>
<div class="tsd-signature tsd-kind-icon">tf<wbr>Set<wbr>NoRipple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 131072</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/trustSet.ts#L26">src/models/transactions/trustSet.ts:26</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-enum-member tsd-parent-kind-enum">
<a name="tfSetfAuth" class="tsd-anchor"></a>
<h3>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-symbol"> = 65536</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/transactions/trustSet.ts#L21">src/models/transactions/trustSet.ts:21</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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr>Set<wbr>Flags</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="TrustSetFlags.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr>Clear<wbr>Freeze</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="TrustSetFlags.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr>Clear<wbr>NoRipple</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="TrustSetFlags.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr>Set<wbr>Freeze</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="TrustSetFlags.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr>Set<wbr>NoRipple</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="TrustSetFlags.html#tfSetfAuth" class="tsd-kind-icon">tf<wbr>Setf<wbr>Auth</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>
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TrustSetFlags | 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="TrustSetFlags.html">TrustSetFlags</a></li></ul><h1>Enumeration TrustSetFlags</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>Enum representing values of <a href="../interfaces/TrustSet.html">TrustSet</a> transaction flags.</p>
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.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>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a name="tfClearFreeze" class="tsd-anchor"></a><h3>tf<wbr/>Clear<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze<span class="tsd-signature-symbol"> = 2097152</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/trustSet.ts#L32">src/models/transactions/trustSet.ts:32</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-enum-member tsd-parent-kind-enum"><a name="tfClearNoRipple" class="tsd-anchor"></a><h3>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"> = 262144</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/trustSet.ts#L28">src/models/transactions/trustSet.ts:28</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-enum-member tsd-parent-kind-enum"><a name="tfSetFreeze" class="tsd-anchor"></a><h3>tf<wbr/>Set<wbr/>Freeze</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze<span class="tsd-signature-symbol"> = 1048576</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/trustSet.ts#L30">src/models/transactions/trustSet.ts:30</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-enum-member tsd-parent-kind-enum"><a name="tfSetNoRipple" class="tsd-anchor"></a><h3>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"> = 131072</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/trustSet.ts#L26">src/models/transactions/trustSet.ts:26</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-enum-member tsd-parent-kind-enum"><a name="tfSetfAuth" class="tsd-anchor"></a><h3>tf<wbr/>Setf<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">tf<wbr/>Setf<wbr/>Auth<span class="tsd-signature-symbol"> = 65536</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/transactions/trustSet.ts#L21">src/models/transactions/trustSet.ts:21</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-enum"><a href="TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr/>Set<wbr/>Flags</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearFreeze" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfClearNoRipple" class="tsd-kind-icon">tf<wbr/>Clear<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetFreeze" class="tsd-kind-icon">tf<wbr/>Set<wbr/>Freeze</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.html#tfSetNoRipple" class="tsd-kind-icon">tf<wbr/>Set<wbr/>No<wbr/>Ripple</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="TrustSetFlags.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>