ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/DeliveredAmount_8cpp_source.html
bthomee 7ca054b7d3 deploy: 3b810c305a
2025-11-10 09:36:27 -08:00

317 lines
44 KiB
HTML
Raw Permalink 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: DeliveredAmount.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.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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_42b876eb66f74e25995e23a7c0222dc7.html">rpc</a></li><li class="navelem"><a class="el" href="dir_f2000200ababdfebbc57680f92fa09d7.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">DeliveredAmount.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="preprocessor">#include &lt;xrpld/app/ledger/LedgerMaster.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;xrpld/app/ledger/OpenLedger.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpld/app/misc/Transaction.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/rpc/Context.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpld/rpc/DeliveredAmount.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/protocol/Feature.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpl/protocol/RPCErr.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span>RPC {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/*</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> GetLedgerIndex and GetCloseTime are lambdas that allow the close time and</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ledger index to be lazily calculated. Without these lambdas, these values</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> would be calculated even when not needed, and in some circumstances they are</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> not trivial to compute.</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><span class="comment"> GetLedgerIndex is a callable that returns a LedgerIndex</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> GetCloseTime is a callable that returns a</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> std::optional&lt;NetClock::time_point&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> */</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> GetLedgerIndex, <span class="keyword">class</span> GetCloseTime&gt;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a></div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a58fb48a81509167c40346305cea629c5"> 25</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> GetLedgerIndex <span class="keyword">const</span>&amp; getLedgerIndex,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> GetCloseTime <span class="keyword">const</span>&amp; getCloseTime,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; serializedTx,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</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="keywordflow">if</span> (!serializedTx)</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> {};</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">if</span> (<span class="keyword">auto</span> <span class="keyword">const</span>&amp; deliveredAmount = transactionMeta.<a class="code hl_function" href="classripple_1_1TxMeta.html#af0baceb9d2dadb4a6a956f2db5aa4b06">getDeliveredAmount</a>();</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> deliveredAmount.has_value())</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">return</span> *deliveredAmount;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">if</span> (serializedTx-&gt;isFieldPresent(sfAmount))</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">using namespace </span>std::chrono_literals;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// Ledger 4594095 is the first ledger in which the DeliveredAmount field</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// was present when a partial payment was made and its absence indicates</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// that the amount delivered is listed in the Amount field.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">//</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// If the ledger closed long after the DeliveredAmount code was deployed</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// then its absence indicates that the amount delivered is listed in the</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Amount field. DeliveredAmount went live January 24, 2014.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// 446000000 is in Feb 2014, well after DeliveredAmount went live</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">if</span> (getLedgerIndex() &gt;= 4594095 ||</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> getCloseTime() &gt; <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/chrono/time_point.html">NetClock::time_point</a>{446000000s})</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">return</span> serializedTx-&gt;getFieldAmount(sfAmount);</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> }</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> {};</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>}</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">// Returns true if transaction meta could contain a delivered amount field,</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">// based on transaction type and transaction result</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#af2dba747db554b22ac5bb723555ce5d8"> 65</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#af2dba747db554b22ac5bb723555ce5d8">canHaveDeliveredAmount</a>(</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; serializedTx,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</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> <span class="keywordflow">if</span> (!serializedTx)</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</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> <a class="code hl_enumeration" href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126">TxType</a> <span class="keyword">const</span> tt{serializedTx-&gt;getTxnType()};</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Transaction type should be ttPAYMENT, ttACCOUNT_DELETE or ttCHECK_CASH</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// and if the transaction failed nothing could have been delivered.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">if</span> ((tt == ttPAYMENT || tt == ttCHECK_CASH || tt == ttACCOUNT_DELETE) &amp;&amp;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> transactionMeta.<a class="code hl_function" href="classripple_1_1TxMeta.html#aa5fff1a8fd590ce06ae81e8cd92f092f">getResultTER</a>() == <a class="code hl_enumvalue" href="namespaceripple.html#aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151">tesSUCCESS</a>)</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>}</div>
</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="}">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#aaa57921f6c51e3495cb6bf14b94a4d90"> 85</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#aaa57921f6c51e3495cb6bf14b94a4d90">insertDeliveredAmount</a>(</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; meta,</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; ledger,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; serializedTx,</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</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> <span class="keyword">auto</span> <span class="keyword">const</span> info = ledger.<a class="code hl_function" href="classripple_1_1ReadView.html#aca9d5e022d68fdd94bf3c8e36a294a96">info</a>();</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="namespaceripple_1_1RPC.html#af2dba747db554b22ac5bb723555ce5d8">canHaveDeliveredAmount</a>(serializedTx, transactionMeta))</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">auto</span> <span class="keyword">const</span> getLedgerIndex = [&amp;info] { <span class="keywordflow">return</span> info.<a class="code hl_variable" href="structripple_1_1LedgerHeader.html#a233e04cfeb4d879ab8517d8aabb7e38b">seq</a>; };</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">auto</span> <span class="keyword">const</span> getCloseTime = [&amp;info] { <span class="keywordflow">return</span> info.closeTime; };</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">auto</span> amt = <a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> getLedgerIndex, getCloseTime, serializedTx, transactionMeta);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordflow">if</span> (amt)</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> {</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> meta[jss::delivered_amount] =</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> amt-&gt;getJson(<a class="code hl_enumvalue" href="structripple_1_1JsonOptions.html#ab85e43ec84df987200d3355c3ba89f0aafbf455cd24e4be77ea2f5049de627345">JsonOptions::include_date</a>);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> }</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> {</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// report &quot;unavailable&quot; which cannot be parsed into a sensible</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="comment">// amount.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> meta[jss::delivered_amount] = <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>(<span class="stringliteral">&quot;unavailable&quot;</span>);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> }</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>}</div>
</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> GetLedgerIndex&gt;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a></div>
<div class="foldopen" id="foldopen00116" data-start="{" data-end="}">
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a81a899ab4c4d932032421f36b17af879"> 116</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <a class="code hl_struct" href="structripple_1_1RPC_1_1Context.html">RPC::Context</a> <span class="keyword">const</span>&amp; context,</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; serializedTx,</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta,</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> GetLedgerIndex <span class="keyword">const</span>&amp; getLedgerIndex)</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span>{</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="namespaceripple_1_1RPC.html#af2dba747db554b22ac5bb723555ce5d8">canHaveDeliveredAmount</a>(serializedTx, transactionMeta))</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">auto</span> <span class="keyword">const</span> getCloseTime =</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> [&amp;context,</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> &amp;getLedgerIndex]() -&gt; <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;NetClock::time_point&gt;</a> {</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keywordflow">return</span> context.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a92c98828663b6b80d3eb15850ec6897a">ledgerMaster</a>.<a class="code hl_function" href="classripple_1_1LedgerMaster.html#a330510efd66b4b08e57f5c0b896560ef">getCloseTimeBySeq</a>(getLedgerIndex());</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> };</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> getLedgerIndex, getCloseTime, serializedTx, transactionMeta);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> }</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <span class="keywordflow">return</span> {};</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>}</div>
</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a></div>
<div class="foldopen" id="foldopen00137" data-start="{" data-end="}">
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47"> 137</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <a class="code hl_struct" href="structripple_1_1RPC_1_1Context.html">RPC::Context</a> <span class="keyword">const</span>&amp; context,</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; serializedTx,</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta,</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">LedgerIndex</a> <span class="keyword">const</span>&amp; ledgerIndex)</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>{</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> context, serializedTx, transactionMeta, [&amp;ledgerIndex]() {</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keywordflow">return</span> ledgerIndex;</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> });</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span>}</div>
</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00150" data-start="{" data-end="}">
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#afbdb96d85459c86ea0d79cd413792764"> 150</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#aaa57921f6c51e3495cb6bf14b94a4d90">insertDeliveredAmount</a>(</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; meta,</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <a class="code hl_struct" href="structripple_1_1RPC_1_1JsonContext.html">RPC::JsonContext</a> <span class="keyword">const</span>&amp; context,</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Transaction&gt;</a> <span class="keyword">const</span>&amp; transaction,</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>{</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> <a class="code hl_function" href="namespaceripple_1_1RPC.html#aaa57921f6c51e3495cb6bf14b94a4d90">insertDeliveredAmount</a>(</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> meta, context, transaction-&gt;getSTransaction(), transactionMeta);</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span>}</div>
</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00161" data-start="{" data-end="}">
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="namespaceripple_1_1RPC.html#a4e4269e3d476eca12efe8663ac3c9b08"> 161</a></span><a class="code hl_function" href="namespaceripple_1_1RPC.html#aaa57921f6c51e3495cb6bf14b94a4d90">insertDeliveredAmount</a>(</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; meta,</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> <a class="code hl_struct" href="structripple_1_1RPC_1_1JsonContext.html">RPC::JsonContext</a> <span class="keyword">const</span>&amp; context,</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;STTx const&gt;</a> <span class="keyword">const</span>&amp; transaction,</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <a class="code hl_class" href="classripple_1_1TxMeta.html">TxMeta</a> <span class="keyword">const</span>&amp; transactionMeta)</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span>{</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="namespaceripple_1_1RPC.html#af2dba747db554b22ac5bb723555ce5d8">canHaveDeliveredAmount</a>(transaction, transactionMeta))</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> {</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">auto</span> amt = <a class="code hl_function" href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">getDeliveredAmount</a>(</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> context, transaction, transactionMeta, [&amp;transactionMeta]() {</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> <span class="keywordflow">return</span> transactionMeta.<a class="code hl_function" href="classripple_1_1TxMeta.html#a835cdd996c2ada5f9cb9215491a7e4ee">getLgrSeq</a>();</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> });</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordflow">if</span> (amt)</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> {</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> meta[jss::delivered_amount] =</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> amt-&gt;getJson(<a class="code hl_enumvalue" href="structripple_1_1JsonOptions.html#ab85e43ec84df987200d3355c3ba89f0aafbf455cd24e4be77ea2f5049de627345">JsonOptions::include_date</a>);</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> }</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> {</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> <span class="comment">// report &quot;unavailable&quot; which cannot be parsed into a sensible</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> <span class="comment">// amount.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> meta[jss::delivered_amount] = <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>(<span class="stringliteral">&quot;unavailable&quot;</span>);</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> }</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> }</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span>}</div>
</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span>} <span class="comment">// namespace RPC</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></div></div>
<div class="ttc" id="aclassripple_1_1LedgerMaster_html_a330510efd66b4b08e57f5c0b896560ef"><div class="ttname"><a href="classripple_1_1LedgerMaster.html#a330510efd66b4b08e57f5c0b896560ef">ripple::LedgerMaster::getCloseTimeBySeq</a></div><div class="ttdeci">std::optional&lt; NetClock::time_point &gt; getCloseTimeBySeq(LedgerIndex ledgerIndex)</div><div class="ttdef"><b>Definition</b> <a href="LedgerMaster_8cpp_source.html#l01581">LedgerMaster.cpp:1581</a></div></div>
<div class="ttc" id="aclassripple_1_1ReadView_html"><div class="ttname"><a href="classripple_1_1ReadView.html">ripple::ReadView</a></div><div class="ttdoc">A view into a ledger.</div><div class="ttdef"><b>Definition</b> <a href="ReadView_8h_source.html#l00031">ReadView.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1ReadView_html_aca9d5e022d68fdd94bf3c8e36a294a96"><div class="ttname"><a href="classripple_1_1ReadView.html#aca9d5e022d68fdd94bf3c8e36a294a96">ripple::ReadView::info</a></div><div class="ttdeci">virtual LedgerInfo const &amp; info() const =0</div><div class="ttdoc">Returns information about the ledger.</div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html"><div class="ttname"><a href="classripple_1_1TxMeta.html">ripple::TxMeta</a></div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00015">TxMeta.h:16</a></div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html_a835cdd996c2ada5f9cb9215491a7e4ee"><div class="ttname"><a href="classripple_1_1TxMeta.html#a835cdd996c2ada5f9cb9215491a7e4ee">ripple::TxMeta::getLgrSeq</a></div><div class="ttdeci">std::uint32_t getLgrSeq() const</div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00028">TxMeta.h:28</a></div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html_aa5fff1a8fd590ce06ae81e8cd92f092f"><div class="ttname"><a href="classripple_1_1TxMeta.html#aa5fff1a8fd590ce06ae81e8cd92f092f">ripple::TxMeta::getResultTER</a></div><div class="ttdeci">TER getResultTER() const</div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00038">TxMeta.h:38</a></div></div>
<div class="ttc" id="aclassripple_1_1TxMeta_html_af0baceb9d2dadb4a6a956f2db5aa4b06"><div class="ttname"><a href="classripple_1_1TxMeta.html#af0baceb9d2dadb4a6a956f2db5aa4b06">ripple::TxMeta::getDeliveredAmount</a></div><div class="ttdeci">std::optional&lt; STAmount &gt; const &amp; getDeliveredAmount() const</div><div class="ttdef"><b>Definition</b> <a href="TxMeta_8h_source.html#l00091">TxMeta.h:91</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a7be9b8fa56565507dd8342f8b0dece47"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a7be9b8fa56565507dd8342f8b0dece47">ripple::RPC::getDeliveredAmount</a></div><div class="ttdeci">std::optional&lt; STAmount &gt; getDeliveredAmount(RPC::Context const &amp;context, std::shared_ptr&lt; STTx const &gt; const &amp;serializedTx, TxMeta const &amp;transactionMeta, LedgerIndex const &amp;ledgerIndex)</div><div class="ttdef"><b>Definition</b> <a href="DeliveredAmount_8cpp_source.html#l00137">DeliveredAmount.cpp:137</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_aaa57921f6c51e3495cb6bf14b94a4d90"><div class="ttname"><a href="namespaceripple_1_1RPC.html#aaa57921f6c51e3495cb6bf14b94a4d90">ripple::RPC::insertDeliveredAmount</a></div><div class="ttdeci">void insertDeliveredAmount(Json::Value &amp;meta, ReadView const &amp;, std::shared_ptr&lt; STTx const &gt; const &amp;serializedTx, TxMeta const &amp;)</div><div class="ttdoc">Add a delivered_amount field to the meta input/output parameter.</div><div class="ttdef"><b>Definition</b> <a href="DeliveredAmount_8cpp_source.html#l00085">DeliveredAmount.cpp:85</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_af2dba747db554b22ac5bb723555ce5d8"><div class="ttname"><a href="namespaceripple_1_1RPC.html#af2dba747db554b22ac5bb723555ce5d8">ripple::RPC::canHaveDeliveredAmount</a></div><div class="ttdeci">bool canHaveDeliveredAmount(std::shared_ptr&lt; STTx const &gt; const &amp;serializedTx, TxMeta const &amp;transactionMeta)</div><div class="ttdef"><b>Definition</b> <a href="DeliveredAmount_8cpp_source.html#l00065">DeliveredAmount.cpp:65</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#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2ce3074a39ea65126b82fc59baf43126"><div class="ttname"><a href="namespaceripple.html#a2ce3074a39ea65126b82fc59baf43126">ripple::TxType</a></div><div class="ttdeci">TxType</div><div class="ttdoc">Transaction type identifiers.</div><div class="ttdef"><b>Definition</b> <a href="TxFormats_8h_source.html#l00037">TxFormats.h:38</a></div></div>
<div class="ttc" id="anamespaceripple_html_aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151"><div class="ttname"><a href="namespaceripple.html#aabc7f150d5082c73116a1cd5962b434da28c7d8b3ed759d363503a05fcd59f151">ripple::tesSUCCESS</a></div><div class="ttdeci">@ tesSUCCESS</div><div class="ttdef"><b>Definition</b> <a href="TER_8h_source.html#l00227">TER.h:226</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="astructripple_1_1JsonOptions_html_ab85e43ec84df987200d3355c3ba89f0aafbf455cd24e4be77ea2f5049de627345"><div class="ttname"><a href="structripple_1_1JsonOptions.html#ab85e43ec84df987200d3355c3ba89f0aafbf455cd24e4be77ea2f5049de627345">ripple::JsonOptions::include_date</a></div><div class="ttdeci">@ include_date</div><div class="ttdef"><b>Definition</b> <a href="STBase_8h_source.html#l00025">STBase.h:25</a></div></div>
<div class="ttc" id="astructripple_1_1LedgerHeader_html_a233e04cfeb4d879ab8517d8aabb7e38b"><div class="ttname"><a href="structripple_1_1LedgerHeader.html#a233e04cfeb4d879ab8517d8aabb7e38b">ripple::LedgerHeader::seq</a></div><div class="ttdeci">LedgerIndex seq</div><div class="ttdef"><b>Definition</b> <a href="LedgerHeader_8h_source.html#l00022">LedgerHeader.h:22</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Context_html"><div class="ttname"><a href="structripple_1_1RPC_1_1Context.html">ripple::RPC::Context</a></div><div class="ttdoc">The context of information needed to call an RPC.</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00019">Context.h:20</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Context_html_a92c98828663b6b80d3eb15850ec6897a"><div class="ttname"><a href="structripple_1_1RPC_1_1Context.html#a92c98828663b6b80d3eb15850ec6897a">ripple::RPC::Context::ledgerMaster</a></div><div class="ttdeci">LedgerMaster &amp; ledgerMaster</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00025">Context.h:25</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_html"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext.html">ripple::RPC::JsonContext</a></div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00033">Context.h:34</a></div></div>
<div class="ttc" id="atime_point_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/time_point.html">std::chrono::time_point</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