Struct TemporaryStore

pub struct TemporaryStore<'backing> { /* private fields */ }

Implementations

impl<'backing> TemporaryStore<'backing>

pub fn new( store: &'backing dyn BackingStore, input_objects: InputObjects, tx_digest: TransactionDigest, protocol_config: &ProtocolConfig, ) -> Self

Creates a new store associated with an authority store, and populates it with initial objects.

pub fn objects(&self) -> &BTreeMap<ObjectID, Object>

pub fn update_object_version_and_prev_tx(&mut self)

pub fn into_inner(self) -> InnerTemporaryStore

Break up the structure and return its internal stores (objects, active_inputs, written, deleted)

pub fn to_effects( self, shared_object_refs: Vec<SharedInput>, transaction_digest: &TransactionDigest, transaction_dependencies: Vec<TransactionDigest>, gas_cost_summary: GasCostSummary, status: ExecutionStatus, gas_charger: &mut GasCharger, epoch: EpochId, ) -> (InnerTemporaryStore, TransactionEffects)

pub fn write_object(&mut self, object: Object, kind: WriteKind)

pub fn delete_object(&mut self, id: &ObjectID, kind: DeleteKindWithOldVersion)

pub fn drop_writes(&mut self)

pub fn log_event(&mut self, event: Event)

pub fn read_object(&self, id: &ObjectID) -> Option<&Object>

pub fn apply_object_changes( &mut self, changes: BTreeMap<ObjectID, ObjectChange>, )

pub fn save_loaded_runtime_objects( &mut self, loaded_runtime_objects: BTreeMap<ObjectID, DynamicallyLoadedObjectMetadata>, )

pub fn estimate_effects_size_upperbound(&self) -> usize

pub fn written_objects_size(&self) -> usize

pub fn conserve_unmetered_storage_rebate( &mut self, unmetered_storage_rebate: u64, )

If there are unmetered storage rebate (due to system transaction), we put them into the storage rebate of 0x5 object.

impl TemporaryStore<'_>

pub fn check_ownership_invariants( &self, sender: &SuiAddress, gas_charger: &mut GasCharger, is_epoch_change: bool, ) -> SuiResult<()>

impl TemporaryStore<'_>

pub fn advance_epoch_safe_mode( &mut self, params: &AdvanceEpochParams, protocol_config: &ProtocolConfig, )

impl TemporaryStore<'_>

pub fn check_sui_conserved( &self, gas_summary: &GasCostSummary, advance_epoch_gas_summary: Option<(u64, u64)>, layout_resolver: &mut impl LayoutResolver, do_expensive_checks: bool, ) -> Result<(), ExecutionError>

Check that this transaction neither creates nor destroys SUI. This should hold for all txes except the epoch change tx, which mints staking rewards equal to the gas fees burned in the previous epoch. Specifically, this checks two key invariants about storage fees and storage rebate:

1. all SUI in storage rebate fields of input objects should flow either to the transaction storage rebate, or the transaction non-refundable storage rebate
2. all SUI charged for storage should flow into the storage rebate field of some output object

If do_expensive_checks is true, this will also check a third invariant:

3. all SUI in input objects (including coins etc in the Move part of an object) should flow either to an output object, or be burned as part of computation fees or non-refundable storage rebate

This function is intended to be called after we have charged for gas + applied the storage rebate to the gas object, but before we have updated object versions. If do_expensive_checks is false, this function will only check conservation of object storage rea epoch_fees and epoch_rebates are only set for advance epoch transactions. The advance epoch transaction would mint epoch_fees amount of SUI, and burn epoch_rebates amount of SUI. We need these information for conservation check.

Trait Implementations

impl BackingPackageStore for TemporaryStore<'_>

fn get_package_object( &self, package_id: &ObjectID, ) -> SuiResult<Option<PackageObject>>

impl ChildObjectResolver for TemporaryStore<'_>

fn read_child_object( &self, parent: &ObjectID, child: &ObjectID, child_version_upper_bound: SequenceNumber, ) -> SuiResult<Option<Object>>

child must have an ObjectOwner ownership equal to owner.

fn get_object_received_at_version( &self, owner: &ObjectID, receiving_object_id: &ObjectID, receive_object_at_version: SequenceNumber, epoch_id: EpochId, ) -> SuiResult<Option<Object>>

receiving_object_id must have an AddressOwner ownership equal to owner. get_object_received_at_version must be the exact version at which the object will be received, and it cannot have been previously received at that version. NB: An object not existing at that version, and not having valid access to the object will be treated exactly the same and Ok(None) must be returned.

impl ParentSync for TemporaryStore<'_>

fn get_latest_parent_entry_ref_deprecated( &self, object_id: ObjectID, ) -> Option<ObjectRef>

This function is only called by older protocol versions. It creates an explicit dependency to tombstones, which is not desired.

impl ResourceResolver for TemporaryStore<'_>

type Error = SuiError

fn get_resource( &self, address: &AccountAddress, struct_tag: &StructTag, ) -> Result<Option<Vec<u8>>, Self::Error>

impl Storage for TemporaryStore<'_>

fn reset(&mut self)

fn read_object(&self, id: &ObjectID) -> Option<&Object>

fn record_execution_results(&mut self, results: ExecutionResults)

fn save_loaded_runtime_objects( &mut self, loaded_runtime_objects: BTreeMap<ObjectID, DynamicallyLoadedObjectMetadata>, )

fn save_wrapped_object_containers( &mut self, _wrapped_object_containers: BTreeMap<ObjectID, ObjectID>, )

fn check_coin_deny_list( &self, _written_objects: &BTreeMap<ObjectID, Object>, ) -> DenyListResult

Check coin denylist during execution, and the number of non-gas-coin owners.