chore: add method to get slice of unresolved opcodes

acvm/src/pwg/mod.rs

@@ -38,7 +38,7 @@ pub enum PartialWitnessGeneratorStatus {
     /// to retrieve information from outside of the ACVM. The result of the foreign call must be passed back
     /// to the ACVM using [`ACVM::resolve_pending_foreign_call`].
     ///
-    /// Once this is done, the `ACVM` can be restarted to solve the remaining opcodes.
+    /// Once this is done, the ACVM can be restarted to solve the remaining opcodes.
     RequiresForeignCall,
 }
 
@@ -112,13 +112,25 @@ impl<B: PartialWitnessGenerator> ACVM<B> {
         }
     }
 
-    // necessary to fix integration tests. Should replace with a better VM status model.
-    pub fn remaining_opcodes_len(&self) -> usize {
-        self.opcodes.len()
+    /// Returns a reference to the current state of the ACVM's [`WitnessMap`].
+    ///
+    /// Once execution has completed, the witness map can be extracted using [`ACVM::finalize`]
+    pub fn witness_map(&self) -> &WitnessMap {
+        &self.witness_map
+    }
+
+    /// Returns a slice containing the opcodes which remain to be solved.
+    ///
+    /// Note: this doesn't include any opcodes which are waiting on a pending foreign call.
+    pub fn unresolved_opcodes(&self) -> &[Opcode] {
+        &self.opcodes
     }
 
     /// Finalize the ACVM execution, returning the resulting [`WitnessMap`].
     pub fn finalize(self) -> WitnessMap {
+        if self.opcodes.is_empty() || self.get_pending_foreign_call().is_some() {
+            panic!("ACVM is not ready to be finalized");
+        }
         self.witness_map
     }
 

acvm/tests/solver.rs

@@ -147,7 +147,7 @@ fn inversion_brillig_oracle_equivalence() {
         PartialWitnessGeneratorStatus::RequiresForeignCall,
         "Should require oracle data"
     );
-    assert_eq!(acvm.remaining_opcodes_len(), 0, "brillig should have been removed");
+    assert!(acvm.unresolved_opcodes().is_empty(), "brillig should have been removed");
 
     let foreign_call_wait_info: &ForeignCallWaitInfo =
         acvm.get_pending_foreign_call().expect("should have a brillig foreign call request");
@@ -274,7 +274,7 @@ fn double_inversion_brillig_oracle() {
         PartialWitnessGeneratorStatus::RequiresForeignCall,
         "Should require oracle data"
     );
-    assert_eq!(acvm.remaining_opcodes_len(), 0, "brillig should have been removed");
+    assert!(acvm.unresolved_opcodes().is_empty(), "brillig should have been removed");
 
     let foreign_call_wait_info: &ForeignCallWaitInfo =
         acvm.get_pending_foreign_call().expect("should have a brillig foreign call request");
@@ -292,7 +292,7 @@ fn double_inversion_brillig_oracle() {
         PartialWitnessGeneratorStatus::RequiresForeignCall,
         "Should require oracle data"
     );
-    assert_eq!(acvm.remaining_opcodes_len(), 0, "should be fully solved");
+    assert!(acvm.unresolved_opcodes().is_empty(), "should be fully solved");
 
     let foreign_call_wait_info =
         acvm.get_pending_foreign_call().expect("should have a brillig foreign call request");