Files
rippled/PermissionedDEXHelpers_8cpp_source.html
2025-11-04 00:36:48 -08:00

180 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: PermissionedDEXHelpers.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_2860c73e71f9ef894ba4acb1eeae5483.html">misc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">PermissionedDEXHelpers.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpld/app/misc/PermissionedDEXHelpers.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpl/ledger/CredentialHelpers.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="foldopen" id="foldopen00006" data-start="{" data-end="}">
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="namespaceripple_1_1permissioned__dex.html"> 6</a></span><span class="keyword">namespace </span>permissioned_dex {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="namespaceripple_1_1permissioned__dex.html#a62826b42e3a4aa7787ec5dcc2366190a"> 9</a></span><a class="code hl_function" href="namespaceripple_1_1permissioned__dex.html#a62826b42e3a4aa7787ec5dcc2366190a">accountInDomain</a>(</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; view,</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; account,</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <a class="code hl_class" href="classripple_1_1base__uint.html">Domain</a> <span class="keyword">const</span>&amp; domainID)</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">auto</span> <span class="keyword">const</span> sleDomain = view.<a class="code hl_function" href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304">read</a>(<a class="code hl_function" href="namespaceripple_1_1keylet.html#a51879ade5bc763231874ba4298bf17d3">keylet::permissionedDomain</a>(domainID));</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">if</span> (!sleDomain)</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// domain owner is in the domain</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">if</span> (sleDomain-&gt;getAccountID(sfOwner) == account)</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">auto</span> <span class="keyword">const</span>&amp; credentials = sleDomain-&gt;getFieldArray(sfAcceptedCredentials);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">bool</span> <span class="keyword">const</span> inDomain = <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/algorithm/all_any_none_of.html">std::any_of</a>(</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> credentials.begin(), credentials.end(), [&amp;](<span class="keyword">auto</span> <span class="keyword">const</span>&amp; <a class="code hl_enumvalue" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bda7c7c74ef60d5950b8abb1ba20e964cdf">credential</a>) {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> auto const sleCred = view.read(keylet::credential(</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> account, credential[sfIssuer], credential[sfCredentialType]));</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> if (!sleCred || !sleCred-&gt;isFlag(lsfAccepted))</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> return false;</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> return !credentials::checkExpired(</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> sleCred, view.info().parentCloseTime);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> });</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span> inDomain;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceripple_1_1permissioned__dex.html#af80a77f3eafe3cbd4292e7af6e76c5b4"> 39</a></span><a class="code hl_function" href="namespaceripple_1_1permissioned__dex.html#af80a77f3eafe3cbd4292e7af6e76c5b4">offerInDomain</a>(</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; view,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; offerID,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="classripple_1_1base__uint.html">Domain</a> <span class="keyword">const</span>&amp; domainID,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> j)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>{</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">auto</span> <span class="keyword">const</span> sleOffer = view.<a class="code hl_function" href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304">read</a>(<a class="code hl_function" href="namespaceripple_1_1keylet.html#aeffddd45805feb6cc0678738b5c21072">keylet::offer</a>(offerID));</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// The following are defensive checks that should never happen, since this</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// function is used to check against the order book offers, which should not</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// have any of the following wrong behavior</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">if</span> (!sleOffer)</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// LCOV_EXCL_LINE</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">if</span> (!sleOffer-&gt;isFieldPresent(sfDomainID))</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// LCOV_EXCL_LINE</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">if</span> (sleOffer-&gt;getFieldH256(sfDomainID) != domainID)</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// LCOV_EXCL_LINE</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">if</span> (sleOffer-&gt;isFlag(<a class="code hl_enumvalue" href="namespaceripple.html#a4a9c7b33fef9015d6406302ef80b63c5a9f6346dbd49b85ced4658b24df239b68">lsfHybrid</a>) &amp;&amp;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> !sleOffer-&gt;isFieldPresent(sfAdditionalBooks))</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> JLOG(j.<a class="code hl_function" href="classbeast_1_1Journal.html#a49b0713e65bb8e2c51b76fbf16252afe">error</a>()) &lt;&lt; <span class="stringliteral">&quot;Hybrid offer &quot;</span> &lt;&lt; offerID</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> &lt;&lt; <span class="stringliteral">&quot; missing AdditionalBooks field&quot;</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// LCOV_EXCL_LINE</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple_1_1permissioned__dex.html#a62826b42e3a4aa7787ec5dcc2366190a">accountInDomain</a>(view, sleOffer-&gt;getAccountID(sfAccount), domainID);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>}</div>
</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>} <span class="comment">// namespace permissioned_dex</span></div>
</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aall_any_none_of_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/all_any_none_of.html">std::any_of</a></div><div class="ttdeci">T any_of(T... args)</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#l00040">Journal.h:41</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html_a49b0713e65bb8e2c51b76fbf16252afe"><div class="ttname"><a href="classbeast_1_1Journal.html#a49b0713e65bb8e2c51b76fbf16252afe">beast::Journal::error</a></div><div class="ttdeci">Stream error() const</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00327">Journal.h:327</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#l00031">ReadView.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1ReadView_html_a0583a050ea7799ba331f6222a905f304"><div class="ttname"><a href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304">ripple::ReadView::read</a></div><div class="ttdeci">virtual std::shared_ptr&lt; SLE const &gt; read(Keylet const &amp;k) const =0</div><div class="ttdoc">Return the state item associated with a key.</div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="anamespaceripple_1_1keylet_html_a51879ade5bc763231874ba4298bf17d3"><div class="ttname"><a href="namespaceripple_1_1keylet.html#a51879ade5bc763231874ba4298bf17d3">ripple::keylet::permissionedDomain</a></div><div class="ttdeci">Keylet permissionedDomain(AccountID const &amp;account, std::uint32_t seq) noexcept</div><div class="ttdef"><b>Definition</b> <a href="Indexes_8cpp_source.html#l00551">Indexes.cpp:551</a></div></div>
<div class="ttc" id="anamespaceripple_1_1keylet_html_aeffddd45805feb6cc0678738b5c21072"><div class="ttname"><a href="namespaceripple_1_1keylet.html#aeffddd45805feb6cc0678738b5c21072">ripple::keylet::offer</a></div><div class="ttdeci">Keylet offer(AccountID const &amp;id, std::uint32_t seq) noexcept</div><div class="ttdoc">An offer from an account.</div><div class="ttdef"><b>Definition</b> <a href="Indexes_8cpp_source.html#l00255">Indexes.cpp:255</a></div></div>
<div class="ttc" id="anamespaceripple_1_1permissioned__dex_html_a62826b42e3a4aa7787ec5dcc2366190a"><div class="ttname"><a href="namespaceripple_1_1permissioned__dex.html#a62826b42e3a4aa7787ec5dcc2366190a">ripple::permissioned_dex::accountInDomain</a></div><div class="ttdeci">bool accountInDomain(ReadView const &amp;view, AccountID const &amp;account, Domain const &amp;domainID)</div><div class="ttdef"><b>Definition</b> <a href="PermissionedDEXHelpers_8cpp_source.html#l00009">PermissionedDEXHelpers.cpp:9</a></div></div>
<div class="ttc" id="anamespaceripple_1_1permissioned__dex_html_af80a77f3eafe3cbd4292e7af6e76c5b4"><div class="ttname"><a href="namespaceripple_1_1permissioned__dex.html#af80a77f3eafe3cbd4292e7af6e76c5b4">ripple::permissioned_dex::offerInDomain</a></div><div class="ttdeci">bool offerInDomain(ReadView const &amp;view, uint256 const &amp;offerID, Domain const &amp;domainID, beast::Journal j)</div><div class="ttdef"><b>Definition</b> <a href="PermissionedDEXHelpers_8cpp_source.html#l00039">PermissionedDEXHelpers.cpp:39</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a4a9c7b33fef9015d6406302ef80b63c5a9f6346dbd49b85ced4658b24df239b68"><div class="ttname"><a href="namespaceripple.html#a4a9c7b33fef9015d6406302ef80b63c5a9f6346dbd49b85ced4658b24df239b68">ripple::lsfHybrid</a></div><div class="ttdeci">@ lsfHybrid</div><div class="ttdef"><b>Definition</b> <a href="LedgerFormats_8h_source.html#l00137">LedgerFormats.h:137</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad5143ceada01141772ae4aab984f94bda7c7c74ef60d5950b8abb1ba20e964cdf"><div class="ttname"><a href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bda7c7c74ef60d5950b8abb1ba20e964cdf">ripple::HashPrefix::credential</a></div><div class="ttdeci">@ credential</div><div class="ttdoc">Credentials signature.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.8
</small></address>
</body>
</html>