Struct Programs 

pub struct Programs<'a, D> {
    pub arbos_version: u64,
    pub backing_storage: Storage<'a, D>,
    pub data_pricer: DataPricer,
    pub cache_managers: AddressSet<'a, D>,
    /* private fields */
}

Stylus programs state.

Fields

arbos_version: u64

backing_storage: Storage<'a, D>

data_pricer: DataPricer

cache_managers: AddressSet<'a, D>

Implementations

impl<'a, D> Programs<'a, D>

pub fn open(arbos_version: u64, sto: Storage<'a, D>) -> Self

impl<D> Programs<'_, D>

pub fn params<B: SystemStateBackend>( &self, backend: &mut B, ) -> Result<StylusParams, ProgramsError>

Load the current Stylus parameters.

pub fn activation_gas<B: SystemStateBackend>( &self, backend: &mut B, ) -> Result<u64, ProgramsError>

Read the configured Wasm activation gas cost.

pub fn set_activation_gas<B: StorageBackend>( &self, backend: &mut B, value: u64, ) -> Result<(), ProgramsError>

Persist a new activation-gas value.

pub fn save_params<B: StorageBackend>( &self, backend: &mut B, params: &StylusParams, ) -> Result<(), ProgramsError>

Persist the given Stylus parameters.

pub fn get_program<B: SystemStateBackend>( &self, backend: &mut B, code_hash: B256, time: u64, ) -> Result<Program, ProgramsError>

Retrieve a program entry (may be expired or unactivated).

pub fn set_program<B: StorageBackend>( &self, backend: &mut B, code_hash: B256, program: Program, ) -> Result<(), ProgramsError>

Store a program entry.

pub fn set_module_hash<B: StorageBackend>( &self, backend: &mut B, code_hash: B256, module_hash: B256, ) -> Result<(), ProgramsError>

Write a module hash for a code hash.

pub fn get_module_hash<B: SystemStateBackend>( &self, backend: &mut B, code_hash: B256, ) -> Result<B256, ProgramsError>

Read the module hash for a code hash.

pub fn get_active_program<B: SystemStateBackend>( &self, backend: &mut B, code_hash: B256, time: u64, params: &StylusParams, ) -> Result<Program, ProgramsError>

Retrieve and validate an active program.

pub fn program_exists<B: SystemStateBackend>( &self, backend: &mut B, code_hash: B256, time: u64, params: &StylusParams, ) -> Result<(u16, bool, bool), ProgramsError>

Check if a program exists and its status.

impl<D: Database> Programs<'_, D>

pub fn initialize<B: StorageBackend>( arbos_version: u64, sto: &Storage<'_, D>, backend: &mut B, ) -> Result<(), ProgramsError>

pub fn prog_params( &self, version: u16, debug_mode: bool, params: &StylusParams, ) -> ProgParams

Build runtime parameters for a program invocation.

pub fn activate_program<B: StorageBackend>( &self, backend: &mut B, code_hash: B256, wasm: &[u8], time: u64, page_limit: u16, debug: bool, activate_fn: impl FnOnce(&[u8], u16, u64, u16, bool) -> Result<ActivationResult, ProgramsError>, ) -> Result<(u16, B256, U256), ProgramsError>

Activate a Stylus program. Records metadata and charges data fees.

Returns (version, code_hash, module_hash, data_fee) on success.

pub fn call_gas_cost<B: SystemStateBackend>( &self, backend: &mut B, code_hash: B256, time: u64, pages_open: u16, recent_cache_hit: bool, ) -> Result<(u64, Program, MemoryModel), ProgramsError>

Compute gas costs for calling a Stylus program.

Returns (call_gas_cost, memory_model).

pub fn program_keepalive<B: StorageBackend>( &self, backend: &mut B, code_hash: B256, time: u64, ) -> Result<U256, ProgramsError>

Extend a program’s expiry by resetting its activation time.

pub fn set_program_cached<B: StorageBackend>( &self, backend: &mut B, code_hash: B256, cache: bool, time: u64, ) -> Result<(), ProgramsError>

Update the cached status of a program.