mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
172 lines
20 KiB
HTML
172 lines
20 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: apply.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&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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_4b2d6f306dc33741b6f38a59a670a446.html">tx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">apply.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_TX_APPLY_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TX_APPLY_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 <xrpld/app/tx/applySteps.h></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <xrpld/core/Config.h></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <xrpl/beast/utility/Journal.h></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <xrpl/ledger/View.h></span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <xrpl/protocol/STTx.h></span></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><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>></span></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">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</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="keyword">class </span>Application;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">class </span>HashRouter;</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="foldopen" id="foldopen00022" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd"> 22</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd">Validity</a> {</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_enumvalue" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda1e2ba91f36984d755d5edb5bf58ae60c">SigBad</a>,</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_enumvalue" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda5ef9dd0687717427ebe8c5e3bcfb7ec1">SigGoodOnly</a>,</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_enumvalue" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d">Valid</a></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair<Validity, std::string></a></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><a class="code hl_function" href="namespaceripple.html#adb47f5675e01882e14c2cf9cc5700648">checkValidity</a>(</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> HashRouter& router,</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> STTx <span class="keyword">const</span>& tx,</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> Rules <span class="keyword">const</span>& rules,</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> Config <span class="keyword">const</span>& config);</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="keywordtype">void</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><a class="code hl_function" href="namespaceripple.html#ab5fadc2b2814a10d35c00c0a8241fbe7">forceValidity</a>(HashRouter& router, <a class="code hl_typedef" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> <span class="keyword">const</span>& txid, <a class="code hl_enumeration" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd">Validity</a> validity);</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>ApplyResult</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><a class="code hl_function" href="namespaceripple.html#ab5570a1f8263efb3c9d80b34a92c895a">apply</a>(</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> Application& app,</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> OpenView& view,</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> STTx <span class="keyword">const</span>& tx,</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <a class="code hl_enumeration" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags,</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
|
|
<div class="foldopen" id="foldopen00116" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63"> 116</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63">ApplyTransactionResult</a> {</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <a class="code hl_enumvalue" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63a505a83f220c02df2f85c3810cd9ceb38">Success</a>,</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <a class="code hl_enumvalue" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63aceaa0734f0b3c738120c67344d8f3ec1">Fail</a>,</div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <a class="code hl_enumvalue" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63a6327b4e59f58137083214a1fec358855">Retry</a></div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><a class="code hl_enumeration" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63">ApplyTransactionResult</a></div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><a class="code hl_function" href="namespaceripple.html#adabbca732d5cb29c385300533c7236e9">applyTransaction</a>(</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> Application& app,</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> OpenView& view,</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> STTx <span class="keyword">const</span>& tx,</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">bool</span> retryAssured,</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_enumeration" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags,</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span>} <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00040">Journal.h:41</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="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a3352ead78ab1510016d3f728004acd63"><div class="ttname"><a href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63">ripple::ApplyTransactionResult</a></div><div class="ttdeci">ApplyTransactionResult</div><div class="ttdoc">Enum class for return value from applyTransaction</div><div class="ttdef"><b>Definition</b> <a href="apply_8h_source.html#l00116">apply.h:116</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a3352ead78ab1510016d3f728004acd63a505a83f220c02df2f85c3810cd9ceb38"><div class="ttname"><a href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63a505a83f220c02df2f85c3810cd9ceb38">ripple::ApplyTransactionResult::Success</a></div><div class="ttdeci">@ Success</div><div class="ttdoc">Applied to this ledger.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a3352ead78ab1510016d3f728004acd63a6327b4e59f58137083214a1fec358855"><div class="ttname"><a href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63a6327b4e59f58137083214a1fec358855">ripple::ApplyTransactionResult::Retry</a></div><div class="ttdeci">@ Retry</div><div class="ttdoc">Should be retried in this ledger.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a3352ead78ab1510016d3f728004acd63aceaa0734f0b3c738120c67344d8f3ec1"><div class="ttname"><a href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63aceaa0734f0b3c738120c67344d8f3ec1">ripple::ApplyTransactionResult::Fail</a></div><div class="ttdeci">@ Fail</div><div class="ttdoc">Should not be retried in this ledger.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a356c68147333a9a48a344718038576d9"><div class="ttname"><a href="namespaceripple.html#a356c68147333a9a48a344718038576d9">ripple::uint256</a></div><div class="ttdeci">base_uint< 256 > uint256</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00539">base_uint.h:539</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ab5570a1f8263efb3c9d80b34a92c895a"><div class="ttname"><a href="namespaceripple.html#ab5570a1f8263efb3c9d80b34a92c895a">ripple::apply</a></div><div class="ttdeci">ApplyResult apply(Application &app, OpenView &view, STTx const &tx, ApplyFlags flags, beast::Journal journal)</div><div class="ttdoc">Apply a transaction to an OpenView.</div><div class="ttdef"><b>Definition</b> <a href="apply_8cpp_source.html#l00127">apply.cpp:127</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ab5fadc2b2814a10d35c00c0a8241fbe7"><div class="ttname"><a href="namespaceripple.html#ab5fadc2b2814a10d35c00c0a8241fbe7">ripple::forceValidity</a></div><div class="ttdeci">void forceValidity(HashRouter &router, uint256 const &txid, Validity validity)</div><div class="ttdoc">Sets the validity of a given transaction in the cache.</div><div class="ttdef"><b>Definition</b> <a href="apply_8cpp_source.html#l00099">apply.cpp:99</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_abcad59b0151763334cc398263373bcdd"><div class="ttname"><a href="namespaceripple.html#abcad59b0151763334cc398263373bcdd">ripple::Validity</a></div><div class="ttdeci">Validity</div><div class="ttdoc">Describes the pre-processing validity of a transaction.</div><div class="ttdef"><b>Definition</b> <a href="apply_8h_source.html#l00022">apply.h:22</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_abcad59b0151763334cc398263373bcdda1e2ba91f36984d755d5edb5bf58ae60c"><div class="ttname"><a href="namespaceripple.html#abcad59b0151763334cc398263373bcdda1e2ba91f36984d755d5edb5bf58ae60c">ripple::Validity::SigBad</a></div><div class="ttdeci">@ SigBad</div><div class="ttdoc">Signature is bad. Didn't do local checks.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d"><div class="ttname"><a href="namespaceripple.html#abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d">ripple::Validity::Valid</a></div><div class="ttdeci">@ Valid</div><div class="ttdoc">Signature and local checks are good / passed.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_abcad59b0151763334cc398263373bcdda5ef9dd0687717427ebe8c5e3bcfb7ec1"><div class="ttname"><a href="namespaceripple.html#abcad59b0151763334cc398263373bcdda5ef9dd0687717427ebe8c5e3bcfb7ec1">ripple::Validity::SigGoodOnly</a></div><div class="ttdeci">@ SigGoodOnly</div><div class="ttdoc">Signature is good, but local checks fail.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ad2487abbcc1a5d6064b72144b461df6e"><div class="ttname"><a href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ripple::ApplyFlags</a></div><div class="ttdeci">ApplyFlags</div><div class="ttdef"><b>Definition</b> <a href="ApplyView_8h_source.html#l00011">ApplyView.h:11</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_adabbca732d5cb29c385300533c7236e9"><div class="ttname"><a href="namespaceripple.html#adabbca732d5cb29c385300533c7236e9">ripple::applyTransaction</a></div><div class="ttdeci">ApplyTransactionResult applyTransaction(Application &app, OpenView &view, STTx const &tx, bool retryAssured, ApplyFlags flags, beast::Journal journal)</div><div class="ttdoc">Transaction application helper.</div><div class="ttdef"><b>Definition</b> <a href="apply_8cpp_source.html#l00220">apply.cpp:220</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_adb47f5675e01882e14c2cf9cc5700648"><div class="ttname"><a href="namespaceripple.html#adb47f5675e01882e14c2cf9cc5700648">ripple::checkValidity</a></div><div class="ttdeci">std::pair< Validity, std::string > checkValidity(HashRouter &router, STTx const &tx, Rules const &rules, Config const &config)</div><div class="ttdoc">Checks transaction signature and local checks.</div><div class="ttdef"><b>Definition</b> <a href="apply_8cpp_source.html#l00025">apply.cpp:25</a></div></div>
|
|
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
|
|
<div class="ttc" id="autility_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/utility.html">utility</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>
|