ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 03:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: fb3713bc25

Browse Source
This commit is contained in:
bthomee
2025-02-05 18:09:38 +00:00
parent 6a62347038
commit 7e62619de6
209 changed files with 19270 additions and 16367 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
AMMUtils_8h_source.html
View File

@@ -186,17 +186,17 @@ $(function() {
<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#l00026">algorithm.h:26</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#l00049">AccountID.h:49</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#l00080">View.h:80</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#l00145">AMMUtils.cpp:145</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#l00249">AMMUtils.cpp:249</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#l00353">AMMUtils.cpp:353</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#l00177">AMMUtils.cpp:177</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#l00281">AMMUtils.cpp:281</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#l00385">AMMUtils.cpp:385</a></div></div>
<div class="ttc" id="anamespaceripple_html_a768092086ea18d2dbeb64efb9fa12ba5"><div class="ttname"><a href="namespaceripple.html#a768092086ea18d2dbeb64efb9fa12ba5">ripple::ammAccountID</a></div><div class="ttdeci">AccountID ammAccountID(std::uint16_t prefix, uint256 const &amp;parentHash, uint256 const &amp;ammID)</div><div class="ttdoc">Calculate AMM account ID.</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8cpp_source.html#l00030">AMMCore.cpp:30</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#l00306">AMMUtils.cpp:306</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#l00338">AMMUtils.cpp:338</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#l00111">AMMUtils.cpp:111</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#l00029">AMMUtils.cpp:29</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#l00045">AMMUtils.cpp:45</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#l00177">AMMUtils.cpp:177</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#l00209">AMMUtils.cpp:209</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#l00627">TER.h:627</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>