sui_types/gas_model/
gas_predicates.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright (c) 2021, Facebook, Inc. and its affiliates
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

//
// Predicates and utility functions based on gas versions.
//

use crate::gas_model::tables::{
    initial_cost_schedule_v1, initial_cost_schedule_v2, initial_cost_schedule_v3,
    initial_cost_schedule_v4, initial_cost_schedule_v5,
};
use crate::gas_model::units_types::CostTable;
use sui_protocol_config::ProtocolConfig;

// Threshold after which native functions contribute to virtual instruction count.
const V2_NATIVE_FUNCTION_CALL_THRESHOLD: u64 = 700;

/// If true, do not charge the entire budget on storage OOG
pub fn dont_charge_budget_on_storage_oog(gas_model_version: u64) -> bool {
    gas_model_version >= 4
}

/// If true, enable the check for gas price too high
pub fn gas_price_too_high(gas_model_version: u64) -> bool {
    gas_model_version >= 4
}

/// If true, input object bytes are treated as memory allocated in Move and
/// charged according to the bucket they end up in.
pub fn charge_input_as_memory(gas_model_version: u64) -> bool {
    gas_model_version == 4
}

/// If true, calculate value sizes using the legacy size calculation.
pub fn use_legacy_abstract_size(gas_model_version: u64) -> bool {
    gas_model_version <= 7
}

// If true, use the value of txn_base_cost as a multiplier of transaction gas price
// to determine the minimum cost of a transaction.
pub fn txn_base_cost_as_multiplier(protocol_config: &ProtocolConfig) -> bool {
    protocol_config.txn_base_cost_as_multiplier()
}

// If true, charge differently for package upgrades
pub fn charge_upgrades(gas_model_version: u64) -> bool {
    gas_model_version >= 7
}

// Return the version supported cost table
pub fn cost_table_for_version(gas_model: u64) -> CostTable {
    if gas_model <= 3 {
        initial_cost_schedule_v1()
    } else if gas_model == 4 {
        initial_cost_schedule_v2()
    } else if gas_model == 5 {
        initial_cost_schedule_v3()
    } else if gas_model <= 7 {
        initial_cost_schedule_v4()
    } else {
        initial_cost_schedule_v5()
    }
}

// Return if the native function call threshold is exceeded
pub fn native_function_threshold_exceeded(gas_model_version: u64, num_native_calls: u64) -> bool {
    if gas_model_version > 8 {
        num_native_calls > V2_NATIVE_FUNCTION_CALL_THRESHOLD
    } else {
        false
    }
}