dash-docs/en/doxygen/html/amount_8h.html

291 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: src/amount.h File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('amount_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">amount.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="serialize_8h_source.html">serialize.h</a>&quot;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="amount_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFeeRate.html">CFeeRate</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4eaf3a5239714d8c45b851527f7cb564"><td class="memItemLeft" align="right" valign="top">typedef int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a></td></tr>
<tr class="separator:a4eaf3a5239714d8c45b851527f7cb564"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a12db56a9a1c931941f0943ecbb278aae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amount_8h.html#a12db56a9a1c931941f0943ecbb278aae">MoneyRange</a> (const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a> &amp;nValue)</td></tr>
<tr class="separator:a12db56a9a1c931941f0943ecbb278aae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aed6bcb17bc73a5dcf33250e9c2c023cc"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amount_8h.html#aed6bcb17bc73a5dcf33250e9c2c023cc">COIN</a> = 100000000</td></tr>
<tr class="separator:aed6bcb17bc73a5dcf33250e9c2c023cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ea4ced67e8cf4c0738078aa44a93bd2"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amount_8h.html#a4ea4ced67e8cf4c0738078aa44a93bd2">CENT</a> = 1000000</td></tr>
<tr class="separator:a4ea4ced67e8cf4c0738078aa44a93bd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea7f12c6759c81efa2b9c7154708a4ca"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amount_8h.html#aea7f12c6759c81efa2b9c7154708a4ca">CURRENCY_UNIT</a></td></tr>
<tr class="separator:aea7f12c6759c81efa2b9c7154708a4ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7af1fa1cd5a4e2c29be8ebefe37743d7"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="amount_8h.html#a7af1fa1cd5a4e2c29be8ebefe37743d7">MAX_MONEY</a> = 21000000 * <a class="el" href="amount_8h.html#aed6bcb17bc73a5dcf33250e9c2c023cc">COIN</a></td></tr>
<tr class="separator:a7af1fa1cd5a4e2c29be8ebefe37743d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a4eaf3a5239714d8c45b851527f7cb564"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eaf3a5239714d8c45b851527f7cb564">&#9670;&nbsp;</a></span>CAmount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int64_t <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="amount_8h_source.html#l00014">14</a> of file <a class="el" href="amount_8h_source.html">amount.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a12db56a9a1c931941f0943ecbb278aae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12db56a9a1c931941f0943ecbb278aae">&#9670;&nbsp;</a></span>MoneyRange()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MoneyRange </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a> &amp;&#160;</td>
<td class="paramname"><em>nValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="amount_8h_source.html#l00031">31</a> of file <a class="el" href="amount_8h_source.html">amount.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="server_8cpp_source.html#l00110">AmountFromValue()</a>, <a class="el" href="validation_8cpp_source.html#l00470">CheckTransaction()</a>, <a class="el" href="validation_8cpp_source.html#l01483">Consensus::CheckTxInputs()</a>, <a class="el" href="wallet_8cpp_source.html#l01944">CWalletTx::GetAnonymizedCredit()</a>, <a class="el" href="wallet_8cpp_source.html#l01871">CWalletTx::GetAvailableCredit()</a>, <a class="el" href="wallet_8cpp_source.html#l01915">CWalletTx::GetAvailableWatchOnlyCredit()</a>, <a class="el" href="wallet_8cpp_source.html#l01385">CWallet::GetChange()</a>, <a class="el" href="wallet_8cpp_source.html#l01356">CWallet::GetCredit()</a>, <a class="el" href="wallet_8cpp_source.html#l01504">CWallet::GetDebit()</a>, <a class="el" href="wallet_8cpp_source.html#l01978">CWalletTx::GetDenominatedCredit()</a>, <a class="el" href="transaction_8cpp_source.html#l00112">CTransaction::GetValueOut()</a>, <a class="el" href="governance-classes_8cpp_source.html#l00038">ParsePaymentAmount()</a>, and <a class="el" href="paymentserver_8cpp_source.html#l00800">PaymentServer::verifyAmount()</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a4ea4ced67e8cf4c0738078aa44a93bd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ea4ced67e8cf4c0738078aa44a93bd2">&#9670;&nbsp;</a></span>CENT</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a> CENT = 1000000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="amount_8h_source.html#l00017">17</a> of file <a class="el" href="amount_8h_source.html">amount.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="wallet__tests_8cpp_source.html#l00068">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="utilmoneystr_8cpp_source.html#l00041">ParseMoney()</a>.</p>
</div>
</div>
<a id="aed6bcb17bc73a5dcf33250e9c2c023cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed6bcb17bc73a5dcf33250e9c2c023cc">&#9670;&nbsp;</a></span>COIN</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a> COIN = 100000000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="amount_8h_source.html#l00016">16</a> of file <a class="el" href="amount_8h_source.html">amount.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="txmempool_8h_source.html#l00026">AllowFreeThreshold()</a>, <a class="el" href="wallet_8cpp_source.html#l02423">ApproximateBestSubset()</a>, <a class="el" href="wallet_8cpp_source.html#l02360">CWallet::AvailableCoins()</a>, <a class="el" href="wallet__tests_8cpp_source.html#l00068">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="masternode_8cpp_source.html#l00122">CMasternode::CheckCollateral()</a>, <a class="el" href="darksendconfig_8cpp_source.html#l00037">DarksendConfig::clickBasic()</a>, <a class="el" href="darksendconfig_8cpp_source.html#l00052">DarksendConfig::clickHigh()</a>, <a class="el" href="darksendconfig_8cpp_source.html#l00067">DarksendConfig::clickMax()</a>, <a class="el" href="chainparams_8cpp_source.html#l00073">CMainParams::CMainParams()</a>, <a class="el" href="privatesend-server_8cpp_source.html#l00331">CPrivateSendServer::CommitFinalTransaction()</a>, <a class="el" href="privatesend-client_8cpp_source.html#l01280">CPrivateSendClient::CreateDenominated()</a>, <a class="el" href="wallet_8cpp_source.html#l03173">CWallet::CreateTransaction()</a>, <a class="el" href="chainparams_8cpp_source.html#l00329">CRegTestParams::CRegTestParams()</a>, <a class="el" href="chainparams_8cpp_source.html#l00212">CTestNetParams::CTestNetParams()</a>, <a class="el" href="privatesend-client_8cpp_source.html#l00695">CPrivateSendClient::DoAutomaticDenominating()</a>, <a class="el" href="utilmoneystr_8cpp_source.html#l00014">FormatMoney()</a>, <a class="el" href="validation_8cpp_source.html#l01230">GetBlockSubsidy()</a>, <a class="el" href="wallet_8cpp_source.html#l02244">CWallet::GetNeedsToBeAnonymizedBalance()</a>, <a class="el" href="privatesend_8cpp_source.html#l00149">CPrivateSend::InitStandardDenominations()</a>, <a class="el" href="masternode_8cpp_source.html#l00258">CMasternode::IsInputAssociatedWithPubkey()</a>, <a class="el" href="masternode-payments_8cpp_source.html#l00543">CMasternodeBlockPayees::IsTransactionValid()</a>, <a class="el" href="instantx_8cpp_source.html#l00922">CTxLockRequest::IsValid()</a>, <a class="el" href="activemasternode_8cpp_source.html#l00141">CActiveMasternode::ManageStateInitial()</a>, <a class="el" href="utilmoneystr_8cpp_source.html#l00041">ParseMoney()</a>, <a class="el" href="privatesend-client_8cpp_source.html#l01039">CPrivateSendClient::PrepareDenominate()</a>, <a class="el" href="walletmodel_8cpp_source.html#l00218">WalletModel::prepareTransaction()</a>, <a class="el" href="wallet_8cpp_source.html#l00084">COutput::Priority()</a>, <a class="el" href="privatesend-server_8cpp_source.html#l00018">CPrivateSendServer::ProcessMessage()</a>, <a class="el" href="net__processing_8cpp_source.html#l01074">ProcessMessage()</a>, <a class="el" href="wallet_8cpp_source.html#l02930">CWallet::SelectCoinsDark()</a>, <a class="el" href="wallet_8cpp_source.html#l02831">CWallet::SelectCoinsGrouppedByAddresses()</a>, <a class="el" href="wallet_8cpp_source.html#l02498">CWallet::SelectCoinsMinConf()</a>, <a class="el" href="privatesend-client_8cpp_source.html#l00362">CPrivateSendClient::SendDenominate()</a>, <a class="el" href="amount_8cpp_source.html#l00030">CFeeRate::ToString()</a>, <a class="el" href="transaction_8cpp_source.html#l00063">CTxOut::ToString()</a>, <a class="el" href="overviewpage_8cpp_source.html#l00330">OverviewPage::updatePrivateSendProgress()</a>, and <a class="el" href="server_8cpp_source.html#l00122">ValueFromAmount()</a>.</p>
</div>
</div>
<a id="aea7f12c6759c81efa2b9c7154708a4ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7f12c6759c81efa2b9c7154708a4ca">&#9670;&nbsp;</a></span>CURRENCY_UNIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string CURRENCY_UNIT</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="amount_8cpp_source.html#l00010">10</a> of file <a class="el" href="amount_8cpp_source.html">amount.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="rawtransaction_8cpp_source.html#l00358">createrawtransaction()</a>, <a class="el" href="rawtransaction_8cpp_source.html#l00460">decoderawtransaction()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00792">getbalance()</a>, <a class="el" href="rpc_2governance_8cpp_source.html#l00897">getgovernanceinfo()</a>, <a class="el" href="misc_8cpp_source.html#l00047">getinfo()</a>, <a class="el" href="rpc_2net_8cpp_source.html#l00392">getnetworkinfo()</a>, <a class="el" href="blockchain_8cpp_source.html#l00234">getrawmempool()</a>, <a class="el" href="rawtransaction_8cpp_source.html#l00144">getrawtransaction()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00701">getreceivedbyaccount()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00641">getreceivedbyaddress()</a>, <a class="el" href="rpc_2governance_8cpp_source.html#l00955">getsuperblockbudget()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l01821">gettransaction()</a>, <a class="el" href="blockchain_8cpp_source.html#l00591">gettxout()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l02376">getwalletinfo()</a>, <a class="el" href="init_8cpp_source.html#l00384">HelpMessage()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00534">listaddressgroupings()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l01339">listreceivedbyaddress()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l01726">listsinceblock()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l01518">listtransactions()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l02533">listunspent()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00885">movecmd()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00958">sendfrom()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l01024">sendmany()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l00409">sendtoaddress()</a>, <a class="el" href="rpcwallet_8cpp_source.html#l02349">settxfee()</a>, and <a class="el" href="amount_8cpp_source.html#l00030">CFeeRate::ToString()</a>.</p>
</div>
</div>
<a id="a7af1fa1cd5a4e2c29be8ebefe37743d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7af1fa1cd5a4e2c29be8ebefe37743d7">&#9670;&nbsp;</a></span>MAX_MONEY</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="amount_8h.html#a4eaf3a5239714d8c45b851527f7cb564">CAmount</a> MAX_MONEY = 21000000 * <a class="el" href="amount_8h.html#aed6bcb17bc73a5dcf33250e9c2c023cc">COIN</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>No amount larger than this (in satoshi) is valid.</p>
<p>Note that this constant is <em>not</em> the total money supply, which in Bitcoin currently happens to be less than 21,000,000 BTC for various reasons, but rather a sanity check. As this sanity check is used by consensus-critical validation code, the exact value of the MAX_MONEY constant is consensus critical; in unusual circumstances like a(nother) overflow bug that allowed for the creation of coins out of thin air modification could lead to a fork. </p>
<p class="definition">Definition at line <a class="el" href="amount_8h_source.html#l00030">30</a> of file <a class="el" href="amount_8h_source.html">amount.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="validation_8cpp_source.html#l00470">CheckTransaction()</a>, <a class="el" href="governance-object_8cpp_source.html#l00491">CGovernanceObject::GetMinCollateralFee()</a>, <a class="el" href="bitcoinunits_8cpp_source.html#l00267">BitcoinUnits::maxMoney()</a>, <a class="el" href="amount_8h_source.html#l00031">MoneyRange()</a>, and <a class="el" href="paymentserver_8cpp_source.html#l00800">PaymentServer::verifyAmount()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="amount_8h.html">amount.h</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:10 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>