ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-01-30 19:45:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/SignFor_8cpp_source.html
bthomee 9368c0d563 deploy: 5f638f5553
2026-01-28 10:13:01 -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: SignFor.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">SignFor.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/ledger/LedgerMaster.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpld/rpc/Context.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpld/rpc/detail/TransactionSign.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="preprocessor">#include &lt;xrpl/protocol/ErrorCodes.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/resource/Fees.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="comment">// {</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// tx_json: &lt;object&gt;,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// account: &lt;signing account&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// secret: &lt;secret of signing account&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// }</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="}">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a0c61538ea820449578f0f367c0a242bd"> 16</a></span><a class="code hl_function" href="namespacexrpl.html#a0c61538ea820449578f0f367c0a242bd">doSignFor</a>(<a class="code hl_struct" href="structxrpl_1_1RPC_1_1JsonContext.html">RPC::JsonContext</a>&amp; context)</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="keywordflow">if</span> (context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#aa793d4a228ce40b8c6dfc549b47e8334">role</a> != <a class="code hl_enumvalue" href="namespacexrpl.html#a7fb64528931ecb2e6dd4bdb6741bd1a7a73acd9a5972130b75066c82595a1fae3">Role::ADMIN</a> &amp;&amp; !context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#a3819425c846e53ec0f1bcfa7407df609">app</a>.<a class="code hl_function" href="classxrpl_1_1Application.html#a31c486ede7ae3b9c56c4c57bc696e3bf">config</a>().<a class="code hl_function" href="classxrpl_1_1Config.html#af157371e2cec213d30037e72154831fa">canSign</a>())</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacexrpl_1_1RPC.html#adacea89cc70d7238cdb1e5044c0d8932">RPC::make_error</a>(<a class="code hl_enumvalue" href="namespacexrpl.html#af6fadbc1b2101eff5fa78e7e2a50b76fa97873cc741794780ea5eef604550badc">rpcNOT_SUPPORTED</a>, <span class="stringliteral">&quot;Signing is not supported by this server.&quot;</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> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#a6ffe33d3c5b1974c798519eb84301dfa">loadType</a> = <a class="code hl_variable" href="namespacexrpl_1_1Resource.html#a356cf47ca4ba93250c9da2e4877fe7c9">Resource::feeHeavyBurdenRPC</a>;</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> failHard = context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1JsonContext.html#a30603f408d454be67d5250a62bf39287">params</a>[jss::fail_hard].<a class="code hl_function" href="classJson_1_1Value.html#ab693fb7b9b1595bb0adc49658bbf780d">asBool</a>();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">auto</span> <span class="keyword">const</span> failType = <a class="code hl_function" href="classxrpl_1_1NetworkOPs.html#a9878fdaa1c85d81ff65277097a564596">NetworkOPs::doFailHard</a>(failHard);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">auto</span> ret = <a class="code hl_function" href="namespacexrpl_1_1RPC.html#a84ab11a51011275dd3fefd0b5bf551c5">RPC::transactionSignFor</a>(</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1JsonContext.html#a30603f408d454be67d5250a62bf39287">params</a>,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#aa8b6cd5d5b9eb13f4a82b16979cbd3f0">apiVersion</a>,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> failType,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#aa793d4a228ce40b8c6dfc549b47e8334">role</a>,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#ac2b68abc7374eacb59cd93164ccdbc77">ledgerMaster</a>.<a class="code hl_function" href="classxrpl_1_1LedgerMaster.html#a1ad1683200cece5f01a0f7fa1c1e8920">getValidatedLedgerAge</a>(),</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> context.<a class="code hl_variable" href="structxrpl_1_1RPC_1_1Context.html#a3819425c846e53ec0f1bcfa7407df609">app</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> ret[jss::deprecated] =</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="stringliteral">&quot;This command has been deprecated and will be &quot;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="stringliteral">&quot;removed in a future version of the server. Please &quot;</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="stringliteral">&quot;migrate to a standalone signing tool.&quot;</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">return</span> ret;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>}</div>
</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</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_ab693fb7b9b1595bb0adc49658bbf780d"><div class="ttname"><a href="classJson_1_1Value.html#ab693fb7b9b1595bb0adc49658bbf780d">Json::Value::asBool</a></div><div class="ttdeci">bool asBool() const</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l00664">json_value.cpp:664</a></div></div>
<div class="ttc" id="aclassxrpl_1_1Application_html_a31c486ede7ae3b9c56c4c57bc696e3bf"><div class="ttname"><a href="classxrpl_1_1Application.html#a31c486ede7ae3b9c56c4c57bc696e3bf">xrpl::Application::config</a></div><div class="ttdeci">virtual Config &amp; config()=0</div></div>
<div class="ttc" id="aclassxrpl_1_1Config_html_af157371e2cec213d30037e72154831fa"><div class="ttname"><a href="classxrpl_1_1Config.html#af157371e2cec213d30037e72154831fa">xrpl::Config::canSign</a></div><div class="ttdeci">bool canSign() const</div><div class="ttdef"><b>Definition</b> <a href="Config_8h_source.html#l00324">Config.h:324</a></div></div>
<div class="ttc" id="aclassxrpl_1_1LedgerMaster_html_a1ad1683200cece5f01a0f7fa1c1e8920"><div class="ttname"><a href="classxrpl_1_1LedgerMaster.html#a1ad1683200cece5f01a0f7fa1c1e8920">xrpl::LedgerMaster::getValidatedLedgerAge</a></div><div class="ttdeci">std::chrono::seconds getValidatedLedgerAge()</div><div class="ttdef"><b>Definition</b> <a href="LedgerMaster_8cpp_source.html#l00156">LedgerMaster.cpp:156</a></div></div>
<div class="ttc" id="aclassxrpl_1_1NetworkOPs_html_a9878fdaa1c85d81ff65277097a564596"><div class="ttname"><a href="classxrpl_1_1NetworkOPs.html#a9878fdaa1c85d81ff65277097a564596">xrpl::NetworkOPs::doFailHard</a></div><div class="ttdeci">static FailHard doFailHard(bool noMeansDont)</div><div class="ttdef"><b>Definition</b> <a href="NetworkOPs_8h_source.html#l00076">NetworkOPs.h:76</a></div></div>
<div class="ttc" id="anamespacexrpl_1_1RPC_html_a84ab11a51011275dd3fefd0b5bf551c5"><div class="ttname"><a href="namespacexrpl_1_1RPC.html#a84ab11a51011275dd3fefd0b5bf551c5">xrpl::RPC::transactionSignFor</a></div><div class="ttdeci">Json::Value transactionSignFor(Json::Value jvRequest, unsigned apiVersion, NetworkOPs::FailHard failType, Role role, std::chrono::seconds validatedLedgerAge, Application &amp;app)</div><div class="ttdoc">Returns a Json::objectValue.</div><div class="ttdef"><b>Definition</b> <a href="TransactionSign_8cpp_source.html#l01037">TransactionSign.cpp:1037</a></div></div>
<div class="ttc" id="anamespacexrpl_1_1RPC_html_adacea89cc70d7238cdb1e5044c0d8932"><div class="ttname"><a href="namespacexrpl_1_1RPC.html#adacea89cc70d7238cdb1e5044c0d8932">xrpl::RPC::make_error</a></div><div class="ttdeci">Json::Value make_error(error_code_i code)</div><div class="ttdoc">Returns a new json object that reflects the error code.</div><div class="ttdef"><b>Definition</b> <a href="ErrorCodes_8cpp_source.html#l00190">ErrorCodes.cpp:190</a></div></div>
<div class="ttc" id="anamespacexrpl_1_1Resource_html_a356cf47ca4ba93250c9da2e4877fe7c9"><div class="ttname"><a href="namespacexrpl_1_1Resource.html#a356cf47ca4ba93250c9da2e4877fe7c9">xrpl::Resource::feeHeavyBurdenRPC</a></div><div class="ttdeci">Charge const feeHeavyBurdenRPC</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_a0c61538ea820449578f0f367c0a242bd"><div class="ttname"><a href="namespacexrpl.html#a0c61538ea820449578f0f367c0a242bd">xrpl::doSignFor</a></div><div class="ttdeci">Json::Value doSignFor(RPC::JsonContext &amp;)</div><div class="ttdef"><b>Definition</b> <a href="SignFor_8cpp_source.html#l00016">SignFor.cpp:16</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a7fb64528931ecb2e6dd4bdb6741bd1a7a73acd9a5972130b75066c82595a1fae3"><div class="ttname"><a href="namespacexrpl.html#a7fb64528931ecb2e6dd4bdb6741bd1a7a73acd9a5972130b75066c82595a1fae3">xrpl::Role::ADMIN</a></div><div class="ttdeci">@ ADMIN</div></div>
<div class="ttc" id="anamespacexrpl_html_af6fadbc1b2101eff5fa78e7e2a50b76fa97873cc741794780ea5eef604550badc"><div class="ttname"><a href="namespacexrpl.html#af6fadbc1b2101eff5fa78e7e2a50b76fa97873cc741794780ea5eef604550badc">xrpl::rpcNOT_SUPPORTED</a></div><div class="ttdeci">@ rpcNOT_SUPPORTED</div><div class="ttdef"><b>Definition</b> <a href="ErrorCodes_8h_source.html#l00113">ErrorCodes.h:113</a></div></div>
<div class="ttc" id="astructxrpl_1_1RPC_1_1Context_html_a3819425c846e53ec0f1bcfa7407df609"><div class="ttname"><a href="structxrpl_1_1RPC_1_1Context.html#a3819425c846e53ec0f1bcfa7407df609">xrpl::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="astructxrpl_1_1RPC_1_1Context_html_a6ffe33d3c5b1974c798519eb84301dfa"><div class="ttname"><a href="structxrpl_1_1RPC_1_1Context.html#a6ffe33d3c5b1974c798519eb84301dfa">xrpl::RPC::Context::loadType</a></div><div class="ttdeci">Resource::Charge &amp; loadType</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00023">Context.h:23</a></div></div>
<div class="ttc" id="astructxrpl_1_1RPC_1_1Context_html_aa793d4a228ce40b8c6dfc549b47e8334"><div class="ttname"><a href="structxrpl_1_1RPC_1_1Context.html#aa793d4a228ce40b8c6dfc549b47e8334">xrpl::RPC::Context::role</a></div><div class="ttdeci">Role role</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00027">Context.h:27</a></div></div>
<div class="ttc" id="astructxrpl_1_1RPC_1_1Context_html_aa8b6cd5d5b9eb13f4a82b16979cbd3f0"><div class="ttname"><a href="structxrpl_1_1RPC_1_1Context.html#aa8b6cd5d5b9eb13f4a82b16979cbd3f0">xrpl::RPC::Context::apiVersion</a></div><div class="ttdeci">unsigned int apiVersion</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00030">Context.h:30</a></div></div>
<div class="ttc" id="astructxrpl_1_1RPC_1_1Context_html_ac2b68abc7374eacb59cd93164ccdbc77"><div class="ttname"><a href="structxrpl_1_1RPC_1_1Context.html#ac2b68abc7374eacb59cd93164ccdbc77">xrpl::RPC::Context::ledgerMaster</a></div><div class="ttdeci">LedgerMaster &amp; ledgerMaster</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00025">Context.h:25</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