ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-02 08:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: eac3abdca9

Browse Source
This commit is contained in:
bthomee
2025-01-21 19:58:08 +00:00
parent 8b38c076f5
commit e61ca37029
15549 changed files with 1163583 additions and 908656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

231
apply_8h_source.html
View File

@@ -1,9 +1,9 @@
<!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">
<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=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<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: apply.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,8 +19,8 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
@@ -29,21 +29,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.5 -->
<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 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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @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>
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -54,123 +55,127 @@ $(function() {
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<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_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_08bd996c7140e5d4c4a2548bd66a393f.html">tx</a></li> </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 class="headertitle"><div class="title">apply.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) 2012, 2013 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_TX_APPLY_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_TX_APPLY_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/beast/utility/Journal.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/core/Config.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;ripple/ledger/View.h&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/STTx.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/TER.h&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span>Application;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">class </span>HashRouter;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd"> 40</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd">Validity</a> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda1e2ba91f36984d755d5edb5bf58ae60c">SigBad</a>,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda5ef9dd0687717427ebe8c5e3bcfb7ec1">SigGoodOnly</a>,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d">Valid</a></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;};</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;Validity, std::string&gt;</a></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<a class="code" href="namespaceripple.html#adb47f5675e01882e14c2cf9cc5700648">checkValidity</a>(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; HashRouter&amp; router,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; STTx <span class="keyword">const</span>&amp; tx,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; Rules <span class="keyword">const</span>&amp; rules,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; Config <span class="keyword">const</span>&amp; config);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<a class="code" href="namespaceripple.html#ab5fadc2b2814a10d35c00c0a8241fbe7">forceValidity</a>(HashRouter&amp; router, <a class="code" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> <span class="keyword">const</span>&amp; txid, <a class="code" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd">Validity</a> validity);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, bool&gt;</a></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<a class="code" href="namespaceripple.html#a19f506b57882e3396d15d7c43fa92d92">apply</a>(</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; Application&amp; app,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; OpenView&amp; view,</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; STTx <span class="keyword">const</span>&amp; tx,</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <a class="code" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags,</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab"> 134</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab">ApplyResult</a> {</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <a class="code" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba505a83f220c02df2f85c3810cd9ceb38">Success</a>,</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <a class="code" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268abaceaa0734f0b3c738120c67344d8f3ec1">Fail</a>,</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <a class="code" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba6327b4e59f58137083214a1fec358855">Retry</a></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;};</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<a class="code" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab">ApplyResult</a></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<a class="code" href="namespaceripple.html#a9a7e15b3f65c118e9ca8589bb70d55b4">applyTransaction</a>(</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; Application&amp; app,</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; OpenView&amp; view,</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; STTx <span class="keyword">const</span>&amp; tx,</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keywordtype">bool</span> retryAssured,</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <a class="code" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags,</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<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 class="ttc" id="anamespaceripple_html_a19f506b57882e3396d15d7c43fa92d92"><div class="ttname"><a href="namespaceripple.html#a19f506b57882e3396d15d7c43fa92d92">ripple::apply</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; apply(Application &amp;app, OpenView &amp;view, STTx const &amp;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#l00109">apply.cpp:109</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="anamespaceripple_html_a9a7e15b3f65c118e9ca8589bb70d55b4"><div class="ttname"><a href="namespaceripple.html#a9a7e15b3f65c118e9ca8589bb70d55b4">ripple::applyTransaction</a></div><div class="ttdeci">ApplyResult applyTransaction(Application &amp;app, OpenView &amp;view, STTx const &amp;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#l00125">apply.cpp:125</a></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#l00029">ApplyView.h:29</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#l00040">apply.h:40</a></div></div>
<div class="ttc" id="anamespaceripple_html_abbfb5342bce7b612bff600b8a44268ab"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab">ripple::ApplyResult</a></div><div class="ttdeci">ApplyResult</div><div class="ttdoc">Enum class for return value from applyTransaction</div><div class="ttdef"><b>Definition:</b> <a href="apply_8h_source.html#l00134">apply.h:134</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 &amp;router, uint256 const &amp;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#l00089">apply.cpp:89</a></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&lt; 256 &gt; uint256</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00550">base_uint.h:550</a></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_adb47f5675e01882e14c2cf9cc5700648"><div class="ttname"><a href="namespaceripple.html#adb47f5675e01882e14c2cf9cc5700648">ripple::checkValidity</a></div><div class="ttdeci">std::pair&lt; Validity, std::string &gt; checkValidity(HashRouter &amp;router, STTx const &amp;tx, Rules const &amp;rules, Config const &amp;config)</div><div class="ttdoc">Checks transaction signature and local checks.</div><div class="ttdef"><b>Definition:</b> <a href="apply_8cpp_source.html#l00037">apply.cpp:37</a></div></div>
<div class="ttc" id="anamespaceripple_html_abbfb5342bce7b612bff600b8a44268aba6327b4e59f58137083214a1fec358855"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba6327b4e59f58137083214a1fec358855">ripple::ApplyResult::Retry</a></div><div class="ttdeci">@ Retry</div><div class="ttdoc">Should be retried in this ledger.</div></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#l00058">Journal.h:58</a></div></div>
<div class="ttc" id="anamespaceripple_html_abbfb5342bce7b612bff600b8a44268aba505a83f220c02df2f85c3810cd9ceb38"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba505a83f220c02df2f85c3810cd9ceb38">ripple::ApplyResult::Success</a></div><div class="ttdeci">@ Success</div><div class="ttdoc">Applied to this ledger.</div></div>
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></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><span class="preprocessor">#ifndef RIPPLE_TX_APPLY_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_TX_APPLY_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpld/core/Config.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpld/ledger/View.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/beast/utility/Journal.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;xrpl/protocol/STTx.h&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;xrpl/protocol/TER.h&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">class </span>Application;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">class </span>HashRouter;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd"> 40</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="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_enumvalue" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda1e2ba91f36984d755d5edb5bf58ae60c">SigBad</a>,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_enumvalue" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda5ef9dd0687717427ebe8c5e3bcfb7ec1">SigGoodOnly</a>,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_enumvalue" href="namespaceripple.html#abcad59b0151763334cc398263373bcdda3ac705f2acd51a4613f9188c05c91d0d">Valid</a></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;Validity, std::string&gt;</a></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><a class="code hl_function" href="namespaceripple.html#adb47f5675e01882e14c2cf9cc5700648">checkValidity</a>(</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> HashRouter&amp; router,</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> STTx <span class="keyword">const</span>&amp; tx,</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> Rules <span class="keyword">const</span>&amp; rules,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> Config <span class="keyword">const</span>&amp; config);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><a class="code hl_function" href="namespaceripple.html#ab5fadc2b2814a10d35c00c0a8241fbe7">forceValidity</a>(HashRouter&amp; router, <a class="code hl_typedef" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> <span class="keyword">const</span>&amp; txid, <a class="code hl_enumeration" href="namespaceripple.html#abcad59b0151763334cc398263373bcdd">Validity</a> validity);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, bool&gt;</a></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><a class="code hl_function" href="namespaceripple.html#a19f506b57882e3396d15d7c43fa92d92">apply</a>(</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> Application&amp; app,</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> OpenView&amp; view,</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> STTx <span class="keyword">const</span>&amp; tx,</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <a class="code hl_enumeration" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags,</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab"> 134</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab">ApplyResult</a> {</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <a class="code hl_enumvalue" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba505a83f220c02df2f85c3810cd9ceb38">Success</a>,</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_enumvalue" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268abaceaa0734f0b3c738120c67344d8f3ec1">Fail</a>,</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <a class="code hl_enumvalue" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba6327b4e59f58137083214a1fec358855">Retry</a></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span>};</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><a class="code hl_enumeration" href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab">ApplyResult</a></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><a class="code hl_function" href="namespaceripple.html#a9a7e15b3f65c118e9ca8589bb70d55b4">applyTransaction</a>(</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> Application&amp; app,</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> OpenView&amp; view,</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> STTx <span class="keyword">const</span>&amp; tx,</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keywordtype">bool</span> retryAssured,</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> <a class="code hl_enumeration" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags,</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</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#l00058">Journal.h:59</a></div></div>
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</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#l00026">algorithm.h:26</a></div></div>
<div class="ttc" id="anamespaceripple_html_a19f506b57882e3396d15d7c43fa92d92"><div class="ttname"><a href="namespaceripple.html#a19f506b57882e3396d15d7c43fa92d92">ripple::apply</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; apply(Application &amp;app, OpenView &amp;view, STTx const &amp;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#l00109">apply.cpp:109</a></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&lt; 256 &gt; uint256</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00557">base_uint.h:557</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9a7e15b3f65c118e9ca8589bb70d55b4"><div class="ttname"><a href="namespaceripple.html#a9a7e15b3f65c118e9ca8589bb70d55b4">ripple::applyTransaction</a></div><div class="ttdeci">ApplyResult applyTransaction(Application &amp;app, OpenView &amp;view, STTx const &amp;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#l00125">apply.cpp:125</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 &amp;router, uint256 const &amp;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#l00089">apply.cpp:89</a></div></div>
<div class="ttc" id="anamespaceripple_html_abbfb5342bce7b612bff600b8a44268ab"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268ab">ripple::ApplyResult</a></div><div class="ttdeci">ApplyResult</div><div class="ttdoc">Enum class for return value from applyTransaction</div><div class="ttdef"><b>Definition:</b> <a href="apply_8h_source.html#l00134">apply.h:134</a></div></div>
<div class="ttc" id="anamespaceripple_html_abbfb5342bce7b612bff600b8a44268aba505a83f220c02df2f85c3810cd9ceb38"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba505a83f220c02df2f85c3810cd9ceb38">ripple::ApplyResult::Success</a></div><div class="ttdeci">@ Success</div><div class="ttdoc">Applied to this ledger.</div></div>
<div class="ttc" id="anamespaceripple_html_abbfb5342bce7b612bff600b8a44268aba6327b4e59f58137083214a1fec358855"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268aba6327b4e59f58137083214a1fec358855">ripple::ApplyResult::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_abbfb5342bce7b612bff600b8a44268abaceaa0734f0b3c738120c67344d8f3ec1"><div class="ttname"><a href="namespaceripple.html#abbfb5342bce7b612bff600b8a44268abaceaa0734f0b3c738120c67344d8f3ec1">ripple::ApplyResult::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"><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="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_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#l00040">apply.h:40</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#l00030">ApplyView.h:30</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&lt; Validity, std::string &gt; checkValidity(HashRouter &amp;router, STTx const &amp;tx, Rules const &amp;rules, Config const &amp;config)</div><div class="ttdoc">Checks transaction signature and local checks.</div><div class="ttdef"><b>Definition:</b> <a href="apply_8cpp_source.html#l00037">apply.cpp:37</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
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>