14908012592

Committed 08 May 2025 01:44PM UTC coverage: 82.072% (+0.02%) from 82.057%

Build # 14908012592

Build Type

Pull #684

github

Committed by

web-flow

Commit Message

Merge 3c94839b7 into 7f2765642

Pull Request Pull Request #684: Add derive macros to cli config

Run Details

0 of 8 new or added lines in 1 file covered. (0.0%)

45 existing lines in 8 files now uncovered.

5475 of 6671 relevant lines covered (82.07%)

693.68 hits per line

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

81.52

/payjoin/src/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)]
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 {
    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",
                _ => (),
            }
        }

        match (max_additional_fee_contribution, additional_fee_output_index) {
            (Some(amount), Some(index)) =>
                params.additional_fee_contribution = Some((amount, index)),
            (Some(_), None) | (None, Some(_)) => {
                warn!("only one additional-fee parameter specified: {params:?}");
            }
            (None, None) => (),
        }

        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)]
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 {	43✔
27	Params {	43✔
28	v: Version::One,	43✔
29	output_substitution: OutputSubstitution::Enabled,	43✔
30	additional_fee_contribution: None,	43✔
31	min_fee_rate: FeeRate::BROADCAST_MIN,	43✔
32	#[cfg(feature = "_multiparty")]	43✔
33	optimistic_merge: false,	43✔
34	}	43✔
35	}	43✔
36	}
37
38	impl Params {
39	pub fn from_query_pairs<K, V, I>(	39✔
40	pairs: I,	39✔
41	supported_versions: &'static [Version],	39✔
42	) -> Result<Self, Error>	39✔
43	where	39✔
44	I: Iterator<Item = (K, V)>,	39✔
45	K: Borrow<str> + Into<String>,	39✔
46	V: Borrow<str> + Into<String>,	39✔
47	{	39✔
48	let mut params = Params::default();	39✔
49		39✔
50	let mut additional_fee_output_index = None;	39✔
51	let mut max_additional_fee_contribution = None;	39✔
52
53	for (key, v) in pairs {	145✔
54	match (key.borrow(), v.borrow()) {	107✔
55	("v", version) =>	107✔
56	params.v = match version {	29✔
57	"1" => Version::One,	29✔
58	"2" => Version::Two,	19✔
59	_ => return Err(Error::UnknownVersion { supported_versions }),	1✔
60	},
61	("additionalfeeoutputindex", index) =>	78✔
62	additional_fee_output_index = match index.parse::<usize>() {	21✔
63	Ok(index) => Some(index),	21✔
64	Err(_error) => {	×
UNCOV 65	warn!("bad `additionalfeeoutputindex` query value '{index}': {_error}");	×
UNCOV 66	None	×
67	}
68	},
69	("maxadditionalfeecontribution", fee) =>	57✔
70	max_additional_fee_contribution =	21✔
71	match bitcoin::Amount::from_str_in(fee, bitcoin::Denomination::Satoshi) {	21✔
72	Ok(contribution) => Some(contribution),	21✔
73	Err(_error) => {	×
UNCOV 74	warn!(	×
75	"bad `maxadditionalfeecontribution` query value '{fee}': {_error}"	×
76	);
UNCOV 77	None	×
78	}
79	},
80	("minfeerate", fee_rate) =>	36✔
81	params.min_fee_rate = match fee_rate.parse::<f32>() {	15✔
82	Ok(fee_rate_sat_per_vb) => {	15✔
83	// TODO Parse with serde when rust-bitcoin supports it	15✔
84	let fee_rate_sat_per_kwu = fee_rate_sat_per_vb * 250.0_f32;	15✔
85	// since it's a minimum, we want to round up	15✔
86	FeeRate::from_sat_per_kwu(fee_rate_sat_per_kwu.ceil() as u64)	15✔
87	}
UNCOV 88	Err(_) => return Err(Error::FeeRate),	×
89	},
90	("disableoutputsubstitution", v) =>	21✔
91	params.output_substitution = if v == "true" {	5✔
92	OutputSubstitution::Disabled	5✔
93	} else {
UNCOV 94	OutputSubstitution::Enabled	×
95	},
96	#[cfg(feature = "_multiparty")]
97	("optimisticmerge", v) => params.optimistic_merge = v == "true",	16✔
UNCOV 98	_ => (),	×
99	}
100	}
101
102	match (max_additional_fee_contribution, additional_fee_output_index) {	38✔
103	(Some(amount), Some(index)) =>	21✔
104	params.additional_fee_contribution = Some((amount, index)),	21✔
105	(Some(_), None) \| (None, Some(_)) => {
UNCOV 106	warn!("only one additional-fee parameter specified: {params:?}");	×
107	}
108	(None, None) => (),	17✔
109	}
110
111	log::debug!("parsed optional parameters: {params:?}");	38✔
112	Ok(params)	38✔
113	}	39✔
114	}
115
116	#[derive(Debug, PartialEq, Eq)]
117	pub(crate) enum Error {
118	UnknownVersion { supported_versions: &'static [Version] },
119	FeeRate,
120	}
121
122	impl fmt::Display for Error {
123	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {	×
124	match self {	×
UNCOV 125	Error::UnknownVersion { .. } => write!(f, "unknown version"),	×
126	Error::FeeRate => write!(f, "could not parse feerate"),	×
127	}
UNCOV 128	}	×
129	}
130
131	impl std::error::Error for Error {
UNCOV 132	fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { None }	×
133	}
134
135	#[cfg(test)]
136	pub(crate) mod test {
137	use bitcoin::{Amount, FeeRate};
138
139	use super::*;
140	use crate::receive::optional_parameters::Params;
141	use crate::Version;
142
143	#[test]
144	fn test_parse_params() {	1✔
145	let pairs = url::form_urlencoded::parse(b"&maxadditionalfeecontribution=182&additionalfeeoutputindex=0&minfeerate=2&disableoutputsubstitution=true&optimisticmerge=true");	1✔
146	let params = Params::from_query_pairs(pairs, &[Version::One])	1✔
147	.expect("Could not parse params from query pairs");	1✔
148	assert_eq!(params.v, Version::One);	1✔
149	assert_eq!(params.output_substitution, OutputSubstitution::Disabled);	1✔
150	assert_eq!(params.additional_fee_contribution, Some((Amount::from_sat(182), 0)));	1✔
151	assert_eq!(	1✔
152	params.min_fee_rate,	1✔
153	FeeRate::from_sat_per_vb(2).expect("Could not calculate feerate")	1✔
154	);	1✔
155	#[cfg(feature = "_multiparty")]
156	assert!(params.optimistic_merge)	1✔
157	}	1✔
158
159	#[test]
160	fn from_query_pairs_unsupported_versions() {	1✔
161	let invalid_pair: Vec<(&str, &str)> = vec![("v", "888")];	1✔
162	let supported_versions = &[Version::One, Version::Two];	1✔
163	let params = Params::from_query_pairs(invalid_pair.into_iter(), supported_versions);	1✔
164	assert!(params.is_err());	1✔
165	assert_eq!(params.err().unwrap(), Error::UnknownVersion { supported_versions });	1✔
166	}	1✔
167	}

payjoin / rust-payjoin / 14908012592

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