Struct CachedPackageStore

pub struct CachedPackageStore<'state> {
    pub package_store: Box<dyn BackingPackageStore + 'state>,
    /* private fields */
}

A package store that caches packages in memory and indexes type origins. This is useful for speeding up package loading and type resolution.

There is a max_package_cache_size that determines how many packages we will cache. If the cache is full, we will drop the cache.

The max_type_cache_size determines how many types we will cache. If the cache is full, we will drop the cache.

FUTURE: Most/all of this will be replaced by the VM runtime cache in the new VM. For now though, we need to use this.

Fields

package_store: Box<dyn BackingPackageStore + 'state>

Underlying store the fetch packages from

Implementations

impl<'state> CachedPackageStore<'state>

pub const DEFAULT_MAX_PACKAGE_CACHE_SIZE: usize = 200usize

pub const DEFAULT_MAX_TYPE_ORIGIN_CACHE_SIZE: usize = 1_000usize

pub fn new(package_store: Box<dyn BackingPackageStore + 'state>) -> Self

pub fn push_package( &self, id: ObjectID, package: Rc<MovePackage>, ) -> Result<(), ExecutionError>

Push a new package into the new packages. This is used to track packages that are being published or have been published.

pub fn pop_package( &self, id: ObjectID, ) -> Result<Rc<MovePackage>, ExecutionError>

Rollback a package that was pushed into the new packages. We keep the invariant that:

• You can only pop the most recent package that was pushed.
• The element being popped must exist in the new packages.

Otherwise this returns an invariant violation.

pub fn take_new_packages(&self) -> IndexMap<ObjectID, Rc<MovePackage>>

pub fn get_package( &self, object_id: &ObjectID, ) -> SuiResult<Option<Rc<MovePackage>>>

Get a package by its package ID (i.e., not original ID). This will first look in the new packages, then in the cache, and then finally try and fetch the pacakge from the underlying package store.

Once the package is fetched it will be added to the type origin cache if it is not already present in the type origin cache.

Trait Implementations

impl PackageStore for CachedPackageStore<'_>

fn get_package(&self, id: &ObjectID) -> SuiResult<Option<Rc<MovePackage>>>

fn resolve_type_to_defining_id( &self, module_address: ObjectID, module_name: &IdentStr, type_name: &IdentStr, ) -> SuiResult<Option<ObjectID>>