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

149 lines
17 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: Fees.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_68f79f171b7159941f300783854c1b48.html">resource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">resource/Fees.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_RESOURCE_FEES_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_RESOURCE_FEES_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;xrpl/resource/Charge.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><span class="keyword">namespace </span>Resource {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// clang-format off</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a0b2a0218d1e64ae67ac02712b613a936">feeMalformedRequest</a>; <span class="comment">// A request that we can immediately</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// tell is invalid</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a79b0f414dccfcd34031b08b68b671d9e">feeRequestNoReply</a>; <span class="comment">// A request that we cannot satisfy</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a4fdcdf42278fb04a30ae886a5c134680">feeInvalidSignature</a>; <span class="comment">// An object whose signature we had</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// to check and it failed</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a41d3c2c4f11f98da55fa0ef10ffcd4e8">feeUselessData</a>; <span class="comment">// Data we have no use for</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a0de6de4b6471f86389f36c06a97c204c">feeInvalidData</a>; <span class="comment">// Data we have to verify before</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// rejecting</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// RPC loads</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#aa41c87ae8c86d79497f14d2b64fa491a">feeMalformedRPC</a>; <span class="comment">// An RPC request that we can</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// immediately tell is invalid.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a433ff63c2b87f2f6e3947dc4d3b822fa">feeReferenceRPC</a>; <span class="comment">// A default &quot;reference&quot; unspecified</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// load</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a6b65785faa4fa20847aa0d93efca9d79">feeExceptionRPC</a>; <span class="comment">// RPC load that causes an exception</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a38c76186a94f70d37812084660e723bf">feeMediumBurdenRPC</a>; <span class="comment">// A somewhat burdensome RPC load</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#ad74523edd5d732d9b4320240f4d42b2a">feeHeavyBurdenRPC</a>; <span class="comment">// A very burdensome RPC load</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// Peer loads</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a577adaba34c2b66dc6bfc468e80c0c1a">feeTrivialPeer</a>; <span class="comment">// Requires no reply</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#aa04990562f4c694a69910d2f6d2b5116">feeModerateBurdenPeer</a>; <span class="comment">// Requires some work</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#af0d1a4d281f9bc4f4501f892782958bb">feeHeavyBurdenPeer</a>; <span class="comment">// Extensive work</span></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><span class="comment">// Administrative</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a9bf0bd7a02008885350cc04739e105e3">feeWarning</a>; <span class="comment">// The cost of receiving a warning</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">extern</span> Charge <span class="keyword">const</span> <a class="code hl_variable" href="namespaceripple_1_1Resource.html#a6eae862122137342f77101165fff66da">feeDrop</a>; <span class="comment">// The cost of being dropped for</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// excess load</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// clang-format on</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>} <span class="comment">// namespace Resource</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a0b2a0218d1e64ae67ac02712b613a936"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a0b2a0218d1e64ae67ac02712b613a936">ripple::Resource::feeMalformedRequest</a></div><div class="ttdeci">Charge const feeMalformedRequest</div><div class="ttdoc">Schedule of fees charged for imposing load on the server.</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a0de6de4b6471f86389f36c06a97c204c"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a0de6de4b6471f86389f36c06a97c204c">ripple::Resource::feeInvalidData</a></div><div class="ttdeci">Charge const feeInvalidData</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a38c76186a94f70d37812084660e723bf"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a38c76186a94f70d37812084660e723bf">ripple::Resource::feeMediumBurdenRPC</a></div><div class="ttdeci">Charge const feeMediumBurdenRPC</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a41d3c2c4f11f98da55fa0ef10ffcd4e8"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a41d3c2c4f11f98da55fa0ef10ffcd4e8">ripple::Resource::feeUselessData</a></div><div class="ttdeci">Charge const feeUselessData</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a433ff63c2b87f2f6e3947dc4d3b822fa"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a433ff63c2b87f2f6e3947dc4d3b822fa">ripple::Resource::feeReferenceRPC</a></div><div class="ttdeci">Charge const feeReferenceRPC</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a4fdcdf42278fb04a30ae886a5c134680"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a4fdcdf42278fb04a30ae886a5c134680">ripple::Resource::feeInvalidSignature</a></div><div class="ttdeci">Charge const feeInvalidSignature</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a577adaba34c2b66dc6bfc468e80c0c1a"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a577adaba34c2b66dc6bfc468e80c0c1a">ripple::Resource::feeTrivialPeer</a></div><div class="ttdeci">Charge const feeTrivialPeer</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a6b65785faa4fa20847aa0d93efca9d79"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a6b65785faa4fa20847aa0d93efca9d79">ripple::Resource::feeExceptionRPC</a></div><div class="ttdeci">Charge const feeExceptionRPC</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a6eae862122137342f77101165fff66da"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a6eae862122137342f77101165fff66da">ripple::Resource::feeDrop</a></div><div class="ttdeci">Charge const feeDrop</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a79b0f414dccfcd34031b08b68b671d9e"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a79b0f414dccfcd34031b08b68b671d9e">ripple::Resource::feeRequestNoReply</a></div><div class="ttdeci">Charge const feeRequestNoReply</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_a9bf0bd7a02008885350cc04739e105e3"><div class="ttname"><a href="namespaceripple_1_1Resource.html#a9bf0bd7a02008885350cc04739e105e3">ripple::Resource::feeWarning</a></div><div class="ttdeci">Charge const feeWarning</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_aa04990562f4c694a69910d2f6d2b5116"><div class="ttname"><a href="namespaceripple_1_1Resource.html#aa04990562f4c694a69910d2f6d2b5116">ripple::Resource::feeModerateBurdenPeer</a></div><div class="ttdeci">Charge const feeModerateBurdenPeer</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_aa41c87ae8c86d79497f14d2b64fa491a"><div class="ttname"><a href="namespaceripple_1_1Resource.html#aa41c87ae8c86d79497f14d2b64fa491a">ripple::Resource::feeMalformedRPC</a></div><div class="ttdeci">Charge const feeMalformedRPC</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_ad74523edd5d732d9b4320240f4d42b2a"><div class="ttname"><a href="namespaceripple_1_1Resource.html#ad74523edd5d732d9b4320240f4d42b2a">ripple::Resource::feeHeavyBurdenRPC</a></div><div class="ttdeci">Charge const feeHeavyBurdenRPC</div></div>
<div class="ttc" id="anamespaceripple_1_1Resource_html_af0d1a4d281f9bc4f4501f892782958bb"><div class="ttname"><a href="namespaceripple_1_1Resource.html#af0d1a4d281f9bc4f4501f892782958bb">ripple::Resource::feeHeavyBurdenPeer</a></div><div class="ttdeci">Charge const feeHeavyBurdenPeer</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><!-- 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>