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

155 lines
19 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: ValidatorInfo.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_42b876eb66f74e25995e23a7c0222dc7.html">rpc</a></li><li class="navelem"><a class="el" href="dir_202f05fcc82d395fac3f43e301f5a49f.html">handlers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ValidatorInfo.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="comment">// Copyright (c) 2019 Dev Null Productions</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;xrpld/app/main/Application.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/misc/ValidatorKeys.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpld/rpc/Context.h&gt;</span></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="preprocessor">#include &lt;xrpl/basics/base64.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpl/json/json_value.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;xrpl/protocol/ErrorCodes.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="}">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="namespaceripple.html#ab824f1e0112d4341786e8df4e6944978"> 14</a></span><a class="code hl_function" href="namespaceripple.html#ab824f1e0112d4341786e8df4e6944978">doValidatorInfo</a>(<a class="code hl_struct" href="structripple_1_1RPC_1_1JsonContext.html">RPC::JsonContext</a>&amp; context)</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// return error if not configured as validator</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">auto</span> <span class="keyword">const</span> validationPK = context.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">app</a>.<a class="code hl_function" href="classripple_1_1Application.html#aa1e13241445bc4b53c9a2aedc0617131">getValidationPublicKey</a>();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keywordflow">if</span> (!validationPK)</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple_1_1RPC.html#a711d9d7325b0ccd758453fcbea4c524f">RPC::not_validator_error</a>();</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> ret;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// assume validationPK is ephemeral key, get master key</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">auto</span> <span class="keyword">const</span> mk =</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> context.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">app</a>.<a class="code hl_function" href="classripple_1_1Application.html#ab2c828cd4eea02429a8251fc24d2d0b6">validatorManifests</a>().<a class="code hl_function" href="classripple_1_1ManifestCache.html#adbe8167cfd5ac328a9bf8b85c319ddc1">getMasterKey</a>(*validationPK);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> ret[jss::master_key] = <a class="code hl_function" href="namespaceripple.html#a08a13b62b18272366f788632359e8793">toBase58</a>(<a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6">TokenType::NodePublic</a>, mk);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// validationPK is master key, this implies that there is no ephemeral</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// key, no manifest, hence return</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">if</span> (mk == validationPK)</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">return</span> ret;</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> ret[jss::ephemeral_key] = <a class="code hl_function" href="namespaceripple.html#a08a13b62b18272366f788632359e8793">toBase58</a>(<a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6">TokenType::NodePublic</a>, *validationPK);</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">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span> <a class="code hl_enumvalue" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bda7f5cb74af5d7f4b82200738fdbdc5a45">manifest</a> = context.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">app</a>.<a class="code hl_function" href="classripple_1_1Application.html#ab2c828cd4eea02429a8251fc24d2d0b6">validatorManifests</a>().<a class="code hl_function" href="classripple_1_1ManifestCache.html#a4fd705df2aded2766ea1e5a98eb0ca74">getManifest</a>(mk))</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ret[jss::manifest] = <a class="code hl_function" href="namespaceripple.html#a9e4e400df889dc7cb9df0f859a8e4f18">base64_encode</a>(*<a class="code hl_enumvalue" href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bda7f5cb74af5d7f4b82200738fdbdc5a45">manifest</a>);</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="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span> seq = context.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">app</a>.<a class="code hl_function" href="classripple_1_1Application.html#ab2c828cd4eea02429a8251fc24d2d0b6">validatorManifests</a>().<a class="code hl_function" href="classripple_1_1ManifestCache.html#a093d015f0c2d38111f217ab167a3973d">getSequence</a>(mk))</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> ret[jss::seq] = *seq;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span> domain = context.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">app</a>.<a class="code hl_function" href="classripple_1_1Application.html#ab2c828cd4eea02429a8251fc24d2d0b6">validatorManifests</a>().<a class="code hl_function" href="classripple_1_1ManifestCache.html#ae3996fe85083b04c4f568cd527a84dc8">getDomain</a>(mk))</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> ret[jss::domain] = *domain;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> ret;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>}</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>} <span class="comment">// namespace ripple</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_1Application_html_aa1e13241445bc4b53c9a2aedc0617131"><div class="ttname"><a href="classripple_1_1Application.html#aa1e13241445bc4b53c9a2aedc0617131">ripple::Application::getValidationPublicKey</a></div><div class="ttdeci">virtual std::optional&lt; PublicKey const &gt; getValidationPublicKey() const =0</div></div>
<div class="ttc" id="aclassripple_1_1Application_html_ab2c828cd4eea02429a8251fc24d2d0b6"><div class="ttname"><a href="classripple_1_1Application.html#ab2c828cd4eea02429a8251fc24d2d0b6">ripple::Application::validatorManifests</a></div><div class="ttdeci">virtual ManifestCache &amp; validatorManifests()=0</div></div>
<div class="ttc" id="aclassripple_1_1ManifestCache_html_a093d015f0c2d38111f217ab167a3973d"><div class="ttname"><a href="classripple_1_1ManifestCache.html#a093d015f0c2d38111f217ab167a3973d">ripple::ManifestCache::getSequence</a></div><div class="ttdeci">std::optional&lt; std::uint32_t &gt; getSequence(PublicKey const &amp;pk) const</div><div class="ttdoc">Returns master key's current manifest sequence.</div><div class="ttdef"><b>Definition</b> <a href="Manifest_8cpp_source.html#l00316">Manifest.cpp:316</a></div></div>
<div class="ttc" id="aclassripple_1_1ManifestCache_html_a4fd705df2aded2766ea1e5a98eb0ca74"><div class="ttname"><a href="classripple_1_1ManifestCache.html#a4fd705df2aded2766ea1e5a98eb0ca74">ripple::ManifestCache::getManifest</a></div><div class="ttdeci">std::optional&lt; std::string &gt; getManifest(PublicKey const &amp;pk) const</div><div class="ttdoc">Returns mainfest corresponding to a given public key.</div><div class="ttdef"><b>Definition</b> <a href="Manifest_8cpp_source.html#l00340">Manifest.cpp:340</a></div></div>
<div class="ttc" id="aclassripple_1_1ManifestCache_html_adbe8167cfd5ac328a9bf8b85c319ddc1"><div class="ttname"><a href="classripple_1_1ManifestCache.html#adbe8167cfd5ac328a9bf8b85c319ddc1">ripple::ManifestCache::getMasterKey</a></div><div class="ttdeci">PublicKey getMasterKey(PublicKey const &amp;pk) const</div><div class="ttdoc">Returns ephemeral signing key's master public key.</div><div class="ttdef"><b>Definition</b> <a href="Manifest_8cpp_source.html#l00304">Manifest.cpp:304</a></div></div>
<div class="ttc" id="aclassripple_1_1ManifestCache_html_ae3996fe85083b04c4f568cd527a84dc8"><div class="ttname"><a href="classripple_1_1ManifestCache.html#ae3996fe85083b04c4f568cd527a84dc8">ripple::ManifestCache::getDomain</a></div><div class="ttdeci">std::optional&lt; std::string &gt; getDomain(PublicKey const &amp;pk) const</div><div class="ttdoc">Returns domain claimed by a given public key.</div><div class="ttdef"><b>Definition</b> <a href="Manifest_8cpp_source.html#l00328">Manifest.cpp:328</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a711d9d7325b0ccd758453fcbea4c524f"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a711d9d7325b0ccd758453fcbea4c524f">ripple::RPC::not_validator_error</a></div><div class="ttdeci">Json::Value not_validator_error()</div><div class="ttdef"><b>Definition</b> <a href="ErrorCodes_8h_source.html#l00342">ErrorCodes.h:342</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_a08a13b62b18272366f788632359e8793"><div class="ttname"><a href="namespaceripple.html#a08a13b62b18272366f788632359e8793">ripple::toBase58</a></div><div class="ttdeci">std::string toBase58(AccountID const &amp;v)</div><div class="ttdoc">Convert AccountID to base58 checked string.</div><div class="ttdef"><b>Definition</b> <a href="AccountID_8cpp_source.html#l00095">AccountID.cpp:95</a></div></div>
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6">ripple::TokenType::NodePublic</a></div><div class="ttdeci">@ NodePublic</div></div>
<div class="ttc" id="anamespaceripple_html_a9e4e400df889dc7cb9df0f859a8e4f18"><div class="ttname"><a href="namespaceripple.html#a9e4e400df889dc7cb9df0f859a8e4f18">ripple::base64_encode</a></div><div class="ttdeci">std::string base64_encode(std::uint8_t const *data, std::size_t len)</div><div class="ttdef"><b>Definition</b> <a href="libxrpl_2basics_2base64_8cpp_source.html#l00217">libxrpl/basics/base64.cpp:217</a></div></div>
<div class="ttc" id="anamespaceripple_html_ab824f1e0112d4341786e8df4e6944978"><div class="ttname"><a href="namespaceripple.html#ab824f1e0112d4341786e8df4e6944978">ripple::doValidatorInfo</a></div><div class="ttdeci">Json::Value doValidatorInfo(RPC::JsonContext &amp;)</div><div class="ttdef"><b>Definition</b> <a href="ValidatorInfo_8cpp_source.html#l00014">ValidatorInfo.cpp:14</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad5143ceada01141772ae4aab984f94bda7f5cb74af5d7f4b82200738fdbdc5a45"><div class="ttname"><a href="namespaceripple.html#ad5143ceada01141772ae4aab984f94bda7f5cb74af5d7f4b82200738fdbdc5a45">ripple::HashPrefix::manifest</a></div><div class="ttdeci">@ manifest</div><div class="ttdoc">Manifest.</div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Context_html_a7878751d68ed7fd43c385913c5e6ff04"><div class="ttname"><a href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">ripple::RPC::Context::app</a></div><div class="ttdeci">Application &amp; app</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00022">Context.h:22</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_html"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext.html">ripple::RPC::JsonContext</a></div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00033">Context.h:34</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