ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-01-30 11:35:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/ValidationCreate_8cpp_source.html
bthomee 9368c0d563 deploy: 5f638f5553
2026-01-28 10:13:01 -08:00

162 lines
20 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: ValidationCreate.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">ValidationCreate.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/rpc/Context.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/protocol/ErrorCodes.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/protocol/RPCErr.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/protocol/Seed.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.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="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;Seed&gt;</a></div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="}">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="namespacexrpl.html#af8e2c9d07216971778fa75669e575078"> 11</a></span><a class="code hl_function" href="namespacexrpl.html#af8e2c9d07216971778fa75669e575078">validationSeed</a>(<a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>&amp; params)</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="keywordflow">if</span> (!params.<a class="code hl_function" href="classJson_1_1Value.html#abfa90c81f6aee7877bd5fb4c8445994f">isMember</a>(jss::secret))</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacexrpl.html#a3033bd0e389803bef7b517d074676238">randomSeed</a>();</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="keywordflow">return</span> <a class="code hl_function" href="namespacexrpl.html#af75cbde7dc484b554349f5456de92cc5">parseGenericSeed</a>(params[jss::secret].asString());</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>}</div>
</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// {</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// secret: &lt;string&gt; // optional</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// }</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">//</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">// This command requires Role::ADMIN access because it makes</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">// no sense to ask an untrusted server for this.</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="foldopen" id="foldopen00026" data-start="{" data-end="}">
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a199d48806b570cca89ea88fbdf33a1c8"> 26</a></span><a class="code hl_function" href="namespacexrpl.html#a199d48806b570cca89ea88fbdf33a1c8">doValidationCreate</a>(<a class="code hl_struct" href="structxrpl_1_1RPC_1_1JsonContext.html">RPC::JsonContext</a>&amp; context)</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> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> obj(<a class="code hl_enumvalue" href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a>);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">auto</span> seed = <a class="code hl_function" href="namespacexrpl.html#af8e2c9d07216971778fa75669e575078">validationSeed</a>(context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1JsonContext.html#a30603f408d454be67d5250a62bf39287">params</a>);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">if</span> (!seed)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacexrpl.html#ab2aea6659695e209e9affb77e421f43e">rpcError</a>(<a class="code hl_enumvalue" href="namespacexrpl.html#af6fadbc1b2101eff5fa78e7e2a50b76fabddd93a232dbbed0e23b40ae9a2199cc">rpcBAD_SEED</a>);</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="keyword">auto</span> <span class="keyword">const</span> private_key = <a class="code hl_function" href="namespacexrpl.html#a5a49ad0145292d1ff0db4490c5521051">generateSecretKey</a>(<a class="code hl_enumvalue" href="namespacexrpl.html#a0b0d50fcc4520f33b4417f1b74eee591a82c2b7829b8129e5a2d53665ba4b4757">KeyType::secp256k1</a>, *seed);</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> obj[jss::validation_public_key] = <a class="code hl_function" href="namespacexrpl.html#a4e17e8237bc800415c303501c667baeb">toBase58</a>(<a class="code hl_enumvalue" href="namespacexrpl.html#ab0ad02fb9cdef90852b93f1b57aacdc1ac3fe5edb1f8a81a8e585f6a27c120be6">TokenType::NodePublic</a>, <a class="code hl_function" href="namespacexrpl.html#a19293e3ab4c454b24b8b7874614062c8">derivePublicKey</a>(<a class="code hl_enumvalue" href="namespacexrpl.html#a0b0d50fcc4520f33b4417f1b74eee591a82c2b7829b8129e5a2d53665ba4b4757">KeyType::secp256k1</a>, private_key));</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> obj[jss::validation_private_key] = <a class="code hl_function" href="namespacexrpl.html#a4e17e8237bc800415c303501c667baeb">toBase58</a>(<a class="code hl_enumvalue" href="namespacexrpl.html#ab0ad02fb9cdef90852b93f1b57aacdc1a5cc5482a0278b704175b383ee922954a">TokenType::NodePrivate</a>, private_key);</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> obj[jss::validation_seed] = <a class="code hl_function" href="namespacexrpl.html#a4e17e8237bc800415c303501c667baeb">toBase58</a>(*seed);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> obj[jss::validation_key] = <a class="code hl_function" href="namespacexrpl.html#a5db3fe998c420da3e35d254bf21833e3">seedAs1751</a>(*seed);</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> obj;</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> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>} <span class="comment">// namespace xrpl</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="aclassJson_1_1Value_html_abfa90c81f6aee7877bd5fb4c8445994f"><div class="ttname"><a href="classJson_1_1Value.html#abfa90c81f6aee7877bd5fb4c8445994f">Json::Value::isMember</a></div><div class="ttdeci">bool isMember(char const *key) const</div><div class="ttdoc">Return true if the object has a member named key.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l00978">json_value.cpp:978</a></div></div>
<div class="ttc" id="anamespaceJson_html_a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6"><div class="ttname"><a href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a></div><div class="ttdeci">@ objectValue</div><div class="ttdoc">object value (collection of name/value pairs).</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00028">json_value.h:27</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="anamespacexrpl_html_a0b0d50fcc4520f33b4417f1b74eee591a82c2b7829b8129e5a2d53665ba4b4757"><div class="ttname"><a href="namespacexrpl.html#a0b0d50fcc4520f33b4417f1b74eee591a82c2b7829b8129e5a2d53665ba4b4757">xrpl::KeyType::secp256k1</a></div><div class="ttdeci">@ secp256k1</div></div>
<div class="ttc" id="anamespacexrpl_html_a19293e3ab4c454b24b8b7874614062c8"><div class="ttname"><a href="namespacexrpl.html#a19293e3ab4c454b24b8b7874614062c8">xrpl::derivePublicKey</a></div><div class="ttdeci">PublicKey derivePublicKey(KeyType type, SecretKey const &amp;sk)</div><div class="ttdoc">Derive the public key from a secret key.</div><div class="ttdef"><b>Definition</b> <a href="SecretKey_8cpp_source.html#l00300">SecretKey.cpp:300</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a199d48806b570cca89ea88fbdf33a1c8"><div class="ttname"><a href="namespacexrpl.html#a199d48806b570cca89ea88fbdf33a1c8">xrpl::doValidationCreate</a></div><div class="ttdeci">Json::Value doValidationCreate(RPC::JsonContext &amp;)</div><div class="ttdef"><b>Definition</b> <a href="ValidationCreate_8cpp_source.html#l00026">ValidationCreate.cpp:26</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a3033bd0e389803bef7b517d074676238"><div class="ttname"><a href="namespacexrpl.html#a3033bd0e389803bef7b517d074676238">xrpl::randomSeed</a></div><div class="ttdeci">Seed randomSeed()</div><div class="ttdoc">Create a seed using secure random numbers.</div><div class="ttdef"><b>Definition</b> <a href="Seed_8cpp_source.html#l00047">Seed.cpp:47</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a4e17e8237bc800415c303501c667baeb"><div class="ttname"><a href="namespacexrpl.html#a4e17e8237bc800415c303501c667baeb">xrpl::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#l00092">AccountID.cpp:92</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a5a49ad0145292d1ff0db4490c5521051"><div class="ttname"><a href="namespacexrpl.html#a5a49ad0145292d1ff0db4490c5521051">xrpl::generateSecretKey</a></div><div class="ttdeci">SecretKey generateSecretKey(KeyType type, Seed const &amp;seed)</div><div class="ttdoc">Generate a new secret key deterministically.</div><div class="ttdef"><b>Definition</b> <a href="SecretKey_8cpp_source.html#l00278">SecretKey.cpp:278</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a5db3fe998c420da3e35d254bf21833e3"><div class="ttname"><a href="namespacexrpl.html#a5db3fe998c420da3e35d254bf21833e3">xrpl::seedAs1751</a></div><div class="ttdeci">std::string seedAs1751(Seed const &amp;seed)</div><div class="ttdoc">Encode a Seed in RFC1751 format.</div><div class="ttdef"><b>Definition</b> <a href="Seed_8cpp_source.html#l00114">Seed.cpp:114</a></div></div>
<div class="ttc" id="anamespacexrpl_html_ab0ad02fb9cdef90852b93f1b57aacdc1a5cc5482a0278b704175b383ee922954a"><div class="ttname"><a href="namespacexrpl.html#ab0ad02fb9cdef90852b93f1b57aacdc1a5cc5482a0278b704175b383ee922954a">xrpl::TokenType::NodePrivate</a></div><div class="ttdeci">@ NodePrivate</div></div>
<div class="ttc" id="anamespacexrpl_html_ab0ad02fb9cdef90852b93f1b57aacdc1ac3fe5edb1f8a81a8e585f6a27c120be6"><div class="ttname"><a href="namespacexrpl.html#ab0ad02fb9cdef90852b93f1b57aacdc1ac3fe5edb1f8a81a8e585f6a27c120be6">xrpl::TokenType::NodePublic</a></div><div class="ttdeci">@ NodePublic</div></div>
<div class="ttc" id="anamespacexrpl_html_ab2aea6659695e209e9affb77e421f43e"><div class="ttname"><a href="namespacexrpl.html#ab2aea6659695e209e9affb77e421f43e">xrpl::rpcError</a></div><div class="ttdeci">Json::Value rpcError(error_code_i iError)</div><div class="ttdef"><b>Definition</b> <a href="RPCErr_8cpp_source.html#l00012">RPCErr.cpp:12</a></div></div>
<div class="ttc" id="anamespacexrpl_html_af6fadbc1b2101eff5fa78e7e2a50b76fabddd93a232dbbed0e23b40ae9a2199cc"><div class="ttname"><a href="namespacexrpl.html#af6fadbc1b2101eff5fa78e7e2a50b76fabddd93a232dbbed0e23b40ae9a2199cc">xrpl::rpcBAD_SEED</a></div><div class="ttdeci">@ rpcBAD_SEED</div><div class="ttdef"><b>Definition</b> <a href="ErrorCodes_8h_source.html#l00080">ErrorCodes.h:80</a></div></div>
<div class="ttc" id="anamespacexrpl_html_af75cbde7dc484b554349f5456de92cc5"><div class="ttname"><a href="namespacexrpl.html#af75cbde7dc484b554349f5456de92cc5">xrpl::parseGenericSeed</a></div><div class="ttdeci">std::optional&lt; Seed &gt; parseGenericSeed(std::string const &amp;str, bool rfc1751=true)</div><div class="ttdoc">Attempt to parse a string as a seed.</div><div class="ttdef"><b>Definition</b> <a href="Seed_8cpp_source.html#l00078">Seed.cpp:78</a></div></div>
<div class="ttc" id="anamespacexrpl_html_af8e2c9d07216971778fa75669e575078"><div class="ttname"><a href="namespacexrpl.html#af8e2c9d07216971778fa75669e575078">xrpl::validationSeed</a></div><div class="ttdeci">static std::optional&lt; Seed &gt; validationSeed(Json::Value const &amp;params)</div><div class="ttdef"><b>Definition</b> <a href="ValidationCreate_8cpp_source.html#l00011">ValidationCreate.cpp:11</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="astructxrpl_1_1RPC_1_1JsonContext_html"><div class="ttname"><a href="structxrpl_1_1RPC_1_1JsonContext.html">xrpl::RPC::JsonContext</a></div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00033">Context.h:34</a></div></div>
<div class="ttc" id="astructxrpl_1_1RPC_1_1JsonContext_html_a30603f408d454be67d5250a62bf39287"><div class="ttname"><a href="structxrpl_1_1RPC_1_1JsonContext.html#a30603f408d454be67d5250a62bf39287">xrpl::RPC::JsonContext::params</a></div><div class="ttdeci">Json::Value params</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00044">Context.h:44</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