fixes

Author: prajwolrg

crates/asm/common/src/error.rs

@@ -1,14 +1,29 @@
+use std::fmt::{Debug, Display};
+
 use strata_primitives::l1::L1VerificationError;
 use thiserror::Error;
 
 use crate::SubprotocolId;
 
+/// A generic “expected vs actual” error.
+#[derive(Debug, Error)]
+#[error("expected {expected}, found {actual}")]
+pub struct Mismatched<T>
+where
+    T: Debug + Display,
+{
+    /// The value that was expected.
+    pub expected: T,
+    /// The value that was actually encountered.
+    pub actual: T,
+}
+
 /// Errors that can occur while working with ASM subprotocols.
 #[derive(Debug, Error)]
 pub enum AsmError {
     /// Subprotocol ID of a decoded section did not match the expected subprotocol ID.
-    #[error("tried to decode section of ID {0} as ID {1}")]
-    SubprotoIdMismatch(SubprotocolId, SubprotocolId),
+    #[error(transparent)]
+    SubprotoIdMismatch(#[from] Mismatched<SubprotocolId>),
 
     /// The requested subprotocol ID was not found.
     #[error("subproto {0:?} does not exist")]

crates/asm/common/src/state.rs

@@ -1,7 +1,7 @@
 use borsh::{BorshDeserialize, BorshSerialize};
 use strata_primitives::l1::HeaderVerificationState;
 
-use crate::{AsmError, Subprotocol, SubprotocolId};
+use crate::{AsmError, Mismatched, Subprotocol, SubprotocolId};
 
 /// Anchor state for the Anchor State Machine (ASM), the core of the Strata protocol.
 ///
@@ -69,7 +69,11 @@ impl SectionState {
     /// Tries to deserialize the section data as a particular subprotocol's state.
     pub fn try_to_state<S: Subprotocol>(&self) -> Result<S::State, AsmError> {
         if S::ID != self.id {
-            return Err(AsmError::SubprotoIdMismatch(self.id, S::ID));
+            return Err(Mismatched {
+                expected: S::ID,
+                actual: self.id,
+            }
+            .into());
         }
 
         <S::State as BorshDeserialize>::try_from_slice(&self.data)

crates/asm/common/src/subprotocol.rs

@@ -68,7 +68,10 @@ pub trait SubprotoHandler {
     /// as-is.
     fn id(&self) -> SubprotocolId;
 
-    /// Processes transactions that were previously collected.
+    /// Process the transactions and extract all the relevant information from L1 for the
+    /// subprotocol
+    ///
+    /// Update it's own state and output a list of InterProtoMsg addressed to other subprotocols
     fn process_txs(&mut self, txs: &[TxInput<'_>], relayer: &mut dyn MsgRelayer);
 
     /// Accepts a message.  This is called while processing other subprotocols.

crates/asm/stf/src/manager.rs

@@ -52,8 +52,8 @@ impl<S: Subprotocol, R: MsgRelayer> SubprotoHandler for HandlerImpl<S, R> {
         S::process_txs(&mut self.state, txs, relayer);
     }
 
-    fn process_msgs(&mut self) {
-        S::finalize_state(&mut self.state, &self.interproto_msg_buf)
+    fn process_buffered_msgs(&mut self) {
+        S::process_msgs(&mut self.state, &self.interproto_msg_buf)
     }
 
     fn to_section(&self) -> SectionState {
@@ -100,7 +100,7 @@ impl SubprotoManager {
         let h = self
             .get_handler_mut(S::ID)
             .expect("asm: unloaded subprotocol");
-        h.process_msgs()
+        h.process_buffered_msgs()
     }
 
     fn insert_handler(&mut self, handler: Box<dyn SubprotoHandler>) {

crates/asm/subprotocols/bridge-v1/src/lib.rs

@@ -37,7 +37,7 @@ impl Subprotocol for BridgeV1Subproto {
         todo!()
     }
 
-    fn finalize_state(_state: &mut Self::State, _msgs: &[Self::Msg]) {
+    fn process_msgs(_state: &mut Self::State, _msgs: &[Self::Msg]) {
         todo!()
     }
 }

crates/asm/subprotocols/core/src/lib.rs

@@ -54,7 +54,7 @@ impl Subprotocol for OLCoreSubproto {
         todo!()
     }
 
-    fn finalize_state(_state: &mut Self::State, _msgs: &[Self::Msg]) {
+    fn process_msgs(_state: &mut Self::State, _msgs: &[Self::Msg]) {
         todo!()
     }
 }