github-wownero/wownero-cpp
1
0
Fork 0
mirror of https://github.com/wownero/wownero-cpp.git synced 2026-10-17 15:21:30 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
bd129fe060e00ebb10d0ac304a0077369ff9a2a2
wownero-cpp/docs/namespacemonero__utils.html
T
woodser 827421c071 update docs
2020-06-26 15:46:30 -04:00

233 lines
16 KiB
HTML
Raw 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">
<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:a2a295a41b9e95d2b6e59dca1bd270c65"><td class="memItemLeft" align="right" valign="top"><a id="a2a295a41b9e95d2b6e59dca1bd270c65"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>serialize</b> (const rapidjson::Document &amp;doc)</td></tr>
<tr class="separator:a2a295a41b9e95d2b6e59dca1bd270c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a739987b96402f79a980cf068839546e9"><td class="memItemLeft" align="right" valign="top"><a id="a739987b96402f79a980cf068839546e9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addJsonMember</b> (std::string key, uint8_t val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</td></tr>
<tr class="separator:a739987b96402f79a980cf068839546e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaac3a72220c25f19718bbacb736cefa4"><td class="memItemLeft" align="right" valign="top"><a id="aaac3a72220c25f19718bbacb736cefa4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addJsonMember</b> (std::string key, uint32_t val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</td></tr>
<tr class="separator:aaac3a72220c25f19718bbacb736cefa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29c178079c4e7ee413cd26b83d0c2882"><td class="memItemLeft" align="right" valign="top"><a id="a29c178079c4e7ee413cd26b83d0c2882"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addJsonMember</b> (std::string key, uint64_t val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</td></tr>
<tr class="separator:a29c178079c4e7ee413cd26b83d0c2882"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2eda14f8c168e74be837dce40bb7fb7"><td class="memItemLeft" align="right" valign="top"><a id="ad2eda14f8c168e74be837dce40bb7fb7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addJsonMember</b> (std::string key, std::string val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</td></tr>
<tr class="separator:ad2eda14f8c168e74be837dce40bb7fb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d481fb1606c964b603400ba1ab9c31b"><td class="memItemLeft" align="right" valign="top"><a id="a2d481fb1606c964b603400ba1ab9c31b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addJsonMember</b> (std::string key, bool val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root)</td></tr>
<tr class="separator:a2d481fb1606c964b603400ba1ab9c31b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ed87748bee21fea57c61e525e94d756"><td class="memTemplParams" colspan="2"><a id="a2ed87748bee21fea57c61e525e94d756"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a2ed87748bee21fea57c61e525e94d756"><td class="memTemplItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memTemplItemRight" valign="bottom"><b>to_rapidjson_val</b> (rapidjson::Document::AllocatorType &amp;allocator, const std::vector&lt; std::shared_ptr&lt; T &gt;&gt; &amp;vals)</td></tr>
<tr class="separator:a2ed87748bee21fea57c61e525e94d756"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a858a2811088a52b873face58bb9fc7"><td class="memTemplParams" colspan="2"><a id="a8a858a2811088a52b873face58bb9fc7"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a8a858a2811088a52b873face58bb9fc7"><td class="memTemplItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memTemplItemRight" valign="bottom"><b>to_rapidjson_val</b> (rapidjson::Document::AllocatorType &amp;allocator, const std::vector&lt; T &gt; &amp;vals)</td></tr>
<tr class="separator:a8a858a2811088a52b873face58bb9fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ed2b6bca0e2ee02afa5c62056b3f4c3"><td class="memItemLeft" align="right" valign="top"><a id="a4ed2b6bca0e2ee02afa5c62056b3f4c3"></a>
rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><b>to_rapidjson_val</b> (rapidjson::Document::AllocatorType &amp;allocator, const std::vector&lt; std::string &gt; &amp;strs)</td></tr>
<tr class="separator:a4ed2b6bca0e2ee02afa5c62056b3f4c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae744c4753657ad125b0b44d5e5330822"><td class="memItemLeft" align="right" valign="top"><a id="ae744c4753657ad125b0b44d5e5330822"></a>
rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><b>to_rapidjson_val</b> (rapidjson::Document::AllocatorType &amp;allocator, const std::vector&lt; uint8_t &gt; &amp;nums)</td></tr>
<tr class="separator:ae744c4753657ad125b0b44d5e5330822"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70a083d99f64024794d49df445b4f839"><td class="memItemLeft" align="right" valign="top"><a id="a70a083d99f64024794d49df445b4f839"></a>
rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><b>to_rapidjson_val</b> (rapidjson::Document::AllocatorType &amp;allocator, const std::vector&lt; uint32_t &gt; &amp;nums)</td></tr>
<tr class="separator:a70a083d99f64024794d49df445b4f839"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa78d122ad53b7c880c17ff684a6248da"><td class="memItemLeft" align="right" valign="top"><a id="aa78d122ad53b7c880c17ff684a6248da"></a>
rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><b>to_rapidjson_val</b> (rapidjson::Document::AllocatorType &amp;allocator, const std::vector&lt; uint64_t &gt; &amp;nums)</td></tr>
<tr class="separator:aa78d122ad53b7c880c17ff684a6248da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a994464a826d732d56dc1538809a79f9c"><td class="memItemLeft" align="right" valign="top"><a id="a994464a826d732d56dc1538809a79f9c"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>serialize</b> (const boost::property_tree::ptree &amp;node)</td></tr>
<tr class="separator:a994464a826d732d56dc1538809a79f9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c3de434c99895049dd1b01b040cbecc"><td class="memItemLeft" align="right" valign="top"><a id="a6c3de434c99895049dd1b01b040cbecc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const std::string &amp;json, boost::property_tree::ptree &amp;root)</td></tr>
<tr class="separator:a6c3de434c99895049dd1b01b040cbecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b9ee3d8bd81e28c3bbdf4e747300277"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemonero__utils.html#a3b9ee3d8bd81e28c3bbdf4e747300277">is_valid_language</a> (const std::string &amp;language)</td></tr>
<tr class="separator:a3b9ee3d8bd81e28c3bbdf4e747300277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2fb8889ec17d02e54541e90a3ffd47f"><td class="memItemLeft" align="right" valign="top">std::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#ab2fb8889ec17d02e54541e90a3ffd47f">cn_block_to_block</a> (const cryptonote::block &amp;cn_block)</td></tr>
<tr class="separator:ab2fb8889ec17d02e54541e90a3ffd47f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4b5df3026350e762bfa40c6acdb6a0d"><td class="memItemLeft" align="right" valign="top">std::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#ad4b5df3026350e762bfa40c6acdb6a0d">cn_tx_to_tx</a> (const cryptonote::transaction &amp;cn_tx, bool init_as_tx_wallet=false)</td></tr>
<tr class="separator:ad4b5df3026350e762bfa40c6acdb6a0d"><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>Collection of utilities for the Monero library. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ab2fb8889ec17d02e54541e90a3ffd47f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2fb8889ec17d02e54541e90a3ffd47f">&#9670;&nbsp;</a></span>cn_block_to_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::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="ad4b5df3026350e762bfa40c6acdb6a0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4b5df3026350e762bfa40c6acdb6a0d">&#9670;&nbsp;</a></span>cn_tx_to_tx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::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>
<a id="a3b9ee3d8bd81e28c3bbdf4e747300277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b9ee3d8bd81e28c3bbdf4e747300277">&#9670;&nbsp;</a></span>is_valid_language()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool monero_utils::is_valid_language </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>language</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates if the given language is valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">language</td><td>is the language to validate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the language is valid, false otherwise </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>
Reference in New Issue View Git Blame Copy Permalink