AMMBid implements AMM bid Transactor. More...

#include <AMMBid.h>

Inheritance diagram for ripple::AMMBid:

Collaboration diagram for ripple::AMMBid:

[legend]

Public Types
enum	ConsequencesFactoryType { Normal , Blocker , Custom }

Public Member Functions
	AMMBid (ApplyContext &ctx)

TER	doApply () override

ApplyResult	operator() ()
	Process the transaction. More...

ApplyView &	view ()

ApplyView const &	view () const

Static Public Member Functions
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 TER	checkPermission (ReadView const &view, STTx const &tx)

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

Static Public Attributes
static constexpr ConsequencesFactoryType	ConsequencesFactory {Normal}

Protected Member Functions
TER	apply ()

virtual void	preCompute ()

Static Protected Member Functions
static XRPAmount	minimumFee (Application &app, 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. More...

Protected Attributes
ApplyContext &	ctx_

beast::Journal const	j_

AccountID const	account_

XRPAmount	mPriorBalance

XRPAmount	mSourceBalance

Private Member Functions
std::pair< TER, XRPAmount >	reset (XRPAmount fee)
	Reset the context, discarding any changes made and adjust the fee. More...

TER	consumeSeqProxy (SLE::pointer const &sleAccount)

TER	payFee ()

void	trapTransaction (uint256) const

Static Private Member Functions
static NotTEC	checkSingleSign (AccountID const &idSigner, AccountID const &idAccount, std::shared_ptr< SLE const > sleAccount, Rules const &rules, beast::Journal j)

static NotTEC	checkMultiSign (ReadView const &view, AccountID const &idAccount, STArray const &txSigners, ApplyFlags const &flags, beast::Journal j)

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 65 of file AMMBid.h.

Member Enumeration Documentation

◆ ConsequencesFactoryType

enum ripple::Transactor::ConsequencesFactoryType

inherited

Enumerator
Normal
Blocker
Custom

Definition at line 153 of file Transactor.h.

Constructor & Destructor Documentation

◆ AMMBid()

ripple::AMMBid::AMMBid ( ApplyContext & ctx )

explicit

Definition at line 70 of file AMMBid.h.

Member Function Documentation

◆ preflight()

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

static

Definition at line 34 of file AMMBid.cpp.

◆ preclaim()

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

static

Definition at line 87 of file AMMBid.cpp.

◆ doApply()

TER ripple::AMMBid::doApply ( )

overridevirtual

Implements ripple::Transactor.

Definition at line 358 of file AMMBid.cpp.

◆ operator()()

ApplyResult ripple::Transactor::operator() ( )

inherited

Process the transaction.

Definition at line 1049 of file Transactor.cpp.

◆ view() [1/2]

ApplyView & ripple::Transactor::view ( )

inherited

Definition at line 159 of file Transactor.h.

◆ view() [2/2]

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

inherited

Definition at line 165 of file Transactor.h.

◆ checkSeqProxy()

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

staticinherited

Definition at line 352 of file Transactor.cpp.

◆ checkPriorTxAndLastLedger()

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

staticinherited

Definition at line 424 of file Transactor.cpp.

◆ checkFee()

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

staticinherited

Definition at line 252 of file Transactor.cpp.

◆ checkSign()

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

staticinherited

Definition at line 572 of file Transactor.cpp.

◆ checkBatchSign()

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

staticinherited

Definition at line 624 of file Transactor.cpp.

◆ calculateBaseFee()

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

staticinherited

Definition at line 224 of file Transactor.cpp.

◆ checkPermission()

TER ripple::Transactor::checkPermission	(	ReadView const &	view,
		STTx const &	tx
	)

staticinherited

Definition at line 208 of file Transactor.cpp.

◆ ticketDelete()

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

staticinherited

Definition at line 473 of file Transactor.cpp.

◆ apply()

TER ripple::Transactor::apply ( )

protectedinherited

Definition at line 535 of file Transactor.cpp.

◆ preCompute()

void ripple::Transactor::preCompute ( )

protectedvirtualinherited

Reimplemented in ripple::Change, ripple::CreateOffer, and ripple::SetSignerList.

Definition at line 527 of file Transactor.cpp.

◆ minimumFee()

XRPAmount ripple::Transactor::minimumFee	(	Application &	app,
		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

app	The application hosting the server
baseFee	The base fee of a candidate transaction

See also: ripple::calculateBaseFee

Parameters

fees	Fee settings from the current ledger
flags	Transaction processing fees

Definition at line 242 of file Transactor.cpp.

◆ reset()

std::pair< TER, XRPAmount > ripple::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 987 of file Transactor.cpp.

◆ consumeSeqProxy()

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

privateinherited

Definition at line 454 of file Transactor.cpp.

◆ payFee()

TER ripple::Transactor::payFee ( )

privateinherited

Definition at line 317 of file Transactor.cpp.

◆ checkSingleSign()

NotTEC ripple::Transactor::checkSingleSign	(	AccountID const &	idSigner,
		AccountID const &	idAccount,
		std::shared_ptr< SLE const >	sleAccount,
		Rules const &	rules,
		beast::Journal	j
	)

staticprivateinherited

Definition at line 671 of file Transactor.cpp.

◆ checkMultiSign()

NotTEC ripple::Transactor::checkMultiSign	(	ReadView const &	view,
		AccountID const &	idAccount,
		STArray const &	txSigners,
		ApplyFlags const &	flags,
		beast::Journal	j
	)

staticprivateinherited

Definition at line 732 of file Transactor.cpp.

◆ trapTransaction()

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

privateinherited

Definition at line 1042 of file Transactor.cpp.

Member Data Documentation

◆ ConsequencesFactory

constexpr ConsequencesFactoryType ripple::AMMBid::ConsequencesFactory {Normal}

staticconstexpr

Definition at line 68 of file AMMBid.h.

◆ ctx_

ApplyContext& ripple::Transactor::ctx_

protectedinherited

Definition at line 140 of file Transactor.h.

◆ j_

beast::Journal const ripple::Transactor::j_

protectedinherited

Definition at line 141 of file Transactor.h.

◆ account_

AccountID const ripple::Transactor::account_

protectedinherited

Definition at line 143 of file Transactor.h.

◆ mPriorBalance

XRPAmount ripple::Transactor::mPriorBalance

protectedinherited

Definition at line 144 of file Transactor.h.

◆ mSourceBalance

XRPAmount ripple::Transactor::mSourceBalance

protectedinherited

Definition at line 145 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

◆ preflight()

◆ preclaim()

◆ doApply()

◆ operator()()

◆ view() [1/2]

◆ view() [2/2]

◆ checkSeqProxy()

◆ checkPriorTxAndLastLedger()

◆ checkFee()

◆ checkSign()

◆ checkBatchSign()

◆ calculateBaseFee()

◆ checkPermission()

◆ ticketDelete()

◆ apply()

◆ preCompute()

◆ minimumFee()

◆ reset()

◆ consumeSeqProxy()

◆ payFee()

◆ checkSingleSign()

◆ checkMultiSign()

◆ trapTransaction()

Member Data Documentation

◆ ConsequencesFactory

◆ ctx_

◆ j_

◆ account_

◆ mPriorBalance

◆ mSourceBalance