refactor: move tx input related types in a new module

Author: prajwolrg

crates/asm/common/src/lib.rs

@@ -6,9 +6,11 @@ mod msg;
 mod spec;
 mod state;
 mod subprotocol;
+mod tx;
 
 pub use error::AsmError;
 pub use msg::{InterprotoMsg, Log, NullMsg};
 pub use spec::{AsmSpec, Stage};
 pub use state::{AnchorState, ChainViewState, SectionState};
-pub use subprotocol::{MsgRelayer, Sps50TagPayload, Subprotocol, SubprotocolId, TxInput};
+pub use subprotocol::{MsgRelayer, Subprotocol, SubprotocolId};
+pub use tx::{TagPayload, TxInput};

crates/asm/common/src/subprotocol.rs

@@ -6,10 +6,9 @@
 
 use std::any::Any;
 
-use bitcoin::Transaction;
 use borsh::{BorshDeserialize, BorshSerialize};
 
-use crate::{Log, msg::InterprotoMsg};
+use crate::{Log, TxInput, msg::InterprotoMsg};
 
 /// Identifier for a subprotocol.
 pub type SubprotocolId = u8;
@@ -58,72 +57,3 @@ pub trait MsgRelayer: Any {
     /// Gets this msg relayer as a `&dyn Any`.
     fn as_mut_any(&mut self) -> &mut dyn Any;
 }
-
-/// A wrapper containing a reference to a Bitcoin `Transaction` together with its
-/// parsed SPS-50 payload.
-///
-/// This struct bundles:
-/// 1. `tx`: the original Bitcoin transaction containing the SPS-50 tag in its first output, and
-/// 2. `sps_50_payload`: the extracted `Sps50TagPayload`, representing the subprotocol’s transaction
-///    type and any auxiliary data.
-#[derive(Debug)]
-pub struct TxInput<'t> {
-    tx: &'t Transaction,
-    sps_50_payload: Sps50TagPayload<'t>,
-}
-
-/// A parsed SPS-50 tag payload (excluding the “ALPN” magic and subprotocol ID),
-/// containing the subprotocol-specific transaction type and any auxiliary data.
-///
-/// This struct represents everything in the OP_RETURN after the first 6 bytes:
-/// 1. Byte 0: subprotocol-defined transaction type
-/// 2. Bytes 1…: auxiliary payload (type-specific)
-#[derive(Debug)]
-pub struct Sps50TagPayload<'p> {
-    /// The transaction type as defined by the SPS-50 subprotocol.
-    tx_type: u8,
-
-    /// The remaining, type-specific payload for this transaction.
-    auxiliary_data: &'p [u8],
-}
-
-impl<'p> Sps50TagPayload<'p> {
-    /// Constructs a new `Sps50TagPayload`.
-    pub fn new(tx_type: u8, auxiliary_data: &'p [u8]) -> Self {
-        Self {
-            tx_type,
-            auxiliary_data,
-        }
-    }
-
-    /// Returns the subprotocol-defined transaction type.
-    pub fn tx_type(&self) -> u8 {
-        self.tx_type
-    }
-
-    /// Returns the auxiliary data slice associated with this tag.
-    pub fn aux_data(&self) -> &[u8] {
-        self.auxiliary_data
-    }
-}
-
-impl<'t> TxInput<'t> {
-    /// Create a new `TxInput` referencing the given `Transaction`.
-    pub fn new(tx: &'t Transaction, sps_50_info: Sps50TagPayload<'t>) -> Self {
-        TxInput {
-            tx,
-            sps_50_payload: sps_50_info,
-        }
-    }
-
-    /// Gets the inner transaction.
-    pub fn tx(&self) -> &Transaction {
-        self.tx
-    }
-
-    /// Returns a reference to the parsed SPS-50 payload for this transaction,
-    /// which contains the subprotocol-specific transaction type and auxiliary data.
-    pub fn sps50_payload(&self) -> &Sps50TagPayload<'t> {
-        &self.sps_50_payload
-    }
-}

crates/asm/common/src/tx.rs

@@ -0,0 +1,70 @@
+use bitcoin::Transaction;
+
+/// A parsed SPS-50 tag payload (excluding the “ALPN” magic and subprotocol ID),
+/// containing the subprotocol-specific transaction type and any auxiliary data.
+///
+/// This struct represents everything in the OP_RETURN after the first 6 bytes:
+/// 1. Byte 0: subprotocol-defined transaction type
+/// 2. Bytes 1…: auxiliary payload (type-specific)
+#[derive(Debug)]
+pub struct TagPayload<'p> {
+    /// The transaction type as defined by the SPS-50 subprotocol.
+    tx_type: u8,
+
+    /// The remaining, type-specific payload for this transaction.
+    auxiliary_data: &'p [u8],
+}
+
+impl<'p> TagPayload<'p> {
+    /// Constructs a new `Sps50TagPayload`.
+    pub fn new(tx_type: u8, auxiliary_data: &'p [u8]) -> Self {
+        Self {
+            tx_type,
+            auxiliary_data,
+        }
+    }
+
+    /// Returns the subprotocol-defined transaction type.
+    pub fn tx_type(&self) -> u8 {
+        self.tx_type
+    }
+
+    /// Returns the auxiliary data slice associated with this tag.
+    pub fn aux_data(&self) -> &[u8] {
+        self.auxiliary_data
+    }
+}
+
+/// A wrapper containing a reference to a Bitcoin `Transaction` together with its
+/// parsed SPS-50 payload.
+///
+/// This struct bundles:
+/// 1. `tx`: the original Bitcoin transaction containing the SPS-50 tag in its first output, and
+/// 2. `tag`: the extracted `TagPayload`, representing the subprotocol’s transaction type and any
+///    auxiliary data.
+#[derive(Debug)]
+pub struct TxInput<'t> {
+    tx: &'t Transaction,
+    tag: TagPayload<'t>,
+}
+
+impl<'t> TxInput<'t> {
+    /// Create a new `TxInput` referencing the given `Transaction`.
+    pub fn new(tx: &'t Transaction, sps_50_info: TagPayload<'t>) -> Self {
+        TxInput {
+            tx,
+            tag: sps_50_info,
+        }
+    }
+
+    /// Gets the inner transaction.
+    pub fn tx(&self) -> &Transaction {
+        self.tx
+    }
+
+    /// Returns a reference to the parsed SPS-50 tag payload for this transaction,
+    /// which contains the subprotocol-specific transaction type and auxiliary data.
+    pub fn tag(&self) -> &TagPayload<'t> {
+        &self.tag
+    }
+}

crates/asm/stf/src/tx_filter.rs

@@ -2,7 +2,7 @@
 use std::collections::BTreeMap;
 
 use bitcoin::{Transaction, opcodes::all::OP_RETURN, script::Instruction};
-use strata_asm_common::{Sps50TagPayload, SubprotocolId, TxInput};
+use strata_asm_common::{SubprotocolId, TagPayload, TxInput};
 
 /// Attempt to parse the SPS-50 L1 transaction header from the first output of a Bitcoin
 /// `Transaction`.
@@ -14,7 +14,7 @@ use strata_asm_common::{Sps50TagPayload, SubprotocolId, TxInput};
 /// [5]      tx type (u8)
 /// [6..]    auxiliary data (ignored here)
 /// ```
-fn parse_sps50_header(tx: &Transaction) -> Option<(SubprotocolId, Sps50TagPayload<'_>)> {
+fn parse_sps50_header(tx: &Transaction) -> Option<(SubprotocolId, TagPayload<'_>)> {
     // 1) Ensure there's an output 0
     let first_out = tx.output.first()?;
     let script = &first_out.script_pubkey;
@@ -40,7 +40,7 @@ fn parse_sps50_header(tx: &Transaction) -> Option<(SubprotocolId, Sps50TagPayloa
     // 4) Extract subprotocol and tx type
     let subprotocol = data[4];
 
-    let sps_50_payload = Sps50TagPayload::new(data[5], data[5..].as_bytes());
+    let sps_50_payload = TagPayload::new(data[5], data[5..].as_bytes());
     Some((subprotocol, sps_50_payload))
 }