This commit is contained in:
kennyzlei
2023-06-26 21:10:47 +00:00
parent bf2baca595
commit 1bbf49b067
597 changed files with 38057 additions and 33569 deletions

View File

@@ -2077,7 +2077,7 @@ $(function() {
<div class="ttc" id="aclassripple_1_1ApplyViewImpl_html"><div class="ttname"><a href="classripple_1_1ApplyViewImpl.html">ripple::ApplyViewImpl</a></div><div class="ttdoc">Editable, discardable view that can build metadata for one tx.</div><div class="ttdef"><b>Definition:</b> <a href="ApplyViewImpl_8h_source.html#l00036">ApplyViewImpl.h:36</a></div></div>
<div class="ttc" id="anamespaceripple_html_a40940571f0e8ca32b7a5798ccd3c6f08"><div class="ttname"><a href="namespaceripple.html#a40940571f0e8ca32b7a5798ccd3c6f08">ripple::getLastLedgerSequence</a></div><div class="ttdeci">static std::optional&lt; LedgerIndex &gt; getLastLedgerSequence(STTx const &amp;tx)</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8cpp_source.html#l00070">TxQ.cpp:70</a></div></div>
<div class="ttc" id="astructripple_1_1LedgerInfo_html_a06608577034840a474361d55624ce9a0"><div class="ttname"><a href="structripple_1_1LedgerInfo.html#a06608577034840a474361d55624ce9a0">ripple::LedgerInfo::seq</a></div><div class="ttdeci">LedgerIndex seq</div><div class="ttdef"><b>Definition:</b> <a href="ReadView_8h_source.html#l00083">ReadView.h:83</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#l00473">applySteps.cpp:473</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#l00484">applySteps.cpp:484</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html_a002e22abe4c34d378ff9ece1ab46c7ea"><div class="ttname"><a href="classripple_1_1Application.html#a002e22abe4c34d378ff9ece1ab46c7ea">ripple::Application::openLedger</a></div><div class="ttdeci">virtual OpenLedger &amp; openLedger()=0</div></div>
<div class="ttc" id="aclassripple_1_1TxQ_html_a5809a0ba90f44da94b1b9f73f5247434"><div class="ttname"><a href="classripple_1_1TxQ.html#a5809a0ba90f44da94b1b9f73f5247434">ripple::TxQ::canBeHeld</a></div><div class="ttdeci">TER canBeHeld(STTx const &amp;, ApplyFlags const, OpenView const &amp;, std::shared_ptr&lt; SLE const &gt; const &amp;sleAccount, AccountMap::iterator const &amp;, std::optional&lt; TxQAccount::TxMap::iterator &gt; const &amp;, std::lock_guard&lt; std::mutex &gt; const &amp;lock)</div><div class="ttdoc">Checks if the indicated transaction fits the conditions for being stored in the queue.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8cpp_source.html#l00373">TxQ.cpp:373</a></div></div>
<div class="ttc" id="anamespaceripple_html_aa58553112bd1aaa4fc99850a98a3362a"><div class="ttname"><a href="namespaceripple.html#aa58553112bd1aaa4fc99850a98a3362a">ripple::toFeeLevel</a></div><div class="ttdeci">FeeLevel64 toFeeLevel(XRPAmount const &amp;drops, XRPAmount const &amp;baseFee)</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00872">TxQ.h:872</a></div></div>
@@ -2103,7 +2103,7 @@ $(function() {
<div class="ttc" id="aclassripple_1_1OpenView_html_af5f70f90ab27cd12ed017a4e1d2494b1"><div class="ttname"><a href="classripple_1_1OpenView.html#af5f70f90ab27cd12ed017a4e1d2494b1">ripple::OpenView::fees</a></div><div class="ttdeci">Fees const &amp; fees() const override</div><div class="ttdoc">Returns the fees for the base ledger.</div><div class="ttdef"><b>Definition:</b> <a href="OpenView_8cpp_source.html#l00146">OpenView.cpp:146</a></div></div>
<div class="ttc" id="aclassripple_1_1TxQ_1_1MaybeTx_html_a5a00a6620ad164b279396218c731422b"><div class="ttname"><a href="classripple_1_1TxQ_1_1MaybeTx.html#a5a00a6620ad164b279396218c731422b">ripple::TxQ::MaybeTx::MaybeTx</a></div><div class="ttdeci">MaybeTx(std::shared_ptr&lt; STTx const &gt; const &amp;, TxID const &amp;txID, FeeLevel64 feeLevel, ApplyFlags const flags, PreflightResult const &amp;pfresult)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8cpp_source.html#l00272">TxQ.cpp:272</a></div></div>
<div class="ttc" id="astructripple_1_1TxQ_1_1Setup_html_afb2a3d5862daac6599f23fc30c60dd8e"><div class="ttname"><a href="structripple_1_1TxQ_1_1Setup.html#afb2a3d5862daac6599f23fc30c60dd8e">ripple::TxQ::Setup::standAlone</a></div><div class="ttdeci">bool standAlone</div><div class="ttdoc">Use standalone mode behavior.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00154">TxQ.h:154</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#l00551">applySteps.cpp:551</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#l00562">applySteps.cpp:562</a></div></div>
<div class="ttc" id="aclassripple_1_1TxQ_html_a3a26f78ddb330368dea5c95a9bf8d218"><div class="ttname"><a href="classripple_1_1TxQ.html#a3a26f78ddb330368dea5c95a9bf8d218">ripple::TxQ::byFee_</a></div><div class="ttdeci">FeeMultiSet byFee_</div><div class="ttdoc">The queue itself: the collection of transactions ordered by fee level.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00772">TxQ.h:772</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#l00150">applySteps.h:150</a></div></div>
<div class="ttc" id="anamespaceJson_html_a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6"><div class="ttname"><a href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a></div><div class="ttdeci">@ objectValue</div><div class="ttdoc">object value (collection of name/value pairs).</div><div class="ttdef"><b>Definition:</b> <a href="json__value_8h_source.html#l00043">json_value.h:43</a></div></div>
@@ -2148,9 +2148,9 @@ $(function() {
<div class="ttc" id="astructripple_1_1TxQ_1_1Metrics_html_a9ef5bb734c6c198cd67ab6b9ccd9fe4e"><div class="ttname"><a href="structripple_1_1TxQ_1_1Metrics.html#a9ef5bb734c6c198cd67ab6b9ccd9fe4e">ripple::TxQ::Metrics::referenceFeeLevel</a></div><div class="ttdeci">FeeLevel64 referenceFeeLevel</div><div class="ttdoc">Reference transaction fee level.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00175">TxQ.h:175</a></div></div>
<div class="ttc" id="anamespaceripple_html_adebe4d783be9c979e67fdbb2bc27162faa7ab9460c6755719dd1a4e74b83f34c4"><div class="ttname"><a href="namespaceripple.html#adebe4d783be9c979e67fdbb2bc27162faa7ab9460c6755719dd1a4e74b83f34c4">ripple::terNO_ACCOUNT</a></div><div class="ttdeci">@ terNO_ACCOUNT</div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00198">TER.h:198</a></div></div>
<div class="ttc" id="amin_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a></div><div class="ttdeci">T min(T... args)</div></div>
<div class="ttc" id="anamespaceripple_html_ae89924d6641e992f08233d811f17f6f3"><div class="ttname"><a href="namespaceripple.html#ae89924d6641e992f08233d811f17f6f3">ripple::calculateDefaultBaseFee</a></div><div class="ttdeci">XRPAmount calculateDefaultBaseFee(ReadView const &amp;view, STTx const &amp;tx)</div><div class="ttdoc">Return the minimum fee that an &quot;ordinary&quot; transaction would pay.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00545">applySteps.cpp:545</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae89924d6641e992f08233d811f17f6f3"><div class="ttname"><a href="namespaceripple.html#ae89924d6641e992f08233d811f17f6f3">ripple::calculateDefaultBaseFee</a></div><div class="ttdeci">XRPAmount calculateDefaultBaseFee(ReadView const &amp;view, STTx const &amp;tx)</div><div class="ttdoc">Return the minimum fee that an &quot;ordinary&quot; transaction would pay.</div><div class="ttdef"><b>Definition:</b> <a href="applySteps_8cpp_source.html#l00556">applySteps.cpp:556</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#l00038">ApplyView.h:38</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#l00493">applySteps.cpp:493</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#l00504">applySteps.cpp:504</a></div></div>
<div class="ttc" id="aclassripple_1_1TxQ_html_a958da208f16e7851992bdb05d3573314"><div class="ttname"><a href="classripple_1_1TxQ.html#a958da208f16e7851992bdb05d3573314">ripple::TxQ::~TxQ</a></div><div class="ttdeci">virtual ~TxQ()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8cpp_source.html#l00358">TxQ.cpp:358</a></div></div>
<div class="ttc" id="astructripple_1_1TxQ_1_1Metrics_html_aee1c684ec90ea6e8e6beea48bcaaf8c5"><div class="ttname"><a href="structripple_1_1TxQ_1_1Metrics.html#aee1c684ec90ea6e8e6beea48bcaaf8c5">ripple::TxQ::Metrics::medFeeLevel</a></div><div class="ttdeci">FeeLevel64 medFeeLevel</div><div class="ttdoc">Median fee level of the last ledger.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00180">TxQ.h:180</a></div></div>
<div class="ttc" id="astructripple_1_1TxQ_1_1FeeMetrics_1_1Snapshot_html"><div class="ttname"><a href="structripple_1_1TxQ_1_1FeeMetrics_1_1Snapshot.html">ripple::TxQ::FeeMetrics::Snapshot</a></div><div class="ttdoc">Snapshot of the externally relevant FeeMetrics fields at any given time.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00439">TxQ.h:439</a></div></div>
@@ -2182,7 +2182,7 @@ $(function() {
<div class="ttc" id="aclassripple_1_1TxQ_1_1FeeMetrics_html_af06e7dee02367d45a8697b428fc3785f"><div class="ttname"><a href="classripple_1_1TxQ_1_1FeeMetrics.html#af06e7dee02367d45a8697b428fc3785f">ripple::TxQ::FeeMetrics::j_</a></div><div class="ttdeci">const beast::Journal j_</div><div class="ttdoc">Journal.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00395">TxQ.h:395</a></div></div>
<div class="ttc" id="astructripple_1_1TxQ_1_1Metrics_html_ade3363912328dbd806a24207929c4fb3"><div class="ttname"><a href="structripple_1_1TxQ_1_1Metrics.html#ade3363912328dbd806a24207929c4fb3">ripple::TxQ::Metrics::txCount</a></div><div class="ttdeci">std::size_t txCount</div><div class="ttdoc">Number of transactions in the queue.</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00167">TxQ.h:167</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad2487abbcc1a5d6064b72144b461df6ea72934cf56aa148d1f25bf08fe8922150"><div class="ttname"><a href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6ea72934cf56aa148d1f25bf08fe8922150">ripple::tapFAIL_HARD</a></div><div class="ttdeci">@ tapFAIL_HARD</div><div class="ttdef"><b>Definition:</b> <a href="ApplyView_8h_source.html#l00034">ApplyView.h:34</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3deb4c69ca598c60e6502a3be527835e"><div class="ttname"><a href="namespaceripple.html#a3deb4c69ca598c60e6502a3be527835e">ripple::calculateBaseFee</a></div><div class="ttdeci">XRPAmount 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#l00539">applySteps.cpp:539</a></div></div>
<div class="ttc" id="anamespaceripple_html_a3deb4c69ca598c60e6502a3be527835e"><div class="ttname"><a href="namespaceripple.html#a3deb4c69ca598c60e6502a3be527835e">ripple::calculateBaseFee</a></div><div class="ttdeci">XRPAmount 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#l00550">applySteps.cpp:550</a></div></div>
<div class="ttc" id="anamespaceripple_html_adebe4d783be9c979e67fdbb2bc27162fac3b54a70e0fa865ed6da55cfdddd725e"><div class="ttname"><a href="namespaceripple.html#adebe4d783be9c979e67fdbb2bc27162fac3b54a70e0fa865ed6da55cfdddd725e">ripple::terPRE_SEQ</a></div><div class="ttdeci">@ terPRE_SEQ</div><div class="ttdef"><b>Definition:</b> <a href="TER_8h_source.html#l00202">TER.h:202</a></div></div>
<div class="ttc" id="astructripple_1_1TxQ_1_1Setup_html_abff7c81cad94c074c6414872e50f23e8"><div class="ttname"><a href="structripple_1_1TxQ_1_1Setup.html#abff7c81cad94c074c6414872e50f23e8">ripple::TxQ::Setup::retrySequencePercent</a></div><div class="ttdeci">std::uint32_t retrySequencePercent</div><div class="ttdoc">Extra percentage required on the fee level of a queued transaction to replace that transaction with a...</div><div class="ttdef"><b>Definition:</b> <a href="TxQ_8h_source.html#l00094">TxQ.h:94</a></div></div>
<div class="ttc" id="aclassripple_1_1OpenView_html_ad31c6cb5856530ac7d72bf01fe780d43"><div class="ttname"><a href="classripple_1_1OpenView.html#ad31c6cb5856530ac7d72bf01fe780d43">ripple::OpenView::read</a></div><div class="ttdeci">std::shared_ptr&lt; SLE const &gt; read(Keylet const &amp;k) const override</div><div class="ttdoc">Return the state item associated with a key.</div><div class="ttdef"><b>Definition:</b> <a href="OpenView_8cpp_source.html#l00171">OpenView.cpp:171</a></div></div>