sui_verifier_latest/
verifier.rs

1// Copyright (c) Mysten Labs, Inc.
2// SPDX-License-Identifier: Apache-2.0
3
4//! This module contains the public APIs supported by the bytecode verifier.
5
6use move_binary_format::file_format::CompiledModule;
7use move_vm_config::verifier::VerifierConfig;
8use sui_types::{error::ExecutionError, move_package::FnInfoMap};
9
10use crate::{
11    entry_points_verifier, global_storage_access_verifier, id_leak_verifier,
12    one_time_witness_verifier, private_generics, private_generics_verifier_v2,
13    struct_with_key_verifier,
14};
15use move_bytecode_verifier_meter::Meter;
16use move_bytecode_verifier_meter::dummy::DummyMeter;
17
18/// Helper for a "canonical" verification of a module.
19pub fn sui_verify_module_metered(
20    module: &CompiledModule,
21    fn_info_map: &FnInfoMap,
22    meter: &mut (impl Meter + ?Sized),
23    verifier_config: &VerifierConfig,
24) -> Result<(), ExecutionError> {
25    struct_with_key_verifier::verify_module(module)?;
26    global_storage_access_verifier::verify_module(module)?;
27    id_leak_verifier::verify_module(module, meter)?;
28    if verifier_config.private_generics_verifier_v2 {
29        private_generics_verifier_v2::verify_module(module, verifier_config)?;
30    } else {
31        private_generics::verify_module(module, verifier_config)?;
32    }
33    entry_points_verifier::verify_module(module, fn_info_map, verifier_config)?;
34    one_time_witness_verifier::verify_module(module, fn_info_map)
35}
36
37/// Runs the Sui verifier and checks if the error counts as a Sui verifier timeout
38/// NOTE: this function only check if the verifier error is a timeout
39/// All other errors are ignored
40pub fn sui_verify_module_metered_check_timeout_only(
41    module: &CompiledModule,
42    fn_info_map: &FnInfoMap,
43    meter: &mut (impl Meter + ?Sized),
44    verifier_config: &VerifierConfig,
45) -> Result<(), ExecutionError> {
46    // Checks if the error counts as a Sui verifier timeout
47    if let Err(error) = sui_verify_module_metered(module, fn_info_map, meter, verifier_config)
48        && matches!(
49            error.kind(),
50            sui_types::execution_status::ExecutionFailureStatus::SuiMoveVerificationTimedout
51        )
52    {
53        return Err(error);
54    }
55    // Any other scenario, including a non-timeout error counts as Ok
56    Ok(())
57}
58
59pub fn sui_verify_module_unmetered(
60    module: &CompiledModule,
61    fn_info_map: &FnInfoMap,
62    verifier_config: &VerifierConfig,
63) -> Result<(), ExecutionError> {
64    sui_verify_module_metered(module, fn_info_map, &mut DummyMeter, verifier_config).inspect_err(
65        |err| {
66            // We must never see timeout error in execution
67            debug_assert!(
68                !matches!(
69                err.kind(),
70                sui_types::execution_status::ExecutionFailureStatus::SuiMoveVerificationTimedout
71            ),
72                "Unexpected timeout error in execution"
73            );
74        },
75    )
76}
sui_verifier_latest/verifier.rs

sui_verifier_latest/
verifier.rs
