Struct MovePackage

pub struct MovePackage { /* private fields */ }

Implementations

impl MovePackage

pub fn new( id: ObjectID, version: SequenceNumber, module_map: BTreeMap<String, Vec<u8>>, max_move_package_size: u64, type_origin_table: Vec<TypeOrigin>, linkage_table: BTreeMap<ObjectID, UpgradeInfo>, ) -> Result<Self, ExecutionError>

Create a package with all required data (including serialized modules, type origin and linkage tables) already supplied.

pub fn digest(&self, hash_modules: bool) -> [u8; 32]

pub fn compute_digest_for_modules_and_deps<'a>( modules: impl IntoIterator<Item = &'a Vec<u8>>, object_ids: impl IntoIterator<Item = &'a ObjectID>, hash_modules: bool, ) -> [u8; 32]

It is important that this function is shared across both the calculation of the digest for the package, and the calculation of the digest on-chain.

pub fn new_initial<'p>( modules: &[CompiledModule], max_move_package_size: u64, move_binary_format_version: u32, transitive_dependencies: impl IntoIterator<Item = &'p MovePackage>, ) -> Result<Self, ExecutionError>

Create an initial version of the package along with this version’s type origin and linkage tables.

pub fn new_upgraded<'p>( &self, storage_id: ObjectID, modules: &[CompiledModule], protocol_config: &ProtocolConfig, transitive_dependencies: impl IntoIterator<Item = &'p MovePackage>, ) -> Result<Self, ExecutionError>

Create an upgraded version of the package along with this version’s type origin and linkage tables.

pub fn new_system( version: SequenceNumber, modules: &[CompiledModule], dependencies: impl IntoIterator<Item = ObjectID>, ) -> Self

pub fn get_module(&self, storage_id: &ModuleId) -> Option<&Vec<u8>>

pub fn size(&self) -> usize

Return the size of the package in bytes

pub fn id(&self) -> ObjectID

pub fn version(&self) -> SequenceNumber

pub fn decrement_version(&mut self)

pub fn increment_version(&mut self)

pub fn object_size_for_gas_metering(&self) -> usize

Approximate size of the package in bytes. This is used for gas metering.

pub fn serialized_module_map(&self) -> &BTreeMap<String, Vec<u8>>

pub fn type_origin_table(&self) -> &Vec<TypeOrigin>

pub fn type_origin_map(&self) -> BTreeMap<(String, String), ObjectID>

pub fn linkage_table(&self) -> &BTreeMap<ObjectID, UpgradeInfo>

pub fn original_package_id(&self) -> ObjectID

The ObjectID that this package’s modules believe they are from, at runtime (can differ from MovePackage::id() in the case of package upgrades).

pub fn deserialize_module( &self, module: &Identifier, binary_config: &BinaryConfig, ) -> SuiResult<CompiledModule>

pub fn normalize<S: Hash + Eq + Clone + ToString, Pool: StringPool<String = S>>( &self, pool: &mut Pool, binary_config: &BinaryConfig, include_code: bool, ) -> SuiResult<BTreeMap<String, Module<S>>>

If include_code is set to false, the normalized module will skip function bodies but still include the signatures.

Trait Implementations

impl Clone for MovePackage

fn clone(&self) -> MovePackage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MovePackage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MovePackage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MovePackage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MovePackage

fn eq(&self, other: &MovePackage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MovePackage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<MovePackage> for MovePackage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: MovePackage) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<MovePackage> for MovePackage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: MovePackage) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for MovePackage

impl StructuralPartialEq for MovePackage