This commit is contained in:
bthomee
2025-08-05 15:33:18 +00:00
parent a71018c685
commit f4b9019010
138 changed files with 5965 additions and 5961 deletions

View File

@@ -630,7 +630,7 @@ $(function() {
<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_a1bdde33b446d3f98ddf6f1fd92baeca7"><div class="ttname"><a href="namespaceripple.html#a1bdde33b446d3f98ddf6f1fd92baeca7">ripple::TOTAL_TIME_SLOT_SECS</a></div><div class="ttdeci">std::uint32_t constexpr TOTAL_TIME_SLOT_SECS</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8h_source.html#l00034">AMMCore.h:34</a></div></div>
<div class="ttc" id="anamespaceripple_html_a20d30277b9c78756b3d14493055a307c"><div class="ttname"><a href="namespaceripple.html#a20d30277b9c78756b3d14493055a307c">ripple::isXRP</a></div><div class="ttdeci">bool isXRP(AccountID const &amp;c)</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8h_source.html#l00090">AccountID.h:90</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2da08ee715495ec871618786c8afec80"><div class="ttname"><a href="namespaceripple.html#a2da08ee715495ec871618786c8afec80">ripple::deleteAMMTrustLine</a></div><div class="ttdeci">TER deleteAMMTrustLine(ApplyView &amp;view, std::shared_ptr&lt; SLE &gt; sleState, std::optional&lt; AccountID &gt; const &amp;ammAccountID, beast::Journal j)</div><div class="ttdoc">Delete trustline to AMM.</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l02620">View.cpp:2620</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2da08ee715495ec871618786c8afec80"><div class="ttname"><a href="namespaceripple.html#a2da08ee715495ec871618786c8afec80">ripple::deleteAMMTrustLine</a></div><div class="ttdeci">TER deleteAMMTrustLine(ApplyView &amp;view, std::shared_ptr&lt; SLE &gt; sleState, std::optional&lt; AccountID &gt; const &amp;ammAccountID, beast::Journal j)</div><div class="ttdoc">Delete trustline to AMM.</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l02720">View.cpp:2720</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2e120e21ebcb5778e7ead49555f5297f"><div class="ttname"><a href="namespaceripple.html#a2e120e21ebcb5778e7ead49555f5297f">ripple::ammLPTCurrency</a></div><div class="ttdeci">Currency ammLPTCurrency(Currency const &amp;cur1, Currency const &amp;cur2)</div><div class="ttdoc">Calculate Liquidity Provider Token (LPT) Currency.</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8cpp_source.html#l00043">AMMCore.cpp:43</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>
@@ -638,7 +638,7 @@ $(function() {
<div class="ttc" id="anamespaceripple_html_a5c353aea81a72e698c287a3e5289619aabafd7322c6e97d25b6299b5d6fe8920b"><div class="ttname"><a href="namespaceripple.html#a5c353aea81a72e698c287a3e5289619aabafd7322c6e97d25b6299b5d6fe8920b">ripple::SkipEntry::No</a></div><div class="ttdeci">@ No</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_a6cb89b79bc073abda42953c323d36cda"><div class="ttname"><a href="namespaceripple.html#a6cb89b79bc073abda42953c323d36cda">ripple::isFrozen</a></div><div class="ttdeci">bool isFrozen(ReadView const &amp;view, AccountID const &amp;account, Currency const &amp;currency, AccountID const &amp;issuer)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l00249">View.cpp:249</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6cb89b79bc073abda42953c323d36cda"><div class="ttname"><a href="namespaceripple.html#a6cb89b79bc073abda42953c323d36cda">ripple::isFrozen</a></div><div class="ttdeci">bool isFrozen(ReadView const &amp;view, AccountID const &amp;account, Currency const &amp;currency, AccountID const &amp;issuer)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l00248">View.cpp:248</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_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>
@@ -649,11 +649,11 @@ $(function() {
<div class="ttc" id="anamespaceripple_html_aaa934f7a06a533f8eae7acf597b2161d"><div class="ttname"><a href="namespaceripple.html#aaa934f7a06a533f8eae7acf597b2161d">ripple::VOTE_WEIGHT_SCALE_FACTOR</a></div><div class="ttdeci">std::uint32_t constexpr VOTE_WEIGHT_SCALE_FACTOR</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8h_source.html#l00045">AMMCore.h:45</a></div></div>
<div class="ttc" id="anamespaceripple_html_aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151"><div class="ttname"><a href="namespaceripple.html#aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151">ripple::tesSUCCESS</a></div><div class="ttdeci">@ tesSUCCESS</div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00245">TER.h:244</a></div></div>
<div class="ttc" id="anamespaceripple_html_aac3db9cd7b81ce8bd1ebf45435f0909b"><div class="ttname"><a href="namespaceripple.html#aac3db9cd7b81ce8bd1ebf45435f0909b">ripple::invalidAMMAssetPair</a></div><div class="ttdeci">NotTEC invalidAMMAssetPair(Issue const &amp;issue1, Issue const &amp;issue2, std::optional&lt; std::pair&lt; Issue, Issue &gt; &gt; const &amp;pair=std::nullopt)</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8cpp_source.html#l00080">AMMCore.cpp:80</a></div></div>
<div class="ttc" id="anamespaceripple_html_ab001e43f50e612727b1ce5985a2770d6"><div class="ttname"><a href="namespaceripple.html#ab001e43f50e612727b1ce5985a2770d6">ripple::accountHolds</a></div><div class="ttdeci">STAmount accountHolds(ReadView const &amp;view, AccountID const &amp;account, Currency const &amp;currency, AccountID const &amp;issuer, FreezeHandling zeroIfFrozen, beast::Journal j)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l00386">View.cpp:386</a></div></div>
<div class="ttc" id="anamespaceripple_html_ab001e43f50e612727b1ce5985a2770d6"><div class="ttname"><a href="namespaceripple.html#ab001e43f50e612727b1ce5985a2770d6">ripple::accountHolds</a></div><div class="ttdeci">STAmount accountHolds(ReadView const &amp;view, AccountID const &amp;account, Currency const &amp;currency, AccountID const &amp;issuer, FreezeHandling zeroIfFrozen, beast::Journal j)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l00385">View.cpp:385</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_ac124fe6744b7fe887dec949b56b16d50"><div class="ttname"><a href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">ripple::to_string</a></div><div class="ttdeci">std::string to_string(base_uint&lt; Bits, Tag &gt; const &amp;a)</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00630">base_uint.h:630</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac151bf19e1f4daae2b04c65c65117139"><div class="ttname"><a href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">ripple::LedgerEntryType</a></div><div class="ttdeci">LedgerEntryType</div><div class="ttdoc">Identifiers for on-ledger objects.</div><div class="ttdef"><b>Definition:</b> <a href="LedgerFormats_8h_source.html#l00053">LedgerFormats.h:54</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac63838a9be23c18086f1f05c78867399"><div class="ttname"><a href="namespaceripple.html#ac63838a9be23c18086f1f05c78867399">ripple::cleanupOnAccountDelete</a></div><div class="ttdeci">TER cleanupOnAccountDelete(ApplyView &amp;view, Keylet const &amp;ownerDirKeylet, EntryDeleter const &amp;deleter, beast::Journal j, std::optional&lt; uint16_t &gt; maxNodesToDelete)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l02542">View.cpp:2542</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac63838a9be23c18086f1f05c78867399"><div class="ttname"><a href="namespaceripple.html#ac63838a9be23c18086f1f05c78867399">ripple::cleanupOnAccountDelete</a></div><div class="ttdeci">TER cleanupOnAccountDelete(ApplyView &amp;view, Keylet const &amp;ownerDirKeylet, EntryDeleter const &amp;deleter, beast::Journal j, std::optional&lt; uint16_t &gt; maxNodesToDelete)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l02642">View.cpp:2642</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_acdc87ea9c4ad1742d4aeebac963e8570"><div class="ttname"><a href="namespaceripple.html#acdc87ea9c4ad1742d4aeebac963e8570">ripple::root</a></div><div class="ttdeci">Number root(Number f, unsigned d)</div><div class="ttdef"><b>Definition:</b> <a href="Number_8cpp_source.html#l00636">Number.cpp:636</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad961eb0fea4cf5a88afbb1855530ffe5"><div class="ttname"><a href="namespaceripple.html#ad961eb0fea4cf5a88afbb1855530ffe5">ripple::maxDeletableAMMTrustLines</a></div><div class="ttdeci">std::uint16_t constexpr maxDeletableAMMTrustLines</div><div class="ttdoc">The maximum number of trustlines to delete as part of AMM account deletion cleanup.</div><div class="ttdef"><b>Definition:</b> <a href="Protocol_8h_source.html#l00141">Protocol.h:141</a></div></div>