ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ef1af9423e3adf2a90158ce99b5ef20fc13619e
rippled/AMMOffer_8h_source.html
ximinez e1dae4fb62 deploy: 3cbdf818a7
2025-09-18 10:58:55 -07:00

273 lines
40 KiB
HTML
Raw 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.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 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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">AMMOffer.h</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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_APP_AMMOFFER_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_APP_AMMOFFER_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpl/ledger/ApplyView.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/ledger/View.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/protocol/Quality.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;xrpl/protocol/TER.h&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">class </span>AMMLiquidity;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">class </span>QualityFunction;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</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="foldopen00039" data-start="{" data-end="};">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html"> 39</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1AMMOffer.html">AMMOffer</a></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b"> 42</a></span> <a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity&lt;TIn, TOut&gt;</a> <span class="keyword">const</span>&amp; <a class="code hl_variable" href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b">ammLiquidity_</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Initial offer amounts. It is fibonacci seq generated for multi-path.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// If the offer size is set based on the competing CLOB offer then</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// the AMM offer size is such that if the offer is consumed then</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// the updated AMM pool SP quality is going to be equal to competing</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// CLOB offer quality. If there is no competing CLOB offer then</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// the initial size is set to in=cMax[Native,Value],balances.out.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// While this is not a &quot;real&quot; offer it simulates the case of</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// the swap out of the entire side of the pool, in which case</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// the swap in amount is infinite.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#ac869ea9f47d5a72de6e38b37b32f5ee6"> 52</a></span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMOffer.html#ac869ea9f47d5a72de6e38b37b32f5ee6">amounts_</a>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Current pool balances.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#abb2a16ab694596f97e5a404ecd9d1d01"> 54</a></span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMOffer.html#abb2a16ab694596f97e5a404ecd9d1d01">balances_</a>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// The Spot Price quality if balances != amounts</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// else the amounts quality</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a2b1d108410e7790da7d1fa64851ca1b2"> 57</a></span> Quality <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMOffer.html#a2b1d108410e7790da7d1fa64851ca1b2">quality_</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// AMM offer can be consumed once at a given iteration</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22"> 59</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22">consumed_</a>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_class" href="classripple_1_1AMMOffer.html">AMMOffer</a>(</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity&lt;TIn, TOut&gt;</a> <span class="keyword">const</span>&amp; ammLiquidity,</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; amounts,</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; balances,</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> Quality <span class="keyword">const</span>&amp; <a class="code hl_function" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">quality</a>);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> Quality</div>
<div class="foldopen" id="foldopen00069" data-start="{" data-end="}">
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f"> 69</a></span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">quality</a>() const noexcept</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="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMOffer.html#a2b1d108410e7790da7d1fa64851ca1b2">quality_</a>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#ad6eff87d977b5a80f1a07660b455a6db">issueIn</a>() <span class="keyword">const</span>;</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> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a2c97fe4fa25accdb68dc5d76a110acce">owner</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;uint256&gt;</a></div>
<div class="foldopen" id="foldopen00081" data-start="{" data-end="}">
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#aaee1051f1666cf67abd13b835787a539"> 81</a></span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#aaee1051f1666cf67abd13b835787a539">key</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">return</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a>;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> }</div>
</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#ae00679ef074c1566c961189dbe3c6768">amount</a>() <span class="keyword">const</span>;</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="keywordtype">void</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a8856f999ea2ba636a2c74e642d4bb329">consume</a>(<a class="code hl_class" href="classripple_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="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="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00093" data-start="{" data-end="}">
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#ad2eba1069935d7ca545125141fe44d3a"> 93</a></span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#ad2eba1069935d7ca545125141fe44d3a">fully_consumed</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22">consumed_</a>;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> }</div>
</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> TAmounts&lt;TIn, TOut&gt;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a3892b94c6284c67b7bf1e388a26ba11c">limitOut</a>(</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; offrAmt,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> TOut <span class="keyword">const</span>&amp; limit,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">bool</span> roundUp) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> TAmounts&lt;TIn, TOut&gt;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a8aa2c24c93334f8741d7798df5aa97fc">limitIn</a>(TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; offrAmt, TIn <span class="keyword">const</span>&amp; limit, <span class="keywordtype">bool</span> roundUp)</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">const</span>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <a class="code hl_class" href="classripple_1_1QualityFunction.html">QualityFunction</a></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#aedb2204df9f80970d1356c8e1997ca35">getQualityFunc</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="foldopen" id="foldopen00123" data-start="{" data-end="}">
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973"> 123</a></span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973">send</a>(Args&amp;&amp;... args)</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> {</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a64bd5df9caa461c20d406382b13df3c5">accountSend</a>(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::forward&lt;Args&gt;</a>(args)..., <a class="code hl_enumvalue" href="namespaceripple.html#a9d22f4d38ac33f4258a0205f8e11d27ea93cba07454f06a4a960172bbd6e2a435">WaiveTransferFee::Yes</a>);</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="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00129" data-start="{" data-end="}">
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a15fd33ac7f16cc9180854d0fd1c5d6ef"> 129</a></span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a15fd33ac7f16cc9180854d0fd1c5d6ef">isFunded</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="comment">// AMM offer is fully funded by the pool</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> }</div>
</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;std::uint32_t, std::uint32_t&gt;</a></div>
<div class="foldopen" id="foldopen00136" data-start="{" data-end="}">
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a3c1892e00fa434749dd69df1f4d61f68"> 136</a></span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a3c1892e00fa434749dd69df1f4d61f68">adjustRates</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ofrInRate, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ofrOutRate)</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> {</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="comment">// AMM doesn&#39;t pay transfer fee on Payment tx</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordflow">return</span> {ofrInRate, QUALITY_ONE};</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> }</div>
</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <a class="code hl_function" href="classripple_1_1AMMOffer.html#a5d6bfd83553cd0ea0f242da69f13eeb2">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="l00147" name="l00147"></a><span class="lineno"> 147</span>};</div>
</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_APP_AMMOFFER_H_INCLUDED</span></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00059">Journal.h:60</a></div></div>
<div class="ttc" id="aclassripple_1_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:53</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="AMMOffer_8h_source.html#l00039">AMMOffer.h:40</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a15fd33ac7f16cc9180854d0fd1c5d6ef"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a15fd33ac7f16cc9180854d0fd1c5d6ef">ripple::AMMOffer::isFunded</a></div><div class="ttdeci">bool isFunded() const</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00129">AMMOffer.h:129</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a1e5bdbacd99624d69a544b22fc3b9973"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973">ripple::AMMOffer::send</a></div><div class="ttdeci">static TER send(Args &amp;&amp;... args)</div><div class="ttdoc">Send funds without incurring the transfer fee.</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00123">AMMOffer.h:123</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a2b1d108410e7790da7d1fa64851ca1b2"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a2b1d108410e7790da7d1fa64851ca1b2">ripple::AMMOffer::quality_</a></div><div class="ttdeci">Quality const quality_</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00057">AMMOffer.h:57</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#l00050">AMMOffer.cpp:50</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a3892b94c6284c67b7bf1e388a26ba11c"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a3892b94c6284c67b7bf1e388a26ba11c">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 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#l00082">AMMOffer.cpp:82</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a3c1892e00fa434749dd69df1f4d61f68"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a3c1892e00fa434749dd69df1f4d61f68">ripple::AMMOffer::adjustRates</a></div><div class="ttdeci">static std::pair&lt; std::uint32_t, std::uint32_t &gt; adjustRates(std::uint32_t ofrInRate, std::uint32_t ofrOutRate)</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00136">AMMOffer.h:136</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a463950305358ecea6335e1556448024b"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b">ripple::AMMOffer::ammLiquidity_</a></div><div class="ttdeci">AMMLiquidity&lt; TIn, TOut &gt; const &amp; ammLiquidity_</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00042">AMMOffer.h:42</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a486876093ae0534c3b2f6e0de734822f"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">ripple::AMMOffer::quality</a></div><div class="ttdeci">Quality quality() const noexcept</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00069">AMMOffer.h:69</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a5d6bfd83553cd0ea0f242da69f13eeb2"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a5d6bfd83553cd0ea0f242da69f13eeb2">ripple::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#l00141">AMMOffer.cpp:141</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a85677b5d46747caaf83f5d97d6122d22"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22">ripple::AMMOffer::consumed_</a></div><div class="ttdeci">bool consumed_</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00059">AMMOffer.h:59</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#l00064">AMMOffer.cpp:64</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a8aa2c24c93334f8741d7798df5aa97fc"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a8aa2c24c93334f8741d7798df5aa97fc">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, 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#l00112">AMMOffer.cpp:112</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_aaee1051f1666cf67abd13b835787a539"><div class="ttname"><a href="classripple_1_1AMMOffer.html#aaee1051f1666cf67abd13b835787a539">ripple::AMMOffer::key</a></div><div class="ttdeci">std::optional&lt; uint256 &gt; key() const</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00081">AMMOffer.h:81</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_abb2a16ab694596f97e5a404ecd9d1d01"><div class="ttname"><a href="classripple_1_1AMMOffer.html#abb2a16ab694596f97e5a404ecd9d1d01">ripple::AMMOffer::balances_</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; const balances_</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00054">AMMOffer.h:54</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_ac869ea9f47d5a72de6e38b37b32f5ee6"><div class="ttname"><a href="classripple_1_1AMMOffer.html#ac869ea9f47d5a72de6e38b37b32f5ee6">ripple::AMMOffer::amounts_</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; const amounts_</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00052">AMMOffer.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMOffer_html_ad2eba1069935d7ca545125141fe44d3a"><div class="ttname"><a href="classripple_1_1AMMOffer.html#ad2eba1069935d7ca545125141fe44d3a">ripple::AMMOffer::fully_consumed</a></div><div class="ttdeci">bool fully_consumed() const</div><div class="ttdef"><b>Definition</b> <a href="AMMOffer_8h_source.html#l00093">AMMOffer.h:93</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#l00043">AMMOffer.cpp:43</a></div></div>
<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#l00057">AMMOffer.cpp:57</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#l00131">AMMOffer.cpp:131</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#l00142">ApplyView.h:143</a></div></div>
<div class="ttc" id="aclassripple_1_1Issue_html"><div class="ttname"><a href="classripple_1_1Issue.html">ripple::Issue</a></div><div class="ttdoc">A currency issued by an account.</div><div class="ttdef"><b>Definition</b> <a href="Issue_8h_source.html#l00032">Issue.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_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:40</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset&lt; CanCvtToTER &gt;</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&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</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="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a64bd5df9caa461c20d406382b13df3c5"><div class="ttname"><a href="namespaceripple.html#a64bd5df9caa461c20d406382b13df3c5">ripple::accountSend</a></div><div class="ttdeci">TER accountSend(ApplyView &amp;view, AccountID const &amp;from, AccountID const &amp;to, STAmount const &amp;saAmount, beast::Journal j, WaiveTransferFee waiveFee=WaiveTransferFee::No)</div><div class="ttdoc">Calls static accountSendIOU if saAmount represents Issue.</div><div class="ttdef"><b>Definition</b> <a href="View_8cpp_source.html#l02174">View.cpp:2174</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9d22f4d38ac33f4258a0205f8e11d27ea93cba07454f06a4a960172bbd6e2a435"><div class="ttname"><a href="namespaceripple.html#a9d22f4d38ac33f4258a0205f8e11d27ea93cba07454f06a4a960172bbd6e2a435">ripple::WaiveTransferFee::Yes</a></div><div class="ttdeci">@ Yes</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="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</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