ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
39032171d185a8703b53d77cc7253e3960e8cddc
rippled/TxFormats_8cpp_source.html
bthomee 39032171d1 deploy: 6534757d85
2025-07-10 18:20:07 +00:00

169 lines
19 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: TxFormats.cpp 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.5 -->
<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>
<!-- 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_90ffdbabf412cfdffe6b2193e0ce938a.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_4cb643486f27a568a0d40f174f670f35.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">TxFormats.cpp</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">#include &lt;xrpl/protocol/SField.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &lt;xrpl/protocol/SOTemplate.h&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;xrpl/protocol/TxFormats.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/initializer_list.html">initializer_list</a>&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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1TxFormats.html#a54e184544beb0cd141f171aa7040e0d7"> 29</a></span><a class="code hl_function" href="classripple_1_1TxFormats.html#a54e184544beb0cd141f171aa7040e0d7">TxFormats::TxFormats</a>()</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Fields shared by all txFormats:</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list&lt;SOElement&gt;</a> <span class="keyword">const</span> commonFields{</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> {sfTransactionType, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763">soeREQUIRED</a>},</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {sfFlags, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {sfSourceTag, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {sfAccount, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763">soeREQUIRED</a>},</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> {sfSequence, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763">soeREQUIRED</a>},</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> {sfPreviousTxnID, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>}, <span class="comment">// emulate027</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> {sfLastLedgerSequence, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> {sfAccountTxnID, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> {sfFee, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763">soeREQUIRED</a>},</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> {sfOperationLimit, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {sfMemos, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> {sfSigningPubKey, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763">soeREQUIRED</a>},</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> {sfTicketSequence, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {sfTxnSignature, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {sfSigners, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>}, <span class="comment">// submit_multisigned</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> {sfNetworkID, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> {sfDelegate, <a class="code hl_enumvalue" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">soeOPTIONAL</a>},</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> };</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#pragma push_macro(&quot;UNWRAP&quot;</span>)</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#undef UNWRAP</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#pragma push_macro(&quot;TRANSACTION&quot;</span>)</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#undef TRANSACTION</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#define UNWRAP(...) __VA_ARGS__</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#define TRANSACTION(tag, value, name, delegatable, fields) \</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor"> add(jss::name, tag, UNWRAP fields, commonFields);</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#include &lt;xrpl/protocol/detail/transactions.macro&gt;</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#undef TRANSACTION</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#pragma pop_macro(&quot;TRANSACTION&quot;</span>)</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#undef UNWRAP</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#pragma pop_macro(&quot;UNWRAP&quot;</span>)</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>}</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><a class="code hl_class" href="classripple_1_1TxFormats.html">TxFormats</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classripple_1_1TxFormats.html#a1db8e0fb64564b47c2c33ff763ccc8c3"> 70</a></span><a class="code hl_function" href="classripple_1_1TxFormats.html#a1db8e0fb64564b47c2c33ff763ccc8c3">TxFormats::getInstance</a>()</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>{</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TxFormats.html">TxFormats</a> <span class="keyword">const</span> instance;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordflow">return</span> instance;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>}</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aclassripple_1_1TxFormats_html"><div class="ttname"><a href="classripple_1_1TxFormats.html">ripple::TxFormats</a></div><div class="ttdoc">Manages the list of known transaction formats.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8h_source.html#l00085">TxFormats.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1TxFormats_html_a1db8e0fb64564b47c2c33ff763ccc8c3"><div class="ttname"><a href="classripple_1_1TxFormats.html#a1db8e0fb64564b47c2c33ff763ccc8c3">ripple::TxFormats::getInstance</a></div><div class="ttdeci">static TxFormats const &amp; getInstance()</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8cpp_source.html#l00070">TxFormats.cpp:70</a></div></div>
<div class="ttc" id="aclassripple_1_1TxFormats_html_a54e184544beb0cd141f171aa7040e0d7"><div class="ttname"><a href="classripple_1_1TxFormats.html#a54e184544beb0cd141f171aa7040e0d7">ripple::TxFormats::TxFormats</a></div><div class="ttdeci">TxFormats()</div><div class="ttdoc">Create the object.</div><div class="ttdef"><b>Definition:</b> <a href="TxFormats_8cpp_source.html#l00029">TxFormats.cpp:29</a></div></div>
<div class="ttc" id="ainitializer_list_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/initializer_list.html">initializer_list</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_ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12"><div class="ttname"><a href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a148febf7586dd994c342f8279d664a12">ripple::soeOPTIONAL</a></div><div class="ttdeci">@ soeOPTIONAL</div><div class="ttdef"><b>Definition:</b> <a href="SOTemplate_8h_source.html#l00036">SOTemplate.h:36</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763"><div class="ttname"><a href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042a515d1dfe6cbb412fbbcece5bb23a0763">ripple::soeREQUIRED</a></div><div class="ttdeci">@ soeREQUIRED</div><div class="ttdef"><b>Definition:</b> <a href="SOTemplate_8h_source.html#l00035">SOTemplate.h:35</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink