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

178 lines
20 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: fee.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_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">fee.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_TEST_JTX_FEE_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TEST_JTX_FEE_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;test/jtx/Env.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;test/jtx/tags.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/basics/contract.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpl/protocol/STAmount.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span>test {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>jtx {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1fee.html">fee</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#a942d31864e207cc6a2851b5a3a426ab3"> 20</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#a942d31864e207cc6a2851b5a3a426ab3">manual_</a> = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#ae8e281cb6145f2f614968239248e0faf"> 21</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#ae8e281cb6145f2f614968239248e0faf">increment_</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#a040776ad1565248c2571b3154575c5bf"> 22</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#a040776ad1565248c2571b3154575c5bf">amount_</a>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#ae9eb0262ed5a0aa4fc897cd28711267f"> 25</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1fee.html#ae9eb0262ed5a0aa4fc897cd28711267f">fee</a>(<a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1autofill__t.html">autofill_t</a>) : <a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#a942d31864e207cc6a2851b5a3a426ab3">manual_</a>(false)</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> }</div>
</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#a5f949c19b710ed8148919b166161626e"> 29</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1fee.html#a5f949c19b710ed8148919b166161626e">fee</a>(<a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1increment__t.html">increment_t</a>) : <a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#ae8e281cb6145f2f614968239248e0faf">increment_</a>(true)</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"> 31</span> }</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="}">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#a6ae062ae09ecf2b6fa1fe496e1d989c7"> 33</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1fee.html#a6ae062ae09ecf2b6fa1fe496e1d989c7">fee</a>(<a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1none__t.html">none_t</a>)</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="foldopen" id="foldopen00037" data-start="{" data-end="}">
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#adedd9b4ed283c4d7f19ff4c240a7ec93"> 37</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1fee.html#adedd9b4ed283c4d7f19ff4c240a7ec93">fee</a>(<a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount) : <a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#a040776ad1565248c2571b3154575c5bf">amount_</a>(amount)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">if</span> (!<a class="code hl_function" href="namespaceripple.html#a20d30277b9c78756b3d14493055a307c">isXRP</a>(*<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1fee.html#a040776ad1565248c2571b3154575c5bf">amount_</a>))</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;fee: not XRP&quot;</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> }</div>
</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1fee.html#a1b2c8338d963ecb711d08dc52f6f93ef"> 43</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1fee.html#a1b2c8338d963ecb711d08dc52f6f93ef">fee</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> amount, <span class="keywordtype">bool</span> negative = <span class="keyword">false</span>)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> : <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1fee.html">fee</a>{<a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a>{amount, negative}}</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> }</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1fee.html#ac04bdec3533093516a24178dc1b8c683">operator()</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&amp;, <a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1JTx.html">JTx</a>&amp; jt) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>};</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>} <span class="comment">// namespace jtx</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace test</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif</span></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#l00030">STAmount.h:31</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html">ripple::test::jtx::Env</a></div><div class="ttdoc">A transaction testing environment.</div><div class="ttdef"><b>Definition</b> <a href="Env_8h_source.html#l00101">Env.h:102</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html">ripple::test::jtx::fee</a></div><div class="ttdoc">Set the fee on a JTx.</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00017">fee.h:18</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_a040776ad1565248c2571b3154575c5bf"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#a040776ad1565248c2571b3154575c5bf">ripple::test::jtx::fee::amount_</a></div><div class="ttdeci">std::optional&lt; STAmount &gt; amount_</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00022">fee.h:22</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_a1b2c8338d963ecb711d08dc52f6f93ef"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#a1b2c8338d963ecb711d08dc52f6f93ef">ripple::test::jtx::fee::fee</a></div><div class="ttdeci">fee(std::uint64_t amount, bool negative=false)</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00043">fee.h:43</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_a5f949c19b710ed8148919b166161626e"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#a5f949c19b710ed8148919b166161626e">ripple::test::jtx::fee::fee</a></div><div class="ttdeci">fee(increment_t)</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00029">fee.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_a6ae062ae09ecf2b6fa1fe496e1d989c7"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#a6ae062ae09ecf2b6fa1fe496e1d989c7">ripple::test::jtx::fee::fee</a></div><div class="ttdeci">fee(none_t)</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00033">fee.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_a942d31864e207cc6a2851b5a3a426ab3"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#a942d31864e207cc6a2851b5a3a426ab3">ripple::test::jtx::fee::manual_</a></div><div class="ttdeci">bool manual_</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00020">fee.h:20</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_ac04bdec3533093516a24178dc1b8c683"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#ac04bdec3533093516a24178dc1b8c683">ripple::test::jtx::fee::operator()</a></div><div class="ttdeci">void operator()(Env &amp;, JTx &amp;jt) const</div><div class="ttdef"><b>Definition</b> <a href="fee_8cpp_source.html#l00010">fee.cpp:10</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_adedd9b4ed283c4d7f19ff4c240a7ec93"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#adedd9b4ed283c4d7f19ff4c240a7ec93">ripple::test::jtx::fee::fee</a></div><div class="ttdeci">fee(STAmount const &amp;amount)</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00037">fee.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_ae8e281cb6145f2f614968239248e0faf"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#ae8e281cb6145f2f614968239248e0faf">ripple::test::jtx::fee::increment_</a></div><div class="ttdeci">bool increment_</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00021">fee.h:21</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1fee_html_ae9eb0262ed5a0aa4fc897cd28711267f"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1fee.html#ae9eb0262ed5a0aa4fc897cd28711267f">ripple::test::jtx::fee::fee</a></div><div class="ttdeci">fee(autofill_t)</div><div class="ttdef"><b>Definition</b> <a href="fee_8h_source.html#l00025">fee.h:25</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_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#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a20d30277b9c78756b3d14493055a307c"><div class="ttname"><a href="namespaceripple.html#a20d30277b9c78756b3d14493055a307c">ripple::isXRP</a></div><div class="ttdeci">bool isXRP(AccountID const &amp;c)</div><div class="ttdef"><b>Definition</b> <a href="AccountID_8h_source.html#l00071">AccountID.h:71</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1JTx_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1JTx.html">ripple::test::jtx::JTx</a></div><div class="ttdoc">Execution context for applying a JSON transaction.</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00025">JTx.h:26</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1autofill__t_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1autofill__t.html">ripple::test::jtx::autofill_t</a></div><div class="ttdef"><b>Definition</b> <a href="tags_8h_source.html#l00017">tags.h:18</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1increment__t_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1increment__t.html">ripple::test::jtx::increment_t</a></div><div class="ttdoc">Used for fee() calls that use an owner reserve increment.</div><div class="ttdef"><b>Definition</b> <a href="tags_8h_source.html#l00034">tags.h:35</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1none__t_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1none__t.html">ripple::test::jtx::none_t</a></div><div class="ttdef"><b>Definition</b> <a href="tags_8h_source.html#l00009">tags.h:10</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>