Struct ContractMetadataStoreOverlay

struct ContractMetadataStoreOverlay {
    overlay: SledDbOverlayPtr,
}

The ContractMetadataStoreOverlay provides write operations for managing contract metadata in underlying sled database. It supports inserting new ContractMetaData and contract source code ContractSourceFile content and deleting existing source code.

Fields

overlay: SledDbOverlayPtr

Pointer to the overlay used for accessing and performing database write operations on the store.

Implementations

impl ContractMetadataStoreOverlay

pub fn new(db: Db) -> Result<Self>

Instantiate a ContractMetadataStoreOverlay over the provided [sled::Db] instance.

pub fn insert_source( &self, contract_id: &ContractId, source: &[ContractSourceFile], source_paths_to_delete: Option<&[String]>, ) -> Result<()>

Inserts ContractSourceFiles associated with provided [ContractId] into the store’s SLED_CONTRACT_SOURCE_CODE_TREE, committing the changes upon success.

This function locks the overlay, then inserts the provided source files into the store while handling serialization and potential errors. The provided contract ID is used to create a key for each source file by prepending the contract ID to each source code path. On success, the contract source code is persisted and made available for use.

If optional source_paths_to_delete is provided, the function first deletes the existing source code associated with these paths before inserting the provided source code.

fn delete_source( &self, contract_id: &ContractId, source_paths: &[String], lock: &mut MutexGuard<'_, SledDbOverlay>, ) -> Result<()>

Deletes source code associated with provided [ContractId] from the store’s SLED_CONTRACT_SOURCE_CODE_TREE, committing the changes upon success.

This auxiliary function locks the overlay, then removes the code associated with the provided contract ID from the store, handling serialization and potential errors. The contract ID is prepended to each source code path to create the keys for deletion. On success, the contract source code is permanently deleted.

pub fn insert_metadata( &self, contract_ids: &[ContractId], metadata: &[ContractMetaData], ) -> Result<()>

Inserts [ContractId] and ContractMetaData pairs into the store’s SLED_CONTRACT_METADATA_TREE, committing the changes upon success.

This function locks the overlay, verifies that the contract_ids and metadata arrays have matching lengths, then inserts them into the store while handling serialization and potential errors. On success, contract metadata is persisted and available for use.

pub fn lock(&self, tree_name: &[u8]) -> Result<MutexGuard<'_, SledDbOverlay>>

Acquires a lock on the database, opening a specified tree for write operations, returning a MutexGuard<SledDbOverlay> representing the locked state.