Files
rippled/AMMVote_8h_source.html
2025-11-04 00:36:48 -08:00

142 lines
15 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" 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: AMMVote.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_4b2d6f306dc33741b6f38a59a670a446.html">tx</a></li><li class="navelem"><a class="el" href="dir_7b1ffcd2aae1e871efc2e94c72e78699.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">AMMVote.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="preprocessor">#ifndef XRPL_TX_AMMVOTE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TX_AMMVOTE_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/tx/detail/Transactor.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="foldopen" id="foldopen00031" data-start="{" data-end="};">
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classripple_1_1AMMVote.html"> 31</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1AMMVote.html">AMMVote</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1Transactor.html">Transactor</a></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="keyword">public</span>:</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1AMMVote.html#ad2a7e91544cf6b0f30c607d7c4b40fdc"> 34</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_enumeration" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> <a class="code hl_variable" href="classripple_1_1AMMVote.html#ad2a7e91544cf6b0f30c607d7c4b40fdc">ConsequencesFactory</a>{<a class="code hl_enumvalue" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>};</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="foldopen" id="foldopen00036" data-start="{" data-end="}">
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classripple_1_1AMMVote.html#a94f008b8168df1c05e54e260f67a5b7a"> 36</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1AMMVote.html#a94f008b8168df1c05e54e260f67a5b7a">AMMVote</a>(<a class="code hl_class" href="classripple_1_1ApplyContext.html">ApplyContext</a>&amp; ctx) : <a class="code hl_class" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">static</span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_function" href="classripple_1_1AMMVote.html#a935a2add398144ec44d8eeb91f0b619b">checkExtraFeatures</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</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="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_function" href="classripple_1_1AMMVote.html#a1d265e2e2da9762944e18134abfa8699">preflight</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_function" href="classripple_1_1AMMVote.html#a876a496bf06ca425b5c5d5f1fec6cfaf">preclaim</a>(<a class="code hl_struct" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_function" href="classripple_1_1AMMVote.html#a89442659a35b02fea1cad703ff21c84f">doApply</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div>
</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#endif </span><span class="comment">// XRPL_TX_AMMVOTE_H_INCLUDED</span></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html"><div class="ttname"><a href="classripple_1_1AMMVote.html">ripple::AMMVote</a></div><div class="ttdoc">AMMVote implements AMM vote Transactor.</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8h_source.html#l00031">AMMVote.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html_a1d265e2e2da9762944e18134abfa8699"><div class="ttname"><a href="classripple_1_1AMMVote.html#a1d265e2e2da9762944e18134abfa8699">ripple::AMMVote::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8cpp_source.html#l00018">AMMVote.cpp:18</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html_a876a496bf06ca425b5c5d5f1fec6cfaf"><div class="ttname"><a href="classripple_1_1AMMVote.html#a876a496bf06ca425b5c5d5f1fec6cfaf">ripple::AMMVote::preclaim</a></div><div class="ttdeci">static TER preclaim(PreclaimContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8cpp_source.html#l00037">AMMVote.cpp:37</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html_a89442659a35b02fea1cad703ff21c84f"><div class="ttname"><a href="classripple_1_1AMMVote.html#a89442659a35b02fea1cad703ff21c84f">ripple::AMMVote::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8cpp_source.html#l00214">AMMVote.cpp:214</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html_a935a2add398144ec44d8eeb91f0b619b"><div class="ttname"><a href="classripple_1_1AMMVote.html#a935a2add398144ec44d8eeb91f0b619b">ripple::AMMVote::checkExtraFeatures</a></div><div class="ttdeci">static bool checkExtraFeatures(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8cpp_source.html#l00012">AMMVote.cpp:12</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html_a94f008b8168df1c05e54e260f67a5b7a"><div class="ttname"><a href="classripple_1_1AMMVote.html#a94f008b8168df1c05e54e260f67a5b7a">ripple::AMMVote::AMMVote</a></div><div class="ttdeci">AMMVote(ApplyContext &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8h_source.html#l00036">AMMVote.h:36</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMVote_html_ad2a7e91544cf6b0f30c607d7c4b40fdc"><div class="ttname"><a href="classripple_1_1AMMVote.html#ad2a7e91544cf6b0f30c607d7c4b40fdc">ripple::AMMVote::ConsequencesFactory</a></div><div class="ttdeci">static constexpr ConsequencesFactoryType ConsequencesFactory</div><div class="ttdef"><b>Definition</b> <a href="AMMVote_8h_source.html#l00034">AMMVote.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1ApplyContext_html"><div class="ttname"><a href="classripple_1_1ApplyContext.html">ripple::ApplyContext</a></div><div class="ttdoc">State information when applying a tx.</div><div class="ttdef"><b>Definition</b> <a href="ApplyContext_8h_source.html#l00017">ApplyContext.h:18</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#l00395">TER.h:396</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html"><div class="ttname"><a href="classripple_1_1Transactor.html">ripple::Transactor</a></div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00121">Transactor.h:122</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ripple::Transactor::ConsequencesFactoryType</a></div><div class="ttdeci">ConsequencesFactoryType</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00138">Transactor.h:138</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">ripple::Transactor::Normal</a></div><div class="ttdeci">@ Normal</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00138">Transactor.h:138</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#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimContext_html"><div class="ttname"><a href="structripple_1_1PreclaimContext.html">ripple::PreclaimContext</a></div><div class="ttdoc">State information when determining if a tx is likely to claim a fee.</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00060">Transactor.h:61</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightContext_html"><div class="ttname"><a href="structripple_1_1PreflightContext.html">ripple::PreflightContext</a></div><div class="ttdoc">State information when preflighting a tx.</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00015">Transactor.h:16</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>