mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-23 12:35:50 +00:00
156 lines
19 KiB
HTML
156 lines
19 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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: tokens.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">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">tokens.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_PROTOCOL_TOKENS_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_PROTOCOL_TOKENS_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03"> 29</a></span> <span class="keyword">enum class</span> <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> : <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a6adf97f83acf6453d4a6a4b1070f3754">None</a> = 1, <span class="comment">// unused</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6">NodePublic</a> = 28,</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a5cc5482a0278b704175b383ee922954a">NodePrivate</a> = 32,</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classripple_1_1base__uint.html">AccountID</a> = 0,</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ab23f52a56f27cc97abe221ea3c5cd56c">AccountPublic</a> = 35,</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a7dc33e2284f98dd03358e2fe25eed241">AccountSecret</a> = 34,</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a513a00dffce0e9ebe3b233b73e916731">FamilyGenerator</a> = 41, <span class="comment">// unused</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ae5f75283d870bd02aef91989195860f0">FamilySeed</a> = 33</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> };</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<T></a></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="namespaceripple.html#a6ed6129376e1d37ef607c2697f5b9d6a">parseBase58</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& s);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<T></a></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <a class="code" href="namespaceripple.html#a6ed6129376e1d37ef607c2697f5b9d6a">parseBase58</a>(<a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type, <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& s);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="namespaceripple.html#a4c70c1f85ccff1b830f4bda1becb21b4">encodeBase58Token</a>(<a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type, <span class="keywordtype">void</span> <span class="keyword">const</span>* token, <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <a class="code" href="namespaceripple.html#a9952e5a413358e9a647b31c86c5835ff">decodeBase58Token</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& s, <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03a513a00dffce0e9ebe3b233b73e916731"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a513a00dffce0e9ebe3b233b73e916731">ripple::TokenType::FamilyGenerator</a></div><div class="ttdeci">@ FamilyGenerator</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a9952e5a413358e9a647b31c86c5835ff"><div class="ttname"><a href="namespaceripple.html#a9952e5a413358e9a647b31c86c5835ff">ripple::decodeBase58Token</a></div><div class="ttdeci">std::string decodeBase58Token(std::string const &s, TokenType type)</div><div class="ttdoc">Decode a token of given type encoded using Base58Check and the XRPL alphabet.</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8cpp_source.html#l00223">tokens.cpp:223</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03a6adf97f83acf6453d4a6a4b1070f3754"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a6adf97f83acf6453d4a6a4b1070f3754">ripple::TokenType::None</a></div><div class="ttdeci">@ None</div></div>
|
|
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint</a></div><div class="ttdoc">Integers of any length that is a multiple of 32-bits.</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00081">base_uint.h:81</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03ae5f75283d870bd02aef91989195860f0"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ae5f75283d870bd02aef91989195860f0">ripple::TokenType::FamilySeed</a></div><div class="ttdeci">@ FamilySeed</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">ripple::TokenType</a></div><div class="ttdeci">TokenType</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8h_source.html#l00029">tokens.h:29</a></div></div>
|
|
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
|
|
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a4c70c1f85ccff1b830f4bda1becb21b4"><div class="ttname"><a href="namespaceripple.html#a4c70c1f85ccff1b830f4bda1becb21b4">ripple::encodeBase58Token</a></div><div class="ttdeci">std::string encodeBase58Token(TokenType type, void const *token, std::size_t size)</div><div class="ttdoc">Encode data in Base58Check format using XRPL alphabet.</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8cpp_source.html#l00199">tokens.cpp:199</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03a7dc33e2284f98dd03358e2fe25eed241"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a7dc33e2284f98dd03358e2fe25eed241">ripple::TokenType::AccountSecret</a></div><div class="ttdeci">@ AccountSecret</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03ab23f52a56f27cc97abe221ea3c5cd56c"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ab23f52a56f27cc97abe221ea3c5cd56c">ripple::TokenType::AccountPublic</a></div><div class="ttdeci">@ AccountPublic</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6">ripple::TokenType::NodePublic</a></div><div class="ttdeci">@ NodePublic</div></div>
|
|
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
|
|
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a6ed6129376e1d37ef607c2697f5b9d6a"><div class="ttname"><a href="namespaceripple.html#a6ed6129376e1d37ef607c2697f5b9d6a">ripple::parseBase58</a></div><div class="ttdeci">std::optional< AccountID > parseBase58(std::string const &s)</div><div class="ttdoc">Parse AccountID from checked, base58 string.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8cpp_source.html#l00114">AccountID.cpp:114</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a1bf8df553d36589191c8057c136cce03a5cc5482a0278b704175b383ee922954a"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a5cc5482a0278b704175b383ee922954a">ripple::TokenType::NodePrivate</a></div><div class="ttdeci">@ NodePrivate</div></div>
|
|
<div class="ttc" id="astring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string.html">string</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|