Module `0x1::DiemVMConfig`

This module defines structs and methods to initialize VM configurations, including different costs of running the VM.

Struct DiemVMConfig
Struct GasSchedule
Struct GasConstants
Constants
Function initialize
Function set_gas_constants
Module Specification
- Initialization
- Access Control

<pre><code>use <a href="DiemConfig.md#0x1_DiemConfig">0x1::DiemConfig</a>; use <a href="DiemTimestamp.md#0x1_DiemTimestamp">0x1::DiemTimestamp</a>; use <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors">0x1::Errors</a>; use <a href="Roles.md#0x1_Roles">0x1::Roles</a>; </code></pre>

Struct `DiemVMConfig`

The struct to hold config data needed to operate the DiemVM.

<pre><code>struct <a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>gas_schedule: <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasSchedule">DiemVMConfig::GasSchedule</a></code> </dt> <dd> Cost of running the VM. </dd> </dl> </details>

Struct `GasSchedule`

The gas schedule keeps two separate schedules for the gas:

The instruction_schedule: This holds the gas for each bytecode instruction.
The native_schedule: This holds the gas for used (per-byte operated over) for each native function. A couple notes:

In the case that an instruction is deleted from the bytecode, that part of the cost schedule still needs to remain the same; once a slot in the table is taken by an instruction, that is its slot for the rest of time (since that instruction could already exist in a module on-chain).
The initialization of the module will publish the instruction table to the diem root account address, and will preload the vector with the gas schedule for instructions. The VM will then load this into memory at the startup of each block.

<pre><code>struct <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasSchedule">GasSchedule</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>instruction_schedule: vector<u8></code> </dt> <dd> </dd> <dt> <code>native_schedule: vector<u8></code> </dt> <dd> </dd> <dt> <code>gas_constants: <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasConstants">DiemVMConfig::GasConstants</a></code> </dt> <dd> </dd> </dl> </details>

Struct `GasConstants`

<pre><code>struct <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasConstants">GasConstants</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>global_memory_per_byte_cost: u64</code> </dt> <dd> The cost per-byte read from global storage. </dd> <dt> <code>global_memory_per_byte_write_cost: u64</code> </dt> <dd> The cost per-byte written to storage. </dd> <dt> <code>min_transaction_gas_units: u64</code> </dt> <dd> The flat minimum amount of gas required for any transaction. Charged at the start of execution. </dd> <dt> <code>large_transaction_cutoff: u64</code> </dt> <dd> Any transaction over this size will be charged an additional amount per byte. </dd> <dt> <code>intrinsic_gas_per_byte: u64</code> </dt> <dd> The units of gas to be charged per byte over the <code>large_transaction_cutoff</code> in addition to <code>min_transaction_gas_units</code> for transactions whose size exceeds <code>large_transaction_cutoff</code>. </dd> <dt> <code>maximum_number_of_gas_units: u64</code> </dt> <dd> ~5 microseconds should equal one unit of computational gas. We bound the maximum computational time of any given transaction at roughly 20 seconds. We want this number and <code>MAX_PRICE_PER_GAS_UNIT</code> to always satisfy the inequality that MAXIMUM_NUMBER_OF_GAS_UNITS * MAX_PRICE_PER_GAS_UNIT < min(u64::MAX, GasUnits<GasCarrier>::MAX) NB: The bound is set quite high since custom scripts aren't allowed except from predefined and vetted senders. </dd> <dt> <code>min_price_per_gas_unit: u64</code> </dt> <dd> The minimum gas price that a transaction can be submitted with. </dd> <dt> <code>max_price_per_gas_unit: u64</code> </dt> <dd> The maximum gas unit price that a transaction can be submitted with. </dd> <dt> <code>max_transaction_size_in_bytes: u64</code> </dt> <dd> </dd> <dt> <code>gas_unit_scaling_factor: u64</code> </dt> <dd> </dd> <dt> <code>default_account_size: u64</code> </dt> <dd> </dd> </dl> </details>

Constants

The provided gas constants were inconsistent.

<pre><code>const <a href="DiemVMConfig.md#0x1_DiemVMConfig_EGAS_CONSTANT_INCONSISTENCY">EGAS_CONSTANT_INCONSISTENCY</a>: u64 = 0; </code></pre>

Function `initialize`

Initialize the table under the diem root account

<pre><code>public fun <a href="DiemVMConfig.md#0x1_DiemVMConfig_initialize">initialize</a>(dr_account: &signer, instruction_schedule: vector<u8>, native_schedule: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="DiemVMConfig.md#0x1_DiemVMConfig_initialize">initialize</a>( dr_account: &signer, instruction_schedule: vector<u8>, native_schedule: vector<u8>, ) { <a href="DiemTimestamp.md#0x1_DiemTimestamp_assert_genesis">DiemTimestamp::assert_genesis</a>(); // The permission "UpdateVMConfig" is granted to DiemRoot [[H11]][PERMISSION]. <a href="Roles.md#0x1_Roles_assert_diem_root">Roles::assert_diem_root</a>(dr_account); let gas_constants = <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasConstants">GasConstants</a> { global_memory_per_byte_cost: 4, global_memory_per_byte_write_cost: 9, min_transaction_gas_units: 600, large_transaction_cutoff: 600, intrinsic_gas_per_byte: 8, maximum_number_of_gas_units: 4000000, min_price_per_gas_unit: 0, max_price_per_gas_unit: 10000, max_transaction_size_in_bytes: 4096, gas_unit_scaling_factor: 1000, default_account_size: 800, }; <a href="DiemConfig.md#0x1_DiemConfig_publish_new_config">DiemConfig::publish_new_config</a>( dr_account, <a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a> { gas_schedule: <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasSchedule">GasSchedule</a> { instruction_schedule, native_schedule, gas_constants, } }, ); } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>let gas_constants = <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasConstants">GasConstants</a> { global_memory_per_byte_cost: 4, global_memory_per_byte_write_cost: 9, min_transaction_gas_units: 600, large_transaction_cutoff: 600, intrinsic_gas_per_byte: 8, maximum_number_of_gas_units: 4000000, min_price_per_gas_unit: 0, max_price_per_gas_unit: 10000, max_transaction_size_in_bytes: 4096, gas_unit_scaling_factor: 1000, default_account_size: 800, }; </code></pre>

Must abort if the signer does not have the DiemRoot role [H11].

<pre><code>include <a href="Roles.md#0x1_Roles_AbortsIfNotDiemRoot">Roles::AbortsIfNotDiemRoot</a>{account: dr_account}; include <a href="DiemTimestamp.md#0x1_DiemTimestamp_AbortsIfNotGenesis">DiemTimestamp::AbortsIfNotGenesis</a>; include <a href="DiemConfig.md#0x1_DiemConfig_PublishNewConfigAbortsIf">DiemConfig::PublishNewConfigAbortsIf</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>; include <a href="DiemConfig.md#0x1_DiemConfig_PublishNewConfigEnsures">DiemConfig::PublishNewConfigEnsures</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>> { payload: <a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a> { gas_schedule: <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasSchedule">GasSchedule</a> { instruction_schedule, native_schedule, gas_constants, } }}; </code></pre> </details>

Function `set_gas_constants`

<pre><code>public fun <a href="DiemVMConfig.md#0x1_DiemVMConfig_set_gas_constants">set_gas_constants</a>(dr_account: &signer, global_memory_per_byte_cost: u64, global_memory_per_byte_write_cost: u64, min_transaction_gas_units: u64, large_transaction_cutoff: u64, intrinsic_gas_per_byte: u64, maximum_number_of_gas_units: u64, min_price_per_gas_unit: u64, max_price_per_gas_unit: u64, max_transaction_size_in_bytes: u64, gas_unit_scaling_factor: u64, default_account_size: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="DiemVMConfig.md#0x1_DiemVMConfig_set_gas_constants">set_gas_constants</a>( dr_account: &signer, global_memory_per_byte_cost: u64, global_memory_per_byte_write_cost: u64, min_transaction_gas_units: u64, large_transaction_cutoff: u64, intrinsic_gas_per_byte: u64, maximum_number_of_gas_units: u64, min_price_per_gas_unit: u64, max_price_per_gas_unit: u64, max_transaction_size_in_bytes: u64, gas_unit_scaling_factor: u64, default_account_size: u64, ) { <a href="DiemTimestamp.md#0x1_DiemTimestamp_assert_operating">DiemTimestamp::assert_operating</a>(); <a href="Roles.md#0x1_Roles_assert_diem_root">Roles::assert_diem_root</a>(dr_account); assert( min_price_per_gas_unit <= max_price_per_gas_unit, <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="DiemVMConfig.md#0x1_DiemVMConfig_EGAS_CONSTANT_INCONSISTENCY">EGAS_CONSTANT_INCONSISTENCY</a>) ); assert( min_transaction_gas_units <= maximum_number_of_gas_units, <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="DiemVMConfig.md#0x1_DiemVMConfig_EGAS_CONSTANT_INCONSISTENCY">EGAS_CONSTANT_INCONSISTENCY</a>) ); let config = <a href="DiemConfig.md#0x1_DiemConfig_get">DiemConfig::get</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>(); let gas_constants = &mut config.gas_schedule.gas_constants; gas_constants.global_memory_per_byte_cost = global_memory_per_byte_cost; gas_constants.global_memory_per_byte_write_cost = global_memory_per_byte_write_cost; gas_constants.min_transaction_gas_units = min_transaction_gas_units; gas_constants.large_transaction_cutoff = large_transaction_cutoff; gas_constants.intrinsic_gas_per_byte = intrinsic_gas_per_byte; gas_constants.maximum_number_of_gas_units = maximum_number_of_gas_units; gas_constants.min_price_per_gas_unit = min_price_per_gas_unit; gas_constants.max_price_per_gas_unit = max_price_per_gas_unit; gas_constants.max_transaction_size_in_bytes = max_transaction_size_in_bytes; gas_constants.gas_unit_scaling_factor = gas_unit_scaling_factor; gas_constants.default_account_size = default_account_size; <a href="DiemConfig.md#0x1_DiemConfig_set">DiemConfig::set</a>(dr_account, config); } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>include <a href="DiemTimestamp.md#0x1_DiemTimestamp_AbortsIfNotOperating">DiemTimestamp::AbortsIfNotOperating</a>; </code></pre>

No one can update DiemVMConfig except for the Diem Root account [H11].

<pre><code>include <a href="Roles.md#0x1_Roles_AbortsIfNotDiemRoot">Roles::AbortsIfNotDiemRoot</a>{account: dr_account}; include <a href="DiemConfig.md#0x1_DiemConfig_SetAbortsIf">DiemConfig::SetAbortsIf</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>{account: dr_account }; aborts_if min_price_per_gas_unit > max_price_per_gas_unit with <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_INVALID_ARGUMENT">Errors::INVALID_ARGUMENT</a>; aborts_if min_transaction_gas_units > maximum_number_of_gas_units with <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_INVALID_ARGUMENT">Errors::INVALID_ARGUMENT</a>; let config = <a href="DiemConfig.md#0x1_DiemConfig_spec_get_config">DiemConfig::spec_get_config</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>(); ensures <a href="DiemConfig.md#0x1_DiemConfig_spec_is_published">DiemConfig::spec_is_published</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>(); ensures <a href="DiemConfig.md#0x1_DiemConfig_get">DiemConfig::get</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>() == <a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a> { gas_schedule: <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasSchedule">GasSchedule</a> { instruction_schedule: config.gas_schedule.instruction_schedule, native_schedule: config.gas_schedule.native_schedule, gas_constants: <a href="DiemVMConfig.md#0x1_DiemVMConfig_GasConstants">GasConstants</a> { global_memory_per_byte_cost, global_memory_per_byte_write_cost, min_transaction_gas_units, large_transaction_cutoff, intrinsic_gas_per_byte, maximum_number_of_gas_units, min_price_per_gas_unit, max_price_per_gas_unit, max_transaction_size_in_bytes, gas_unit_scaling_factor, default_account_size, }, } }; ensures old(<a href="DiemConfig.md#0x1_DiemConfig_spec_has_config">DiemConfig::spec_has_config</a>()) == <a href="DiemConfig.md#0x1_DiemConfig_spec_has_config">DiemConfig::spec_has_config</a>(); </code></pre> </details>

Module Specification

Initialization

<pre><code>invariant <a href="DiemTimestamp.md#0x1_DiemTimestamp_is_operating">DiemTimestamp::is_operating</a>() ==> <a href="DiemConfig.md#0x1_DiemConfig_spec_is_published">DiemConfig::spec_is_published</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>(); </code></pre>

Access Control

No one can update DiemVMConfig except for the Diem Root account [H11].

<pre><code>schema <a href="DiemVMConfig.md#0x1_DiemVMConfig_DiemVMConfigRemainsSame">DiemVMConfigRemainsSame</a> { ensures old(<a href="DiemConfig.md#0x1_DiemConfig_spec_is_published">DiemConfig::spec_is_published</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>()) ==> global<<a href="DiemConfig.md#0x1_DiemConfig">DiemConfig</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>>(@DiemRoot) == old(global<<a href="DiemConfig.md#0x1_DiemConfig">DiemConfig</a><<a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a>>>(@DiemRoot)); } </code></pre> <pre><code>apply <a href="DiemVMConfig.md#0x1_DiemVMConfig_DiemVMConfigRemainsSame">DiemVMConfigRemainsSame</a> to * except set_gas_constants; </code></pre>

Module `0x1::DiemVMConfig`

Module 0x1::DiemVMConfig

Struct DiemVMConfig

Struct GasSchedule

Struct GasConstants

Constants

Function initialize

Function set_gas_constants

Module Specification

Initialization

Access Control

Module `0x1::DiemVMConfig`

Struct `DiemVMConfig`

Struct `GasSchedule`

Struct `GasConstants`

Function `initialize`

Function `set_gas_constants`