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
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/AMMDeposit_8h_source.html
ximinez e1dae4fb62 deploy: 3cbdf818a7
2025-09-18 10:58:55 -07:00

256 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: 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="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) 2023 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_TX_AMMDEPOSIT_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_TX_AMMDEPOSIT_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpld/app/tx/detail/Transactor.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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</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">class </span>Sandbox;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00062" data-start="{" data-end="};">
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1AMMDeposit.html"> 62</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="l00063" name="l00063"></a><span class="lineno"> 63</span>{</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classripple_1_1AMMDeposit.html#ab8190e434de81091a994e511dd4d293f"> 65</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="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="foldopen" id="foldopen00067" data-start="{" data-end="}">
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classripple_1_1AMMDeposit.html#af63010c83c7bc12b999a81c5b26aa023"> 67</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="l00068" name="l00068"></a><span class="lineno"> 68</span> {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> }</div>
</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</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="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</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="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</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="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</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="l00082" name="l00082"></a><span class="lineno"> 82</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="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</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="l00100" name="l00100"></a><span class="lineno"> 100</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#adcf4670f2b402a00f166d0f342a75714">deposit</a>(</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</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="l00102" name="l00102"></a><span class="lineno"> 102</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="l00103" name="l00103"></a><span class="lineno"> 103</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="l00104" name="l00104"></a><span class="lineno"> 104</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="l00105" name="l00105"></a><span class="lineno"> 105</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="l00106" name="l00106"></a><span class="lineno"> 106</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="l00107" name="l00107"></a><span class="lineno"> 107</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="l00108" name="l00108"></a><span class="lineno"> 108</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="l00109" name="l00109"></a><span class="lineno"> 109</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="l00110" name="l00110"></a><span class="lineno"> 110</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="l00111" name="l00111"></a><span class="lineno"> 111</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="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</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="l00127" name="l00127"></a><span class="lineno"> 127</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#aaf3f2a49ffb3a83e42b3daf49f33319f">equalDepositTokens</a>(</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</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="l00129" name="l00129"></a><span class="lineno"> 129</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="l00130" name="l00130"></a><span class="lineno"> 130</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="l00131" name="l00131"></a><span class="lineno"> 131</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="l00132" name="l00132"></a><span class="lineno"> 132</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="l00133" name="l00133"></a><span class="lineno"> 133</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="l00134" name="l00134"></a><span class="lineno"> 134</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="l00135" name="l00135"></a><span class="lineno"> 135</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="l00136" name="l00136"></a><span class="lineno"> 136</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="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</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="l00153" name="l00153"></a><span class="lineno"> 153</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a11321a8e5c8d6a60a0dc2baa64ac98a6">equalDepositLimit</a>(</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</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="l00155" name="l00155"></a><span class="lineno"> 155</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="l00156" name="l00156"></a><span class="lineno"> 156</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="l00157" name="l00157"></a><span class="lineno"> 157</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="l00158" name="l00158"></a><span class="lineno"> 158</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="l00159" name="l00159"></a><span class="lineno"> 159</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="l00160" name="l00160"></a><span class="lineno"> 160</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="l00161" name="l00161"></a><span class="lineno"> 161</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="l00162" name="l00162"></a><span class="lineno"> 162</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="l00163" name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</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="l00176" name="l00176"></a><span class="lineno"> 176</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501">singleDeposit</a>(</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</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="l00178" name="l00178"></a><span class="lineno"> 178</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="l00179" name="l00179"></a><span class="lineno"> 179</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="l00180" name="l00180"></a><span class="lineno"> 180</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="l00181" name="l00181"></a><span class="lineno"> 181</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="l00182" name="l00182"></a><span class="lineno"> 182</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="l00183" name="l00183"></a><span class="lineno"> 183</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="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</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="l00197" name="l00197"></a><span class="lineno"> 197</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#ad27c911271e84c57234e36978b8160bb">singleDepositTokens</a>(</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</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="l00199" name="l00199"></a><span class="lineno"> 199</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="l00200" name="l00200"></a><span class="lineno"> 200</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="l00201" name="l00201"></a><span class="lineno"> 201</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="l00202" name="l00202"></a><span class="lineno"> 202</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="l00203" name="l00203"></a><span class="lineno"> 203</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="l00204" name="l00204"></a><span class="lineno"> 204</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="l00205" name="l00205"></a><span class="lineno"> 205</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</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="l00218" name="l00218"></a><span class="lineno"> 218</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#a5775a9ff666de25c0c0ad243b79b9d0e">singleDepositEPrice</a>(</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</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="l00220" name="l00220"></a><span class="lineno"> 220</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="l00221" name="l00221"></a><span class="lineno"> 221</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="l00222" name="l00222"></a><span class="lineno"> 222</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="l00223" name="l00223"></a><span class="lineno"> 223</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="l00224" name="l00224"></a><span class="lineno"> 224</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="l00225" name="l00225"></a><span class="lineno"> 225</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="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</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="l00236" name="l00236"></a><span class="lineno"> 236</span> <a class="code hl_function" href="classripple_1_1AMMDeposit.html#ac9c59cc740132fad1337d18c074a477a">equalDepositInEmptyState</a>(</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</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="l00238" name="l00238"></a><span class="lineno"> 238</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="l00239" name="l00239"></a><span class="lineno"> 239</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="l00240" name="l00240"></a><span class="lineno"> 240</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="l00241" name="l00241"></a><span class="lineno"> 241</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="l00242" name="l00242"></a><span class="lineno"> 242</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="l00243" name="l00243"></a><span class="lineno"> 243</span>};</div>
</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> </div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> </div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_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#l00062">AMMDeposit.h:63</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#l00368">AMMDeposit.cpp:368</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#l00719">AMMDeposit.cpp:719</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#l00901">AMMDeposit.cpp:901</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#l00166">AMMDeposit.cpp:166</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#l00796">AMMDeposit.cpp:796</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#l00033">AMMDeposit.cpp:33</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#l00643">AMMDeposit.cpp:643</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#l00065">AMMDeposit.h:65</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#l00483">AMMDeposit.cpp:483</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#l01006">AMMDeposit.cpp:1006</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#l00843">AMMDeposit.cpp:843</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#l00497">AMMDeposit.cpp:497</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#l00067">AMMDeposit.h:67</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#l00036">ApplyContext.h:37</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#l00032">Issue.h:33</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#l00049">STAmount.h:50</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#l00034">Sandbox.h:35</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#l00410">TER.h:411</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#l00138">Transactor.h:139</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#l00155">Transactor.h:155</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#l00155">Transactor.h:155</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#l00161">Transactor.h:161</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::uint16_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#l00025">algorithm.h:25</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#l00079">Transactor.h:80</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#l00034">Transactor.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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink