ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ef1af9423e3adf2a90158ce99b5ef20fc13619e
rippled/tokens_8h_source.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

248 lines
36 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_8d04e3c0b58cad28d7755ed462d1b6c0.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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" 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 id="l00012" 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 id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" 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 id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_PROTOCOL_TOKENS_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_PROTOCOL_TOKENS_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpl/basics/Expected.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/basics/contract.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/protocol/detail/token_errors.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/span.html">span</a>&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string_view.html">string_view</a>&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="namespaceripple.html#aac94480492da0b29f45633ca86aa7623"> 36</a></span><span class="keyword">using </span><a class="code hl_class" href="classripple_1_1Expected.html">B58Result</a> = <a class="code hl_class" href="classripple_1_1Expected.html">Expected&lt;T, std::error_code&gt;</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="};">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03"> 38</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> : <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a6adf97f83acf6453d4a6a4b1070f3754">None</a> = 1, <span class="comment">// unused</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ac3fe5edb1f8a81a8e585f6a27c120be6">NodePublic</a> = 28,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a5cc5482a0278b704175b383ee922954a">NodePrivate</a> = 32,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> = 0,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ab23f52a56f27cc97abe221ea3c5cd56c">AccountPublic</a> = 35,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a7dc33e2284f98dd03358e2fe25eed241">AccountSecret</a> = 34,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a513a00dffce0e9ebe3b233b73e916731">FamilyGenerator</a> = 41, <span class="comment">// unused</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_enumvalue" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03ae5f75283d870bd02aef91989195860f0">FamilySeed</a> = 33</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;T&gt;</a></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="namespaceripple.html#aaa9096cc18e555e69331d24fd526ce6f"> 51</a></span><a class="code hl_function" href="namespaceripple.html#a2d4b11b177a0b78f80727d7800399ff6">parseBase58</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;T&gt;</a></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="namespaceripple.html#a42976577ec6c6f85d68e6bf021d2db49"> 55</a></span><a class="code hl_function" href="namespaceripple.html#a2d4b11b177a0b78f80727d7800399ff6">parseBase58</a>(<a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><a class="code hl_function" href="namespaceripple.html#a6034aeaa84f60243a837b0ee043e4114">encodeBase58Token</a>(<a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type, <span class="keywordtype">void</span> <span class="keyword">const</span>* token, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><a class="code hl_function" href="namespaceripple.html#a791e5b51e5921b1070bc195ba2959f3e">decodeBase58Token</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s, <a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="foldopen" id="foldopen00074" data-start="{" data-end="}">
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="namespaceripple_1_1b58__ref.html"> 74</a></span><span class="keyword">namespace </span>b58_ref {</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">// The reference version does not use gcc extensions (int128 in particular)</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><a class="code hl_function" href="namespaceripple_1_1b58__ref.html#aa0fa3cba7987f0ba4579070b2d4bba8d">encodeBase58Token</a>(<a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type, <span class="keywordtype">void</span> <span class="keyword">const</span>* token, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><a class="code hl_function" href="namespaceripple_1_1b58__ref.html#ac05a3902d978e135ba7ad0bef1e4b89e">decodeBase58Token</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s, <a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="foldopen" id="foldopen00082" data-start="{" data-end="}">
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="namespaceripple_1_1b58__ref_1_1detail.html"> 82</a></span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">// Expose detail functions for unit tests only</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><a class="code hl_function" href="namespaceripple_1_1b58__ref_1_1detail.html#ab0b27e0b4489431b8cb8f5ff8276a6ac">encodeBase58</a>(</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">void</span> <span class="keyword">const</span>* message,</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span>* temp,</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> temp_size);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><a class="code hl_function" href="namespaceripple_1_1b58__ref_1_1detail.html#a7228a56fbbce041214ae00bd5d761107">decodeBase58</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>} <span class="comment">// namespace detail</span></div>
</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span>} <span class="comment">// namespace b58_ref</span></div>
</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="preprocessor">#ifndef _MSC_VER</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="keyword">namespace </span>b58_fast {</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment">// Use the fast version (10-15x faster) is using gcc extensions (int128 in</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment">// particular)</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>[[nodiscard]] <a class="code hl_class" href="classripple_1_1Expected.html">B58Result&lt;std::span&lt;std::uint8_t&gt;</a>&gt;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><a class="code hl_function" href="namespaceripple.html#a6034aeaa84f60243a837b0ee043e4114">encodeBase58Token</a>(</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> token_type,</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/span.html">std::span&lt;std::uint8_t const&gt;</a> input,</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/span.html">std::span&lt;std::uint8_t&gt;</a> out);</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>[[nodiscard]] <a class="code hl_class" href="classripple_1_1Expected.html">B58Result&lt;std::span&lt;std::uint8_t&gt;</a>&gt;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><a class="code hl_function" href="namespaceripple.html#a791e5b51e5921b1070bc195ba2959f3e">decodeBase58Token</a>(</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type,</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a> s,</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/span.html">std::span&lt;std::uint8_t&gt;</a> outBuf);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment">// This interface matches the old interface, but requires additional allocation</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><a class="code hl_function" href="namespaceripple.html#a6034aeaa84f60243a837b0ee043e4114">encodeBase58Token</a>(<a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type, <span class="keywordtype">void</span> <span class="keyword">const</span>* token, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">// This interface matches the old interface, but requires additional allocation</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><a class="code hl_function" href="namespaceripple.html#a791e5b51e5921b1070bc195ba2959f3e">decodeBase58Token</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s, <a class="code hl_enumeration" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment">// Expose detail functions for unit tests only</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><a class="code hl_class" href="classripple_1_1Expected.html">B58Result&lt;std::span&lt;std::uint8_t&gt;</a>&gt;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>b256_to_b58_be(</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/span.html">std::span&lt;std::uint8_t const&gt;</a> input,</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/span.html">std::span&lt;std::uint8_t&gt;</a> out);</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><a class="code hl_class" href="classripple_1_1Expected.html">B58Result&lt;std::span&lt;std::uint8_t&gt;</a>&gt;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>b58_to_b256_be(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a> input, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/span.html">std::span&lt;std::uint8_t&gt;</a> out);</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>} <span class="comment">// namespace detail</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>} <span class="comment">// namespace b58_fast</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="preprocessor">#endif </span><span class="comment">// _MSC_VER</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="preprocessor">#endif</span></div>
<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>
<div class="ttc" id="abasic_string_view_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string_view.html">std::string_view</a></div></div>
<div class="ttc" id="aclassripple_1_1Expected_html"><div class="ttname"><a href="classripple_1_1Expected.html">ripple::Expected</a></div><div class="ttdef"><b>Definition</b> <a href="Expected_8h_source.html#l00130">Expected.h:132</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 160, detail::AccountIDTag &gt;</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_1_1b58__ref_1_1detail_html_a7228a56fbbce041214ae00bd5d761107"><div class="ttname"><a href="namespaceripple_1_1b58__ref_1_1detail.html#a7228a56fbbce041214ae00bd5d761107">ripple::b58_ref::detail::decodeBase58</a></div><div class="ttdeci">std::string decodeBase58(std::string const &amp;s)</div><div class="ttdef"><b>Definition</b> <a href="tokens_8cpp_source.html#l00275">tokens.cpp:275</a></div></div>
<div class="ttc" id="anamespaceripple_1_1b58__ref_1_1detail_html_ab0b27e0b4489431b8cb8f5ff8276a6ac"><div class="ttname"><a href="namespaceripple_1_1b58__ref_1_1detail.html#ab0b27e0b4489431b8cb8f5ff8276a6ac">ripple::b58_ref::detail::encodeBase58</a></div><div class="ttdeci">std::string encodeBase58(void const *message, std::size_t size, void *temp, std::size_t temp_size)</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_1_1b58__ref_html_aa0fa3cba7987f0ba4579070b2d4bba8d"><div class="ttname"><a href="namespaceripple_1_1b58__ref.html#aa0fa3cba7987f0ba4579070b2d4bba8d">ripple::b58_ref::encodeBase58Token</a></div><div class="ttdeci">std::string encodeBase58Token(TokenType type, void const *token, std::size_t size)</div><div class="ttdef"><b>Definition</b> <a href="tokens_8cpp_source.html#l00325">tokens.cpp:325</a></div></div>
<div class="ttc" id="anamespaceripple_1_1b58__ref_html_ac05a3902d978e135ba7ad0bef1e4b89e"><div class="ttname"><a href="namespaceripple_1_1b58__ref.html#ac05a3902d978e135ba7ad0bef1e4b89e">ripple::b58_ref::decodeBase58Token</a></div><div class="ttdeci">std::string decodeBase58Token(std::string const &amp;s, TokenType type)</div><div class="ttdef"><b>Definition</b> <a href="tokens_8cpp_source.html#l00349">tokens.cpp:349</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="algorithm_8h_source.html#l00025">algorithm.h:25</a></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#l00038">tokens.h:38</a></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_a1bf8df553d36589191c8057c136cce03a5cc5482a0278b704175b383ee922954a"><div class="ttname"><a href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03a5cc5482a0278b704175b383ee922954a">ripple::TokenType::NodePrivate</a></div><div class="ttdeci">@ NodePrivate</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="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="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_a2d4b11b177a0b78f80727d7800399ff6"><div class="ttname"><a href="namespaceripple.html#a2d4b11b177a0b78f80727d7800399ff6">ripple::parseBase58</a></div><div class="ttdeci">std::optional&lt; AccountID &gt; parseBase58(std::string const &amp;s)</div><div class="ttdoc">Parse AccountID from checked, base58 string.</div><div class="ttdef"><b>Definition</b> <a href="AccountID_8cpp_source.html#l00124">AccountID.cpp:124</a></div></div>
<div class="ttc" id="anamespaceripple_html_a6034aeaa84f60243a837b0ee043e4114"><div class="ttname"><a href="namespaceripple.html#a6034aeaa84f60243a837b0ee043e4114">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_a791e5b51e5921b1070bc195ba2959f3e"><div class="ttname"><a href="namespaceripple.html#a791e5b51e5921b1070bc195ba2959f3e">ripple::decodeBase58Token</a></div><div class="ttdeci">std::string decodeBase58Token(std::string const &amp;s, TokenType type)</div><div class="ttdef"><b>Definition</b> <a href="tokens_8cpp_source.html#l00209">tokens.cpp:209</a></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="aspan_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/span.html">span</a></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>
<div class="ttc" id="astring_view_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string_view.html">string_view</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink