mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
248 lines
37 KiB
HTML
248 lines
37 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.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_1e0db5c7188e9c3cb47dd9ba683c8f27.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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_APP_AMMOFFER_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_APP_AMMOFFER_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/ledger/ApplyView.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/ledger/View.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/protocol/Quality.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <ripple/protocol/TER.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span> <<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>AMMLiquidity;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>QualityFunction;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">template</span> <<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>AMMOffer</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b"> 42</a></span>  <a class="code" href="classripple_1_1AMMLiquidity.html">AMMLiquidity<TIn, TOut></a> <span class="keyword">const</span>& <a class="code" href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b">ammLiquidity_</a>;</div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// While this is not a "real" offer it simulates the case of</span></div>
|
|
<div class="line"><a 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 name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// the swap in amount is infinite.</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#aa846ce37b8941fb26fac2db78655f609"> 52</a></span>  TAmounts<TIn, TOut> <span class="keyword">const</span> <a class="code" href="classripple_1_1AMMOffer.html#aa846ce37b8941fb26fac2db78655f609">amounts_</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// If seated then current pool balances. Used in one-path limiting steps</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// to swap in/out.</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a75ffe2ba285ffe0238927a12c41aef8c"> 55</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<TAmounts<TIn, TOut></a>> <span class="keyword">const</span> <a class="code" href="classripple_1_1AMMOffer.html#a75ffe2ba285ffe0238927a12c41aef8c">balances_</a>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// The Spot Price quality if balances != amounts</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// else the amounts quality</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a05edc64a26adef208eeeaf2c48279bfc"> 58</a></span>  Quality <span class="keyword">const</span> <a class="code" href="classripple_1_1AMMOffer.html#a05edc64a26adef208eeeaf2c48279bfc">quality_</a>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// AMM offer can be consumed once at a given iteration</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22"> 60</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22">consumed_</a>;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classripple_1_1AMMOffer.html#a2135c82cf3cb7183eeff9fe0df5d9057">AMMOffer</a>(</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classripple_1_1AMMLiquidity.html">AMMLiquidity<TIn, TOut></a> <span class="keyword">const</span>& ammLiquidity,</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  TAmounts<TIn, TOut> <span class="keyword">const</span>& amounts,</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a><TAmounts<TIn, TOut>> <span class="keyword">const</span>& balances,</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  Quality <span class="keyword">const</span>& <a class="code" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">quality</a>);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  Quality</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f"> 70</a></span>  <a class="code" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">quality</a>() const noexcept</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1AMMOffer.html#a05edc64a26adef208eeeaf2c48279bfc">quality_</a>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classripple_1_1AMMOffer.html#ad6eff87d977b5a80f1a07660b455a6db">issueIn</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classripple_1_1AMMOffer.html#a1c599cad195a93f56c24975eab9728cc">issueOut</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="classripple_1_1AMMOffer.html#a2c97fe4fa25accdb68dc5d76a110acce">owner</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<uint256></a></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a88753961f835cc4e516bed3598be5dc3"> 85</a></span>  <a class="code" href="classripple_1_1AMMOffer.html#a88753961f835cc4e516bed3598be5dc3">key</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> std::nullopt;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  TAmounts<TIn, TOut> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classripple_1_1AMMOffer.html#ae00679ef074c1566c961189dbe3c6768">amount</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classripple_1_1AMMOffer.html#a8856f999ea2ba636a2c74e642d4bb329">consume</a>(<a class="code" href="classripple_1_1ApplyView.html">ApplyView</a>& view, TAmounts<TIn, TOut> <span class="keyword">const</span>& consumed);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#ad2eba1069935d7ca545125141fe44d3a"> 97</a></span>  <a class="code" href="classripple_1_1AMMOffer.html#ad2eba1069935d7ca545125141fe44d3a">fully_consumed</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22">consumed_</a>;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  TAmounts<TIn, TOut></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classripple_1_1AMMOffer.html#a3757f92066ba7fa0fcf4b8964b00dfa4">limitOut</a>(</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  TAmounts<TIn, TOut> <span class="keyword">const</span>& offrAmt,</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  TOut <span class="keyword">const</span>& limit,</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">bool</span> fixReducedOffers,</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">bool</span> roundUp) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  TAmounts<TIn, TOut></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="classripple_1_1AMMOffer.html#a47c9d8c0e8d74d833a2591b303b02c3e">limitIn</a>(TAmounts<TIn, TOut> <span class="keyword">const</span>& offrAmt, TIn <span class="keyword">const</span>& limit) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="classripple_1_1AMMOffer.html#aedb2204df9f80970d1356c8e1997ca35">getQualityFunc</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">template</span> <<span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973"> 127</a></span>  <a class="code" href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973">send</a>(Args&&... args)</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  {</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceripple.html#a31e8d2d9c46559018ad6e096b31fc308">accountSend</a>(std::forward<Args>(args)..., <a class="code" href="namespaceripple.html#a9d22f4d38ac33f4258a0205f8e11d27ea93cba07454f06a4a960172bbd6e2a435">WaiveTransferFee::Yes</a>);</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a15fd33ac7f16cc9180854d0fd1c5d6ef"> 133</a></span>  <a class="code" href="classripple_1_1AMMOffer.html#a15fd33ac7f16cc9180854d0fd1c5d6ef">isFunded</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">// AMM offer is fully funded by the pool</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">static</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<std::uint32_t, std::uint32_t></a></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="classripple_1_1AMMOffer.html#a27aaec299811ff36f123aec975db230d"> 140</a></span>  <a class="code" href="classripple_1_1AMMOffer.html#a27aaec299811ff36f123aec975db230d">adjustRates</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ofrInRate, <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ofrOutRate)</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  {</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment">// AMM doesn't pay transfer fee on Payment tx</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">return</span> {ofrInRate, QUALITY_ONE};</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  }</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> };</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor">#endif // RIPPLE_APP_AMMOFFER_H_INCLUDED</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< TIn, TOut > const & 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< TIn, TOut > limitOut(TAmounts< TIn, TOut > const &offrAmt, TOut const &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_1AMMOffer_html_a463950305358ecea6335e1556448024b"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b">ripple::AMMOffer::ammLiquidity_</a></div><div class="ttdeci">AMMLiquidity< TIn, TOut > const & 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_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="anamespaceripple_html_a31e8d2d9c46559018ad6e096b31fc308"><div class="ttname"><a href="namespaceripple.html#a31e8d2d9c46559018ad6e096b31fc308">ripple::accountSend</a></div><div class="ttdeci">TER accountSend(ApplyView &view, AccountID const &uSenderID, AccountID const &uReceiverID, STAmount const &saAmount, beast::Journal j, WaiveTransferFee waiveFee)</div><div class="ttdef"><b>Definition:</b> <a href="View_8cpp_source.html#l01142">View.cpp:1142</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="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_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 & 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< TIn, TOut > limitIn(TAmounts< TIn, TOut > const &offrAmt, TIn const &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_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#l00133">AMMOffer.h:133</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_1AMMOffer_html_a05edc64a26adef208eeeaf2c48279bfc"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a05edc64a26adef208eeeaf2c48279bfc">ripple::AMMOffer::quality_</a></div><div class="ttdeci">const Quality quality_</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8h_source.html#l00058">AMMOffer.h:58</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMOffer_html_aa846ce37b8941fb26fac2db78655f609"><div class="ttname"><a href="classripple_1_1AMMOffer.html#aa846ce37b8941fb26fac2db78655f609">ripple::AMMOffer::amounts_</a></div><div class="ttdeci">const TAmounts< TIn, TOut > 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_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint</a></div><div class="ttdoc">Integers of any length that is a multiple of 32-bits.</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00082">base_uint.h:82</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset< CanCvtToTER ></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 &view, TAmounts< TIn, TOut > const &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_a27aaec299811ff36f123aec975db230d"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a27aaec299811ff36f123aec975db230d">ripple::AMMOffer::adjustRates</a></div><div class="ttdeci">static std::pair< std::uint32_t, std::uint32_t > adjustRates(std::uint32_t ofrInRate, std::uint32_t ofrOutRate)</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8h_source.html#l00140">AMMOffer.h:140</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="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< TIn, TOut > const &ammLiquidity, TAmounts< TIn, TOut > const &amounts, std::optional< TAmounts< TIn, TOut >> const &balances, Quality const &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_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#l00070">AMMOffer.h:70</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_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#l00097">AMMOffer.h:97</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="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#l00060">AMMOffer.h:60</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 & 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_a1e5bdbacd99624d69a544b22fc3b9973"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973">ripple::AMMOffer::send</a></div><div class="ttdeci">static TER send(Args &&... 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#l00127">AMMOffer.h:127</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a88753961f835cc4e516bed3598be5dc3"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a88753961f835cc4e516bed3598be5dc3">ripple::AMMOffer::key</a></div><div class="ttdeci">std::optional< uint256 > key() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8h_source.html#l00085">AMMOffer.h:85</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 & owner() const</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8cpp_source.html#l00056">AMMOffer.cpp:56</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMOffer_html_a75ffe2ba285ffe0238927a12c41aef8c"><div class="ttname"><a href="classripple_1_1AMMOffer.html#a75ffe2ba285ffe0238927a12c41aef8c">ripple::AMMOffer::balances_</a></div><div class="ttdeci">const std::optional< TAmounts< TIn, TOut > > balances_</div><div class="ttdef"><b>Definition:</b> <a href="AMMOffer_8h_source.html#l00055">AMMOffer.h:55</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|