state.rs

use super::*;

#[derive(Clone, Debug)]
pub(crate) struct PathState {
    pub(crate) depth: usize,
    pub(crate) call_depth: usize,
    pub(crate) origin: Address,
    pub(crate) origin_word: SymExpr,
    pub(crate) gas_price: SymExpr,
    pub(crate) ffi_enabled: bool,
    pub(crate) block: SymbolicBlock,
    pub(crate) frame: CallFrame,
    pub(crate) world: SymbolicWorld,
    pub(crate) prank: SymbolicPrank,
    pub(crate) constraints: Vec<SymBoolExpr>,
    pub(crate) next_symbol: usize,
    pub(crate) recorded_logs: Option<Vec<SymbolicLog>>,
    pub(crate) access_record: Option<AccessRecord>,
    pub(crate) root_calldata: Option<SymbolicCalldata>,
    corpus_seed_models: Vec<Arc<SymbolicModel>>,
    branch_target: Option<SymbolicBranchTarget>,
    branch_target_reached: bool,
    needs_feasibility_check: bool,
    pub(crate) loop_jumps: HashMap<usize, u32>,
    pub(crate) expected_revert: Option<ExpectedRevert>,
    pub(crate) assume_no_revert_next_call: Option<AssumeNoRevert>,
    pub(crate) expected_emit: Option<ExpectedEmit>,
    pub(crate) expected_calls: Vec<ExpectedCall>,
    pub(crate) expected_creates: Vec<ExpectedCreate>,
    pub(crate) call_mocks: Vec<CallMock>,
    pub(crate) function_mocks: Vec<FunctionMock>,
    pub(crate) persistent_accounts: HashSet<Address>,
    pub(crate) wallets: IndexSet<Address>,
    pub(crate) labels: HashMap<Address, String>,
    pub(crate) storage_load_hooks: HashMap<Address, SymbolicStorageHook>,
    pub(crate) storage_store_hooks: HashMap<Address, SymbolicStorageHook>,
    pub(crate) mapping_storage_store_hooks: HashMap<(Address, U256), SymbolicStorageHook>,
    pub(crate) mapping_hook_keccak_preimages: HashMap<(Address, SymExpr), Arc<[SymExpr]>>,
    pub(crate) storage_hook_active: bool,
    pub(crate) pending_storage_hook_revert: bool,
}

impl PathState {
    pub(crate) fn new(
        cx: &mut SymCx,
        address: Address,
        caller: Address,
        callvalue: U256,
        calldata: SymbolicCalldata,
        ffi_enabled: bool,
    ) -> Self {
        let constraints = calldata.constraints().to_vec();
        let call_data = calldata.call_data(cx);
        let origin_word = SymExpr::constant(cx, address_word(caller));
        let gas_price = SymExpr::zero(cx);
        let block = SymbolicBlock::new(cx);
        let callvalue = SymExpr::constant(cx, callvalue);
        let frame = CallFrame::new(cx, address, address, caller, callvalue, false, call_data);
        Self {
            depth: 0,
            call_depth: 0,
            origin: caller,
            origin_word,
            gas_price,
            ffi_enabled,
            block,
            frame,
            world: SymbolicWorld::default(),
            prank: SymbolicPrank::default(),
            constraints,
            next_symbol: 0,
            recorded_logs: None,
            access_record: None,
            root_calldata: Some(calldata),
            corpus_seed_models: Vec::new(),
            branch_target: None,
            branch_target_reached: false,
            needs_feasibility_check: false,
            loop_jumps: HashMap::default(),
            expected_revert: None,
            assume_no_revert_next_call: None,
            expected_emit: None,
            expected_calls: Vec::new(),
            expected_creates: Vec::new(),
            call_mocks: Vec::new(),
            function_mocks: Vec::new(),
            persistent_accounts: HashSet::default(),
            wallets: IndexSet::default(),
            labels: HashMap::default(),
            storage_load_hooks: HashMap::default(),
            storage_store_hooks: HashMap::default(),
            mapping_storage_store_hooks: HashMap::default(),
            mapping_hook_keccak_preimages: HashMap::default(),
            storage_hook_active: false,
            pending_storage_hook_revert: false,
        }
    }

    pub(crate) fn empty(
        cx: &mut SymCx,
        address: Address,
        caller: Address,
        ffi_enabled: bool,
    ) -> Self {
        let origin_word = SymExpr::constant(cx, address_word(caller));
        let gas_price = SymExpr::zero(cx);
        let block = SymbolicBlock::new(cx);
        let callvalue = SymExpr::zero(cx);
        let calldata = SymBytes::empty(cx);
        let calldata = SymCalldata::from_bytes(cx, calldata);
        let frame = CallFrame::new(cx, address, address, caller, callvalue, false, calldata);
        Self {
            depth: 0,
            call_depth: 0,
            origin: caller,
            origin_word,
            gas_price,
            ffi_enabled,
            block,
            frame,
            world: SymbolicWorld::default(),
            prank: SymbolicPrank::default(),
            constraints: Vec::new(),
            next_symbol: 0,
            recorded_logs: None,
            access_record: None,
            root_calldata: None,
            corpus_seed_models: Vec::new(),
            branch_target: None,
            branch_target_reached: false,
            needs_feasibility_check: false,
            loop_jumps: HashMap::default(),
            expected_revert: None,
            assume_no_revert_next_call: None,
            expected_emit: None,
            expected_calls: Vec::new(),
            expected_creates: Vec::new(),
            call_mocks: Vec::new(),
            function_mocks: Vec::new(),
            persistent_accounts: HashSet::default(),
            wallets: IndexSet::default(),
            labels: HashMap::default(),
            storage_load_hooks: HashMap::default(),
            storage_store_hooks: HashMap::default(),
            mapping_storage_store_hooks: HashMap::default(),
            mapping_hook_keccak_preimages: HashMap::default(),
            storage_hook_active: false,
            pending_storage_hook_revert: false,
        }
    }

    pub(crate) fn apply_executor_env<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
    ) {
        self.block = SymbolicBlock::from_executor(cx, executor);
        let gas_price = executor
            .inspector()
            .cheatcodes
            .as_ref()
            .and_then(|cheats| cheats.gas_price)
            .unwrap_or_else(|| executor.tx_env().gas_price());
        self.gas_price = SymExpr::constant(cx, U256::from(gas_price));
        if let Some(cheats) = executor.inspector().cheatcodes.as_ref() {
            for (target, overwrite) in cheats.arbitrary_storage_target_overwrite_modes() {
                self.world.enable_arbitrary_storage(target, overwrite);
            }
            for (target, source) in cheats.arbitrary_storage_copied_target_sources() {
                self.world.enable_arbitrary_storage_copy(source, target);
            }
            self.storage_load_hooks.extend(cheats.storage_load_hooks().map(|(target, hook)| {
                (
                    target,
                    SymbolicStorageHook {
                        callback_target: hook.callback_target,
                        callback_selector: hook.callback_selector,
                    },
                )
            }));
            self.storage_store_hooks.extend(cheats.storage_store_hooks().map(|(target, hook)| {
                (
                    target,
                    SymbolicStorageHook {
                        callback_target: hook.callback_target,
                        callback_selector: hook.callback_selector,
                    },
                )
            }));
            self.mapping_storage_store_hooks.extend(cheats.mapping_storage_store_hooks().map(
                |(target, root, hook)| {
                    (
                        (target, root.into()),
                        SymbolicStorageHook {
                            callback_target: hook.callback_target,
                            callback_selector: hook.callback_selector,
                        },
                    )
                },
            ));
        }
    }

    pub(crate) fn child(&self, frame: CallFrame) -> Self {
        let mut child = self.clone();
        child.call_depth += 1;
        child.frame = frame;
        // A prank changes the call being entered; calls made by the callee use normal EVM caller
        // semantics unless the callee sets its own prank.
        child.prank = SymbolicPrank::default();
        child.loop_jumps.clear();
        child.expected_revert = None;
        child.assume_no_revert_next_call = None;
        child
    }

    pub(crate) fn storage_hook_child(&self, frame: CallFrame) -> Self {
        let mut child = self.child(frame);
        child.storage_hook_active = true;
        child.recorded_logs = None;
        child.access_record = None;
        child.expected_emit = None;
        child.expected_calls.clear();
        child.expected_creates.clear();
        child.call_mocks.clear();
        child.function_mocks.clear();
        child.set_branch_target(None);
        child
    }

    pub(crate) fn copy_call_output_offset(
        &mut self,
        cx: &mut SymCx,
        dest: SymExpr,
        size: &BoundedCopySize,
    ) -> Result<(), SymbolicError> {
        let CallFrame { memory, return_data, .. } = &mut self.frame;
        memory.copy_call_output_offset(cx, dest, size, return_data)
    }

    pub(crate) fn copy_calldata_to_offset(
        &mut self,
        cx: &mut SymCx,
        dest: SymExpr,
        offset: SymExpr,
        size: usize,
    ) -> Result<(), SymbolicError> {
        let CallFrame { memory, calldata, .. } = &mut self.frame;
        memory.copy_calldata_to_offset(cx, dest, offset, size, calldata)
    }

    pub(crate) fn copy_calldata_symbolic_size(
        &mut self,
        cx: &mut SymCx,
        dest: SymExpr,
        offset: SymExpr,
        size: SymExpr,
        max_size: usize,
    ) -> Result<(), SymbolicError> {
        let CallFrame { memory, calldata, .. } = &mut self.frame;
        memory.copy_calldata_symbolic_size(cx, dest, offset, size, max_size, calldata)
    }

    pub(crate) fn copy_return_data_to_offset(
        &mut self,
        cx: &mut SymCx,
        dest: SymExpr,
        offset: SymExpr,
        size: usize,
    ) -> Result<(), SymbolicError> {
        let CallFrame { memory, return_data, .. } = &mut self.frame;
        memory.copy_return_data_to_offset(cx, dest, offset, size, return_data)
    }

    pub(crate) fn copy_return_data_symbolic_size(
        &mut self,
        cx: &mut SymCx,
        dest: SymExpr,
        offset: SymExpr,
        size: SymExpr,
        max_size: usize,
    ) -> Result<(), SymbolicError> {
        let CallFrame { memory, return_data, .. } = &mut self.frame;
        memory.copy_return_data_symbolic_size(cx, dest, offset, size, max_size, return_data)
    }

    pub(crate) fn constrained_usize(&self, cx: &mut SymCx, expr: &SymExpr) -> Option<usize> {
        self.constrained_usize_checked(cx, expr).and_then(Result::ok)
    }

    pub(crate) fn constrained_usize_checked(
        &self,
        cx: &mut SymCx,
        expr: &SymExpr,
    ) -> Option<Result<usize, U256>> {
        self.constrained_word(cx, expr).map(|value| usize::try_from(value).map_err(|_| value))
    }

    pub(crate) fn upper_bound_usize(&self, cx: &mut SymCx, expr: &SymExpr) -> Option<usize> {
        self.constrained_usize(cx, expr).or_else(|| {
            expr.as_const()
                .and_then(|value| usize::try_from(value).ok())
                .or_else(|| self.expr_upper_bound_usize(expr))
        })
    }

    pub(crate) fn constrained_word(&self, cx: &mut SymCx, expr: &SymExpr) -> Option<U256> {
        expr.as_const().or_else(|| {
            self.constraints
                .iter()
                .find_map(|constraint| {
                    constraint.forces_expr_const_with_context(expr, &self.constraints)
                })
                .or_else(|| self.constrained_expr_value(cx, expr))
        })
    }

    pub(crate) fn constrained_expr_value(&self, cx: &mut SymCx, expr: &SymExpr) -> Option<U256> {
        if let Some(value) = expr.eval() {
            return Some(value);
        }
        if let Some(value) = expr.known_word() {
            return Some(value);
        }

        let mut vars = SymbolicVars::default();
        expr.collect_eval_vars(&mut vars);
        let mut model = SymbolicModel::default();
        for var in vars {
            let var_expr = SymExpr::get_var(cx, var);
            let value = self.constraints.iter().find_map(|constraint| {
                constraint.forces_expr_const_with_context(&var_expr, &self.constraints)
            })?;
            model.insert(var, value);
        }

        expr.eval_model(&model).ok()
    }

    pub(crate) fn split_corpus_seed_models(
        &self,
        condition: &SymBoolExpr,
    ) -> (Vec<Arc<SymbolicModel>>, Vec<Arc<SymbolicModel>>) {
        let mut true_models = Vec::new();
        let mut false_models = Vec::new();
        for model in &self.corpus_seed_models {
            match condition.eval_model_if_complete(model.as_ref()) {
                Ok(Some(true)) => true_models.push(Arc::clone(model)),
                Ok(Some(false)) => false_models.push(Arc::clone(model)),
                Ok(None) | Err(_) => {
                    true_models.push(Arc::clone(model));
                    false_models.push(Arc::clone(model));
                }
            }
        }
        (true_models, false_models)
    }

    pub(crate) fn set_corpus_seed_models(&mut self, models: Vec<Arc<SymbolicModel>>) {
        self.corpus_seed_models = models;
    }

    pub(crate) const fn corpus_seed_model_count(&self) -> usize {
        self.corpus_seed_models.len()
    }

    pub(crate) const fn set_branch_target(&mut self, target: Option<SymbolicBranchTarget>) {
        self.branch_target = target;
        self.branch_target_reached = false;
    }

    pub(crate) const fn branch_target(&self) -> Option<SymbolicBranchTarget> {
        self.branch_target
    }

    pub(crate) const fn mark_branch_target_reached(&mut self) {
        self.branch_target_reached = true;
    }

    pub(crate) fn inherit_branch_target_progress(&mut self, child: &Self) {
        if self.branch_target == child.branch_target && child.branch_target_reached {
            self.branch_target_reached = true;
        }
    }

    pub(crate) fn take_noncommitting_check_state(&mut self, check: &mut Self) {
        self.constraints = std::mem::take(&mut check.constraints);
        self.next_symbol = self.next_symbol.max(check.next_symbol);
        self.world.merge_replay_metadata_from(&check.world);
        self.storage_load_hooks = std::mem::take(&mut check.storage_load_hooks);
        self.storage_store_hooks = std::mem::take(&mut check.storage_store_hooks);
        self.mapping_storage_store_hooks = std::mem::take(&mut check.mapping_storage_store_hooks);
    }

    pub(crate) fn take_call_outcome_state(&mut self, child: &mut Self) {
        self.constraints = std::mem::take(&mut child.constraints);
        self.next_symbol = child.next_symbol;
        self.inherit_branch_target_progress(child);
        self.storage_load_hooks = std::mem::take(&mut child.storage_load_hooks);
        self.storage_store_hooks = std::mem::take(&mut child.storage_store_hooks);
        self.mapping_storage_store_hooks = std::mem::take(&mut child.mapping_storage_store_hooks);
        self.mapping_hook_keccak_preimages =
            std::mem::take(&mut child.mapping_hook_keccak_preimages);
        self.recorded_logs = child.recorded_logs.take();
        self.access_record = child.access_record.take();
    }

    pub(crate) fn take_reverted_top_level_effects(&mut self, mut reverted: Self) {
        self.take_noncommitting_check_state(&mut reverted);
        self.block = reverted.block;
        self.recorded_logs = reverted.recorded_logs;
        self.access_record = reverted.access_record;
        self.expected_revert = reverted.expected_revert;
        self.assume_no_revert_next_call = reverted.assume_no_revert_next_call;
        self.expected_emit = reverted.expected_emit;
        self.expected_calls = reverted.expected_calls;
        self.expected_creates = reverted.expected_creates;
        self.call_mocks = reverted.call_mocks;
        self.function_mocks = reverted.function_mocks;
    }

    pub(crate) const fn satisfies_branch_target(&self) -> bool {
        self.branch_target.is_none() || self.branch_target_reached
    }

    pub(crate) const fn defer_feasibility_check(&mut self) {
        self.needs_feasibility_check = true;
    }

    pub(crate) const fn take_deferred_feasibility_check(&mut self) -> bool {
        let needs_check = self.needs_feasibility_check;
        self.needs_feasibility_check = false;
        needs_check
    }

    pub(crate) fn expr_upper_bound_usize(&self, expr: &SymExpr) -> Option<usize> {
        if let Some(value) = expr.eval() {
            return usize::try_from(value).ok();
        }
        if let Some(value) = expr.known_word() {
            return usize::try_from(value).ok();
        }

        let constraint_bound = self.constraint_upper_bound_usize(expr);
        let structural_bound = match expr.kind() {
            SymExprKind::Const(value) => usize::try_from(*value).ok(),
            SymExprKind::Var(_)
            | SymExprKind::GasLeft(_)
            | SymExprKind::Keccak { .. }
            | SymExprKind::Hash { .. } => None,
            SymExprKind::Not(_) => None,
            SymExprKind::TernOp(_, _, _, modulus) => match modulus.eval() {
                Some(modulus) if modulus.is_zero() => Some(0),
                Some(modulus) => usize::try_from(modulus - U256::from(1)).ok(),
                None => self.expr_upper_bound_usize(modulus).and_then(|bound| bound.checked_sub(1)),
            },
            SymExprKind::Ite(_, left, right) => {
                Some(self.expr_upper_bound_usize(left)?.max(self.expr_upper_bound_usize(right)?))
            }
            SymExprKind::BinOp(op, left, right) => match op {
                SymBinOp::Add => self
                    .expr_upper_bound_usize(left)?
                    .checked_add(self.expr_upper_bound_usize(right)?),
                SymBinOp::Mul => self
                    .expr_upper_bound_usize(left)?
                    .checked_mul(self.expr_upper_bound_usize(right)?),
                SymBinOp::UDiv => {
                    let left = self.expr_upper_bound_usize(left)?;
                    match right.eval()? {
                        divisor if divisor.is_zero() => Some(0),
                        divisor => Some(left / usize::try_from(divisor).ok()?),
                    }
                }
                SymBinOp::URem => match right.eval() {
                    Some(divisor) if divisor.is_zero() => Some(0),
                    Some(divisor) => usize::try_from(divisor - U256::from(1)).ok(),
                    None => self.expr_upper_bound_usize(left),
                },
                SymBinOp::And => right
                    .eval()
                    .and_then(|value| usize::try_from(value).ok())
                    .or_else(|| left.eval().and_then(|value| usize::try_from(value).ok()))
                    .map(|mask| {
                        self.expr_upper_bound_usize(left)
                            .or_else(|| self.expr_upper_bound_usize(right))
                            .map_or(mask, |bound| bound.min(mask))
                    }),
                SymBinOp::Shr => {
                    let left = self.expr_upper_bound_usize(left)?;
                    let shift = usize::try_from(right.eval()?).ok()?;
                    Some(if shift >= usize::BITS as usize { 0 } else { left >> shift })
                }
                SymBinOp::Sub
                | SymBinOp::SDiv
                | SymBinOp::SRem
                | SymBinOp::Or
                | SymBinOp::Xor
                | SymBinOp::Shl
                | SymBinOp::Sar => None,
            },
        };

        match (constraint_bound, structural_bound) {
            (Some(left), Some(right)) => Some(left.min(right)),
            (Some(bound), None) | (None, Some(bound)) => Some(bound),
            (None, None) => None,
        }
    }

    pub(crate) fn constraint_upper_bound_usize(&self, expr: &SymExpr) -> Option<usize> {
        let mut bound: Option<usize> = None;
        for constraint in &self.constraints {
            if let Some(candidate) = constraint.upper_bound_usize(expr) {
                bound = Some(bound.map_or(candidate, |bound| bound.min(candidate)));
            }
        }
        bound
    }

    pub(crate) fn expect_constrained_usize(
        &self,
        cx: &mut SymCx,
        expr: SymExpr,
        reason: &'static str,
    ) -> Result<usize, SymbolicError> {
        self.constrained_usize(cx, &expr).ok_or(SymbolicError::Unsupported(reason))
    }

    pub(crate) fn expect_constrained_word(
        &self,
        cx: &mut SymCx,
        expr: SymExpr,
        reason: &'static str,
    ) -> Result<U256, SymbolicError> {
        self.constrained_word(cx, &expr).ok_or(SymbolicError::Unsupported(reason))
    }

    pub(crate) fn bin_word(
        &mut self,
        cx: &mut SymCx,
        op: SymBinOp,
    ) -> Result<StepOutcome, SymbolicError> {
        let a = self.stack.pop()?;
        let b = self.stack.pop()?;
        self.stack.push(SymExpr::binop(cx, op, a, b))?;
        Ok(StepOutcome::Continue)
    }

    pub(crate) fn bin_word_div_zero_guard(
        &mut self,
        cx: &mut SymCx,
        op: SymBinOp,
    ) -> Result<StepOutcome, SymbolicError> {
        let a = self.stack.pop()?;
        let b = self.stack.pop()?;
        let zero = SymExpr::zero(cx);
        let condition = SymBoolExpr::eq(cx, b.clone(), zero.clone());
        let expr = SymExpr::binop(cx, op, a, b);
        self.stack.push(SymExpr::ite(cx, condition, zero, expr))?;
        Ok(StepOutcome::Continue)
    }

    #[cfg(test)]
    pub(crate) fn cmp_word(
        &mut self,
        cx: &mut SymCx,
        op: SymCmpOp,
    ) -> Result<StepOutcome, SymbolicError> {
        let condition = self.cmp_word_condition(cx, op)?;
        let value = SymExpr::bool_word(cx, condition);
        self.stack.push(value)?;
        Ok(StepOutcome::Continue)
    }

    pub(crate) fn cmp_word_condition(
        &mut self,
        cx: &mut SymCx,
        op: SymCmpOp,
    ) -> Result<SymBoolExpr, SymbolicError> {
        let a = self.stack.pop()?;
        let b = self.stack.pop()?;
        Ok(SymBoolExpr::cmp(cx, op, a, b))
    }

    pub(crate) fn shift_word(
        &mut self,
        cx: &mut SymCx,
        kind: ShiftKind,
    ) -> Result<StepOutcome, SymbolicError> {
        let shift = self.stack.pop()?;
        let value = self.stack.pop()?;
        let result = if let (Some(value), Some(shift)) = (value.as_const(), shift.as_const()) {
            let result = if shift >= U256::from(256) {
                if matches!(kind, ShiftKind::Sar) && ((value >> 255) == U256::from(1)) {
                    U256::MAX
                } else {
                    U256::ZERO
                }
            } else {
                let shift = usize::try_from(shift).expect("checked word shift");
                match kind {
                    ShiftKind::Shl => value << shift,
                    ShiftKind::Shr => value >> shift,
                    ShiftKind::Sar => sar(value, shift),
                }
            };
            SymExpr::constant(cx, result)
        } else {
            let expr = match kind {
                ShiftKind::Shl => SymExpr::binop(cx, SymBinOp::Shl, value, shift),
                ShiftKind::Shr => SymExpr::binop(cx, SymBinOp::Shr, value, shift),
                ShiftKind::Sar => SymExpr::binop(cx, SymBinOp::Sar, value, shift),
            };
            expr.known_word().map(|word| SymExpr::constant(cx, word)).unwrap_or(expr)
        };
        self.stack.push(result)?;
        Ok(StepOutcome::Continue)
    }

    pub(crate) fn exp_word(&mut self, cx: &mut SymCx) -> Result<StepOutcome, SymbolicError> {
        let base = self.stack.pop()?;
        let exponent = self.stack.pop()?;
        let result = if let Some(exponent) = self.constrained_word(cx, &exponent) {
            if let Some(base_value) = base.as_const() {
                SymExpr::constant(cx, pow_mod(base_value, exponent))
            } else if exponent <= U256::from(SYMBOLIC_EXP_CONCRETE_EXPONENT_LIMIT) {
                exp_expr_for_concrete_exponent(
                    cx,
                    base,
                    usize::try_from(exponent).expect("checked symbolic exponent"),
                )
            } else {
                return Err(SymbolicError::Unsupported("symbolic EXP base"));
            }
        } else {
            let exponent_limit = if base.as_const().is_some() {
                CONCRETE_BASE_SYMBOLIC_EXPONENT_LIMIT
            } else {
                SYMBOLIC_EXP_CONCRETE_EXPONENT_LIMIT
            };
            let max_exponent = self
                .upper_bound_usize(cx, &exponent)
                .filter(|exponent| *exponent <= exponent_limit as usize)
                .ok_or(SymbolicError::Unsupported("symbolic EXP exponent"))?;
            let mut expr = SymExpr::zero(cx);
            for candidate in (0..=max_exponent).rev() {
                let candidate_expr = SymExpr::constant(cx, U256::from(candidate));
                let condition = SymBoolExpr::eq(cx, exponent.clone(), candidate_expr);
                let value = exp_expr_for_concrete_exponent(cx, base.clone(), candidate);
                expr = SymExpr::ite(cx, condition, value, expr);
            }
            expr
        };
        self.stack.push(result)?;
        Ok(StepOutcome::Continue)
    }

    pub(crate) fn balance<FEN: FoundryEvmNetwork>(
        &self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
    ) -> SymExpr {
        self.world.balance_word_for_address(cx, executor, address)
    }

    pub(crate) fn balance_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        self.world.balance_word(cx, executor, address_expr)
    }

    pub(crate) fn extcode_size_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        self.world.extcode_size_word(cx, executor, address_expr)
    }

    pub(crate) fn extcode_hash_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        self.world.extcode_hash_word(cx, executor, address_expr)
    }

    pub(crate) fn extcode_bytes_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
        offset: SymExpr,
        size: usize,
    ) -> Result<SymBytes, SymbolicError> {
        self.world.extcode_bytes_word(cx, executor, address_expr, offset, size)
    }

    pub(crate) fn pop_address_word_or_symbolic_slot(
        &mut self,
        cx: &mut SymCx,
    ) -> Result<(SymExpr, Address), SymbolicError> {
        let expr = self.stack.pop()?;
        let address = self.address_or_symbolic_slot(cx, expr.clone());
        Ok((expr, address))
    }

    pub(crate) fn address_or_symbolic_slot(&mut self, cx: &mut SymCx, expr: SymExpr) -> Address {
        if let Some(value) = self.constrained_word(cx, &expr) {
            return word_to_address(value);
        }
        self.world.resolve_address(&expr).unwrap_or_else(|| self.world.symbolic_address_slot(expr))
    }

    pub(crate) fn fresh_word(&mut self, cx: &mut SymCx, prefix: &'static str) -> SymExpr {
        let id = self.next_symbol;
        self.next_symbol += 1;
        SymExpr::var(cx, &format!("{prefix}_{id}"))
    }

    pub(crate) fn fresh_gasleft(&mut self, cx: &mut SymCx) -> SymExpr {
        let id = self.next_symbol;
        self.next_symbol += 1;
        SymExpr::gas_left(cx, id)
    }

    pub(crate) fn fresh_bounded_uint(&mut self, cx: &mut SymCx, bits: U256) -> SymExpr {
        let value = self.fresh_word(cx, "symbolic");
        if bits < U256::from(256) {
            let upper = if bits.is_zero() {
                U256::ZERO
            } else {
                U256::from(1) << usize::try_from(bits).expect("checked bit width")
            };
            self.constraints.push(SymBoolExpr::cmp_word_const(cx, SymCmpOp::Ult, &value, upper));
        }
        value
    }

    pub(crate) fn fresh_bytes(&mut self, cx: &mut SymCx, len: usize) -> Vec<SymExpr> {
        (0..len).map(|_| self.fresh_bounded_uint(cx, U256::from(8))).collect()
    }

    pub(crate) fn fresh_printable_ascii_bytes(
        &mut self,
        cx: &mut SymCx,
        len: usize,
    ) -> Vec<SymExpr> {
        (0..len)
            .map(|_| {
                let byte = self.fresh_bounded_uint(cx, U256::from(8));
                self.constraints.push(SymBoolExpr::cmp_word_const(
                    cx,
                    SymCmpOp::Uge,
                    &byte,
                    U256::from(0x20),
                ));
                self.constraints.push(SymBoolExpr::cmp_word_const(
                    cx,
                    SymCmpOp::Ule,
                    &byte,
                    U256::from(0x7e),
                ));
                byte
            })
            .collect()
    }

    pub(crate) fn fresh_bounded_int(&mut self, cx: &mut SymCx, bits: U256) -> SymExpr {
        let value = self.fresh_word(cx, "symbolic");
        if bits.is_zero() {
            self.constraints.push(SymBoolExpr::eq_word_const(cx, &value, U256::ZERO));
        } else if bits < U256::from(256) {
            let magnitude =
                U256::from(1) << (usize::try_from(bits).expect("checked bit width") - 1);
            let lt = SymBoolExpr::cmp_word_const(cx, SymCmpOp::Ult, &value, magnitude);
            let ge = SymBoolExpr::cmp_word_const(
                cx,
                SymCmpOp::Uge,
                &value,
                U256::ZERO.wrapping_sub(magnitude),
            );
            let condition = SymBoolExpr::or(cx, vec![lt, ge]);
            self.constraints.push(condition);
        }
        value
    }

    pub(crate) fn prank_for_next_call(&mut self) -> (Address, SymExpr, Option<(Address, SymExpr)>) {
        if let Some((caller, caller_word)) = self.prank.next_caller.take() {
            (caller, caller_word, self.prank.next_origin.take())
        } else {
            match self.prank.persistent_caller.clone() {
                Some((caller, caller_word)) => {
                    (caller, caller_word, self.prank.persistent_origin.clone())
                }
                None => {
                    (self.address, self.address_word.clone(), self.prank.persistent_origin.clone())
                }
            }
        }
    }

    pub(crate) fn read_callers_words(&self, cx: &mut SymCx) -> Vec<SymExpr> {
        let (mode, caller, origin) = if let Some((_, caller_word)) = self.prank.next_caller.as_ref()
        {
            (
                U256::from(3),
                caller_word.clone(),
                self.prank
                    .next_origin
                    .as_ref()
                    .map(|(_, origin_word)| origin_word.clone())
                    .unwrap_or_else(|| self.origin_word.clone()),
            )
        } else if let Some((_, caller_word)) = self.prank.persistent_caller.as_ref() {
            (
                U256::from(4),
                caller_word.clone(),
                self.prank
                    .persistent_origin
                    .as_ref()
                    .map(|(_, origin_word)| origin_word.clone())
                    .unwrap_or_else(|| self.origin_word.clone()),
            )
        } else {
            (U256::ZERO, self.caller_word.clone(), self.origin_word.clone())
        };
        vec![SymExpr::constant(cx, mode), caller, origin]
    }

    pub(crate) fn record_log(&mut self, log: SymbolicLog) {
        if let Some(logs) = &mut self.recorded_logs {
            logs.push(log);
        }
    }

    pub(crate) fn record_sload(&mut self, address: Address, slot: SymExpr) {
        if let Some(record) = &mut self.access_record {
            record.read(address, slot);
        }
    }

    pub(crate) fn record_sstore(&mut self, address: Address, slot: SymExpr) {
        if let Some(record) = &mut self.access_record {
            record.write(address, slot);
        }
    }

    pub(crate) fn expectations_satisfied(&self) -> bool {
        self.expected_revert.is_none()
            && self.expected_emit.as_ref().is_none_or(ExpectedEmit::is_satisfied)
            && self.expected_calls.iter().all(ExpectedCall::is_satisfied)
            && self.expected_creates.is_empty()
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct SymbolicStorageHook {
    pub(crate) callback_target: Address,
    pub(crate) callback_selector: [u8; 4],
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct SymbolicLog {
    topics: Arc<[SymExpr]>,
    data_len: SymExpr,
    data: SymBytes,
    emitter: Address,
}

impl SymbolicLog {
    pub(crate) fn new(
        topics: Vec<SymExpr>,
        data_len: SymExpr,
        data: SymBytes,
        emitter: Address,
    ) -> Self {
        Self { topics: topics.into(), data_len, data, emitter }
    }

    pub(crate) fn into_parts(self) -> (Arc<[SymExpr]>, SymExpr, SymBytes, Address) {
        (self.topics, self.data_len, self.data, self.emitter)
    }
}

#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub(crate) struct AccessRecord {
    reads: HashMap<Address, Vec<SymExpr>>,
    writes: HashMap<Address, Vec<SymExpr>>,
}

impl AccessRecord {
    pub(crate) fn read(&mut self, address: Address, slot: SymExpr) {
        Self::push_unique_slot(self.reads.entry(address).or_default(), slot);
    }

    pub(crate) fn write(&mut self, address: Address, slot: SymExpr) {
        self.read(address, slot.clone());
        Self::push_unique_slot(self.writes.entry(address).or_default(), slot);
    }

    pub(crate) fn addresses(&self) -> Vec<Address> {
        let mut addresses = HashSet::<Address>::default();
        addresses.extend(self.reads.keys().copied());
        addresses.extend(self.writes.keys().copied());
        let mut addresses = addresses.into_iter().collect::<Vec<_>>();
        addresses.sort_unstable();
        addresses
    }

    pub(crate) fn read_slots(&self, address: Address) -> Vec<SymExpr> {
        self.reads.get(&address).cloned().unwrap_or_default()
    }

    pub(crate) fn write_slots(&self, address: Address) -> Vec<SymExpr> {
        self.writes.get(&address).cloned().unwrap_or_default()
    }

    fn push_unique_slot(slots: &mut Vec<SymExpr>, slot: SymExpr) {
        if !slots.iter().any(|existing| existing == &slot) {
            slots.push(slot);
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct ExpectedRevert {
    data: ExpectedRevertData,
    reverter: Option<SymExpr>,
    remaining: u64,
}

impl ExpectedRevert {
    pub(crate) fn new(data: ExpectedRevertData, reverter: Option<SymExpr>, remaining: u64) -> Self {
        Self { data, reverter, remaining: remaining.max(1) }
    }

    pub(crate) const fn consume_one(&mut self) -> bool {
        self.remaining = self.remaining.saturating_sub(1);
        self.remaining == 0
    }

    pub(crate) fn match_condition(
        &self,
        cx: &mut SymCx,
        reverter: Address,
        return_data: &SymReturnData,
    ) -> Option<SymBoolExpr> {
        let mut conditions = Vec::new();
        if let Some(expected_reverter) = &self.reverter {
            conditions.push(expected_reverter.address_match_condition(cx, reverter));
        }
        match &self.data {
            ExpectedRevertData::Any => {}
            ExpectedRevertData::Prefix(prefix) => {
                if return_data.len() < prefix.len() {
                    return None;
                }
                let prefix_len = SymExpr::constant(cx, U256::from(prefix.len()));
                conditions.push(SymBoolExpr::cmp(
                    cx,
                    SymCmpOp::Uge,
                    return_data.len_expr(),
                    prefix_len,
                ));
                conditions.extend((0..prefix.len()).map(|offset| {
                    let expected = prefix.byte(cx, offset);
                    let actual = return_data.byte(cx, offset);
                    SymBoolExpr::eq(cx, actual, expected)
                }));
            }
            ExpectedRevertData::Exact(data) => {
                if return_data.len() < data.len() {
                    return None;
                }
                let len = SymExpr::constant(cx, U256::from(data.len()));
                conditions.push(SymBoolExpr::eq(cx, return_data.len_expr(), len));
                conditions.extend((0..data.len()).map(|offset| {
                    let expected = data.byte(cx, offset);
                    let actual = return_data.byte(cx, offset);
                    SymBoolExpr::eq(cx, actual, expected)
                }));
            }
        }
        Some(SymBoolExpr::and(cx, conditions))
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum ExpectedRevertData {
    Any,
    Prefix(SymBytes),
    Exact(SymBytes),
}

impl ExpectedRevertData {
    pub(crate) const fn prefix(data: SymBytes) -> Self {
        Self::Prefix(data)
    }

    pub(crate) const fn exact(data: SymBytes) -> Self {
        Self::Exact(data)
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum AssumeNoRevert {
    Any,
    Filtered(Vec<ExpectedRevert>),
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct ExpectedCall {
    callee: SymExpr,
    value: Option<U256>,
    gas: Option<u64>,
    min_gas: Option<u64>,
    data: SymBytes,
    expected: u64,
    observed: u64,
    exact: bool,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct ExpectedCreate {
    bytecode: Vec<u8>,
    deployer: SymExpr,
    kind: CreateKind,
}

impl ExpectedCreate {
    pub(crate) const fn new(bytecode: Vec<u8>, deployer: SymExpr, kind: CreateKind) -> Self {
        Self { bytecode, deployer, kind }
    }

    pub(crate) fn match_condition(
        &self,
        cx: &mut SymCx,
        deployer: Address,
        kind: CreateKind,
        bytecode: &[u8],
    ) -> Option<SymBoolExpr> {
        (self.kind == kind && self.bytecode == bytecode)
            .then(|| self.deployer.address_match_condition(cx, deployer))
    }
}

impl ExpectedCall {
    pub(crate) fn new(
        callee: SymExpr,
        value: Option<U256>,
        gas: Option<u64>,
        min_gas: Option<u64>,
        data: SymBytes,
        count: Option<u64>,
    ) -> Self {
        let (gas, min_gas) = if value.is_some_and(|value| !value.is_zero()) {
            (
                gas.map(|gas| gas.saturating_add(CALL_VALUE_STIPEND)),
                min_gas.map(|gas| gas.saturating_add(CALL_VALUE_STIPEND)),
            )
        } else {
            (gas, min_gas)
        };
        Self {
            callee,
            value,
            gas,
            min_gas,
            data,
            expected: count.unwrap_or(1),
            observed: 0,
            exact: count.is_some(),
        }
    }

    pub(crate) const fn value(&self) -> Option<U256> {
        self.value
    }

    pub(crate) fn match_condition(
        &self,
        cx: &mut SymCx,
        callee: Address,
        value: Option<U256>,
        gas: &SymExpr,
        calldata: &SymBytes,
    ) -> Result<Option<SymBoolExpr>, SymbolicError> {
        if !self.static_parts_match(value, gas)? {
            return Ok(None);
        }
        let Some(data_condition) = calldata.prefix_condition(cx, &self.data) else {
            return Ok(None);
        };
        let callee_condition = self.callee.address_match_condition(cx, callee);
        Ok(Some(SymBoolExpr::and(cx, vec![callee_condition, data_condition])))
    }

    fn static_parts_match(
        &self,
        value: Option<U256>,
        gas: &SymExpr,
    ) -> Result<bool, SymbolicError> {
        Ok(self.value.is_none_or(|expected| value.is_some_and(|value| expected == value))
            && self.gas_matches(gas, value)?)
    }

    fn gas_matches(&self, gas: &SymExpr, value: Option<U256>) -> Result<bool, SymbolicError> {
        if self.gas.is_none() && self.min_gas.is_none() {
            return Ok(true);
        }
        let mut gas = gas.as_const_or("symbolic expected call gas")?;
        if value.is_some_and(|value| !value.is_zero()) {
            gas = gas.saturating_add(U256::from(CALL_VALUE_STIPEND));
        }
        Ok(self.gas.is_none_or(|expected| gas == U256::from(expected))
            && self.min_gas.is_none_or(|expected| gas >= U256::from(expected)))
    }

    pub(crate) const fn observe(&mut self) -> bool {
        if self.exact && self.observed >= self.expected {
            return false;
        }
        self.observed = self.observed.saturating_add(1);
        true
    }

    pub(crate) const fn is_satisfied(&self) -> bool {
        if self.exact { self.observed == self.expected } else { self.observed >= self.expected }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct CallMock {
    pub(crate) callee: SymExpr,
    value: Option<U256>,
    pub(crate) data: SymBytes,
    returns: Vec<SymReturnData>,
    reverts: bool,
    calls: usize,
}

impl CallMock {
    pub(crate) const fn new(
        callee: SymExpr,
        value: Option<U256>,
        data: SymBytes,
        returns: Vec<SymReturnData>,
        reverts: bool,
    ) -> Self {
        Self { callee, value, data, returns, reverts, calls: 0 }
    }

    pub(crate) const fn value(&self) -> Option<U256> {
        self.value
    }

    pub(crate) fn specificity(&self) -> (usize, bool) {
        (self.data.len(), self.value.is_some())
    }

    pub(crate) fn match_condition(
        &self,
        cx: &mut SymCx,
        callee: Address,
        value: Option<U256>,
        calldata: &SymBytes,
    ) -> Option<SymBoolExpr> {
        if !self.static_parts_match(value) {
            return None;
        }
        let data_condition = calldata.prefix_condition(cx, &self.data)?;
        let callee_condition = self.callee.address_match_condition(cx, callee);
        Some(SymBoolExpr::and(cx, vec![callee_condition, data_condition]))
    }

    fn static_parts_match(&self, value: Option<U256>) -> bool {
        self.value.is_none_or(|expected| value.is_some_and(|value| expected == value))
    }

    pub(crate) fn next_outcome(&mut self, cx: &mut SymCx) -> CallMockOutcome {
        let idx = self.calls.min(self.returns.len().saturating_sub(1));
        self.calls = self.calls.saturating_add(1);
        CallMockOutcome {
            return_data: self.returns.get(idx).cloned().unwrap_or_else(|| SymReturnData::empty(cx)),
            reverts: self.reverts,
        }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct CallMockOutcome {
    return_data: SymReturnData,
    reverts: bool,
}

impl CallMockOutcome {
    pub(crate) fn into_parts(self) -> (SymReturnData, bool) {
        (self.return_data, self.reverts)
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct FunctionMock {
    callee: SymExpr,
    target: Address,
    data: SymBytes,
}

impl FunctionMock {
    pub(crate) const fn new(callee: SymExpr, target: Address, data: SymBytes) -> Self {
        Self { callee, target, data }
    }

    pub(crate) fn matches_definition(
        &self,
        cx: &mut SymCx,
        callee: &SymExpr,
        data: &SymBytes,
    ) -> bool {
        self.callee == *callee && self.data.same_bytes(cx, data)
    }

    pub(crate) const fn set_target(&mut self, target: Address) {
        self.target = target;
    }

    pub(crate) fn calldata_len(&self) -> usize {
        self.data.len()
    }

    pub(crate) const fn target(&self) -> Address {
        self.target
    }

    pub(crate) fn match_condition(
        &self,
        cx: &mut SymCx,
        callee: Address,
        calldata: &SymBytes,
    ) -> Option<SymBoolExpr> {
        let data_condition = calldata.prefix_condition(cx, &self.data)?;
        let callee_condition = self.callee.address_match_condition(cx, callee);
        Some(SymBoolExpr::and(cx, vec![callee_condition, data_condition]))
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct ExpectedEmit {
    checks: ExpectedEmitChecks,
    emitter: Option<SymExpr>,
    remaining: u64,
    template: Option<SymbolicLog>,
}

impl ExpectedEmit {
    pub(crate) fn new(
        checks: ExpectedEmitChecks,
        emitter: Option<SymExpr>,
        remaining: u64,
    ) -> Self {
        Self { checks, emitter, remaining: remaining.max(1), template: None }
    }

    pub(crate) const fn is_satisfied(&self) -> bool {
        self.template.is_none() && self.remaining == 0
    }

    pub(crate) const fn template(&self) -> Option<&SymbolicLog> {
        self.template.as_ref()
    }

    pub(crate) fn set_template(&mut self, log: SymbolicLog) {
        self.template = Some(log);
    }

    pub(crate) fn consume_one(&mut self) -> bool {
        self.remaining = self.remaining.saturating_sub(1);
        if self.remaining == 0 {
            self.template = None;
            true
        } else {
            false
        }
    }

    pub(crate) fn match_condition(
        &self,
        cx: &mut SymCx,
        template: &SymbolicLog,
        actual: &SymbolicLog,
    ) -> Option<SymBoolExpr> {
        let mut conditions = Vec::new();
        if let Some(expected_emitter) = &self.emitter {
            conditions.push(expected_emitter.address_match_condition(cx, actual.emitter));
        }
        for (idx, &check_topic) in self.checks.topics.iter().enumerate() {
            if !check_topic {
                continue;
            }
            match (template.topics.get(idx), actual.topics.get(idx)) {
                (Some(left), Some(right)) => {
                    conditions.push(SymBoolExpr::eq(cx, left.clone(), right.clone()));
                }
                (None, None) => {}
                _ => return None,
            }
        }

        if self.checks.data {
            conditions.push(SymBoolExpr::eq(
                cx,
                template.data_len.clone(),
                actual.data_len.clone(),
            ));
            if template.data.len() != actual.data.len() {
                return None;
            }
            conditions.extend((0..template.data.len()).map(|idx| {
                let template = template.data.byte(cx, idx);
                let actual = actual.data.byte(cx, idx);
                SymBoolExpr::eq(cx, template, actual)
            }));
        }

        Some(SymBoolExpr::and(cx, conditions))
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct ExpectedEmitChecks {
    topics: [bool; 4],
    data: bool,
}

impl ExpectedEmitChecks {
    pub(crate) const fn default_non_anonymous() -> Self {
        Self { topics: [true, true, true, true], data: true }
    }

    pub(crate) const fn default_anonymous() -> Self {
        Self { topics: [true, true, true, true], data: true }
    }

    pub(crate) fn from_non_anonymous_args(
        cx: &mut SymCx,
        memory: &SymMemory,
        args_offset: usize,
    ) -> Result<Self, SymbolicError> {
        Ok(Self {
            topics: [
                true,
                read_abi_bool_arg(cx, memory, args_offset, 0, "symbolic vm.expectEmit")?,
                read_abi_bool_arg(cx, memory, args_offset, 1, "symbolic vm.expectEmit")?,
                read_abi_bool_arg(cx, memory, args_offset, 2, "symbolic vm.expectEmit")?,
            ],
            data: read_abi_bool_arg(cx, memory, args_offset, 3, "symbolic vm.expectEmit")?,
        })
    }

    pub(crate) fn from_anonymous_args(
        cx: &mut SymCx,
        memory: &SymMemory,
        args_offset: usize,
    ) -> Result<Self, SymbolicError> {
        Ok(Self {
            topics: [
                read_abi_bool_arg(cx, memory, args_offset, 0, "symbolic vm.expectEmitAnonymous")?,
                read_abi_bool_arg(cx, memory, args_offset, 1, "symbolic vm.expectEmitAnonymous")?,
                read_abi_bool_arg(cx, memory, args_offset, 2, "symbolic vm.expectEmitAnonymous")?,
                read_abi_bool_arg(cx, memory, args_offset, 3, "symbolic vm.expectEmitAnonymous")?,
            ],
            data: read_abi_bool_arg(cx, memory, args_offset, 4, "symbolic vm.expectEmitAnonymous")?,
        })
    }
}

impl Deref for PathState {
    type Target = CallFrame;

    fn deref(&self) -> &Self::Target {
        &self.frame
    }
}

impl DerefMut for PathState {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.frame
    }
}

#[derive(Clone, Debug)]
pub(crate) struct CallFrame {
    pub(crate) pc: usize,
    pub(crate) address: Address,
    pub(crate) address_word: SymExpr,
    pub(crate) storage_address: Address,
    pub(crate) caller: Address,
    pub(crate) caller_word: SymExpr,
    pub(crate) callvalue: SymExpr,
    pub(crate) is_static: bool,
    pub(crate) calldata: SymCalldata,
    pub(crate) stack: SymStack,
    pub(crate) memory: SymMemory,
    pub(crate) return_data: SymReturnData,
}

impl CallFrame {
    pub(crate) fn new(
        cx: &mut SymCx,
        address: Address,
        storage_address: Address,
        caller: Address,
        callvalue: SymExpr,
        is_static: bool,
        calldata: SymCalldata,
    ) -> Self {
        Self {
            pc: 0,
            address,
            address_word: SymExpr::constant(cx, address_word(address)),
            storage_address,
            caller,
            caller_word: SymExpr::constant(cx, address_word(caller)),
            callvalue,
            is_static,
            calldata,
            stack: SymStack::default(),
            memory: SymMemory::default(),
            return_data: SymReturnData::empty(cx),
        }
    }
}

#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub(crate) struct SymbolicPrank {
    next_caller: Option<(Address, SymExpr)>,
    next_origin: Option<(Address, SymExpr)>,
    persistent_caller: Option<(Address, SymExpr)>,
    persistent_origin: Option<(Address, SymExpr)>,
}

impl SymbolicPrank {
    pub(crate) fn set_next(
        &mut self,
        caller: (Address, SymExpr),
        origin: Option<(Address, SymExpr)>,
    ) {
        self.next_caller = Some(caller);
        self.next_origin = origin;
    }

    pub(crate) fn set_persistent(
        &mut self,
        caller: (Address, SymExpr),
        origin: Option<(Address, SymExpr)>,
    ) {
        self.persistent_caller = Some(caller);
        self.persistent_origin = origin;
    }

    pub(crate) const fn has_active(&self) -> bool {
        self.next_caller.is_some()
            || self.next_origin.is_some()
            || self.persistent_caller.is_some()
            || self.persistent_origin.is_some()
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct StorageWrite {
    address: Address,
    key: SymExpr,
    value: SymExpr,
}

impl StorageWrite {
    pub(crate) const fn new(address: Address, key: SymExpr, value: SymExpr) -> Self {
        Self { address, key, value }
    }

    pub(crate) fn select_from(
        cx: &mut SymCx,
        writes: &[Self],
        address: Address,
        key: SymExpr,
        base: SymExpr,
    ) -> SymExpr {
        let mut value = base;
        for write in writes.iter().filter(|write| write.address == address) {
            value = write.select(cx, key.clone(), value);
        }
        value
    }

    pub(crate) const fn address(&self) -> Address {
        self.address
    }

    #[cfg(test)]
    pub(crate) const fn value(&self) -> &SymExpr {
        &self.value
    }

    pub(crate) fn select(&self, cx: &mut SymCx, read_key: SymExpr, base: SymExpr) -> SymExpr {
        read_key.select_storage_write(cx, self.key.clone(), self.value.clone(), base)
    }
}

/// World data shared copy-on-write by branched paths and snapshots.
#[derive(Clone, Debug, Default)]
pub(crate) struct SymbolicWorldState {
    storage: Vec<StorageWrite>,
    transient_storage: Vec<StorageWrite>,
    created_accounts: HashSet<Address>,
    current_transaction_created_accounts: HashSet<Address>,
    balances: HashMap<Address, SymExpr>,
    code_cache: HashMap<Address, SymCode>,
    nonces: HashMap<Address, u64>,
    existing_accounts: HashSet<Address>,
    destroyed_accounts: HashSet<Address>,
    arbitrary_storage_accounts: HashMap<Address, bool>,
    arbitrary_storage_copies: HashMap<Address, Address>,
    arbitrary_storage_all: bool,
    zero_init_symbolic_storage: bool,
    symbolic_address_aliases: HashMap<SymExpr, Address>,
    replay_storage_slots: HashMap<Symbol, Vec<SymbolicReplayStorageSlot>>,
}

#[derive(Clone, Debug)]
struct SymbolicReplayStorageSlot {
    address: Address,
    slot: U256,
}

#[derive(Clone, Debug, Default)]
pub(crate) struct SymbolicWorld {
    state: Arc<SymbolicWorldState>,
    snapshots: HashMap<U256, Arc<SymbolicWorldState>>,
    next_snapshot_id: u64,
}

impl Deref for SymbolicWorld {
    type Target = SymbolicWorldState;

    fn deref(&self) -> &Self::Target {
        &self.state
    }
}

impl SymbolicWorld {
    fn state_mut(&mut self) -> &mut SymbolicWorldState {
        Arc::make_mut(&mut self.state)
    }

    pub(crate) fn is_destroyed(&self, address: Address) -> bool {
        self.destroyed_accounts.contains(&address)
    }

    #[cfg(test)]
    pub(crate) fn cached_code(&self, address: Address) -> Option<&SymCode> {
        self.code_cache.get(&address)
    }

    #[cfg(test)]
    pub(crate) fn cached_nonce(&self, address: Address) -> Option<u64> {
        self.nonces.get(&address).copied()
    }

    #[cfg(test)]
    pub(crate) fn storage_len(&self) -> usize {
        self.storage.len()
    }

    #[cfg(test)]
    pub(crate) fn storage_value(&self, index: usize) -> Option<&SymExpr> {
        self.storage.get(index).map(StorageWrite::value)
    }

    pub(crate) fn set_storage_layout(&mut self, layout: SymbolicStorageLayout) {
        let state = self.state_mut();
        state.arbitrary_storage_all = matches!(layout, SymbolicStorageLayout::Generic);
        state.zero_init_symbolic_storage = matches!(layout, SymbolicStorageLayout::ZeroInit);
    }

    pub(crate) fn sload<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
        key: SymExpr,
        concrete_key: Option<U256>,
    ) -> Result<SymExpr, SymbolicError> {
        let base = self.storage_base(cx, executor, address, &key, concrete_key)?;
        let read_key = concrete_key.map(|key| SymExpr::constant(cx, key)).unwrap_or(key);
        Ok(StorageWrite::select_from(cx, &self.storage, address, read_key, base))
    }

    pub(crate) fn sstore(&mut self, address: Address, key: SymExpr, value: SymExpr) {
        self.state_mut().storage.push(StorageWrite::new(address, key, value));
    }

    pub(crate) fn tload(&self, cx: &mut SymCx, address: Address, key: SymExpr) -> SymExpr {
        let base = SymExpr::zero(cx);
        StorageWrite::select_from(cx, &self.transient_storage, address, key, base)
    }

    pub(crate) fn tstore(&mut self, address: Address, key: SymExpr, value: SymExpr) {
        self.state_mut().transient_storage.push(StorageWrite::new(address, key, value));
    }

    /// Clears transaction-scoped state at a top-level call boundary.
    pub(crate) fn clear_transaction_scoped_state(&mut self) {
        let state = self.state_mut();
        state.transient_storage.clear();
        state.current_transaction_created_accounts.clear();
    }

    pub(crate) fn mark_current_transaction_created(&mut self, address: Address) {
        let state = self.state_mut();
        state.created_accounts.insert(address);
        state.current_transaction_created_accounts.insert(address);
    }

    /// Returns whether `address` was created in the current top-level symbolic transaction.
    pub(crate) fn was_created_in_current_transaction(&self, address: Address) -> bool {
        self.current_transaction_created_accounts.contains(&address)
    }

    pub(crate) fn enable_arbitrary_storage(&mut self, address: Address, overwrite: bool) {
        self.state_mut().arbitrary_storage_accounts.insert(address, overwrite);
    }

    pub(crate) fn enable_arbitrary_storage_copy(&mut self, source: Address, target: Address) {
        self.state_mut().arbitrary_storage_copies.insert(target, source);
    }

    pub(crate) fn replay_storage_symbols(&self) -> SymbolicVars {
        self.replay_storage_slots.keys().copied().collect()
    }

    pub(crate) fn replay_storage_assignments(
        &self,
        model: &SymbolicModel,
    ) -> Result<Vec<SymbolicStorageAssignment>, SymbolicError> {
        let mut assignments = std::collections::BTreeMap::<(Address, U256), U256>::new();
        for (symbol, slots) in &self.replay_storage_slots {
            let Some(value) = model.get(symbol).copied() else { continue };
            for slot in slots {
                match assignments.entry((slot.address, slot.slot)) {
                    std::collections::btree_map::Entry::Vacant(entry) => {
                        entry.insert(value);
                    }
                    std::collections::btree_map::Entry::Occupied(entry)
                        if *entry.get() == value => {}
                    std::collections::btree_map::Entry::Occupied(_) => {
                        return Err(SymbolicError::Solver(
                            "conflicting symbolic storage replay assignments".to_string(),
                        ));
                    }
                }
            }
        }
        Ok(assignments
            .into_iter()
            .map(|((address, slot), value)| SymbolicStorageAssignment { address, slot, value })
            .collect())
    }

    pub(crate) fn resolve_address(&self, expr: &SymExpr) -> Option<Address> {
        expr.as_const().map(word_to_address).or_else(|| {
            self.symbolic_address_aliases.get(expr).copied().or_else(|| {
                self.symbolic_address_aliases.iter().find_map(|(alias, address)| {
                    expr.symbolic_address_equivalent(alias).then_some(*address)
                })
            })
        })
    }

    pub(crate) fn symbolic_address_slot(&mut self, expr: SymExpr) -> Address {
        if let Some(address) = self.resolve_address(&expr) {
            return address;
        }
        let address = expr.representative_symbolic_address();
        self.state_mut().symbolic_address_aliases.insert(expr, address);
        address
    }

    pub(crate) fn symbolic_word_for_address(&self, address: Address) -> Option<SymExpr> {
        self.symbolic_address_aliases
            .iter()
            .find_map(|(word, slot)| (*slot == address).then(|| word.clone()))
    }

    pub(crate) fn snapshot_state(&mut self) -> U256 {
        let id = U256::from(self.next_snapshot_id);
        self.next_snapshot_id = self.next_snapshot_id.saturating_add(1);
        self.snapshots.insert(id, Arc::clone(&self.state));
        id
    }

    pub(crate) fn restore_snapshot(&mut self, id: U256) -> bool {
        let Some(snapshot) = self.snapshots.get(&id) else {
            return false;
        };
        self.state = Arc::clone(snapshot);
        true
    }

    pub(crate) fn delete_snapshot(&mut self, id: U256) -> bool {
        self.snapshots.remove(&id).is_some()
    }

    pub(crate) fn delete_snapshots(&mut self) {
        self.snapshots.clear();
    }

    pub(crate) fn storage_base<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
        key: &SymExpr,
        concrete_key: Option<U256>,
    ) -> Result<SymExpr, SymbolicError> {
        if let Some(base) = self.arbitrary_storage_base(cx, executor, address, key, concrete_key)? {
            return Ok(base);
        }
        if self.created_accounts.contains(&address) {
            return Ok(SymExpr::zero(cx));
        }
        if let Some(key) = concrete_key {
            return executor
                .backend()
                .storage_ref(address, key)
                .map(|value| SymExpr::constant(cx, value))
                .map_err(|err| SymbolicError::Backend(err.to_string()));
        }
        if let Some(key) = key.as_const() {
            executor
                .backend()
                .storage_ref(address, key)
                .map(|value| SymExpr::constant(cx, value))
                .map_err(|err| SymbolicError::Backend(err.to_string()))
        } else if self.zero_init_symbolic_storage {
            Ok(SymExpr::zero(cx))
        } else {
            let name = symbolic_storage_symbol(cx, address, key);
            Ok(SymExpr::get_var(cx, name))
        }
    }

    fn arbitrary_storage_base<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
        key: &SymExpr,
        concrete_key: Option<U256>,
    ) -> Result<Option<SymExpr>, SymbolicError> {
        if let Some(slot) = concrete_key.or_else(|| key.as_const())
            && !self.arbitrary_storage_all
        {
            let overwrite_arbitrary_storage =
                self.arbitrary_storage_accounts.get(&address).copied();
            let has_arbitrary_storage = overwrite_arbitrary_storage.is_some();
            let is_copied_storage =
                !has_arbitrary_storage && self.arbitrary_storage_copies.contains_key(&address);
            let preserve_nonzero_slot =
                overwrite_arbitrary_storage == Some(false) || is_copied_storage;
            if preserve_nonzero_slot {
                let concrete = executor
                    .backend()
                    .storage_ref(address, slot)
                    .map_err(|err| SymbolicError::Backend(err.to_string()))?;
                if !concrete.is_zero() {
                    return Ok(Some(SymExpr::constant(cx, concrete)));
                }
            }
        }

        Ok(self.unchecked_arbitrary_storage_base(cx, address, key, concrete_key))
    }

    fn unchecked_arbitrary_storage_base(
        &mut self,
        cx: &mut SymCx,
        address: Address,
        key: &SymExpr,
        concrete_key: Option<U256>,
    ) -> Option<SymExpr> {
        let overwrite_arbitrary_storage = self.arbitrary_storage_accounts.get(&address).copied();
        let has_arbitrary_storage = overwrite_arbitrary_storage.is_some();
        let copied_source = (!has_arbitrary_storage)
            .then(|| self.arbitrary_storage_copies.get(&address).copied())
            .flatten();
        let symbol_address = if self.arbitrary_storage_all || has_arbitrary_storage {
            address
        } else {
            copied_source?
        };
        let symbol = symbolic_storage_symbol(cx, symbol_address, key);
        if let Some(slot) = concrete_key.or_else(|| key.as_const()) {
            if has_arbitrary_storage {
                self.record_replay_storage_slot(symbol, address, slot);
            }
            if let Some(source) = copied_source {
                self.record_replay_storage_slot(symbol, source, slot);
                self.record_replay_storage_slot(symbol, address, slot);
            }
        }
        let value = SymExpr::get_var(cx, symbol);
        if let Some(source) = copied_source {
            self.sstore(source, key.clone(), value.clone());
        }
        Some(value)
    }

    fn record_replay_storage_slot(&mut self, symbol: Symbol, address: Address, slot: U256) {
        if self.replay_storage_slots.get(&symbol).is_some_and(|slots| {
            slots.iter().any(|existing| existing.address == address && existing.slot == slot)
        }) {
            return;
        }
        self.state_mut()
            .replay_storage_slots
            .entry(symbol)
            .or_default()
            .push(SymbolicReplayStorageSlot { address, slot });
    }

    fn merge_replay_metadata_from(&mut self, other: &Self) {
        for (symbol, slots) in &other.replay_storage_slots {
            for slot in slots {
                self.record_replay_storage_slot(*symbol, slot.address, slot.slot);
            }
        }
        let state = self.state_mut();
        for (expr, address) in &other.symbolic_address_aliases {
            state.symbolic_address_aliases.entry(expr.clone()).or_insert(*address);
        }
    }

    pub(crate) fn backend_balance<FEN: FoundryEvmNetwork>(
        &self,
        executor: &Executor<FEN>,
        address: Address,
    ) -> U256 {
        executor
            .backend()
            .basic_ref(address)
            .ok()
            .flatten()
            .map(|account| account.balance)
            .unwrap_or_default()
    }

    pub(crate) fn balance_word_for_address<FEN: FoundryEvmNetwork>(
        &self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
    ) -> SymExpr {
        if self.destroyed_accounts.contains(&address) {
            return SymExpr::zero(cx);
        }
        self.balances
            .get(&address)
            .cloned()
            .unwrap_or_else(|| SymExpr::constant(cx, self.backend_balance(executor, address)))
    }

    pub(crate) fn balance_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        if let Some(address) = self.resolve_address(&address_expr) {
            return Ok(self.balance_word_for_address(cx, executor, address));
        }

        let expr = address_expr;
        let representative = expr.representative_symbolic_address();
        let mut result = self.balance_word_for_address(cx, executor, representative);
        for (address, balance) in &self.balances {
            if self.destroyed_accounts.contains(address) {
                continue;
            }
            let address = SymExpr::constant(cx, address_word(*address));
            let condition = SymBoolExpr::eq(cx, expr.clone(), address);
            result = SymExpr::ite(cx, condition, balance.clone(), result);
        }

        Ok(result)
    }

    pub(crate) fn set_balance_word(&mut self, address: Address, value: SymExpr) {
        let account_exists = !value.as_const().is_some_and(|value| value.is_zero());
        let state = self.state_mut();
        state.balances.insert(address, value);
        if account_exists {
            state.existing_accounts.insert(address);
            state.destroyed_accounts.remove(&address);
        }
    }

    pub(crate) fn transfer<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        from: Address,
        to: Address,
        value: SymExpr,
    ) {
        if from == to || value.as_const().is_some_and(|value| value.is_zero()) {
            return;
        }
        let from_balance = self.balance_word_for_address(cx, executor, from);
        let to_balance = self.balance_word_for_address(cx, executor, to);
        let from_balance = SymExpr::binop(cx, SymBinOp::Sub, from_balance, value.clone());
        let to_balance = SymExpr::binop(cx, SymBinOp::Add, to_balance, value);
        self.set_balance_word(from, from_balance);
        self.set_balance_word(to, to_balance);
    }

    pub(crate) fn nonce<FEN: FoundryEvmNetwork>(
        &self,
        executor: &Executor<FEN>,
        address: Address,
    ) -> Result<u64, SymbolicError> {
        if self.destroyed_accounts.contains(&address) {
            return Ok(self.nonces.get(&address).copied().unwrap_or_default());
        }
        if let Some(nonce) = self.nonces.get(&address) {
            return Ok(*nonce);
        }
        executor
            .backend()
            .basic_ref(address)
            .map_err(|err| SymbolicError::Backend(err.to_string()))
            .map(|account| account.map(|account| account.nonce).unwrap_or_default())
    }

    pub(crate) fn set_nonce(&mut self, address: Address, nonce: u64) {
        let state = self.state_mut();
        state.nonces.insert(address, nonce);
        if nonce != 0 {
            state.existing_accounts.insert(address);
            state.destroyed_accounts.remove(&address);
        }
    }

    pub(crate) fn increment_nonce<FEN: FoundryEvmNetwork>(
        &mut self,
        executor: &Executor<FEN>,
        address: Address,
    ) -> Result<(), SymbolicError> {
        let nonce = self.nonce(executor, address)?;
        self.set_nonce(address, nonce.saturating_add(1));
        Ok(())
    }

    pub(crate) fn has_code_or_nonce<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
    ) -> Result<bool, SymbolicError> {
        if self.destroyed_accounts.contains(&address) {
            return Ok(false);
        }
        Ok(!self.extcode(cx, executor, address)?.is_empty() || self.nonce(executor, address)? != 0)
    }

    pub(crate) fn install_code(&mut self, address: Address, code: SymCode) {
        let state = self.state_mut();
        state.code_cache.insert(address, code);
        state.existing_accounts.insert(address);
        state.destroyed_accounts.remove(&address);
    }

    /// Implements legacy `SELFDESTRUCT` semantics.
    pub(crate) fn selfdestruct_legacy<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
        beneficiary: Address,
    ) -> Result<(), SymbolicError> {
        let balance = self.balance_word_for_address(cx, executor, address);
        if beneficiary != address && !balance.as_const().is_some_and(|value| value.is_zero()) {
            let beneficiary_balance = self.balance_word_for_address(cx, executor, beneficiary);
            let beneficiary_balance =
                SymExpr::binop(cx, SymBinOp::Add, beneficiary_balance, balance);
            self.set_balance_word(beneficiary, beneficiary_balance);
        }
        let nonce = if self.nonces.contains_key(&address) {
            None
        } else {
            Some(self.nonce(executor, address)?)
        };
        let zero = SymExpr::zero(cx);
        let empty_code = SymCode::empty(cx);
        let state = self.state_mut();
        state.balances.insert(address, zero);
        state.code_cache.insert(address, empty_code);
        if let Some(nonce) = nonce {
            state.nonces.insert(address, nonce);
        }
        state.storage.retain(|write| write.address() != address);
        state.transient_storage.retain(|write| write.address() != address);
        state.created_accounts.remove(&address);
        state.current_transaction_created_accounts.remove(&address);
        state.existing_accounts.remove(&address);
        state.destroyed_accounts.insert(address);
        Ok(())
    }

    /// Implements Cancun+ `SELFDESTRUCT` semantics for accounts not created in the current tx.
    pub(crate) fn selfdestruct_cancun_existing<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
        beneficiary: Address,
    ) {
        let balance = self.balance_word_for_address(cx, executor, address);
        if beneficiary != address && !balance.as_const().is_some_and(|value| value.is_zero()) {
            let beneficiary_balance = self.balance_word_for_address(cx, executor, beneficiary);
            // Symbolic balances are treated as possibly non-zero, matching transfer's
            // account-existence approximation.
            let beneficiary_balance =
                SymExpr::binop(cx, SymBinOp::Add, beneficiary_balance, balance);
            self.set_balance_word(beneficiary, beneficiary_balance);
            let zero = SymExpr::zero(cx);
            self.state_mut().balances.insert(address, zero);
        }
    }

    pub(crate) fn account_exists<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
    ) -> Result<bool, SymbolicError> {
        let spec_id: SpecId = executor.spec_id().into();
        if is_known_cheatcode(address) || is_supported_precompile(address, spec_id) {
            return Ok(true);
        }
        if self.destroyed_accounts.contains(&address) {
            return Ok(false);
        }
        if self.existing_accounts.contains(&address) {
            return Ok(true);
        }
        if self
            .balances
            .get(&address)
            .is_some_and(|balance| !balance.as_const().is_some_and(|value| value.is_zero()))
            || self.nonces.get(&address).is_some_and(|nonce| *nonce != 0)
            || self.code_cache.get(&address).is_some_and(|code| !code.is_empty())
        {
            self.state_mut().existing_accounts.insert(address);
            return Ok(true);
        }

        let Some(account) = executor
            .backend()
            .basic_ref(address)
            .map_err(|err| SymbolicError::Backend(err.to_string()))?
        else {
            return Ok(false);
        };

        if account.nonce != 0 || !account.balance.is_zero() {
            self.state_mut().existing_accounts.insert(address);
            return Ok(true);
        }

        if let Some(code) = account.code.as_ref()
            && !code.is_empty()
        {
            let code = SymCode::from_bytecode(cx, code);
            let state = self.state_mut();
            state.code_cache.insert(address, code);
            state.existing_accounts.insert(address);
            return Ok(true);
        }

        Ok(false)
    }

    pub(crate) fn extcode<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
    ) -> Result<SymCode, SymbolicError> {
        if is_known_cheatcode(address) {
            return Ok(SymCode::concrete(cx, vec![0]));
        }
        let spec_id: SpecId = executor.spec_id().into();
        if is_supported_precompile(address, spec_id) {
            return Ok(SymCode::empty(cx));
        }
        if self.destroyed_accounts.contains(&address) {
            return Ok(SymCode::empty(cx));
        }
        if let Some(code) = self.code_cache.get(&address) {
            return Ok(code.clone());
        }
        let account = executor
            .backend()
            .basic_ref(address)
            .map_err(|err| SymbolicError::Backend(err.to_string()))?;
        if let Some(account) = account.as_ref()
            && (account.nonce != 0
                || !account.balance.is_zero()
                || account.code.as_ref().is_some_and(|code| !code.is_empty()))
        {
            self.state_mut().existing_accounts.insert(address);
        }
        let bytecode = account.as_ref().and_then(|account| account.code.as_ref());
        let code = bytecode
            .map(|bytecode| SymCode::from_bytecode(cx, bytecode))
            .unwrap_or_else(|| SymCode::empty(cx));
        self.state_mut().code_cache.insert(address, code.clone());
        Ok(code)
    }

    pub(crate) fn extcode_hash_for_address<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address: Address,
    ) -> Result<SymExpr, SymbolicError> {
        if self.account_exists(cx, executor, address)? {
            let code = self.extcode(cx, executor, address)?;
            let bytes = code.read_byte_exprs(cx, 0, code.len());
            Ok(keccak_word(cx, bytes))
        } else {
            Ok(SymExpr::zero(cx))
        }
    }

    pub(crate) fn extcode_size_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        if let Some(address) = self.resolve_address(&address_expr) {
            let len = self.extcode(cx, executor, address)?.len();
            return Ok(SymExpr::constant(cx, U256::from(len)));
        }

        let expr = address_expr;
        let representative = expr.representative_symbolic_address();
        let len = self.extcode(cx, executor, representative)?.len();
        let mut result = SymExpr::constant(cx, U256::from(len));
        for (address, code) in &self.code_cache {
            if self.destroyed_accounts.contains(address) {
                continue;
            }
            let address = SymExpr::constant(cx, address_word(*address));
            let condition = SymBoolExpr::eq(cx, expr.clone(), address);
            let len = SymExpr::constant(cx, U256::from(code.len()));
            result = SymExpr::ite(cx, condition, len, result);
        }

        Ok(result)
    }

    pub(crate) fn extcode_hash_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        if let Some(address) = self.resolve_address(&address_expr) {
            return self.extcode_hash_for_address(cx, executor, address);
        }

        let expr = address_expr;
        let representative = expr.representative_symbolic_address();
        let mut result = self.extcode_hash_for_address(cx, executor, representative)?;
        let cached_codes = self.code_cache.iter().collect::<Vec<_>>();
        for (address, code) in cached_codes.into_iter().rev() {
            let hash = if self.destroyed_accounts.contains(address) {
                SymExpr::zero(cx)
            } else {
                let bytes = code.read_byte_exprs(cx, 0, code.len());
                keccak_word(cx, bytes)
            };
            let address = SymExpr::constant(cx, address_word(*address));
            let condition = SymBoolExpr::eq(cx, expr.clone(), address);
            result = SymExpr::ite(cx, condition, hash, result);
        }

        Ok(result)
    }

    pub(crate) fn extcode_bytes_word<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        address_expr: SymExpr,
        offset: SymExpr,
        size: usize,
    ) -> Result<SymBytes, SymbolicError> {
        if let Some(address) = self.resolve_address(&address_expr) {
            return Ok(self.extcode(cx, executor, address)?.read_bytes_offset(cx, offset, size));
        }

        let expr = address_expr;
        let representative = expr.representative_symbolic_address();
        let mut result = self.extcode(cx, executor, representative)?.read_byte_exprs_offset(
            cx,
            offset.clone(),
            size,
        );
        let cached_codes = self.code_cache.iter().collect::<Vec<_>>();
        for (address, code) in cached_codes.into_iter().rev() {
            let bytes = if self.destroyed_accounts.contains(address) {
                vec![SymExpr::zero(cx); size]
            } else {
                code.read_byte_exprs_offset(cx, offset.clone(), size)
            };
            let address = SymExpr::constant(cx, address_word(*address));
            let condition = SymBoolExpr::eq(cx, expr.clone(), address);
            for (idx, byte) in bytes.into_iter().enumerate() {
                result[idx] = SymExpr::ite(cx, condition.clone(), byte, result[idx].clone());
            }
        }

        Ok(SymBytes::exprs(cx, result))
    }

    pub(crate) fn symbolic_call_targets<FEN: FoundryEvmNetwork>(
        &mut self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
    ) -> Result<Vec<Address>, SymbolicError> {
        let mut addresses = HashSet::<Address>::default();
        addresses.extend(self.code_cache.keys().copied());
        addresses.extend(self.existing_accounts.iter().copied());
        addresses.extend(executor.backend().mem_db().cache.accounts.keys().copied());
        if let Some(db) = executor.backend().active_fork_db() {
            addresses.extend(db.cache.accounts.keys().copied());
        }
        let mut addresses = addresses.into_iter().collect::<Vec<_>>();
        addresses.sort_unstable();

        let mut targets = Vec::new();
        let spec_id: SpecId = executor.spec_id().into();
        for address in addresses {
            if is_known_cheatcode(address) || is_supported_precompile(address, spec_id) {
                continue;
            }
            if !self.extcode(cx, executor, address)?.is_empty() {
                targets.push(address);
            }
        }
        Ok(targets)
    }
}

fn symbolic_storage_symbol(cx: &mut SymCx, address: Address, key: &SymExpr) -> Symbol {
    stable_symbol(cx, "storage", format!("{address:?}:{key:?}").as_bytes())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn expected_call_zero_count_is_satisfied_only_if_call_never_happens() {
        let mut cx = SymCx::new();
        let callee = SymExpr::zero(&mut cx);
        let data = SymBytes::empty(&mut cx);

        // vm.expectCall(callee, data, 0) - the call must NEVER happen.
        let mut never_called =
            ExpectedCall::new(callee.clone(), None, None, None, data.clone(), Some(0));
        // If the forbidden call never occurs, the expectation is satisfied.
        assert!(never_called.is_satisfied());

        // A forbidden call is rejected without incrementing the observed count.
        assert!(!never_called.observe());
        assert!(never_called.is_satisfied());

        // Sanity check: an exact count=1 expectation still behaves as before.
        let mut called_once = ExpectedCall::new(callee, None, None, None, data, Some(1));
        assert!(!called_once.is_satisfied());
        assert!(called_once.observe());
        assert!(called_once.is_satisfied());
        // A second call beyond the exact count of 1 must be rejected.
        assert!(!called_once.observe());
    }

    #[test]
    fn reverted_top_level_effects_preserve_storage_hook_registrations() {
        let mut cx = SymCx::new();
        let mut state = PathState::empty(&mut cx, Address::ZERO, Address::ZERO, false);
        let mut reverted = state.clone();
        let target = Address::repeat_byte(0x11);
        let hook = SymbolicStorageHook {
            callback_target: Address::repeat_byte(0x22),
            callback_selector: [0x12, 0x34, 0x56, 0x78],
        };
        reverted.storage_load_hooks.insert(target, hook);
        reverted.storage_store_hooks.insert(target, hook);
        reverted.mapping_storage_store_hooks.insert((target, U256::from(2)), hook);

        state.take_reverted_top_level_effects(reverted);

        assert_eq!(state.storage_load_hooks.get(&target), Some(&hook));
        assert_eq!(state.storage_store_hooks.get(&target), Some(&hook));
        assert_eq!(state.mapping_storage_store_hooks.get(&(target, U256::from(2))), Some(&hook));
    }

    #[test]
    fn mapping_hook_provenance_is_account_and_path_local() {
        let mut cx = SymCx::new();
        let state = PathState::empty(&mut cx, Address::ZERO, Address::ZERO, false);
        let account = Address::repeat_byte(0x11);
        let other = Address::repeat_byte(0x22);
        let hash = SymExpr::constant(&mut cx, U256::from(7));
        let preimage = vec![SymExpr::zero(&mut cx); 64].into();
        let mut branch = state.clone();
        branch.mapping_hook_keccak_preimages.insert((account, hash.clone()), preimage);

        assert!(branch.mapping_hook_keccak_preimages.contains_key(&(account, hash.clone())));
        assert!(!branch.mapping_hook_keccak_preimages.contains_key(&(other, hash.clone())));
        assert!(!state.mapping_hook_keccak_preimages.contains_key(&(account, hash)));
    }

    #[test]
    fn cloned_world_shares_state_until_mutated() {
        let mut cx = SymCx::new();
        let address = Address::repeat_byte(0x11);
        let mut world = SymbolicWorld::default();
        world.sstore(
            address,
            SymExpr::constant(&mut cx, U256::from(1)),
            SymExpr::constant(&mut cx, U256::from(2)),
        );
        let mut branch = world.clone();

        assert!(Arc::ptr_eq(&world.state, &branch.state));
        branch.sstore(
            address,
            SymExpr::constant(&mut cx, U256::from(3)),
            SymExpr::constant(&mut cx, U256::from(4)),
        );

        assert!(!Arc::ptr_eq(&world.state, &branch.state));
        assert_eq!(world.storage_len(), 1);
        assert_eq!(branch.storage_len(), 2);
    }

    #[test]
    fn noncommitting_checks_preserve_new_storage_hook_registrations() {
        let mut cx = SymCx::new();
        let mut state = PathState::empty(&mut cx, Address::ZERO, Address::ZERO, false);
        let mut check = state.clone();
        let target = Address::repeat_byte(0x11);
        let hook = SymbolicStorageHook {
            callback_target: Address::repeat_byte(0x22),
            callback_selector: [0x12, 0x34, 0x56, 0x78],
        };
        check.storage_load_hooks.insert(target, hook);
        check.storage_store_hooks.insert(target, hook);
        check.mapping_storage_store_hooks.insert((target, U256::from(2)), hook);

        state.take_noncommitting_check_state(&mut check);

        assert_eq!(state.storage_load_hooks.get(&target), Some(&hook));
        assert_eq!(state.storage_store_hooks.get(&target), Some(&hook));
        assert_eq!(state.mapping_storage_store_hooks.get(&(target, U256::from(2))), Some(&hook));
    }

    #[test]
    fn noncommitting_checks_preserve_replaced_storage_hook_registrations() {
        let mut cx = SymCx::new();
        let mut state = PathState::empty(&mut cx, Address::ZERO, Address::ZERO, false);
        let mut check = state.clone();
        let target = Address::repeat_byte(0x11);
        let old_hook = SymbolicStorageHook {
            callback_target: Address::repeat_byte(0x33),
            callback_selector: [0x87, 0x65, 0x43, 0x21],
        };
        let hook = SymbolicStorageHook {
            callback_target: Address::repeat_byte(0x22),
            callback_selector: [0x12, 0x34, 0x56, 0x78],
        };
        state.storage_load_hooks.insert(target, old_hook);
        state.storage_store_hooks.insert(target, old_hook);
        state.mapping_storage_store_hooks.insert((target, U256::from(2)), old_hook);
        check.storage_load_hooks.insert(target, hook);
        check.storage_store_hooks.insert(target, hook);
        check.mapping_storage_store_hooks.insert((target, U256::from(2)), hook);

        state.take_noncommitting_check_state(&mut check);

        assert_eq!(state.storage_load_hooks.get(&target), Some(&hook));
        assert_eq!(state.storage_store_hooks.get(&target), Some(&hook));
        assert_eq!(state.mapping_storage_store_hooks.get(&(target, U256::from(2))), Some(&hook));
    }

    #[test]
    fn storage_hook_child_does_not_inherit_instrumentation_state() {
        let mut cx = SymCx::new();
        let mut state = PathState::empty(&mut cx, Address::ZERO, Address::ZERO, false);
        state.set_branch_target(Some(SymbolicBranchTarget::new(
            Address::ZERO,
            0,
            opcode::EQ,
            false,
        )));
        state.recorded_logs = Some(Vec::new());
        state.access_record = Some(AccessRecord::default());
        state.expected_revert = Some(ExpectedRevert::new(ExpectedRevertData::Any, None, 1));
        state.assume_no_revert_next_call = Some(AssumeNoRevert::Any);
        state.expected_emit =
            Some(ExpectedEmit::new(ExpectedEmitChecks::default_non_anonymous(), None, 1));
        let callee = SymExpr::zero(&mut cx);
        let data = SymBytes::empty(&mut cx);
        state.expected_calls.push(ExpectedCall::new(
            callee.clone(),
            None,
            None,
            None,
            data.clone(),
            None,
        ));
        state.expected_creates.push(ExpectedCreate::new(
            Vec::new(),
            callee.clone(),
            CreateKind::Create,
        ));
        state.call_mocks.push(CallMock::new(
            callee.clone(),
            None,
            data.clone(),
            vec![SymReturnData::empty(&mut cx)],
            false,
        ));
        state.function_mocks.push(FunctionMock::new(callee, Address::ZERO, data));
        let frame = state.frame.clone();

        let child = state.storage_hook_child(frame);

        assert!(child.storage_hook_active);
        assert!(child.branch_target().is_none());
        assert!(child.recorded_logs.is_none());
        assert!(child.access_record.is_none());
        assert!(child.expected_revert.is_none());
        assert!(child.assume_no_revert_next_call.is_none());
        assert!(child.expected_emit.is_none());
        assert!(child.expected_calls.is_empty());
        assert!(child.expected_creates.is_empty());
        assert!(child.call_mocks.is_empty());
        assert!(child.function_mocks.is_empty());
    }

    #[test]
    fn copied_arbitrary_storage_uses_source_symbol_and_replays_both_accounts() {
        let source = Address::repeat_byte(0x11);
        let copied = Address::repeat_byte(0x22);
        let slot = U256::from(7);
        let mut cx = SymCx::new();
        let key = SymExpr::constant(&mut cx, slot);
        let mut world = SymbolicWorld::default();
        world.enable_arbitrary_storage(source, false);
        world.enable_arbitrary_storage_copy(source, copied);

        let source_base =
            world.unchecked_arbitrary_storage_base(&mut cx, source, &key, Some(slot)).unwrap();
        let copied_base =
            world.unchecked_arbitrary_storage_base(&mut cx, copied, &key, Some(slot)).unwrap();

        assert_eq!(source_base, copied_base);
        let symbol = source_base.kind().get_var().expect("storage symbol");
        let mut model = SymbolicModel::default();
        model.insert(symbol, U256::from(42));
        let mut assignments = world.replay_storage_assignments(&model).unwrap();
        assignments.sort_by_key(|assignment| assignment.address);
        assert_eq!(
            assignments,
            vec![
                SymbolicStorageAssignment { address: source, slot, value: U256::from(42) },
                SymbolicStorageAssignment { address: copied, slot, value: U256::from(42) },
            ]
        );
    }

    #[test]
    fn copied_arbitrary_storage_read_writes_source_slot() {
        let source = Address::repeat_byte(0x11);
        let copied = Address::repeat_byte(0x22);
        let slot = U256::from(7);
        let mut cx = SymCx::new();
        let key = SymExpr::constant(&mut cx, slot);
        let mut world = SymbolicWorld::default();
        world.enable_arbitrary_storage_copy(source, copied);

        let copied_base =
            world.unchecked_arbitrary_storage_base(&mut cx, copied, &key, Some(slot)).unwrap();
        let zero = SymExpr::zero(&mut cx);
        let source_read = StorageWrite::select_from(&mut cx, &world.storage, source, key, zero);

        assert_eq!(source_read, copied_base);
    }

    #[test]
    fn explicit_arbitrary_storage_takes_precedence_over_copied_storage() {
        let source = Address::repeat_byte(0x11);
        let copied = Address::repeat_byte(0x22);
        let slot = U256::from(7);
        let mut cx = SymCx::new();
        let key = SymExpr::constant(&mut cx, slot);
        let mut world = SymbolicWorld::default();
        world.enable_arbitrary_storage(source, false);
        world.enable_arbitrary_storage_copy(source, copied);
        world.enable_arbitrary_storage(copied, false);

        let source_base =
            world.unchecked_arbitrary_storage_base(&mut cx, source, &key, Some(slot)).unwrap();
        let copied_base =
            world.unchecked_arbitrary_storage_base(&mut cx, copied, &key, Some(slot)).unwrap();

        assert_ne!(source_base, copied_base);

        let source_symbol = source_base.kind().get_var().expect("source storage symbol");
        let copied_symbol = copied_base.kind().get_var().expect("copied storage symbol");
        let mut model = SymbolicModel::default();
        model.insert(source_symbol, U256::from(42));
        model.insert(copied_symbol, U256::from(99));

        assert_eq!(
            world.replay_storage_assignments(&model).unwrap(),
            vec![
                SymbolicStorageAssignment { address: source, slot, value: U256::from(42) },
                SymbolicStorageAssignment { address: copied, slot, value: U256::from(99) },
            ]
        );
    }

    #[test]
    fn conflicting_replay_storage_assignments_error() {
        let address = Address::repeat_byte(0x11);
        let slot = U256::from(7);
        let mut cx = SymCx::new();
        let mut world = SymbolicWorld::default();
        let first = cx.intern("first_storage");
        let second = cx.intern("second_storage");
        world.record_replay_storage_slot(first, address, slot);
        world.record_replay_storage_slot(second, address, slot);

        let mut model = SymbolicModel::default();
        model.insert(first, U256::from(42));
        model.insert(second, U256::from(99));

        let err = world.replay_storage_assignments(&model).unwrap_err();
        assert!(
            matches!(err, SymbolicError::Solver(message) if message.contains("conflicting symbolic storage replay assignments"))
        );
    }
}

#[derive(Clone, Debug)]
pub(crate) struct SymbolicBlock {
    pub(crate) chain_id: SymExpr,
    pub(crate) coinbase: Address,
    pub(crate) timestamp: SymExpr,
    pub(crate) number: SymExpr,
    pub(crate) difficulty: SymExpr,
    pub(crate) gaslimit: SymExpr,
    pub(crate) basefee: SymExpr,
    pub(crate) blob_basefee: SymExpr,
    pub(crate) block_hashes: HashMap<U256, SymExpr>,
    pub(crate) blob_hashes: Vec<B256>,
}

impl SymbolicBlock {
    pub(crate) fn new(cx: &mut SymCx) -> Self {
        Self {
            chain_id: SymExpr::constant(cx, U256::from(1)),
            coinbase: Address::ZERO,
            timestamp: SymExpr::zero(cx),
            number: SymExpr::zero(cx),
            difficulty: SymExpr::zero(cx),
            gaslimit: SymExpr::zero(cx),
            basefee: SymExpr::zero(cx),
            blob_basefee: SymExpr::zero(cx),
            block_hashes: HashMap::default(),
            blob_hashes: Vec::new(),
        }
    }

    pub(crate) fn from_executor<FEN: FoundryEvmNetwork>(
        cx: &mut SymCx,
        executor: &Executor<FEN>,
    ) -> Self {
        let evm_env = executor.evm_env();
        let block = executor
            .inspector()
            .cheatcodes
            .as_ref()
            .and_then(|cheats| cheats.block.as_ref())
            .unwrap_or(&evm_env.block_env);
        let difficulty = block
            .prevrandao()
            .map(|hash| U256::from_be_bytes(hash.0))
            .unwrap_or_else(|| block.difficulty());

        Self {
            chain_id: SymExpr::constant(cx, U256::from(evm_env.cfg_env.chain_id)),
            coinbase: block.beneficiary(),
            timestamp: SymExpr::constant(cx, block.timestamp()),
            number: SymExpr::constant(cx, block.number()),
            difficulty: SymExpr::constant(cx, difficulty),
            gaslimit: SymExpr::constant(cx, U256::from(block.gas_limit())),
            basefee: SymExpr::constant(cx, U256::from(block.basefee())),
            blob_basefee: SymExpr::constant(
                cx,
                U256::from(block.blob_gasprice().unwrap_or_default()),
            ),
            block_hashes: HashMap::default(),
            blob_hashes: executor.tx_env().blob_versioned_hashes().to_vec(),
        }
    }

    pub(crate) fn set_block_hash(
        &mut self,
        block_number: U256,
        block_hash: SymExpr,
    ) -> Result<(), SymbolicError> {
        let current = self.number.as_const_or("symbolic vm.setBlockhash current number")?;
        if block_number < current && current - block_number <= U256::from(256) {
            self.block_hashes.insert(block_number, block_hash);
        }
        Ok(())
    }

    pub(crate) fn block_hash<FEN: FoundryEvmNetwork>(
        &self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        block_number: U256,
    ) -> Result<SymExpr, SymbolicError> {
        let current = self.number.as_const_or("symbolic BLOCKHASH current number")?;
        if block_number >= current || current - block_number > U256::from(256) {
            return Ok(SymExpr::zero(cx));
        }
        if let Some(hash) = self.block_hashes.get(&block_number) {
            return Ok(hash.clone());
        }
        let Ok(block_number) = u64::try_from(block_number) else {
            return Ok(SymExpr::zero(cx));
        };
        let hash = executor
            .backend()
            .block_hash_ref(block_number)
            .map_err(|err| SymbolicError::Backend(err.to_string()))?;
        Ok(SymExpr::constant(cx, U256::from_be_slice(hash.as_slice())))
    }

    pub(crate) fn block_hash_word<FEN: FoundryEvmNetwork>(
        &self,
        cx: &mut SymCx,
        executor: &Executor<FEN>,
        block_number: SymExpr,
    ) -> Result<SymExpr, SymbolicError> {
        if let Some(block_number) = block_number.as_const() {
            return self.block_hash(cx, executor, block_number);
        }
        let current = self.number.as_const_or("symbolic BLOCKHASH current number")?;
        if current.is_zero() {
            return Ok(SymExpr::zero(cx));
        }

        let mut result = SymExpr::zero(cx);
        let max_distance =
            usize::try_from(current.min(U256::from(256))).expect("checked blockhash distance");
        for distance in (1..=max_distance).rev() {
            let candidate = current - U256::from(distance);
            let hash = self.block_hash(cx, executor, candidate)?;
            if hash.as_const().is_some_and(|hash| hash.is_zero()) {
                continue;
            }
            let candidate = SymExpr::constant(cx, candidate);
            let condition = SymBoolExpr::eq(cx, block_number.clone(), candidate);
            result = SymExpr::ite(cx, condition, hash, result);
        }

        Ok(result)
    }

    pub(crate) fn set_blob_hashes(&mut self, blob_hashes: Vec<B256>) {
        self.blob_hashes = blob_hashes;
    }

    pub(crate) fn blob_hash(&self, index: usize) -> B256 {
        self.blob_hashes.get(index).copied().unwrap_or_default()
    }
}