Remove ReceivedProposalPsbt infavor of session outcome (payjoin#1171)

Author: arminsabouri

payjoin-cli/src/app/v2/mod.rs

@@ -52,10 +52,9 @@ impl StatusText for SendSession {
         match self {
             SendSession::WithReplyKey(_) | SendSession::PollingForProposal(_) =>
                 "Waiting for proposal",
-            SendSession::ProposalReceived(_) => "Proposal received",
             SendSession::Closed(session_outcome) => match session_outcome {
                 SenderSessionOutcome::Failure => "Session failure",
-                SenderSessionOutcome::Success => "Session success",
+                SenderSessionOutcome::Success(_) => "Session success",
                 SenderSessionOutcome::Cancel => "Session cancelled",
             },
         }
@@ -461,7 +460,7 @@ impl App {
                 self.post_original_proposal(context, persister).await?,
             SendSession::PollingForProposal(context) =>
                 self.get_proposed_payjoin_psbt(context, persister).await?,
-            SendSession::ProposalReceived(proposal) => {
+            SendSession::Closed(SenderSessionOutcome::Success(proposal)) => {
                 self.process_pj_response(proposal)?;
                 return Ok(());
             }

payjoin-ffi/src/send/mod.rs

@@ -72,7 +72,6 @@ impl From<SenderSessionOutcome> for payjoin::send::v2::SessionOutcome {
 pub enum SendSession {
     WithReplyKey { inner: Arc<WithReplyKey> },
     PollingForProposal { inner: Arc<PollingForProposal> },
-    ProposalReceived { inner: Arc<Psbt> },
     Closed { inner: Arc<SenderSessionOutcome> },
 }
 
@@ -84,8 +83,6 @@ impl From<payjoin::send::v2::SendSession> for SendSession {
                 Self::WithReplyKey { inner: Arc::new(inner.into()) },
             SendSession::PollingForProposal(inner) =>
                 Self::PollingForProposal { inner: Arc::new(inner.into()) },
-            SendSession::ProposalReceived(inner) =>
-                Self::ProposalReceived { inner: Arc::new(inner.into()) },
             SendSession::Closed(session_outcome) =>
                 Self::Closed { inner: Arc::new(session_outcome.into()) },
         }

payjoin/src/core/send/v2/mod.rs

@@ -247,7 +247,6 @@ impl<State> Sender<State> {
 pub enum SendSession {
     WithReplyKey(Sender<WithReplyKey>),
     PollingForProposal(Sender<PollingForProposal>),
-    ProposalReceived(Psbt),
     Closed(SessionOutcome),
 }
 
@@ -265,8 +264,8 @@ impl SendSession {
                 Ok(state.apply_polling_for_proposal()),
             (
                 SendSession::PollingForProposal(_state),
-                SessionEvent::ReceivedProposalPsbt(proposal),
-            ) => Ok(SendSession::ProposalReceived(proposal)),
+                SessionEvent::Closed(SessionOutcome::Success(proposal)),
+            ) => Ok(SendSession::Closed(SessionOutcome::Success(proposal))),
             (_, SessionEvent::Closed(session_outcome)) => Ok(SendSession::Closed(session_outcome)),
             (current_state, event) => Err(InternalReplayError::InvalidEvent(
                 Box::new(event),
@@ -530,7 +529,7 @@ impl Sender<PollingForProposal> {
 
         MaybeSuccessTransitionWithNoResults::success(
             processed_proposal.clone(),
-            SessionEvent::ReceivedProposalPsbt(processed_proposal),
+            SessionEvent::Closed(SessionOutcome::Success(processed_proposal)),
         )
     }
 }

payjoin/src/core/send/v2/session.rs

@@ -85,7 +85,7 @@ impl SessionHistory {
 
         match self.events.last() {
             Some(SessionEvent::Closed(outcome)) => match outcome {
-                SessionOutcome::Success => SessionStatus::Completed,
+                SessionOutcome::Success(_) => SessionStatus::Completed,
                 SessionOutcome::Failure | SessionOutcome::Cancel => SessionStatus::Failed,
             },
             _ => SessionStatus::Active,
@@ -109,8 +109,6 @@ pub enum SessionEvent {
     Created(Box<SessionContext>),
     /// Sender POSTed the Original PSBT and is waiting to receive a Proposal PSBT
     PostedOriginalPsbt(),
-    /// Sender received a Proposal PSBT
-    ReceivedProposalPsbt(bitcoin::Psbt),
     /// Closed successful or failed session
     Closed(SessionOutcome),
 }
@@ -119,7 +117,7 @@ pub enum SessionEvent {
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
 pub enum SessionOutcome {
     /// Successful payjoin
-    Success,
+    Success(bitcoin::Psbt),
     /// Payjoin failed to complete due to a counterparty deviation from the protocol
     Failure,
     /// Payjoin was cancelled by the user
@@ -178,8 +176,7 @@ mod tests {
         let test_cases = vec![
             SessionEvent::Created(Box::new(sender_with_reply_key.session_context.clone())),
             SessionEvent::PostedOriginalPsbt(),
-            SessionEvent::ReceivedProposalPsbt(PARSED_ORIGINAL_PSBT.clone()),
-            SessionEvent::Closed(SessionOutcome::Success),
+            SessionEvent::Closed(SessionOutcome::Success(PARSED_ORIGINAL_PSBT.clone())),
             SessionEvent::Closed(SessionOutcome::Failure),
             SessionEvent::Closed(SessionOutcome::Cancel),
         ];
@@ -353,7 +350,7 @@ mod tests {
 
         let events = vec![
             SessionEvent::Created(Box::new(with_reply_key.session_context.clone())),
-            SessionEvent::Closed(SessionOutcome::Success),
+            SessionEvent::Closed(SessionOutcome::Success(PARSED_ORIGINAL_PSBT.clone())),
         ];
 
         let session = SessionHistory { events };