ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5d00ab2bf5a6fed840f2f17ebf7ba99974fe875
rippled/classripple_1_1ValidClawback.html
ximinez c7ce48f391 deploy: 33e1c42599
2025-01-31 18:44:55 +00:00

258 lines
13 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" 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::ValidClawback Class 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="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.5 -->
<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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1ValidClawback.html">ValidClawback</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1ValidClawback-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::ValidClawback Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Invariant: Token holder's trustline balance cannot be negative after <a class="el" href="classripple_1_1Clawback.html">Clawback</a>.
<a href="classripple_1_1ValidClawback.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="InvariantCheck_8h_source.html">InvariantCheck.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::ValidClawback:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1ValidClawback__coll__graph.png" border="0" usemap="#aripple_1_1ValidClawback_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1ValidClawback_coll__map" id="aripple_1_1ValidClawback_coll__map">
<area shape="rect" title="Invariant: Token holder&#39;s trustline balance cannot be negative after Clawback." alt="" coords="5,108,168,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="35,5,138,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5e614f43f7cb0e11dfc2c4527c231be0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidClawback.html#a5e614f43f7cb0e11dfc2c4527c231be0">visitEntry</a> (bool, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const &gt; const &amp;, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const &gt; const &amp;)</td></tr>
<tr class="separator:a5e614f43f7cb0e11dfc2c4527c231be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1743d3fcddc9394c99ff23a91baa353"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidClawback.html#ae1743d3fcddc9394c99ff23a91baa353">finalize</a> (<a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;, <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> const, <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const, <a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;)</td></tr>
<tr class="separator:ae1743d3fcddc9394c99ff23a91baa353"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a7e2187c69fb0d79fdafae3f9f24baed9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidClawback.html#a7e2187c69fb0d79fdafae3f9f24baed9">trustlinesChanged</a> = 0</td></tr>
<tr class="separator:a7e2187c69fb0d79fdafae3f9f24baed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f4ae66a49513fa78d98df13aea2f9b5"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidClawback.html#a7f4ae66a49513fa78d98df13aea2f9b5">mptokensChanged</a> = 0</td></tr>
<tr class="separator:a7f4ae66a49513fa78d98df13aea2f9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Invariant: Token holder's trustline balance cannot be negative after <a class="el" href="classripple_1_1Clawback.html">Clawback</a>. </p>
<p >We iterate all the trust lines affected by this transaction and ensure that no more than one trustline is modified, and also holder's balance is non-negative. </p>
<p class="definition">Definition at line <a class="el" href="InvariantCheck_8h_source.html#l00539">539</a> of file <a class="el" href="InvariantCheck_8h_source.html">InvariantCheck.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5e614f43f7cb0e11dfc2c4527c231be0" name="a5e614f43f7cb0e11dfc2c4527c231be0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e614f43f7cb0e11dfc2c4527c231be0">&#9670;&#160;</a></span>visitEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::ValidClawback::visitEntry </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const &gt; const &amp;&#160;</td>
<td class="paramname"><em>before</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const &gt; const &amp;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InvariantCheck_8cpp_source.html#l01204">1204</a> of file <a class="el" href="InvariantCheck_8cpp_source.html">InvariantCheck.cpp</a>.</p>
</div>
</div>
<a id="ae1743d3fcddc9394c99ff23a91baa353" name="ae1743d3fcddc9394c99ff23a91baa353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1743d3fcddc9394c99ff23a91baa353">&#9670;&#160;</a></span>finalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::ValidClawback::finalize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td>
<td class="paramname"><em>tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> const&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InvariantCheck_8cpp_source.html#l01217">1217</a> of file <a class="el" href="InvariantCheck_8cpp_source.html">InvariantCheck.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7e2187c69fb0d79fdafae3f9f24baed9" name="a7e2187c69fb0d79fdafae3f9f24baed9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e2187c69fb0d79fdafae3f9f24baed9">&#9670;&#160;</a></span>trustlinesChanged</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::ValidClawback::trustlinesChanged = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InvariantCheck_8h_source.html#l00541">541</a> of file <a class="el" href="InvariantCheck_8h_source.html">InvariantCheck.h</a>.</p>
</div>
</div>
<a id="a7f4ae66a49513fa78d98df13aea2f9b5" name="a7f4ae66a49513fa78d98df13aea2f9b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f4ae66a49513fa78d98df13aea2f9b5">&#9670;&#160;</a></span>mptokensChanged</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::ValidClawback::mptokensChanged = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="InvariantCheck_8h_source.html#l00542">542</a> of file <a class="el" href="InvariantCheck_8h_source.html">InvariantCheck.h</a>.</p>
</div>
</div>
</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink