ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-02 08:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: a8d481c2a5

Browse Source
This commit is contained in:
nbougalis
2020-09-08 17:09:25 +00:00
parent 624d5a38ad
commit 2682e5845e
2596 changed files with 124385 additions and 94582 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
tokens_8h_source.html
View File

@@ -124,69 +124,33 @@ $(function() {
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;boost::optional&lt;T&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<a class="code" href="namespaceripple.html#a9c8334c5594b91495328149c7868b16a">parseHexOrBase58</a>(<a class="codeRef" 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 name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">// Facilities for converting Ripple tokens</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment">// to and from their human readable strings</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment">/* Base-58 encode a Ripple Token</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> Ripple Tokens have a one-byte prefx indicating</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"> the type of token, followed by the data for the</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"> token, and finally a 4-byte checksum.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> Tokens include the following:</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> Wallet Seed</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> Account Public Key</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> Account ID</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> @param type A single byte representing the TokenType</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"> @param token A pointer to storage of not</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> less than 2*(size+6) bytes</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> @param size the size of the token buffer in bytes</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<a class="code" href="namespaceripple.html#aa0d412b8937660a0a98f1df59fa6ea4e">base58EncodeToken</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="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment">/* Base-58 encode a Bitcoin Token</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"> * provided here for symmetry, but should never be needed</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> * except for testing.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> * @see base58EncodeToken for format description.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<a class="code" href="namespaceripple.html#a1340479593e450b7e785a9890ae6db87">base58EncodeTokenBitcoin</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="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<a class="code" href="namespaceripple.html#af0519143c57504d84138b6b4dd013fe3">decodeBase58Token</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s, <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<a class="code" href="namespaceripple.html#a12e4315aae2394e7dc58678d38a7a374">decodeBase58TokenBitcoin</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s, <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<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="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<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>&amp; s, <a class="code" href="namespaceripple.html#a1bf8df553d36589191c8057c136cce03">TokenType</a> type);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<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_aa0d412b8937660a0a98f1df59fa6ea4e"><div class="ttname"><a href="namespaceripple.html#aa0d412b8937660a0a98f1df59fa6ea4e">ripple::base58EncodeToken</a></div><div class="ttdeci">std::string base58EncodeToken(TokenType type, void const *token, std::size_t size)</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8cpp_source.html#l00182">tokens.cpp:182</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_ad6a4b945bd1f40791624a2da61adefa8"><div class="ttname"><a href="namespaceripple.html#ad6a4b945bd1f40791624a2da61adefa8">ripple::parseHex</a></div><div class="ttdeci">boost::optional&lt; AccountID &gt; parseHex(std::string const &amp;s)</div><div class="ttdoc">Parse AccountID from hexadecimal string.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8cpp_source.html#l00075">AccountID.cpp:75</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad6a4b945bd1f40791624a2da61adefa8"><div class="ttname"><a href="namespaceripple.html#ad6a4b945bd1f40791624a2da61adefa8">ripple::parseHex</a></div><div class="ttdeci">boost::optional&lt; AccountID &gt; parseHex(std::string const &amp;s)</div><div class="ttdoc">Parse AccountID from hexadecimal string.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8cpp_source.html#l00062">AccountID.cpp:62</a></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 &amp;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="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00063">base_uint.h:63</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_a1340479593e450b7e785a9890ae6db87"><div class="ttname"><a href="namespaceripple.html#a1340479593e450b7e785a9890ae6db87">ripple::base58EncodeTokenBitcoin</a></div><div class="ttdeci">std::string base58EncodeTokenBitcoin(TokenType type, void const *token, std::size_t size)</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8cpp_source.html#l00188">tokens.cpp:188</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_a9c8334c5594b91495328149c7868b16a"><div class="ttname"><a href="namespaceripple.html#a9c8334c5594b91495328149c7868b16a">ripple::parseHexOrBase58</a></div><div class="ttdeci">boost::optional&lt; AccountID &gt; parseHexOrBase58(std::string const &amp;s)</div><div class="ttdoc">Parse AccountID from hex or checked base58 string.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8cpp_source.html#l00087">AccountID.cpp:87</a></div></div>
<div class="ttc" id="anamespaceripple_html_af0519143c57504d84138b6b4dd013fe3"><div class="ttname"><a href="namespaceripple.html#af0519143c57504d84138b6b4dd013fe3">ripple::decodeBase58Token</a></div><div class="ttdeci">static std::string decodeBase58Token(std::string const &amp;s, TokenType type, InverseArray const &amp;inv)</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8cpp_source.html#l00256">tokens.cpp:256</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9c8334c5594b91495328149c7868b16a"><div class="ttname"><a href="namespaceripple.html#a9c8334c5594b91495328149c7868b16a">ripple::parseHexOrBase58</a></div><div class="ttdeci">boost::optional&lt; AccountID &gt; parseHexOrBase58(std::string const &amp;s)</div><div class="ttdoc">Parse AccountID from hex or checked base58 string.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8cpp_source.html#l00074">AccountID.cpp:74</a></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="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_a12e4315aae2394e7dc58678d38a7a374"><div class="ttname"><a href="namespaceripple.html#a12e4315aae2394e7dc58678d38a7a374">ripple::decodeBase58TokenBitcoin</a></div><div class="ttdeci">std::string decodeBase58TokenBitcoin(std::string const &amp;s, TokenType type)</div><div class="ttdoc">Decode a Base58 token using Bitcoin alphabet.</div><div class="ttdef"><b>Definition:</b> <a href="tokens_8cpp_source.html#l00313">tokens.cpp:313</a></div></div>
<div class="ttc" id="anamespaceripple_html_afac6ca7a5a3ec1537768de5cebb1c77c"><div class="ttname"><a href="namespaceripple.html#afac6ca7a5a3ec1537768de5cebb1c77c">ripple::parseBase58</a></div><div class="ttdeci">boost::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#l00036">AccountID.cpp:36</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>