Inheritance diagram for ripple::BookStep< TIn, TOut, TDerived >:

Collaboration diagram for ripple::BookStep< TIn, TOut, TDerived >:

[legend]

Classes
struct	Cache

Public Member Functions
	BookStep (StrandContext const &ctx, Issue const &in, Issue const &out)

Book const &	book () const

std::optional< EitherAmount >	cachedIn () const override

std::optional< EitherAmount >	cachedOut () const override

DebtDirection	debtDirection (ReadView const &sb, StrandDirection dir) const override

std::optional< Book >	bookStepBook () const override

std::pair< std::optional< Quality >, DebtDirection >	qualityUpperBound (ReadView const &v, DebtDirection prevStepDir) const override

std::pair< std::optional< QualityFunction >, DebtDirection >	getQualityFunc (ReadView const &v, DebtDirection prevStepDir) const override

std::uint32_t	offersUsed () const override

std::pair< TIn, TOut >	revImp (PaymentSandbox &sb, ApplyView &afView, boost::container::flat_set< uint256 > &ofrsToRm, TOut const &out)

std::pair< TIn, TOut >	fwdImp (PaymentSandbox &sb, ApplyView &afView, boost::container::flat_set< uint256 > &ofrsToRm, TIn const &in)

std::pair< bool, EitherAmount >	validFwd (PaymentSandbox &sb, ApplyView &afView, EitherAmount const &in) override

TER	check (StrandContext const &ctx) const

bool	inactive () const override

Protected Types
enum class	OfferType { AMM , CLOB }

Protected Member Functions
std::string	logStringImpl (char const *name) const

Protected Attributes
Book	book_

AccountID	strandSrc_

AccountID	strandDst_

Step const *const	prevStep_ = nullptr

bool const	ownerPaysTransferFee_

bool	inactive_ = false

std::uint32_t	offersUsed_ = 0
	Number of offers consumed or partially consumed the last time the step ran, including expired and unfunded offers.

std::optional< AMMLiquidity< TIn, TOut > >	ammLiquidity_

beast::Journal const	j_

std::optional< Cache >	cache_

Static Protected Attributes
static constexpr uint32_t	MaxOffersToConsume {1000}

Private Member Functions
bool	equal (Step const &rhs) const override

template<class Callback >
std::pair< boost::container::flat_set< uint256 >, std::uint32_t >	forEachOffer (PaymentSandbox &sb, ApplyView &afView, DebtDirection prevStepDebtDir, Callback &callback) const

template<template< typename, typename > typename Offer>
void	consumeOffer (PaymentSandbox &sb, Offer< TIn, TOut > &offer, TAmounts< TIn, TOut > const &ofrAmt, TAmounts< TIn, TOut > const &stepAmt, TOut const &ownerGives) const

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

std::optional< std::variant< Quality, AMMOffer< TIn, TOut > > >	tip (ReadView const &view) const

std::optional< std::pair< Quality, OfferType > >	tipOfferQuality (ReadView const &view) const

std::optional< QualityFunction >	tipOfferQualityF (ReadView const &view) const

Friends
bool	operator== (BookStep const &lhs, BookStep const &rhs)

bool	operator!= (BookStep const &lhs, BookStep const &rhs)

Detailed Description

template<class TIn, class TOut, class TDerived>
class ripple::BookStep< TIn, TOut, TDerived >

Definition at line 26 of file BookStep.cpp.

Member Enumeration Documentation

◆ OfferType

template<class TIn , class TOut , class TDerived >

enum class ripple::BookStep::OfferType

strongprotected

Enumerator
AMM
CLOB

Definition at line 29 of file BookStep.cpp.

Constructor & Destructor Documentation

◆ BookStep()

template<class TIn , class TOut , class TDerived >

ripple::BookStep< TIn, TOut, TDerived >::BookStep	(	StrandContext const &	ctx,
		Issue const &	in,
		Issue const &	out
	)

Definition at line 67 of file BookStep.cpp.

Member Function Documentation

◆ book()

template<class TIn , class TOut , class TDerived >

Book const & ripple::BookStep< TIn, TOut, TDerived >::book ( ) const

Definition at line 88 of file BookStep.cpp.

◆ cachedIn()

template<class TIn , class TOut , class TDerived >

std::optional< EitherAmount > ripple::BookStep< TIn, TOut, TDerived >::cachedIn ( ) const

override

Definition at line 94 of file BookStep.cpp.

◆ cachedOut()

template<class TIn , class TOut , class TDerived >

std::optional< EitherAmount > ripple::BookStep< TIn, TOut, TDerived >::cachedOut ( ) const

override

Definition at line 102 of file BookStep.cpp.

◆ debtDirection()

template<class TIn , class TOut , class TDerived >

DebtDirection ripple::BookStep< TIn, TOut, TDerived >::debtDirection	(	ReadView const &	sb,
		StrandDirection	dir
	)		const

override

Definition at line 110 of file BookStep.cpp.

◆ bookStepBook()

template<class TIn , class TOut , class TDerived >

std::optional< Book > ripple::BookStep< TIn, TOut, TDerived >::bookStepBook ( ) const

override

Definition at line 117 of file BookStep.cpp.

◆ qualityUpperBound()

template<class TIn , class TOut , class TDerived >

std::pair< std::optional< Quality >, DebtDirection > ripple::BookStep< TIn, TOut, TDerived >::qualityUpperBound	(	ReadView const &	v,
		DebtDirection	prevStepDir
	)		const

override

Definition at line 556 of file BookStep.cpp.

◆ getQualityFunc()

template<class TIn , class TOut , class TDerived >

std::pair< std::optional< QualityFunction >, DebtDirection > ripple::BookStep< TIn, TOut, TDerived >::getQualityFunc	(	ReadView const &	v,
		DebtDirection	prevStepDir
	)		const

override

Definition at line 582 of file BookStep.cpp.

◆ offersUsed()

template<class TIn , class TOut , class TDerived >

std::uint32_t ripple::BookStep< TIn, TOut, TDerived >::offersUsed ( ) const

override

Definition at line 624 of file BookStep.cpp.

◆ revImp()

template<class TIn , class TOut , class TDerived >

std::pair< TIn, TOut > ripple::BookStep< TIn, TOut, TDerived >::revImp	(	PaymentSandbox &	sb,
		ApplyView &	afView,
		boost::container::flat_set< uint256 > &	ofrsToRm,
		TOut const &	out
	)

Definition at line 986 of file BookStep.cpp.

◆ fwdImp()

template<class TIn , class TOut , class TDerived >

std::pair< TIn, TOut > ripple::BookStep< TIn, TOut, TDerived >::fwdImp	(	PaymentSandbox &	sb,
		ApplyView &	afView,
		boost::container::flat_set< uint256 > &	ofrsToRm,
		TIn const &	in
	)

Definition at line 1100 of file BookStep.cpp.

◆ validFwd()

template<class TIn , class TOut , class TDerived >

std::pair< bool, EitherAmount > ripple::BookStep< TIn, TOut, TDerived >::validFwd	(	PaymentSandbox &	sb,
		ApplyView &	afView,
		EitherAmount const &	in
	)

override

Definition at line 1264 of file BookStep.cpp.

◆ check()

template<class TIn , class TOut , class TDerived >

TER ripple::BookStep< TIn, TOut, TDerived >::check ( StrandContext const & ctx ) const

Definition at line 1302 of file BookStep.cpp.

◆ inactive()

template<class TIn , class TOut , class TDerived >

bool ripple::BookStep< TIn, TOut, TDerived >::inactive ( ) const

override

Definition at line 155 of file BookStep.cpp.

◆ logStringImpl()

template<class TIn , class TOut , class TDerived >

std::string ripple::BookStep< TIn, TOut, TDerived >::logStringImpl ( char const * name ) const

protected

Definition at line 162 of file BookStep.cpp.

◆ equal()

template<class TIn , class TOut , class TDerived >

bool ripple::BookStep< TIn, TOut, TDerived >::equal ( Step const & rhs ) const

overrideprivate

Definition at line 547 of file BookStep.cpp.

◆ forEachOffer()

template<class TIn , class TOut , class TDerived >

template<class Callback >

std::pair< boost::container::flat_set< uint256 >, std::uint32_t > ripple::BookStep< TIn, TOut, TDerived >::forEachOffer	(	PaymentSandbox &	sb,
		ApplyView &	afView,
		DebtDirection	prevStepDebtDir,
		Callback &	callback
	)		const

private

Definition at line 689 of file BookStep.cpp.

◆ consumeOffer()

template<class TIn , class TOut , class TDerived >

template<template< typename, typename > typename Offer>

void ripple::BookStep< TIn, TOut, TDerived >::consumeOffer	(	PaymentSandbox &	sb,
		Offer< TIn, TOut > &	offer,
		TAmounts< TIn, TOut > const &	ofrAmt,
		TAmounts< TIn, TOut > const &	stepAmt,
		TOut const &	ownerGives
	)		const

private

Definition at line 850 of file BookStep.cpp.

◆ getAMMOffer()

template<class TIn , class TOut , class TDerived >

std::optional< AMMOffer< TIn, TOut > > ripple::BookStep< TIn, TOut, TDerived >::getAMMOffer	(	ReadView const &	view,
		std::optional< Quality > const &	clobQuality
	)		const

private

Definition at line 899 of file BookStep.cpp.

◆ tip()

template<class TIn , class TOut , class TDerived >

std::optional< std::variant< Quality, AMMOffer< TIn, TOut > > > ripple::BookStep< TIn, TOut, TDerived >::tip ( ReadView const & view ) const

private

Definition at line 910 of file BookStep.cpp.

◆ tipOfferQuality()

template<class TIn , class TOut , class TDerived >

auto ripple::BookStep< TIn, TOut, TDerived >::tipOfferQuality ( ReadView const & view ) const

private

Definition at line 950 of file BookStep.cpp.

◆ tipOfferQualityF()

template<class TIn , class TOut , class TDerived >

std::optional< QualityFunction > ripple::BookStep< TIn, TOut, TDerived >::tipOfferQualityF ( ReadView const & view ) const

private

Definition at line 964 of file BookStep.cpp.

Friends And Related Symbol Documentation

◆ operator==

template<class TIn , class TOut , class TDerived >

bool operator==	(	BookStep< TIn, TOut, TDerived > const &	lhs,
		BookStep< TIn, TOut, TDerived > const &	rhs
	)

friend

Definition at line 175 of file BookStep.cpp.

◆ operator!=

template<class TIn , class TOut , class TDerived >

bool operator!=	(	BookStep< TIn, TOut, TDerived > const &	lhs,
		BookStep< TIn, TOut, TDerived > const &	rhs
	)

friend

Definition at line 181 of file BookStep.cpp.

Member Data Documentation

◆ MaxOffersToConsume

template<class TIn , class TOut , class TDerived >

constexpr uint32_t ripple::BookStep< TIn, TOut, TDerived >::MaxOffersToConsume {1000}

staticconstexprprotected

Definition at line 31 of file BookStep.cpp.

◆ book_

template<class TIn , class TOut , class TDerived >

Book ripple::BookStep< TIn, TOut, TDerived >::book_

protected

Definition at line 32 of file BookStep.cpp.

◆ strandSrc_

template<class TIn , class TOut , class TDerived >

AccountID ripple::BookStep< TIn, TOut, TDerived >::strandSrc_

protected

Definition at line 33 of file BookStep.cpp.

◆ strandDst_

template<class TIn , class TOut , class TDerived >

AccountID ripple::BookStep< TIn, TOut, TDerived >::strandDst_

protected

Definition at line 34 of file BookStep.cpp.

◆ prevStep_

template<class TIn , class TOut , class TDerived >

Step const* const ripple::BookStep< TIn, TOut, TDerived >::prevStep_ = nullptr

protected

Definition at line 36 of file BookStep.cpp.

◆ ownerPaysTransferFee_

template<class TIn , class TOut , class TDerived >

bool const ripple::BookStep< TIn, TOut, TDerived >::ownerPaysTransferFee_

protected

Definition at line 37 of file BookStep.cpp.

◆ inactive_

template<class TIn , class TOut , class TDerived >

bool ripple::BookStep< TIn, TOut, TDerived >::inactive_ = false

protected

Definition at line 39 of file BookStep.cpp.

◆ offersUsed_

template<class TIn , class TOut , class TDerived >

std::uint32_t ripple::BookStep< TIn, TOut, TDerived >::offersUsed_ = 0

protected

Number of offers consumed or partially consumed the last time the step ran, including expired and unfunded offers.

N.B. This this not the total number offers consumed by this step for the entire payment, it is only the number the last time it ran. Offers may be partially consumed multiple times during a payment.

Definition at line 47 of file BookStep.cpp.

◆ ammLiquidity_

template<class TIn , class TOut , class TDerived >

std::optional<AMMLiquidity<TIn, TOut> > ripple::BookStep< TIn, TOut, TDerived >::ammLiquidity_

protected

Definition at line 51 of file BookStep.cpp.

◆ j_

template<class TIn , class TOut , class TDerived >

beast::Journal const ripple::BookStep< TIn, TOut, TDerived >::j_

protected

Definition at line 52 of file BookStep.cpp.

◆ cache_

template<class TIn , class TOut , class TDerived >

std::optional<Cache> ripple::BookStep< TIn, TOut, TDerived >::cache_

protected

Definition at line 64 of file BookStep.cpp.

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ OfferType

Constructor & Destructor Documentation

◆ BookStep()

Member Function Documentation

◆ book()

◆ cachedIn()

◆ cachedOut()

◆ debtDirection()

◆ bookStepBook()

◆ qualityUpperBound()

◆ getQualityFunc()

◆ offersUsed()

◆ revImp()

◆ fwdImp()

◆ validFwd()

◆ check()

◆ inactive()

◆ logStringImpl()

◆ equal()

◆ forEachOffer()

◆ consumeOffer()

◆ getAMMOffer()

◆ tip()

◆ tipOfferQuality()

◆ tipOfferQualityF()

Friends And Related Symbol Documentation

◆ operator==

◆ operator!=

Member Data Documentation

◆ MaxOffersToConsume

◆ book_

◆ strandSrc_

◆ strandDst_

◆ prevStep_

◆ ownerPaysTransferFee_

◆ inactive_

◆ offersUsed_

◆ ammLiquidity_

◆ j_

◆ cache_