ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/AMMLiquidity_8h_source.html
bthomee 099ba7da4d deploy: dc8b37a524
2025-09-18 08:15:26 -07:00

258 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: AMMLiquidity.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">AMMLiquidity.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_TX_AMMLIQUIDITY_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_APP_TX_AMMLIQUIDITY_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;xrpld/app/misc/AMMHelpers.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpld/app/misc/AMMUtils.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpld/app/paths/AMMContext.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;xrpl/basics/Log.h&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;xrpl/ledger/ReadView.h&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;xrpl/ledger/View.h&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;xrpl/protocol/Quality.h&gt;</span></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">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</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="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">class </span>AMMOffer;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</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="foldopen00052" data-start="{" data-end="};">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html"> 52</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>{</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a10fb841bc078c796d9e3c2fcb3541c13"> 55</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1Number.html">Number</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#a10fb841bc078c796d9e3c2fcb3541c13">InitialFibSeqPct</a> = <a class="code hl_class" href="classripple_1_1Number.html">Number</a>(5) / 20000;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#aaa76a6df3301390623b4502708b65a66"> 56</a></span> <a class="code hl_class" href="classripple_1_1AMMContext.html">AMMContext</a>&amp; <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#aaa76a6df3301390623b4502708b65a66">ammContext_</a>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a133f036de6e226d1a9d989ba57f50cb7"> 57</a></span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#a133f036de6e226d1a9d989ba57f50cb7">ammAccountID_</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#aeba999ec8adb002627daf4434b39cb5a"> 58</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#aeba999ec8adb002627daf4434b39cb5a">tradingFee_</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a4a36a6364b9f06e25c418bd59cf4d455"> 59</a></span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#a4a36a6364b9f06e25c418bd59cf4d455">issueIn_</a>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#add252bdab66684786d1d1faf36c03585"> 60</a></span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#add252bdab66684786d1d1faf36c03585">issueOut_</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Initial AMM pool balances</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#abb12965efebc4a2dac9f59f1bffc1974"> 62</a></span> TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#abb12965efebc4a2dac9f59f1bffc1974">initialBalances_</a>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a84417ee785f2490ca7a50fc70b9be157"> 63</a></span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#a84417ee785f2490ca7a50fc70b9be157">j_</a>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>(</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; view,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccountID,</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a2464ba632642635216c034a22d1408c8">tradingFee</a>,</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp; <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>,</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp; <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>,</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <a class="code hl_class" href="classripple_1_1AMMContext.html">AMMContext</a>&amp; ammContext,</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> j);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a640f4fd0c1a5b2500f43c75132f702b0"> 74</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a640f4fd0c1a5b2500f43c75132f702b0">~AMMLiquidity</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a031fa0d4a212b3ffda51a01acd65c0d7"> 75</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a031fa0d4a212b3ffda51a01acd65c0d7">AMMLiquidity</a>(<a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>&amp;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#aa217198640a9af820fdb9c487b5b094b"> 77</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#aa217198640a9af820fdb9c487b5b094b">operator=</a>(<a class="code hl_class" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;AMMOffer&lt;TIn, TOut&gt;</a>&gt;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a4f40426bb36529ccba8ef2768e3c3bc9">getOffer</a>(<a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; view, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;Quality&gt;</a> <span class="keyword">const</span>&amp; clobQuality)</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">const</span>;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="}">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a9316bb888b1ce3b10be95103a2830a08"> 89</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a9316bb888b1ce3b10be95103a2830a08">ammAccount</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#a133f036de6e226d1a9d989ba57f50cb7">ammAccountID_</a>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> }</div>
</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00095" data-start="{" data-end="}">
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a293bb918d765f4291d1f8d11a0a1e63d"> 95</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a293bb918d765f4291d1f8d11a0a1e63d">multiPath</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#aaa76a6df3301390623b4502708b65a66">ammContext_</a>.<a class="code hl_function" href="classripple_1_1AMMContext.html#aa5131ca8c3c5190fc5ae3d5d75cebcea">multiPath</a>();</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> }</div>
</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div>
<div class="foldopen" id="foldopen00101" data-start="{" data-end="}">
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a2464ba632642635216c034a22d1408c8"> 101</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a2464ba632642635216c034a22d1408c8">tradingFee</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#aeba999ec8adb002627daf4434b39cb5a">tradingFee_</a>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <a class="code hl_class" href="classripple_1_1AMMContext.html">AMMContext</a>&amp;</div>
<div class="foldopen" id="foldopen00107" data-start="{" data-end="}">
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a0483f5ab5a62264b9254e7fc6f15fbcf"> 107</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a0483f5ab5a62264b9254e7fc6f15fbcf">context</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#aaa76a6df3301390623b4502708b65a66">ammContext_</a>;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> }</div>
</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00113" data-start="{" data-end="}">
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a3f3caadf2e06839e1a67a6690b2fdad7"> 113</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a3f3caadf2e06839e1a67a6690b2fdad7">issueIn</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#a4a36a6364b9f06e25c418bd59cf4d455">issueIn_</a>;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div>
</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> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00119" data-start="{" data-end="}">
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classripple_1_1AMMLiquidity.html#a055fcd3cdd03884c34a008ae85f2bd80"> 119</a></span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a055fcd3cdd03884c34a008ae85f2bd80">issueOut</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1AMMLiquidity.html#add252bdab66684786d1d1faf36c03585">issueOut_</a>;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> }</div>
</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> TAmounts&lt;TIn, TOut&gt;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#a90e392457e7f89d2ee5e2a5398b29aac">fetchBalances</a>(<a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; view) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> TAmounts&lt;TIn, TOut&gt;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#afc3099a63d626321df693638c4b09b34">generateFibSeqOffer</a>(TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; balances) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;AMMOffer&lt;TIn, TOut&gt;</a>&gt;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <a class="code hl_function" href="classripple_1_1AMMLiquidity.html#ab6752c49c9927eb6d07bb08f4418581e">maxOffer</a>(TAmounts&lt;TIn, TOut&gt; <span class="keyword">const</span>&amp; balances, <a class="code hl_class" href="classripple_1_1Rules.html">Rules</a> <span class="keyword">const</span>&amp; rules) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span>};</div>
</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_APP_TX_AMMLIQUIDITY_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_1AMMContext_html"><div class="ttname"><a href="classripple_1_1AMMContext.html">ripple::AMMContext</a></div><div class="ttdoc">Maintains AMM info per overall payment engine execution and individual iteration.</div><div class="ttdef"><b>Definition</b> <a href="AMMContext_8h_source.html#l00035">AMMContext.h:36</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMContext_html_aa5131ca8c3c5190fc5ae3d5d75cebcea"><div class="ttname"><a href="classripple_1_1AMMContext.html#aa5131ca8c3c5190fc5ae3d5d75cebcea">ripple::AMMContext::multiPath</a></div><div class="ttdeci">bool multiPath() const</div><div class="ttdef"><b>Definition</b> <a href="AMMContext_8h_source.html#l00064">AMMContext.h:64</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_1AMMLiquidity_html_a031fa0d4a212b3ffda51a01acd65c0d7"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a031fa0d4a212b3ffda51a01acd65c0d7">ripple::AMMLiquidity::AMMLiquidity</a></div><div class="ttdeci">AMMLiquidity(AMMLiquidity const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a0483f5ab5a62264b9254e7fc6f15fbcf"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a0483f5ab5a62264b9254e7fc6f15fbcf">ripple::AMMLiquidity::context</a></div><div class="ttdeci">AMMContext &amp; context() const</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00107">AMMLiquidity.h:107</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a055fcd3cdd03884c34a008ae85f2bd80"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a055fcd3cdd03884c34a008ae85f2bd80">ripple::AMMLiquidity::issueOut</a></div><div class="ttdeci">Issue const &amp; issueOut() const</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00119">AMMLiquidity.h:119</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a10fb841bc078c796d9e3c2fcb3541c13"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a10fb841bc078c796d9e3c2fcb3541c13">ripple::AMMLiquidity::InitialFibSeqPct</a></div><div class="ttdeci">static Number const InitialFibSeqPct</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00055">AMMLiquidity.h:55</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a133f036de6e226d1a9d989ba57f50cb7"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a133f036de6e226d1a9d989ba57f50cb7">ripple::AMMLiquidity::ammAccountID_</a></div><div class="ttdeci">AccountID const ammAccountID_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00057">AMMLiquidity.h:57</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a2464ba632642635216c034a22d1408c8"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a2464ba632642635216c034a22d1408c8">ripple::AMMLiquidity::tradingFee</a></div><div class="ttdeci">std::uint32_t tradingFee() const</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00101">AMMLiquidity.h:101</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a293bb918d765f4291d1f8d11a0a1e63d"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a293bb918d765f4291d1f8d11a0a1e63d">ripple::AMMLiquidity::multiPath</a></div><div class="ttdeci">bool multiPath() const</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00095">AMMLiquidity.h:95</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a3f3caadf2e06839e1a67a6690b2fdad7"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a3f3caadf2e06839e1a67a6690b2fdad7">ripple::AMMLiquidity::issueIn</a></div><div class="ttdeci">Issue const &amp; issueIn() const</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00113">AMMLiquidity.h:113</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a4a36a6364b9f06e25c418bd59cf4d455"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a4a36a6364b9f06e25c418bd59cf4d455">ripple::AMMLiquidity::issueIn_</a></div><div class="ttdeci">Issue const issueIn_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00059">AMMLiquidity.h:59</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a4f40426bb36529ccba8ef2768e3c3bc9"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a4f40426bb36529ccba8ef2768e3c3bc9">ripple::AMMLiquidity::getOffer</a></div><div class="ttdeci">std::optional&lt; AMMOffer&lt; TIn, TOut &gt; &gt; getOffer(ReadView const &amp;view, std::optional&lt; Quality &gt; const &amp;clobQuality) const</div><div class="ttdoc">Generate AMM offer.</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8cpp_source.html#l00150">AMMLiquidity.cpp:150</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a640f4fd0c1a5b2500f43c75132f702b0"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a640f4fd0c1a5b2500f43c75132f702b0">ripple::AMMLiquidity::~AMMLiquidity</a></div><div class="ttdeci">~AMMLiquidity()=default</div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a84417ee785f2490ca7a50fc70b9be157"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a84417ee785f2490ca7a50fc70b9be157">ripple::AMMLiquidity::j_</a></div><div class="ttdeci">beast::Journal const j_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00063">AMMLiquidity.h:63</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a90e392457e7f89d2ee5e2a5398b29aac"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a90e392457e7f89d2ee5e2a5398b29aac">ripple::AMMLiquidity::fetchBalances</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; fetchBalances(ReadView const &amp;view) const</div><div class="ttdoc">Fetches current AMM balances.</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8cpp_source.html#l00046">AMMLiquidity.cpp:46</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_a9316bb888b1ce3b10be95103a2830a08"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#a9316bb888b1ce3b10be95103a2830a08">ripple::AMMLiquidity::ammAccount</a></div><div class="ttdeci">AccountID const &amp; ammAccount() const</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00089">AMMLiquidity.h:89</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_aa217198640a9af820fdb9c487b5b094b"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#aa217198640a9af820fdb9c487b5b094b">ripple::AMMLiquidity::operator=</a></div><div class="ttdeci">AMMLiquidity &amp; operator=(AMMLiquidity const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_aaa76a6df3301390623b4502708b65a66"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#aaa76a6df3301390623b4502708b65a66">ripple::AMMLiquidity::ammContext_</a></div><div class="ttdeci">AMMContext &amp; ammContext_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00056">AMMLiquidity.h:56</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_ab6752c49c9927eb6d07bb08f4418581e"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#ab6752c49c9927eb6d07bb08f4418581e">ripple::AMMLiquidity::maxOffer</a></div><div class="ttdeci">std::optional&lt; AMMOffer&lt; TIn, TOut &gt; &gt; maxOffer(TAmounts&lt; TIn, TOut &gt; const &amp;balances, Rules const &amp;rules) const</div><div class="ttdoc">Generate max offer.</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8cpp_source.html#l00122">AMMLiquidity.cpp:122</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_abb12965efebc4a2dac9f59f1bffc1974"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#abb12965efebc4a2dac9f59f1bffc1974">ripple::AMMLiquidity::initialBalances_</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; const initialBalances_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00062">AMMLiquidity.h:62</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_add252bdab66684786d1d1faf36c03585"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#add252bdab66684786d1d1faf36c03585">ripple::AMMLiquidity::issueOut_</a></div><div class="ttdeci">Issue const issueOut_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00060">AMMLiquidity.h:60</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_aeba999ec8adb002627daf4434b39cb5a"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#aeba999ec8adb002627daf4434b39cb5a">ripple::AMMLiquidity::tradingFee_</a></div><div class="ttdeci">std::uint32_t const tradingFee_</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8h_source.html#l00058">AMMLiquidity.h:58</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMLiquidity_html_afc3099a63d626321df693638c4b09b34"><div class="ttname"><a href="classripple_1_1AMMLiquidity.html#afc3099a63d626321df693638c4b09b34">ripple::AMMLiquidity::generateFibSeqOffer</a></div><div class="ttdeci">TAmounts&lt; TIn, TOut &gt; generateFibSeqOffer(TAmounts&lt; TIn, TOut &gt; const &amp;balances) const</div><div class="ttdoc">Generate AMM offers with the offer size based on Fibonacci sequence.</div><div class="ttdef"><b>Definition</b> <a href="AMMLiquidity_8cpp_source.html#l00059">AMMLiquidity.cpp:59</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_1Number_html"><div class="ttname"><a href="classripple_1_1Number.html">ripple::Number</a></div><div class="ttdef"><b>Definition</b> <a href="Number_8h_source.html#l00035">Number.h:36</a></div></div>
<div class="ttc" id="aclassripple_1_1ReadView_html"><div class="ttname"><a href="classripple_1_1ReadView.html">ripple::ReadView</a></div><div class="ttdoc">A view into a ledger.</div><div class="ttdef"><b>Definition</b> <a href="ReadView_8h_source.html#l00050">ReadView.h:51</a></div></div>
<div class="ttc" id="aclassripple_1_1Rules_html"><div class="ttname"><a href="classripple_1_1Rules.html">ripple::Rules</a></div><div class="ttdoc">Rules controlling protocol behavior.</div><div class="ttdef"><b>Definition</b> <a href="Rules_8h_source.html#l00037">Rules.h:38</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="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_a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf"><div class="ttname"><a href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">ripple::QualityDirection::in</a></div><div class="ttdeci">@ in</div></div>
<div class="ttc" id="anamespaceripple_html_a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275"><div class="ttname"><a href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">ripple::QualityDirection::out</a></div><div class="ttdeci">@ out</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><!-- 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