16130228730

Committed 07 Jul 2025 11:38PM UTC coverage: 85.319% (+0.4%) from 84.896%

Build # 16130228730

Build Type

Pull #852

github

Committed by

web-flow

Commit Message

Merge 11c576839 into 25acd561b

Pull Request Pull Request #852: Fragment parameter fixes

Run Details

94 of 106 new or added lines in 2 files covered. (88.68%)

76 existing lines in 5 files now uncovered.

7456 of 8739 relevant lines covered (85.32%)

535.95 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.11

/payjoin/src/core/receive/optional_parameters.rs

use std::borrow::Borrow;
use std::fmt;

use bitcoin::FeeRate;
use log::warn;

use crate::output_substitution::OutputSubstitution;
use crate::Version;

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
pub(crate) struct Params {
    // version
    pub v: Version,
    // disableoutputsubstitution
    pub output_substitution: OutputSubstitution,
    // maxadditionalfeecontribution, additionalfeeoutputindex
    pub additional_fee_contribution: Option<(bitcoin::Amount, usize)>,
    // minfeerate
    pub min_fee_rate: FeeRate,
    #[cfg(feature = "_multiparty")]
    /// Opt in to optimistic psbt merge
    pub optimistic_merge: bool,
}

impl Default for Params {
    fn default() -> Self {
        Params {
            v: Version::One,
            output_substitution: OutputSubstitution::Enabled,
            additional_fee_contribution: None,
            min_fee_rate: FeeRate::BROADCAST_MIN,
            #[cfg(feature = "_multiparty")]
            optimistic_merge: false,
        }
    }
}

impl Params {
    /// Warn when only one parameter is present rather than failing the entire payjoin process.
    ///
    /// This allows for graceful degradation and doesn't halt the payjoin process
    /// due to incomplete optional parameters, while still alerting about the unusual
    /// configuration that prevents fee adjustment capability.
    fn handle_additonal_fee_param(
        &mut self,
        max_additional_fee_contribution: Option<bitcoin::Amount>,
        additional_fee_output_index: Option<usize>,
    ) {
        match (max_additional_fee_contribution, additional_fee_output_index) {
            (Some(amount), Some(index)) => {
                self.additional_fee_contribution = Some((amount, index));
            }
            (Some(_), None) | (None, Some(_)) => {
                warn!("Only one additional fee parameter specified, proceeding without fee adjustment capability. Both maxadditionalfeecontribution and additionalfeeoutputindex must be present for receiver to alter sender's output: {self:?}");
            }
            (None, None) => (), // Neither parameter provided, normal case
        }
    }

    pub fn from_query_pairs<K, V, I>(
        pairs: I,
        supported_versions: &'static [Version],
    ) -> Result<Self, Error>
    where
        I: Iterator<Item = (K, V)>,
        K: Borrow<str> + Into<String>,
        V: Borrow<str> + Into<String>,
    {
        let mut params = Params::default();

        let mut additional_fee_output_index = None;
        let mut max_additional_fee_contribution = None;

        for (key, v) in pairs {
            match (key.borrow(), v.borrow()) {
                ("v", version) =>
                    params.v = match version {
                        "1" => Version::One,
                        "2" => Version::Two,
                        _ => return Err(Error::UnknownVersion { supported_versions }),
                    },
                ("additionalfeeoutputindex", index) =>
                    additional_fee_output_index = match index.parse::<usize>() {
                        Ok(index) => Some(index),
                        Err(_error) => {
                            warn!("bad `additionalfeeoutputindex` query value '{index}': {_error}");
                            None
                        }
                    },
                ("maxadditionalfeecontribution", fee) =>
                    max_additional_fee_contribution =
                        match bitcoin::Amount::from_str_in(fee, bitcoin::Denomination::Satoshi) {
                            Ok(contribution) => Some(contribution),
                            Err(_error) => {
                                warn!(
                                "bad `maxadditionalfeecontribution` query value '{fee}': {_error}"
                            );
                                None
                            }
                        },
                ("minfeerate", fee_rate) =>
                    params.min_fee_rate = match fee_rate.parse::<f32>() {
                        Ok(fee_rate_sat_per_vb) => {
                            // TODO Parse with serde when rust-bitcoin supports it
                            let fee_rate_sat_per_kwu = fee_rate_sat_per_vb * 250.0_f32;
                            // since it's a minimum, we want to round up
                            FeeRate::from_sat_per_kwu(fee_rate_sat_per_kwu.ceil() as u64)
                        }
                        Err(_) => return Err(Error::FeeRate),
                    },
                ("disableoutputsubstitution", v) =>
                    params.output_substitution = if v == "true" {
                        OutputSubstitution::Disabled
                    } else {
                        OutputSubstitution::Enabled
                    },
                #[cfg(feature = "_multiparty")]
                ("optimisticmerge", v) => params.optimistic_merge = v == "true",
                _ => (),
            }
        }

        params.handle_additonal_fee_param(
            max_additional_fee_contribution,
            additional_fee_output_index,
        );

        log::debug!("parsed optional parameters: {params:?}");
        Ok(params)
    }
}

#[derive(Debug, PartialEq, Eq)]
pub(crate) enum Error {
    UnknownVersion { supported_versions: &'static [Version] },
    FeeRate,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Error::UnknownVersion { .. } => write!(f, "unknown version"),
            Error::FeeRate => write!(f, "could not parse feerate"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { None }
}

#[cfg(test)]
pub(crate) mod test {
    use bitcoin::{Amount, FeeRate};

    use super::*;
    use crate::receive::optional_parameters::Params;
    use crate::Version;

    #[test]
    fn test_parse_params() {
        let pairs = url::form_urlencoded::parse(b"&maxadditionalfeecontribution=182&additionalfeeoutputindex=0&minfeerate=2&disableoutputsubstitution=true&optimisticmerge=true");
        let params = Params::from_query_pairs(pairs, &[Version::One])
            .expect("Could not parse params from query pairs");
        assert_eq!(params.v, Version::One);
        assert_eq!(params.output_substitution, OutputSubstitution::Disabled);
        assert_eq!(params.additional_fee_contribution, Some((Amount::from_sat(182), 0)));
        assert_eq!(
            params.min_fee_rate,
            FeeRate::from_sat_per_vb(2).expect("Could not calculate feerate")
        );
        #[cfg(feature = "_multiparty")]
        assert!(params.optimistic_merge)
    }

    #[test]
    fn from_query_pairs_unsupported_versions() {
        let invalid_pair: Vec<(&str, &str)> = vec![("v", "888")];
        let supported_versions = &[Version::One, Version::Two];
        let params = Params::from_query_pairs(invalid_pair.into_iter(), supported_versions);
        assert!(params.is_err());
        assert_eq!(params.err().unwrap(), Error::UnknownVersion { supported_versions });
    }
}

1	use std::borrow::Borrow;
2	use std::fmt;
3
4	use bitcoin::FeeRate;
5	use log::warn;
6
7	use crate::output_substitution::OutputSubstitution;
8	use crate::Version;
9
10	#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
11	pub(crate) struct Params {
12	// version
13	pub v: Version,
14	// disableoutputsubstitution
15	pub output_substitution: OutputSubstitution,
16	// maxadditionalfeecontribution, additionalfeeoutputindex
17	pub additional_fee_contribution: Option<(bitcoin::Amount, usize)>,
18	// minfeerate
19	pub min_fee_rate: FeeRate,
20	#[cfg(feature = "_multiparty")]
21	/// Opt in to optimistic psbt merge
22	pub optimistic_merge: bool,
23	}
24
25	impl Default for Params {
26	fn default() -> Self {	59✔
27	Params {	59✔
28	v: Version::One,	59✔
29	output_substitution: OutputSubstitution::Enabled,	59✔
30	additional_fee_contribution: None,	59✔
31	min_fee_rate: FeeRate::BROADCAST_MIN,	59✔
32	#[cfg(feature = "_multiparty")]	59✔
33	optimistic_merge: false,	59✔
34	}	59✔
35	}	59✔
36	}
37
38	impl Params {
39	/// Warn when only one parameter is present rather than failing the entire payjoin process.
40	///
41	/// This allows for graceful degradation and doesn't halt the payjoin process
42	/// due to incomplete optional parameters, while still alerting about the unusual
43	/// configuration that prevents fee adjustment capability.
44	fn handle_additonal_fee_param(	54✔
45	&mut self,	54✔
46	max_additional_fee_contribution: Option<bitcoin::Amount>,	54✔
47	additional_fee_output_index: Option<usize>,	54✔
48	) {	54✔
49	match (max_additional_fee_contribution, additional_fee_output_index) {	54✔
50	(Some(amount), Some(index)) => {	37✔
51	self.additional_fee_contribution = Some((amount, index));	37✔
52	}	37✔
53	(Some(_), None) \| (None, Some(_)) => {
UNCOV 54	warn!("Only one additional fee parameter specified, proceeding without fee adjustment capability. Both maxadditionalfeecontribution and additionalfeeoutputindex must be present for receiver to alter sender's output: {self:?}");	×
55	}
56	(None, None) => (), // Neither parameter provided, normal case	17✔
57	}
58	}	54✔
59
60	pub fn from_query_pairs<K, V, I>(	55✔
61	pairs: I,	55✔
62	supported_versions: &'static [Version],	55✔
63	) -> Result<Self, Error>	55✔
64	where	55✔
65	I: Iterator<Item = (K, V)>,	55✔
66	K: Borrow<str> + Into<String>,	55✔
67	V: Borrow<str> + Into<String>,	55✔
68	{
69	let mut params = Params::default();	55✔
70
71	let mut additional_fee_output_index = None;	55✔
72	let mut max_additional_fee_contribution = None;	55✔
73
74	for (key, v) in pairs {	193✔
75	match (key.borrow(), v.borrow()) {	139✔
76	("v", version) =>	139✔
77	params.v = match version {	29✔
78	"1" => Version::One,	29✔
79	"2" => Version::Two,	19✔
80	_ => return Err(Error::UnknownVersion { supported_versions }),	1✔
81	},
82	("additionalfeeoutputindex", index) =>	110✔
83	additional_fee_output_index = match index.parse::<usize>() {	37✔
84	Ok(index) => Some(index),	37✔
UNCOV 85	Err(_error) => {	×
UNCOV 86	warn!("bad `additionalfeeoutputindex` query value '{index}': {_error}");	×
UNCOV 87	None	×
88	}
89	},
90	("maxadditionalfeecontribution", fee) =>	73✔
91	max_additional_fee_contribution =
92	match bitcoin::Amount::from_str_in(fee, bitcoin::Denomination::Satoshi) {	37✔
93	Ok(contribution) => Some(contribution),	37✔
94	Err(_error) => {	×
UNCOV 95	warn!(	×
UNCOV 96	"bad `maxadditionalfeecontribution` query value '{fee}': {_error}"	×
97	);
98	None	×
99	}
100	},
101	("minfeerate", fee_rate) =>	36✔
102	params.min_fee_rate = match fee_rate.parse::<f32>() {	15✔
103	Ok(fee_rate_sat_per_vb) => {	15✔
104	// TODO Parse with serde when rust-bitcoin supports it
105	let fee_rate_sat_per_kwu = fee_rate_sat_per_vb * 250.0_f32;	15✔
106	// since it's a minimum, we want to round up
107	FeeRate::from_sat_per_kwu(fee_rate_sat_per_kwu.ceil() as u64)	15✔
108	}
UNCOV 109	Err(_) => return Err(Error::FeeRate),	×
110	},
111	("disableoutputsubstitution", v) =>	21✔
112	params.output_substitution = if v == "true" {	5✔
113	OutputSubstitution::Disabled	5✔
114	} else {
UNCOV 115	OutputSubstitution::Enabled	×
116	},
117	#[cfg(feature = "_multiparty")]
118	("optimisticmerge", v) => params.optimistic_merge = v == "true",	16✔
UNCOV 119	_ => (),	×
120	}
121	}
122
123	params.handle_additonal_fee_param(	54✔
124	max_additional_fee_contribution,	54✔
125	additional_fee_output_index,	54✔
126	);
127
128	log::debug!("parsed optional parameters: {params:?}");	54✔
129	Ok(params)	54✔
130	}	55✔
131	}
132
133	#[derive(Debug, PartialEq, Eq)]
134	pub(crate) enum Error {
135	UnknownVersion { supported_versions: &'static [Version] },
136	FeeRate,
137	}
138
139	impl fmt::Display for Error {
UNCOV 140	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {	×
UNCOV 141	match self {	×
UNCOV 142	Error::UnknownVersion { .. } => write!(f, "unknown version"),	×
UNCOV 143	Error::FeeRate => write!(f, "could not parse feerate"),	×
144	}
UNCOV 145	}	×
146	}
147
148	impl std::error::Error for Error {
UNCOV 149	fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { None }	×
150	}
151
152	#[cfg(test)]
153	pub(crate) mod test {
154	use bitcoin::{Amount, FeeRate};
155
156	use super::*;
157	use crate::receive::optional_parameters::Params;
158	use crate::Version;
159
160	#[test]
161	fn test_parse_params() {	1✔
162	let pairs = url::form_urlencoded::parse(b"&maxadditionalfeecontribution=182&additionalfeeoutputindex=0&minfeerate=2&disableoutputsubstitution=true&optimisticmerge=true");	1✔
163	let params = Params::from_query_pairs(pairs, &[Version::One])	1✔
164	.expect("Could not parse params from query pairs");	1✔
165	assert_eq!(params.v, Version::One);	1✔
166	assert_eq!(params.output_substitution, OutputSubstitution::Disabled);	1✔
167	assert_eq!(params.additional_fee_contribution, Some((Amount::from_sat(182), 0)));	1✔
168	assert_eq!(	1✔
169	params.min_fee_rate,
170	FeeRate::from_sat_per_vb(2).expect("Could not calculate feerate")	1✔
171	);
172	#[cfg(feature = "_multiparty")]
173	assert!(params.optimistic_merge)	1✔
174	}	1✔
175
176	#[test]
177	fn from_query_pairs_unsupported_versions() {	1✔
178	let invalid_pair: Vec<(&str, &str)> = vec![("v", "888")];	1✔
179	let supported_versions = &[Version::One, Version::Two];	1✔
180	let params = Params::from_query_pairs(invalid_pair.into_iter(), supported_versions);	1✔
181	assert!(params.is_err());	1✔
182	assert_eq!(params.err().unwrap(), Error::UnknownVersion { supported_versions });	1✔
183	}	1✔
184	}

payjoin / rust-payjoin / 16130228730

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous