Struct iota_protocol_config::ProtocolConfig

source ·

pub struct ProtocolConfig {
    pub version: ProtocolVersion,
    /* private fields */
}

Expand description

Constants that change the behavior of the protocol.

The value of each constant here must be fixed for a given protocol version. To change the value of a constant, advance the protocol version, and add support for it in get_for_version under the new version number. (below).

To add a new field to this struct, use the following procedure:

Advance the protocol version.
Add the field as a private Option<T> to the struct.
Initialize the field to None in prior protocol versions.
Initialize the field to Some(val) for your new protocol version.
Add a public getter that simply unwraps the field.
Two public getters of the form field(&self) -> field_type and field_as_option(&self) -> Option<field_type> will be automatically generated for you. Example for a field: new_constant: Option<u64>

     pub fn new_constant(&self) -> u64 {
        self.new_constant.expect(Self::CONSTANT_ERR_MSG)
    }
     pub fn new_constant_as_option(&self) -> Option<u64> {
        self.new_constant.expect(Self::CONSTANT_ERR_MSG)
    }

With pub fn new_constant(&self) -> u64, if the constant is accessed in a protocol version in which it is not defined, the validator will crash. (Crashing is necessary because this type of error would almost always result in forking if not prevented here). If you don’t want the validator to crash, you can use the pub fn new_constant_as_option(&self) -> Option<u64> getter, which will return None if the field is not defined at that version.

If you want a customized getter, you can add a method in the impl.

Fields§

§version: ProtocolVersion

Struct iota_protocol_config::ProtocolConfigCopy item path

Fields§

Implementations§

impl ProtocolConfig

pub fn max_tx_size_bytes(&self) -> u64

pub fn max_tx_size_bytes_as_option(&self) -> Option<u64>

pub fn max_input_objects(&self) -> u64

pub fn max_input_objects_as_option(&self) -> Option<u64>

pub fn max_size_written_objects(&self) -> u64

pub fn max_size_written_objects_as_option(&self) -> Option<u64>

pub fn max_size_written_objects_system_tx(&self) -> u64

pub fn max_size_written_objects_system_tx_as_option(&self) -> Option<u64>

pub fn max_serialized_tx_effects_size_bytes(&self) -> u64

pub fn max_serialized_tx_effects_size_bytes_as_option(&self) -> Option<u64>

pub fn max_serialized_tx_effects_size_bytes_system_tx(&self) -> u64

pub fn max_serialized_tx_effects_size_bytes_system_tx_as_option( &self, ) -> Option<u64>

pub fn max_gas_payment_objects(&self) -> u32

pub fn max_gas_payment_objects_as_option(&self) -> Option<u32>

pub fn max_modules_in_publish(&self) -> u32

pub fn max_modules_in_publish_as_option(&self) -> Option<u32>

pub fn max_package_dependencies(&self) -> u32

pub fn max_package_dependencies_as_option(&self) -> Option<u32>

pub fn max_arguments(&self) -> u32

pub fn max_arguments_as_option(&self) -> Option<u32>

pub fn max_type_arguments(&self) -> u32

pub fn max_type_arguments_as_option(&self) -> Option<u32>

pub fn max_type_argument_depth(&self) -> u32

pub fn max_type_argument_depth_as_option(&self) -> Option<u32>

pub fn max_pure_argument_size(&self) -> u32

pub fn max_pure_argument_size_as_option(&self) -> Option<u32>

pub fn max_programmable_tx_commands(&self) -> u32

pub fn max_programmable_tx_commands_as_option(&self) -> Option<u32>

pub fn move_binary_format_version(&self) -> u32

pub fn move_binary_format_version_as_option(&self) -> Option<u32>

pub fn min_move_binary_format_version(&self) -> u32

pub fn min_move_binary_format_version_as_option(&self) -> Option<u32>

pub fn binary_module_handles(&self) -> u16

pub fn binary_module_handles_as_option(&self) -> Option<u16>

pub fn binary_struct_handles(&self) -> u16

pub fn binary_struct_handles_as_option(&self) -> Option<u16>

pub fn binary_function_handles(&self) -> u16

pub fn binary_function_handles_as_option(&self) -> Option<u16>

pub fn binary_function_instantiations(&self) -> u16

pub fn binary_function_instantiations_as_option(&self) -> Option<u16>

pub fn binary_signatures(&self) -> u16

pub fn binary_signatures_as_option(&self) -> Option<u16>

pub fn binary_constant_pool(&self) -> u16

pub fn binary_constant_pool_as_option(&self) -> Option<u16>

pub fn binary_identifiers(&self) -> u16

pub fn binary_identifiers_as_option(&self) -> Option<u16>

pub fn binary_address_identifiers(&self) -> u16

pub fn binary_address_identifiers_as_option(&self) -> Option<u16>

pub fn binary_struct_defs(&self) -> u16

pub fn binary_struct_defs_as_option(&self) -> Option<u16>

pub fn binary_struct_def_instantiations(&self) -> u16

pub fn binary_struct_def_instantiations_as_option(&self) -> Option<u16>

pub fn binary_function_defs(&self) -> u16

pub fn binary_function_defs_as_option(&self) -> Option<u16>

pub fn binary_field_handles(&self) -> u16

pub fn binary_field_handles_as_option(&self) -> Option<u16>

pub fn binary_field_instantiations(&self) -> u16

pub fn binary_field_instantiations_as_option(&self) -> Option<u16>

pub fn binary_friend_decls(&self) -> u16

pub fn binary_friend_decls_as_option(&self) -> Option<u16>

pub fn binary_enum_defs(&self) -> u16

pub fn binary_enum_defs_as_option(&self) -> Option<u16>

pub fn binary_enum_def_instantiations(&self) -> u16

pub fn binary_enum_def_instantiations_as_option(&self) -> Option<u16>

pub fn binary_variant_handles(&self) -> u16

pub fn binary_variant_handles_as_option(&self) -> Option<u16>

pub fn binary_variant_instantiation_handles(&self) -> u16

pub fn binary_variant_instantiation_handles_as_option(&self) -> Option<u16>

pub fn max_move_object_size(&self) -> u64

pub fn max_move_object_size_as_option(&self) -> Option<u64>

pub fn max_move_package_size(&self) -> u64

pub fn max_move_package_size_as_option(&self) -> Option<u64>

pub fn max_publish_or_upgrade_per_ptb(&self) -> u64

pub fn max_publish_or_upgrade_per_ptb_as_option(&self) -> Option<u64>

pub fn max_tx_gas(&self) -> u64

pub fn max_tx_gas_as_option(&self) -> Option<u64>

Struct iota_protocol_config::ProtocolConfig