ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/AMMDeposit_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

245 lines
41 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: AMMDeposit.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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_4b2d6f306dc33741b6f38a59a670a446.html">tx</a></li><li class="navelem"><a class="el" href="dir_7b1ffcd2aae1e871efc2e94c72e78699.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">AMMDeposit.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="preprocessor">#ifndef XRPL_TX_AMMDEPOSIT_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TX_AMMDEPOSIT_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/tx/detail/Transactor.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">class </span>Sandbox;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="};">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1AMMDeposit.html"> 43</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1AMMDeposit.html">AMMDeposit</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1Transactor.html">Transactor</a></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>{</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1AMMDeposit.html#ab8190e434de81091a994e511dd4d293f"> 46</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_enumeration" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> <a class="code hl_variable" href="classripple_1_1AMMDeposit.html#ab8190e434de81091a994e511dd4d293f">ConsequencesFactory</a>{<a class="code hl_enumvalue" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>};</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="foldopen" id="foldopen00048" data-start="{" data-end="}">
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1AMMDeposit.html#af63010c83c7bc12b999a81c5b26aa023"> 48</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#af63010c83c7bc12b999a81c5b26aa023">AMMDeposit</a>(<a class="code hl_class" href="classripple_1_1ApplyContext.html">ApplyContext</a>&amp; ctx) : <a class="code hl_class" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> {</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
</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="keyword">static</span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#ab200ac70a4c9861acef3c2efb4521f68">checkExtraFeatures</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</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="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a2eb419b10a05051aa1f736d8c98cde57">getFlagsMask</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</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> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a9a77c5ee8dcce8013ddb3b875e8a8b05">preflight</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</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="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a5cd7c6df65846108840ff91aa3a814f5">preclaim</a>(<a class="code hl_struct" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#ac92c10f978f5a831447bd7cdc5a0d1ef">doApply</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, bool&gt;</a></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a0494829d8e22b029e7dfb90ee970fda1">applyGuts</a>(<a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#adcf4670f2b402a00f166d0f342a75714">deposit</a>(</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountDeposit,</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; amount2Deposit,</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lpTokensDeposit,</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; depositMin,</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; deposit2Min,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; lpTokensDepositMin,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#aaf3f2a49ffb3a83e42b3daf49f33319f">equalDepositTokens</a>(</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount2Balance,</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lpTokensDeposit,</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; depositMin,</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; deposit2Min,</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </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/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a11321a8e5c8d6a60a0dc2baa64ac98a6">equalDepositLimit</a>(</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount2Balance,</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount2,</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; lpTokensDepositMin,</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501">singleDeposit</a>(</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;STAmount&gt;</a> <span class="keyword">const</span>&amp; lpTokensDepositMin,</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#ad27c911271e84c57234e36978b8160bb">singleDepositTokens</a>(</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lpTokensDeposit,</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a5775a9ff666de25c0c0ad243b79b9d0e">singleDepositEPrice</a>(</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amountBalance,</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; lptAMMBalance,</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; ePrice,</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> </div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;TER, STAmount&gt;</a></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#ac9c59cc740132fad1337d18c074a477a">equalDepositInEmptyState</a>(</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> <a class="code hl_class" href="classripple_1_1Sandbox.html">Sandbox</a>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>,</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; ammAccount,</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount,</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount2,</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> <a class="code hl_class" href="classripple_1_1Issue.html">Issue</a> <span class="keyword">const</span>&amp; lptIssue,</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee);</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span>};</div>
</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span><span class="preprocessor">#endif </span><span class="comment">// XRPL_TX_AMMDEPOSIT_H_INCLUDED</span></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html"><div class="ttname"><a href="classripple_1_1AMMDeposit.html">ripple::AMMDeposit</a></div><div class="ttdoc">AMMDeposit implements AMM deposit Transactor.</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8h_source.html#l00043">AMMDeposit.h:44</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a0494829d8e22b029e7dfb90ee970fda1"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a0494829d8e22b029e7dfb90ee970fda1">ripple::AMMDeposit::applyGuts</a></div><div class="ttdeci">std::pair&lt; TER, bool &gt; applyGuts(Sandbox &amp;view)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00351">AMMDeposit.cpp:351</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a11321a8e5c8d6a60a0dc2baa64ac98a6"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a11321a8e5c8d6a60a0dc2baa64ac98a6">ripple::AMMDeposit::equalDepositLimit</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; equalDepositLimit(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount2Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, STAmount const &amp;amount2, std::optional&lt; STAmount &gt; const &amp;lpTokensDepositMin, std::uint16_t tfee)</div><div class="ttdoc">Equal asset deposit (Asset1In, Asset2In) with the constraint on the maximum amount of both assets tha...</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00702">AMMDeposit.cpp:702</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a2eb419b10a05051aa1f736d8c98cde57"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a2eb419b10a05051aa1f736d8c98cde57">ripple::AMMDeposit::getFlagsMask</a></div><div class="ttdeci">static std::uint32_t getFlagsMask(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00020">AMMDeposit.cpp:20</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a5775a9ff666de25c0c0ad243b79b9d0e"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a5775a9ff666de25c0c0ad243b79b9d0e">ripple::AMMDeposit::singleDepositEPrice</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleDepositEPrice(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount, STAmount const &amp;lptAMMBalance, STAmount const &amp;ePrice, std::uint16_t tfee)</div><div class="ttdoc">Single asset deposit (Asset1In, EPrice) with two constraints.</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00884">AMMDeposit.cpp:884</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a5cd7c6df65846108840ff91aa3a814f5"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a5cd7c6df65846108840ff91aa3a814f5">ripple::AMMDeposit::preclaim</a></div><div class="ttdeci">static TER preclaim(PreclaimContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00149">AMMDeposit.cpp:149</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a7242a93c72c9cb498849fb149ded3501"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501">ripple::AMMDeposit::singleDeposit</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleDeposit(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;lptAMMBalance, STAmount const &amp;amount, std::optional&lt; STAmount &gt; const &amp;lpTokensDepositMin, std::uint16_t tfee)</div><div class="ttdoc">Single asset deposit (Asset1In) by the amount.</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00779">AMMDeposit.cpp:779</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_a9a77c5ee8dcce8013ddb3b875e8a8b05"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#a9a77c5ee8dcce8013ddb3b875e8a8b05">ripple::AMMDeposit::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00027">AMMDeposit.cpp:27</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_aaf3f2a49ffb3a83e42b3daf49f33319f"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#aaf3f2a49ffb3a83e42b3daf49f33319f">ripple::AMMDeposit::equalDepositTokens</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; equalDepositTokens(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount2Balance, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokensDeposit, std::optional&lt; STAmount &gt; const &amp;depositMin, std::optional&lt; STAmount &gt; const &amp;deposit2Min, std::uint16_t tfee)</div><div class="ttdoc">Equal asset deposit (LPTokens) for the specified share of the AMM instance pools.</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00626">AMMDeposit.cpp:626</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_ab200ac70a4c9861acef3c2efb4521f68"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#ab200ac70a4c9861acef3c2efb4521f68">ripple::AMMDeposit::checkExtraFeatures</a></div><div class="ttdeci">static bool checkExtraFeatures(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00014">AMMDeposit.cpp:14</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_ab8190e434de81091a994e511dd4d293f"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#ab8190e434de81091a994e511dd4d293f">ripple::AMMDeposit::ConsequencesFactory</a></div><div class="ttdeci">static constexpr ConsequencesFactoryType ConsequencesFactory</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8h_source.html#l00046">AMMDeposit.h:46</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_ac92c10f978f5a831447bd7cdc5a0d1ef"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#ac92c10f978f5a831447bd7cdc5a0d1ef">ripple::AMMDeposit::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00466">AMMDeposit.cpp:466</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_ac9c59cc740132fad1337d18c074a477a"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#ac9c59cc740132fad1337d18c074a477a">ripple::AMMDeposit::equalDepositInEmptyState</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; equalDepositInEmptyState(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amount, STAmount const &amp;amount2, Issue const &amp;lptIssue, std::uint16_t tfee)</div><div class="ttdoc">Equal deposit in empty AMM state (LP tokens balance is 0)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00989">AMMDeposit.cpp:989</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_ad27c911271e84c57234e36978b8160bb"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#ad27c911271e84c57234e36978b8160bb">ripple::AMMDeposit::singleDepositTokens</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; singleDepositTokens(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amount, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokensDeposit, std::uint16_t tfee)</div><div class="ttdoc">Single asset deposit (Asset1In, LPTokens) by the tokens.</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00826">AMMDeposit.cpp:826</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_adcf4670f2b402a00f166d0f342a75714"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#adcf4670f2b402a00f166d0f342a75714">ripple::AMMDeposit::deposit</a></div><div class="ttdeci">std::pair&lt; TER, STAmount &gt; deposit(Sandbox &amp;view, AccountID const &amp;ammAccount, STAmount const &amp;amountBalance, STAmount const &amp;amountDeposit, std::optional&lt; STAmount &gt; const &amp;amount2Deposit, STAmount const &amp;lptAMMBalance, STAmount const &amp;lpTokensDeposit, std::optional&lt; STAmount &gt; const &amp;depositMin, std::optional&lt; STAmount &gt; const &amp;deposit2Min, std::optional&lt; STAmount &gt; const &amp;lpTokensDepositMin, std::uint16_t tfee)</div><div class="ttdoc">Deposit requested assets and token amount into LP account.</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8cpp_source.html#l00480">AMMDeposit.cpp:480</a></div></div>
<div class="ttc" id="aclassripple_1_1AMMDeposit_html_af63010c83c7bc12b999a81c5b26aa023"><div class="ttname"><a href="classripple_1_1AMMDeposit.html#af63010c83c7bc12b999a81c5b26aa023">ripple::AMMDeposit::AMMDeposit</a></div><div class="ttdeci">AMMDeposit(ApplyContext &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="AMMDeposit_8h_source.html#l00048">AMMDeposit.h:48</a></div></div>
<div class="ttc" id="aclassripple_1_1ApplyContext_html"><div class="ttname"><a href="classripple_1_1ApplyContext.html">ripple::ApplyContext</a></div><div class="ttdoc">State information when applying a tx.</div><div class="ttdef"><b>Definition</b> <a href="ApplyContext_8h_source.html#l00017">ApplyContext.h:18</a></div></div>
<div class="ttc" id="aclassripple_1_1Issue_html"><div class="ttname"><a href="classripple_1_1Issue.html">ripple::Issue</a></div><div class="ttdoc">A currency issued by an account.</div><div class="ttdef"><b>Definition</b> <a href="Issue_8h_source.html#l00013">Issue.h:14</a></div></div>
<div class="ttc" id="aclassripple_1_1STAmount_html"><div class="ttname"><a href="classripple_1_1STAmount.html">ripple::STAmount</a></div><div class="ttdef"><b>Definition</b> <a href="STAmount_8h_source.html#l00030">STAmount.h:31</a></div></div>
<div class="ttc" id="aclassripple_1_1Sandbox_html"><div class="ttname"><a href="classripple_1_1Sandbox.html">ripple::Sandbox</a></div><div class="ttdoc">Discardable, editable view to a ledger.</div><div class="ttdef"><b>Definition</b> <a href="Sandbox_8h_source.html#l00015">Sandbox.h:16</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset</a></div><div class="ttdef"><b>Definition</b> <a href="TER_8h_source.html#l00395">TER.h:396</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html"><div class="ttname"><a href="classripple_1_1Transactor.html">ripple::Transactor</a></div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00121">Transactor.h:122</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ripple::Transactor::ConsequencesFactoryType</a></div><div class="ttdeci">ConsequencesFactoryType</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00138">Transactor.h:138</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">ripple::Transactor::Normal</a></div><div class="ttdeci">@ Normal</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00138">Transactor.h:138</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a9acc4edc9b8f2a11a27fbcf5e93e2fe2"><div class="ttname"><a href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">ripple::Transactor::view</a></div><div class="ttdeci">ApplyView &amp; view()</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00144">Transactor.h:144</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="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_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="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="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimContext_html"><div class="ttname"><a href="structripple_1_1PreclaimContext.html">ripple::PreclaimContext</a></div><div class="ttdoc">State information when determining if a tx is likely to claim a fee.</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00060">Transactor.h:61</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightContext_html"><div class="ttname"><a href="structripple_1_1PreflightContext.html">ripple::PreflightContext</a></div><div class="ttdoc">State information when preflighting a tx.</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00015">Transactor.h:16</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