This commit is contained in:
bthomee
2025-07-11 20:07:51 +00:00
parent d2ff10dd51
commit 4efb77b0da
123 changed files with 14890 additions and 14937 deletions

View File

@@ -180,24 +180,32 @@ $(function() {
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> Issue <span class="keyword">const</span>&amp; ammIssue,</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <a class="code hl_typedef" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> <span class="keyword">const</span>&amp; lpAccount);</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_APP_MISC_AMMUTILS_H_INCLUDED</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>Expected&lt;bool, TER&gt;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><a class="code hl_function" href="namespaceripple.html#a6c0288f25088dd5b24ce567290b2a75b">verifyAndAdjustLPTokenBalance</a>(</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> Sandbox&amp; sb,</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> STAmount <span class="keyword">const</span>&amp; lpTokens,</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SLE&gt;</a>&amp; ammSle,</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <a class="code hl_typedef" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> <span class="keyword">const</span>&amp; account);</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_APP_MISC_AMMUTILS_H_INCLUDED</span></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition:</b> <a href="Journal_8h_source.html#l00059">Journal.h:60</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a00ae0d729cb3e35b6bcac9a27ebb5284"><div class="ttname"><a href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">ripple::AccountID</a></div><div class="ttdeci">base_uint&lt; 160, detail::AccountIDTag &gt; AccountID</div><div class="ttdoc">A 160-bit unsigned that uniquely identifies an account.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8h_source.html#l00048">AccountID.h:48</a></div></div>
<div class="ttc" id="anamespaceripple_html_a17a9a9b903b66e49f5413d82ce79f085"><div class="ttname"><a href="namespaceripple.html#a17a9a9b903b66e49f5413d82ce79f085">ripple::FreezeHandling</a></div><div class="ttdeci">FreezeHandling</div><div class="ttdoc">Controls the treatment of frozen account balances.</div><div class="ttdef"><b>Definition:</b> <a href="View_8h_source.html#l00078">View.h:78</a></div></div>
<div class="ttc" id="anamespaceripple_html_a308162f4d3c7b3c005ee6907ab576da1"><div class="ttname"><a href="namespaceripple.html#a308162f4d3c7b3c005ee6907ab576da1">ripple::getTradingFee</a></div><div class="ttdeci">std::uint16_t getTradingFee(ReadView const &amp;view, SLE const &amp;ammSle, AccountID const &amp;account)</div><div class="ttdoc">Get AMM trading fee for the given account.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00178">AMMUtils.cpp:178</a></div></div>
<div class="ttc" id="anamespaceripple_html_a39496f811d81eeceaec4ab1fe9f877ac"><div class="ttname"><a href="namespaceripple.html#a39496f811d81eeceaec4ab1fe9f877ac">ripple::deleteAMMAccount</a></div><div class="ttdeci">TER deleteAMMAccount(Sandbox &amp;view, Issue const &amp;asset, Issue const &amp;asset2, beast::Journal j)</div><div class="ttdoc">Delete trustlines to AMM.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00282">AMMUtils.cpp:282</a></div></div>
<div class="ttc" id="anamespaceripple_html_a62e9ba0cf1379cc7c73007cafd91b972"><div class="ttname"><a href="namespaceripple.html#a62e9ba0cf1379cc7c73007cafd91b972">ripple::isOnlyLiquidityProvider</a></div><div class="ttdeci">Expected&lt; bool, TER &gt; isOnlyLiquidityProvider(ReadView const &amp;view, Issue const &amp;ammIssue, AccountID const &amp;lpAccount)</div><div class="ttdoc">Return true if the Liquidity Provider is the only AMM provider, false otherwise.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00386">AMMUtils.cpp:386</a></div></div>
<div class="ttc" id="anamespaceripple_html_a78b3ccb8c17df3888bf47d05cb5376c1"><div class="ttname"><a href="namespaceripple.html#a78b3ccb8c17df3888bf47d05cb5376c1">ripple::initializeFeeAuctionVote</a></div><div class="ttdeci">void initializeFeeAuctionVote(ApplyView &amp;view, std::shared_ptr&lt; SLE &gt; &amp;ammSle, AccountID const &amp;account, Issue const &amp;lptIssue, std::uint16_t tfee)</div><div class="ttdoc">Initialize Auction and Voting slots and set the trading/discounted fee.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00339">AMMUtils.cpp:339</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7c5d3108f4942ebc53a3fa4f83c2d577"><div class="ttname"><a href="namespaceripple.html#a7c5d3108f4942ebc53a3fa4f83c2d577">ripple::ammLPHolds</a></div><div class="ttdeci">STAmount ammLPHolds(ReadView const &amp;view, Currency const &amp;cur1, Currency const &amp;cur2, AccountID const &amp;ammAccount, AccountID const &amp;lpAccount, beast::Journal const j)</div><div class="ttdoc">Get the balance of LP tokens.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00112">AMMUtils.cpp:112</a></div></div>
<div class="ttc" id="anamespaceripple_html_a308162f4d3c7b3c005ee6907ab576da1"><div class="ttname"><a href="namespaceripple.html#a308162f4d3c7b3c005ee6907ab576da1">ripple::getTradingFee</a></div><div class="ttdeci">std::uint16_t getTradingFee(ReadView const &amp;view, SLE const &amp;ammSle, AccountID const &amp;account)</div><div class="ttdoc">Get AMM trading fee for the given account.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00179">AMMUtils.cpp:179</a></div></div>
<div class="ttc" id="anamespaceripple_html_a39496f811d81eeceaec4ab1fe9f877ac"><div class="ttname"><a href="namespaceripple.html#a39496f811d81eeceaec4ab1fe9f877ac">ripple::deleteAMMAccount</a></div><div class="ttdeci">TER deleteAMMAccount(Sandbox &amp;view, Issue const &amp;asset, Issue const &amp;asset2, beast::Journal j)</div><div class="ttdoc">Delete trustlines to AMM.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00283">AMMUtils.cpp:283</a></div></div>
<div class="ttc" id="anamespaceripple_html_a62e9ba0cf1379cc7c73007cafd91b972"><div class="ttname"><a href="namespaceripple.html#a62e9ba0cf1379cc7c73007cafd91b972">ripple::isOnlyLiquidityProvider</a></div><div class="ttdeci">Expected&lt; bool, TER &gt; isOnlyLiquidityProvider(ReadView const &amp;view, Issue const &amp;ammIssue, AccountID const &amp;lpAccount)</div><div class="ttdoc">Return true if the Liquidity Provider is the only AMM provider, false otherwise.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00387">AMMUtils.cpp:387</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6c0288f25088dd5b24ce567290b2a75b"><div class="ttname"><a href="namespaceripple.html#a6c0288f25088dd5b24ce567290b2a75b">ripple::verifyAndAdjustLPTokenBalance</a></div><div class="ttdeci">Expected&lt; bool, TER &gt; verifyAndAdjustLPTokenBalance(Sandbox &amp;sb, STAmount const &amp;lpTokens, std::shared_ptr&lt; SLE &gt; &amp;ammSle, AccountID const &amp;account)</div><div class="ttdoc">Due to rounding, the LPTokenBalance of the last LP might not match the LP's trustline balance.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00469">AMMUtils.cpp:469</a></div></div>
<div class="ttc" id="anamespaceripple_html_a78b3ccb8c17df3888bf47d05cb5376c1"><div class="ttname"><a href="namespaceripple.html#a78b3ccb8c17df3888bf47d05cb5376c1">ripple::initializeFeeAuctionVote</a></div><div class="ttdeci">void initializeFeeAuctionVote(ApplyView &amp;view, std::shared_ptr&lt; SLE &gt; &amp;ammSle, AccountID const &amp;account, Issue const &amp;lptIssue, std::uint16_t tfee)</div><div class="ttdoc">Initialize Auction and Voting slots and set the trading/discounted fee.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00340">AMMUtils.cpp:340</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7c5d3108f4942ebc53a3fa4f83c2d577"><div class="ttname"><a href="namespaceripple.html#a7c5d3108f4942ebc53a3fa4f83c2d577">ripple::ammLPHolds</a></div><div class="ttdeci">STAmount ammLPHolds(ReadView const &amp;view, Currency const &amp;cur1, Currency const &amp;cur2, AccountID const &amp;ammAccount, AccountID const &amp;lpAccount, beast::Journal const j)</div><div class="ttdoc">Get the balance of LP tokens.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00113">AMMUtils.cpp:113</a></div></div>
<div class="ttc" id="anamespaceripple_html_a8792cc3f99463ceba4e96dde34fe17a4"><div class="ttname"><a href="namespaceripple.html#a8792cc3f99463ceba4e96dde34fe17a4">ripple::Currency</a></div><div class="ttdeci">base_uint&lt; 160, detail::CurrencyTag &gt; Currency</div><div class="ttdoc">Currency is a hash representing a specific currency.</div><div class="ttdef"><b>Definition:</b> <a href="UintTypes_8h_source.html#l00056">UintTypes.h:56</a></div></div>
<div class="ttc" id="anamespaceripple_html_a887bf45d7cc0bf68aec6440746faca36"><div class="ttname"><a href="namespaceripple.html#a887bf45d7cc0bf68aec6440746faca36">ripple::ammPoolHolds</a></div><div class="ttdeci">std::pair&lt; STAmount, STAmount &gt; ammPoolHolds(ReadView const &amp;view, AccountID const &amp;ammAccountID, Issue const &amp;issue1, Issue const &amp;issue2, FreezeHandling freezeHandling, beast::Journal const j)</div><div class="ttdoc">Get AMM pool balances.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00030">AMMUtils.cpp:30</a></div></div>
<div class="ttc" id="anamespaceripple_html_ab656cc4e3a94b007e52a53420c2d2460"><div class="ttname"><a href="namespaceripple.html#ab656cc4e3a94b007e52a53420c2d2460">ripple::ammHolds</a></div><div class="ttdeci">Expected&lt; std::tuple&lt; STAmount, STAmount, STAmount &gt;, TER &gt; ammHolds(ReadView const &amp;view, SLE const &amp;ammSle, std::optional&lt; Issue &gt; const &amp;optIssue1, std::optional&lt; Issue &gt; const &amp;optIssue2, FreezeHandling freezeHandling, beast::Journal const j)</div><div class="ttdoc">Get AMM pool and LP token balances.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00046">AMMUtils.cpp:46</a></div></div>
<div class="ttc" id="anamespaceripple_html_a887bf45d7cc0bf68aec6440746faca36"><div class="ttname"><a href="namespaceripple.html#a887bf45d7cc0bf68aec6440746faca36">ripple::ammPoolHolds</a></div><div class="ttdeci">std::pair&lt; STAmount, STAmount &gt; ammPoolHolds(ReadView const &amp;view, AccountID const &amp;ammAccountID, Issue const &amp;issue1, Issue const &amp;issue2, FreezeHandling freezeHandling, beast::Journal const j)</div><div class="ttdoc">Get AMM pool balances.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00031">AMMUtils.cpp:31</a></div></div>
<div class="ttc" id="anamespaceripple_html_ab656cc4e3a94b007e52a53420c2d2460"><div class="ttname"><a href="namespaceripple.html#ab656cc4e3a94b007e52a53420c2d2460">ripple::ammHolds</a></div><div class="ttdeci">Expected&lt; std::tuple&lt; STAmount, STAmount, STAmount &gt;, TER &gt; ammHolds(ReadView const &amp;view, SLE const &amp;ammSle, std::optional&lt; Issue &gt; const &amp;optIssue1, std::optional&lt; Issue &gt; const &amp;optIssue2, FreezeHandling freezeHandling, beast::Journal const j)</div><div class="ttdoc">Get AMM pool and LP token balances.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00047">AMMUtils.cpp:47</a></div></div>
<div class="ttc" id="anamespaceripple_html_abbba3966df1925ac76f6d04c0aa1abe3"><div class="ttname"><a href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">ripple::SLE</a></div><div class="ttdeci">STLedgerEntry SLE</div><div class="ttdef"><b>Definition:</b> <a href="STLedgerEntry_8h_source.html#l00097">STLedgerEntry.h:97</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac7da6b05048137df6afafbcb4af6343a"><div class="ttname"><a href="namespaceripple.html#ac7da6b05048137df6afafbcb4af6343a">ripple::ammAccountHolds</a></div><div class="ttdeci">STAmount ammAccountHolds(ReadView const &amp;view, AccountID const &amp;ammAccountID, Issue const &amp;issue)</div><div class="ttdoc">Returns total amount held by AMM for the given token.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00210">AMMUtils.cpp:210</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac7da6b05048137df6afafbcb4af6343a"><div class="ttname"><a href="namespaceripple.html#ac7da6b05048137df6afafbcb4af6343a">ripple::ammAccountHolds</a></div><div class="ttdeci">STAmount ammAccountHolds(ReadView const &amp;view, AccountID const &amp;ammAccountID, Issue const &amp;issue)</div><div class="ttdoc">Returns total amount held by AMM for the given token.</div><div class="ttdef"><b>Definition:</b> <a href="AMMUtils_8cpp_source.html#l00211">AMMUtils.cpp:211</a></div></div>
<div class="ttc" id="anamespaceripple_html_adfb760bc3e4ccb79d5d4f6ecff2f1817"><div class="ttname"><a href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">ripple::TER</a></div><div class="ttdeci">TERSubset&lt; CanCvtToTER &gt; TER</div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00645">TER.h:645</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>