This commit is contained in:
manojsdoshi
2020-06-30 22:25:39 +00:00
parent afa79b0356
commit 76ee98eab2
3262 changed files with 114349 additions and 92216 deletions

View File

@@ -213,7 +213,7 @@ $(function() {
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructripple_1_1PreclaimResult_html_a63d5e4fce0f093dcd45b3355827c6638"><div class="ttname"><a href="structripple_1_1PreclaimResult.html#a63d5e4fce0f093dcd45b3355827c6638">ripple::PreclaimResult::view</a></div><div class="ttdeci">ReadView const &amp; view</div><div class="ttdoc">From the input - the ledger view.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00088">applySteps.h:88</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimResult_html_aa83c59a10a22ef7daeadadaf1fc1ab0a"><div class="ttname"><a href="structripple_1_1PreclaimResult.html#aa83c59a10a22ef7daeadadaf1fc1ab0a">ripple::PreclaimResult::j</a></div><div class="ttdeci">const beast::Journal j</div><div class="ttdoc">From the input - the journal.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00094">applySteps.h:94</a></div></div>
<div class="ttc" id="anamespaceripple_html_a42bdde4d18ce8c6a342c3d23f170dfa3"><div class="ttname"><a href="namespaceripple.html#a42bdde4d18ce8c6a342c3d23f170dfa3">ripple::calculateBaseFee</a></div><div class="ttdeci">FeeUnit64 calculateBaseFee(ReadView const &amp;view, STTx const &amp;tx)</div><div class="ttdoc">Compute only the expected base fee for a transaction.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00470">applySteps.cpp:470</a></div></div>
<div class="ttc" id="anamespaceripple_html_a42bdde4d18ce8c6a342c3d23f170dfa3"><div class="ttname"><a href="namespaceripple.html#a42bdde4d18ce8c6a342c3d23f170dfa3">ripple::calculateBaseFee</a></div><div class="ttdeci">FeeUnit64 calculateBaseFee(ReadView const &amp;view, STTx const &amp;tx)</div><div class="ttdoc">Compute only the expected base fee for a transaction.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00475">applySteps.cpp:475</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="astructripple_1_1PreflightResult_html_a0262ecf5f04e2439ffd5dac95d996ac7"><div class="ttname"><a href="structripple_1_1PreflightResult.html#a0262ecf5f04e2439ffd5dac95d996ac7">ripple::PreflightResult::operator=</a></div><div class="ttdeci">PreflightResult &amp; operator=(PreflightResult const &amp;)=delete</div><div class="ttdoc">Deleted copy assignment operator.</div></div>
<div class="ttc" id="astructripple_1_1TxConsequences_html"><div class="ttname"><a href="structripple_1_1TxConsequences.html">ripple::TxConsequences</a></div><div class="ttdoc">Structure describing the consequences to the account of applying a transaction if the transaction con...</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00126">applySteps.h:126</a></div></div>
@@ -222,13 +222,13 @@ $(function() {
<div class="ttc" id="astructripple_1_1TxConsequences_html_ab1a8896e43f9f4ebe4113631b56a7fbcaa2a44ea84ff1c735a8d9ac6edf7f43a1"><div class="ttname"><a href="structripple_1_1TxConsequences.html#ab1a8896e43f9f4ebe4113631b56a7fbcaa2a44ea84ff1c735a8d9ac6edf7f43a1">ripple::TxConsequences::normal</a></div><div class="ttdeci">@ normal</div><div class="ttdoc">Moves currency around, creates offers, etc.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00132">applySteps.h:132</a></div></div>
<div class="ttc" id="astructripple_1_1TxConsequences_html_ab1a8896e43f9f4ebe4113631b56a7fbc"><div class="ttname"><a href="structripple_1_1TxConsequences.html#ab1a8896e43f9f4ebe4113631b56a7fbc">ripple::TxConsequences::ConsequenceCategory</a></div><div class="ttdeci">ConsequenceCategory</div><div class="ttdoc">Describes how the transaction affects subsequent transactions.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00130">applySteps.h:130</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightResult_html_afc32faa89017861a7dc93dffa72946fb"><div class="ttname"><a href="structripple_1_1PreflightResult.html#afc32faa89017861a7dc93dffa72946fb">ripple::PreflightResult::tx</a></div><div class="ttdeci">STTx const &amp; tx</div><div class="ttdoc">From the input - the transaction.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00050">applySteps.h:50</a></div></div>
<div class="ttc" id="anamespaceripple_html_a24280b80536d1afd09e24a75f4596922"><div class="ttname"><a href="namespaceripple.html#a24280b80536d1afd09e24a75f4596922">ripple::preflight</a></div><div class="ttdeci">PreflightResult preflight(Application &amp;app, Rules const &amp;rules, STTx const &amp;tx, ApplyFlags flags, beast::Journal j)</div><div class="ttdoc">Gate a transaction based on static information.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00404">applySteps.cpp:404</a></div></div>
<div class="ttc" id="anamespaceripple_html_a24280b80536d1afd09e24a75f4596922"><div class="ttname"><a href="namespaceripple.html#a24280b80536d1afd09e24a75f4596922">ripple::preflight</a></div><div class="ttdeci">PreflightResult preflight(Application &amp;app, Rules const &amp;rules, STTx const &amp;tx, ApplyFlags flags, beast::Journal j)</div><div class="ttdoc">Gate a transaction based on static information.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00409">applySteps.cpp:409</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimResult_html_a1b6b5dc07dfef7173cba9fb947a89a96"><div class="ttname"><a href="structripple_1_1PreclaimResult.html#a1b6b5dc07dfef7173cba9fb947a89a96">ripple::PreclaimResult::likelyToClaimFee</a></div><div class="ttdeci">const bool likelyToClaimFee</div><div class="ttdoc">Success flag - whether the transaction is likely to claim a fee.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00100">applySteps.h:100</a></div></div>
<div class="ttc" id="anamespaceripple_html_a18e688f3fc0a5e80e13b353c9f924b22"><div class="ttname"><a href="namespaceripple.html#a18e688f3fc0a5e80e13b353c9f924b22">ripple::isTecClaim</a></div><div class="ttdeci">bool isTecClaim(TER x)</div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00582">TER.h:582</a></div></div>
<div class="ttc" id="anamespaceripple_html_aaad7838ce24fa0ffc4c6e388b18c86a4"><div class="ttname"><a href="namespaceripple.html#aaad7838ce24fa0ffc4c6e388b18c86a4">ripple::isTecClaimHardFail</a></div><div class="ttdeci">bool isTecClaimHardFail(TER ter, ApplyFlags flags)</div><div class="ttdoc">Return true if the transaction can claim a fee (tec), and the ApplyFlags do not allow soft failures.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00035">applySteps.h:35</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimResult_html_ad6d5a2a6c89f2e4c61ba575bdc2f8379"><div class="ttname"><a href="structripple_1_1PreclaimResult.html#ad6d5a2a6c89f2e4c61ba575bdc2f8379">ripple::PreclaimResult::ter</a></div><div class="ttdeci">const TER ter</div><div class="ttdoc">Intermediate transaction result.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00097">applySteps.h:97</a></div></div>
<div class="ttc" id="astructripple_1_1TxConsequences_html_affc5709f92a5ccd81217945a2af165a8"><div class="ttname"><a href="structripple_1_1TxConsequences.html#affc5709f92a5ccd81217945a2af165a8">ripple::TxConsequences::potentialSpend</a></div><div class="ttdeci">const XRPAmount potentialSpend</div><div class="ttdoc">Does NOT include the fee.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00144">applySteps.h:144</a></div></div>
<div class="ttc" id="anamespaceripple_html_a305632c3ccdbb4005fa2b019c51b5ac1"><div class="ttname"><a href="namespaceripple.html#a305632c3ccdbb4005fa2b019c51b5ac1">ripple::doApply</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; doApply(PreclaimResult const &amp;preclaimResult, Application &amp;app, OpenView &amp;view)</div><div class="ttdoc">Apply a prechecked transaction to an OpenView.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00488">applySteps.cpp:488</a></div></div>
<div class="ttc" id="anamespaceripple_html_a305632c3ccdbb4005fa2b019c51b5ac1"><div class="ttname"><a href="namespaceripple.html#a305632c3ccdbb4005fa2b019c51b5ac1">ripple::doApply</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; doApply(PreclaimResult const &amp;preclaimResult, Application &amp;app, OpenView &amp;view)</div><div class="ttdoc">Apply a prechecked transaction to an OpenView.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00493">applySteps.cpp:493</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightResult_html"><div class="ttname"><a href="structripple_1_1PreflightResult.html">ripple::PreflightResult</a></div><div class="ttdoc">Describes the results of the preflight check.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00046">applySteps.h:46</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightResult_html_ae4b697f3fa00d5bb98458f73eb8537ab"><div class="ttname"><a href="structripple_1_1PreflightResult.html#ae4b697f3fa00d5bb98458f73eb8537ab">ripple::PreflightResult::rules</a></div><div class="ttdeci">const Rules rules</div><div class="ttdoc">From the input - the rules.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00052">applySteps.h:52</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightResult_html_a6ff883db027bca4c1f3db9b6cf2efef1"><div class="ttname"><a href="structripple_1_1PreflightResult.html#a6ff883db027bca4c1f3db9b6cf2efef1">ripple::PreflightResult::ter</a></div><div class="ttdeci">const NotTEC ter</div><div class="ttdoc">Intermediate transaction result.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00059">applySteps.h:59</a></div></div>
@@ -237,12 +237,12 @@ $(function() {
<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="astructripple_1_1TxConsequences_html_a1821082771e2467755a26807e2d5bd76"><div class="ttname"><a href="structripple_1_1TxConsequences.html#a1821082771e2467755a26807e2d5bd76">ripple::TxConsequences::TxConsequences</a></div><div class="ttdeci">TxConsequences(ConsequenceCategory const category_, XRPAmount const fee_, XRPAmount const spend_)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00147">applySteps.h:147</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad2487abbcc1a5d6064b72144b461df6ead993a03ae0b72db5c62a616b69eaccff"><div class="ttname"><a href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6ead993a03ae0b72db5c62a616b69eaccff">ripple::tapRETRY</a></div><div class="ttdeci">@ tapRETRY</div><div class="ttdef"><b>Definition:</b> <a href="ApplyView_8h_source.html#l00039">ApplyView.h:39</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5027a5209e954b9478fab70357963466"><div class="ttname"><a href="namespaceripple.html#a5027a5209e954b9478fab70357963466">ripple::preclaim</a></div><div class="ttdeci">PreclaimResult preclaim(PreflightResult const &amp;preflightResult, Application &amp;app, OpenView const &amp;view)</div><div class="ttdoc">Gate a transaction based on static ledger information.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00424">applySteps.cpp:424</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5027a5209e954b9478fab70357963466"><div class="ttname"><a href="namespaceripple.html#a5027a5209e954b9478fab70357963466">ripple::preclaim</a></div><div class="ttdeci">PreclaimResult preclaim(PreflightResult const &amp;preflightResult, Application &amp;app, OpenView const &amp;view)</div><div class="ttdoc">Gate a transaction based on static ledger information.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00429">applySteps.cpp:429</a></div></div>
<div class="ttc" id="aclassripple_1_1ReadView_html"><div class="ttname"><a href="classripple_1_1ReadView.html">ripple::ReadView</a></div><div class="ttdoc">A view into a ledger.</div><div class="ttdef"><b>Definition:</b> <a href="ReadView_8h_source.html#l00188">ReadView.h:188</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightResult_html_a3804e7a9e9cfd06b09571edc3d489f24"><div class="ttname"><a href="structripple_1_1PreflightResult.html#a3804e7a9e9cfd06b09571edc3d489f24">ripple::PreflightResult::PreflightResult</a></div><div class="ttdeci">PreflightResult(Context const &amp;ctx_, NotTEC ter_)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00063">applySteps.h:63</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimResult_html_a0e839d1b5fa7397cf8c416473d843913"><div class="ttname"><a href="structripple_1_1PreclaimResult.html#a0e839d1b5fa7397cf8c416473d843913">ripple::PreclaimResult::operator=</a></div><div class="ttdeci">PreclaimResult &amp; operator=(PreclaimResult const &amp;)=delete</div><div class="ttdoc">Deleted copy assignment operator.</div></div>
<div class="ttc" id="anamespaceripple_html_aaca2b95d107c501db5931fd6d9a06683"><div class="ttname"><a href="namespaceripple.html#aaca2b95d107c501db5931fd6d9a06683">ripple::calculateConsequences</a></div><div class="ttdeci">TxConsequences calculateConsequences(PreflightResult const &amp;preflightResult)</div><div class="ttdoc">Determine the XRP balance consequences if a transaction consumes the maximum XRP allowed.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00476">applySteps.cpp:476</a></div></div>
<div class="ttc" id="anamespaceripple_html_aaca2b95d107c501db5931fd6d9a06683"><div class="ttname"><a href="namespaceripple.html#aaca2b95d107c501db5931fd6d9a06683">ripple::calculateConsequences</a></div><div class="ttdeci">TxConsequences calculateConsequences(PreflightResult const &amp;preflightResult)</div><div class="ttdoc">Determine the XRP balance consequences if a transaction consumes the maximum XRP allowed.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00481">applySteps.cpp:481</a></div></div>
<div class="ttc" id="anamespaceripple_html_a0c6efbec71c5ff79b38c80b8fe3f52e5"><div class="ttname"><a href="namespaceripple.html#a0c6efbec71c5ff79b38c80b8fe3f52e5">ripple::FeeUnit64</a></div><div class="ttdeci">FeeUnit&lt; std::uint64_t &gt; FeeUnit64</div><div class="ttdef"><b>Definition:</b> <a href="FeeUnits_8h_source.html#l00460">FeeUnits.h:460</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimResult_html"><div class="ttname"><a href="structripple_1_1PreclaimResult.html">ripple::PreclaimResult</a></div><div class="ttdoc">Describes the results of the preclaim check.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00084">applySteps.h:84</a></div></div>
<div class="ttc" id="astructripple_1_1TxConsequences_html_a9d8f5627fb157e7c63f2fd9018235b92"><div class="ttname"><a href="structripple_1_1TxConsequences.html#a9d8f5627fb157e7c63f2fd9018235b92">ripple::TxConsequences::fee</a></div><div class="ttdeci">const XRPAmount fee</div><div class="ttdoc">Transaction fee.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8h_source.html#l00142">applySteps.h:142</a></div></div>