Struct Programs 

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

Stylus programs state.

Fields

arbos_version: u64

backing_storage: Storage<D>

data_pricer: DataPricer<D>

cache_managers: AddressSet<D>

Implementations

impl<D: Database> Programs<D>

pub fn initialize(arbos_version: u64, sto: &Storage<D>)

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

pub fn params(&self) -> Result<StylusParams, ()>

Load the current Stylus parameters.

pub fn get_program(&self, code_hash: B256, time: u64) -> Result<Program, ()>

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

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

Retrieve and validate an active program.

pub fn set_program(&self, code_hash: B256, program: Program) -> Result<(), ()>

Store a program entry.

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

Check if a program exists and its status.

pub fn get_module_hash(&self, code_hash: B256) -> Result<B256, ()>

Get the module hash for a code hash.

pub fn set_module_hash( &self, code_hash: B256, module_hash: B256, ) -> Result<(), ()>

Set the module hash for a code hash.

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

Build runtime parameters for a program invocation.

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

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( &self, code_hash: B256, time: u64, pages_open: u16, recent_cache_hit: bool, ) -> Result<(u64, Program, MemoryModel), ()>

Compute gas costs for calling a Stylus program.

Returns (call_gas_cost, memory_model).

pub fn program_keepalive( &self, code_hash: B256, time: u64, ) -> Result<U256, String>

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

Returns the data fee charged.

pub fn call_program<F>( &self, code_hash: B256, time: u64, pages_open: u16, calldata: &[u8], evm_data: EvmData, _reentrant: bool, debug_mode: bool, gas: u64, used_multi_gas: &mut MultiGas, recent_cache_hit: bool, call_fn: F, ) -> Result<(Vec<u8>, u64), String>

where F: FnOnce(Program, ProgParams, EvmData, &[u8], u64) -> Result<(Vec<u8>, u64), String>,

Execute a Stylus program call.

Computes gas costs, resolves program metadata, and delegates to the provided call_fn which handles the actual WASM runtime execution. After execution, enforces return data cost parity with the EVM and attributes residual gas to WasmComputation.

The call_fn receives (program, prog_params, evm_data, calldata, gas) and returns (output_bytes, gas_left) or an error.

pub fn set_program_cached( &self, code_hash: B256, cache: bool, time: u64, ) -> Result<(), String>

Update the cached status of a program.