Files
rippled/AMMOffer_8cpp_source.html
2023-07-12 17:57:19 +00:00

243 lines
33 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: AMMOffer.cpp 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_1e0db5c7188e9c3cb47dd9ba683c8f27.html">paths</a></li><li class="navelem"><a class="el" href="dir_a616178398cd3ecc4e74090cb6c9f8d9.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AMMOffer.cpp</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;<span class="preprocessor">#include &lt;ripple/app/paths/AMMOffer.h&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;ripple/app/paths/AMMLiquidity.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/QualityFunction.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</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="l00027"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a2135c82cf3cb7183eeff9fe0df5d9057"> 27</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#a2135c82cf3cb7183eeff9fe0df5d9057">AMMOffer&lt;TIn, TOut&gt;::AMMOffer</a>(</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classripple_1_1AMMLiquidity.html">AMMLiquidity&lt;TIn, TOut&gt;</a> <span class="keyword">const</span>&amp; ammLiquidity,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; amounts,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;TAmounts&lt;TIn, TOut&gt;&gt; <span class="keyword">const</span>&amp; balances,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; Quality <span class="keyword">const</span>&amp; quality)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; : ammLiquidity_(ammLiquidity)</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; , amounts_(amounts)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; , balances_(balances)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; , quality_(quality)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; , consumed_(false)</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</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="l00041"></a><span class="lineno"> 41</span>&#160;<a class="code" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#ad6eff87d977b5a80f1a07660b455a6db"> 42</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#ad6eff87d977b5a80f1a07660b455a6db">AMMOffer&lt;TIn, TOut&gt;::issueIn</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">return</span> ammLiquidity_.issueIn();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</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="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a1c599cad195a93f56c24975eab9728cc"> 49</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#a1c599cad195a93f56c24975eab9728cc">AMMOffer&lt;TIn, TOut&gt;::issueOut</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> ammLiquidity_.issueOut();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</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="l00055"></a><span class="lineno"> 55</span>&#160;<a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a2c97fe4fa25accdb68dc5d76a110acce"> 56</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#a2c97fe4fa25accdb68dc5d76a110acce">AMMOffer&lt;TIn, TOut&gt;::owner</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> ammLiquidity_.ammAccount();</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</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="l00062"></a><span class="lineno"> 62</span>&#160;TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#ae00679ef074c1566c961189dbe3c6768"> 63</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#ae00679ef074c1566c961189dbe3c6768">AMMOffer&lt;TIn, TOut&gt;::amount</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> amounts_;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;}</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</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="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a8856f999ea2ba636a2c74e642d4bb329"> 70</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#a8856f999ea2ba636a2c74e642d4bb329">AMMOffer&lt;TIn, TOut&gt;::consume</a>(</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classripple_1_1ApplyView.html">ApplyView</a>&amp; view,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; consumed)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="comment">// Consumed offer must be less or equal to the original</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">if</span> (consumed.in &gt; amounts_.in || consumed.out &gt; amounts_.out)</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; Throw&lt;std::logic_error&gt;(<span class="stringliteral">&quot;Invalid consumed AMM offer.&quot;</span>);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// AMM pool is updated when the amounts are transferred</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// in BookStep::consumeOffer().</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; consumed_ = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="comment">// Let the context know AMM offer is consumed</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; ammLiquidity_.context().setAMMUsed();</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</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="l00087"></a><span class="lineno"> 87</span>&#160;TAmounts&lt;TIn, TOut&gt;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a3757f92066ba7fa0fcf4b8964b00dfa4"> 88</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#a3757f92066ba7fa0fcf4b8964b00dfa4">AMMOffer&lt;TIn, TOut&gt;::limitOut</a>(</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; offrAmt,</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; TOut <span class="keyword">const</span>&amp; limit,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">bool</span> fixReducedOffers,</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">bool</span> roundUp)<span class="keyword"> const</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="comment">// Change the offer size proportionally to the original offer quality</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="comment">// to keep the strands quality order unchanged. The taker pays slightly</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">// more for the offer in this case, which results in a slightly higher</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// pool product than the original pool product. I.e. if the original</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="comment">// pool is poolPays, poolGets and the offer is assetIn, assetOut then</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="comment">// poolPays * poolGets &lt; (poolPays - assetOut) * (poolGets + assetIn)</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">if</span> (ammLiquidity_.multiPath())</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">if</span> (fixReducedOffers)</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="comment">// It turns out that the ceil_out implementation has some slop in</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="comment">// it. ceil_out_strict removes that slop. But removing that slop</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="comment">// affects transaction outcomes, so the change must be made using</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="comment">// an amendment.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">return</span> quality().ceil_out_strict(offrAmt, limit, roundUp);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">return</span> quality().ceil_out(offrAmt, limit);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="comment">// Change the offer size according to the conservation function. The offer</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">// quality is increased in this case, but it doesn&#39;t matter since there is</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="comment">// only one path.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">return</span> {swapAssetOut(*balances_, limit, ammLiquidity_.tradingFee()), limit};</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;}</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</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="l00117"></a><span class="lineno"> 117</span>&#160;TAmounts&lt;TIn, TOut&gt;</div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a47c9d8c0e8d74d833a2591b303b02c3e"> 118</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#a47c9d8c0e8d74d833a2591b303b02c3e">AMMOffer&lt;TIn, TOut&gt;::limitIn</a>(</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; offrAmt,</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; TIn <span class="keyword">const</span>&amp; limit)<span class="keyword"> const</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="comment">// See the comments above in limitOut().</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">if</span> (ammLiquidity_.multiPath())</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">return</span> quality().ceil_in(offrAmt, limit);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordflow">return</span> {limit, swapAssetIn(*balances_, limit, ammLiquidity_.tradingFee())};</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;}</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</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="l00129"></a><span class="lineno"> 129</span>&#160;<a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a></div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#aedb2204df9f80970d1356c8e1997ca35"> 130</a></span>&#160;<a class="code" href="classripple_1_1AMMOffer.html#aedb2204df9f80970d1356c8e1997ca35">AMMOffer&lt;TIn, TOut&gt;::getQualityFunc</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordflow">if</span> (ammLiquidity_.multiPath())</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a>{quality(), <a class="code" href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">QualityFunction::CLOBLikeTag</a>{}};</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a>{</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; *balances_, ammLiquidity_.tradingFee(), <a class="code" href="structripple_1_1QualityFunction_1_1AMMTag.html">QualityFunction::AMMTag</a>{}};</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;}</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="keyword">template</span> <span class="keyword">class </span><a class="code" href="classripple_1_1AMMOffer.html">AMMOffer&lt;STAmount, STAmount&gt;</a>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="keyword">template</span> <span class="keyword">class </span><a class="code" href="classripple_1_1AMMOffer.html">AMMOffer&lt;IOUAmount, IOUAmount&gt;</a>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="keyword">template</span> <span class="keyword">class </span><a class="code" href="classripple_1_1AMMOffer.html">AMMOffer&lt;XRPAmount, IOUAmount&gt;</a>;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="keyword">template</span> <span class="keyword">class </span><a class="code" href="classripple_1_1AMMOffer.html">AMMOffer&lt;IOUAmount, XRPAmount&gt;</a>;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;} <span class="comment">// namespace ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1AMMOffer_html_ae00679ef074c1566c961189dbe3c6768"><div class="ttname"><a href="classripple_1_1AMMOffer.html#ae00679ef074c1566c961189dbe3c6768">ripple::AMMOffer::amount</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; const &amp; amount() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00063">AMMOffer.cpp:63</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a3757f92066ba7fa0fcf4b8964b00dfa4"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a3757f92066ba7fa0fcf4b8964b00dfa4">ripple::AMMOffer::limitOut</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; limitOut(TAmounts&lt; TIn, TOut &gt; const &amp;offrAmt, TOut const &amp;limit, bool fixReducedOffers, bool roundUp) const</div><div class="ttdoc">Limit out of the provided offer.</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00088">AMMOffer.cpp:88</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#l00035">Issue.h:35</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_aedb2204df9f80970d1356c8e1997ca35"><div class="ttname"><a href="classripple_1_1AMMOffer.html#aedb2204df9f80970d1356c8e1997ca35">ripple::AMMOffer::getQualityFunc</a></div><div class="ttdeci">QualityFunction getQualityFunc() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00130">AMMOffer.cpp:130</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_ad6eff87d977b5a80f1a07660b455a6db"><div class="ttname"><a href="classripple_1_1AMMOffer.html#ad6eff87d977b5a80f1a07660b455a6db">ripple::AMMOffer::issueIn</a></div><div class="ttdeci">Issue const &amp; issueIn() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00042">AMMOffer.cpp:42</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a47c9d8c0e8d74d833a2591b303b02c3e"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a47c9d8c0e8d74d833a2591b303b02c3e">ripple::AMMOffer::limitIn</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; limitIn(TAmounts&lt; TIn, TOut &gt; const &amp;offrAmt, TIn const &amp;limit) const</div><div class="ttdoc">Limit in of the provided offer.</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00118">AMMOffer.cpp:118</a></div></div>
<div class="ttc" id="aclassripple_1_1ApplyView_html"><div class="ttname"><a href="classripple_1_1ApplyView.html">ripple::ApplyView</a></div><div class="ttdoc">Writeable view to a ledger, for applying a transaction.</div><div class="ttdef"><b>Definition:</b> <a href="ApplyView_8h_source.html#l00134">ApplyView.h:134</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="astructripple_1_1QualityFunction_1_1AMMTag_html"><div class="ttname"><a href="structripple_1_1QualityFunction_1_1AMMTag.html">ripple::QualityFunction::AMMTag</a></div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00050">QualityFunction.h:50</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a8856f999ea2ba636a2c74e642d4bb329"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a8856f999ea2ba636a2c74e642d4bb329">ripple::AMMOffer::consume</a></div><div class="ttdeci">void consume(ApplyView &amp;view, TAmounts&lt; TIn, TOut &gt; const &amp;consumed)</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00070">AMMOffer.cpp:70</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html"><div class="ttname"><a href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a></div><div class="ttdoc">Represents synthetic AMM offer in BookStep.</div><div class="ttdef"><b>Definition:</b> <a href="AMMLiquidity_8h_source.html#l00035">AMMLiquidity.h:35</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a2135c82cf3cb7183eeff9fe0df5d9057"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a2135c82cf3cb7183eeff9fe0df5d9057">ripple::AMMOffer::AMMOffer</a></div><div class="ttdeci">AMMOffer(AMMLiquidity&lt; TIn, TOut &gt; const &amp;ammLiquidity, TAmounts&lt; TIn, TOut &gt; const &amp;amounts, std::optional&lt; TAmounts&lt; TIn, TOut &gt;&gt; const &amp;balances, Quality const &amp;quality)</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00027">AMMOffer.cpp:27</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_1AMMLiquidity_html"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a></div><div class="ttdoc">AMMLiquidity class provides AMM offers to BookStep class.</div><div class="ttdef"><b>Definition:</b> <a href="AMMLiquidity_8h_source.html#l00052">AMMLiquidity.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html"><div class="ttname"><a href="classripple_1_1QualityFunction.html">ripple::QualityFunction</a></div><div class="ttdoc">Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00039">QualityFunction.h:39</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="astructripple_1_1QualityFunction_1_1CLOBLikeTag_html"><div class="ttname"><a href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">ripple::QualityFunction::CLOBLikeTag</a></div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00055">QualityFunction.h:55</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a1c599cad195a93f56c24975eab9728cc"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a1c599cad195a93f56c24975eab9728cc">ripple::AMMOffer::issueOut</a></div><div class="ttdeci">Issue const &amp; issueOut() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00049">AMMOffer.cpp:49</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a2c97fe4fa25accdb68dc5d76a110acce"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a2c97fe4fa25accdb68dc5d76a110acce">ripple::AMMOffer::owner</a></div><div class="ttdeci">AccountID const &amp; owner() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00056">AMMOffer.cpp:56</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>