Files
wownero-cpp/docs/monero__utils_8h_source.html
T
2021-01-14 21:08:05 -05:00

192 lines
22 KiB
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.20"/>
<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.20 -->
<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">#pragma once</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#ifndef monero_utils_h</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#define monero_utils_h</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor">#include &quot;wallet/monero_wallet_model.h&quot;</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor">#include &quot;cryptonote_basic/cryptonote_basic.h&quot;</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</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="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#include &quot;storages/portable_storage.h&quot;</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="namespacemonero__utils.html"> 66</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemonero__utils.html">monero_utils</a></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;{</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">using namespace </span>cryptonote;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// ------------------------ CONSTANTS ---------------------------</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</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="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="comment">// ------------------------ BINARY SERIALIZATION ----------------------------</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</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="l00077"></a><span class="lineno"> 77</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="l00078"></a><span class="lineno"> 78</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="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="comment">// ------------------------------ RAPIDJSON ---------------------------------</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; std::string serialize(<span class="keyword">const</span> rapidjson::Document&amp; doc);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774"> 90</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">add_json_member</a>(std::string key, T val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field) {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; rapidjson::Value field_key(key.c_str(), key.size(), allocator);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; field.SetInt64((uint64_t) val);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; root.AddMember(field_key, field, 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="keywordtype">void</span> <a class="code" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">add_json_member</a>(std::string key, std::string val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">void</span> <a class="code" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">add_json_member</a>(std::string key, <span class="keywordtype">bool</span> val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root);</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> std::vector&lt;std::shared_ptr&lt;T&gt;&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-&gt;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; <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="l00108"></a><span class="lineno"> 108</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> std::vector&lt;T&gt;&amp; vals) {</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; rapidjson::Value value_arr(rapidjson::kArrayType);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</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="l00111"></a><span class="lineno"> 111</span>&#160; value_arr.PushBack(val.to_rapidjson_val(allocator), allocator);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; }</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">return</span> value_arr;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</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; rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; strs);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; nums);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> std::vector&lt;uint32_t&gt;&amp; nums);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; rapidjson::Value to_rapidjson_val(rapidjson::Document::AllocatorType&amp; allocator, <span class="keyword">const</span> std::vector&lt;uint64_t&gt;&amp; nums);</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="comment">// ------------------------ PROPERTY TREES ---------------------------</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="comment">// TODO: fully switch from property trees to rapidjson</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; std::string serialize(<span class="keyword">const</span> boost::property_tree::ptree&amp; node);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordtype">void</span> deserialize(<span class="keyword">const</span> std::string&amp; json, boost::property_tree::ptree&amp; root);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="namespacemonero__utils.html#a3b9ee3d8bd81e28c3bbdf4e747300277">is_valid_language</a>(<span class="keyword">const</span> std::string&amp; language);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; std::shared_ptr&lt;monero_block&gt; <a class="code" href="namespacemonero__utils.html#ab2fb8889ec17d02e54541e90a3ffd47f">cn_block_to_block</a>(<span class="keyword">const</span> cryptonote::block&amp; cn_block);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; std::shared_ptr&lt;monero_tx&gt; <a class="code" href="namespacemonero__utils.html#ad4b5df3026350e762bfa40c6acdb6a0d">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="l00154"></a><span class="lineno"> 154</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keyword">static</span> std::string get_pruned_tx_json(cryptonote::transaction &amp;tx)</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; {</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; std::stringstream ss;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; json_archive&lt;true&gt; ar(ss);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keywordtype">bool</span> r = tx.serialize_base(ar);</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</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="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordflow">return</span> ss.str();</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; }</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> free(std::shared_ptr&lt;monero_block&gt; block) {</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_tx&gt;&amp; tx : block-&gt;m_txs) {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; tx-&gt;m_block.reset();</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <a class="code" href="structmonero_1_1monero__tx__wallet.html">monero_tx_wallet</a>* tx_wallet = <span class="keyword">dynamic_cast&lt;</span><a class="code" href="structmonero_1_1monero__tx__wallet.html">monero_tx_wallet</a>*<span class="keyword">&gt;</span>(tx.get());</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keywordflow">if</span> (tx_wallet != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordflow">if</span> (tx_wallet-&gt;m_outgoing_transfer != boost::none) tx_wallet-&gt;m_outgoing_transfer.get()-&gt;m_tx.reset();</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_transfer&gt; transfer : tx_wallet-&gt;m_incoming_transfers) transfer-&gt;m_tx.reset();</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_output&gt; output : tx_wallet-&gt;m_outputs) output-&gt;m_tx.reset();</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_output&gt; input : tx_wallet-&gt;m_inputs) {</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; input-&gt;m_key_image.reset();</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; input-&gt;m_tx.reset();</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; }</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; }</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; }</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; block.reset();</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; }</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> free(std::vector&lt;std::shared_ptr&lt;monero_block&gt;&gt; blocks) {</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_block&gt;&amp; block : blocks) monero_utils::free(block);</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; }</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;}</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* monero_utils_h */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacemonero__utils_html_a3b9ee3d8bd81e28c3bbdf4e747300277"><div class="ttname"><a href="namespacemonero__utils.html#a3b9ee3d8bd81e28c3bbdf4e747300277">monero_utils::is_valid_language</a></div><div class="ttdeci">bool is_valid_language(const std::string &amp;language)</div><div class="ttdef"><b>Definition:</b> monero_utils.cpp:217</div></div>
<div class="ttc" id="anamespacemonero__utils_html_ad4b5df3026350e762bfa40c6acdb6a0d"><div class="ttname"><a href="namespacemonero__utils.html#ad4b5df3026350e762bfa40c6acdb6a0d">monero_utils::cn_tx_to_tx</a></div><div class="ttdeci">std::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:246</div></div>
<div class="ttc" id="astructmonero_1_1monero__tx__wallet_html"><div class="ttname"><a href="structmonero_1_1monero__tx__wallet.html">monero::monero_tx_wallet</a></div><div class="ttdef"><b>Definition:</b> monero_wallet_model.h:244</div></div>
<div class="ttc" id="anamespacemonero__utils_html"><div class="ttname"><a href="namespacemonero__utils.html">monero_utils</a></div><div class="ttdef"><b>Definition:</b> monero_utils.h:67</div></div>
<div class="ttc" id="anamespacemonero__utils_html_abc8108fdc0269db2f50c2ac24d7e5774"><div class="ttname"><a href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">monero_utils::add_json_member</a></div><div class="ttdeci">void add_json_member(std::string key, T val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</div><div class="ttdef"><b>Definition:</b> monero_utils.h:90</div></div>
<div class="ttc" id="anamespacemonero__utils_html_ab2fb8889ec17d02e54541e90a3ffd47f"><div class="ttname"><a href="namespacemonero__utils.html#ab2fb8889ec17d02e54541e90a3ffd47f">monero_utils::cn_block_to_block</a></div><div class="ttdeci">std::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:230</div></div>
<!-- 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.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>