ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-01-31 12:05:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/AMMOffer_8cpp_source.html
bthomee 9368c0d563 deploy: 5f638f5553
2026-01-28 10:13:01 -08:00

268 lines
40 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_a6d14a898e5042b88feceb06bece5732.html">paths</a></li><li class="navelem"><a class="el" href="dir_4236dcdf923f97c252e0c826c4e7f6d7.html">detail</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpld/app/paths/AMMLiquidity.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpld/app/paths/AMMOffer.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/protocol/QualityFunction.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#a5719bf06b15c6820210fd77086d0c9e8"> 9</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#a5719bf06b15c6820210fd77086d0c9e8">AMMOffer&lt;TIn, TOut&gt;::AMMOffer</a>(</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <a class="code hl_class" href="classxrpl_1_1AMMLiquidity.html">AMMLiquidity&lt;TIn, TOut&gt;</a> <span class="keyword">const</span>&amp; ammLiquidity,</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; amounts,</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; balances,</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> Quality <span class="keyword">const</span>&amp; quality)</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> : ammLiquidity_(ammLiquidity), amounts_(amounts), balances_(balances), quality_(quality), consumed_(false)</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>}</div>
</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><a class="code hl_class" href="classxrpl_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="}">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#aaf18394270d2c466b357d2457b043839"> 20</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#aaf18394270d2c466b357d2457b043839">AMMOffer&lt;TIn, TOut&gt;::issueIn</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">return</span> ammLiquidity_.issueIn();</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>}</div>
</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#ad88d9033397b09d3f0f761e225628369"> 27</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#ad88d9033397b09d3f0f761e225628369">AMMOffer&lt;TIn, TOut&gt;::owner</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">return</span> ammLiquidity_.ammAccount();</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>}</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#a73efd37481ced83fceaea032820ab4c4"> 34</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#a73efd37481ced83fceaea032820ab4c4">AMMOffer&lt;TIn, TOut&gt;::amount</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">return</span> amounts_;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>}</div>
</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="}">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#a7197f16d33225e69efbed3ca10839a81"> 41</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#a7197f16d33225e69efbed3ca10839a81">AMMOffer&lt;TIn, TOut&gt;::consume</a>(<a class="code hl_class" href="classxrpl_1_1ApplyView.html">ApplyView</a>&amp; view, TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; consumed)</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Consumed offer must be less or equal to the original</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">if</span> (consumed.in &gt; amounts_.in || consumed.out &gt; amounts_.out)</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> Throw&lt;std::logic_error&gt;(<span class="stringliteral">&quot;Invalid consumed AMM offer.&quot;</span>);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// AMM pool is updated when the amounts are transferred</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// in BookStep::consumeOffer().</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> consumed_ = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Let the context know AMM offer is consumed</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> ammLiquidity_.context().setAMMUsed();</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>}</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>TAmounts&lt;TIn, TOut&gt;</div>
<div class="foldopen" id="foldopen00057" data-start="{" data-end="}">
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#aab13f1ed83661b54c69b74d1d0c8903c"> 57</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#aab13f1ed83661b54c69b74d1d0c8903c">AMMOffer&lt;TIn, TOut&gt;::limitOut</a>(TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; offerAmount, TOut <span class="keyword">const</span>&amp; limit, <span class="keywordtype">bool</span> roundUp)<span class="keyword"> const</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// Change the offer size proportionally to the original offer quality</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// to keep the strands quality order unchanged. The taker pays slightly</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// more for the offer in this case, which results in a slightly higher</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// pool product than the original pool product. I.e. if the original</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// pool is poolPays, poolGets and the offer is assetIn, assetOut then</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// poolPays * poolGets &lt; (poolPays - assetOut) * (poolGets + assetIn)</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">if</span> (ammLiquidity_.multiPath())</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// It turns out that the ceil_out implementation has some slop in</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// it, which ceil_out_strict removes.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> quality().ceil_out_strict(offerAmount, limit, roundUp);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// Change the offer size according to the conservation function. The offer</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// quality is increased in this case, but it doesn&#39;t matter since there is</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// only one path.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> {<a class="code hl_function" href="namespacexrpl.html#acd8dcc2ff08382ec2b1e01fa2749a25b">swapAssetOut</a>(balances_, limit, ammLiquidity_.tradingFee()), limit};</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>}</div>
</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>TAmounts&lt;TIn, TOut&gt;</div>
<div class="foldopen" id="foldopen00079" data-start="{" data-end="}">
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#afe58309b78bba3b05ab9f3bb9ab747d5"> 79</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#afe58309b78bba3b05ab9f3bb9ab747d5">AMMOffer&lt;TIn, TOut&gt;::limitIn</a>(TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; offerAmount, TIn <span class="keyword">const</span>&amp; limit, <span class="keywordtype">bool</span> roundUp)<span class="keyword"> const</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// See the comments above in limitOut().</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">if</span> (ammLiquidity_.multiPath())</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span>&amp; rules = <a class="code hl_function" href="namespacexrpl.html#a5a1298fd71a9010ea3228b2ba8d46efe">getCurrentTransactionRules</a>(); rules &amp;&amp; rules-&gt;enabled(fixReducedOffersV2))</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">return</span> quality().ceil_in_strict(offerAmount, limit, roundUp);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> quality().ceil_in(offerAmount, limit);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">return</span> {limit, <a class="code hl_function" href="namespacexrpl.html#a5f8d3cff236ddbd2cbf77a2ef664f877">swapAssetIn</a>(balances_, limit, ammLiquidity_.tradingFee())};</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>}</div>
</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><a class="code hl_class" href="classxrpl_1_1QualityFunction.html">QualityFunction</a></div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="}">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#aa7a7f20cc32ffb3db12c304c3bb36e84"> 94</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#aa7a7f20cc32ffb3db12c304c3bb36e84">AMMOffer&lt;TIn, TOut&gt;::getQualityFunc</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">if</span> (ammLiquidity_.multiPath())</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classxrpl_1_1QualityFunction.html">QualityFunction</a>{quality(), <a class="code hl_struct" href="structxrpl_1_1QualityFunction_1_1CLOBLikeTag.html">QualityFunction::CLOBLikeTag</a>{}};</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classxrpl_1_1QualityFunction.html">QualityFunction</a>{balances_, ammLiquidity_.tradingFee(), <a class="code hl_struct" href="structxrpl_1_1QualityFunction_1_1AMMTag.html">QualityFunction::AMMTag</a>{}};</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>}</div>
</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut&gt;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00103" data-start="{" data-end="}">
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classxrpl_1_1AMMOffer.html#acac1e64351cff38ee010562bb5261377"> 103</a></span><a class="code hl_function" href="classxrpl_1_1AMMOffer.html#acac1e64351cff38ee010562bb5261377">AMMOffer&lt;TIn, TOut&gt;::checkInvariant</a>(TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; consumed, <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> j)<span class="keyword"> const</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">if</span> (consumed.in &gt; amounts_.in || consumed.out &gt; amounts_.out)</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> {</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> JLOG(j.<a class="code hl_function" href="classbeast_1_1Journal.html#a49b0713e65bb8e2c51b76fbf16252afe">error</a>()) &lt;&lt; <span class="stringliteral">&quot;AMMOffer::checkInvariant failed: consumed &quot;</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(consumed.in) &lt;&lt; <span class="stringliteral">&quot; &quot;</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(consumed.out) &lt;&lt; <span class="stringliteral">&quot; amounts &quot;</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(amounts_.in) &lt;&lt; <span class="stringliteral">&quot; &quot;</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(amounts_.out);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> }</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <a class="code hl_class" href="classxrpl_1_1Number.html">Number</a> <span class="keyword">const</span> product = balances_.in * balances_.out;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">auto</span> <span class="keyword">const</span> newBalances = TAmounts&lt;TIn, TOut&gt;{balances_.in + consumed.in, balances_.out - consumed.out};</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <a class="code hl_class" href="classxrpl_1_1Number.html">Number</a> <span class="keyword">const</span> newProduct = newBalances.in * newBalances.out;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">if</span> (newProduct &gt;= product || <a class="code hl_function" href="namespacexrpl.html#ad64c4c59078876e1cf6f5c7203f815e0">withinRelativeDistance</a>(product, newProduct, <a class="code hl_class" href="classxrpl_1_1Number.html">Number</a>{1, -7}))</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> JLOG(j.<a class="code hl_function" href="classbeast_1_1Journal.html#a49b0713e65bb8e2c51b76fbf16252afe">error</a>()) &lt;&lt; <span class="stringliteral">&quot;AMMOffer::checkInvariant failed: balances &quot;</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(balances_.in) &lt;&lt; <span class="stringliteral">&quot; &quot;</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(balances_.out) &lt;&lt; <span class="stringliteral">&quot; new balances &quot;</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(newBalances.in) &lt;&lt; <span class="stringliteral">&quot; &quot;</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> &lt;&lt; <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>(newBalances.out) &lt;&lt; <span class="stringliteral">&quot; product/newProduct &quot;</span> &lt;&lt; product &lt;&lt; <span class="stringliteral">&quot; &quot;</span> &lt;&lt; newProduct &lt;&lt; <span class="stringliteral">&quot; diff &quot;</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> &lt;&lt; (product != <a class="code hl_class" href="classxrpl_1_1Number.html">Number</a>{0} ? <a class="code hl_function" href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">to_string</a>((product - newProduct) / product) : <span class="stringliteral">&quot;undefined&quot;</span>);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>}</div>
</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1AMMOffer.html">AMMOffer&lt;STAmount, STAmount&gt;</a>;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1AMMOffer.html">AMMOffer&lt;IOUAmount, IOUAmount&gt;</a>;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1AMMOffer.html">AMMOffer&lt;XRPAmount, IOUAmount&gt;</a>;</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="keyword">template</span> <span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1AMMOffer.html">AMMOffer&lt;IOUAmount, XRPAmount&gt;</a>;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00040">Journal.h:41</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html_a49b0713e65bb8e2c51b76fbf16252afe"><div class="ttname"><a href="classbeast_1_1Journal.html#a49b0713e65bb8e2c51b76fbf16252afe">beast::Journal::error</a></div><div class="ttdeci">Stream error() const</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00319">Journal.h:319</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMLiquidity_html"><div class="ttname"><a href="classxrpl_1_1AMMLiquidity.html">xrpl::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#l00033">AMMLiquidity.h:34</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html">xrpl::AMMOffer</a></div><div class="ttdoc">Represents synthetic AMM offer in BookStep.</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00020">AMMOffer.h:21</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_a5719bf06b15c6820210fd77086d0c9e8"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#a5719bf06b15c6820210fd77086d0c9e8">xrpl::AMMOffer::AMMOffer</a></div><div class="ttdeci">AMMOffer(AMMLiquidity&lt; TIn, TOut &gt; const &amp;ammLiquidity, TAmounts&lt; TIn, TOut &gt; const &amp;amounts, TAmounts&lt; TIn, TOut &gt; const &amp;balances, Quality const &amp;quality)</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8cpp_source.html#l00009">AMMOffer.cpp:9</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_a7197f16d33225e69efbed3ca10839a81"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#a7197f16d33225e69efbed3ca10839a81">xrpl::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#l00041">AMMOffer.cpp:41</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_a73efd37481ced83fceaea032820ab4c4"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#a73efd37481ced83fceaea032820ab4c4">xrpl::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#l00034">AMMOffer.cpp:34</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_aa7a7f20cc32ffb3db12c304c3bb36e84"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#aa7a7f20cc32ffb3db12c304c3bb36e84">xrpl::AMMOffer::getQualityFunc</a></div><div class="ttdeci">QualityFunction getQualityFunc() const</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8cpp_source.html#l00094">AMMOffer.cpp:94</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_aab13f1ed83661b54c69b74d1d0c8903c"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#aab13f1ed83661b54c69b74d1d0c8903c">xrpl::AMMOffer::limitOut</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; limitOut(TAmounts&lt; TIn, TOut &gt; const &amp;offerAmount, TOut const &amp;limit, 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#l00057">AMMOffer.cpp:57</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_aaf18394270d2c466b357d2457b043839"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#aaf18394270d2c466b357d2457b043839">xrpl::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#l00020">AMMOffer.cpp:20</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_acac1e64351cff38ee010562bb5261377"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#acac1e64351cff38ee010562bb5261377">xrpl::AMMOffer::checkInvariant</a></div><div class="ttdeci">bool checkInvariant(TAmounts&lt; TIn, TOut &gt; const &amp;consumed, beast::Journal j) const</div><div class="ttdoc">Check the new pool product is greater or equal to the old pool product or if decreases then within so...</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8cpp_source.html#l00103">AMMOffer.cpp:103</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_ad88d9033397b09d3f0f761e225628369"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#ad88d9033397b09d3f0f761e225628369">xrpl::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#l00027">AMMOffer.cpp:27</a></div></div>
<div class="ttc" id="aclassxrpl_1_1AMMOffer_html_afe58309b78bba3b05ab9f3bb9ab747d5"><div class="ttname"><a href="classxrpl_1_1AMMOffer.html#afe58309b78bba3b05ab9f3bb9ab747d5">xrpl::AMMOffer::limitIn</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; limitIn(TAmounts&lt; TIn, TOut &gt; const &amp;offerAmount, TIn const &amp;limit, bool roundUp) const</div><div class="ttdoc">Limit in of the provided offer.</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8cpp_source.html#l00079">AMMOffer.cpp:79</a></div></div>
<div class="ttc" id="aclassxrpl_1_1ApplyView_html"><div class="ttname"><a href="classxrpl_1_1ApplyView.html">xrpl::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#l00114">ApplyView.h:115</a></div></div>
<div class="ttc" id="aclassxrpl_1_1Issue_html"><div class="ttname"><a href="classxrpl_1_1Issue.html">xrpl::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#l00013">Issue.h:14</a></div></div>
<div class="ttc" id="aclassxrpl_1_1Number_html"><div class="ttname"><a href="classxrpl_1_1Number.html">xrpl::Number</a></div><div class="ttdoc">Number is a floating point type that can represent a wide range of values.</div><div class="ttdef"><b>Definition</b> <a href="Number_8h_source.html#l00207">Number.h:208</a></div></div>
<div class="ttc" id="aclassxrpl_1_1QualityFunction_html"><div class="ttname"><a href="classxrpl_1_1QualityFunction.html">xrpl::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#l00020">QualityFunction.h:21</a></div></div>
<div class="ttc" id="aclassxrpl_1_1base__uint_html"><div class="ttname"><a href="classxrpl_1_1base__uint.html">xrpl::base_uint&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a35ce7572092b98720a52fa343c6f2fa9"><div class="ttname"><a href="namespacexrpl.html#a35ce7572092b98720a52fa343c6f2fa9">xrpl::to_string</a></div><div class="ttdeci">std::string to_string(base_uint&lt; Bits, Tag &gt; const &amp;a)</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00598">base_uint.h:598</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a5a1298fd71a9010ea3228b2ba8d46efe"><div class="ttname"><a href="namespacexrpl.html#a5a1298fd71a9010ea3228b2ba8d46efe">xrpl::getCurrentTransactionRules</a></div><div class="ttdeci">std::optional&lt; Rules &gt; const &amp; getCurrentTransactionRules()</div><div class="ttdef"><b>Definition</b> <a href="Rules_8cpp_source.html#l00031">Rules.cpp:31</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a5f8d3cff236ddbd2cbf77a2ef664f877"><div class="ttname"><a href="namespacexrpl.html#a5f8d3cff236ddbd2cbf77a2ef664f877">xrpl::swapAssetIn</a></div><div class="ttdeci">TOut swapAssetIn(TAmounts&lt; TIn, TOut &gt; const &amp;pool, TIn const &amp;assetIn, std::uint16_t tfee)</div><div class="ttdoc">AMM pool invariant - the product (A * B) after swap in/out has to remain at least the same: (A + in) ...</div><div class="ttdef"><b>Definition</b> <a href="AMMHelpers_8h_source.html#l00396">AMMHelpers.h:396</a></div></div>
<div class="ttc" id="anamespacexrpl_html_acd8dcc2ff08382ec2b1e01fa2749a25b"><div class="ttname"><a href="namespacexrpl.html#acd8dcc2ff08382ec2b1e01fa2749a25b">xrpl::swapAssetOut</a></div><div class="ttdeci">TIn swapAssetOut(TAmounts&lt; TIn, TOut &gt; const &amp;pool, TOut const &amp;assetOut, std::uint16_t tfee)</div><div class="ttdoc">Swap assetOut out of the pool and swap in a proportional amount of the other asset.</div><div class="ttdef"><b>Definition</b> <a href="AMMHelpers_8h_source.html#l00464">AMMHelpers.h:464</a></div></div>
<div class="ttc" id="anamespacexrpl_html_ad64c4c59078876e1cf6f5c7203f815e0"><div class="ttname"><a href="namespacexrpl.html#ad64c4c59078876e1cf6f5c7203f815e0">xrpl::withinRelativeDistance</a></div><div class="ttdeci">bool withinRelativeDistance(Quality const &amp;calcQuality, Quality const &amp;reqQuality, Number const &amp;dist)</div><div class="ttdoc">Check if the relative distance between the qualities is within the requested distance.</div><div class="ttdef"><b>Definition</b> <a href="AMMHelpers_8h_source.html#l00099">AMMHelpers.h:99</a></div></div>
<div class="ttc" id="astructxrpl_1_1QualityFunction_1_1AMMTag_html"><div class="ttname"><a href="structxrpl_1_1QualityFunction_1_1AMMTag.html">xrpl::QualityFunction::AMMTag</a></div><div class="ttdef"><b>Definition</b> <a href="QualityFunction_8h_source.html#l00031">QualityFunction.h:32</a></div></div>
<div class="ttc" id="astructxrpl_1_1QualityFunction_1_1CLOBLikeTag_html"><div class="ttname"><a href="structxrpl_1_1QualityFunction_1_1CLOBLikeTag.html">xrpl::QualityFunction::CLOBLikeTag</a></div><div class="ttdef"><b>Definition</b> <a href="QualityFunction_8h_source.html#l00036">QualityFunction.h:37</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink