Struct AccountComponent 

pub struct AccountComponent { /* private fields */ }

An AccountComponent defines a Library of code and the initial value and types of the StorageSlots it accesses.

One or more components can be used to built AccountCode and AccountStorage.

Each component is independent of other components and can only access its own storage slots. Each component defines its own storage layout starting at index 0 up to the length of the storage slots vector.

Components define the AccountTypes they support, meaning whether the component can be used to instantiate an account of that type. For example, a component implementing a fungible faucet would only specify support for AccountType::FungibleFaucet. Using it to instantiate a regular account would fail. By default, the set of supported types is empty, so each component is forced to explicitly define what it supports.

Implementations

impl AccountComponent

pub fn new( code: impl Into<AccountComponentCode>, storage_slots: Vec<StorageSlot>, ) -> Result<Self, AccountError>

Returns a new AccountComponent constructed from the provided library and storage_slots.

All procedures exported from the provided code will become members of the account’s public interface when added to an AccountCode.

Errors

The following list of errors is exhaustive and can be relied upon for expecting the call to this function. It is recommended that custom components ensure these conditions by design or in their fallible constructors.

Returns an error if:

• The number of given StorageSlots exceeds 255.

pub fn from_package( package: &Package, init_storage_data: &InitStorageData, ) -> Result<Self, AccountError>

Creates an AccountComponent from a Package using InitStorageData.

This method provides type safety by leveraging the component’s metadata to validate storage initialization data. The package must contain explicit account component metadata.

Arguments

• package - The package containing the Library and account component metadata
• init_storage_data - The initialization data for storage slots

Errors

Returns an error if:

• The package does not contain a library artifact
• The package does not contain account component metadata
• The metadata cannot be deserialized from the package
• The storage initialization fails due to invalid or missing data
• The component creation fails

pub fn from_library( library: &AccountComponentCode, account_component_metadata: &AccountComponentMetadata, init_storage_data: &InitStorageData, ) -> Result<Self, AccountError>

Creates an AccountComponent from an AccountComponentCode and AccountComponentMetadata.

This method provides type safety by leveraging the component’s metadata to validate the passed storage initialization data (InitStorageData).

Arguments

• library - The component’s assembled code
• account_component_metadata - The component’s metadata, which describes the storage layout
• init_storage_data - The initialization data for storage slots

Errors

Returns an error if:

• The package does not contain a library artifact
• The package does not contain account component metadata
• The metadata cannot be deserialized from the package
• The storage initialization fails due to invalid or missing data
• The component creation fails

pub fn storage_size(&self) -> u8

Returns the number of storage slots accessible from this component.

pub fn component_code(&self) -> &AccountComponentCode

Returns a reference to the underlying AccountComponentCode of this component.

pub fn mast_forest(&self) -> &MastForest

Returns a reference to the underlying MastForest of this component.

pub fn storage_slots(&self) -> &[StorageSlot]

Returns a slice of the underlying StorageSlots of this component.

pub fn metadata(&self) -> Option<&AccountComponentMetadata>

Returns the component metadata, if any.

pub fn storage_schema(&self) -> Option<&StorageSchema>

Returns the storage schema associated with this component, if any.

pub fn supported_types(&self) -> &BTreeSet<AccountType>

Returns a reference to the supported AccountTypes.

pub fn supports_type(&self, account_type: AccountType) -> bool

Returns true if this component supports the given account_type, false otherwise.

pub fn get_procedures(&self) -> Vec<(Word, bool)>

Returns a vector of tuples (digest, is_auth) for all procedures in this component.

pub fn get_procedure_root_by_path( &self, proc_name: impl AsRef<Path>, ) -> Option<Word>

Returns the digest of the procedure with the specified path, or None if it was not found in this component’s library or its library path is malformed.

pub fn with_supported_type(self, supported_type: AccountType) -> Self

Adds supported_type to the set of AccountTypes supported by this component.

This function has the semantics of BTreeSet::insert, i.e. adding a type twice is fine and it can be called multiple times with different account types.

pub fn with_supported_types( self, supported_types: BTreeSet<AccountType>, ) -> Self

Overwrites any previously set supported types with the given set.

This can be used to reset the supported types of a component to a chosen set, which may be useful after cloning an existing component.

pub fn with_metadata(self, metadata: AccountComponentMetadata) -> Self

Attaches metadata to this component for downstream schema commitments and introspection.

pub fn with_supports_all_types(self) -> Self

Sets the AccountTypes supported by this component to all account types.

Trait Implementations

impl Clone for AccountComponent

fn clone(&self) -> AccountComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountComponent

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

Formats the value using the given formatter.

impl From<AccountComponent> for AccountComponentCode

fn from(component: AccountComponent) -> Self

Converts to this type from the input type.

impl PartialEq for AccountComponent

fn eq(&self, other: &AccountComponent) -> 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 Eq for AccountComponent

impl StructuralPartialEq for AccountComponent