mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
151 lines
19 KiB
HTML
151 lines
19 KiB
HTML
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: AMMCreate.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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_08bd996c7140e5d4c4a2548bd66a393f.html">tx</a></li><li class="navelem"><a class="el" href="dir_03680b44059da148632e530fc6dc63c7.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">AMMCreate.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_TX_AMMCREATE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_TX_AMMCREATE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/app/tx/impl/Transactor.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1AMMCreate.html"> 57</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1AMMCreate.html">AMMCreate</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1Transactor.html">Transactor</a></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> {</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classripple_1_1AMMCreate.html#a82a56dd6210d9dfe231a7a41cdea85bf"> 60</a></span>  <span class="keyword">static</span> constexpr <a class="code" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> <a class="code" href="classripple_1_1AMMCreate.html#a82a56dd6210d9dfe231a7a41cdea85bf">ConsequencesFactory</a>{<a class="code" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>};</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1AMMCreate.html#aa61d51e4eaeae5c4e725bc9a46b3b859"> 62</a></span>  <span class="keyword">explicit</span> <a class="code" href="classripple_1_1AMMCreate.html#aa61d51e4eaeae5c4e725bc9a46b3b859">AMMCreate</a>(<a class="code" href="classripple_1_1ApplyContext.html">ApplyContext</a>& ctx) : <a class="code" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">NotTEC</a></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="classripple_1_1AMMCreate.html#a7fb869f61591c8f5daedd40628398bdd">preflight</a>(<a class="code" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>& ctx);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <a class="code" href="classripple_1_1XRPAmount.html">XRPAmount</a></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classripple_1_1AMMCreate.html#aacbb467211f50a54170c9934f65f7e12">calculateBaseFee</a>(<a class="code" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>& <a class="code" href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">view</a>, <a class="code" href="classripple_1_1STTx.html">STTx</a> <span class="keyword">const</span>& tx);</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classripple_1_1AMMCreate.html#a3da5c9273404ba0fa33c9f428827d8b0">preclaim</a>(<a class="code" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> <span class="keyword">const</span>& ctx);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classripple_1_1TERSubset.html">TER</a></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classripple_1_1AMMCreate.html#a68a6b3ead4b86444308a5378bbad2723">doApply</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif // RIPPLE_TX_AMMCREATE_H_INCLUDED</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html_aa61d51e4eaeae5c4e725bc9a46b3b859"><div class="ttname"><a href="classripple_1_1AMMCreate.html#aa61d51e4eaeae5c4e725bc9a46b3b859">ripple::AMMCreate::AMMCreate</a></div><div class="ttdeci">AMMCreate(ApplyContext &ctx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8h_source.html#l00062">AMMCreate.h:62</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html_aacbb467211f50a54170c9934f65f7e12"><div class="ttname"><a href="classripple_1_1AMMCreate.html#aacbb467211f50a54170c9934f65f7e12">ripple::AMMCreate::calculateBaseFee</a></div><div class="ttdeci">static XRPAmount calculateBaseFee(ReadView const &view, STTx const &tx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8cpp_source.html#l00082">AMMCreate.cpp:82</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#l00085">Transactor.h:85</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html_a7fb869f61591c8f5daedd40628398bdd"><div class="ttname"><a href="classripple_1_1AMMCreate.html#a7fb869f61591c8f5daedd40628398bdd">ripple::AMMCreate::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &ctx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8cpp_source.html#l00036">AMMCreate.cpp:36</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html"><div class="ttname"><a href="classripple_1_1AMMCreate.html">ripple::AMMCreate</a></div><div class="ttdoc">AMMCreate implements Automatic Market Maker(AMM) creation Transactor.</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8h_source.html#l00057">AMMCreate.h:57</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html_a82a56dd6210d9dfe231a7a41cdea85bf"><div class="ttname"><a href="classripple_1_1AMMCreate.html#a82a56dd6210d9dfe231a7a41cdea85bf">ripple::AMMCreate::ConsequencesFactory</a></div><div class="ttdeci">static constexpr ConsequencesFactoryType ConsequencesFactory</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8h_source.html#l00060">AMMCreate.h:60</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html_a3da5c9273404ba0fa33c9f428827d8b0"><div class="ttname"><a href="classripple_1_1AMMCreate.html#a3da5c9273404ba0fa33c9f428827d8b0">ripple::AMMCreate::preclaim</a></div><div class="ttdeci">static TER preclaim(PreclaimContext const &ctx)</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8cpp_source.html#l00089">AMMCreate.cpp:89</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#l00101">Transactor.h:101</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#l00351">TER.h:351</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1AMMCreate_html_a68a6b3ead4b86444308a5378bbad2723"><div class="ttname"><a href="classripple_1_1AMMCreate.html#a68a6b3ead4b86444308a5378bbad2723">ripple::AMMCreate::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdoc">Attempt to create the AMM instance.</div><div class="ttdef"><b>Definition:</b> <a href="AMMCreate_8cpp_source.html#l00352">AMMCreate.cpp:352</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1STTx_html"><div class="ttname"><a href="classripple_1_1STTx.html">ripple::STTx</a></div><div class="ttdef"><b>Definition:</b> <a href="STTx_8h_source.html#l00045">STTx.h:45</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#l00035">ApplyContext.h:35</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#l00052">Transactor.h:52</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#l00054">ReadView.h:54</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Transactor_html_a1ac5d16d7b21e8af9cc94d7af39a85d5"><div class="ttname"><a href="classripple_1_1Transactor.html#a1ac5d16d7b21e8af9cc94d7af39a85d5">ripple::Transactor::view</a></div><div class="ttdeci">ApplyView & view()</div><div class="ttdef"><b>Definition:</b> <a href="Transactor_8h_source.html#l00107">Transactor.h:107</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#l00101">Transactor.h:101</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#l00031">Transactor.h:31</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1XRPAmount_html"><div class="ttname"><a href="classripple_1_1XRPAmount.html">ripple::XRPAmount</a></div><div class="ttdef"><b>Definition:</b> <a href="XRPAmount_8h_source.html#l00046">XRPAmount.h:46</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|