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/AMMCore_8h_source.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

233 lines
36 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: AMMCore.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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_8d04e3c0b58cad28d7755ed462d1b6c0.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">AMMCore.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_PROTOCOL_AMMCORE_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_PROTOCOL_AMMCORE_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/basics/Number.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/protocol/AccountID.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/Issue.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><span class="preprocessor">#include &lt;xrpl/protocol/UintTypes.h&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="namespaceripple.html#ae0ae9ebb091dfd0a1578b5c791fbe5da"> 31</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#ae0ae9ebb091dfd0a1578b5c791fbe5da">TRADING_FEE_THRESHOLD</a> = 1000; <span class="comment">// 1%</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">// Auction slot</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="namespaceripple.html#a1bdde33b446d3f98ddf6f1fd92baeca7"> 34</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#a1bdde33b446d3f98ddf6f1fd92baeca7">TOTAL_TIME_SLOT_SECS</a> = 24 * 3600;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="namespaceripple.html#a23fb7eb93804db3ca8fe3ad9cb8f7cd4"> 35</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#a23fb7eb93804db3ca8fe3ad9cb8f7cd4">AUCTION_SLOT_TIME_INTERVALS</a> = 20;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="namespaceripple.html#ae4b23ad04ab6a4fa07b0644753414844"> 36</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#ae4b23ad04ab6a4fa07b0644753414844">AUCTION_SLOT_MAX_AUTH_ACCOUNTS</a> = 4;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespaceripple.html#a94a558cd104922c7b67cc0af9fee630b"> 37</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#a94a558cd104922c7b67cc0af9fee630b">AUCTION_SLOT_FEE_SCALE_FACTOR</a> = 100000;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="namespaceripple.html#afc5d8c9c40be21c625aa413b915eb02f"> 38</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#afc5d8c9c40be21c625aa413b915eb02f">AUCTION_SLOT_DISCOUNTED_FEE_FRACTION</a> = 10;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple.html#a722d3adbf2dfcfa53329113ed9d5467e"> 39</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#a722d3adbf2dfcfa53329113ed9d5467e">AUCTION_SLOT_MIN_FEE_FRACTION</a> = 25;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="namespaceripple.html#ab3ff1082024f45e95dc0352753fd0a50"> 40</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#ab3ff1082024f45e95dc0352753fd0a50">AUCTION_SLOT_INTERVAL_DURATION</a> =</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_variable" href="namespaceripple.html#a1bdde33b446d3f98ddf6f1fd92baeca7">TOTAL_TIME_SLOT_SECS</a> / <a class="code hl_variable" href="namespaceripple.html#a23fb7eb93804db3ca8fe3ad9cb8f7cd4">AUCTION_SLOT_TIME_INTERVALS</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// Votes</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="namespaceripple.html#add680fb7e654697df4e36789f91b31cb"> 44</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#add680fb7e654697df4e36789f91b31cb">VOTE_MAX_SLOTS</a> = 8;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="namespaceripple.html#aaa934f7a06a533f8eae7acf597b2161d"> 45</a></span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <span class="keyword">constexpr</span> <a class="code hl_variable" href="namespaceripple.html#aaa934f7a06a533f8eae7acf597b2161d">VOTE_WEIGHT_SCALE_FACTOR</a> = 100000;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1STObject.html">STObject</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1Rules.html">Rules</a>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><a class="code hl_class" href="classripple_1_1base__uint.html">Currency</a></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><a class="code hl_function" href="namespaceripple.html#a2e120e21ebcb5778e7ead49555f5297f">ammLPTCurrency</a>(<a class="code hl_class" href="classripple_1_1base__uint.html">Currency</a> <span class="keyword">const</span>&amp; cur1, <a class="code hl_class" href="classripple_1_1base__uint.html">Currency</a> <span class="keyword">const</span>&amp; cur2);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><a class="code hl_class" href="classripple_1_1Issue.html">Issue</a></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><a class="code hl_function" href="namespaceripple.html#a5e068ce58638111534101573085f71a2">ammLPTIssue</a>(</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <a class="code hl_class" href="classripple_1_1base__uint.html">Currency</a> <span class="keyword">const</span>&amp; cur1,</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_class" href="classripple_1_1base__uint.html">Currency</a> <span class="keyword">const</span>&amp; cur2,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</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="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><a class="code hl_function" href="namespaceripple.html#a0a4a286d1662cbca7a134981b70e65b6">invalidAMMAmount</a>(</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;Issue, Issue&gt;</a>&gt; <span class="keyword">const</span>&amp; pair = <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="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">bool</span> validZero = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><a class="code hl_function" href="namespaceripple.html#a24c6e746a89df3d7e0d51db772e8545a">invalidAMMAsset</a>(</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp; issue,</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;Issue, Issue&gt;</a>&gt; <span class="keyword">const</span>&amp; pair = <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="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_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><a class="code hl_function" href="namespaceripple.html#aac3db9cd7b81ce8bd1ebf45435f0909b">invalidAMMAssetPair</a>(</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp; issue1,</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp; issue2,</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</a>&lt;<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;Issue, Issue&gt;</a>&gt; <span class="keyword">const</span>&amp; pair = <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="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;std::uint8_t&gt;</a></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><a class="code hl_function" href="namespaceripple.html#a23fcbb81cb52959dfbeebade68c4db18">ammAuctionTimeSlot</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> <a class="code hl_enumvalue" href="namespaceripple.html#a6434c1a0fd22b77e2e4a228c0eca79eba43b5c9175984c071f30b873fdce0a000">current</a>, <a class="code hl_class" href="classripple_1_1STObject.html">STObject</a> <span class="keyword">const</span>&amp; auctionSlot);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><a class="code hl_function" href="namespaceripple.html#a5c4fa33b0b13deab58e07744afe0f7ed">ammEnabled</a>(<a class="code hl_class" href="classripple_1_1Rules.html">Rules</a> <span class="keyword">const</span>&amp;);</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="keyword">inline</span> <a class="code hl_class" href="classripple_1_1Number.html">Number</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="namespaceripple.html#aa8871e2f35cee24497183274c0bab5fd"> 101</a></span><a class="code hl_function" href="namespaceripple.html#aa8871e2f35cee24497183274c0bab5fd">getFee</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</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_class" href="classripple_1_1Number.html">Number</a>{tfee} / <a class="code hl_variable" href="namespaceripple.html#a94a558cd104922c7b67cc0af9fee630b">AUCTION_SLOT_FEE_SCALE_FACTOR</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="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="keyword">inline</span> Number</div>
<div class="foldopen" id="foldopen00110" data-start="{" data-end="}">
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a"> 110</a></span><a class="code hl_function" href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">feeMult</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</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> <span class="keywordflow">return</span> 1 - <a class="code hl_function" href="namespaceripple.html#aa8871e2f35cee24497183274c0bab5fd">getFee</a>(tfee);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>}</div>
</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="keyword">inline</span> Number</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="namespaceripple.html#ac78c8c0642bbbe33db633286fa147381"> 119</a></span><a class="code hl_function" href="namespaceripple.html#ac78c8c0642bbbe33db633286fa147381">feeMultHalf</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>{</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="keywordflow">return</span> 1 - <a class="code hl_function" href="namespaceripple.html#aa8871e2f35cee24497183274c0bab5fd">getFee</a>(tfee) / 2;</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="comment">// namespace ripple</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_PROTOCOL_AMMCORE_H_INCLUDED</span></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_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_1STAmount_html"><div class="ttname"><a href="classripple_1_1STAmount.html">ripple::STAmount</a></div><div class="ttdef"><b>Definition</b> <a href="STAmount_8h_source.html#l00049">STAmount.h:50</a></div></div>
<div class="ttc" id="aclassripple_1_1STObject_html"><div class="ttname"><a href="classripple_1_1STObject.html">ripple::STObject</a></div><div class="ttdef"><b>Definition</b> <a href="STObject_8h_source.html#l00056">STObject.h:57</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset</a></div><div class="ttdef"><b>Definition</b> <a href="TER_8h_source.html#l00410">TER.h:411</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::CurrencyTag &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::uint16_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_a0a4a286d1662cbca7a134981b70e65b6"><div class="ttname"><a href="namespaceripple.html#a0a4a286d1662cbca7a134981b70e65b6">ripple::invalidAMMAmount</a></div><div class="ttdeci">NotTEC invalidAMMAmount(STAmount const &amp;amount, std::optional&lt; std::pair&lt; Issue, Issue &gt; &gt; const &amp;pair=std::nullopt, bool validZero=false)</div><div class="ttdoc">Validate the amount.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00095">AMMCore.cpp:95</a></div></div>
<div class="ttc" id="anamespaceripple_html_a1bdde33b446d3f98ddf6f1fd92baeca7"><div class="ttname"><a href="namespaceripple.html#a1bdde33b446d3f98ddf6f1fd92baeca7">ripple::TOTAL_TIME_SLOT_SECS</a></div><div class="ttdeci">std::uint32_t constexpr TOTAL_TIME_SLOT_SECS</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00034">AMMCore.h:34</a></div></div>
<div class="ttc" id="anamespaceripple_html_a23fb7eb93804db3ca8fe3ad9cb8f7cd4"><div class="ttname"><a href="namespaceripple.html#a23fb7eb93804db3ca8fe3ad9cb8f7cd4">ripple::AUCTION_SLOT_TIME_INTERVALS</a></div><div class="ttdeci">std::uint16_t constexpr AUCTION_SLOT_TIME_INTERVALS</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00035">AMMCore.h:35</a></div></div>
<div class="ttc" id="anamespaceripple_html_a23fcbb81cb52959dfbeebade68c4db18"><div class="ttname"><a href="namespaceripple.html#a23fcbb81cb52959dfbeebade68c4db18">ripple::ammAuctionTimeSlot</a></div><div class="ttdeci">std::optional&lt; std::uint8_t &gt; ammAuctionTimeSlot(std::uint64_t current, STObject const &amp;auctionSlot)</div><div class="ttdoc">Get time slot of the auction slot.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00108">AMMCore.cpp:108</a></div></div>
<div class="ttc" id="anamespaceripple_html_a24c6e746a89df3d7e0d51db772e8545a"><div class="ttname"><a href="namespaceripple.html#a24c6e746a89df3d7e0d51db772e8545a">ripple::invalidAMMAsset</a></div><div class="ttdeci">NotTEC invalidAMMAsset(Issue const &amp;issue, std::optional&lt; std::pair&lt; Issue, Issue &gt; &gt; const &amp;pair=std::nullopt)</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00066">AMMCore.cpp:66</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2e120e21ebcb5778e7ead49555f5297f"><div class="ttname"><a href="namespaceripple.html#a2e120e21ebcb5778e7ead49555f5297f">ripple::ammLPTCurrency</a></div><div class="ttdeci">Currency ammLPTCurrency(Currency const &amp;cur1, Currency const &amp;cur2)</div><div class="ttdoc">Calculate Liquidity Provider Token (LPT) Currency.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00043">AMMCore.cpp:43</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5c4fa33b0b13deab58e07744afe0f7ed"><div class="ttname"><a href="namespaceripple.html#a5c4fa33b0b13deab58e07744afe0f7ed">ripple::ammEnabled</a></div><div class="ttdeci">bool ammEnabled(Rules const &amp;)</div><div class="ttdoc">Return true if required AMM amendments are enabled.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00129">AMMCore.cpp:129</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5e068ce58638111534101573085f71a2"><div class="ttname"><a href="namespaceripple.html#a5e068ce58638111534101573085f71a2">ripple::ammLPTIssue</a></div><div class="ttdeci">Issue ammLPTIssue(Currency const &amp;cur1, Currency const &amp;cur2, AccountID const &amp;ammAccountID)</div><div class="ttdoc">Calculate LPT Issue from AMM asset pair.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00057">AMMCore.cpp:57</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6434c1a0fd22b77e2e4a228c0eca79eba43b5c9175984c071f30b873fdce0a000"><div class="ttname"><a href="namespaceripple.html#a6434c1a0fd22b77e2e4a228c0eca79eba43b5c9175984c071f30b873fdce0a000">ripple::ValStatus::current</a></div><div class="ttdeci">@ current</div><div class="ttdoc">This was a new validation and was added.</div></div>
<div class="ttc" id="anamespaceripple_html_a722d3adbf2dfcfa53329113ed9d5467e"><div class="ttname"><a href="namespaceripple.html#a722d3adbf2dfcfa53329113ed9d5467e">ripple::AUCTION_SLOT_MIN_FEE_FRACTION</a></div><div class="ttdeci">std::uint32_t constexpr AUCTION_SLOT_MIN_FEE_FRACTION</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00039">AMMCore.h:39</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7894756905fee556c1541cd1de1f697a"><div class="ttname"><a href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">ripple::feeMult</a></div><div class="ttdeci">Number feeMult(std::uint16_t tfee)</div><div class="ttdoc">Get fee multiplier (1 - tfee) @tfee trading fee in basis points.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00110">AMMCore.h:110</a></div></div>
<div class="ttc" id="anamespaceripple_html_a94a558cd104922c7b67cc0af9fee630b"><div class="ttname"><a href="namespaceripple.html#a94a558cd104922c7b67cc0af9fee630b">ripple::AUCTION_SLOT_FEE_SCALE_FACTOR</a></div><div class="ttdeci">std::uint32_t constexpr AUCTION_SLOT_FEE_SCALE_FACTOR</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00037">AMMCore.h:37</a></div></div>
<div class="ttc" id="anamespaceripple_html_aa8871e2f35cee24497183274c0bab5fd"><div class="ttname"><a href="namespaceripple.html#aa8871e2f35cee24497183274c0bab5fd">ripple::getFee</a></div><div class="ttdeci">Number getFee(std::uint16_t tfee)</div><div class="ttdoc">Convert to the fee from the basis points.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00101">AMMCore.h:101</a></div></div>
<div class="ttc" id="anamespaceripple_html_aaa934f7a06a533f8eae7acf597b2161d"><div class="ttname"><a href="namespaceripple.html#aaa934f7a06a533f8eae7acf597b2161d">ripple::VOTE_WEIGHT_SCALE_FACTOR</a></div><div class="ttdeci">std::uint32_t constexpr VOTE_WEIGHT_SCALE_FACTOR</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00045">AMMCore.h:45</a></div></div>
<div class="ttc" id="anamespaceripple_html_aac3db9cd7b81ce8bd1ebf45435f0909b"><div class="ttname"><a href="namespaceripple.html#aac3db9cd7b81ce8bd1ebf45435f0909b">ripple::invalidAMMAssetPair</a></div><div class="ttdeci">NotTEC invalidAMMAssetPair(Issue const &amp;issue1, Issue const &amp;issue2, std::optional&lt; std::pair&lt; Issue, Issue &gt; &gt; const &amp;pair=std::nullopt)</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8cpp_source.html#l00080">AMMCore.cpp:80</a></div></div>
<div class="ttc" id="anamespaceripple_html_ab3ff1082024f45e95dc0352753fd0a50"><div class="ttname"><a href="namespaceripple.html#ab3ff1082024f45e95dc0352753fd0a50">ripple::AUCTION_SLOT_INTERVAL_DURATION</a></div><div class="ttdeci">std::uint32_t constexpr AUCTION_SLOT_INTERVAL_DURATION</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00040">AMMCore.h:40</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac78c8c0642bbbe33db633286fa147381"><div class="ttname"><a href="namespaceripple.html#ac78c8c0642bbbe33db633286fa147381">ripple::feeMultHalf</a></div><div class="ttdeci">Number feeMultHalf(std::uint16_t tfee)</div><div class="ttdoc">Get fee multiplier (1 - tfee / 2) @tfee trading fee in basis points.</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00119">AMMCore.h:119</a></div></div>
<div class="ttc" id="anamespaceripple_html_add680fb7e654697df4e36789f91b31cb"><div class="ttname"><a href="namespaceripple.html#add680fb7e654697df4e36789f91b31cb">ripple::VOTE_MAX_SLOTS</a></div><div class="ttdeci">std::uint16_t constexpr VOTE_MAX_SLOTS</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00044">AMMCore.h:44</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae0ae9ebb091dfd0a1578b5c791fbe5da"><div class="ttname"><a href="namespaceripple.html#ae0ae9ebb091dfd0a1578b5c791fbe5da">ripple::TRADING_FEE_THRESHOLD</a></div><div class="ttdeci">std::uint16_t constexpr TRADING_FEE_THRESHOLD</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00031">AMMCore.h:31</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae4b23ad04ab6a4fa07b0644753414844"><div class="ttname"><a href="namespaceripple.html#ae4b23ad04ab6a4fa07b0644753414844">ripple::AUCTION_SLOT_MAX_AUTH_ACCOUNTS</a></div><div class="ttdeci">std::uint16_t constexpr AUCTION_SLOT_MAX_AUTH_ACCOUNTS</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00036">AMMCore.h:36</a></div></div>
<div class="ttc" id="anamespaceripple_html_afc5d8c9c40be21c625aa413b915eb02f"><div class="ttname"><a href="namespaceripple.html#afc5d8c9c40be21c625aa413b915eb02f">ripple::AUCTION_SLOT_DISCOUNTED_FEE_FRACTION</a></div><div class="ttdeci">std::uint32_t constexpr AUCTION_SLOT_DISCOUNTED_FEE_FRACTION</div><div class="ttdef"><b>Definition</b> <a href="AMMCore_8h_source.html#l00038">AMMCore.h:38</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="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