wownero-cpp/docs/monero__utils_8h_source.html

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: utils/monero_utils.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 style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Monero C++ Library
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_cbdb8362360e11eafe2fa3bc74cf0ffd.html">utils</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">monero_utils.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#ifndef monero_utils_h</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#define monero_utils_h</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">#include &quot;wallet/monero_wallet_model.h&quot;</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#include &quot;cryptonote_basic/cryptonote_basic.h&quot;</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#include &quot;serialization/keyvalue_serialization.h&quot;</span>   <span class="comment">// TODO: consolidate with other binary deps?</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">#include &quot;storages/portable_storage.h&quot;</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="namespacemonero__utils.html">   64</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemonero__utils.html">monero_utils</a></div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;{</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <span class="keyword">using namespace </span>std;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  <span class="keyword">using namespace </span>cryptonote;</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="comment">// ------------------------ CONSTANTS ---------------------------</span></div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> RING_SIZE = 12;  <span class="comment">// network-enforced ring size</span></div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  <span class="comment">// ------------------------ BINARY SERIALIZATION ----------------------------</span></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="keywordtype">void</span> json_to_binary(<span class="keyword">const</span> std::string &amp;json, std::string &amp;bin);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="keywordtype">void</span> binary_to_json(<span class="keyword">const</span> std::string &amp;bin, std::string &amp;json);</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="keywordtype">void</span> binary_blocks_to_json(<span class="keyword">const</span> std::string &amp;bin, std::string &amp;json);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="comment">// ------------------------------ RAPIDJSON ---------------------------------</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  <span class="keywordtype">string</span> serialize(<span class="keyword">const</span> rapidjson::Document&amp; doc);</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  <span class="keywordtype">void</span> addJsonMember(<span class="keywordtype">string</span> key, uint8_t val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field);</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="keywordtype">void</span> addJsonMember(<span class="keywordtype">string</span> key, uint32_t val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field);</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="keywordtype">void</span> addJsonMember(<span class="keywordtype">string</span> key, uint64_t val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field);</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keywordtype">void</span> addJsonMember(<span class="keywordtype">string</span> key, <span class="keywordtype">string</span> val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field);</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;  <span class="keywordtype">void</span> addJsonMember(<span class="keywordtype">string</span> key, <span class="keywordtype">bool</span> val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root);</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="comment">// TODO: template implementation here, could move to monero_utils.hpp per https://stackoverflow.com/questions/3040480/c-template-function-compiles-in-header-but-not-implementation</span></div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt; rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> vector&lt;shared_ptr&lt;T&gt;&gt;&amp; vals) {</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    rapidjson::Value value_arr(rapidjson::kArrayType);</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; val : vals) {</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;      value_arr.PushBack(val-&gt;to_rapidjson_val(allocator), allocator);</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    }</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keywordflow">return</span> value_arr;</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  }</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  <span class="comment">// TODO: template implementation here, could move to monero_utils.hpp per https://stackoverflow.com/questions/3040480/c-template-function-compiles-in-header-but-not-implementation</span></div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt; rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> vector&lt;T&gt;&amp; vals) {</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    rapidjson::Value value_arr(rapidjson::kArrayType);</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; val : vals) {</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;      value_arr.PushBack(val.to_rapidjson_val(allocator), allocator);</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    }</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keywordflow">return</span> value_arr;</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  }</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> vector&lt;string&gt;&amp; strs);</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> vector&lt;uint8_t&gt;&amp; nums);</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;  rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> vector&lt;uint32_t&gt;&amp; nums);</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> vector&lt;uint64_t&gt;&amp; nums);</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  <span class="comment">// ------------------------ PROPERTY TREES ---------------------------</span></div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="comment">// TODO: fully switch from property trees to rapidjson</span></div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;  <span class="keywordtype">string</span> serialize(<span class="keyword">const</span> boost::property_tree::ptree&amp; node);</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="keywordtype">void</span> deserialize(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; json, boost::property_tree::ptree&amp; root);</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  <span class="comment">// --------------------------------------------------------------------------</span></div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;  <span class="keywordtype">void</span> deserialize(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; json, boost::property_tree::ptree&amp; root);</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;  shared_ptr&lt;monero_block&gt; <a class="code" href="namespacemonero__utils.html#a101ac2471565938c54d68b588221fef7">cn_block_to_block</a>(<span class="keyword">const</span> cryptonote::block&amp; cn_block);</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;  shared_ptr&lt;monero_tx&gt; <a class="code" href="namespacemonero__utils.html#ac0f19d3c9a66d2907258233683749b29">cn_tx_to_tx</a>(<span class="keyword">const</span> cryptonote::transaction&amp; cn_tx, <span class="keywordtype">bool</span> init_as_tx_wallet = <span class="keyword">false</span>);</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;  <span class="keyword">static</span> std::string get_pruned_tx_json(cryptonote::transaction &amp;tx)</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;  {</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;    std::stringstream ss;</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    json_archive&lt;true&gt; ar(ss);</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    <span class="keywordtype">bool</span> r = tx.serialize_base(ar);</div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    CHECK_AND_ASSERT_MES(r, std::string(), <span class="stringliteral">&quot;Failed to serialize rct signatures base&quot;</span>);</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;    <span class="keywordflow">return</span> ss.str();</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;  }</div><div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;}</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* monero_utils_h */</span><span class="preprocessor"></span></div><div class="ttc" id="namespacemonero__utils_html_a101ac2471565938c54d68b588221fef7"><div class="ttname"><a href="namespacemonero__utils.html#a101ac2471565938c54d68b588221fef7">monero_utils::cn_block_to_block</a></div><div class="ttdeci">shared_ptr&lt; monero_block &gt; cn_block_to_block(const cryptonote::block &amp;cn_block)</div><div class="ttdef"><b>Definition:</b> monero_utils.cpp:236</div></div>
<div class="ttc" id="namespacemonero__utils_html_ac0f19d3c9a66d2907258233683749b29"><div class="ttname"><a href="namespacemonero__utils.html#ac0f19d3c9a66d2907258233683749b29">monero_utils::cn_tx_to_tx</a></div><div class="ttdeci">shared_ptr&lt; monero_tx &gt; cn_tx_to_tx(const cryptonote::transaction &amp;cn_tx, bool init_as_tx_wallet=false)</div><div class="ttdef"><b>Definition:</b> monero_utils.cpp:252</div></div>
<div class="ttc" id="namespacemonero__utils_html"><div class="ttname"><a href="namespacemonero__utils.html">monero_utils</a></div><div class="ttdef"><b>Definition:</b> monero_utils.h:64</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>