ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/permissioned__domains_8h_source.html
bthomee 7ca054b7d3 deploy: 3b810c305a
2025-11-10 09:36:27 -08:00

167 lines
21 KiB
HTML
Raw Permalink Blame History

<!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: permissioned_domains.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_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">permissioned_domains.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">#ifndef XRPL_TEST_JTX_PERMISSIONED_DOMAINS_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TEST_JTX_PERMISSIONED_DOMAINS_H_INCLUDED</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="preprocessor">#include &lt;test/jtx/Account.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;test/jtx/Env.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;test/jtx/deposit.h&gt;</span></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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span>test {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span>jtx {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span>pdomain {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// Helpers for PermissionedDomains testing</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#ad603213c94b4a2fce2b211294cdc6d7f"> 14</a></span><span class="keyword">using </span><a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1deposit_1_1AuthorizeCredentials.html">Credential</a> = <a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1deposit_1_1AuthorizeCredentials.html">ripple::test::jtx::deposit::AuthorizeCredentials</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a98fd2489d3c9c83c22d1755a3c5032fe"> 15</a></span><span class="keyword">using </span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Credentials</a> = <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;Credential&gt;</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// helpers</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// Make json for PermissionedDomainSet transaction</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#aa0fac6b0470e763cd0fa2fb314460ac5">setTx</a>(</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</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="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Credentials</a> <span class="keyword">const</span>&amp; credentials,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;uint256&gt;</a> <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1domain.html">domain</a> = <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">// Make json for PermissionedDomainDelete transaction</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#aa070858e5515fcd524a4781a29ffa293">deleteTx</a>(<a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; account, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1domain.html">domain</a>);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">// Get PermissionedDomain objects from account_objects rpc call</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map&lt;uint256, Json::Value&gt;</a></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#ad25d486c469428f0a3d10ba2b9ea09a6">getObjects</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <span class="keyword">const</span>&amp; account, <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&amp; env, <span class="keywordtype">bool</span> withType = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">// Check if ledger object is there</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keywordtype">bool</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a54b6ec39d419cea69ead03dcf2bb72ef">objectExists</a>(<a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; objID, <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&amp; env);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">// Extract credentials from account_object object</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Credentials</a></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a4f49b60aaee303add781150062130606">credentialsFromJson</a>(</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>&amp; <span class="keywordtype">object</span>,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map&lt;std::string, Account&gt;</a> <span class="keyword">const</span>&amp; human2Acc);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// Sort credentials the same way as PermissionedDomainSet</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Credentials</a></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a368ec67b9f4032393e0122ef8f44f8de">sortCredentials</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">Credentials</a> <span class="keyword">const</span>&amp; input);</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">// Get newly created domain from transaction metadata.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#af1f0005d8e17536dd1183a22df3f60f6">getNewDomain</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STObject const&gt;</a> <span class="keyword">const</span>&amp; meta);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>} <span class="comment">// namespace pdomain</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>} <span class="comment">// namespace jtx</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace test</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></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="aclassripple_1_1test_1_1jtx_1_1Account_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Account.html">ripple::test::jtx::Account</a></div><div class="ttdoc">Immutable cryptographic account descriptor.</div><div class="ttdef"><b>Definition</b> <a href="Account_8h_source.html#l00019">Account.h:20</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html">ripple::test::jtx::Env</a></div><div class="ttdoc">A transaction testing environment.</div><div class="ttdef"><b>Definition</b> <a href="Env_8h_source.html#l00101">Env.h:102</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1domain_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1domain.html">ripple::test::jtx::domain</a></div><div class="ttdoc">Set the domain on a JTx.</div><div class="ttdef"><b>Definition</b> <a href="domain_8h_source.html#l00010">domain.h:11</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="amap_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_a368ec67b9f4032393e0122ef8f44f8de"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a368ec67b9f4032393e0122ef8f44f8de">ripple::test::jtx::pdomain::sortCredentials</a></div><div class="ttdeci">Credentials sortCredentials(Credentials const &amp;input)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00127">permissioned_domains.cpp:127</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_a4f49b60aaee303add781150062130606"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a4f49b60aaee303add781150062130606">ripple::test::jtx::pdomain::credentialsFromJson</a></div><div class="ttdeci">Credentials credentialsFromJson(Json::Value const &amp;object, std::unordered_map&lt; std::string, Account &gt; const &amp;human2Acc)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00103">permissioned_domains.cpp:103</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_a54b6ec39d419cea69ead03dcf2bb72ef"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#a54b6ec39d419cea69ead03dcf2bb72ef">ripple::test::jtx::pdomain::objectExists</a></div><div class="ttdeci">bool objectExists(uint256 const &amp;objID, Env &amp;env)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00081">permissioned_domains.cpp:81</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_aa070858e5515fcd524a4781a29ffa293"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#aa070858e5515fcd524a4781a29ffa293">ripple::test::jtx::pdomain::deleteTx</a></div><div class="ttdeci">Json::Value deleteTx(AccountID const &amp;account, uint256 const &amp;domain)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00036">permissioned_domains.cpp:36</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_aa0fac6b0470e763cd0fa2fb314460ac5"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#aa0fac6b0470e763cd0fa2fb314460ac5">ripple::test::jtx::pdomain::setTx</a></div><div class="ttdeci">Json::Value setTx(AccountID const &amp;account, Credentials const &amp;credentials, std::optional&lt; uint256 &gt; domain)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00011">permissioned_domains.cpp:11</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_ad25d486c469428f0a3d10ba2b9ea09a6"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#ad25d486c469428f0a3d10ba2b9ea09a6">ripple::test::jtx::pdomain::getObjects</a></div><div class="ttdeci">std::map&lt; uint256, Json::Value &gt; getObjects(Account const &amp;account, Env &amp;env, bool withType)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00047">permissioned_domains.cpp:47</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1pdomain_html_af1f0005d8e17536dd1183a22df3f60f6"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1pdomain.html#af1f0005d8e17536dd1183a22df3f60f6">ripple::test::jtx::pdomain::getNewDomain</a></div><div class="ttdeci">uint256 getNewDomain(std::shared_ptr&lt; STObject const &gt; const &amp;meta)</div><div class="ttdef"><b>Definition</b> <a href="permissioned__domains_8cpp_source.html#l00136">permissioned_domains.cpp:136</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="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1deposit_1_1AuthorizeCredentials_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1deposit_1_1AuthorizeCredentials.html">ripple::test::jtx::deposit::AuthorizeCredentials</a></div><div class="ttdef"><b>Definition</b> <a href="deposit_8h_source.html#l00022">deposit.h:23</a></div></div>
<div class="ttc" id="aunordered_map_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</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>
Reference in New Issue View Git Blame Copy Permalink