Cleanup comments and fix doc links

Author: spacebear21

payjoin-cli/src/app/v1.rs

@@ -319,7 +319,7 @@ impl App {
             }
         })?;
         log::trace!("check2");
-        // Receive Check 3: receiver can't sign for proposal inputs
+        // Receive Check 3: no mixed input scripts
         let proposal = proposal.check_no_mixed_input_scripts()?;
         log::trace!("check3");
 

payjoin-cli/src/app/v2.rs

@@ -306,7 +306,7 @@ impl App {
             }
         })?;
         log::trace!("check2");
-        // Receive Check 3: receiver can't sign for proposal inputs
+        // Receive Check 3: no mixed input scripts
         let proposal = proposal.check_no_mixed_input_scripts()?;
         log::trace!("check3");
 

payjoin/src/receive/mod.rs

@@ -165,7 +165,7 @@ impl UncheckedProposal {
 
 /// Typestate to validate that the Original PSBT has no receiver-owned inputs.
 ///
-/// Call [`check_no_receiver_owned_inputs()`](struct.UncheckedProposal.html#method.check_no_receiver_owned_inputs) to proceed.
+/// Call [`Self::check_inputs_not_owned`] to proceed.
 #[derive(Clone)]
 pub struct MaybeInputsOwned {
     psbt: Psbt,
@@ -208,8 +208,9 @@ impl MaybeInputsOwned {
 }
 
 /// Typestate to validate that the Original PSBT has no mixed input types.
+/// This check is skipped in payjoin v2.
 ///
-/// Call [`check_no_mixed_input_types`](struct.UncheckedProposal.html#method.check_no_mixed_input_scripts) to proceed.
+/// Call [`Self::check_no_mixed_input_scripts`] to proceed.
 #[derive(Clone)]
 pub struct MaybeMixedInputScripts {
     psbt: Psbt,
@@ -261,7 +262,7 @@ impl MaybeMixedInputScripts {
 
 /// Typestate to validate that the Original PSBT has no inputs that have been seen before.
 ///
-/// Call [`check_no_inputs_seen`](struct.MaybeInputsSeen.html#method.check_no_inputs_seen_before) to proceed.
+/// Call [`Self::check_no_inputs_seen_before`] to proceed.
 #[derive(Clone)]
 pub struct MaybeInputsSeen {
     psbt: Psbt,
@@ -295,7 +296,7 @@ impl MaybeInputsSeen {
 /// The receiver has not yet identified which outputs belong to the receiver.
 ///
 /// Only accept PSBTs that send us money.
-/// Identify those outputs with `identify_receiver_outputs()` to proceed
+/// Identify those outputs with [`Self::identify_receiver_outputs`] to proceed.
 #[derive(Clone)]
 pub struct OutputsUnknown {
     psbt: Psbt,
@@ -345,6 +346,8 @@ impl OutputsUnknown {
 }
 
 /// A checked proposal that the receiver may substitute or add outputs to
+///
+/// Call [`Self::commit_outputs`] to proceed.
 #[derive(Debug, Clone)]
 pub struct WantsOutputs {
     original_psbt: Psbt,
@@ -486,6 +489,8 @@ fn interleave_shuffle<T: Clone, R: rand::Rng>(
 }
 
 /// A checked proposal that the receiver may contribute inputs to to make a payjoin
+///
+/// Call [`Self::commit_inputs`] to proceed.
 #[derive(Debug, Clone)]
 pub struct WantsInputs {
     original_psbt: Psbt,
@@ -658,6 +663,8 @@ impl WantsInputs {
 
 /// A checked proposal that the receiver may sign and finalize to make a proposal PSBT that the
 /// sender will accept.
+///
+/// Call [`Self::finalize_proposal`] to return a finalized [`PayjoinProposal`].
 #[derive(Debug, Clone)]
 pub struct ProvisionalProposal {
     original_psbt: Psbt,
@@ -861,7 +868,8 @@ impl ProvisionalProposal {
     }
 }
 
-/// A mutable checked proposal that the receiver may contribute inputs to to make a payjoin.
+/// A finalized payjoin proposal, complete with fees and receiver signatures, that the sender
+/// should find acceptable.
 #[derive(Clone)]
 pub struct PayjoinProposal {
     payjoin_psbt: Psbt,

payjoin/src/send/mod.rs

@@ -9,11 +9,9 @@
 //! 2. Construct URI request parameters, a finalized “Original PSBT” paying .amount to .address
 //! 3. (optional) Spawn a thread or async task that will broadcast the original PSBT fallback after
 //!    delay (e.g. 1 minute) unless canceled
-//! 4. Construct the request using [`RequestBuilder`](crate::send::RequestBuilder) with the PSBT
-//!    and payjoin uri
+//! 4. Construct the request using [`RequestBuilder`] with the PSBT and payjoin uri
 //! 5. Send the request and receive response
-//! 6. Process the response with
-//!    [`Context::process_response()`](crate::send::Context::process_response())
+//! 6. Process the response with [`ContextV1::process_response`]
 //! 7. Sign and finalize the Payjoin Proposal PSBT
 //! 8. Broadcast the Payjoin Transaction (and cancel the optional fallback broadcast)
 //!
@@ -34,7 +32,7 @@ pub(crate) use error::{InternalCreateRequestError, InternalValidationError};
 use serde::{Deserialize, Serialize};
 use url::Url;
 
-use crate::psbt::{InputPair, PsbtExt};
+use crate::psbt::PsbtExt;
 use crate::request::Request;
 #[cfg(feature = "v2")]
 use crate::v2::{HpkePublicKey, HpkeSecretKey};
@@ -123,7 +121,7 @@ impl<'a> RequestBuilder<'a> {
             .find(|(_, txo)| payout_scripts.all(|script| script != txo.script_pubkey))
             .map(|(i, txo)| (i, txo.value))
         {
-            let mut input_pairs = self.psbt.input_pairs().collect::<Vec<InputPair>>().into_iter();
+            let mut input_pairs = self.psbt.input_pairs();
             let first_input_pair =
                 input_pairs.next().ok_or(InternalCreateRequestError::NoInputs)?;
             let mut input_weight = first_input_pair
@@ -370,8 +368,8 @@ impl RequestContext {
 
 /// Data required for validation of response.
 ///
-/// This type is used to process the response. Get it from [`RequestBuilder`](crate::send::RequestBuilder)'s build methods.
-/// Then you only need to call [`.process_response()`](crate::send::Context::process_response()) on it to continue BIP78 flow.
+/// This type is used to process the response. Get it from [`RequestBuilder`]'s build methods.
+/// Then you only need to call [`Self::process_response`] on it to continue BIP78 flow.
 #[derive(Debug, Clone)]
 pub struct ContextV1 {
     original_psbt: Psbt,

payjoin/tests/integration.rs

@@ -860,7 +860,7 @@ mod integration {
                 })
                 .expect("Receiver should not own any of the inputs");
 
-            // Receive Check 3: receiver can't sign for proposal inputs
+            // Receive Check 3: no mixed input scripts
             let proposal = proposal.check_no_mixed_input_scripts().unwrap();
 
             // Receive Check 4: have we seen this input before? More of a check for non-interactive i.e. payment processor receivers.
@@ -1301,7 +1301,7 @@ mod integration {
             })
             .expect("Receiver should not own any of the inputs");
 
-        // Receive Check 3: receiver can't sign for proposal inputs
+        // Receive Check 3: no mixed input scripts
         let proposal = proposal.check_no_mixed_input_scripts().unwrap();
 
         // Receive Check 4: have we seen this input before? More of a check for non-interactive i.e. payment processor receivers.