Document trace build inputs test helpers

Author: huitseeker

processor/src/execution/operations/crypto_ops/tests.rs

@@ -6,7 +6,7 @@ use miden_core::{
     crypto::merkle::{MerkleStore, MerkleTree, NodeIndex},
     field::{BasedVectorSpace, QuadFelt},
     mast::MastForest,
-    program::{MIN_STACK_DEPTH, StackInputs},
+    program::StackInputs,
 };
 use proptest::prelude::*;
 
@@ -807,18 +807,3 @@ fn test_op_mrupdate_merge_subtree() {
 fn init_node(value: u64) -> Word {
     [Felt::new(value), ZERO, ZERO, ZERO].into()
 }
-
-/// Builds an expected stack state from the given values.
-///
-/// The values are provided in "stack order" (top of stack first), and the result is a Vec<Felt>
-/// that can be compared with `processor.stack_top()`, where the top of the stack is at the
-/// **last** index.
-#[allow(dead_code)]
-fn build_expected(values: &[u64]) -> Vec<Felt> {
-    let mut expected = vec![ZERO; MIN_STACK_DEPTH];
-    for (i, &value) in values.iter().enumerate() {
-        // In the result, top of stack is at index 15, second at 14, etc.
-        expected[15 - i] = Felt::new(value);
-    }
-    expected
-}

processor/src/trace/mod.rs

@@ -105,6 +105,7 @@ impl TraceBuildInputs {
         }
     }
 
+    /// Returns the stack outputs captured for the execution being replayed.
     pub fn stack_outputs(&self) -> &StackOutputs {
         &self.trace_output.stack_outputs
     }
@@ -124,17 +125,20 @@ impl TraceBuildInputs {
         &self.program_info
     }
 
+    // Kept for mismatch and edge-case tests that mutate replay inputs directly.
     #[cfg(any(test, feature = "testing"))]
     #[allow(dead_code)]
     pub(crate) fn into_parts(self) -> (TraceBuildOutput, TraceGenerationContext, ProgramInfo) {
         (self.trace_output, self.trace_generation_context, self.program_info)
     }
 
     #[cfg(any(test, feature = "testing"))]
+    /// Returns the trace replay context captured during execution.
     pub fn trace_generation_context(&self) -> &TraceGenerationContext {
         &self.trace_generation_context
     }
 
+    // Kept for tests that force invalid replay contexts without widening the public API.
     #[cfg(any(test, feature = "testing"))]
     #[allow(dead_code)]
     pub(crate) fn trace_generation_context_mut(&mut self) -> &mut TraceGenerationContext {