Enum casper_execution_engine::core::engine_state::execution_result::ExecutionResult

pub enum ExecutionResult {
    Failure {
        error: Error,
        transfers: Vec<TransferAddr>,
        cost: Gas,
        execution_journal: ExecutionJournal,
    },
    Success {
        transfers: Vec<TransferAddr>,
        cost: Gas,
        execution_journal: ExecutionJournal,
    },
}

Represents the result of an execution specified by crate::core::engine_state::ExecuteRequest.

Variants

Failure

Fields

error: Error

Error causing this Failure variant.

transfers: Vec<TransferAddr>

List of transfers that happened during execution up to the point of the failure.

cost: Gas

Gas consumed up to the point of the failure.

execution_journal: ExecutionJournal

Journal of execution.

An error condition that happened during execution

Success

Fields

transfers: Vec<TransferAddr>

List of transfers.

cost: Gas

Gas cost.

execution_journal: ExecutionJournal

Journal of execution.

Execution was finished successfully

Implementations

impl ExecutionResult

pub fn precondition_failure(error: Error) -> ExecutionResult

Constructs ExecutionResult::Failure that has 0 cost and no effects. This is the case for failures that we can’t (or don’t want to) charge for, like PreprocessingError or InvalidNonce.

pub fn is_success(&self) -> bool

Returns true if this is a successful variant.

pub fn is_failure(&self) -> bool

Returns true if this is a failure variant.

pub fn has_precondition_failure(&self) -> bool

Returns true if this is a precondition failure.

Precondition variant is further described as an execution failure which does not have any effects, and has a gas cost of 0.

pub fn cost(&self) -> Gas

Returns gas cost of execution regardless of variant.

pub fn transfers(&self) -> &Vec<TransferAddr>

Returns list of transfers regardless of variant.

pub fn execution_journal(&self) -> &ExecutionJournal

The journal of transforms regardless of variant.

pub fn with_cost(self, cost: Gas) -> Self

Returns a new execution result with updated gas cost.

This method preserves the ExecutionResult variant and updates the cost field only.

pub fn with_transfers(self, transfers: Vec<TransferAddr>) -> Self

Returns a new execution result with updated transfers field.

This method preserves the ExecutionResult variant and updates the transfers field only.

pub fn with_journal(self, execution_journal: ExecutionJournal) -> Self

Returns a new execution result with an updated execution journal.

This method preserves the ExecutionResult variant and updates the execution_journal field only.

pub fn as_error(&self) -> Option<&Error>

Returns error value, if possible.

Returns a reference to a wrapped error::Error instance if the object is a failure variant.

pub fn take_error(self) -> Option<Error>

Consumes ExecutionResult instance and optionally returns error::Error instance for ExecutionResult::Failure variant.

pub fn check_forced_transfer( &self, payment_purse_balance: Motes, gas_price: u64 ) -> Option<ForcedTransferResult>

Checks the transfer status of a payment code.

This method converts the gas cost of the execution result into motes using supplied gas_price, and then a check is made to ensure that user deposited enough funds in the payment purse (in motes) to cover the execution of a payment code.

Returns None if user deposited enough funds in payment purse and the execution result was a success variant, otherwise a wrapped ForcedTransferResult that indicates an error condition.

pub fn new_payment_code_error( error: Error, max_payment_cost: Motes, account_main_purse_balance: Motes, gas_cost: Gas, account_main_purse_balance_key: Key, proposer_main_purse_balance_key: Key ) -> Result<ExecutionResult, Error>

Creates a new payment code error.

The method below creates an ExecutionResult with precomputed effects of a “finalize_payment”.

The effects that are produced as part of this process would subract max_payment_cost from account’s main purse, and add max_payment_cost to proposer account’s balance.

Trait Implementations

impl Clone for ExecutionResult

fn clone(&self) -> ExecutionResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecutionResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExecutionResult

fn default() -> Self

Returns the “default value” for a type.

impl From<&ExecutionResult> for ExecutionResult

fn from(ee_execution_result: &ExecutionResult) -> Self

Converts to this type from the input type.

impl From<ExecutionResult> for ExecutionResult

fn from(ee_execution_result: ExecutionResult) -> Self

Converts to this type from the input type.