Transactor specialized for creating offers in the ledger. More...

#include <CreateOffer.h>

Inheritance diagram for xrpl::CreateOffer:

Collaboration diagram for xrpl::CreateOffer:

[legend]

Public Types
enum	ConsequencesFactoryType { Normal , Blocker , Custom }

Public Member Functions
	CreateOffer (ApplyContext &ctx)
	Construct a Transactor subclass that creates an offer in the ledger.

TER	doApply () override
	Precondition: fee collection is likely.

ApplyResult	operator() ()
	Process the transaction.

ApplyView &	view ()

ApplyView const &	view () const

Static Public Member Functions
static TxConsequences	makeTxConsequences (PreflightContext const &ctx)

static bool	checkExtraFeatures (PreflightContext const &ctx)

static std::uint32_t	getFlagsMask (PreflightContext const &ctx)

static NotTEC	preflight (PreflightContext const &ctx)
	Enforce constraints beyond those of the Transactor base class.

static TER	preclaim (PreclaimContext const &ctx)
	Enforce constraints beyond those of the Transactor base class.

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)

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 {Custom}

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 (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 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	account_

XRPAmount	mPriorBalance

XRPAmount	mSourceBalance

Private Member Functions
std::pair< TER, bool >	applyGuts (Sandbox &view, Sandbox &view_cancel)

std::pair< TER, Amounts >	flowCross (PaymentSandbox &psb, PaymentSandbox &psbCancel, Amounts const &takerAmount, std::optional< uint256 > const &domainID)

TER	applyHybrid (Sandbox &sb, std::shared_ptr< STLedgerEntry > sleOffer, Keylet const &offer_index, STAmount const &saTakerPays, STAmount const &saTakerGets, std::function< void(SLE::ref, std::optional< uint256 >)> const &setDir)

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 TER	checkAcceptAsset (ReadView const &view, ApplyFlags const flags, AccountID const id, beast::Journal const j, Issue const &issue)

static std::string	format_amount (STAmount const &amount)

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

Transactor specialized for creating offers in the ledger.

Definition at line 13 of file CreateOffer.h.

Member Enumeration Documentation

◆ ConsequencesFactoryType

enum xrpl::Transactor::ConsequencesFactoryType

inherited

Enumerator
Normal
Blocker
Custom

Definition at line 122 of file Transactor.h.

Constructor & Destructor Documentation

◆ CreateOffer()

xrpl::CreateOffer::CreateOffer ( ApplyContext & ctx )

explicit

Construct a Transactor subclass that creates an offer in the ledger.

Definition at line 19 of file CreateOffer.h.

Member Function Documentation

◆ makeTxConsequences()

TxConsequences xrpl::CreateOffer::makeTxConsequences ( PreflightContext const & ctx )

static

Definition at line 17 of file CreateOffer.cpp.

◆ checkExtraFeatures()

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

static

Definition at line 28 of file CreateOffer.cpp.

◆ getFlagsMask()

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

static

Definition at line 37 of file CreateOffer.cpp.

◆ preflight()

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

static

Enforce constraints beyond those of the Transactor base class.

Definition at line 49 of file CreateOffer.cpp.

◆ preclaim()

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

static

Enforce constraints beyond those of the Transactor base class.

Definition at line 127 of file CreateOffer.cpp.

◆ doApply()

TER xrpl::CreateOffer::doApply ( )

overridevirtual

Precondition: fee collection is likely.

Attempt to create the offer.

Implements xrpl::Transactor.

Definition at line 836 of file CreateOffer.cpp.

◆ applyGuts()

std::pair< TER, bool > xrpl::CreateOffer::applyGuts	(	Sandbox &	view,
		Sandbox &	view_cancel
	)

private

Definition at line 499 of file CreateOffer.cpp.

◆ checkAcceptAsset()

TER xrpl::CreateOffer::checkAcceptAsset	(	ReadView const &	view,
		ApplyFlags const	flags,
		AccountID const	id,
		beast::Journal const	j,
		Issue const &	issue
	)

staticprivate

Definition at line 196 of file CreateOffer.cpp.

◆ flowCross()

std::pair< TER, Amounts > xrpl::CreateOffer::flowCross	(	PaymentSandbox &	psb,
		PaymentSandbox &	psbCancel,
		Amounts const &	takerAmount,
		std::optional< uint256 > const &	domainID
	)

private

Definition at line 271 of file CreateOffer.cpp.

◆ format_amount()

std::string xrpl::CreateOffer::format_amount ( STAmount const & amount )

staticprivate

Definition at line 444 of file CreateOffer.cpp.

◆ applyHybrid()

TER xrpl::CreateOffer::applyHybrid	(	Sandbox &	sb,
		std::shared_ptr< STLedgerEntry >	sleOffer,
		Keylet const &	offer_index,
		STAmount const &	saTakerPays,
		STAmount const &	saTakerGets,
		std::function< void(SLE::ref, std::optional< uint256 >)> const &	setDir
	)

private

Definition at line 453 of file CreateOffer.cpp.

◆ operator()()

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

inherited

Process the transaction.

Definition at line 1042 of file Transactor.cpp.

◆ view() [1/2]

ApplyView & xrpl::Transactor::view ( )

inherited

Definition at line 128 of file Transactor.h.

◆ view() [2/2]

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

inherited

Definition at line 134 of file Transactor.h.

◆ checkSeqProxy()

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

staticinherited

Definition at line 406 of file Transactor.cpp.

◆ checkPriorTxAndLastLedger()

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

staticinherited

Definition at line 470 of file Transactor.cpp.

◆ checkFee()

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

staticinherited

Definition at line 312 of file Transactor.cpp.

◆ checkSign() [1/2]

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

staticinherited

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

◆ checkBatchSign()

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

staticinherited

Definition at line 683 of file Transactor.cpp.

◆ calculateBaseFee()

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

staticinherited

Definition at line 268 of file Transactor.cpp.

◆ invokePreflight() [1/3]

template<class T >

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

staticinherited

Definition at line 364 of file Transactor.h.

◆ invokePreflight() [2/3]

template<>

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

staticinherited

Definition at line 18 of file Change.cpp.

◆ invokePreflight() [3/3]

template<>

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

staticinherited

◆ checkPermission()

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

staticinherited

Definition at line 252 of file Transactor.cpp.

◆ ticketDelete()

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

staticinherited

Definition at line 513 of file Transactor.cpp.

◆ apply()

TER xrpl::Transactor::apply ( )

protectedinherited

Definition at line 577 of file Transactor.cpp.

◆ preCompute()

void xrpl::Transactor::preCompute ( )

protectedvirtualinherited

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

Definition at line 571 of file Transactor.cpp.

◆ minimumFee()

XRPAmount xrpl::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: xrpl::calculateBaseFee

Parameters

fees	Fee settings from the current ledger
flags	Transaction processing fees

Definition at line 306 of file Transactor.cpp.

◆ calculateOwnerReserveFee()

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

staticprotectedinherited

Definition at line 286 of file Transactor.cpp.

◆ preflightSigValidated()

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

staticprotectedinherited

Definition at line 246 of file Transactor.cpp.

◆ validDataLength()

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

staticprotectedinherited

Definition at line 232 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 390 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 399 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 406 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 415 of file Transactor.h.

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

◆ consumeSeqProxy()

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

privateinherited

Definition at line 496 of file Transactor.cpp.

◆ payFee()

TER xrpl::Transactor::payFee ( )

privateinherited

Definition at line 372 of file Transactor.cpp.

◆ checkSingleSign()

NotTEC xrpl::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 725 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 757 of file Transactor.cpp.

◆ trapTransaction()

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

privateinherited

Definition at line 1035 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 135 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 188 of file Transactor.cpp.

Member Data Documentation

◆ ConsequencesFactory

constexpr ConsequencesFactoryType xrpl::CreateOffer::ConsequencesFactory {Custom}

staticconstexpr

Definition at line 16 of file CreateOffer.h.

◆ ctx_

ApplyContext& xrpl::Transactor::ctx_

protectedinherited

Definition at line 108 of file Transactor.h.

◆ sink_

beast::WrappedSink xrpl::Transactor::sink_

protectedinherited

Definition at line 109 of file Transactor.h.

◆ j_

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

protectedinherited

Definition at line 110 of file Transactor.h.

◆ account_

AccountID const xrpl::Transactor::account_

protectedinherited

Definition at line 112 of file Transactor.h.

◆ mPriorBalance

XRPAmount xrpl::Transactor::mPriorBalance

protectedinherited

Definition at line 113 of file Transactor.h.

◆ mSourceBalance

XRPAmount xrpl::Transactor::mSourceBalance

protectedinherited

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

◆ CreateOffer()

Member Function Documentation

◆ makeTxConsequences()

◆ checkExtraFeatures()

◆ getFlagsMask()

◆ preflight()

◆ preclaim()

◆ doApply()

◆ applyGuts()

◆ checkAcceptAsset()

◆ flowCross()

◆ format_amount()

◆ applyHybrid()

◆ operator()()

◆ view() [1/2]

◆ view() [2/2]

◆ checkSeqProxy()

◆ checkPriorTxAndLastLedger()

◆ checkFee()

◆ checkSign() [1/2]

◆ checkSign() [2/2]

◆ checkBatchSign()

◆ calculateBaseFee()

◆ invokePreflight() [1/3]

◆ invokePreflight() [2/3]

◆ invokePreflight() [3/3]

◆ checkPermission()

◆ ticketDelete()

◆ apply()

◆ preCompute()

◆ minimumFee()

◆ calculateOwnerReserveFee()

◆ preflightSigValidated()

◆ validDataLength()

◆ validNumericRange() [1/2]

◆ validNumericRange() [2/2]

◆ validNumericMinimum() [1/2]

◆ validNumericMinimum() [2/2]

◆ reset()

◆ consumeSeqProxy()

◆ payFee()

◆ checkSingleSign()

◆ checkMultiSign()

◆ trapTransaction()

◆ preflight1()

◆ preflight2()

Member Data Documentation

◆ ConsequencesFactory

◆ ctx_

◆ sink_

◆ j_

◆ account_

◆ mPriorBalance

◆ mSourceBalance