AMMCreate implements Automatic Market Maker(AMM) creation Transactor. More...

#include <AMMCreate.h>

Inheritance diagram for ripple::AMMCreate:

Collaboration diagram for ripple::AMMCreate:

[legend]

Public Types
enum	ConsequencesFactoryType { Normal , Blocker , Custom }

Public Member Functions
	AMMCreate (ApplyContext &ctx)

TER	doApply () override
	Attempt to create the AMM instance.

ApplyResult	operator() ()
	Process the transaction.

ApplyView &	view ()

ApplyView const &	view () const

Static Public Member Functions
static bool	checkExtraFeatures (PreflightContext const &ctx)

static NotTEC	preflight (PreflightContext const &ctx)

static XRPAmount	calculateBaseFee (ReadView const &view, STTx const &tx)

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)

template<class T >
static NotTEC	invokePreflight (PreflightContext const &ctx)

template<>
NotTEC	invokePreflight (PreflightContext const &ctx)

template<>
NotTEC	invokePreflight (PreflightContext const &ctx)

static NotTEC	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 NotTEC	checkSign (ReadView const &view, ApplyFlags flags, AccountID const &idAccount, STObject const &sigObject, beast::Journal const j)

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.

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={})

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

Protected Attributes
ApplyContext &	ctx_

beast::WrappedSink	sink_

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.

TER	consumeSeqProxy (SLE::pointer const &sleAccount)

TER	payFee ()

void	trapTransaction (uint256) const

Static Private Member Functions
static NotTEC	checkSingleSign (ReadView const &view, AccountID const &idSigner, AccountID const &idAccount, std::shared_ptr< SLE const > 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.

Detailed Description

AMMCreate implements Automatic Market Maker(AMM) creation Transactor.

It creates a new AMM instance with two tokens. Any trader, or Liquidity Provider (LP), can create the AMM instance and receive in return shares of the AMM pool in the form of LPTokens. The number of tokens that LP gets are determined by LPTokens = sqrt(A * B), where A and B is the current composition of the AMM pool. LP can add (AMMDeposit) or withdraw (AMMWithdraw) tokens from AMM and AMM can be used transparently in the payment or offer crossing transactions. Trading fee is charged to the traders for the trades executed against AMM instance. The fee is added to the AMM pool and distributed to the LPs in proportion to the LPTokens upon liquidity removal. The fee can be voted on by LP's (AMMVote). LP's can continuously bid (AMMBid) for the 24 hour auction slot, which enables LP's to trade at zero trading fee. AMM instance creates AccountRoot object with disabled master key for book-keeping of XRP balance if one of the tokens is XRP, a trustline for each IOU token, a trustline to keep track of LPTokens, and ltAMM ledger object. AccountRoot ID is generated internally from the parent's hash. ltAMM's object ID is hash{token1.currency, token1.issuer, token2.currency, token2.issuer}, where issue1 < issue2. ltAMM object provides mapping from the hash to AccountRoot ID and contains: AMMAccount - AMM AccountRoot ID. TradingFee - AMM voted TradingFee. VoteSlots - Array of VoteEntry, contains fee vote information. AuctionSlot - Auction slot, contains discounted fee bid information. LPTokenBalance - LPTokens outstanding balance. AMMToken - currency/issuer information for AMM tokens. AMMDeposit, AMMWithdraw, AMMVote, and AMMBid transactions use the hash to access AMM instance.

See also: XLS30d:Creating AMM instance on XRPL

Definition at line 38 of file AMMCreate.h.

Member Enumeration Documentation

◆ ConsequencesFactoryType

enum ripple::Transactor::ConsequencesFactoryType

inherited

Enumerator
Normal
Blocker
Custom

Definition at line 138 of file Transactor.h.

Constructor & Destructor Documentation

◆ AMMCreate()

ripple::AMMCreate::AMMCreate ( ApplyContext & ctx )

explicit

Definition at line 43 of file AMMCreate.h.

Member Function Documentation

◆ checkExtraFeatures()

bool ripple::AMMCreate::checkExtraFeatures ( PreflightContext const & ctx )

static

Definition at line 16 of file AMMCreate.cpp.

◆ preflight()

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

static

Definition at line 22 of file AMMCreate.cpp.

◆ calculateBaseFee()

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

static

Definition at line 56 of file AMMCreate.cpp.

◆ preclaim()

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

static

Definition at line 63 of file AMMCreate.cpp.

◆ doApply()

TER ripple::AMMCreate::doApply ( )

overridevirtual

Attempt to create the AMM instance.

Implements ripple::Transactor.

Definition at line 320 of file AMMCreate.cpp.

◆ operator()()

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

inherited

Process the transaction.

Definition at line 1105 of file Transactor.cpp.

◆ view() [1/2]

ApplyView & ripple::Transactor::view ( )

inherited

Definition at line 144 of file Transactor.h.

◆ view() [2/2]

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

inherited

Definition at line 150 of file Transactor.h.

◆ checkSeqProxy()

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

staticinherited

Definition at line 415 of file Transactor.cpp.

◆ checkPriorTxAndLastLedger()

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

staticinherited

Definition at line 486 of file Transactor.cpp.

◆ checkFee()

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

staticinherited

Definition at line 315 of file Transactor.cpp.

◆ checkSign() [1/2]

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

staticinherited

Definition at line 699 of file Transactor.cpp.

◆ checkSign() [2/2]

NotTEC ripple::Transactor::checkSign	(	ReadView const &	view,
		ApplyFlags	flags,
		AccountID const &	idAccount,
		STObject const &	sigObject,
		beast::Journal const	j
	)

staticprotectedinherited

Definition at line 642 of file Transactor.cpp.

◆ checkBatchSign()

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

staticinherited

Definition at line 708 of file Transactor.cpp.

◆ invokePreflight() [1/3]

template<class T >

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

staticinherited

Definition at line 380 of file Transactor.h.

◆ invokePreflight() [2/3]

template<>

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

staticinherited

Definition at line 18 of file Change.cpp.

◆ invokePreflight() [3/3]

template<>

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

staticinherited

◆ checkPermission()

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

staticinherited

Definition at line 250 of file Transactor.cpp.

◆ ticketDelete()

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

staticinherited

Definition at line 535 of file Transactor.cpp.

◆ apply()

TER ripple::Transactor::apply ( )

protectedinherited

Definition at line 605 of file Transactor.cpp.

◆ preCompute()

void ripple::Transactor::preCompute ( )

protectedvirtualinherited

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

Definition at line 597 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 305 of file Transactor.cpp.

◆ calculateOwnerReserveFee()

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

staticprotectedinherited

Definition at line 285 of file Transactor.cpp.

◆ getFlagsMask()

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

staticprotectedinherited

Definition at line 238 of file Transactor.cpp.

◆ preflightSigValidated()

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

staticprotectedinherited

Definition at line 244 of file Transactor.cpp.

◆ validDataLength()

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

staticprotectedinherited

Definition at line 228 of file Transactor.cpp.

◆ validNumericRange() [1/2]

template<class T >

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

staticprotectedinherited

Definition at line 407 of file Transactor.h.

◆ validNumericRange() [2/2]

template<class T , class Unit >

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

staticprotectedinherited

Definition at line 416 of file Transactor.h.

◆ 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 1043 of file Transactor.cpp.

◆ consumeSeqProxy()

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

privateinherited

Definition at line 516 of file Transactor.cpp.

◆ payFee()

TER ripple::Transactor::payFee ( )

privateinherited

Definition at line 380 of file Transactor.cpp.

◆ checkSingleSign()

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

staticprivateinherited

Definition at line 754 of file Transactor.cpp.

◆ checkMultiSign()

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

staticprivateinherited

Definition at line 786 of file Transactor.cpp.

◆ trapTransaction()

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

privateinherited

Definition at line 1098 of file Transactor.cpp.

◆ preflight1()

NotTEC ripple::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 144 of file Transactor.cpp.

◆ preflight2()

NotTEC ripple::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 199 of file Transactor.cpp.

Member Data Documentation

◆ ConsequencesFactory

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

staticconstexpr

Definition at line 41 of file AMMCreate.h.

◆ ctx_

ApplyContext& ripple::Transactor::ctx_

protectedinherited

Definition at line 124 of file Transactor.h.

◆ sink_

beast::WrappedSink ripple::Transactor::sink_

protectedinherited

Definition at line 125 of file Transactor.h.

◆ j_

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

protectedinherited

Definition at line 126 of file Transactor.h.

◆ account_

AccountID const ripple::Transactor::account_

protectedinherited

Definition at line 128 of file Transactor.h.

◆ mPriorBalance

XRPAmount ripple::Transactor::mPriorBalance

protectedinherited

Definition at line 129 of file Transactor.h.

◆ mSourceBalance

XRPAmount ripple::Transactor::mSourceBalance

protectedinherited

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

◆ AMMCreate()

Member Function Documentation

◆ checkExtraFeatures()

◆ preflight()

◆ calculateBaseFee()

◆ preclaim()

◆ doApply()

◆ operator()()

◆ view() [1/2]

◆ view() [2/2]

◆ checkSeqProxy()

◆ checkPriorTxAndLastLedger()

◆ checkFee()

◆ checkSign() [1/2]

◆ checkSign() [2/2]

◆ checkBatchSign()

◆ invokePreflight() [1/3]

◆ invokePreflight() [2/3]

◆ invokePreflight() [3/3]

◆ checkPermission()

◆ ticketDelete()

◆ apply()

◆ preCompute()

◆ minimumFee()

◆ calculateOwnerReserveFee()

◆ getFlagsMask()

◆ preflightSigValidated()

◆ validDataLength()

◆ validNumericRange() [1/2]

◆ validNumericRange() [2/2]

◆ reset()

◆ consumeSeqProxy()

◆ payFee()

◆ checkSingleSign()

◆ checkMultiSign()

◆ trapTransaction()

◆ preflight1()

◆ preflight2()

Member Data Documentation

◆ ConsequencesFactory

◆ ctx_

◆ sink_

◆ j_

◆ account_

◆ mPriorBalance

◆ mSourceBalance