AMMBid implements AMM bid Transactor. More...

#include <AMMBid.h>

Inheritance diagram for xrpl::AMMBid:

Collaboration diagram for xrpl::AMMBid:

[legend]

Public Types
enum class	ConsequencesFactoryType { Normal , Blocker , Custom }

Public Member Functions
	AMMBid (ApplyContext &ctx)
TER	doApply () override
void	visitInvariantEntry (bool isDelete, SLE::const_ref before, SLE::const_ref after) override
	Inspect a single ledger entry modified by this transaction.
bool	finalizeInvariants (STTx const &tx, TER result, XRPAmount fee, ReadView const &view, beast::Journal const &j) override
	Check transaction-specific post-conditions after all entries have been visited.
ApplyResult	operator() ()
	Process the transaction.
ApplyView &	view ()
ApplyView const &	view () const
TER	checkInvariants (TER result, XRPAmount fee)
	Check all invariants for the current transaction.

Static Public Member Functions
static bool	checkExtraFeatures (PreflightContext const &ctx)
static NotTEC	preflight (PreflightContext const &ctx)
static TER	preclaim (PreclaimContext const &ctx)
static NotTEC	checkSeqProxy (ReadView const &view, STTx const &tx, beast::Journal j)
static NotTEC	checkPriorTxAndLastLedger (PreclaimContext const &ctx)
static TER	checkFee (PreclaimContext const &ctx, XRPAmount baseFee)
static NotTEC	checkSign (PreclaimContext const &ctx)
static NotTEC	checkBatchSign (PreclaimContext const &ctx)
static XRPAmount	calculateBaseFee (ReadView const &view, STTx const &tx)
static XRPAmount	calculateBaseFee (ReadView const &view, STTx const &tx, std::uint32_t extraBaseFeeMultiplier)
template<class T>
static NotTEC	invokePreflight (PreflightContext const &ctx)
template<>
NotTEC	invokePreflight (PreflightContext const &ctx)
template<>
NotTEC	invokePreflight (PreflightContext const &ctx)
static NotTEC	checkGranularSemantics (ReadView const &view, STTx const &tx, std::unordered_set< GranularPermissionType > const &heldGranularPermissions)
	This function can be overridden to introduce additional semantic constraints beyond the granular template validation for granular permissions.
template<class T>
static NotTEC	invokeCheckPermission (ReadView const &view, STTx const &tx)
	Checks whether the transaction is authorized to be executed by the delegated account.
static TER	ticketDelete (ApplyView &view, AccountID const &account, uint256 const &ticketIndex, beast::Journal j)

Static Public Attributes
static constexpr auto	kConsequencesFactory = ConsequencesFactoryType::Normal

Protected Member Functions
TER	apply ()
virtual void	preCompute ()

Static Protected Member Functions
static NotTEC	checkSign (ReadView const &view, ApplyFlags flags, std::optional< uint256 const > const &parentBatchId, AccountID const &idAccount, STObject const &sigObject, beast::Journal const j)
static XRPAmount	minimumFee (ServiceRegistry &registry, XRPAmount baseFee, Fees const &fees, ApplyFlags flags)
	Compute the minimum fee required to process a transaction with a given baseFee based on the current server load.
static XRPAmount	calculateOwnerReserveFee (ReadView const &view, STTx const &tx)
static std::uint32_t	getFlagsMask (PreflightContext const &ctx)
static NotTEC	preflightSigValidated (PreflightContext const &ctx)
static bool	validDataLength (std::optional< Slice > const &slice, std::size_t maxLength)
template<class T>
static bool	validNumericRange (std::optional< T > value, T max, T min=T{})
template<class T, class Unit>
static bool	validNumericRange (std::optional< T > value, unit::ValueUnit< Unit, T > max, unit::ValueUnit< Unit, T > min=unit::ValueUnit< Unit, T >{})
template<class T>
static bool	validNumericMinimum (std::optional< T > value, T min=T{})
	Minimum will usually be zero.
template<class T, class Unit>
static bool	validNumericMinimum (std::optional< T > value, unit::ValueUnit< Unit, T > min=unit::ValueUnit< Unit, T >{})
	Minimum will usually be zero.

Protected Attributes
ApplyContext &	ctx_
beast::WrappedSink	sink_
beast::Journal const	j_
AccountID const	accountID_
XRPAmount	preFeeBalance_ {}

Private Member Functions
std::pair< TER, XRPAmount >	reset (XRPAmount fee)
	Reset the context, discarding any changes made and adjust the fee.
TER	consumeSeqProxy (SLE::pointer const &sleAccount)
TER	payFee ()
std::tuple< TER, XRPAmount, bool >	processPersistentChanges (TER result, XRPAmount fee)
void	trapTransaction (uint256) const
TER	checkTransactionInvariants (TER result, XRPAmount fee)
	Check transaction-specific invariants only.

Static Private Member Functions
static NotTEC	checkPermission (ReadView const &view, STTx const &tx, std::unordered_set< GranularPermissionType > &heldGranularPermissions)
static NotTEC	checkSingleSign (ReadView const &view, AccountID const &idSigner, AccountID const &idAccount, SLE::const_pointer sleAccount, beast::Journal const j)
static NotTEC	checkMultiSign (ReadView const &view, ApplyFlags flags, AccountID const &id, STObject const &sigObject, beast::Journal const j)
static NotTEC	preflight1 (PreflightContext const &ctx, std::uint32_t flagMask)
	Performs early sanity checks on the account and fee fields.
static NotTEC	preflight2 (PreflightContext const &ctx)
	Checks whether the signature appears valid.
static NotTEC	preflightUniversal (PreflightContext const &ctx)
	Universal validations.

Detailed Description

AMMBid implements AMM bid Transactor.

This is a mechanism for an AMM instance to auction-off the trading advantages to users (arbitrageurs) at a discounted TradingFee for a 24 hour slot. Any account that owns corresponding LPTokens can bid for the auction slot of that AMM instance. Part of the proceeds from the auction, i.e. LPTokens are refunded to the current slot-holder computed on a pro rata basis. Remaining part of the proceeds - in the units of LPTokens- is burnt, thus effectively increasing the LPs shares. Total slot time of 24 hours is divided into 20 equal intervals. The auction slot can be in any of the following states at any time:

Empty - no account currently holds the slot.
Occupied - an account owns the slot with at least 5% of the remaining slot time (in one of 1-19 intervals).
Tailing - an account owns the slot with less than 5% of the remaining time. The slot-holder owns the slot privileges when in state Occupied or Tailing. If x is the fraction of used slot time for the current slot holder and X is the price at which the slot can be bought specified in LPTokens then: The minimum bid price for the slot in first interval is f(x) = X * 1.05 + min_slot_price The bid price of slot any time is f(x) = X * 1.05 * (1 - x^60) + min_slot_price, where min_slot_price is a constant fraction of the total LPTokens. The revenue from a successful bid is split between the current slot-holder and the pool. The current slot holder is always refunded the remaining slot value f(x) = (1 - x) * X. The remaining LPTokens are burnt. The auction information is maintained in AuctionSlot of ltAMM object. AuctionSlot contains: Account - account id, which owns the slot. Expiration - slot expiration time DiscountedFee - trading fee charged to the account, default is 0. Price - price paid for the slot in LPTokens. AuthAccounts - up to four accounts authorized to trade at the discounted fee.
See also
XLS30d:Continuous Auction Mechanism

Definition at line 45 of file tx/transactors/dex/AMMBid.h.

Member Enumeration Documentation

◆ ConsequencesFactoryType

enum class xrpl::Transactor::ConsequencesFactoryType

stronginherited

Enumerator
Normal
Blocker
Custom

Definition at line 129 of file Transactor.h.

Constructor & Destructor Documentation

◆ AMMBid()

xrpl::AMMBid::AMMBid ( ApplyContext & ctx )

explicit

Definition at line 50 of file tx/transactors/dex/AMMBid.h.

Member Function Documentation

◆ checkExtraFeatures()

bool xrpl::AMMBid::checkExtraFeatures ( PreflightContext const & ctx )

static

Definition at line 37 of file AMMBid.cpp.

◆ preflight()

NotTEC xrpl::AMMBid::preflight ( PreflightContext const & ctx )

static

Definition at line 50 of file AMMBid.cpp.

◆ preclaim()

TER xrpl::AMMBid::preclaim ( PreclaimContext const & ctx )

static

Definition at line 105 of file AMMBid.cpp.

◆ doApply()

TER xrpl::AMMBid::doApply ( )

overridevirtual

Implements xrpl::Transactor.

Definition at line 367 of file AMMBid.cpp.

◆ visitInvariantEntry()

void xrpl::AMMBid::visitInvariantEntry	(	bool	isDelete,
		SLE::const_ref	before,
		SLE::const_ref	after )

overridevirtual

Inspect a single ledger entry modified by this transaction.

Called once for every SLE created, modified, or deleted by the transaction, before finalizeInvariants. Implementations should accumulate whatever state they need to verify transaction-specific post-conditions.

Parameters

isDelete	true if the entry was erased from the ledger.
before	the entry's state before the transaction (nullptr for newly created entries).
after	the entry's state as supplied by the apply logic for this transaction. For deletions, this is the SLE being erased and is not guaranteed to be null; callers must use isDelete rather than after == nullptr to detect deletions.

Implements xrpl::Transactor.

Definition at line 381 of file AMMBid.cpp.

◆ finalizeInvariants()

bool xrpl::AMMBid::finalizeInvariants	(	STTx const &	tx,
		TER	result,
		XRPAmount	fee,
		ReadView const &	view,
		beast::Journal const &	j )

nodiscardoverridevirtual

Check transaction-specific post-conditions after all entries have been visited.

Called once after every modified ledger entry has been passed to visitInvariantEntry. Returns true if all transaction-specific invariants hold, or false to fail the transaction with tecINVARIANT_FAILED.

Parameters

tx	the transaction being applied.
result	the tentative TER result so far.
fee	the fee consumed by the transaction.
view	read-only view of the ledger after the transaction.
j	journal for logging invariant failures.

Returns: true if all invariants pass; false otherwise.

Implements xrpl::Transactor.

Definition at line 387 of file AMMBid.cpp.

◆ operator()()

ApplyResult xrpl::Transactor::operator() ( )

inherited

Process the transaction.

Definition at line 1318 of file Transactor.cpp.

◆ view() [1/2]

ApplyView & xrpl::Transactor::view ( )

inherited

Definition at line 136 of file Transactor.h.

◆ view() [2/2]

ApplyView const & xrpl::Transactor::view ( ) const

nodiscardinherited

Definition at line 142 of file Transactor.h.

◆ checkInvariants()

TER xrpl::Transactor::checkInvariants	(	TER	result,
		XRPAmount	fee )

nodiscardinherited

Check all invariants for the current transaction.

Runs transaction-specific invariants first (visitInvariantEntry + finalizeInvariants), then protocol-level invariants. Both layers always run; the worst failure code is returned.

Parameters

result	the tentative TER from transaction processing.
fee	the fee consumed by the transaction.

Returns: the final TER after all invariant checks.

Definition at line 1301 of file Transactor.cpp.

◆ checkSeqProxy()

NotTEC xrpl::Transactor::checkSeqProxy	(	ReadView const &	view,
		STTx const &	tx,
		beast::Journal	j )

staticinherited

Definition at line 487 of file Transactor.cpp.

◆ checkPriorTxAndLastLedger()

NotTEC xrpl::Transactor::checkPriorTxAndLastLedger ( PreclaimContext const & ctx )

staticinherited

Definition at line 552 of file Transactor.cpp.

◆ checkFee()

TER xrpl::Transactor::checkFee	(	PreclaimContext const &	ctx,
		XRPAmount	baseFee )

staticinherited

Definition at line 400 of file Transactor.cpp.

◆ checkSign() [1/2]

NotTEC xrpl::Transactor::checkSign ( PreclaimContext const & ctx )

staticinherited

Definition at line 771 of file Transactor.cpp.

◆ checkSign() [2/2]

NotTEC xrpl::Transactor::checkSign	(	ReadView const &	view,
		ApplyFlags	flags,
		std::optional< uint256 const > const &	parentBatchId,
		AccountID const &	idAccount,
		STObject const &	sigObject,
		beast::Journal const	j )

staticprotectedinherited

Definition at line 705 of file Transactor.cpp.

◆ checkBatchSign()

NotTEC xrpl::Transactor::checkBatchSign ( PreclaimContext const & ctx )

staticinherited

Definition at line 779 of file Transactor.cpp.

◆ calculateBaseFee() [1/2]

XRPAmount xrpl::Transactor::calculateBaseFee	(	ReadView const &	view,
		STTx const &	tx )

staticinherited

Definition at line 342 of file Transactor.cpp.

◆ calculateBaseFee() [2/2]

XRPAmount xrpl::Transactor::calculateBaseFee	(	ReadView const &	view,
		STTx const &	tx,
		std::uint32_t	extraBaseFeeMultiplier )

staticinherited

Definition at line 360 of file Transactor.cpp.

◆ invokePreflight() [1/3]

template<class T>

NotTEC xrpl::Transactor::invokePreflight ( PreflightContext const & ctx )

staticinherited

Definition at line 530 of file Transactor.h.

◆ invokePreflight() [2/3]

template<>

NotTEC xrpl::Transactor::invokePreflight ( PreflightContext const & ctx )

staticinherited

◆ invokePreflight() [3/3]

template<>

NotTEC xrpl::Transactor::invokePreflight ( PreflightContext const & ctx )

staticinherited

Definition at line 33 of file Change.cpp.

◆ checkGranularSemantics()

NotTEC xrpl::Transactor::checkGranularSemantics	(	ReadView const &	view,
		STTx const &	tx,
		std::unordered_set< GranularPermissionType > const &	heldGranularPermissions )

staticinherited

This function can be overridden to introduce additional semantic constraints beyond the granular template validation for granular permissions.

It is called by the base invokeCheckPermission method only after the transaction has successfully passed checkGranularSandbox.

Definition at line 238 of file Transactor.h.

◆ invokeCheckPermission()

template<class T>

NotTEC xrpl::Transactor::invokeCheckPermission	(	ReadView const &	view,
		STTx const &	tx )

staticinherited

Checks whether the transaction is authorized to be executed by the delegated account.

This function enforces the strict permission check hierarchy. It is explicitly designed NOT to be overridden. Derived transactors must instead implement checkGranularSemantics to add custom validation logic for granular permissions.

The evaluation proceeds as follows:

If transaction-level permission is granted, the function immediately returns tesSUCCESS.
If transaction-level permission is not granted, the function checks whether the transaction matches the granular permission template defined in permissions.macro. If it does, it then calls checkGranularSemantics to perform any additional, fine-grained validation.

Definition at line 261 of file Transactor.h.

◆ ticketDelete()

TER xrpl::Transactor::ticketDelete	(	ApplyView &	view,
		AccountID const &	account,
		uint256 const &	ticketIndex,
		beast::Journal	j )

staticinherited

Definition at line 597 of file Transactor.cpp.

◆ apply()

TER xrpl::Transactor::apply ( )

protectedinherited

Definition at line 669 of file Transactor.cpp.

◆ preCompute()

void xrpl::Transactor::preCompute ( )

protectedvirtualinherited

Reimplemented in xrpl::Change, and xrpl::SignerListSet.

Definition at line 663 of file Transactor.cpp.

◆ minimumFee()

XRPAmount xrpl::Transactor::minimumFee	(	ServiceRegistry &	registry,
		XRPAmount	baseFee,
		Fees const &	fees,
		ApplyFlags	flags )

staticprotectedinherited

Compute the minimum fee required to process a transaction with a given baseFee based on the current server load.

Parameters

registry	The service registry.
baseFee	The base fee of a candidate transaction

See also: xrpl::calculateBaseFee

Parameters

fees	Fee settings from the current ledger
flags	Transaction processing fees

Definition at line 390 of file Transactor.cpp.

◆ calculateOwnerReserveFee()

XRPAmount xrpl::Transactor::calculateOwnerReserveFee	(	ReadView const &	view,
		STTx const &	tx )

staticprotectedinherited

Definition at line 370 of file Transactor.cpp.

◆ getFlagsMask()

std::uint32_t xrpl::Transactor::getFlagsMask ( PreflightContext const & ctx )

staticprotectedinherited

Definition at line 300 of file Transactor.cpp.

◆ preflightSigValidated()

NotTEC xrpl::Transactor::preflightSigValidated ( PreflightContext const & ctx )

staticprotectedinherited

Definition at line 306 of file Transactor.cpp.

◆ validDataLength()

bool xrpl::Transactor::validDataLength	(	std::optional< Slice > const &	slice,
		std::size_t	maxLength )

staticprotectedinherited

Definition at line 292 of file Transactor.cpp.

◆ validNumericRange() [1/2]

template<class T>

bool xrpl::Transactor::validNumericRange	(	std::optional< T >	value,
		T	max,
		T	min = T{} )

staticprotectedinherited

Definition at line 559 of file Transactor.h.

◆ validNumericRange() [2/2]

template<class T, class Unit>

bool xrpl::Transactor::validNumericRange	(	std::optional< T >	value,
		unit::ValueUnit< Unit, T >	max,
		unit::ValueUnit< Unit, T >	min = unit::ValueUnit<Unit, T>{} )

staticprotectedinherited

Definition at line 568 of file Transactor.h.

◆ validNumericMinimum() [1/2]

template<class T>

bool xrpl::Transactor::validNumericMinimum	(	std::optional< T >	value,
		T	min = T{} )

staticprotectedinherited

Minimum will usually be zero.

Definition at line 578 of file Transactor.h.

◆ validNumericMinimum() [2/2]

template<class T, class Unit>

bool xrpl::Transactor::validNumericMinimum	(	std::optional< T >	value,
		unit::ValueUnit< Unit, T >	min = unit::ValueUnit<Unit, T>{} )

staticprotectedinherited

Minimum will usually be zero.

Definition at line 587 of file Transactor.h.

◆ checkPermission()

NotTEC xrpl::Transactor::checkPermission	(	ReadView const &	view,
		STTx const &	tx,
		std::unordered_set< GranularPermissionType > &	heldGranularPermissions )

staticprivateinherited

Definition at line 312 of file Transactor.cpp.

◆ reset()

std::pair< TER, XRPAmount > xrpl::Transactor::reset ( XRPAmount fee )

privateinherited

Reset the context, discarding any changes made and adjust the fee.

Parameters

fee	The transaction fee to be charged.

Returns: A pair containing the transaction result and the actual fee charged.

Definition at line 1098 of file Transactor.cpp.

◆ consumeSeqProxy()

TER xrpl::Transactor::consumeSeqProxy ( SLE::pointer const & sleAccount )

privateinherited

Definition at line 580 of file Transactor.cpp.

◆ payFee()

TER xrpl::Transactor::payFee ( )

privateinherited

Definition at line 467 of file Transactor.cpp.

◆ processPersistentChanges()

std::tuple< TER, XRPAmount, bool > xrpl::Transactor::processPersistentChanges	(	TER	result,
		XRPAmount	fee )

privateinherited

Definition at line 1155 of file Transactor.cpp.

◆ checkSingleSign()

NotTEC xrpl::Transactor::checkSingleSign	(	ReadView const &	view,
		AccountID const &	idSigner,
		AccountID const &	idAccount,
		SLE::const_pointer	sleAccount,
		beast::Journal const	j )

staticprivateinherited

Definition at line 823 of file Transactor.cpp.

◆ checkMultiSign()

NotTEC xrpl::Transactor::checkMultiSign	(	ReadView const &	view,
		ApplyFlags	flags,
		AccountID const &	id,
		STObject const &	sigObject,
		beast::Journal const	j )

staticprivateinherited

Definition at line 855 of file Transactor.cpp.

◆ trapTransaction()

void xrpl::Transactor::trapTransaction ( uint256 txHash ) const

privateinherited

Definition at line 1149 of file Transactor.cpp.

◆ preflight1()

NotTEC xrpl::Transactor::preflight1	(	PreflightContext const &	ctx,
		std::uint32_t	flagMask )

staticprivateinherited

Performs early sanity checks on the account and fee fields.

(And passes flagMask to preflight0)

Do not try to call preflight1 from preflight() in derived classes. See the description of invokePreflight for details.

Definition at line 173 of file Transactor.cpp.

◆ preflight2()

NotTEC xrpl::Transactor::preflight2 ( PreflightContext const & ctx )

staticprivateinherited

Checks whether the signature appears valid.

Do not try to call preflight2 from preflight() in derived classes. See the description of invokePreflight for details.

Definition at line 237 of file Transactor.cpp.

◆ preflightUniversal()

NotTEC xrpl::Transactor::preflightUniversal ( PreflightContext const & ctx )

staticprivateinherited

Universal validations.

Valid MPTAmount and XRPAmount

Do not try to call preflightUniversal from preflight() in derived classes. See the description of invokePreflight for details.

Definition at line 273 of file Transactor.cpp.

◆ checkTransactionInvariants()

TER xrpl::Transactor::checkTransactionInvariants	(	TER	result,
		XRPAmount	fee )

nodiscardprivateinherited

Check transaction-specific invariants only.

Walks every modified ledger entry via visitInvariantEntry, then calls finalizeInvariants on the derived transactor. Returns tecINVARIANT_FAILED if any transaction invariant is violated.

Parameters

result	the tentative TER from transaction processing.
fee	the fee consumed by the transaction.

Returns: the original result if all invariants pass, or tecINVARIANT_FAILED otherwise.

Definition at line 1267 of file Transactor.cpp.

Member Data Documentation

◆ kConsequencesFactory

auto xrpl::AMMBid::kConsequencesFactory = ConsequencesFactoryType::Normal

staticconstexpr

Definition at line 48 of file tx/transactors/dex/AMMBid.h.

◆ ctx_

ApplyContext& xrpl::Transactor::ctx_

protectedinherited

Definition at line 116 of file Transactor.h.

◆ sink_

beast::WrappedSink xrpl::Transactor::sink_

protectedinherited

Definition at line 117 of file Transactor.h.

◆ j_

beast::Journal const xrpl::Transactor::j_

protectedinherited

Definition at line 118 of file Transactor.h.

◆ accountID_

AccountID const xrpl::Transactor::accountID_

protectedinherited

Definition at line 120 of file Transactor.h.

◆ preFeeBalance_

XRPAmount xrpl::Transactor::preFeeBalance_ {}

protectedinherited

Definition at line 121 of file Transactor.h.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ ConsequencesFactoryType

Constructor & Destructor Documentation

◆ AMMBid()

Member Function Documentation

◆ checkExtraFeatures()

◆ preflight()

◆ preclaim()

◆ doApply()

◆ visitInvariantEntry()

◆ finalizeInvariants()

◆ operator()()

◆ view() [1/2]

◆ view() [2/2]

◆ checkInvariants()

◆ checkSeqProxy()

◆ checkPriorTxAndLastLedger()

◆ checkFee()

◆ checkSign() [1/2]

◆ checkSign() [2/2]

◆ checkBatchSign()

◆ calculateBaseFee() [1/2]

◆ calculateBaseFee() [2/2]

◆ invokePreflight() [1/3]

◆ invokePreflight() [2/3]

◆ invokePreflight() [3/3]

◆ checkGranularSemantics()

◆ invokeCheckPermission()

◆ ticketDelete()

◆ apply()

◆ preCompute()

◆ minimumFee()

◆ calculateOwnerReserveFee()

◆ getFlagsMask()

◆ preflightSigValidated()

◆ validDataLength()

◆ validNumericRange() [1/2]

◆ validNumericRange() [2/2]

◆ validNumericMinimum() [1/2]

◆ validNumericMinimum() [2/2]

◆ checkPermission()

◆ reset()

◆ consumeSeqProxy()

◆ payFee()

◆ processPersistentChanges()

◆ checkSingleSign()

◆ checkMultiSign()

◆ trapTransaction()

◆ preflight1()

◆ preflight2()

◆ preflightUniversal()

◆ checkTransactionInvariants()

Member Data Documentation

◆ kConsequencesFactory

◆ ctx_

◆ sink_

◆ j_

◆ accountID_

◆ preFeeBalance_