Track pending payjoin transactions

Both sender original PSBT and payjoin proposal PSBT are tracked as pending.
Only the one that confirms proceeds to live in the wallet forever.

Author: DanGould

mutiny-core/src/lib.rs

@@ -1518,7 +1518,7 @@ impl<S: MutinyStorage> MutinyWallet<S> {
                 let session = self
                     .node_manager
                     .storage
-                    .persist_payjoin(enrolled.clone())?;
+                    .persist_enrolled(enrolled.clone())?;
                 let pj_uri = session.enrolled.fallback_target();
                 self.node_manager.spawn_payjoin_receiver(session);
                 let ohttp = base64::encode_config(

mutiny-core/src/nodemanager.rs

@@ -767,7 +767,16 @@ impl<S: MutinyStorage> NodeManager<S> {
             .map_err(|_| MutinyError::IncorrectNetwork)?;
         let address = uri.address.clone();
         let original_psbt = self.wallet.create_signed_psbt(address, amount, fee_rate)?;
-        // TODO ensure this creates a pending tx in the UI.  Ensure locked UTXO.
+        // Track this transaction in the wallet so it shows as an ActivityItem in UI.
+        // We'll cancel it if and when this original_psbt fallback is replaced with a received payjoin.
+        self.wallet
+            .insert_tx(
+                original_psbt.clone().extract_tx(),
+                ConfirmationTime::unconfirmed(crate::utils::now().as_secs()),
+                None,
+            )
+            .await?;
+
         let fee_rate = if let Some(rate) = fee_rate {
             FeeRate::from_sat_per_vb(rate)
         } else {
@@ -798,6 +807,7 @@ impl<S: MutinyStorage> NodeManager<S> {
             let proposal_psbt = match Self::poll_payjoin_sender(stop, req_ctx).await {
                 Ok(psbt) => psbt,
                 Err(e) => {
+                    // self.wallet cancel_tx
                     log_error!(logger, "Error polling payjoin sender: {e}");
                     return;
                 }
@@ -867,11 +877,13 @@ impl<S: MutinyStorage> NodeManager<S> {
         labels: Vec<String>,
     ) -> Result<Txid, MutinyError> {
         log_debug!(logger, "Sending payjoin..");
+        let original_tx = original_psbt.clone().extract_tx();
         let tx = wallet
             .send_payjoin(original_psbt, proposal_psbt, labels)
             .await?;
         let txid = tx.txid();
         wallet.broadcast_transaction(tx).await?;
+        wallet.cancel_tx(&original_tx)?;
         log_info!(logger, "Payjoin broadcast! TXID: {txid}");
         Ok(txid)
     }
@@ -899,12 +911,18 @@ impl<S: MutinyStorage> NodeManager<S> {
         let http_client = reqwest::Client::builder()
             .build()
             .map_err(PayjoinError::Reqwest)?;
-        let proposal: payjoin::receive::v2::UncheckedProposal =
-            Self::poll_for_fallback_psbt(stop, storage, &http_client, &mut session)
-                .await
-                .map_err(|e| PayjoinError::ReceiverStateMachine(e.to_string()))?;
+        let proposal: payjoin::receive::v2::UncheckedProposal = Self::poll_for_fallback_psbt(
+            stop,
+            wallet.clone(),
+            storage.clone(),
+            &http_client,
+            &mut session,
+        )
+        .await
+        .map_err(|e| PayjoinError::ReceiverStateMachine(e.to_string()))?;
         let mut payjoin_proposal = wallet
             .process_payjoin_proposal(proposal)
+            .await
             .map_err(|e| PayjoinError::ReceiverStateMachine(e.to_string()))?;
 
         let (req, ohttp_ctx) = payjoin_proposal
@@ -922,11 +940,23 @@ impl<S: MutinyStorage> NodeManager<S> {
         let _res = payjoin_proposal
             .deserialize_res(res.to_vec(), ohttp_ctx)
             .map_err(|e| PayjoinError::ReceiverStateMachine(e.to_string()))?;
-        Ok(payjoin_proposal.psbt().clone().extract_tx().txid())
+        let payjoin_tx = payjoin_proposal.psbt().clone().extract_tx();
+        let payjoin_txid = payjoin_tx.txid();
+        wallet
+            .insert_tx(
+                payjoin_tx.clone(),
+                ConfirmationTime::unconfirmed(utils::now().as_secs()),
+                None,
+            )
+            .await?;
+        session.payjoin_tx = Some(payjoin_tx);
+        storage.update_session(session)?;
+        Ok(payjoin_txid)
     }
 
     async fn poll_for_fallback_psbt(
         stop: Arc<AtomicBool>,
+        wallet: Arc<OnChainWallet<S>>,
         storage: Arc<S>,
         client: &reqwest::Client,
         session: &mut crate::payjoin::Session,
@@ -937,6 +967,11 @@ impl<S: MutinyStorage> NodeManager<S> {
             }
 
             if session.expiry < utils::now() {
+                if let Some(payjoin_tx) = &session.payjoin_tx {
+                    wallet
+                        .cancel_tx(payjoin_tx)
+                        .map_err(|_| crate::payjoin::Error::CancelPayjoinTx)?;
+                }
                 let _ = storage.delete_payjoin(&session.enrolled.pubkey());
                 return Err(crate::payjoin::Error::SessionExpired);
             }

mutiny-core/src/onchain.rs

@@ -355,6 +355,12 @@ impl<S: MutinyStorage> OnChainWallet<S> {
         Ok(())
     }
 
+    pub(crate) fn cancel_tx(&self, tx: &Transaction) -> Result<(), MutinyError> {
+        let mut wallet = self.wallet.try_write()?;
+        wallet.cancel_tx(tx);
+        Ok(())
+    }
+
     fn is_mine(&self, script: &Script) -> Result<bool, MutinyError> {
         Ok(self.wallet.try_read()?.is_mine(script))
     }
@@ -363,7 +369,7 @@ impl<S: MutinyStorage> OnChainWallet<S> {
         Ok(self.wallet.try_read()?.list_unspent().collect())
     }
 
-    pub fn process_payjoin_proposal(
+    pub async fn process_payjoin_proposal(
         &self,
         proposal: payjoin::receive::v2::UncheckedProposal,
     ) -> Result<payjoin::receive::v2::PayjoinProposal, payjoin::Error> {
@@ -407,21 +413,26 @@ impl<S: MutinyStorage> OnChainWallet<S> {
         let payjoin_proposal = provisional_payjoin.finalize_proposal(
             |psbt| {
                 let mut psbt = psbt.clone();
-                let wallet = self
-                    .wallet
-                    .try_read()
-                    .map_err(|_| Error::Server(MutinyError::WalletSigningFailed.into()))?;
-                wallet
+                self.wallet
+                    .try_write()
+                    .map_err(|_| Error::Server(MutinyError::WalletSigningFailed.into()))?
                     .sign(&mut psbt, SignOptions::default())
                     .map_err(|_| Error::Server(MutinyError::WalletSigningFailed.into()))?;
                 Ok(psbt)
             },
             Some(min_pj_fee_rate),
         )?;
-        let payjoin_proposal_psbt = payjoin_proposal.psbt();
+        let payjoin_psbt_tx = payjoin_proposal.psbt().clone().extract_tx();
+        self.insert_tx(
+            payjoin_psbt_tx,
+            ConfirmationTime::unconfirmed(crate::utils::now().as_secs()),
+            None,
+        )
+        .await
+        .map_err(|_| Error::Server(MutinyError::WalletOperationFailed.into()))?;
         log::debug!(
             "Receiver's Payjoin proposal PSBT Rsponse: {:#?}",
-            payjoin_proposal_psbt
+            payjoin_proposal.psbt()
         );
         Ok(payjoin_proposal)
     }

mutiny-core/src/payjoin.rs

@@ -2,6 +2,7 @@ use std::collections::HashMap;
 
 use crate::error::MutinyError;
 use crate::storage::MutinyStorage;
+use bitcoin::Transaction;
 use core::time::Duration;
 use hex_conservative::DisplayHex;
 use once_cell::sync::Lazy;
@@ -22,6 +23,7 @@ pub(crate) static PAYJOIN_DIR: Lazy<Url> =
 pub struct Session {
     pub enrolled: Enrolled,
     pub expiry: Duration,
+    pub payjoin_tx: Option<Transaction>,
 }
 
 impl Session {
@@ -32,7 +34,8 @@ impl Session {
 pub trait PayjoinStorage {
     fn get_payjoin(&self, id: &[u8; 33]) -> Result<Option<Session>, MutinyError>;
     fn get_payjoins(&self) -> Result<Vec<Session>, MutinyError>;
-    fn persist_payjoin(&self, session: Enrolled) -> Result<Session, MutinyError>;
+    fn persist_enrolled(&self, session: Enrolled) -> Result<Session, MutinyError>;
+    fn update_session(&self, session: Session) -> Result<(), MutinyError>;
     fn delete_payjoin(&self, id: &[u8; 33]) -> Result<(), MutinyError>;
 }
 
@@ -53,16 +56,21 @@ impl<S: MutinyStorage> PayjoinStorage for S {
         Ok(map.values().map(|v| v.to_owned()).collect())
     }
 
-    fn persist_payjoin(&self, enrolled: Enrolled) -> Result<Session, MutinyError> {
+    fn persist_enrolled(&self, enrolled: Enrolled) -> Result<Session, MutinyError> {
         let in_24_hours = crate::utils::now() + Duration::from_secs(60 * 60 * 24);
         let session = Session {
             enrolled,
             expiry: in_24_hours,
+            payjoin_tx: None,
         };
         self.set_data(get_payjoin_key(&session.pubkey()), session.clone(), None)
             .map(|_| session)
     }
 
+    fn update_session(&self, session: Session) -> Result<(), MutinyError> {
+        self.set_data(get_payjoin_key(&session.pubkey()), session, None)
+    }
+
     fn delete_payjoin(&self, id: &[u8; 33]) -> Result<(), MutinyError> {
         self.delete(&[get_payjoin_key(id)])
     }
@@ -88,6 +96,10 @@ pub enum Error {
     OhttpDecodeFailed,
     Shutdown,
     SessionExpired,
+    BadDirectoryHost,
+    BadOhttpWsHost,
+    RequestFailed(String),
+    CancelPayjoinTx,
 }
 
 impl std::error::Error for Error {}
@@ -101,6 +113,10 @@ impl std::fmt::Display for Error {
             Error::OhttpDecodeFailed => write!(f, "Failed to decode ohttp keys"),
             Error::Shutdown => write!(f, "Payjoin stopped by application shutdown"),
             Error::SessionExpired => write!(f, "Payjoin session expired. Create a new payment request and have the sender try again."),
+            Error::BadDirectoryHost => write!(f, "Bad directory host"),
+            Error::BadOhttpWsHost => write!(f, "Bad ohttp ws host"),
+            Error::RequestFailed(e) => write!(f, "Request failed: {}", e),
+            Error::CancelPayjoinTx => write!(f, "Failed to cancel payjoin tx in wallet"),
         }
     }
 }