Struct ckb_script::TransactionScriptsVerifier

pub struct TransactionScriptsVerifier<'a, DL> { /* private fields */ }

This struct leverages CKB VM to verify transaction inputs.

FlatBufferBuilder owned Vec<u8> that grows as needed, in the future, we might refactor this to share buffer to achieve zero-copy

Implementations

impl<'a, DL: CellDataProvider + HeaderProvider> TransactionScriptsVerifier<'a, DL>

pub fn new(
    rtx: &'a ResolvedTransaction,
    data_loader: &'a DL
) -> TransactionScriptsVerifier<'a, DL>

Creates a script verifier for the transaction.

Params

• rtx - transaction which cell out points have been resolved.
• data_loader - used to load cell data.

pub fn set_debug_printer<F: Fn(&Byte32, &str) + 'static>(&mut self, func: F)

Sets a callback to handle the debug syscall.

Script can print a message using the debug syscall.

The callback receives two parameters:

• hash: &Byte32: this is the script hash of currently running script group.
• message: &str: message passed to the debug syscall.

pub fn extract_script(&self, script: &'a Script) -> Result<Bytes, ScriptError>

Extracts actual script binary either in dep cells.

pub fn select_version(
    &self,
    script: &'a Script
) -> Result<ScriptVersion, ScriptError>

Returns the version of the machine based on the script and the consensus rules.

pub fn verify(&self, max_cycles: Cycle) -> Result<Cycle, Error>

Verifies the transaction by running scripts.

Params

• max_cycles - Maximum allowed cycles to run the scripts. The verification quits early when the consumed cycles exceed the limit.

Returns

It returns the total consumed cycles on success, Otherwise it returns the verification error.

pub fn resumable_verify(
    &self,
    limit_cycles: Cycle
) -> Result<VerifyResult<'_>, Error>

Performing a resumable verification on the transaction scripts.

Params

• limit_cycles - Maximum allowed cycles to run the scripts. The verification quits early when the consumed cycles exceed the limit.

Returns

It returns the total consumed cycles if verification completed, If verify is suspended, a state will returned.

pub fn resume_from_snap(
    &self,
    snap: &TransactionSnapshot,
    limit_cycles: Cycle
) -> Result<VerifyResult<'_>, Error>

Resuming an suspended verify from snapshot

Params

• snap - Captured transaction verification snapshot.

• limit_cycles - Maximum allowed cycles to run the scripts. The verification quits early when the consumed cycles exceed the limit.

Returns

It returns the total consumed cycles if verification completed, If verify is suspended, a borrowed state will returned.

pub fn resume_from_state(
    &'a self,
    state: TransactionState<'a>,
    limit_cycles: Cycle
) -> Result<VerifyResult<'a>, Error>

Resuming an suspended verify from vm state

Params

• state - vm state.

• limit_cycles - Maximum allowed cycles to run the scripts. The verification quits early when the consumed cycles exceed the limit.

Returns

It returns the total consumed cycles if verification completed, If verify is suspended, a borrowed state will returned.

pub fn complete(
    &self,
    snap: &TransactionSnapshot,
    max_cycles: Cycle
) -> Result<Cycle, Error>

Complete an suspended verify

Params

• snap - Captured transaction verification snapshot.

• max_cycles - Maximum allowed cycles to run the scripts. The verification quits early when the consumed cycles exceed the limit.

Returns

It returns the total consumed cycles on completed, Otherwise it returns the verification error.

pub fn verify_single(
    &self,
    script_group_type: ScriptGroupType,
    script_hash: &Byte32,
    max_cycles: Cycle
) -> Result<Cycle, ScriptError>

Runs a single script in current transaction, while this is not useful for CKB itself, it can be very helpful when building a CKB debugger.

pub fn groups(&self) -> impl Iterator<Item = (&Byte32, &ScriptGroup)>

Returns all script groups.

pub fn groups_with_type(
    &self
) -> impl Iterator<Item = (ScriptGroupType, &Byte32, &ScriptGroup)>

Returns all script groups with type.

pub fn find_script_group(
    &self,
    script_group_type: ScriptGroupType,
    script_hash: &Byte32
) -> Option<&ScriptGroup>

Finds the script group from cell deps.

pub fn generate_syscalls(
    &'a self,
    script_version: ScriptVersion,
    script_group: &'a ScriptGroup
) -> Vec<Box<dyn Syscalls<CoreMachine> + 'a>>

Prepares syscalls.