mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 03:26:01 +00:00
225 lines
36 KiB
HTML
225 lines
36 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: AMMWithdraw.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_08bd996c7140e5d4c4a2548bd66a393f.html">tx</a></li><li class="navelem"><a class="el" href="dir_03680b44059da148632e530fc6dc63c7.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">AMMWithdraw.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_TX_AMMWITHDRAW_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_TX_AMMWITHDRAW_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/app/tx/impl/Transactor.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>Sandbox;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classripple_1_1AMMWithdraw.html"> 65</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1AMMWithdraw.html">AMMWithdraw</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1Transactor.html">Transactor</a></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classripple_1_1AMMWithdraw.html#a951edc48bf0cee75293ce82b7ba7b61c"> 68</a></span>  <span class="keyword">static</span> constexpr <a class="code" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> <a class="code" href="classripple_1_1AMMWithdraw.html#a951edc48bf0cee75293ce82b7ba7b61c">ConsequencesFactory</a>{<a class="code" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>};</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classripple_1_1AMMWithdraw.html#a345ddd0ca98b576c85173513861b6366"> 70</a></span>  <span class="keyword">explicit</span> <a class="code" href="classripple_1_1AMMWithdraw.html#a345ddd0ca98b576c85173513861b6366">AMMWithdraw</a>(<a class="code" href="classripple_1_1ApplyContext.html">ApplyContext</a>& ctx) : <a class="code" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">NotTEC</a></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#acf1048871867fae517d6e38c09f9ffd8">preflight</a>(<a class="code" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>& ctx);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#ac65c94e120bdb3957a6951fab2af6c29">preclaim</a>(<a class="code" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> <span class="keyword">const</span>& ctx);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#ad366e7ecc17ab21d3fb406c334df6b0e">doApply</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, bool></a></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#a690f2bdea8fffee52a5d12db0733b28b">applyGuts</a>(<a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, STAmount></a></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#aea2dd562841d34b3fc53ccdac5c569f8">withdraw</a>(</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>,</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& ammAccount,</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountWithdraw,</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountBalance,</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<STAmount></a> <span class="keyword">const</span>& amount2Withdraw,</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lpTokensAMMBalance,</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lpTokensWithdraw,</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, STAmount></a></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#a08f36d93ed444aab431d5663d6305f60">equalWithdrawTokens</a>(</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>,</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& ammAccount,</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountBalance,</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount2Balance,</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lptAMMBalance,</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lpTokens,</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lpTokensWithdraw,</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, STAmount></a></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#a48dc0dc1f20489b695ac7c16e79e5cbd">equalWithdrawLimit</a>(</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>,</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& ammAccount,</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountBalance,</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount2Balance,</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lptAMMBalance,</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount,</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount2,</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, STAmount></a></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#a41ba8cc3d6402d3babee02819a78fca4">singleWithdraw</a>(</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>,</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& ammAccount,</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountBalance,</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lptAMMBalance,</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount,</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, STAmount></a></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#a6e5584ff04fd7a09d3213d88372a88d8">singleWithdrawTokens</a>(</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>,</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& ammAccount,</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountBalance,</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lptAMMBalance,</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount,</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lpTokensWithdraw,</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  </div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<TER, STAmount></a></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <a class="code" href="classripple_1_1AMMWithdraw.html#ae118560969025af2963d994ea4247d7b">singleWithdrawEPrice</a>(</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>,</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& ammAccount,</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amountBalance,</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& lptAMMBalance,</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount,</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <a class="code" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& ePrice,</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> };</div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  </div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  </div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor">#endif // RIPPLE_TX_AMMWITHDRAW_H_INCLUDED</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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#l00068">AMMWithdraw.h:68</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Transactor_html"><div class="ttname"><a href="classripple_1_1Transactor.html">ripple::Transactor</a></div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00085">Transactor.h:85</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>
|
|
<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#l00407">AMMWithdraw.cpp:407</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< TER, bool > applyGuts(Sandbox &view)</div><div class="ttdef"><b>Definition:</b> <a href="AMMWithdraw_8cpp_source.html#l00296">AMMWithdraw.cpp:296</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint</a></div><div class="ttdoc">Integers of any length that is a multiple of 32-bits.</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00082">base_uint.h:82</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_ae118560969025af2963d994ea4247d7b"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#ae118560969025af2963d994ea4247d7b">ripple::AMMWithdraw::singleWithdrawEPrice</a></div><div class="ttdeci">std::pair< TER, STAmount > singleWithdrawEPrice(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &lptAMMBalance, STAmount const &amount, STAmount const &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#l00768">AMMWithdraw.cpp:768</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ripple::Transactor::ConsequencesFactoryType</a></div><div class="ttdeci">ConsequencesFactoryType</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00101">Transactor.h:101</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 &ctx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMWithdraw_8cpp_source.html#l00036">AMMWithdraw.cpp:36</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a08f36d93ed444aab431d5663d6305f60"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a08f36d93ed444aab431d5663d6305f60">ripple::AMMWithdraw::equalWithdrawTokens</a></div><div class="ttdeci">std::pair< TER, STAmount > equalWithdrawTokens(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amount2Balance, STAmount const &lptAMMBalance, STAmount const &lpTokens, STAmount const &lpTokensWithdraw, std::uint16_t tfee)</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#l00569">AMMWithdraw.cpp:569</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset</a></div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00352">TER.h:352</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a41ba8cc3d6402d3babee02819a78fca4"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a41ba8cc3d6402d3babee02819a78fca4">ripple::AMMWithdraw::singleWithdraw</a></div><div class="ttdeci">std::pair< TER, STAmount > singleWithdraw(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &lptAMMBalance, STAmount const &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#l00691">AMMWithdraw.cpp:691</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Sandbox_html"><div class="ttname"><a href="classripple_1_1Sandbox.html">ripple::Sandbox</a></div><div class="ttdoc">Discardable, editable view to a ledger.</div><div class="ttdef"><b>Definition:</b> <a href="Sandbox_8h_source.html#l00034">Sandbox.h:34</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#l00045">STAmount.h:45</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="ttdoc">AMMWithdraw implements AMM withdraw Transactor.</div><div class="ttdef"><b>Definition:</b> <a href="AMMWithdraw_8h_source.html#l00065">AMMWithdraw.h:65</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#l00035">ApplyContext.h:35</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="astructripple_1_1PreclaimContext_html"><div class="ttname"><a href="structripple_1_1PreclaimContext.html">ripple::PreclaimContext</a></div><div class="ttdoc">State information when determining if a tx is likely to claim a fee.</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00052">Transactor.h:52</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a6e5584ff04fd7a09d3213d88372a88d8"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a6e5584ff04fd7a09d3213d88372a88d8">ripple::AMMWithdraw::singleWithdrawTokens</a></div><div class="ttdeci">std::pair< TER, STAmount > singleWithdrawTokens(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &lptAMMBalance, STAmount const &amount, STAmount const &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#l00724">AMMWithdraw.cpp:724</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Transactor_html_a1ac5d16d7b21e8af9cc94d7af39a85d5"><div class="ttname"><a href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">ripple::Transactor::view</a></div><div class="ttdeci">ApplyView & view()</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00107">Transactor.h:107</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">ripple::Transactor::Normal</a></div><div class="ttdeci">@ Normal</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00101">Transactor.h:101</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_aea2dd562841d34b3fc53ccdac5c569f8"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#aea2dd562841d34b3fc53ccdac5c569f8">ripple::AMMWithdraw::withdraw</a></div><div class="ttdeci">std::pair< TER, STAmount > withdraw(Sandbox &view, AccountID const &ammAccount, STAmount const &amountWithdraw, STAmount const &amountBalance, std::optional< STAmount > const &amount2Withdraw, STAmount const &lpTokensAMMBalance, STAmount const &lpTokensWithdraw, std::uint16_t tfee)</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#l00421">AMMWithdraw.cpp:421</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< STAmount ></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 &ctx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMWithdraw_8cpp_source.html#l00172">AMMWithdraw.cpp:172</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1PreflightContext_html"><div class="ttname"><a href="structripple_1_1PreflightContext.html">ripple::PreflightContext</a></div><div class="ttdoc">State information when preflighting a tx.</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00031">Transactor.h:31</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMWithdraw_html_a48dc0dc1f20489b695ac7c16e79e5cbd"><div class="ttname"><a href="classripple_1_1AMMWithdraw.html#a48dc0dc1f20489b695ac7c16e79e5cbd">ripple::AMMWithdraw::equalWithdrawLimit</a></div><div class="ttdeci">std::pair< TER, STAmount > equalWithdrawLimit(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amount2Balance, STAmount const &lptAMMBalance, STAmount const &amount, STAmount const &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#l00649">AMMWithdraw.cpp:649</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 &ctx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMWithdraw_8h_source.html#l00070">AMMWithdraw.h:70</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|