AMMLiquidity class provides AMM offers to BookStep class. More...

#include <AMMLiquidity.h>

Collaboration diagram for xrpl::AMMLiquidity< TIn, TOut >:

[legend]

Public Member Functions
	AMMLiquidity (ReadView const &view, AccountID const &ammAccountID, std::uint32_t tradingFee, Asset const &in, Asset const &out, AMMContext &ammContext, beast::Journal j)
	~AMMLiquidity ()=default
	AMMLiquidity (AMMLiquidity const &)=delete
AMMLiquidity &	operator= (AMMLiquidity const &)=delete
std::optional< AMMOffer< TIn, TOut > >	getOffer (ReadView const &view, std::optional< Quality > const &clobQuality) const
	Generate AMM offer.
AccountID const &	ammAccount () const
bool	multiPath () const
std::uint32_t	tradingFee () const
AMMContext &	context () const
Asset const &	assetIn () const
Asset const &	assetOut () const

Private Member Functions
TAmounts< TIn, TOut >	fetchBalances (ReadView const &view) const
	Fetches current AMM balances.
TAmounts< TIn, TOut >	generateFibSeqOffer (TAmounts< TIn, TOut > const &balances) const
	Generate AMM offers with the offer size based on Fibonacci sequence.
std::optional< AMMOffer< TIn, TOut > >	maxOffer (TAmounts< TIn, TOut > const &balances) const
	Generate max offer.

Private Attributes
AMMContext &	ammContext_
AccountID const	ammAccountID_
std::uint32_t const	tradingFee_
Asset const	assetIn_
Asset const	assetOut_
TAmounts< TIn, TOut > const	initialBalances_
beast::Journal const	j_

Static Private Attributes
static Number const	kInitialFibSeqPct = Number(5) / 20000

Detailed Description

template<typename TIn, typename TOut>
class xrpl::AMMLiquidity< TIn, TOut >

AMMLiquidity class provides AMM offers to BookStep class.

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.

Definition at line 35 of file AMMLiquidity.h.

Constructor & Destructor Documentation

◆ AMMLiquidity() [1/2]

template<typename TIn, typename TOut>

xrpl::AMMLiquidity< TIn, TOut >::AMMLiquidity	(	ReadView const &	view,
		AccountID const &	ammAccountID,
		std::uint32_t	tradingFee,
		Asset const &	in,
		Asset const &	out,
		AMMContext &	ammContext,
		beast::Journal	j )

Definition at line 32 of file AMMLiquidity.cpp.

◆ ~AMMLiquidity()

template<typename TIn, typename TOut>

xrpl::AMMLiquidity< TIn, TOut >::~AMMLiquidity ( )

default

◆ AMMLiquidity() [2/2]

template<typename TIn, typename TOut>

xrpl::AMMLiquidity< TIn, TOut >::AMMLiquidity ( AMMLiquidity< TIn, TOut > const & )

delete

Member Function Documentation

◆ operator=()

template<typename TIn, typename TOut>

AMMLiquidity & xrpl::AMMLiquidity< TIn, TOut >::operator= ( AMMLiquidity< TIn, TOut > const & )

delete

◆ getOffer()

template<typename TIn, typename TOut>

std::optional< AMMOffer< TIn, TOut > > xrpl::AMMLiquidity< TIn, TOut >::getOffer	(	ReadView const &	view,
		std::optional< Quality > const &	clobQuality ) const

nodiscard

Generate AMM offer.

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.

Definition at line 147 of file AMMLiquidity.cpp.

◆ ammAccount()

template<typename TIn, typename TOut>

AccountID const & xrpl::AMMLiquidity< TIn, TOut >::ammAccount ( ) const

nodiscard

Definition at line 72 of file AMMLiquidity.h.

◆ multiPath()

template<typename TIn, typename TOut>

bool xrpl::AMMLiquidity< TIn, TOut >::multiPath ( ) const

nodiscard

Definition at line 78 of file AMMLiquidity.h.

◆ tradingFee()

template<typename TIn, typename TOut>

std::uint32_t xrpl::AMMLiquidity< TIn, TOut >::tradingFee ( ) const

nodiscard

Definition at line 84 of file AMMLiquidity.h.

◆ context()

template<typename TIn, typename TOut>

AMMContext & xrpl::AMMLiquidity< TIn, TOut >::context ( ) const

nodiscard

Definition at line 90 of file AMMLiquidity.h.

◆ assetIn()

template<typename TIn, typename TOut>

Asset const & xrpl::AMMLiquidity< TIn, TOut >::assetIn ( ) const

nodiscard

Definition at line 96 of file AMMLiquidity.h.

◆ assetOut()

template<typename TIn, typename TOut>

Asset const & xrpl::AMMLiquidity< TIn, TOut >::assetOut ( ) const

nodiscard

Definition at line 102 of file AMMLiquidity.h.

◆ fetchBalances()

template<typename TIn, typename TOut>

TAmounts< TIn, TOut > xrpl::AMMLiquidity< TIn, TOut >::fetchBalances ( ReadView const & view ) const

nodiscardprivate

Fetches current AMM balances.

Definition at line 52 of file AMMLiquidity.cpp.

◆ generateFibSeqOffer()

template<typename TIn, typename TOut>

TAmounts< TIn, TOut > xrpl::AMMLiquidity< TIn, TOut >::generateFibSeqOffer ( TAmounts< TIn, TOut > const & balances ) const

nodiscardprivate

Generate AMM offers with the offer size based on Fibonacci sequence.

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.

Definition at line 65 of file AMMLiquidity.cpp.

◆ maxOffer()

template<typename TIn, typename TOut>

std::optional< AMMOffer< TIn, TOut > > xrpl::AMMLiquidity< TIn, TOut >::maxOffer ( TAmounts< TIn, TOut > const & balances ) const

nodiscardprivate

Generate max offer.

The offer is generated as: takerGets = 99% * balances.out takerPays = swapOut(takerGets). Return nullopt if takerGets is 0 or takerGets == balances.out.

Definition at line 136 of file AMMLiquidity.cpp.

Member Data Documentation

◆ kInitialFibSeqPct

template<typename TIn, typename TOut>

Number const xrpl::AMMLiquidity< TIn, TOut >::kInitialFibSeqPct = Number(5) / 20000

staticprivate

Definition at line 38 of file AMMLiquidity.h.

◆ ammContext_

template<typename TIn, typename TOut>

AMMContext& xrpl::AMMLiquidity< TIn, TOut >::ammContext_

private

Definition at line 39 of file AMMLiquidity.h.

◆ ammAccountID_

template<typename TIn, typename TOut>

AccountID const xrpl::AMMLiquidity< TIn, TOut >::ammAccountID_

private

Definition at line 40 of file AMMLiquidity.h.

◆ tradingFee_

template<typename TIn, typename TOut>

std::uint32_t const xrpl::AMMLiquidity< TIn, TOut >::tradingFee_

private

Definition at line 41 of file AMMLiquidity.h.

◆ assetIn_

template<typename TIn, typename TOut>

Asset const xrpl::AMMLiquidity< TIn, TOut >::assetIn_

private

Definition at line 42 of file AMMLiquidity.h.

◆ assetOut_

template<typename TIn, typename TOut>

Asset const xrpl::AMMLiquidity< TIn, TOut >::assetOut_

private

Definition at line 43 of file AMMLiquidity.h.

◆ initialBalances_

template<typename TIn, typename TOut>

TAmounts<TIn, TOut> const xrpl::AMMLiquidity< TIn, TOut >::initialBalances_

private

Definition at line 45 of file AMMLiquidity.h.

◆ j_

template<typename TIn, typename TOut>

beast::Journal const xrpl::AMMLiquidity< TIn, TOut >::j_

private

Definition at line 46 of file AMMLiquidity.h.

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AMMLiquidity() [1/2]

◆ ~AMMLiquidity()

◆ AMMLiquidity() [2/2]

Member Function Documentation

◆ operator=()

◆ getOffer()

◆ ammAccount()

◆ multiPath()

◆ tradingFee()

◆ context()

◆ assetIn()

◆ assetOut()

◆ fetchBalances()

◆ generateFibSeqOffer()

◆ maxOffer()

Member Data Documentation

◆ kInitialFibSeqPct

◆ ammContext_

◆ ammAccountID_

◆ tradingFee_

◆ assetIn_

◆ assetOut_

◆ initialBalances_

◆ j_