ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 20:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2082d336dc30640f4a0a73bb4e8839151b917340
rippled/protocol_2Fees_8h_source.html
intelliot 2082d336dc deploy: 3574956e5e
2023-08-21 23:24:10 +00:00

138 lines
14 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">protocol/Fees.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_PROTOCOL_FEES_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_PROTOCOL_FEES_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/basics/XRPAmount.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structripple_1_1Fees.html"> 32</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structripple_1_1Fees.html">Fees</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structripple_1_1Fees.html#a64c9587f977c872e926a58401d7d8224"> 34</a></span>&#160; <a class="code" href="classripple_1_1XRPAmount.html">XRPAmount</a> <a class="code" href="structripple_1_1Fees.html#a64c9587f977c872e926a58401d7d8224">base</a>{0}; <span class="comment">// Reference tx cost (drops)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structripple_1_1Fees.html#a75648591a2d5bc9e670f1f4081bfdfe0"> 35</a></span>&#160; <a class="code" href="classripple_1_1XRPAmount.html">XRPAmount</a> <a class="code" href="structripple_1_1Fees.html#a75648591a2d5bc9e670f1f4081bfdfe0">reserve</a>{0}; <span class="comment">// Reserve base (drops)</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structripple_1_1Fees.html#a6d48ec23cfbe4eacac46fbfaa8ce67f9"> 36</a></span>&#160; <a class="code" href="classripple_1_1XRPAmount.html">XRPAmount</a> <a class="code" href="structripple_1_1Fees.html#a6d48ec23cfbe4eacac46fbfaa8ce67f9">increment</a>{0}; <span class="comment">// Reserve increment (drops)</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">explicit</span> <a class="code" href="structripple_1_1Fees.html#ab08271e72339f96f52b80be7a3511e43">Fees</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structripple_1_1Fees.html#ab08271e72339f96f52b80be7a3511e43">Fees</a>(<a class="code" href="structripple_1_1Fees.html">Fees</a> <span class="keyword">const</span>&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="structripple_1_1Fees.html">Fees</a>&amp;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="structripple_1_1Fees.html#a6e07a9079a3e3eb564d197fb4f53ddc5">operator=</a>(<a class="code" href="structripple_1_1Fees.html">Fees</a> <span class="keyword">const</span>&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="classripple_1_1XRPAmount.html">XRPAmount</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structripple_1_1Fees.html#acb07843d0d0e3ccacd7cf51d5296fe40"> 49</a></span>&#160; <a class="code" href="structripple_1_1Fees.html#acb07843d0d0e3ccacd7cf51d5296fe40">accountReserve</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ownerCount)<span class="keyword"> const</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structripple_1_1Fees.html#a75648591a2d5bc9e670f1f4081bfdfe0">reserve</a> + ownerCount * <a class="code" href="structripple_1_1Fees.html#a6d48ec23cfbe4eacac46fbfaa8ce67f9">increment</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;};</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructripple_1_1Fees_html_a75648591a2d5bc9e670f1f4081bfdfe0"><div class="ttname"><a href="structripple_1_1Fees.html#a75648591a2d5bc9e670f1f4081bfdfe0">ripple::Fees::reserve</a></div><div class="ttdeci">XRPAmount reserve</div><div class="ttdef"><b>Definition:</b> <a href="protocol_2Fees_8h_source.html#l00035">protocol/Fees.h:35</a></div></div>
<div class="ttc" id="astructripple_1_1Fees_html_ab08271e72339f96f52b80be7a3511e43"><div class="ttname"><a href="structripple_1_1Fees.html#ab08271e72339f96f52b80be7a3511e43">ripple::Fees::Fees</a></div><div class="ttdeci">Fees()=default</div></div>
<div class="ttc" id="astructripple_1_1Fees_html_a6d48ec23cfbe4eacac46fbfaa8ce67f9"><div class="ttname"><a href="structripple_1_1Fees.html#a6d48ec23cfbe4eacac46fbfaa8ce67f9">ripple::Fees::increment</a></div><div class="ttdeci">XRPAmount increment</div><div class="ttdef"><b>Definition:</b> <a href="protocol_2Fees_8h_source.html#l00036">protocol/Fees.h:36</a></div></div>
<div class="ttc" id="astructripple_1_1Fees_html"><div class="ttname"><a href="structripple_1_1Fees.html">ripple::Fees</a></div><div class="ttdoc">Reflects the fee settings for a particular ledger.</div><div class="ttdef"><b>Definition:</b> <a href="protocol_2Fees_8h_source.html#l00032">protocol/Fees.h:32</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="astructripple_1_1Fees_html_acb07843d0d0e3ccacd7cf51d5296fe40"><div class="ttname"><a href="structripple_1_1Fees.html#acb07843d0d0e3ccacd7cf51d5296fe40">ripple::Fees::accountReserve</a></div><div class="ttdeci">XRPAmount accountReserve(std::size_t ownerCount) const</div><div class="ttdoc">Returns the account reserve given the owner count, in drops.</div><div class="ttdef"><b>Definition:</b> <a href="protocol_2Fees_8h_source.html#l00049">protocol/Fees.h:49</a></div></div>
<div class="ttc" id="astructripple_1_1Fees_html_a6e07a9079a3e3eb564d197fb4f53ddc5"><div class="ttname"><a href="structripple_1_1Fees.html#a6e07a9079a3e3eb564d197fb4f53ddc5">ripple::Fees::operator=</a></div><div class="ttdeci">Fees &amp; operator=(Fees const &amp;)=default</div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="astructripple_1_1Fees_html_a64c9587f977c872e926a58401d7d8224"><div class="ttname"><a href="structripple_1_1Fees.html#a64c9587f977c872e926a58401d7d8224">ripple::Fees::base</a></div><div class="ttdeci">XRPAmount base</div><div class="ttdef"><b>Definition:</b> <a href="protocol_2Fees_8h_source.html#l00034">protocol/Fees.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1XRPAmount_html"><div class="ttname"><a href="classripple_1_1XRPAmount.html">ripple::XRPAmount</a></div><div class="ttdef"><b>Definition:</b> <a href="XRPAmount_8h_source.html#l00046">XRPAmount.h:46</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink