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

138 lines
14 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: sig.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_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li><li class="navelem"><a class="el" href="dir_b6e1af3af959840d44bdaef0b719b3f9.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">sig.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;test/jtx/sig.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;test/jtx/utility.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="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span>test {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span>jtx {</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="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="}">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classxrpl_1_1test_1_1jtx_1_1sig.html#ac8611a33d98a111882586ad8453f26da"> 9</a></span><a class="code hl_function" href="classxrpl_1_1test_1_1jtx_1_1sig.html#ac8611a33d98a111882586ad8453f26da">sig::operator()</a>(<a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Env.html">Env</a>&amp;, <a class="code hl_struct" href="structxrpl_1_1test_1_1jtx_1_1JTx.html">JTx</a>&amp; jt)<span class="keyword"> const</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classxrpl_1_1test_1_1jtx_1_1sig.html#a437dbf73e7b8a8c9c3791564ae90ca35">manual_</a>)</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classxrpl_1_1test_1_1jtx_1_1sig.html#a91ac14018602c71c2fcd9a16644fbeb3">subField_</a>)</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> jt.<a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1JTx.html#a6358d3f44d7bf9c01e03353ad1ee7d56">fill_sig</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classxrpl_1_1test_1_1jtx_1_1sig.html#aefeb0e6a8e7b538775bf75ab02c7beb2">account_</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">// VFALCO Inefficient pre-C++14</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">auto</span> <span class="keyword">const</span> account = *<a class="code hl_variable" href="classxrpl_1_1test_1_1jtx_1_1sig.html#aefeb0e6a8e7b538775bf75ab02c7beb2">account_</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">auto</span> callback = [subField = <a class="code hl_variable" href="classxrpl_1_1test_1_1jtx_1_1sig.html#a91ac14018602c71c2fcd9a16644fbeb3">subField_</a>, account](<a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Env.html">Env</a>&amp;, <a class="code hl_struct" href="structxrpl_1_1test_1_1jtx_1_1JTx.html">JTx</a>&amp; jtx) {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Where to put the signature. Supports sfCounterPartySignature.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">auto</span>&amp; sigObject = subField ? jtx[*subField] : jtx.jv;</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> <a class="code hl_function" href="namespacexrpl_1_1test_1_1jtx.html#a96748feb48e6d4b340cfac3c8749ddbf">jtx::sign</a>(jtx.jv, account, sigObject);</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="keywordflow">if</span> (!<a class="code hl_variable" href="classxrpl_1_1test_1_1jtx_1_1sig.html#a91ac14018602c71c2fcd9a16644fbeb3">subField_</a>)</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> jt.<a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1JTx.html#a87d8ee966e2ac9415ebad0d2abfe5b04">mainSigners</a>.emplace_back(callback);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> jt.<a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1JTx.html#a7f49353106b6fa747077a153dac95088">postSigners</a>.emplace_back(callback);</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>}</div>
</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="comment">// namespace jtx</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>} <span class="comment">// namespace test</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1Env.html">xrpl::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#l00097">Env.h:98</a></div></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1sig_html_a437dbf73e7b8a8c9c3791564ae90ca35"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1sig.html#a437dbf73e7b8a8c9c3791564ae90ca35">xrpl::test::jtx::sig::manual_</a></div><div class="ttdeci">bool manual_</div><div class="ttdef"><b>Definition</b> <a href="sig_8h_source.html#l00018">sig.h:18</a></div></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1sig_html_a91ac14018602c71c2fcd9a16644fbeb3"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1sig.html#a91ac14018602c71c2fcd9a16644fbeb3">xrpl::test::jtx::sig::subField_</a></div><div class="ttdeci">SField const *const subField_</div><div class="ttdoc">Alternative transaction object field in which to place the signature.</div><div class="ttdef"><b>Definition</b> <a href="sig_8h_source.html#l00023">sig.h:23</a></div></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1sig_html_ac8611a33d98a111882586ad8453f26da"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1sig.html#ac8611a33d98a111882586ad8453f26da">xrpl::test::jtx::sig::operator()</a></div><div class="ttdeci">void operator()(Env &amp;, JTx &amp;jt) const</div><div class="ttdef"><b>Definition</b> <a href="sig_8cpp_source.html#l00009">sig.cpp:9</a></div></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1sig_html_aefeb0e6a8e7b538775bf75ab02c7beb2"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1sig.html#aefeb0e6a8e7b538775bf75ab02c7beb2">xrpl::test::jtx::sig::account_</a></div><div class="ttdeci">std::optional&lt; Account &gt; account_</div><div class="ttdoc">Account that will generate the signature.</div><div class="ttdef"><b>Definition</b> <a href="sig_8h_source.html#l00029">sig.h:29</a></div></div>
<div class="ttc" id="anamespacexrpl_1_1test_1_1jtx_html_a96748feb48e6d4b340cfac3c8749ddbf"><div class="ttname"><a href="namespacexrpl_1_1test_1_1jtx.html#a96748feb48e6d4b340cfac3c8749ddbf">xrpl::test::jtx::sign</a></div><div class="ttdeci">void sign(Json::Value &amp;jv, Account const &amp;account, Json::Value &amp;sigObject)</div><div class="ttdoc">Sign automatically into a specific Json field of the jv object.</div><div class="ttdef"><b>Definition</b> <a href="utility_8cpp_source.html#l00027">utility.cpp: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="astructxrpl_1_1test_1_1jtx_1_1JTx_html"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1JTx.html">xrpl::test::jtx::JTx</a></div><div class="ttdoc">Execution context for applying a JSON transaction.</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00025">JTx.h:26</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1JTx_html_a6358d3f44d7bf9c01e03353ad1ee7d56"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1JTx.html#a6358d3f44d7bf9c01e03353ad1ee7d56">xrpl::test::jtx::JTx::fill_sig</a></div><div class="ttdeci">bool fill_sig</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00034">JTx.h:34</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1JTx_html_a7f49353106b6fa747077a153dac95088"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1JTx.html#a7f49353106b6fa747077a153dac95088">xrpl::test::jtx::JTx::postSigners</a></div><div class="ttdeci">std::vector&lt; std::function&lt; void(Env &amp;, JTx &amp;)&gt; &gt; postSigners</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00041">JTx.h:41</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1JTx_html_a87d8ee966e2ac9415ebad0d2abfe5b04"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1JTx.html#a87d8ee966e2ac9415ebad0d2abfe5b04">xrpl::test::jtx::JTx::mainSigners</a></div><div class="ttdeci">std::vector&lt; std::function&lt; void(Env &amp;, JTx &amp;)&gt; &gt; mainSigners</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00038">JTx.h:38</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