This commit is contained in:
intelliot
2023-07-12 17:57:19 +00:00
parent a2e1c04c86
commit 2cd625785d
3545 changed files with 126342 additions and 73769 deletions

View File

@@ -81,32 +81,35 @@ Collaboration diagram for ripple::StrandContext:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1StrandContext__coll__graph.png" border="0" usemap="#ripple_1_1StrandContext_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1StrandContext_coll__map" id="ripple_1_1StrandContext_coll__map">
<area shape="rect" title="Context needed to build Strand Steps and for error checking." alt="" coords="1155,172,1315,199"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="811,157,974,213"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="842,237,943,264"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,230,689,271"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,147,389,189"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,165,693,206"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="519,297,661,338"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,155,108,181"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,320,349,347"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="827,459,958,485"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1147,444,1323,500"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1147,525,1323,566"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="1372,411,1572,437"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="1375,575,1569,601"/>
<area shape="rect" href="classripple_1_1Step.html" title="A step in a payment path." alt="" coords="845,5,941,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="803,56,983,83"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="837,107,948,133"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="517,107,663,133"/>
<area shape="rect" title="Context needed to build Strand Steps and for error checking." alt="" coords="1187,212,1347,239"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="843,107,1006,163"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="874,237,975,264"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,250,689,291"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,333,389,374"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,185,693,226"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="519,315,661,357"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,340,108,367"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,189,349,216"/>
<area shape="rect" href="classripple_1_1AMMContext.html" title="Maintains AMM info per overall payment engine execution and individual iteration." alt="" coords="850,187,999,213"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="859,483,990,509"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1179,607,1355,663"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1179,415,1355,457"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="1404,561,1604,588"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="1407,460,1601,487"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="539,83,641,109"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="543,133,637,160"/>
<area shape="rect" href="classripple_1_1Step.html" title="A step in a payment path." alt="" coords="877,5,973,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="835,56,1015,83"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="869,377,980,404"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="517,381,663,408"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a097aac45f577b584145d4005dec223cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a097aac45f577b584145d4005dec223cd">StrandContext</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;view_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1Step.html">Step</a> &gt;&gt; const &amp;strand_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandSrc_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandDst_, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;strandDeliver_, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt; const &amp;limitQuality_, bool isLast_, bool ownerPaysTransferFee_, bool offerCrossing_, bool isDefaultPath_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;seenDirectIssues_, boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;seenBookOuts_, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j_)</td></tr>
<tr class="memdesc:a097aac45f577b584145d4005dec223cd"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structripple_1_1StrandContext.html" title="Context needed to build Strand Steps and for error checking.">StrandContext</a> constructor. <a href="structripple_1_1StrandContext.html#a097aac45f577b584145d4005dec223cd">More...</a><br /></td></tr>
<tr class="separator:a097aac45f577b584145d4005dec223cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb42106b3095bae08d39db25ba118c22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#acb42106b3095bae08d39db25ba118c22">StrandContext</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;view_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1Step.html">Step</a> &gt;&gt; const &amp;strand_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandSrc_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandDst_, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;strandDeliver_, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt; const &amp;limitQuality_, bool isLast_, bool ownerPaysTransferFee_, bool offerCrossing_, bool isDefaultPath_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;seenDirectIssues_, boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;seenBookOuts_, <a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;ammContext_, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j_)</td></tr>
<tr class="memdesc:acb42106b3095bae08d39db25ba118c22"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structripple_1_1StrandContext.html" title="Context needed to build Strand Steps and for error checking.">StrandContext</a> constructor. <a href="structripple_1_1StrandContext.html#acb42106b3095bae08d39db25ba118c22">More...</a><br /></td></tr>
<tr class="separator:acb42106b3095bae08d39db25ba118c22"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@@ -152,16 +155,18 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a0bef921eb9b057dff6fa57d4bef62025"><td class="memItemLeft" align="right" valign="top">boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0bef921eb9b057dff6fa57d4bef62025">seenBookOuts</a></td></tr>
<tr class="memdesc:a0bef921eb9b057dff6fa57d4bef62025"><td class="mdescLeft">&#160;</td><td class="mdescRight">A strand may not include an offer that output the same issue more than once. <a href="structripple_1_1StrandContext.html#a0bef921eb9b057dff6fa57d4bef62025">More...</a><br /></td></tr>
<tr class="separator:a0bef921eb9b057dff6fa57d4bef62025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad518e54e6f8dd8bc666dd4066e4da31c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#ad518e54e6f8dd8bc666dd4066e4da31c">ammContext</a></td></tr>
<tr class="separator:ad518e54e6f8dd8bc666dd4066e4da31c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4004cdee59805566766958fbf01c13ae"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a4004cdee59805566766958fbf01c13ae">j</a></td></tr>
<tr class="separator:a4004cdee59805566766958fbf01c13ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Context needed to build Strand Steps and for error checking. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00497">497</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00524">524</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a097aac45f577b584145d4005dec223cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a097aac45f577b584145d4005dec223cd">&#9670;&nbsp;</a></span>StrandContext()</h2>
<a id="acb42106b3095bae08d39db25ba118c22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb42106b3095bae08d39db25ba118c22">&#9670;&nbsp;</a></span>StrandContext()</h2>
<div class="memitem">
<div class="memproto">
@@ -238,6 +243,12 @@ Public Attributes</h2></td></tr>
<td class="paramtype">boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>seenBookOuts_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;&#160;</td>
<td class="paramname"><em>ammContext_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
@@ -262,7 +273,7 @@ Public Attributes</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PaySteps_8cpp_source.html#l00575">575</a> of file <a class="el" href="PaySteps_8cpp_source.html">PaySteps.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="PaySteps_8cpp_source.html#l00580">580</a> of file <a class="el" href="PaySteps_8cpp_source.html">PaySteps.cpp</a>.</p>
</div>
</div>
@@ -281,7 +292,7 @@ Public Attributes</h2></td></tr>
<p>Current <a class="el" href="classripple_1_1ReadView.html" title="A view into a ledger.">ReadView</a>. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00499">499</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00526">526</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -299,7 +310,7 @@ Public Attributes</h2></td></tr>
<p>Strand source account. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00500">500</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00527">527</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -317,7 +328,7 @@ Public Attributes</h2></td></tr>
<p>Strand destination account. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00501">501</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00528">528</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -335,7 +346,7 @@ Public Attributes</h2></td></tr>
<p><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> strand delivers. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00502">502</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00529">529</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -353,7 +364,7 @@ Public Attributes</h2></td></tr>
<p>Worst accepted quality. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00503">503</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00530">530</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -371,7 +382,7 @@ Public Attributes</h2></td></tr>
<p>true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is first in Strand </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00504">504</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00531">531</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -389,7 +400,7 @@ Public Attributes</h2></td></tr>
<p>true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is last in Strand </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00505">505</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00532">532</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -407,7 +418,7 @@ Public Attributes</h2></td></tr>
<p>true if owner, not sender, pays fee </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00506">506</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00533">533</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -425,7 +436,7 @@ Public Attributes</h2></td></tr>
<p>true if offer crossing, not payment </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00507">507</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00534">534</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -443,7 +454,7 @@ Public Attributes</h2></td></tr>
<p>true if Strand is default path </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00508">508</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00535">535</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -461,7 +472,7 @@ Public Attributes</h2></td></tr>
<p>Length of Strand. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00509">509</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00536">536</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -480,7 +491,7 @@ Public Attributes</h2></td></tr>
<p>The previous step in the strand. </p>
<p>Needed to check the no ripple constraint </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00513">513</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00540">540</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -499,7 +510,7 @@ Public Attributes</h2></td></tr>
<p>A strand may not include the same account node more than once in the same currency. </p>
<p>In a direct step, an account will show up at most twice: once as a src and once as a dst (hence the two element array). The strandSrc and strandDst will only show up once each. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00519">519</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00546">546</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -517,7 +528,23 @@ Public Attributes</h2></td></tr>
<p>A strand may not include an offer that output the same issue more than once. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00523">523</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00550">550</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="ad518e54e6f8dd8bc666dd4066e4da31c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad518e54e6f8dd8bc666dd4066e4da31c">&#9670;&nbsp;</a></span>ammContext</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a>&amp; ripple::StrandContext::ammContext</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00551">551</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
@@ -533,7 +560,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00524">524</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00552">552</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>