#include <evaluator.hpp>

Inheritance diagram for graphene::chain::generic_evaluator:

Public Member Functions
virtual	~generic_evaluator ()

virtual int	get_type () const =0

virtual operation_result	start_evaluate (transaction_evaluation_state &eval_state, const operation &op, bool apply)

virtual operation_result	evaluate (const operation &op)=0

virtual operation_result	apply (const operation &op)=0

virtual void	pay_fee ()

database &	db () const

Protected Member Functions
void	prepare_fee (account_id_type account_id, asset fee)
	Fetch objects relevant to fee payer and set pointer members. More...

virtual void	convert_fee ()

object_id_type	get_relative_id (object_id_type rel_id) const

void	pay_fba_fee (uint64_t fba_id)

share_type	calculate_fee_for_operation (const operation &op) const

void	db_adjust_balance (const account_id_type &fee_payer, asset fee_from_account)

Protected Attributes
asset	fee_from_account

share_type	core_fee_paid

const account_object *	fee_paying_account = nullptr

const account_statistics_object *	fee_paying_account_statistics = nullptr

const asset_object *	fee_asset = nullptr

const asset_dynamic_data_object *	fee_asset_dyn_data = nullptr

transaction_evaluation_state *	trx_state

Detailed Description

Definition at line 39 of file evaluator.hpp.

Constructor & Destructor Documentation

◆ ~generic_evaluator()

virtual graphene::chain::generic_evaluator::~generic_evaluator ( )

inlinevirtual

Definition at line 42 of file evaluator.hpp.

Member Function Documentation

◆ apply()

virtual operation_result graphene::chain::generic_evaluator::apply ( const operation & op )

pure virtual

◆ calculate_fee_for_operation()

share_type graphene::chain::generic_evaluator::calculate_fee_for_operation ( const operation & op ) const

protected

Definition at line 115 of file evaluator.cpp.

◆ convert_fee()

void graphene::chain::generic_evaluator::convert_fee ( )

protectedvirtual

Convert the fee into BTS through the exchange pool.

Reads core_fee_paid field for how much CORE is deducted from the exchange pool, and fee_from_account for how much USD is added to the pool.

Since prepare_fee() does the validation checks ensuring the account and fee pool have sufficient balance and the exchange rate is correct, those validation checks are not replicated here.

Rather than returning a value, this method fills in core_fee_paid field.

Reimplemented in graphene::chain::limit_order_update_evaluator, and graphene::chain::limit_order_create_evaluator.

Definition at line 80 of file evaluator.cpp.

◆ db()

database & graphene::chain::generic_evaluator::db ( ) const

Definition at line 39 of file evaluator.cpp.

◆ db_adjust_balance()

void graphene::chain::generic_evaluator::db_adjust_balance	(	const account_id_type &	fee_payer,
		asset	fee_from_account
	)

protected

Definition at line 119 of file evaluator.cpp.

◆ evaluate()

virtual operation_result graphene::chain::generic_evaluator::evaluate ( const operation & op )

pure virtual

Note: derived classes should ASSUME that the default validation that is indepenent of chain state should be performed by op.validate() and should not perform these extra checks.

◆ get_relative_id()

object_id_type graphene::chain::generic_evaluator::get_relative_id ( object_id_type rel_id ) const

protected

◆ get_type()

virtual int graphene::chain::generic_evaluator::get_type ( ) const

pure virtual

Implemented in graphene::chain::evaluator< DerivedEvaluator >.

◆ pay_fba_fee()

void graphene::chain::generic_evaluator::pay_fba_fee ( uint64_t fba_id )

protected

pay_fee() for FBA subclass should simply call this method

Definition at line 100 of file evaluator.cpp.

◆ pay_fee()

void graphene::chain::generic_evaluator::pay_fee ( )

virtual

Routes the fee to where it needs to go. The default implementation routes the fee to the account_statistics_object of the fee_paying_account.

Before pay_fee() is called, the fee is computed by prepare_fee() and has been moved out of the fee_paying_account and (if paid in a non-CORE asset) converted by the asset's fee pool.

Therefore, when pay_fee() is called, the fee only exists in this->core_fee_paid. So pay_fee() need only increment the receiving balance.

The default implementation simply calls account_statistics_object->pay_fee() to increment pending_fees or pending_vested_fees.

Reimplemented in graphene::chain::limit_order_update_evaluator, graphene::chain::blind_transfer_evaluator, graphene::chain::limit_order_create_evaluator, graphene::chain::transfer_from_blind_evaluator, graphene::chain::asset_create_evaluator, and graphene::chain::transfer_to_blind_evaluator.

Definition at line 91 of file evaluator.cpp.

◆ prepare_fee()

void graphene::chain::generic_evaluator::prepare_fee	(	account_id_type	account_id,
		asset	fee
	)

protected

Fetch objects relevant to fee payer and set pointer members.

Parameters

account_id	Account which is paying the fee
fee	The fee being paid. May be in assets other than core.

This method verifies that the fee is valid and sets the object pointer members and the fee fields. It should be called during do_evaluate.

In particular, core_fee_paid field is set by prepare_fee().

Definition at line 51 of file evaluator.cpp.

◆ start_evaluate()

operation_result graphene::chain::generic_evaluator::start_evaluate	(	transaction_evaluation_state &	eval_state,
		const operation &	op,
		bool	apply
	)

virtual

Definition at line 41 of file evaluator.cpp.

Member Data Documentation

◆ core_fee_paid

share_type graphene::chain::generic_evaluator::core_fee_paid

protected

Definition at line 115 of file evaluator.hpp.

◆ fee_asset

const asset_object* graphene::chain::generic_evaluator::fee_asset = nullptr

protected

Definition at line 118 of file evaluator.hpp.

◆ fee_asset_dyn_data

const asset_dynamic_data_object* graphene::chain::generic_evaluator::fee_asset_dyn_data = nullptr

protected

Definition at line 119 of file evaluator.hpp.

◆ fee_from_account

asset graphene::chain::generic_evaluator::fee_from_account

protected

Definition at line 114 of file evaluator.hpp.

◆ fee_paying_account

const account_object* graphene::chain::generic_evaluator::fee_paying_account = nullptr

protected

Definition at line 116 of file evaluator.hpp.

◆ fee_paying_account_statistics

const account_statistics_object* graphene::chain::generic_evaluator::fee_paying_account_statistics = nullptr

protected

Definition at line 117 of file evaluator.hpp.

◆ trx_state

transaction_evaluation_state* graphene::chain::generic_evaluator::trx_state

protected

Definition at line 120 of file evaluator.hpp.

The documentation for this class was generated from the following files:

libraries/chain/include/graphene/chain/evaluator.hpp
libraries/chain/evaluator.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~generic_evaluator()

Member Function Documentation

◆ apply()

◆ calculate_fee_for_operation()

◆ convert_fee()

◆ db()

◆ db_adjust_balance()

◆ evaluate()

◆ get_relative_id()

◆ get_type()

◆ pay_fba_fee()

◆ pay_fee()

◆ prepare_fee()

◆ start_evaluate()

Member Data Documentation

◆ core_fee_paid

◆ fee_asset

◆ fee_asset_dyn_data

◆ fee_from_account

◆ fee_paying_account

◆ fee_paying_account_statistics

◆ trx_state