mirror of
https://github.com/XRPLF/rippled.git
synced 2026-02-01 04:25:30 +00:00
160 lines
17 KiB
HTML
160 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: Credit.cpp 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&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&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&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_90ffdbabf412cfdffe6b2193e0ce938a.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_206ae571f9a7f3abb34f1a779b56a18b.html">ledger</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Credit.cpp</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">#include <xrpl/ledger/ReadView.h></span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include <xrpl/protocol/AmountConversions.h></span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <xrpl/protocol/Indexes.h></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <xrpl/protocol/STAmount.h></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="namespacexrpl.html">xrpl</a> {</div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>STAmount</div>
|
|
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a6827ba10f9a74582eb39009494f651a7"> 9</a></span><a class="code hl_function" href="namespacexrpl.html#a6827ba10f9a74582eb39009494f651a7">creditLimit</a>(<a class="code hl_class" href="classxrpl_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>& view, <a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& account, <a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& issuer, <a class="code hl_class" href="classxrpl_1_1base__uint.html">Currency</a> <span class="keyword">const</span>& currency)</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>{</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <a class="code hl_class" href="classxrpl_1_1STAmount.html">STAmount</a> result(<a class="code hl_class" href="classxrpl_1_1Issue.html">Issue</a>{currency, account});</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">auto</span> sleRippleState = view.<a class="code hl_function" href="classxrpl_1_1ReadView.html#ae7286da5df8ee36f950cc43fd3a46806">read</a>(<a class="code hl_function" href="namespacexrpl_1_1keylet.html#aa21a42ef67381b26994fa7a9960b1306">keylet::line</a>(account, issuer, currency));</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">if</span> (sleRippleState)</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> result = sleRippleState->getFieldAmount(account < issuer ? sfLowLimit : sfHighLimit);</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> result.setIssuer(account);</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</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> XRPL_ASSERT(result.getIssuer() == account, <span class="stringliteral">"xrpl::creditLimit : result issuer match"</span>);</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> XRPL_ASSERT(result.getCurrency() == currency, <span class="stringliteral">"xrpl::creditLimit : result currency match"</span>);</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">return</span> result;</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>IOUAmount</div>
|
|
<div class="foldopen" id="foldopen00027" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a7d80263dd562d13fe89a37179552979b"> 27</a></span><a class="code hl_function" href="namespacexrpl.html#a7d80263dd562d13fe89a37179552979b">creditLimit2</a>(<a class="code hl_class" href="classxrpl_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>& v, <a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& acc, <a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& iss, <a class="code hl_class" href="classxrpl_1_1base__uint.html">Currency</a> <span class="keyword">const</span>& cur)</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>{</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacexrpl.html#aca16307bc2bd096a064cbce3af895ac9">toAmount<IOUAmount></a>(<a class="code hl_function" href="namespacexrpl.html#a6827ba10f9a74582eb39009494f651a7">creditLimit</a>(v, acc, iss, cur));</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>STAmount</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="namespacexrpl.html#aa02ddd7fd103324c4ac6c80efc16f1bd"> 33</a></span><a class="code hl_function" href="namespacexrpl.html#aa02ddd7fd103324c4ac6c80efc16f1bd">creditBalance</a>(<a class="code hl_class" href="classxrpl_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>& view, <a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& account, <a class="code hl_class" href="classxrpl_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>& issuer, <a class="code hl_class" href="classxrpl_1_1base__uint.html">Currency</a> <span class="keyword">const</span>& currency)</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> <a class="code hl_class" href="classxrpl_1_1STAmount.html">STAmount</a> result(<a class="code hl_class" href="classxrpl_1_1Issue.html">Issue</a>{currency, account});</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">auto</span> sleRippleState = view.<a class="code hl_function" href="classxrpl_1_1ReadView.html#ae7286da5df8ee36f950cc43fd3a46806">read</a>(<a class="code hl_function" href="namespacexrpl_1_1keylet.html#aa21a42ef67381b26994fa7a9960b1306">keylet::line</a>(account, issuer, currency));</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> (sleRippleState)</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> {</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> result = sleRippleState->getFieldAmount(sfBalance);</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">if</span> (account < issuer)</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> result.negate();</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> result.setIssuer(account);</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 class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> XRPL_ASSERT(result.getIssuer() == account, <span class="stringliteral">"xrpl::creditBalance : result issuer match"</span>);</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> XRPL_ASSERT(result.getCurrency() == currency, <span class="stringliteral">"xrpl::creditBalance : result currency match"</span>);</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> result;</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 xrpl</span></div>
|
|
<div class="ttc" id="aclassxrpl_1_1Issue_html"><div class="ttname"><a href="classxrpl_1_1Issue.html">xrpl::Issue</a></div><div class="ttdoc">A currency issued by an account.</div><div class="ttdef"><b>Definition</b> <a href="Issue_8h_source.html#l00013">Issue.h:14</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1ReadView_html"><div class="ttname"><a href="classxrpl_1_1ReadView.html">xrpl::ReadView</a></div><div class="ttdoc">A view into a ledger.</div><div class="ttdef"><b>Definition</b> <a href="ReadView_8h_source.html#l00031">ReadView.h:32</a></div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1ReadView_html_ae7286da5df8ee36f950cc43fd3a46806"><div class="ttname"><a href="classxrpl_1_1ReadView.html#ae7286da5df8ee36f950cc43fd3a46806">xrpl::ReadView::read</a></div><div class="ttdeci">virtual std::shared_ptr< SLE const > read(Keylet const &k) const =0</div><div class="ttdoc">Return the state item associated with a key.</div></div>
|
|
<div class="ttc" id="aclassxrpl_1_1STAmount_html"><div class="ttname"><a href="classxrpl_1_1STAmount.html">xrpl::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="aclassxrpl_1_1base__uint_html"><div class="ttname"><a href="classxrpl_1_1base__uint.html">xrpl::base_uint< 160, detail::AccountIDTag ></a></div></div>
|
|
<div class="ttc" id="anamespacexrpl_1_1keylet_html_aa21a42ef67381b26994fa7a9960b1306"><div class="ttname"><a href="namespacexrpl_1_1keylet.html#aa21a42ef67381b26994fa7a9960b1306">xrpl::keylet::line</a></div><div class="ttdeci">Keylet line(AccountID const &id0, AccountID const &id1, Currency const &currency) noexcept</div><div class="ttdoc">The index of a trust line for a given currency.</div><div class="ttdef"><b>Definition</b> <a href="Indexes_8cpp_source.html#l00214">Indexes.cpp:214</a></div></div>
|
|
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="anamespacexrpl_html_a6827ba10f9a74582eb39009494f651a7"><div class="ttname"><a href="namespacexrpl.html#a6827ba10f9a74582eb39009494f651a7">xrpl::creditLimit</a></div><div class="ttdeci">STAmount creditLimit(ReadView const &view, AccountID const &account, AccountID const &issuer, Currency const &currency)</div><div class="ttdoc">Calculate the maximum amount of IOUs that an account can hold.</div><div class="ttdef"><b>Definition</b> <a href="Credit_8cpp_source.html#l00009">Credit.cpp:9</a></div></div>
|
|
<div class="ttc" id="anamespacexrpl_html_a7d80263dd562d13fe89a37179552979b"><div class="ttname"><a href="namespacexrpl.html#a7d80263dd562d13fe89a37179552979b">xrpl::creditLimit2</a></div><div class="ttdeci">IOUAmount creditLimit2(ReadView const &v, AccountID const &acc, AccountID const &iss, Currency const &cur)</div><div class="ttdef"><b>Definition</b> <a href="Credit_8cpp_source.html#l00027">Credit.cpp:27</a></div></div>
|
|
<div class="ttc" id="anamespacexrpl_html_aa02ddd7fd103324c4ac6c80efc16f1bd"><div class="ttname"><a href="namespacexrpl.html#aa02ddd7fd103324c4ac6c80efc16f1bd">xrpl::creditBalance</a></div><div class="ttdeci">STAmount creditBalance(ReadView const &view, AccountID const &account, AccountID const &issuer, Currency const &currency)</div><div class="ttdoc">Returns the amount of IOUs issued by issuer that are held by an account.</div><div class="ttdef"><b>Definition</b> <a href="Credit_8cpp_source.html#l00033">Credit.cpp:33</a></div></div>
|
|
<div class="ttc" id="anamespacexrpl_html_aca16307bc2bd096a064cbce3af895ac9"><div class="ttname"><a href="namespacexrpl.html#aca16307bc2bd096a064cbce3af895ac9">xrpl::toAmount< IOUAmount ></a></div><div class="ttdeci">IOUAmount toAmount< IOUAmount >(STAmount const &amt)</div><div class="ttdef"><b>Definition</b> <a href="AmountConversions_8h_source.html#l00053">AmountConversions.h:54</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|