Struct TransactionScriptsVerifier

pub struct TransactionScriptsVerifier<DL: CellDataProvider, V = DebugPrinter, M: DefaultMachineRunner = Machine> { /* private fields */ }

This struct leverages CKB VM to verify transaction inputs.

Implementations

impl<DL> TransactionScriptsVerifier<DL>

where DL: CellDataProvider + HeaderProvider + ExtensionProvider + Send + Sync + Clone + 'static,

pub fn new( rtx: Arc<ResolvedTransaction>, data_loader: DL, consensus: Arc<Consensus>, tx_env: Arc<TxVerifyEnv>, ) -> Self

Create a script verifier using default CKB syscalls and a default debug printer

pub fn new_with_debug_printer( rtx: Arc<ResolvedTransaction>, data_loader: DL, consensus: Arc<Consensus>, tx_env: Arc<TxVerifyEnv>, debug_printer: DebugPrinter, ) -> Self

Create a script verifier using default CKB syscalls and a custom debug printer

impl<DL, V, M> TransactionScriptsVerifier<DL, V, M>

where DL: CellDataProvider + HeaderProvider + ExtensionProvider + Clone, V: Clone, M: DefaultMachineRunner,

pub fn new_with_generator( rtx: Arc<ResolvedTransaction>, data_loader: DL, consensus: Arc<Consensus>, tx_env: Arc<TxVerifyEnv>, syscall_generator: SyscallGenerator<DL, V, <M as DefaultMachineRunner>::Inner>, syscall_context: V, ) -> TransactionScriptsVerifier<DL, V, M>

Creates a script verifier for the transaction.

Params

• rtx - transaction which cell out points have been resolved.
• data_loader - used to load cell data.
• consensus - consensus parameters.
• tx_env - enviroment for verifying transaction, such as committed block, etc.
• syscall_generator - a syscall generator for current verifier
• syscall_context - context for syscall generator

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

Extracts actual script binary either in dep cells.

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

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

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 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_state( &self, state: &TransactionState, limit_cycles: Cycle, ) -> Result<VerifyResult, 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: &TransactionState, max_cycles: Cycle, ) -> Result<Cycle, Error>

Complete an suspended verify

Params

• snap - Captured transaction verification state.

• 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 create_scheduler( &self, script_group: &ScriptGroup, ) -> Result<Scheduler<DL, V, M>, ScriptError>

Create a scheduler to manage virtual machine instances.

pub fn resume_scheduler( &self, script_group: &ScriptGroup, state: &FullSuspendedState, ) -> Result<Scheduler<DL, V, M>, ScriptError>

Resumes a scheduler from a previous state.

pub fn detailed_run( &self, script_group: &ScriptGroup, max_cycles: Cycle, ) -> Result<TerminatedResult, ScriptError>

Runs a single program, then returns the exit code together with the entire machine to the caller for more inspections.

impl<DL, V, M> TransactionScriptsVerifier<DL, V, M>

where DL: CellDataProvider + HeaderProvider + ExtensionProvider + Send + Sync + Clone + 'static, V: Send + Clone + 'static, M: DefaultMachineRunner + Send + 'static,

pub async fn resumable_verify_with_signal( &self, limit_cycles: Cycle, command_rx: &mut Receiver<ChunkCommand>, ) -> Result<Cycle, Error>

Performing a resumable verification on the transaction scripts with signal channel, if Suspend comes from command_rx, the process will be hang up until Resume comes, otherwise, it will return until the verification is completed.