mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
1847 lines
117 KiB
HTML
1847 lines
117 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::AMMDeposit Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.5 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1AMMDeposit.html">AMMDeposit</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-static-methods">Static Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="classripple_1_1AMMDeposit-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::AMMDeposit Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classripple_1_1AMMDeposit.html" title="AMMDeposit implements AMM deposit Transactor.">AMMDeposit</a> implements AMM deposit <a class="el" href="classripple_1_1Transactor.html">Transactor</a>.
|
|
<a href="classripple_1_1AMMDeposit.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="AMMDeposit_8h_source.html">AMMDeposit.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::AMMDeposit:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1AMMDeposit__inherit__graph.png" border="0" usemap="#aripple_1_1AMMDeposit_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1AMMDeposit_inherit__map" id="aripple_1_1AMMDeposit_inherit__map">
|
|
<area shape="rect" title="AMMDeposit implements AMM deposit Transactor." alt="" coords="5,79,156,104"/>
|
|
<area shape="rect" href="classripple_1_1Transactor.html" title=" " alt="" coords="13,5,148,31"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::AMMDeposit:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1AMMDeposit__coll__graph.png" border="0" usemap="#aripple_1_1AMMDeposit_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1AMMDeposit_coll__map" id="aripple_1_1AMMDeposit_coll__map">
|
|
<area shape="rect" title="AMMDeposit implements AMM deposit Transactor." alt="" coords="2367,938,2517,963"/>
|
|
<area shape="rect" href="classripple_1_1Transactor.html" title=" " alt="" coords="2183,938,2317,963"/>
|
|
<area shape="rect" href="classripple_1_1ApplyContext.html" title="State information when applying a tx." alt="" coords="1948,722,2103,747"/>
|
|
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1479,191,1619,217"/>
|
|
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Source.html" title="Subclasses can be called to write to a stream and have children." alt="" coords="853,69,1021,109"/>
|
|
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1264,99,1432,139"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="557,13,644,38"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="236,5,375,45"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="521,62,680,87"/>
|
|
<area shape="rect" title=" " alt="" coords="864,150,1011,175"/>
|
|
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="508,112,693,152"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,267,349,293"/>
|
|
<area shape="rect" href="classripple_1_1STTx.html" title=" " alt="" coords="888,317,987,342"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="530,412,671,452"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32-bits." alt="" coords="530,316,671,356"/>
|
|
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="538,602,663,627"/>
|
|
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="248,602,363,627"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="224,652,387,692"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="234,488,377,528"/>
|
|
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="233,553,378,578"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="519,176,682,216"/>
|
|
<area shape="rect" href="structripple_1_1LedgerHeader.html" title="Information about the notional ledger backing the view." alt="" coords="1269,659,1427,685"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,424,389,464"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,695,108,721"/>
|
|
<area shape="rect" href="classripple_1_1TERSubset.html" title=" " alt="" coords="1647,688,1793,728"/>
|
|
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="866,1122,1009,1147"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1RawStateTable.html" title=" " alt="" coords="1261,1008,1435,1048"/>
|
|
<area shape="rect" title=" " alt="" coords="518,1057,683,1097"/>
|
|
<area shape="rect" title=" " alt="" coords="488,1122,713,1147"/>
|
|
<area shape="rect" title=" " alt="" coords="496,1172,705,1212"/>
|
|
<area shape="rect" title=" " alt="" coords="493,1236,708,1276"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="553,1007,648,1033"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1665,1062,1775,1087"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1275,1073,1421,1098"/>
|
|
<area shape="rect" href="classripple_1_1OpenView.html" title="Writable ledger view that accumulates state and tx changes." alt="" coords="1653,753,1787,778"/>
|
|
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1282,709,1414,734"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="837,817,1038,842"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="840,767,1035,793"/>
|
|
<area shape="rect" href="classripple_1_1TxsRawView.html" title="Interface for changing ledger entries with transactions." alt="" coords="1273,565,1423,590"/>
|
|
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="874,431,1001,457"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="836,917,1039,971"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="1241,759,1455,857"/>
|
|
<area shape="rect" href="structripple_1_1OpenView_1_1txData.html" title=" " alt="" coords="845,867,1029,893"/>
|
|
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="1297,494,1399,519"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="852,367,1023,407"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="851,652,1023,692"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="859,481,1015,521"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="825,996,1049,1095"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1267,944,1429,984"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="1643,316,1797,356"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a5c6d16e9402d182a835f50b37ce9a938"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> { <a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>
|
|
, <a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938a55caa0901cae976168bf23f19bc3e8f4">Blocker</a>
|
|
, <a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845">Custom</a>
|
|
}</td></tr>
|
|
<tr class="separator:a5c6d16e9402d182a835f50b37ce9a938"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af63010c83c7bc12b999a81c5b26aa023"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#af63010c83c7bc12b999a81c5b26aa023">AMMDeposit</a> (<a class="el" href="classripple_1_1ApplyContext.html">ApplyContext</a> &ctx)</td></tr>
|
|
<tr class="separator:af63010c83c7bc12b999a81c5b26aa023"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac92c10f978f5a831447bd7cdc5a0d1ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#ac92c10f978f5a831447bd7cdc5a0d1ef">doApply</a> () override</td></tr>
|
|
<tr class="separator:ac92c10f978f5a831447bd7cdc5a0d1ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1da35943be8abee6756535e60689de65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1ApplyResult.html">ApplyResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a1da35943be8abee6756535e60689de65">operator()</a> ()</td></tr>
|
|
<tr class="memdesc:a1da35943be8abee6756535e60689de65"><td class="mdescLeft"> </td><td class="mdescRight">Process the transaction. <a href="classripple_1_1Transactor.html#a1da35943be8abee6756535e60689de65">More...</a><br /></td></tr>
|
|
<tr class="separator:a1da35943be8abee6756535e60689de65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9acc4edc9b8f2a11a27fbcf5e93e2fe2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a> ()</td></tr>
|
|
<tr class="separator:a9acc4edc9b8f2a11a27fbcf5e93e2fe2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbfc65493c2efc1defca8bc10523a9c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#afbfc65493c2efc1defca8bc10523a9c7">view</a> () const</td></tr>
|
|
<tr class="separator:afbfc65493c2efc1defca8bc10523a9c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9a77c5ee8dcce8013ddb3b875e8a8b05"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#a9a77c5ee8dcce8013ddb3b875e8a8b05">preflight</a> (<a class="el" href="structripple_1_1PreflightContext.html">PreflightContext</a> const &ctx)</td></tr>
|
|
<tr class="separator:a9a77c5ee8dcce8013ddb3b875e8a8b05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cd7c6df65846108840ff91aa3a814f5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#a5cd7c6df65846108840ff91aa3a814f5">preclaim</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &ctx)</td></tr>
|
|
<tr class="separator:a5cd7c6df65846108840ff91aa3a814f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a433ee7a44770c882927f2eedf20e6c71"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a433ee7a44770c882927f2eedf20e6c71">checkSeqProxy</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="classripple_1_1STTx.html">STTx</a> const &tx, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
|
|
<tr class="separator:a433ee7a44770c882927f2eedf20e6c71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f3af178ae553ba91b5893fbcc4ade7f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a2f3af178ae553ba91b5893fbcc4ade7f">checkPriorTxAndLastLedger</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &ctx)</td></tr>
|
|
<tr class="separator:a2f3af178ae553ba91b5893fbcc4ade7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a356c16a6a5d7ccade18cf4c9fb58cc38"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a356c16a6a5d7ccade18cf4c9fb58cc38">checkFee</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &ctx, <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> baseFee)</td></tr>
|
|
<tr class="separator:a356c16a6a5d7ccade18cf4c9fb58cc38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4501e41a5df4853bb93e7f85ec6abaf7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a4501e41a5df4853bb93e7f85ec6abaf7">checkSign</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &ctx)</td></tr>
|
|
<tr class="separator:a4501e41a5df4853bb93e7f85ec6abaf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a428581db1f9eea2f41cf9e371a1e557d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a428581db1f9eea2f41cf9e371a1e557d">calculateBaseFee</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="classripple_1_1STTx.html">STTx</a> const &tx)</td></tr>
|
|
<tr class="separator:a428581db1f9eea2f41cf9e371a1e557d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac424955fc06a7eb920a93fe517ad8d69"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#ac424955fc06a7eb920a93fe517ad8d69">ticketDelete</a> (<a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &account, <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &ticketIndex, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
|
|
<tr class="separator:ac424955fc06a7eb920a93fe517ad8d69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ab8190e434de81091a994e511dd4d293f"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#ab8190e434de81091a994e511dd4d293f">ConsequencesFactory</a> {<a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>}</td></tr>
|
|
<tr class="separator:ab8190e434de81091a994e511dd4d293f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:ac2faaa3bfd1c9b9f91ae24f367474d0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#ac2faaa3bfd1c9b9f91ae24f367474d0f">apply</a> ()</td></tr>
|
|
<tr class="separator:ac2faaa3bfd1c9b9f91ae24f367474d0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac251aaee739d07ccdd565f2e9d9f336e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#ac251aaee739d07ccdd565f2e9d9f336e">preCompute</a> ()</td></tr>
|
|
<tr class="separator:ac251aaee739d07ccdd565f2e9d9f336e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
|
|
Static Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a5c4568739676c5335b8d63dc375f7920"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a5c4568739676c5335b8d63dc375f7920">minimumFee</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &app, <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> baseFee, <a class="el" href="structripple_1_1Fees.html">Fees</a> const &fees, <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags)</td></tr>
|
|
<tr class="memdesc:a5c4568739676c5335b8d63dc375f7920"><td class="mdescLeft"> </td><td class="mdescRight">Compute the minimum fee required to process a transaction with a given baseFee based on the current server load. <a href="classripple_1_1Transactor.html#a5c4568739676c5335b8d63dc375f7920">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c4568739676c5335b8d63dc375f7920"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:aef4ef0a89b5595b2a688b89e4ecef833"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ApplyContext.html">ApplyContext</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#aef4ef0a89b5595b2a688b89e4ecef833">ctx_</a></td></tr>
|
|
<tr class="separator:aef4ef0a89b5595b2a688b89e4ecef833"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab84d1ef5275a1c6c63176c11d72d6235"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#ab84d1ef5275a1c6c63176c11d72d6235">j_</a></td></tr>
|
|
<tr class="separator:ab84d1ef5275a1c6c63176c11d72d6235"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a803c6fba463ed92ee24e4c056467f20a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a803c6fba463ed92ee24e4c056467f20a">account_</a></td></tr>
|
|
<tr class="separator:a803c6fba463ed92ee24e4c056467f20a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb2f6f5d7fd8c663c5df76b6fcba2c49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#abb2f6f5d7fd8c663c5df76b6fcba2c49">mPriorBalance</a></td></tr>
|
|
<tr class="separator:abb2f6f5d7fd8c663c5df76b6fcba2c49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae20c19d8ecec32cec52399081e76cc45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#ae20c19d8ecec32cec52399081e76cc45">mSourceBalance</a></td></tr>
|
|
<tr class="separator:ae20c19d8ecec32cec52399081e76cc45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a0494829d8e22b029e7dfb90ee970fda1"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#a0494829d8e22b029e7dfb90ee970fda1">applyGuts</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>)</td></tr>
|
|
<tr class="separator:a0494829d8e22b029e7dfb90ee970fda1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcf4670f2b402a00f166d0f342a75714"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#adcf4670f2b402a00f166d0f342a75714">deposit</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountDeposit, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &amount2Deposit, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lptAMMBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lpTokensDeposit, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &depositMin, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &deposit2Min, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &lpTokensDepositMin, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:adcf4670f2b402a00f166d0f342a75714"><td class="mdescLeft"> </td><td class="mdescRight">Deposit requested assets and token amount into LP account. <a href="classripple_1_1AMMDeposit.html#adcf4670f2b402a00f166d0f342a75714">More...</a><br /></td></tr>
|
|
<tr class="separator:adcf4670f2b402a00f166d0f342a75714"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf3f2a49ffb3a83e42b3daf49f33319f"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#aaf3f2a49ffb3a83e42b3daf49f33319f">equalDepositTokens</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount2Balance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lptAMMBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lpTokensDeposit, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &depositMin, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &deposit2Min, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:aaf3f2a49ffb3a83e42b3daf49f33319f"><td class="mdescLeft"> </td><td class="mdescRight">Equal asset deposit (LPTokens) for the specified share of the AMM instance pools. <a href="classripple_1_1AMMDeposit.html#aaf3f2a49ffb3a83e42b3daf49f33319f">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf3f2a49ffb3a83e42b3daf49f33319f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11321a8e5c8d6a60a0dc2baa64ac98a6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#a11321a8e5c8d6a60a0dc2baa64ac98a6">equalDepositLimit</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount2Balance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lptAMMBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount2, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &lpTokensDepositMin, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:a11321a8e5c8d6a60a0dc2baa64ac98a6"><td class="mdescLeft"> </td><td class="mdescRight">Equal asset deposit (Asset1In, Asset2In) with the constraint on the maximum amount of both assets that the trader is willing to deposit. <a href="classripple_1_1AMMDeposit.html#a11321a8e5c8d6a60a0dc2baa64ac98a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a11321a8e5c8d6a60a0dc2baa64ac98a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7242a93c72c9cb498849fb149ded3501"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501">singleDeposit</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lptAMMBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const &lpTokensDepositMin, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:a7242a93c72c9cb498849fb149ded3501"><td class="mdescLeft"> </td><td class="mdescRight">Single asset deposit (Asset1In) by the amount. <a href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501">More...</a><br /></td></tr>
|
|
<tr class="separator:a7242a93c72c9cb498849fb149ded3501"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad27c911271e84c57234e36978b8160bb"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#ad27c911271e84c57234e36978b8160bb">singleDepositTokens</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lptAMMBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lpTokensDeposit, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:ad27c911271e84c57234e36978b8160bb"><td class="mdescLeft"> </td><td class="mdescRight">Single asset deposit (Asset1In, LPTokens) by the tokens. <a href="classripple_1_1AMMDeposit.html#ad27c911271e84c57234e36978b8160bb">More...</a><br /></td></tr>
|
|
<tr class="separator:ad27c911271e84c57234e36978b8160bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5775a9ff666de25c0c0ad243b79b9d0e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#a5775a9ff666de25c0c0ad243b79b9d0e">singleDepositEPrice</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amountBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &lptAMMBalance, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &ePrice, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:a5775a9ff666de25c0c0ad243b79b9d0e"><td class="mdescLeft"> </td><td class="mdescRight">Single asset deposit (Asset1In, EPrice) with two constraints. <a href="classripple_1_1AMMDeposit.html#a5775a9ff666de25c0c0ad243b79b9d0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a5775a9ff666de25c0c0ad243b79b9d0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9c59cc740132fad1337d18c074a477a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMDeposit.html#ac9c59cc740132fad1337d18c074a477a">equalDepositInEmptyState</a> (<a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> &<a class="el" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount2, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &lptIssue, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> tfee)</td></tr>
|
|
<tr class="memdesc:ac9c59cc740132fad1337d18c074a477a"><td class="mdescLeft"> </td><td class="mdescRight">Equal deposit in empty AMM state (LP tokens balance is 0) <a href="classripple_1_1AMMDeposit.html#ac9c59cc740132fad1337d18c074a477a">More...</a><br /></td></tr>
|
|
<tr class="separator:ac9c59cc740132fad1337d18c074a477a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af81f796422a3f66771e31a6ecbbbf57b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#af81f796422a3f66771e31a6ecbbbf57b">reset</a> (<a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> fee)</td></tr>
|
|
<tr class="memdesc:af81f796422a3f66771e31a6ecbbbf57b"><td class="mdescLeft"> </td><td class="mdescRight">Reset the context, discarding any changes made and adjust the fee. <a href="classripple_1_1Transactor.html#af81f796422a3f66771e31a6ecbbbf57b">More...</a><br /></td></tr>
|
|
<tr class="separator:af81f796422a3f66771e31a6ecbbbf57b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b2066252127862bb58c1e4994dd5deb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a0b2066252127862bb58c1e4994dd5deb">consumeSeqProxy</a> (<a class="el" href="classripple_1_1STLedgerEntry.html#ad360ad8483226127ef6b132ac93c1598">SLE::pointer</a> const &sleAccount)</td></tr>
|
|
<tr class="separator:a0b2066252127862bb58c1e4994dd5deb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08d96a396dc3bd9a0a3e39e47e38531c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a08d96a396dc3bd9a0a3e39e47e38531c">payFee</a> ()</td></tr>
|
|
<tr class="separator:a08d96a396dc3bd9a0a3e39e47e38531c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5597401d095d153481ff61819fbb83dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a5597401d095d153481ff61819fbb83dc">trapTransaction</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>) const</td></tr>
|
|
<tr class="separator:a5597401d095d153481ff61819fbb83dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a68776b873595ab6d7ed33ddd0353c01b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#a68776b873595ab6d7ed33ddd0353c01b">checkSingleSign</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &ctx)</td></tr>
|
|
<tr class="separator:a68776b873595ab6d7ed33ddd0353c01b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcb347c674044ec5c9e9ac751b54c3ac"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Transactor.html#afcb347c674044ec5c9e9ac751b54c3ac">checkMultiSign</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &ctx)</td></tr>
|
|
<tr class="separator:afcb347c674044ec5c9e9ac751b54c3ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p ><a class="el" href="classripple_1_1AMMDeposit.html" title="AMMDeposit implements AMM deposit Transactor.">AMMDeposit</a> implements AMM deposit <a class="el" href="classripple_1_1Transactor.html">Transactor</a>. </p>
|
|
<p >The deposit transaction is used to add liquidity to the AMM instance pool, thus obtaining some share of the instance's pools in the form of LPTokens. If the trader deposits proportional values of both assets without changing their relative price, then no trading fee is charged on the transaction. The trader can specify different combination of the fields in the deposit. LPTokens - transaction assumes proportional deposit of pools assets in exchange for the specified amount of LPTokens of the AMM instance. Asset1In - transaction assumes single asset deposit of the amount of asset specified by Asset1In. This is essentially a swap and an equal asset deposit. Asset1In and Asset2In - transaction assumes proportional deposit of pool assets with the constraints on the maximum amount of each asset that the trader is willing to deposit. Asset1In and LPTokens - transaction assumes that a single asset asset1 is deposited to obtain some share of the AMM instance's pools represented by amount of LPTokens. Asset1In and EPrice - transaction assumes single asset deposit with the following two constraints: a. amount of asset1 if specified (not 0) in Asset1In specifies the maximum amount of asset1 that the trader is willing to deposit b. The effective-price of the LPTokens traded out does not exceed the specified EPrice. Following updates after a successful <a class="el" href="classripple_1_1AMMDeposit.html" title="AMMDeposit implements AMM deposit Transactor.">AMMDeposit</a> transaction: The deposited asset, if XRP, is transferred from the account that initiated the transaction to the AMM instance account, thus changing the Balance field of each account. The deposited asset, if tokens, are balanced between the AMM account and the issuer account trustline. The LPTokens are issued by the AMM instance account to the account that initiated the transaction and a new trustline is created, if there does not exist one. The pool composition is updated. </p><dl class="section see"><dt>See also</dt><dd><a href="https://github.com/XRPLF/XRPL-Standards/discussions/78">XLS30d:AMMDeposit transaction</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8h_source.html#l00062">62</a> of file <a class="el" href="AMMDeposit_8h_source.html">AMMDeposit.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a5c6d16e9402d182a835f50b37ce9a938" name="a5c6d16e9402d182a835f50b37ce9a938"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c6d16e9402d182a835f50b37ce9a938">◆ </a></span>ConsequencesFactoryType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ripple::Transactor::ConsequencesFactoryType</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f" name="a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f"></a>Normal </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a5c6d16e9402d182a835f50b37ce9a938a55caa0901cae976168bf23f19bc3e8f4" name="a5c6d16e9402d182a835f50b37ce9a938a55caa0901cae976168bf23f19bc3e8f4"></a>Blocker </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845" name="a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845"></a>Custom </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00101">101</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af63010c83c7bc12b999a81c5b26aa023" name="af63010c83c7bc12b999a81c5b26aa023"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af63010c83c7bc12b999a81c5b26aa023">◆ </a></span>AMMDeposit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::AMMDeposit::AMMDeposit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ApplyContext.html">ApplyContext</a> & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8h_source.html#l00067">67</a> of file <a class="el" href="AMMDeposit_8h_source.html">AMMDeposit.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a9a77c5ee8dcce8013ddb3b875e8a8b05" name="a9a77c5ee8dcce8013ddb3b875e8a8b05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a77c5ee8dcce8013ddb3b875e8a8b05">◆ </a></span>preflight()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::AMMDeposit::preflight </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreflightContext.html">PreflightContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00036">36</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5cd7c6df65846108840ff91aa3a814f5" name="a5cd7c6df65846108840ff91aa3a814f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5cd7c6df65846108840ff91aa3a814f5">◆ </a></span>preclaim()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::AMMDeposit::preclaim </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00169">169</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac92c10f978f5a831447bd7cdc5a0d1ef" name="ac92c10f978f5a831447bd7cdc5a0d1ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac92c10f978f5a831447bd7cdc5a0d1ef">◆ </a></span>doApply()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::AMMDeposit::doApply </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implements <a class="el" href="classripple_1_1Transactor.html#af0192505cdcebc1bb31be32dfb62aa72">ripple::Transactor</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00486">486</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0494829d8e22b029e7dfb90ee970fda1" name="a0494829d8e22b029e7dfb90ee970fda1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0494829d8e22b029e7dfb90ee970fda1">◆ </a></span>applyGuts()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, bool > ripple::AMMDeposit::applyGuts </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00371">371</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adcf4670f2b402a00f166d0f342a75714" name="adcf4670f2b402a00f166d0f342a75714"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adcf4670f2b402a00f166d0f342a75714">◆ </a></span>deposit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::deposit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountDeposit</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>amount2Deposit</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lptAMMBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lpTokensDeposit</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>depositMin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>deposit2Min</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>lpTokensDepositMin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deposit requested assets and token amount into LP account. </p>
|
|
<p >Return new total LPToken balance. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amountBalance</td><td>current AMM asset1 balance </td></tr>
|
|
<tr><td class="paramname">amountDeposit</td><td></td></tr>
|
|
<tr><td class="paramname">amount2Deposit</td><td></td></tr>
|
|
<tr><td class="paramname">lptAMMBalance</td><td>current AMM LPT balance </td></tr>
|
|
<tr><td class="paramname">lpTokensDeposit</td><td>amount of tokens to deposit </td></tr>
|
|
<tr><td class="paramname">depositMin</td><td>minimum accepted amount deposit </td></tr>
|
|
<tr><td class="paramname">deposit2Min</td><td>minimum accepted amount2 deposit </td></tr>
|
|
<tr><td class="paramname">lpTokensDepositMin</td><td>minimum accepted LPTokens deposit </td></tr>
|
|
<tr><td class="paramname">tfee</td><td>trading fee in basis points </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00500">500</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf3f2a49ffb3a83e42b3daf49f33319f" name="aaf3f2a49ffb3a83e42b3daf49f33319f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf3f2a49ffb3a83e42b3daf49f33319f">◆ </a></span>equalDepositTokens()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::equalDepositTokens </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount2Balance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lptAMMBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lpTokensDeposit</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>depositMin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>deposit2Min</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Equal asset deposit (LPTokens) for the specified share of the AMM instance pools. </p>
|
|
<p >Proportional deposit of pools assets in exchange for the specified amount of LPTokens.</p>
|
|
<p >The trading fee is not charged. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amountBalance</td><td>current AMM asset1 balance </td></tr>
|
|
<tr><td class="paramname">amount2Balance</td><td>current AMM asset2 balance </td></tr>
|
|
<tr><td class="paramname">lptAMMBalance</td><td>current AMM LPT balance </td></tr>
|
|
<tr><td class="paramname">lpTokensDeposit</td><td>amount of tokens to deposit </td></tr>
|
|
<tr><td class="paramname">depositMin</td><td>minimum accepted amount deposit </td></tr>
|
|
<tr><td class="paramname">deposit2Min</td><td>minimum accepted amount2 deposit </td></tr>
|
|
<tr><td class="paramname">tfee</td><td>trading fee in basis points </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00635">635</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a11321a8e5c8d6a60a0dc2baa64ac98a6" name="a11321a8e5c8d6a60a0dc2baa64ac98a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11321a8e5c8d6a60a0dc2baa64ac98a6">◆ </a></span>equalDepositLimit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::equalDepositLimit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount2Balance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lptAMMBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>lpTokensDepositMin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Equal asset deposit (Asset1In, Asset2In) with the constraint on the maximum amount of both assets that the trader is willing to deposit. </p>
|
|
<p >Proportional deposit of pool assets with the constraints on the maximum amount of each asset that the trader is willing to deposit.</p>
|
|
<p >The trading fee is not charged. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amountBalance</td><td>current AMM asset1 balance </td></tr>
|
|
<tr><td class="paramname">amount2Balance</td><td>current AMM asset2 balance </td></tr>
|
|
<tr><td class="paramname">lptAMMBalance</td><td>current AMM LPT balance </td></tr>
|
|
<tr><td class="paramname">amount</td><td>maximum asset1 deposit amount </td></tr>
|
|
<tr><td class="paramname">amount2</td><td>maximum asset2 deposit amount </td></tr>
|
|
<tr><td class="paramname">lpTokensDepositMin</td><td>minimum accepted LPTokens deposit </td></tr>
|
|
<tr><td class="paramname">tfee</td><td>trading fee in basis points </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
<p>a = (t/T) * A (1) b = (t/T) * B (2) where A,B: current pool composition T: current balance of outstanding LPTokens a: balance of asset A being added b: balance of asset B being added t: balance of LPTokens issued to LP after a successful transaction Use equation 1 to compute the amount of t, given the amount in Asset1In. Let this be Z Use equation 2 to compute the amount of asset2, given t~Z. Let the computed amount of asset2 be X. If X <= amount in Asset2In: The amount of asset1 to be deposited is the one specified in Asset1In The amount of asset2 to be deposited is X The amount of LPTokens to be issued is Z If X > amount in Asset2In: Use equation 2 to compute , given the amount in Asset2In. Let this be W Use equation 1 to compute the amount of asset1, given t~W from above. Let the computed amount of asset1 be Y If Y <= amount in Asset1In: The amount of asset1 to be deposited is Y The amount of asset2 to be deposited is the one specified in Asset2In The amount of LPTokens to be issued is W else, failed transaction </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00702">702</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7242a93c72c9cb498849fb149ded3501" name="a7242a93c72c9cb498849fb149ded3501"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7242a93c72c9cb498849fb149ded3501">◆ </a></span>singleDeposit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::singleDeposit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lptAMMBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > const & </td>
|
|
<td class="paramname"><em>lpTokensDepositMin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Single asset deposit (Asset1In) by the amount. </p>
|
|
<p >Single asset deposit of the amount of asset specified by Asset1In.</p>
|
|
<p >The trading fee is charged. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amountBalance</td><td>current AMM asset1 balance </td></tr>
|
|
<tr><td class="paramname">lptAMMBalance</td><td>current AMM LPT balance </td></tr>
|
|
<tr><td class="paramname">amount</td><td>requested asset1 deposit amount </td></tr>
|
|
<tr><td class="paramname">lpTokensDepositMin</td><td>minimum accepted LPTokens deposit </td></tr>
|
|
<tr><td class="paramname">tfee</td><td>trading fee in basis points </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
<p>t = T * (b / B - x) / (1 + x) (3) where f1 = (1 - 0.5 * tfee) / (1 - tfee) x = sqrt(f1**2 + b / (B * (1 - tfee)) - f1 Use equation 3 </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501" title="Single asset deposit (Asset1In) by the amount.">singleDeposit</a> to compute amount of LPTokens to be issued, given the amount <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a> Asset1In. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00761">761</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad27c911271e84c57234e36978b8160bb" name="ad27c911271e84c57234e36978b8160bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad27c911271e84c57234e36978b8160bb">◆ </a></span>singleDepositTokens()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::singleDepositTokens </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lptAMMBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lpTokensDeposit</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Single asset deposit (Asset1In, LPTokens) by the tokens. </p>
|
|
<p >Single asset asset1 is deposited to obtain some share of the AMM instance's pools represented by amount of LPTokens.</p>
|
|
<p >The trading fee is charged. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amountBalance</td><td>current AMM asset1 balance </td></tr>
|
|
<tr><td class="paramname">amount</td><td>max asset1 to deposit </td></tr>
|
|
<tr><td class="paramname">lptAMMBalance</td><td>current AMM LPT balance </td></tr>
|
|
<tr><td class="paramname">lpTokensDeposit</td><td>amount of tokens to deposit </td></tr>
|
|
<tr><td class="paramname">tfee</td><td>trading fee in basis points </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
<p>Use equation 4 to compute the amount of asset1 to be deposited, given t represented by amount of LPTokens. Equation 4 solves equation 3 </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501" title="Single asset deposit (Asset1In) by the amount.">singleDeposit</a> for b. <a class="el" href="namespaceripple.html#a3352ead78ab1510016d3f728004acd63aceaa0734f0b3c738120c67344d8f3ec1" title="Should not be retried in this ledger.">Fail</a> if b exceeds specified Max amount to <a class="el" href="classripple_1_1AMMDeposit.html#adcf4670f2b402a00f166d0f342a75714" title="Deposit requested assets and token amount into LP account.">deposit</a>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00795">795</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5775a9ff666de25c0c0ad243b79b9d0e" name="a5775a9ff666de25c0c0ad243b79b9d0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5775a9ff666de25c0c0ad243b79b9d0e">◆ </a></span>singleDepositEPrice()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::singleDepositEPrice </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amountBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>lptAMMBalance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>ePrice</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Single asset deposit (Asset1In, EPrice) with two constraints. </p>
|
|
<p >Single asset deposit with two constraints.</p>
|
|
<p >The trading fee is charged. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amountBalance</td><td>current AMM asset1 balance </td></tr>
|
|
<tr><td class="paramname">amount</td><td>requested asset1 deposit amount </td></tr>
|
|
<tr><td class="paramname">lptAMMBalance</td><td>current AMM LPT balance </td></tr>
|
|
<tr><td class="paramname">ePrice</td><td>maximum effective price </td></tr>
|
|
<tr><td class="paramname">tfee</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
<p>a. Amount of asset1 if specified (not 0) in Asset1In specifies the maximum amount of asset1 that the trader is willing to deposit. b. The effective-price of the LPToken traded out does not exceed the specified EPrice. The effective price (EP) of a trade is defined as the ratio of the tokens the trader sold or swapped in (Token B) and the token they got in return or swapped out (Token A). EP(B/A) = b/a (III) Use equation 3 </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501" title="Single asset deposit (Asset1In) by the amount.">singleDeposit</a> to compute the amount of LPTokens <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>, given the amount of Asset1In. Let this be X. Use equation III to compute the effective-price of the trade given Asset1In amount as the asset <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a> and the LPTokens amount X as asset <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>. Let this be Y. If Y <= amount <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a> EPrice: The amount of asset1 to be deposited is given by amount <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a> Asset1In The amount of LPTokens to be issued is X If (Y>EPrice) OR (amount <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a> Asset1In does not exist): Use equations 3 </dd>
|
|
<dd>
|
|
<a class="el" href="classripple_1_1AMMDeposit.html#a7242a93c72c9cb498849fb149ded3501" title="Single asset deposit (Asset1In) by the amount.">singleDeposit</a> & III and the given EPrice to compute the following two variables: The amount of asset1 <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>. Let this be Q The amount of LPTokens <a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>. Let this be W The amount of asset1 to be deposited is Q The amount of LPTokens to be issued is W </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00848">848</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9c59cc740132fad1337d18c074a477a" name="ac9c59cc740132fad1337d18c074a477a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9c59cc740132fad1337d18c074a477a">◆ </a></span>equalDepositInEmptyState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> > ripple::AMMDeposit::equalDepositInEmptyState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Sandbox.html">Sandbox</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Issue.html">Issue</a> const & </td>
|
|
<td class="paramname"><em>lptIssue</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> </td>
|
|
<td class="paramname"><em>tfee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Equal deposit in empty AMM state (LP tokens balance is 0) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td></td></tr>
|
|
<tr><td class="paramname">ammAccount</td><td></td></tr>
|
|
<tr><td class="paramname">amount</td><td>requested asset1 deposit amount </td></tr>
|
|
<tr><td class="paramname">amount2</td><td>requested asset2 deposit amount </td></tr>
|
|
<tr><td class="paramname">tfee</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8cpp_source.html#l00925">925</a> of file <a class="el" href="AMMDeposit_8cpp_source.html">AMMDeposit.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1da35943be8abee6756535e60689de65" name="a1da35943be8abee6756535e60689de65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1da35943be8abee6756535e60689de65">◆ </a></span>operator()()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1ApplyResult.html">ApplyResult</a> ripple::Transactor::operator() </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Process the transaction. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00912">912</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9acc4edc9b8f2a11a27fbcf5e93e2fe2" name="a9acc4edc9b8f2a11a27fbcf5e93e2fe2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">◆ </a></span>view() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> & ripple::Transactor::view </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00107">107</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afbfc65493c2efc1defca8bc10523a9c7" name="afbfc65493c2efc1defca8bc10523a9c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbfc65493c2efc1defca8bc10523a9c7">◆ </a></span>view() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> const & ripple::Transactor::view </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00113">113</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a433ee7a44770c882927f2eedf20e6c71" name="a433ee7a44770c882927f2eedf20e6c71"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a433ee7a44770c882927f2eedf20e6c71">◆ </a></span>checkSeqProxy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::Transactor::checkSeqProxy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const & </td>
|
|
<td class="paramname"><em>tx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> </td>
|
|
<td class="paramname"><em>j</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00295">295</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f3af178ae553ba91b5893fbcc4ade7f" name="a2f3af178ae553ba91b5893fbcc4ade7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f3af178ae553ba91b5893fbcc4ade7f">◆ </a></span>checkPriorTxAndLastLedger()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::Transactor::checkPriorTxAndLastLedger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00367">367</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a356c16a6a5d7ccade18cf4c9fb58cc38" name="a356c16a6a5d7ccade18cf4c9fb58cc38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a356c16a6a5d7ccade18cf4c9fb58cc38">◆ </a></span>checkFee()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::Transactor::checkFee </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td>
|
|
<td class="paramname"><em>baseFee</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00222">222</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4501e41a5df4853bb93e7f85ec6abaf7" name="a4501e41a5df4853bb93e7f85ec6abaf7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4501e41a5df4853bb93e7f85ec6abaf7">◆ </a></span>checkSign()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::Transactor::checkSign </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00515">515</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a428581db1f9eea2f41cf9e371a1e557d" name="a428581db1f9eea2f41cf9e371a1e557d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a428581db1f9eea2f41cf9e371a1e557d">◆ </a></span>calculateBaseFee()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Transactor::calculateBaseFee </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const & </td>
|
|
<td class="paramname"><em>tx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00194">194</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac424955fc06a7eb920a93fe517ad8d69" name="ac424955fc06a7eb920a93fe517ad8d69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac424955fc06a7eb920a93fe517ad8d69">◆ </a></span>ticketDelete()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::Transactor::ticketDelete </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> & </td>
|
|
<td class="paramname"><em>view</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>account</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>ticketIndex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> </td>
|
|
<td class="paramname"><em>j</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00416">416</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2faaa3bfd1c9b9f91ae24f367474d0f" name="ac2faaa3bfd1c9b9f91ae24f367474d0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2faaa3bfd1c9b9f91ae24f367474d0f">◆ </a></span>apply()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::Transactor::apply </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00478">478</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac251aaee739d07ccdd565f2e9d9f336e" name="ac251aaee739d07ccdd565f2e9d9f336e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac251aaee739d07ccdd565f2e9d9f336e">◆ </a></span>preCompute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Transactor::preCompute </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1Change.html#a69cd5bf7979d79ffc7d2a7b813ff967e">ripple::Change</a>, <a class="el" href="classripple_1_1CreateOffer.html#a51e243eec385d66e97acbc6b59e6b95c">ripple::CreateOffer</a>, and <a class="el" href="classripple_1_1SetSignerList.html#a81cc900e9e0dc4096c3c8f63c1371ffe">ripple::SetSignerList</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00470">470</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c4568739676c5335b8d63dc375f7920" name="a5c4568739676c5335b8d63dc375f7920"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c4568739676c5335b8d63dc375f7920">◆ </a></span>minimumFee()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Transactor::minimumFee </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> & </td>
|
|
<td class="paramname"><em>app</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td>
|
|
<td class="paramname"><em>baseFee</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Fees.html">Fees</a> const & </td>
|
|
<td class="paramname"><em>fees</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> </td>
|
|
<td class="paramname"><em>flags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compute the minimum fee required to process a transaction with a given baseFee based on the current server load. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">app</td><td>The application hosting the server </td></tr>
|
|
<tr><td class="paramname">baseFee</td><td>The base fee of a candidate transaction </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceripple.html#a3deb4c69ca598c60e6502a3be527835e" title="Compute only the expected base fee for a transaction.">ripple::calculateBaseFee</a> </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fees</td><td>Fee settings from the current ledger </td></tr>
|
|
<tr><td class="paramname">flags</td><td><a class="el" href="classripple_1_1Transaction.html">Transaction</a> processing fees </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00212">212</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af81f796422a3f66771e31a6ecbbbf57b" name="af81f796422a3f66771e31a6ecbbbf57b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af81f796422a3f66771e31a6ecbbbf57b">◆ </a></span>reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>, <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> > ripple::Transactor::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> </td>
|
|
<td class="paramname"><em>fee</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reset the context, discarding any changes made and adjust the fee. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00862">862</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b2066252127862bb58c1e4994dd5deb" name="a0b2066252127862bb58c1e4994dd5deb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b2066252127862bb58c1e4994dd5deb">◆ </a></span>consumeSeqProxy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::Transactor::consumeSeqProxy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STLedgerEntry.html#ad360ad8483226127ef6b132ac93c1598">SLE::pointer</a> const & </td>
|
|
<td class="paramname"><em>sleAccount</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00397">397</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a08d96a396dc3bd9a0a3e39e47e38531c" name="a08d96a396dc3bd9a0a3e39e47e38531c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a08d96a396dc3bd9a0a3e39e47e38531c">◆ </a></span>payFee()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::Transactor::payFee </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00275">275</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68776b873595ab6d7ed33ddd0353c01b" name="a68776b873595ab6d7ed33ddd0353c01b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68776b873595ab6d7ed33ddd0353c01b">◆ </a></span>checkSingleSign()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::Transactor::checkSingleSign </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00533">533</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afcb347c674044ec5c9e9ac751b54c3ac" name="afcb347c674044ec5c9e9ac751b54c3ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afcb347c674044ec5c9e9ac751b54c3ac">◆ </a></span>checkMultiSign()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::Transactor::checkMultiSign </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const & </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00613">613</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5597401d095d153481ff61819fbb83dc" name="a5597401d095d153481ff61819fbb83dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5597401d095d153481ff61819fbb83dc">◆ </a></span>trapTransaction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::Transactor::trapTransaction </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> </td>
|
|
<td class="paramname"><em>txHash</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00905">905</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ab8190e434de81091a994e511dd4d293f" name="ab8190e434de81091a994e511dd4d293f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8190e434de81091a994e511dd4d293f">◆ </a></span>ConsequencesFactory</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr <a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> ripple::AMMDeposit::ConsequencesFactory {<a class="el" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938aa45cb725337de0d627f42b7ebf4be91f">Normal</a>}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMDeposit_8h_source.html#l00065">65</a> of file <a class="el" href="AMMDeposit_8h_source.html">AMMDeposit.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aef4ef0a89b5595b2a688b89e4ecef833" name="aef4ef0a89b5595b2a688b89e4ecef833"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aef4ef0a89b5595b2a688b89e4ecef833">◆ </a></span>ctx_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1ApplyContext.html">ApplyContext</a>& ripple::Transactor::ctx_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00088">88</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab84d1ef5275a1c6c63176c11d72d6235" name="ab84d1ef5275a1c6c63176c11d72d6235"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab84d1ef5275a1c6c63176c11d72d6235">◆ </a></span>j_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const ripple::Transactor::j_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00089">89</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a803c6fba463ed92ee24e4c056467f20a" name="a803c6fba463ed92ee24e4c056467f20a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a803c6fba463ed92ee24e4c056467f20a">◆ </a></span>account_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const ripple::Transactor::account_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00091">91</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb2f6f5d7fd8c663c5df76b6fcba2c49" name="abb2f6f5d7fd8c663c5df76b6fcba2c49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb2f6f5d7fd8c663c5df76b6fcba2c49">◆ </a></span>mPriorBalance</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Transactor::mPriorBalance</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00092">92</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae20c19d8ecec32cec52399081e76cc45" name="ae20c19d8ecec32cec52399081e76cc45"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae20c19d8ecec32cec52399081e76cc45">◆ </a></span>mSourceBalance</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::Transactor::mSourceBalance</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00093">93</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|