Files
rippled/AMMHelpers_8h_source.html
2023-09-14 20:12:35 +00:00

297 lines
40 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: AMMHelpers.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&amp;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&amp;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_29f79f6f29a0be0eebc6c46bea51c866.html">misc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AMMHelpers.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<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>&#160;<span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_APP_MISC_AMMHELPERS_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_APP_MISC_AMMHELPERS_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/basics/IOUAmount.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/basics/Number.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/AMMCore.h&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/AmountConversions.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/Issue.h&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/Quality.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/STAccount.h&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/STAmount.h&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;STAmount</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<a class="code" href="namespaceripple.html#ab8defa1f235abbf44a60ccc6c71c6fdd">ammLPTokens</a>(</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; STAmount <span class="keyword">const</span>&amp; asset1,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; STAmount <span class="keyword">const</span>&amp; asset2,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; Issue <span class="keyword">const</span>&amp; lptIssue);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;STAmount</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<a class="code" href="namespaceripple.html#a0b2344222057d8b5b9923b2911962879">lpTokensIn</a>(</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; STAmount <span class="keyword">const</span>&amp; asset1Balance,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; STAmount <span class="keyword">const</span>&amp; asset1Deposit,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; STAmount <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;STAmount</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<a class="code" href="namespaceripple.html#a573eb2cecf652856fc74fb1dfbaf8c2a">ammAssetIn</a>(</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; STAmount <span class="keyword">const</span>&amp; asset1Balance,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; STAmount <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; STAmount <span class="keyword">const</span>&amp; lpTokens,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;STAmount</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<a class="code" href="namespaceripple.html#a4c964d1f7629a28f9b916e2d25b39bcd">lpTokensOut</a>(</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; STAmount <span class="keyword">const</span>&amp; asset1Balance,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; STAmount <span class="keyword">const</span>&amp; asset1Withdraw,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; STAmount <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;STAmount</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<a class="code" href="namespaceripple.html#aea4620f7a5356019edee3be624729c6d">withdrawByTokens</a>(</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; STAmount <span class="keyword">const</span>&amp; assetBalance,</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; STAmount <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; STAmount <span class="keyword">const</span>&amp; lpTokens,</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;withinRelativeDistance(</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; Quality <span class="keyword">const</span>&amp; calcQuality,</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; Quality <span class="keyword">const</span>&amp; reqQuality,</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; Number <span class="keyword">const</span>&amp; dist)</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;{</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span> (calcQuality == reqQuality)</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> [<a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">min</a>, <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/max.html">max</a>] = <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/minmax.html">std::minmax</a>(calcQuality, reqQuality);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// Relative distance is (max - min)/max. Can&#39;t use basic operations</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="comment">// on Quality. Have to use Quality::rate() instead, which</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="comment">// is inverse of quality: (1/max.rate - 1/min.rate)/(1/max.rate)</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">return</span> ((<a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">min</a>.rate() - <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/max.html">max</a>.rate()) / <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">min</a>.rate()) &lt; dist;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;}</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment">// clang-format off</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Amt&gt;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; requires(</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; std::is_same_v&lt;Amt, STAmount&gt; || std::is_same_v&lt;Amt, IOUAmount&gt; ||</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; std::is_same_v&lt;Amt, XRPAmount&gt;)</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="keywordtype">bool</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;withinRelativeDistance(Amt <span class="keyword">const</span>&amp; calc, Amt <span class="keyword">const</span>&amp; req, Number <span class="keyword">const</span>&amp; dist)</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;{</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordflow">if</span> (calc == req)</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> [<a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">min</a>, <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/max.html">max</a>] = <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/minmax.html">std::minmax</a>(calc, req);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keywordflow">return</span> ((max - min) / max) &lt; dist;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;}</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="comment">// clang-format on</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;TAmounts&lt;TIn, TOut&gt;</a>&gt;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;changeSpotPriceQuality(</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; pool,</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; Quality <span class="keyword">const</span>&amp; quality,</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;{</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> f = <a class="code" href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">feeMult</a>(tfee); <span class="comment">// 1 - fee</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span>&amp; a = f;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> b = pool.in * (1 + f);</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; Number <span class="keyword">const</span> c = pool.in * pool.in - pool.in * pool.out * <a class="code" href="namespaceripple_1_1keylet.html#a521be311ed98c7c94eeff3441e6bf85f">quality</a>.rate();</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span> res = b * b - 4 * a * c; res &lt; 0)</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span> nTakerPaysPropose = (-b + <a class="code" href="namespaceripple.html#aecb9ae1add070266b1be59ff570ec713">root2</a>(res)) / (2 * a);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; nTakerPaysPropose &gt; 0)</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; {</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> nTakerPays = [&amp;]() {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="comment">// The fee might make the AMM offer quality less than CLOB quality.</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="comment">// Therefore, AMM offer has to satisfy this constraint: o / i &gt;= q.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="comment">// Substituting o with swapAssetIn() gives:</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="comment">// i &lt;= O / q - I / (1 - fee).</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> nTakerPaysConstraint =</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; pool.out * <a class="code" href="namespaceripple_1_1keylet.html#a521be311ed98c7c94eeff3441e6bf85f">quality</a>.rate() - pool.in / f;</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordflow">if</span> (nTakerPaysPropose &gt; nTakerPaysConstraint)</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="keywordflow">return</span> nTakerPaysConstraint;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <span class="keywordflow">return</span> nTakerPaysPropose;</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; }();</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keywordflow">if</span> (nTakerPays &lt;= 0)</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> takerPays = toAmount&lt;TIn&gt;(</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <a class="code" href="namespaceripple.html#a35d75f3e8c1d99beb8c834d767070d8c">getIssue</a>(pool.in), nTakerPays, Number::rounding_mode::upward);</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="comment">// should not fail</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span> amounts =</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; TAmounts&lt;TIn, TOut&gt;{</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; takerPays, swapAssetIn(pool, takerPays, tfee)};</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; Quality{amounts} &lt; <a class="code" href="namespaceripple_1_1keylet.html#a521be311ed98c7c94eeff3441e6bf85f">quality</a> &amp;&amp;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; !withinRelativeDistance(Quality{amounts}, <a class="code" href="namespaceripple_1_1keylet.html#a521be311ed98c7c94eeff3441e6bf85f">quality</a>, Number(1, -7)))</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;changeSpotPriceQuality failed&quot;</span>);</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keywordflow">return</span> amounts;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; }</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;}</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; </div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;TOut</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;swapAssetIn(</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; pool,</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; TIn <span class="keyword">const</span>&amp; assetIn,</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;{</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="keywordflow">return</span> toAmount&lt;TOut&gt;(</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <a class="code" href="namespaceripple.html#a35d75f3e8c1d99beb8c834d767070d8c">getIssue</a>(pool.out),</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; pool.out - (pool.in * pool.out) / (pool.in + assetIn * <a class="code" href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">feeMult</a>(tfee)),</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; Number::rounding_mode::downward);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;}</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;TIn</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;swapAssetOut(</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; pool,</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; TOut <span class="keyword">const</span>&amp; assetOut,</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;{</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <span class="keywordflow">return</span> toAmount&lt;TIn&gt;(</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; <a class="code" href="namespaceripple.html#a35d75f3e8c1d99beb8c834d767070d8c">getIssue</a>(pool.in),</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; ((pool.in * pool.out) / (pool.out - assetOut) - pool.in) /</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; <a class="code" href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">feeMult</a>(tfee),</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; Number::rounding_mode::upward);</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;}</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; </div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;Number</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<a class="code" href="namespaceripple.html#a58b7851104129e42da9c5260ba6f00d6">square</a>(Number <span class="keyword">const</span>&amp; n);</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; </div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;STAmount</div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<a class="code" href="namespaceripple.html#a0e17cbd5597a6159dfa1045e6b2e951e">adjustLPTokens</a>(</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160; STAmount <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; STAmount <span class="keyword">const</span>&amp; lpTokens,</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; <span class="keywordtype">bool</span> isDeposit);</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; </div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/tuple.html">std::tuple&lt;STAmount, std::optional&lt;STAmount&gt;</a>, STAmount&gt;</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<a class="code" href="namespaceripple.html#a87134fa08d20568d7d5e469b616601e4">adjustAmountsByLPTokens</a>(</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; STAmount <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160; STAmount <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; amount2,</div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; STAmount <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; STAmount <span class="keyword">const</span>&amp; lpTokens,</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee,</div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160; <span class="keywordtype">bool</span> isDeposit);</div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; </div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;Number</div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<a class="code" href="namespaceripple.html#a3d22714f28b806ea5c702eba2db5fbc2">solveQuadraticEq</a>(Number <span class="keyword">const</span>&amp; a, Number <span class="keyword">const</span>&amp; b, Number <span class="keyword">const</span>&amp; c);</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; </div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; </div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;<span class="preprocessor">#endif // RIPPLE_APP_MISC_AMMHELPERS_H_INCLUDED</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceripple_html_a4c964d1f7629a28f9b916e2d25b39bcd"><div class="ttname"><a href="namespaceripple.html#a4c964d1f7629a28f9b916e2d25b39bcd">ripple::lpTokensOut</a></div><div class="ttdeci">STAmount lpTokensOut(STAmount const &amp;asset1Balance, STAmount const &amp;asset1Withdraw, STAmount const &amp;lptAMMBalance, std::uint16_t tfee)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00090">AMMHelpers.cpp:90</a></div></div>
<div class="ttc" id="anamespaceripple_html_aecb9ae1add070266b1be59ff570ec713"><div class="ttname"><a href="namespaceripple.html#aecb9ae1add070266b1be59ff570ec713">ripple::root2</a></div><div class="ttdeci">Number root2(Number f)</div><div class="ttdef"><b>Definition:</b> <a href="Number_8cpp_source.html#l00689">Number.cpp:689</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3d22714f28b806ea5c702eba2db5fbc2"><div class="ttname"><a href="namespaceripple.html#a3d22714f28b806ea5c702eba2db5fbc2">ripple::solveQuadraticEq</a></div><div class="ttdeci">Number solveQuadraticEq(Number const &amp;a, Number const &amp;b, Number const &amp;c)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00201">AMMHelpers.cpp:201</a></div></div>
<div class="ttc" id="anamespaceripple_html_a0b2344222057d8b5b9923b2911962879"><div class="ttname"><a href="namespaceripple.html#a0b2344222057d8b5b9923b2911962879">ripple::lpTokensIn</a></div><div class="ttdeci">STAmount lpTokensIn(STAmount const &amp;asset1Balance, STAmount const &amp;asset1Deposit, STAmount const &amp;lptAMMBalance, std::uint16_t tfee)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00041">AMMHelpers.cpp:41</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7894756905fee556c1541cd1de1f697a"><div class="ttname"><a href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">ripple::feeMult</a></div><div class="ttdeci">Number feeMult(std::uint16_t tfee)</div><div class="ttdoc">Get fee multiplier (1 - tfee) @tfee trading fee in basis points.</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8h_source.html#l00118">AMMCore.h:118</a></div></div>
<div class="ttc" id="anamespaceripple_html_a87134fa08d20568d7d5e469b616601e4"><div class="ttname"><a href="namespaceripple.html#a87134fa08d20568d7d5e469b616601e4">ripple::adjustAmountsByLPTokens</a></div><div class="ttdeci">std::tuple&lt; STAmount, std::optional&lt; STAmount &gt;, STAmount &gt; adjustAmountsByLPTokens(STAmount const &amp;amountBalance, STAmount const &amp;amount, std::optional&lt; STAmount &gt; const &amp;amount2, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokens, std::uint16_t tfee, bool isDeposit)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00147">AMMHelpers.cpp:147</a></div></div>
<div class="ttc" id="atuple_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/tuple.html">std::tuple</a></div></div>
<div class="ttc" id="anamespaceripple_html_a58b7851104129e42da9c5260ba6f00d6"><div class="ttname"><a href="namespaceripple.html#a58b7851104129e42da9c5260ba6f00d6">ripple::square</a></div><div class="ttdeci">Number square(Number const &amp;n)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00127">AMMHelpers.cpp:127</a></div></div>
<div class="ttc" id="anamespaceripple_html_aea4620f7a5356019edee3be624729c6d"><div class="ttname"><a href="namespaceripple.html#aea4620f7a5356019edee3be624729c6d">ripple::withdrawByTokens</a></div><div class="ttdeci">STAmount withdrawByTokens(STAmount const &amp;assetBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokens, std::uint16_t tfee)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00114">AMMHelpers.cpp:114</a></div></div>
<div class="ttc" id="anamespaceripple_html_a35d75f3e8c1d99beb8c834d767070d8c"><div class="ttname"><a href="namespaceripple.html#a35d75f3e8c1d99beb8c834d767070d8c">ripple::getIssue</a></div><div class="ttdeci">Issue getIssue(T const &amp;amt)</div><div class="ttdef"><b>Definition:</b> <a href="AmountConversions_8h_source.html#l00156">AmountConversions.h:156</a></div></div>
<div class="ttc" id="aminmax_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/minmax.html">std::minmax</a></div><div class="ttdeci">T minmax(T... args)</div></div>
<div class="ttc" id="anamespaceripple_html_a573eb2cecf652856fc74fb1dfbaf8c2a"><div class="ttname"><a href="namespaceripple.html#a573eb2cecf652856fc74fb1dfbaf8c2a">ripple::ammAssetIn</a></div><div class="ttdeci">STAmount ammAssetIn(STAmount const &amp;asset1Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokens, std::uint16_t tfee)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00067">AMMHelpers.cpp:67</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="amin_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a></div><div class="ttdeci">T min(T... args)</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="anamespaceripple_html_ab8defa1f235abbf44a60ccc6c71c6fdd"><div class="ttname"><a href="namespaceripple.html#ab8defa1f235abbf44a60ccc6c71c6fdd">ripple::ammLPTokens</a></div><div class="ttdeci">STAmount ammLPTokens(STAmount const &amp;asset1, STAmount const &amp;asset2, Issue const &amp;lptIssue)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00025">AMMHelpers.cpp:25</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="anamespaceripple_1_1keylet_html_a521be311ed98c7c94eeff3441e6bf85f"><div class="ttname"><a href="namespaceripple_1_1keylet.html#a521be311ed98c7c94eeff3441e6bf85f">ripple::keylet::quality</a></div><div class="ttdeci">Keylet quality(Keylet const &amp;k, std::uint64_t q) noexcept</div><div class="ttdoc">The initial directory page for a specific quality.</div><div class="ttdef"><b>Definition:</b> <a href="Indexes_8cpp_source.html#l00236">Indexes.cpp:236</a></div></div>
<div class="ttc" id="amax_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/max.html">std::max</a></div><div class="ttdeci">T max(T... args)</div></div>
<div class="ttc" id="anamespaceripple_html_a0e17cbd5597a6159dfa1045e6b2e951e"><div class="ttname"><a href="namespaceripple.html#a0e17cbd5597a6159dfa1045e6b2e951e">ripple::adjustLPTokens</a></div><div class="ttdeci">STAmount adjustLPTokens(STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokens, bool isDeposit)</div><div class="ttdef"><b>Definition:</b> <a href="AMMHelpers_8cpp_source.html#l00133">AMMHelpers.cpp:133</a></div></div>
<div class="ttc" id="atype_traits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>