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

122 lines
10 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.h 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.h</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">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpl/ledger/View.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span>permissioned_dex {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// Check if an account is in a permissioned domain</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>[[nodiscard]] <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</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> ReadView <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_typedef" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">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_typedef" href="namespaceripple.html#ae0ecc59d04defeab5f14f5dddbc694b7">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="comment">// Check if an offer is in the permissioned domain</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>[[nodiscard]] <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><a class="code hl_function" href="namespaceripple_1_1permissioned__dex.html#af80a77f3eafe3cbd4292e7af6e76c5b4">offerInDomain</a>(</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> ReadView <span class="keyword">const</span>&amp; view,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_typedef" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> <span class="keyword">const</span>&amp; offerID,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_typedef" href="namespaceripple.html#ae0ecc59d04defeab5f14f5dddbc694b7">Domain</a> <span class="keyword">const</span>&amp; domainID,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> j);</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="comment">// namespace permissioned_dex</span></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="comment">// namespace ripple</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#l00040">Journal.h:41</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_a00ae0d729cb3e35b6bcac9a27ebb5284"><div class="ttname"><a href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">ripple::AccountID</a></div><div class="ttdeci">base_uint&lt; 160, detail::AccountIDTag &gt; AccountID</div><div class="ttdoc">A 160-bit unsigned that uniquely identifies an account.</div><div class="ttdef"><b>Definition</b> <a href="AccountID_8h_source.html#l00029">AccountID.h:29</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#l00539">base_uint.h:539</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae0ecc59d04defeab5f14f5dddbc694b7"><div class="ttname"><a href="namespaceripple.html#ae0ecc59d04defeab5f14f5dddbc694b7">ripple::Domain</a></div><div class="ttdeci">base_uint&lt; 256 &gt; Domain</div><div class="ttdoc">Domain is a 256-bit hash representing a specific domain.</div><div class="ttdef"><b>Definition</b> <a href="UintTypes_8h_source.html#l00048">UintTypes.h:48</a></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>