Struct ScriptEvaluationError 

pub struct ScriptEvaluationError {
    pub message: String,
    pub source_txid: String,
    pub source_output_index: u32,
    pub context: ExecutionContext,
    pub program_counter: usize,
    pub stack: Vec<Vec<u8>>,
    pub alt_stack: Vec<Vec<u8>>,
    pub if_stack: Vec<bool>,
    pub stack_mem: usize,
    pub alt_stack_mem: usize,
    pub resource_limit: Option<ScriptResourceLimit>,
}

Fields

message: String

The error message describing what went wrong.

source_txid: String

The TXID of the source UTXO being spent (hex, display order).

source_output_index: u32

The output index of the source UTXO.

context: ExecutionContext

Whether the error occurred in the unlocking or locking script.

program_counter: usize

The program counter (chunk index) when the error occurred.

stack: Vec<Vec<u8>>

The state of the main stack at the time of failure.

alt_stack: Vec<Vec<u8>>

The state of the alt stack at the time of failure.

if_stack: Vec<bool>

The state of the if/else condition stack.

stack_mem: usize

Memory usage of the main stack in bytes.

alt_stack_mem: usize

Memory usage of the alt stack in bytes.

resource_limit: Option<ScriptResourceLimit>

Some when the evaluation stopped because a LOCAL resource budget was exhausted (the TypeScript SDK throws a distinct ScriptResourceLimitError for these); None for every verdict about the script itself. Added in 0.3.23 (reference parity).

Implementations

impl ScriptEvaluationError

pub fn new( message: impl Into<String>, source_txid: impl Into<String>, source_output_index: u32, context: ExecutionContext, program_counter: usize, stack: Vec<Vec<u8>>, alt_stack: Vec<Vec<u8>>, if_stack: Vec<bool>, stack_mem: usize, alt_stack_mem: usize, ) -> Self

Creates a new script evaluation error with the given context.

pub fn with_resource_limit(self, limit: ScriptResourceLimit) -> Self

Mark this error as a LOCAL resource exhaustion (the reference’s ScriptResourceLimitError): the evaluator’s budget, not the script’s validity.

pub fn is_resource_limit(&self) -> bool

Whether the evaluation stopped on a LOCAL resource budget (see ScriptEvaluationError::resource_limit) rather than on the script.

Trait Implementations

impl Clone for ScriptEvaluationError

fn clone(&self) -> ScriptEvaluationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptEvaluationError

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

Formats the value using the given formatter.

impl Display for ScriptEvaluationError

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

Formats the value using the given formatter.

impl Error for ScriptEvaluationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.