generalize output pattern monitoring for RSK pegin transactions

Author: zingmanariel

examples/union/participants/user.rs

@@ -30,7 +30,7 @@ use bitvmx_client::{
         variables::PartialUtxo,
     },
     spv_proof::BtcTxSPVProof,
-    types::OutgoingBitVMXApiMessages::*,
+    types::{OutgoingBitVMXApiMessages::*, OutputPatternFilter},
 };
 
 const KEY_SPEND_FEE: u64 = 135;
@@ -106,9 +106,16 @@ impl User {
     ) -> Result<(Txid, Transaction)> {
         info!(id = self.id, "Requesting pegin");
 
-        // Enable RSK pegin monitoring using the public API
+        // Enable output pattern monitoring for RSK pegin transactions
         //TOOD: Define proper confirmation threshold
-        self.bitvmx.subscribe_to_rsk_pegin(Some(1))?;
+        self.bitvmx.subscribe_to_output_pattern(
+            OutputPatternFilter {
+                output_index: 1,
+                tag: b"RSK_PEGIN".to_vec(),
+                max_outputs: None,
+            },
+            Some(1),
+        )?;
 
         // Create a proper RSK pegin transaction and send it as if it was a user transaction
         let packet_number = 0;
@@ -145,8 +152,8 @@ impl User {
             request_pegin_txid
         );
 
-        // Wait for Bitvmx news PeginTransactionFound message
-        let (_, _) = wait_until_msg!(&self.bitvmx, PeginTransactionFound(_txid, _tx_status) => (_txid, _tx_status));
+        // Wait for Bitvmx news OutputPatternTransactionFound message
+        let (_, _, _) = wait_until_msg!(&self.bitvmx, OutputPatternTransactionFound(_txid, _tx_status, _tag) => (_txid, _tx_status, _tag));
         info!("RSK request pegin completed");
         info!("Waiting for SPV proof...");
 

src/bitvmx.rs

@@ -609,14 +609,19 @@ impl BitVMX {
                         context_data,
                     ));
                 }
-                MonitorNews::RskPeginTransaction(tx_id, tx_status) => {
+                MonitorNews::OutputPatternTransaction(tx_id, tx_status, tag) => {
                     let data = serde_json::to_string(
-                        &OutgoingBitVMXApiMessages::PeginTransactionFound(tx_id, tx_status),
+                        &OutgoingBitVMXApiMessages::OutputPatternTransactionFound(
+                            tx_id,
+                            tx_status,
+                            tag.clone(),
+                        ),
                     )?;
                     self.program_context
                         .broker_channel
                         .send(&self.config.components.l2, data)?;
-                    ack_news = AckNews::Monitor(AckMonitorNews::RskPeginTransaction(tx_id));
+                    ack_news =
+                        AckNews::Monitor(AckMonitorNews::OutputPatternTransaction(tx_id, tag));
                 }
                 MonitorNews::NewBlock(block_height, block_hash) => {
                     debug!("New block: {} {}", block_height, block_hash);
@@ -1232,14 +1237,14 @@ impl BitVMX {
         Ok(())
     }
 
-    fn subscribe_to_rsk_pegin(
+    fn subscribe_to_output_pattern(
         &mut self,
+        filter: bitcoin_coordinator::OutputPatternFilter,
         confirmation_threshold: Option<u32>,
     ) -> Result<(), BitVMXError> {
-        // Enable RSK pegin transaction monitoring
         self.program_context
             .bitcoin_coordinator
-            .monitor(TypesToMonitor::RskPegin(confirmation_threshold))?;
+            .monitor(TypesToMonitor::OutputPattern(filter, confirmation_threshold))?;
         Ok(())
     }
 
@@ -1496,8 +1501,8 @@ impl BitVMX {
                 txid,
                 confirmation_threshold,
             ) => self.subscribe_to_tx(from, uuid, txid, confirmation_threshold)?,
-            IncomingBitVMXApiMessages::SubscribeToRskPegin(confirmation_threshold) => {
-                self.subscribe_to_rsk_pegin(confirmation_threshold)?
+            IncomingBitVMXApiMessages::SubscribeToOutputPattern(filter, confirmation_threshold) => {
+                self.subscribe_to_output_pattern(filter, confirmation_threshold)?
             }
             IncomingBitVMXApiMessages::GetSPVProof(txid) => self.get_spv_proof(from, txid)?,
 

src/client.rs

@@ -6,7 +6,7 @@ use crate::{
         participant::CommsAddress,
         variables::{VariableTypes, WitnessTypes},
     },
-    types::{IncomingBitVMXApiMessages, OutgoingBitVMXApiMessages},
+    types::{IncomingBitVMXApiMessages, OutgoingBitVMXApiMessages, OutputPatternFilter},
 };
 use anyhow::Result;
 use bitcoin::{PublicKey, Transaction, Txid};
@@ -158,8 +158,13 @@ impl BitVMXClient {
         ))
     }
 
-    pub fn subscribe_to_rsk_pegin(&self, confirmation_threshold: Option<u32>) -> Result<()> {
-        self.send_message(IncomingBitVMXApiMessages::SubscribeToRskPegin(
+    pub fn subscribe_to_output_pattern(
+        &self,
+        filter: OutputPatternFilter,
+        confirmation_threshold: Option<u32>,
+    ) -> Result<()> {
+        self.send_message(IncomingBitVMXApiMessages::SubscribeToOutputPattern(
+            filter,
             confirmation_threshold,
         ))
     }

src/types.rs

@@ -28,6 +28,7 @@ use crate::{
         variables::{Globals, VariableTypes, WitnessTypes, WitnessVars},
     },
 };
+pub use bitcoin_coordinator::OutputPatternFilter;
 
 pub struct ProgramContext {
     pub key_manager: Rc<KeyManager>,
@@ -93,7 +94,7 @@ pub enum IncomingBitVMXApiMessages {
     GetHashedMessage(Uuid, String, u32, u32),
     Setup(ProgramId, String, Vec<CommsAddress>, u16),
     SubscribeToTransaction(Uuid, Txid, Option<u32>),
-    SubscribeToRskPegin(Option<u32>),
+    SubscribeToOutputPattern(OutputPatternFilter, Option<u32>),
     GetSPVProof(Txid),
     DispatchTransaction(Uuid, Transaction, Option<u32>),
     DispatchTransactionName(Uuid, String),
@@ -131,8 +132,8 @@ pub enum OutgoingBitVMXApiMessages {
     Pong(Uuid),
     // response for transaction get and dispatch
     Transaction(Uuid, TransactionStatus, Option<String>),
-    // Represents when pegin transactions is found
-    PeginTransactionFound(Txid, TransactionStatus),
+    // Represents when a transaction matching a generic output pattern is found
+    OutputPatternTransactionFound(Txid, TransactionStatus, Vec<u8>),
     // Represents when a spending utxo transaction is found
     SpendingUTXOTransactionFound(Uuid, Txid, u32, TransactionStatus),
     // Represents when a program is running out of funds
@@ -285,8 +286,8 @@ impl OutgoingBitVMXApiMessages {
         match self {
             OutgoingBitVMXApiMessages::Pong(_) => "Pong".to_string(),
             OutgoingBitVMXApiMessages::Transaction(_, _, _) => "Transaction".to_string(),
-            OutgoingBitVMXApiMessages::PeginTransactionFound(_, _) => {
-                "PeginTransactionFound".to_string()
+            OutgoingBitVMXApiMessages::OutputPatternTransactionFound(_, _, _) => {
+                "OutputPatternTransactionFound".to_string()
             }
             OutgoingBitVMXApiMessages::SpendingUTXOTransactionFound(_, _, _, _) => {
                 "SpendingUTXOTransactionFound".to_string()