mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
832 lines
50 KiB
HTML
832 lines
50 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.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::AMMLiquidity< TIn, TOut > Class Template 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.8 -->
|
|
<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_1AMMLiquidity.html">AMMLiquidity</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#pri-static-attribs">Static Private Attributes</a> |
|
|
<a href="classripple_1_1AMMLiquidity-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::AMMLiquidity< TIn, TOut > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classripple_1_1AMMLiquidity.html" title="AMMLiquidity class provides AMM offers to BookStep class.">AMMLiquidity</a> class provides AMM offers to <a class="el" href="classripple_1_1BookStep.html">BookStep</a> class.
|
|
<a href="classripple_1_1AMMLiquidity.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::AMMLiquidity< TIn, TOut >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1AMMLiquidity__coll__graph.png" border="0" usemap="#aripple_1_1AMMLiquidity_3_01TIn_00_01TOut_01_4_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1AMMLiquidity_3_01TIn_00_01TOut_01_4_coll__map" id="aripple_1_1AMMLiquidity_3_01TIn_00_01TOut_01_4_coll__map">
|
|
<area shape="rect" title="AMMLiquidity class provides AMM offers to BookStep class." alt="" coords="1140,199,1296,239"/>
|
|
<area shape="rect" href="classripple_1_1Number.html" title=" " alt="" coords="852,37,971,62"/>
|
|
<area shape="poly" title=" " alt="" coords="985,45,1052,55,1086,65,1117,80,1150,106,1176,138,1210,197,1206,200,1172,141,1146,110,1115,85,1084,70,1050,60,984,51"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="543,37,637,62"/>
|
|
<area shape="poly" title=" " alt="" coords="651,47,852,47,852,52,651,52"/>
|
|
<area shape="rect" href="classripple_1_1AMMContext.html" title="Maintains AMM info per overall payment engine execution and individual iteration." alt="" coords="836,357,987,382"/>
|
|
<area shape="poly" title=" " alt="" coords="952,348,1115,270,1178,236,1181,241,1117,274,954,353"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="543,429,637,454"/>
|
|
<area shape="poly" title=" " alt="" coords="651,437,728,430,811,413,852,398,887,380,890,384,855,403,813,419,729,435,651,442"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,315,693,355"/>
|
|
<area shape="poly" title=" " alt="" coords="708,345,836,359,835,364,707,350"/>
|
|
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="861,243,962,269"/>
|
|
<area shape="poly" title=" " alt="" coords="685,309,860,266,861,271,686,314"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,231,349,257"/>
|
|
<area shape="poly" title=" " alt="" coords="364,252,391,267,401,281,403,295,406,307,415,318,449,334,487,341,486,346,447,339,412,322,401,310,398,296,396,283,388,271,361,257"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32-bits." alt="" coords="519,173,661,213"/>
|
|
<area shape="poly" title=" " alt="" coords="331,221,368,197,413,177,467,171,520,175,519,180,467,176,414,183,371,201,334,225"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,237,689,277"/>
|
|
<area shape="poly" title=" " alt="" coords="364,248,413,252,490,255,490,260,413,257,363,253"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,281,389,321"/>
|
|
<area shape="poly" title=" " alt="" coords="330,331,366,371,389,389,414,403,438,410,461,403,469,395,473,386,476,375,485,365,504,353,507,357,488,369,481,378,478,388,474,398,464,408,438,415,412,408,386,394,362,375,326,334"/>
|
|
<area shape="poly" title=" " alt="" coords="380,272,387,266,395,256,398,245,402,234,412,223,437,209,464,199,519,190,520,195,465,204,439,214,415,227,407,237,403,247,400,258,391,270,383,276"/>
|
|
<area shape="poly" title=" " alt="" coords="403,284,462,275,490,270,491,276,463,280,404,289"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,189,108,214"/>
|
|
<area shape="poly" title=" " alt="" coords="86,178,127,154,180,128,241,107,272,101,304,99,913,99,953,101,994,109,1071,135,1138,167,1188,196,1185,201,1135,172,1069,140,992,114,953,107,913,104,304,104,273,106,242,112,182,132,130,158,89,183"/>
|
|
<area shape="poly" title=" " alt="" coords="103,217,222,266,255,279,253,284,220,270,101,222"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="539,379,641,405"/>
|
|
<area shape="poly" title=" " alt="" coords="655,392,730,393,812,388,861,379,861,385,812,393,731,398,655,398"/>
|
|
<area shape="poly" title=" " alt="" coords="675,193,1116,209,1140,211,1140,216,1116,215,674,198"/>
|
|
<area shape="poly" title=" " alt="" coords="976,251,1043,247,1116,239,1139,235,1140,240,1116,244,1044,252,976,257"/>
|
|
<area shape="poly" title=" " alt="" coords="703,254,861,254,861,259,703,260"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="856,453,967,478"/>
|
|
<area shape="poly" title=" " alt="" coords="952,444,1030,402,1074,373,1114,342,1165,288,1202,237,1206,240,1169,291,1118,346,1077,378,1033,406,954,449"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="517,478,663,503"/>
|
|
<area shape="poly" title=" " alt="" coords="677,489,743,488,812,483,856,475,857,481,812,488,743,493,677,495"/>
|
|
</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-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ab64d5ee790ade8eea80a94449a0e120c" id="r_ab64d5ee790ade8eea80a94449a0e120c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#ab64d5ee790ade8eea80a94449a0e120c">AMMLiquidity</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &view, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &ammAccountID, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="el" href="classripple_1_1AMMLiquidity.html#a2464ba632642635216c034a22d1408c8">tradingFee</a>, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>, <a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &ammContext, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
|
|
<tr class="separator:ab64d5ee790ade8eea80a94449a0e120c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a640f4fd0c1a5b2500f43c75132f702b0" id="r_a640f4fd0c1a5b2500f43c75132f702b0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a640f4fd0c1a5b2500f43c75132f702b0">~AMMLiquidity</a> ()=default</td></tr>
|
|
<tr class="separator:a640f4fd0c1a5b2500f43c75132f702b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a031fa0d4a212b3ffda51a01acd65c0d7" id="r_a031fa0d4a212b3ffda51a01acd65c0d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a031fa0d4a212b3ffda51a01acd65c0d7">AMMLiquidity</a> (<a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> const &)=delete</td></tr>
|
|
<tr class="separator:a031fa0d4a212b3ffda51a01acd65c0d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa217198640a9af820fdb9c487b5b094b" id="r_aa217198640a9af820fdb9c487b5b094b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#aa217198640a9af820fdb9c487b5b094b">operator=</a> (<a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> const &)=delete</td></tr>
|
|
<tr class="separator:aa217198640a9af820fdb9c487b5b094b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f40426bb36529ccba8ef2768e3c3bc9" id="r_a4f40426bb36529ccba8ef2768e3c3bc9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1AMMOffer.html">AMMOffer</a>< TIn, TOut > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a4f40426bb36529ccba8ef2768e3c3bc9">getOffer</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &view, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< Quality > const &clobQuality) const</td></tr>
|
|
<tr class="memdesc:a4f40426bb36529ccba8ef2768e3c3bc9"><td class="mdescLeft"> </td><td class="mdescRight">Generate AMM offer. <br /></td></tr>
|
|
<tr class="separator:a4f40426bb36529ccba8ef2768e3c3bc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9316bb888b1ce3b10be95103a2830a08" id="r_a9316bb888b1ce3b10be95103a2830a08"><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_1AMMLiquidity.html#a9316bb888b1ce3b10be95103a2830a08">ammAccount</a> () const</td></tr>
|
|
<tr class="separator:a9316bb888b1ce3b10be95103a2830a08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a293bb918d765f4291d1f8d11a0a1e63d" id="r_a293bb918d765f4291d1f8d11a0a1e63d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a293bb918d765f4291d1f8d11a0a1e63d">multiPath</a> () const</td></tr>
|
|
<tr class="separator:a293bb918d765f4291d1f8d11a0a1e63d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2464ba632642635216c034a22d1408c8" id="r_a2464ba632642635216c034a22d1408c8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a2464ba632642635216c034a22d1408c8">tradingFee</a> () const</td></tr>
|
|
<tr class="separator:a2464ba632642635216c034a22d1408c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0483f5ab5a62264b9254e7fc6f15fbcf" id="r_a0483f5ab5a62264b9254e7fc6f15fbcf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a0483f5ab5a62264b9254e7fc6f15fbcf">context</a> () const</td></tr>
|
|
<tr class="separator:a0483f5ab5a62264b9254e7fc6f15fbcf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f3caadf2e06839e1a67a6690b2fdad7" id="r_a3f3caadf2e06839e1a67a6690b2fdad7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a3f3caadf2e06839e1a67a6690b2fdad7">issueIn</a> () const</td></tr>
|
|
<tr class="separator:a3f3caadf2e06839e1a67a6690b2fdad7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a055fcd3cdd03884c34a008ae85f2bd80" id="r_a055fcd3cdd03884c34a008ae85f2bd80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a055fcd3cdd03884c34a008ae85f2bd80">issueOut</a> () const</td></tr>
|
|
<tr class="separator:a055fcd3cdd03884c34a008ae85f2bd80"><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:a90e392457e7f89d2ee5e2a5398b29aac" id="r_a90e392457e7f89d2ee5e2a5398b29aac"><td class="memItemLeft" align="right" valign="top">TAmounts< TIn, TOut > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a90e392457e7f89d2ee5e2a5398b29aac">fetchBalances</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &view) const</td></tr>
|
|
<tr class="memdesc:a90e392457e7f89d2ee5e2a5398b29aac"><td class="mdescLeft"> </td><td class="mdescRight">Fetches current AMM balances. <br /></td></tr>
|
|
<tr class="separator:a90e392457e7f89d2ee5e2a5398b29aac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc3099a63d626321df693638c4b09b34" id="r_afc3099a63d626321df693638c4b09b34"><td class="memItemLeft" align="right" valign="top">TAmounts< TIn, TOut > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#afc3099a63d626321df693638c4b09b34">generateFibSeqOffer</a> (TAmounts< TIn, TOut > const &balances) const</td></tr>
|
|
<tr class="memdesc:afc3099a63d626321df693638c4b09b34"><td class="mdescLeft"> </td><td class="mdescRight">Generate AMM offers with the offer size based on Fibonacci sequence. <br /></td></tr>
|
|
<tr class="separator:afc3099a63d626321df693638c4b09b34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6752c49c9927eb6d07bb08f4418581e" id="r_ab6752c49c9927eb6d07bb08f4418581e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1AMMOffer.html">AMMOffer</a>< TIn, TOut > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#ab6752c49c9927eb6d07bb08f4418581e">maxOffer</a> (TAmounts< TIn, TOut > const &balances, <a class="el" href="classripple_1_1Rules.html">Rules</a> const &rules) const</td></tr>
|
|
<tr class="memdesc:ab6752c49c9927eb6d07bb08f4418581e"><td class="mdescLeft"> </td><td class="mdescRight">Generate max offer. <br /></td></tr>
|
|
<tr class="separator:ab6752c49c9927eb6d07bb08f4418581e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:aaa76a6df3301390623b4502708b65a66" id="r_aaa76a6df3301390623b4502708b65a66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#aaa76a6df3301390623b4502708b65a66">ammContext_</a></td></tr>
|
|
<tr class="separator:aaa76a6df3301390623b4502708b65a66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a133f036de6e226d1a9d989ba57f50cb7" id="r_a133f036de6e226d1a9d989ba57f50cb7"><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_1AMMLiquidity.html#a133f036de6e226d1a9d989ba57f50cb7">ammAccountID_</a></td></tr>
|
|
<tr class="separator:a133f036de6e226d1a9d989ba57f50cb7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeba999ec8adb002627daf4434b39cb5a" id="r_aeba999ec8adb002627daf4434b39cb5a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#aeba999ec8adb002627daf4434b39cb5a">tradingFee_</a></td></tr>
|
|
<tr class="separator:aeba999ec8adb002627daf4434b39cb5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a36a6364b9f06e25c418bd59cf4d455" id="r_a4a36a6364b9f06e25c418bd59cf4d455"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a4a36a6364b9f06e25c418bd59cf4d455">issueIn_</a></td></tr>
|
|
<tr class="separator:a4a36a6364b9f06e25c418bd59cf4d455"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add252bdab66684786d1d1faf36c03585" id="r_add252bdab66684786d1d1faf36c03585"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#add252bdab66684786d1d1faf36c03585">issueOut_</a></td></tr>
|
|
<tr class="separator:add252bdab66684786d1d1faf36c03585"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb12965efebc4a2dac9f59f1bffc1974" id="r_abb12965efebc4a2dac9f59f1bffc1974"><td class="memItemLeft" align="right" valign="top">TAmounts< TIn, TOut > const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#abb12965efebc4a2dac9f59f1bffc1974">initialBalances_</a></td></tr>
|
|
<tr class="separator:abb12965efebc4a2dac9f59f1bffc1974"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84417ee785f2490ca7a50fc70b9be157" id="r_a84417ee785f2490ca7a50fc70b9be157"><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_1AMMLiquidity.html#a84417ee785f2490ca7a50fc70b9be157">j_</a></td></tr>
|
|
<tr class="separator:a84417ee785f2490ca7a50fc70b9be157"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-attribs" name="pri-static-attribs"></a>
|
|
Static Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a10fb841bc078c796d9e3c2fcb3541c13" id="r_a10fb841bc078c796d9e3c2fcb3541c13"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classripple_1_1Number.html">Number</a> const </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMLiquidity.html#a10fb841bc078c796d9e3c2fcb3541c13">InitialFibSeqPct</a> = <a class="el" href="classripple_1_1Number.html">Number</a>(5) / 20000</td></tr>
|
|
<tr class="separator:a10fb841bc078c796d9e3c2fcb3541c13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename TIn, typename TOut><br />
|
|
class ripple::AMMLiquidity< TIn, TOut ></div><p><a class="el" href="classripple_1_1AMMLiquidity.html" title="AMMLiquidity class provides AMM offers to BookStep class.">AMMLiquidity</a> class provides AMM offers to <a class="el" href="classripple_1_1BookStep.html">BookStep</a> class. </p>
|
|
<p>The offers are generated in two ways. If there are multiple paths specified to the payment transaction then the offers are generated based on the Fibonacci sequence with a limited number of payment engine iterations consuming AMM offers. These offers behave the same way as CLOB offers in that if there is a limiting step, then the offers are adjusted based on their quality. If there is only one path specified in the payment transaction then the offers are generated based on the competing CLOB offer quality. In this case the offer's size is set in such a way that the new AMM's pool spot price quality is equal to the CLOB's offer quality. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00033">33</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ab64d5ee790ade8eea80a94449a0e120c" name="ab64d5ee790ade8eea80a94449a0e120c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab64d5ee790ade8eea80a94449a0e120c">◆ </a></span>AMMLiquidity() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::AMMLiquidity </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="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>ammAccountID</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::uint32_t</a> </td>
|
|
<td class="paramname"><em>tradingFee</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>in</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>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> & </td>
|
|
<td class="paramname"><em>ammContext</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>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8cpp_source.html#l00007">7</a> of file <a class="el" href="AMMLiquidity_8cpp_source.html">AMMLiquidity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a640f4fd0c1a5b2500f43c75132f702b0" name="a640f4fd0c1a5b2500f43c75132f702b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a640f4fd0c1a5b2500f43c75132f702b0">◆ </a></span>~AMMLiquidity()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::~<a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a031fa0d4a212b3ffda51a01acd65c0d7" name="a031fa0d4a212b3ffda51a01acd65c0d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a031fa0d4a212b3ffda51a01acd65c0d7">◆ </a></span>AMMLiquidity() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::AMMLiquidity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>< TIn, TOut > const & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa217198640a9af820fdb9c487b5b094b" name="aa217198640a9af820fdb9c487b5b094b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa217198640a9af820fdb9c487b5b094b">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a> & <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>< TIn, TOut > const & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f40426bb36529ccba8ef2768e3c3bc9" name="a4f40426bb36529ccba8ef2768e3c3bc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f40426bb36529ccba8ef2768e3c3bc9">◆ </a></span>getOffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1AMMOffer.html">AMMOffer</a>< TIn, TOut > > <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::getOffer </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="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< Quality > const & </td>
|
|
<td class="paramname"><em>clobQuality</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generate AMM offer. </p>
|
|
<p>Returns nullopt if clobQuality is provided and it is better than AMM offer quality. Otherwise returns AMM offer. If clobQuality is provided then AMM offer size is set based on the quality. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8cpp_source.html#l00131">131</a> of file <a class="el" href="AMMLiquidity_8cpp_source.html">AMMLiquidity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9316bb888b1ce3b10be95103a2830a08" name="a9316bb888b1ce3b10be95103a2830a08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9316bb888b1ce3b10be95103a2830a08">◆ </a></span>ammAccount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::ammAccount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00070">70</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a293bb918d765f4291d1f8d11a0a1e63d" name="a293bb918d765f4291d1f8d11a0a1e63d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a293bb918d765f4291d1f8d11a0a1e63d">◆ </a></span>multiPath()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::multiPath </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00076">76</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2464ba632642635216c034a22d1408c8" name="a2464ba632642635216c034a22d1408c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2464ba632642635216c034a22d1408c8">◆ </a></span>tradingFee()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::tradingFee </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00082">82</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0483f5ab5a62264b9254e7fc6f15fbcf" name="a0483f5ab5a62264b9254e7fc6f15fbcf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0483f5ab5a62264b9254e7fc6f15fbcf">◆ </a></span>context()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> & <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::context </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00088">88</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3f3caadf2e06839e1a67a6690b2fdad7" name="a3f3caadf2e06839e1a67a6690b2fdad7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f3caadf2e06839e1a67a6690b2fdad7">◆ </a></span>issueIn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const & <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::issueIn </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00094">94</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a055fcd3cdd03884c34a008ae85f2bd80" name="a055fcd3cdd03884c34a008ae85f2bd80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a055fcd3cdd03884c34a008ae85f2bd80">◆ </a></span>issueOut()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const & <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::issueOut </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00100">100</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90e392457e7f89d2ee5e2a5398b29aac" name="a90e392457e7f89d2ee5e2a5398b29aac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90e392457e7f89d2ee5e2a5398b29aac">◆ </a></span>fetchBalances()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TAmounts< TIn, TOut > <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::fetchBalances </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><td>)</td>
|
|
<td> const</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>Fetches current AMM balances. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8cpp_source.html#l00027">27</a> of file <a class="el" href="AMMLiquidity_8cpp_source.html">AMMLiquidity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc3099a63d626321df693638c4b09b34" name="afc3099a63d626321df693638c4b09b34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc3099a63d626321df693638c4b09b34">◆ </a></span>generateFibSeqOffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TAmounts< TIn, TOut > <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::generateFibSeqOffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">TAmounts< TIn, TOut > const & </td>
|
|
<td class="paramname"><em>balances</em></td><td>)</td>
|
|
<td> const</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>Generate AMM offers with the offer size based on Fibonacci sequence. </p>
|
|
<p>The sequence corresponds to the payment engine iterations with AMM liquidity. Iterations that don't consume AMM offers don't count. The number of iterations with AMM offers is limited. If the generated offer exceeds the pool balance then the function throws overflow exception. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8cpp_source.html#l00040">40</a> of file <a class="el" href="AMMLiquidity_8cpp_source.html">AMMLiquidity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6752c49c9927eb6d07bb08f4418581e" name="ab6752c49c9927eb6d07bb08f4418581e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6752c49c9927eb6d07bb08f4418581e">◆ </a></span>maxOffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<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/optional.html">std::optional</a>< <a class="el" href="classripple_1_1AMMOffer.html">AMMOffer</a>< TIn, TOut > > <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::maxOffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">TAmounts< TIn, TOut > const & </td>
|
|
<td class="paramname"><em>balances</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Rules.html">Rules</a> const & </td>
|
|
<td class="paramname"><em>rules</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</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>Generate max offer. </p>
|
|
<p>If <code>fixAMMOverflowOffer</code> is active, the offer is generated as: takerGets = 99% * balances.out takerPays = swapOut(takerGets). Return nullopt if takerGets is 0 or takerGets == balances.out.</p>
|
|
<p>If <code>fixAMMOverflowOffer</code> is not active, the offer is generated as: takerPays = max input amount; takerGets = swapIn(takerPays). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8cpp_source.html#l00103">103</a> of file <a class="el" href="AMMLiquidity_8cpp_source.html">AMMLiquidity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a10fb841bc078c796d9e3c2fcb3541c13" name="a10fb841bc078c796d9e3c2fcb3541c13"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10fb841bc078c796d9e3c2fcb3541c13">◆ </a></span>InitialFibSeqPct</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Number.html">Number</a> const <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::InitialFibSeqPct = <a class="el" href="classripple_1_1Number.html">Number</a>(5) / 20000</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00036">36</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa76a6df3301390623b4502708b65a66" name="aaa76a6df3301390623b4502708b65a66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa76a6df3301390623b4502708b65a66">◆ </a></span>ammContext_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a>& <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::ammContext_</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="AMMLiquidity_8h_source.html#l00037">37</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a133f036de6e226d1a9d989ba57f50cb7" name="a133f036de6e226d1a9d989ba57f50cb7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a133f036de6e226d1a9d989ba57f50cb7">◆ </a></span>ammAccountID_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<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 <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::ammAccountID_</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="AMMLiquidity_8h_source.html#l00038">38</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeba999ec8adb002627daf4434b39cb5a" name="aeba999ec8adb002627daf4434b39cb5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeba999ec8adb002627daf4434b39cb5a">◆ </a></span>tradingFee_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<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/types/integer.html">std::uint32_t</a> const <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::tradingFee_</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="AMMLiquidity_8h_source.html#l00039">39</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a36a6364b9f06e25c418bd59cf4d455" name="a4a36a6364b9f06e25c418bd59cf4d455"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a36a6364b9f06e25c418bd59cf4d455">◆ </a></span>issueIn_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::issueIn_</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="AMMLiquidity_8h_source.html#l00040">40</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add252bdab66684786d1d1faf36c03585" name="add252bdab66684786d1d1faf36c03585"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add252bdab66684786d1d1faf36c03585">◆ </a></span>issueOut_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::issueOut_</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="AMMLiquidity_8h_source.html#l00041">41</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb12965efebc4a2dac9f59f1bffc1974" name="abb12965efebc4a2dac9f59f1bffc1974"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb12965efebc4a2dac9f59f1bffc1974">◆ </a></span>initialBalances_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TAmounts<TIn, TOut> const <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::initialBalances_</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="AMMLiquidity_8h_source.html#l00043">43</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84417ee785f2490ca7a50fc70b9be157" name="a84417ee785f2490ca7a50fc70b9be157"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84417ee785f2490ca7a50fc70b9be157">◆ </a></span>j_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename TIn , typename TOut > </div>
|
|
<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 <a class="el" href="classripple_1_1AMMLiquidity.html">ripple::AMMLiquidity</a>< TIn, TOut >::j_</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="AMMLiquidity_8h_source.html#l00044">44</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.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.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|