Files
wownero-cpp/docs/namespacemonero__utils.html
T
2019-08-25 13:37:46 -04:00

224 lines
18 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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero_utils Namespace Reference</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">monero_utils Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4b46d88c2b662d0b36f8c93171601d39"><td class="memItemLeft" align="right" valign="top"><a id="a4b46d88c2b662d0b36f8c93171601d39"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>json_to_binary</b> (const std::string &amp;json, std::string &amp;bin)</td></tr>
<tr class="separator:a4b46d88c2b662d0b36f8c93171601d39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6eae9999c9eec429dc10985bc96e16ab"><td class="memItemLeft" align="right" valign="top"><a id="a6eae9999c9eec429dc10985bc96e16ab"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>binary_to_json</b> (const std::string &amp;bin, std::string &amp;json)</td></tr>
<tr class="separator:a6eae9999c9eec429dc10985bc96e16ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e75da8e9e45070df04827553a3c1940"><td class="memItemLeft" align="right" valign="top"><a id="a4e75da8e9e45070df04827553a3c1940"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>binary_blocks_to_json</b> (const std::string &amp;bin, std::string &amp;json)</td></tr>
<tr class="separator:a4e75da8e9e45070df04827553a3c1940"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d85b51543a864a0d186ebf3d763eb6"><td class="memItemLeft" align="right" valign="top"><a id="ac4d85b51543a864a0d186ebf3d763eb6"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx__query.html">monero_tx_query</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize_tx_query</b> (const string &amp;txQueryStr)</td></tr>
<tr class="separator:ac4d85b51543a864a0d186ebf3d763eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7efd4fb0fd8964ddfde9bf8e6475900"><td class="memItemLeft" align="right" valign="top"><a id="ab7efd4fb0fd8964ddfde9bf8e6475900"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize_transfer_query</b> (const string &amp;transfer_query_str)</td></tr>
<tr class="separator:ab7efd4fb0fd8964ddfde9bf8e6475900"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf124bd1090ff7618ea0aa303b77c08f"><td class="memItemLeft" align="right" valign="top"><a id="acf124bd1090ff7618ea0aa303b77c08f"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__output__query.html">monero_output_query</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize_output_query</b> (const string &amp;output_query_str)</td></tr>
<tr class="separator:acf124bd1090ff7618ea0aa303b77c08f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2830c3e1a6ace0977cfb7b5edc07747"><td class="memItemLeft" align="right" valign="top"><a id="ab2830c3e1a6ace0977cfb7b5edc07747"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__send__request.html">monero_send_request</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize_send_request</b> (const string &amp;send_request_str)</td></tr>
<tr class="separator:ab2830c3e1a6ace0977cfb7b5edc07747"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa020f146a14f533722e3fc4c12dc676d"><td class="memItemLeft" align="right" valign="top"><a id="aa020f146a14f533722e3fc4c12dc676d"></a>
vector&lt; shared_ptr&lt; <a class="el" href="structmonero_1_1monero__key__image.html">monero_key_image</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize_key_images</b> (const string &amp;key_images_json)</td></tr>
<tr class="separator:aa020f146a14f533722e3fc4c12dc676d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af12b61e3c5db22f4a56eb06aabb8343b"><td class="memItemLeft" align="right" valign="top"><a id="af12b61e3c5db22f4a56eb06aabb8343b"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><b>serialize</b> (const boost::property_tree::ptree &amp;node)</td></tr>
<tr class="separator:af12b61e3c5db22f4a56eb06aabb8343b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a101ac2471565938c54d68b588221fef7"><td class="memItemLeft" align="right" valign="top">shared_ptr&lt; <a class="el" href="structmonero_1_1monero__block.html">monero_block</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemonero__utils.html#a101ac2471565938c54d68b588221fef7">cn_block_to_block</a> (const cryptonote::block &amp;cn_block)</td></tr>
<tr class="separator:a101ac2471565938c54d68b588221fef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0f19d3c9a66d2907258233683749b29"><td class="memItemLeft" align="right" valign="top">shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx.html">monero_tx</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemonero__utils.html#ac0f19d3c9a66d2907258233683749b29">cn_tx_to_tx</a> (const cryptonote::transaction &amp;cn_tx, bool init_as_tx_wallet=false)</td></tr>
<tr class="separator:ac0f19d3c9a66d2907258233683749b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a1333cc5a61cc15126dfd1ce173425e"><td class="memTemplParams" colspan="2"><a id="a2a1333cc5a61cc15126dfd1ce173425e"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a2a1333cc5a61cc15126dfd1ce173425e"><td class="memTemplItemLeft" align="right" valign="top">boost::property_tree::ptree&#160;</td><td class="memTemplItemRight" valign="bottom"><b>to_property_tree</b> (const vector&lt; shared_ptr&lt; T &gt;&gt; &amp;types)</td></tr>
<tr class="separator:a2a1333cc5a61cc15126dfd1ce173425e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5616300165089474217e73b03d7557b"><td class="memTemplParams" colspan="2"><a id="af5616300165089474217e73b03d7557b"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:af5616300165089474217e73b03d7557b"><td class="memTemplItemLeft" align="right" valign="top">boost::property_tree::ptree&#160;</td><td class="memTemplItemRight" valign="bottom"><b>to_property_tree</b> (const vector&lt; T &gt; &amp;types)</td></tr>
<tr class="separator:af5616300165089474217e73b03d7557b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d9e464b33bc3debc789d122304671ac"><td class="memItemLeft" align="right" valign="top"><a id="a5d9e464b33bc3debc789d122304671ac"></a>
boost::property_tree::ptree&#160;</td><td class="memItemRight" valign="bottom"><b>to_property_tree</b> (const vector&lt; string &gt; &amp;strs)</td></tr>
<tr class="separator:a5d9e464b33bc3debc789d122304671ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c313dacbc8121e8a889301da0ad4d10"><td class="memItemLeft" align="right" valign="top"><a id="a4c313dacbc8121e8a889301da0ad4d10"></a>
boost::property_tree::ptree&#160;</td><td class="memItemRight" valign="bottom"><b>to_property_tree</b> (const vector&lt; uint8_t &gt; &amp;nums)</td></tr>
<tr class="separator:a4c313dacbc8121e8a889301da0ad4d10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cf8834d79978a8fe04f13e62bf40bb6"><td class="memItemLeft" align="right" valign="top"><a id="a6cf8834d79978a8fe04f13e62bf40bb6"></a>
boost::property_tree::ptree&#160;</td><td class="memItemRight" valign="bottom"><b>to_property_tree</b> (const vector&lt; uint32_t &gt; &amp;nums)</td></tr>
<tr class="separator:a6cf8834d79978a8fe04f13e62bf40bb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23f1648d8d19c9d823c6aa98541f6cde"><td class="memItemLeft" align="right" valign="top"><a id="a23f1648d8d19c9d823c6aa98541f6cde"></a>
boost::property_tree::ptree&#160;</td><td class="memItemRight" valign="bottom"><b>to_property_tree</b> (const vector&lt; uint64_t &gt; &amp;nums)</td></tr>
<tr class="separator:a23f1648d8d19c9d823c6aa98541f6cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a724cbe3f57a2afc3d3220ef768b81077"><td class="memTemplParams" colspan="2"><a id="a724cbe3f57a2afc3d3220ef768b81077"></a>
template&lt;class T , typename std::enable_if&lt; std::is_same&lt; T, string &gt;::value, T &gt;::type * = nullptr&gt; </td></tr>
<tr class="memitem:a724cbe3f57a2afc3d3220ef768b81077"><td class="memTemplItemLeft" align="right" valign="top">boost::optional&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>reconcile</b> (const boost::optional&lt; T &gt; &amp;val1, const boost::optional&lt; T &gt; &amp;val2, boost::optional&lt; bool &gt; resolve_defined, boost::optional&lt; bool &gt; resolve_true, boost::optional&lt; bool &gt; resolve_max, const string &amp;err_msg=&quot;&quot;)</td></tr>
<tr class="separator:a724cbe3f57a2afc3d3220ef768b81077"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51d168822f0ff297f488dded1ca1cc4e"><td class="memTemplParams" colspan="2"><a id="a51d168822f0ff297f488dded1ca1cc4e"></a>
template&lt;class T , typename std::enable_if&lt; std::is_same&lt; T, string &gt;::value, T &gt;::type * = nullptr&gt; </td></tr>
<tr class="memitem:a51d168822f0ff297f488dded1ca1cc4e"><td class="memTemplItemLeft" align="right" valign="top">boost::optional&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>reconcile</b> (const boost::optional&lt; T &gt; &amp;val1, const boost::optional&lt; T &gt; &amp;val2, const string &amp;err_msg=&quot;&quot;)</td></tr>
<tr class="separator:a51d168822f0ff297f488dded1ca1cc4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afec3c14f8ddaad9c9370a29a17035fff"><td class="memTemplParams" colspan="2"><a id="afec3c14f8ddaad9c9370a29a17035fff"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:afec3c14f8ddaad9c9370a29a17035fff"><td class="memTemplItemLeft" align="right" valign="top">vector&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>reconcile</b> (const vector&lt; T &gt; &amp;v1, const vector&lt; T &gt; &amp;v2, const string &amp;err_msg=&quot;&quot;)</td></tr>
<tr class="separator:afec3c14f8ddaad9c9370a29a17035fff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Copyright (c) 2017-2019 woodser</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<p>Parts of this file are originally copyright (c) 2014-2019, The Monero Project</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
<p>All rights reserved.</p>
<ol type="1">
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
<li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li>
<li>Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</li>
</ol>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
<p>Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developersCollection of utilities for working with Monero's binary portable storage format. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a101ac2471565938c54d68b588221fef7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a101ac2471565938c54d68b588221fef7">&#9670;&nbsp;</a></span>cn_block_to_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shared_ptr&lt; <a class="el" href="structmonero_1_1monero__block.html">monero_block</a> &gt; monero_utils::cn_block_to_block </td>
<td>(</td>
<td class="paramtype">const cryptonote::block &amp;&#160;</td>
<td class="paramname"><em>cn_block</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a Monero Core cryptonote::block to a block in this library's native model.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cn_block</td><td>is the Core block to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a block in this library's native model </dd></dl>
</div>
</div>
<a id="ac0f19d3c9a66d2907258233683749b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0f19d3c9a66d2907258233683749b29">&#9670;&nbsp;</a></span>cn_tx_to_tx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx.html">monero_tx</a> &gt; monero_utils::cn_tx_to_tx </td>
<td>(</td>
<td class="paramtype">const cryptonote::transaction &amp;&#160;</td>
<td class="paramname"><em>cn_tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>init_as_tx_wallet</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a Monero Core crpytonote::transaction to a transaction in this library's native model.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cn_tx</td><td>is the Core transaction to convert </td></tr>
<tr><td class="paramname">init_as_tx_wallet</td><td>specifies if a monero_tx xor monero_tx_wallet should be initialized </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>