ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-01 00:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 8637d606a4

Browse Source
This commit is contained in:
bthomee
2025-10-13 07:59:26 -07:00
parent 4aaf7703d2
commit 940050298d
174 changed files with 10473 additions and 10348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
AMMWithdraw_8h_source.html
View File

@@ -265,22 +265,22 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_TX_AMMWITHDRAW_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="aclassripple_1_1AMMWithdraw_html"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html">ripple::AMMWithdraw</a></div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8h_source.html#l00070">AMMWithdraw.h:71</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a0b14d4c7e7868ef1bd417b63cd42063b"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a0b14d4c7e7868ef1bd417b63cd42063b">ripple::AMMWithdraw::isWithdrawAll</a></div><div class="ttdeci">static WithdrawAll isWithdrawAll(STTx const &amp;tx)</div><div class="ttdoc">Check from the flags if it's withdraw all.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l01098">AMMWithdraw.cpp:1098</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a0b14d4c7e7868ef1bd417b63cd42063b"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a0b14d4c7e7868ef1bd417b63cd42063b">ripple::AMMWithdraw::isWithdrawAll</a></div><div class="ttdeci">static WithdrawAll isWithdrawAll(STTx const &amp;tx)</div><div class="ttdoc">Check from the flags if it's withdraw all.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l01100">AMMWithdraw.cpp:1100</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a1f5c2849da27382f58a3ac7e04442f90"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a1f5c2849da27382f58a3ac7e04442f90">ripple::AMMWithdraw::checkExtraFeatures</a></div><div class="ttdeci">static bool checkExtraFeatures(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00032">AMMWithdraw.cpp:32</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a345ddd0ca98b576c85173513861b6366"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a345ddd0ca98b576c85173513861b6366">ripple::AMMWithdraw::AMMWithdraw</a></div><div class="ttdeci">AMMWithdraw(ApplyContext &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8h_source.html#l00075">AMMWithdraw.h:75</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a4318b71ceedb46714e2d93a6db8e93c9"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a4318b71ceedb46714e2d93a6db8e93c9">ripple::AMMWithdraw::singleWithdrawEPrice</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleWithdrawEPrice(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;ePrice, std::uint16_t tfee)</div><div class="ttdoc">Withdraw single asset (Asset1Out, EPrice) with two constraints.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l01037">AMMWithdraw.cpp:1037</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a5236e8a4e14c231694b6952abfc3b423"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a5236e8a4e14c231694b6952abfc3b423">ripple::AMMWithdraw::equalWithdrawLimit</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; equalWithdrawLimit(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount2Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;amount2, std::uint16_t tfee)</div><div class="ttdoc">Withdraw both assets (Asset1Out, Asset2Out) with the constraints on the maximum amount of each asset ...</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00859">AMMWithdraw.cpp:859</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a64842cf86a14dfe5dcc9019eb55511d0"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a64842cf86a14dfe5dcc9019eb55511d0">ripple::AMMWithdraw::equalWithdrawTokens</a></div><div class="ttdeci">static std::tuple&lt; TER, STAmount, STAmount, std::optional&lt; STAmount &gt; &gt; equalWithdrawTokens(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const account, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount2Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokens, STAmount const &amp;lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHanding, WithdrawAll withdrawAll, XRPAmount const &amp;priorBalance, beast::Journal const &amp;journal)</div><div class="ttdoc">Equal-asset withdrawal (LPTokens) of some AMM instance pools shares represented by the number of LPTo...</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00751">AMMWithdraw.cpp:751</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a690f2bdea8fffee52a5d12db0733b28b"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a690f2bdea8fffee52a5d12db0733b28b">ripple::AMMWithdraw::applyGuts</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; applyGuts(Sandbox &amp;view)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00293">AMMWithdraw.cpp:293</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a6f66fea4d10c565cbc522980f248eee2"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a6f66fea4d10c565cbc522980f248eee2">ripple::AMMWithdraw::singleWithdraw</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleWithdraw(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, std::uint16_t tfee)</div><div class="ttdoc">Single asset withdrawal (Asset1Out) equivalent to the amount specified in Asset1Out.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00934">AMMWithdraw.cpp:934</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a4318b71ceedb46714e2d93a6db8e93c9"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a4318b71ceedb46714e2d93a6db8e93c9">ripple::AMMWithdraw::singleWithdrawEPrice</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleWithdrawEPrice(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;ePrice, std::uint16_t tfee)</div><div class="ttdoc">Withdraw single asset (Asset1Out, EPrice) with two constraints.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l01039">AMMWithdraw.cpp:1039</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a5236e8a4e14c231694b6952abfc3b423"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a5236e8a4e14c231694b6952abfc3b423">ripple::AMMWithdraw::equalWithdrawLimit</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; equalWithdrawLimit(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount2Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;amount2, std::uint16_t tfee)</div><div class="ttdoc">Withdraw both assets (Asset1Out, Asset2Out) with the constraints on the maximum amount of each asset ...</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00861">AMMWithdraw.cpp:861</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a64842cf86a14dfe5dcc9019eb55511d0"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a64842cf86a14dfe5dcc9019eb55511d0">ripple::AMMWithdraw::equalWithdrawTokens</a></div><div class="ttdeci">static std::tuple&lt; TER, STAmount, STAmount, std::optional&lt; STAmount &gt; &gt; equalWithdrawTokens(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const account, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount2Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokens, STAmount const &amp;lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHanding, WithdrawAll withdrawAll, XRPAmount const &amp;priorBalance, beast::Journal const &amp;journal)</div><div class="ttdoc">Equal-asset withdrawal (LPTokens) of some AMM instance pools shares represented by the number of LPTo...</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00753">AMMWithdraw.cpp:753</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a690f2bdea8fffee52a5d12db0733b28b"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a690f2bdea8fffee52a5d12db0733b28b">ripple::AMMWithdraw::applyGuts</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; applyGuts(Sandbox &amp;view)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00295">AMMWithdraw.cpp:295</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a6f66fea4d10c565cbc522980f248eee2"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a6f66fea4d10c565cbc522980f248eee2">ripple::AMMWithdraw::singleWithdraw</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleWithdraw(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, std::uint16_t tfee)</div><div class="ttdoc">Single asset withdrawal (Asset1Out) equivalent to the amount specified in Asset1Out.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00936">AMMWithdraw.cpp:936</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a951edc48bf0cee75293ce82b7ba7b61c"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a951edc48bf0cee75293ce82b7ba7b61c">ripple::AMMWithdraw::ConsequencesFactory</a></div><div class="ttdeci">static constexpr ConsequencesFactoryType ConsequencesFactory</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8h_source.html#l00073">AMMWithdraw.h:73</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ab62952f0d0ed8f24c7a5dddcbbc5c9ae"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ab62952f0d0ed8f24c7a5dddcbbc5c9ae">ripple::AMMWithdraw::deleteAMMAccountIfEmpty</a></div><div class="ttdeci">static std::pair&lt; TER, bool &gt; deleteAMMAccountIfEmpty(Sandbox &amp;sb, std::shared_ptr&lt; SLE &gt; const ammSle, STAmount const &amp;lpTokenBalance, Issue const &amp;issue1, Issue const &amp;issue2, beast::Journal const &amp;journal)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00720">AMMWithdraw.cpp:720</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ab62952f0d0ed8f24c7a5dddcbbc5c9ae"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ab62952f0d0ed8f24c7a5dddcbbc5c9ae">ripple::AMMWithdraw::deleteAMMAccountIfEmpty</a></div><div class="ttdeci">static std::pair&lt; TER, bool &gt; deleteAMMAccountIfEmpty(Sandbox &amp;sb, std::shared_ptr&lt; SLE &gt; const ammSle, STAmount const &amp;lpTokenBalance, Issue const &amp;issue1, Issue const &amp;issue2, beast::Journal const &amp;journal)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00722">AMMWithdraw.cpp:722</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ac65c94e120bdb3957a6951fab2af6c29"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ac65c94e120bdb3957a6951fab2af6c29">ripple::AMMWithdraw::preclaim</a></div><div class="ttdeci">static TER preclaim(PreclaimContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00169">AMMWithdraw.cpp:169</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_acf1048871867fae517d6e38c09f9ffd8"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#acf1048871867fae517d6e38c09f9ffd8">ripple::AMMWithdraw::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00044">AMMWithdraw.cpp:44</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ad1c31e18b3be405513e9e68004e72f09"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ad1c31e18b3be405513e9e68004e72f09">ripple::AMMWithdraw::withdraw</a></div><div class="ttdeci">static std::tuple&lt; TER, STAmount, STAmount, std::optional&lt; STAmount &gt; &gt; withdraw(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, AccountID const &amp;account, STAmount const &amp;amountBalance, STAmount const &amp;amountWithdraw, std::optional&lt; STAmount &gt; const &amp;amount2Withdraw, STAmount const &amp;lpTokensAMMBalance, STAmount const &amp;lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHandling, WithdrawAll withdrawAll, XRPAmount const &amp;priorBalance, beast::Journal const &amp;journal)</div><div class="ttdoc">Withdraw requested assets and token from AMM into LP account.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00469">AMMWithdraw.cpp:469</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ad366e7ecc17ab21d3fb406c334df6b0e"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ad366e7ecc17ab21d3fb406c334df6b0e">ripple::AMMWithdraw::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00423">AMMWithdraw.cpp:423</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ad1c31e18b3be405513e9e68004e72f09"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ad1c31e18b3be405513e9e68004e72f09">ripple::AMMWithdraw::withdraw</a></div><div class="ttdeci">static std::tuple&lt; TER, STAmount, STAmount, std::optional&lt; STAmount &gt; &gt; withdraw(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, AccountID const &amp;account, STAmount const &amp;amountBalance, STAmount const &amp;amountWithdraw, std::optional&lt; STAmount &gt; const &amp;amount2Withdraw, STAmount const &amp;lpTokensAMMBalance, STAmount const &amp;lpTokensWithdraw, std::uint16_t tfee, FreezeHandling freezeHandling, WithdrawAll withdrawAll, XRPAmount const &amp;priorBalance, beast::Journal const &amp;journal)</div><div class="ttdoc">Withdraw requested assets and token from AMM into LP account.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00471">AMMWithdraw.cpp:471</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ad366e7ecc17ab21d3fb406c334df6b0e"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ad366e7ecc17ab21d3fb406c334df6b0e">ripple::AMMWithdraw::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00425">AMMWithdraw.cpp:425</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_aeb0d6c11ef78505357d955bd94c9cf69"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#aeb0d6c11ef78505357d955bd94c9cf69">ripple::AMMWithdraw::getFlagsMask</a></div><div class="ttdeci">static std::uint32_t getFlagsMask(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00038">AMMWithdraw.cpp:38</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_af550daae2d35615ebb72a32cdc09c158"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#af550daae2d35615ebb72a32cdc09c158">ripple::AMMWithdraw::singleWithdrawTokens</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleWithdrawTokens(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;lpTokensWithdraw, std::uint16_t tfee)</div><div class="ttdoc">Single asset withdrawal (Asset1Out, LPTokens) proportional to the share specified by tokens.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00983">AMMWithdraw.cpp:983</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_af550daae2d35615ebb72a32cdc09c158"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#af550daae2d35615ebb72a32cdc09c158">ripple::AMMWithdraw::singleWithdrawTokens</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleWithdrawTokens(Sandbox &amp;view, SLE const &amp;ammSle, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;lpTokensWithdraw, std::uint16_t tfee)</div><div class="ttdoc">Single asset withdrawal (Asset1Out, LPTokens) proportional to the share specified by tokens.</div><div class="ttdef"><b>Definition</b> <a href="AMMWithdraw_8cpp_source.html#l00985">AMMWithdraw.cpp:985</a></div></div>
<div class="ttc" id="aclassripple_1_1ApplyContext_html"><div class="ttname"><a href="classripple_1_1ApplyContext.html">ripple::ApplyContext</a></div><div class="ttdoc">State information when applying a tx.</div><div class="ttdef"><b>Definition</b> <a href="ApplyContext_8h_source.html#l00036">ApplyContext.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1Issue_html"><div class="ttname"><a href="classripple_1_1Issue.html">ripple::Issue</a></div><div class="ttdoc">A currency issued by an account.</div><div class="ttdef"><b>Definition</b> <a href="Issue_8h_source.html#l00032">Issue.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_1STAmount_html"><div class="ttname"><a href="classripple_1_1STAmount.html">ripple::STAmount</a></div><div class="ttdef"><b>Definition</b> <a href="STAmount_8h_source.html#l00049">STAmount.h:50</a></div></div>