joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/base58_8cpp.html

400 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: src/base58.cpp File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('base58_8cpp.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">base58.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="base58_8h_source.html">base58.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="hash_8h_source.html">hash.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="uint256_8h_source.html">uint256.h</a>&quot;</code><br />
<code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;boost/variant/apply_visitor.hpp&gt;</code><br />
<code>#include &lt;boost/variant/static_visitor.hpp&gt;</code><br />
</div>
<p><a href="base58_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0f74d1d6e7e982cad4b0e538acea4538"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#a0f74d1d6e7e982cad4b0e538acea4538">DecodeBase58</a> (const char *psz, std::vector&lt; unsigned char &gt; &amp;vch)</td></tr>
<tr class="separator:a0f74d1d6e7e982cad4b0e538acea4538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d6f0e9d5df175b4966dcede31dc90ad"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#a8d6f0e9d5df175b4966dcede31dc90ad">EncodeBase58</a> (const unsigned char *pbegin, const unsigned char *pend)</td></tr>
<tr class="separator:a8d6f0e9d5df175b4966dcede31dc90ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab95cf95fa4e2631017335c2ea73090bc"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#ab95cf95fa4e2631017335c2ea73090bc">EncodeBase58</a> (const std::vector&lt; unsigned char &gt; &amp;vch)</td></tr>
<tr class="separator:ab95cf95fa4e2631017335c2ea73090bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83e290bb1b09e9c26a86863c5641111f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#a83e290bb1b09e9c26a86863c5641111f">DecodeBase58</a> (const std::string &amp;str, std::vector&lt; unsigned char &gt; &amp;vchRet)</td></tr>
<tr class="separator:a83e290bb1b09e9c26a86863c5641111f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace9a5807ee51604f33044339f073ec76"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#ace9a5807ee51604f33044339f073ec76">EncodeBase58Check</a> (const std::vector&lt; unsigned char &gt; &amp;vchIn)</td></tr>
<tr class="separator:ace9a5807ee51604f33044339f073ec76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2dc7ad63e243509e0871ec4a5890678"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#ae2dc7ad63e243509e0871ec4a5890678">DecodeBase58Check</a> (const char *psz, std::vector&lt; unsigned char &gt; &amp;vchRet)</td></tr>
<tr class="separator:ae2dc7ad63e243509e0871ec4a5890678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96597527b13547236b99430e6ac195b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#a96597527b13547236b99430e6ac195b3">DecodeBase58Check</a> (const std::string &amp;str, std::vector&lt; unsigned char &gt; &amp;vchRet)</td></tr>
<tr class="separator:a96597527b13547236b99430e6ac195b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ab647a562dea2d764299dc9a7d3bb1175"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="base58_8cpp.html#ab647a562dea2d764299dc9a7d3bb1175">pszBase58</a> = &quot;123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz&quot;</td></tr>
<tr class="separator:ab647a562dea2d764299dc9a7d3bb1175"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0f74d1d6e7e982cad4b0e538acea4538"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f74d1d6e7e982cad4b0e538acea4538">&#9670;&nbsp;</a></span>DecodeBase58() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeBase58 </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>psz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; unsigned char &gt; &amp;&#160;</td>
<td class="paramname"><em>vchRet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode a base58-encoded string (psz) into a byte vector (vchRet). return true if decoding is successful. psz cannot be NULL. </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00021">21</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="base58_8cpp_source.html#l00116">DecodeBase58()</a>, and <a class="el" href="base58_8cpp_source.html#l00130">DecodeBase58Check()</a>.</p>
</div>
</div>
<a id="a83e290bb1b09e9c26a86863c5641111f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83e290bb1b09e9c26a86863c5641111f">&#9670;&nbsp;</a></span>DecodeBase58() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DecodeBase58 </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; unsigned char &gt; &amp;&#160;</td>
<td class="paramname"><em>vchRet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode a base58-encoded string (str) into a byte vector (vchRet). return true if decoding is successful. </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00116">116</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
</div>
</div>
<a id="ae2dc7ad63e243509e0871ec4a5890678"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2dc7ad63e243509e0871ec4a5890678">&#9670;&nbsp;</a></span>DecodeBase58Check() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool DecodeBase58Check </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>psz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; unsigned char &gt; &amp;&#160;</td>
<td class="paramname"><em>vchRet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode a base58-encoded string (psz) that includes a checksum into a byte vector (vchRet), return true if decoding is successful </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00130">130</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="base58_8cpp_source.html#l00147">DecodeBase58Check()</a>, and <a class="el" href="base58_8cpp_source.html#l00171">CBase58Data::SetString()</a>.</p>
</div>
</div>
<a id="a96597527b13547236b99430e6ac195b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96597527b13547236b99430e6ac195b3">&#9670;&nbsp;</a></span>DecodeBase58Check() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool DecodeBase58Check </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; unsigned char &gt; &amp;&#160;</td>
<td class="paramname"><em>vchRet</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode a base58-encoded string (str) that includes a checksum into a byte vector (vchRet), return true if decoding is successful </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00147">147</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
</div>
</div>
<a id="a8d6f0e9d5df175b4966dcede31dc90ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d6f0e9d5df175b4966dcede31dc90ad">&#9670;&nbsp;</a></span>EncodeBase58() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string EncodeBase58 </td>
<td>(</td>
<td class="paramtype">const unsigned char *&#160;</td>
<td class="paramname"><em>pbegin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char *&#160;</td>
<td class="paramname"><em>pend</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Why base-58 instead of standard base-64 encoding?</p><ul>
<li>Don't want 0OIl characters that look the same in some fonts and could be used to create visually identical looking data.</li>
<li>A string with non-alphanumeric characters is not as easily accepted as input.</li>
<li>E-mail usually won't line-break if there's no punctuation to break at.</li>
<li>Double-clicking selects the whole string as one word if it's all alphanumeric. Encode a byte sequence as a base58-encoded string. pbegin and pend cannot be NULL, unless both are. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00071">71</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="base58_8cpp_source.html#l00111">EncodeBase58()</a>, and <a class="el" href="base58_8cpp_source.html#l00121">EncodeBase58Check()</a>.</p>
</div>
</div>
<a id="ab95cf95fa4e2631017335c2ea73090bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab95cf95fa4e2631017335c2ea73090bc">&#9670;&nbsp;</a></span>EncodeBase58() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string EncodeBase58 </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; unsigned char &gt; &amp;&#160;</td>
<td class="paramname"><em>vch</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode a byte vector as a base58-encoded string </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00111">111</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
</div>
</div>
<a id="ace9a5807ee51604f33044339f073ec76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace9a5807ee51604f33044339f073ec76">&#9670;&nbsp;</a></span>EncodeBase58Check()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string EncodeBase58Check </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; unsigned char &gt; &amp;&#160;</td>
<td class="paramname"><em>vchIn</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode a byte vector into a base58-encoded string, including checksum </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00121">121</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="base58_8cpp_source.html#l00193">CBase58Data::ToString()</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ab647a562dea2d764299dc9a7d3bb1175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab647a562dea2d764299dc9a7d3bb1175">&#9670;&nbsp;</a></span>pszBase58</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* pszBase58 = &quot;123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>All alphanumeric characters except for "0", "I", "O", and "l" </p>
<p class="definition">Definition at line <a class="el" href="base58_8cpp_source.html#l00019">19</a> of file <a class="el" href="base58_8cpp_source.html">base58.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="base58_8cpp_source.html#l00021">DecodeBase58()</a>, and <a class="el" href="base58_8cpp_source.html#l00071">EncodeBase58()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="base58_8cpp.html">base58.cpp</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:10 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink