• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

payjoin / rust-payjoin / 13350991407

16 Feb 2025 02:43AM UTC coverage: 79.468% (+0.2%) from 79.269%
13350991407

Pull #538

github

web-flow
Merge 0e46f80b5 into 2627ef20f
Pull Request #538: Make payjoin-cli v1 / v2 features additive

363 of 422 new or added lines in 6 files covered. (86.02%)

2 existing lines in 1 file now uncovered.

4122 of 5187 relevant lines covered (79.47%)

887.41 hits per line

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

76.23
/payjoin-cli/src/app/v2.rs
1
use std::sync::Arc;
2

3
use anyhow::{anyhow, Context, Result};
4
use payjoin::bitcoin::consensus::encode::serialize_hex;
5
use payjoin::bitcoin::psbt::Psbt;
6
use payjoin::bitcoin::{Amount, FeeRate};
7
use payjoin::receive::v2::{Receiver, UncheckedProposal};
8
use payjoin::receive::{Error, ReplyableError};
9
use payjoin::send::v2::{Sender, SenderBuilder};
10
use payjoin::Uri;
11
use tokio::sync::watch;
12

13
use super::config::Config;
14
use super::wallet::BitcoindWallet;
15
use super::App as AppTrait;
16
use crate::app::{handle_interrupt, http_agent};
17
use crate::db::Database;
18

19
#[derive(Clone)]
20
pub(crate) struct App {
21
    config: Config,
22
    db: Arc<Database>,
23
    wallet: BitcoindWallet,
24
    interrupt: watch::Receiver<()>,
25
}
26

27
#[async_trait::async_trait]
28
impl AppTrait for App {
29
    fn new(config: Config) -> Result<Self> {
4✔
30
        let db = Arc::new(Database::create(&config.db_path)?);
4✔
31
        let (interrupt_tx, interrupt_rx) = watch::channel(());
4✔
32
        tokio::spawn(handle_interrupt(interrupt_tx));
4✔
33
        let wallet = BitcoindWallet::new(&config.bitcoind)?;
4✔
34
        let app = Self { config, db, wallet, interrupt: interrupt_rx };
4✔
35
        app.wallet()
4✔
36
            .network()
4✔
37
            .context("Failed to connect to bitcoind. Check config RPC connection.")?;
4✔
38
        Ok(app)
4✔
39
    }
4✔
40

41
    fn wallet(&self) -> BitcoindWallet { self.wallet.clone() }
10✔
42

43
    async fn send_payjoin(&self, bip21: &str, fee_rate: FeeRate) -> Result<()> {
2✔
44
        use payjoin::UriExt;
45
        let uri =
2✔
46
            Uri::try_from(bip21).map_err(|e| anyhow!("Failed to create URI from BIP21: {}", e))?;
2✔
47
        let uri = uri.assume_checked();
2✔
48
        let uri = uri.check_pj_supported().map_err(|_| anyhow!("URI does not support Payjoin"))?;
2✔
49
        let url = uri.extras.endpoint();
2✔
50
        // match bip21 to send_session public_key
51
        let req_ctx = match self.db.get_send_session(url)? {
2✔
52
            Some(send_session) => send_session,
1✔
53
            None => {
54
                let psbt = self.create_original_psbt(&uri, fee_rate)?;
1✔
55
                let mut req_ctx = SenderBuilder::new(psbt, uri.clone())
1✔
56
                    .build_recommended(fee_rate)
1✔
57
                    .with_context(|| "Failed to build payjoin request")?;
1✔
58
                self.db.insert_send_session(&mut req_ctx, url)?;
1✔
59
                req_ctx
1✔
60
            }
61
        };
62
        self.spawn_payjoin_sender(req_ctx).await
2✔
63
    }
4✔
64

65
    async fn receive_payjoin(&self, amount: Amount) -> Result<()> {
1✔
66
        let address = self.wallet().get_new_address()?;
1✔
67
        let ohttp_keys = unwrap_ohttp_keys_or_else_fetch(&self.config).await?;
1✔
68
        let session = Receiver::new(
1✔
69
            address,
1✔
70
            self.config.v2()?.pj_directory.clone(),
1✔
71
            ohttp_keys.clone(),
1✔
72
            None,
1✔
73
        );
1✔
74
        self.db.insert_recv_session(session.clone())?;
1✔
75
        self.spawn_payjoin_receiver(session, Some(amount)).await
1✔
76
    }
2✔
77

78
    #[allow(clippy::incompatible_msrv)]
79
    async fn resume_payjoins(&self) -> Result<()> {
1✔
80
        let recv_sessions = self.db.get_recv_sessions()?;
1✔
81
        let send_sessions = self.db.get_send_sessions()?;
1✔
82

83
        if recv_sessions.is_empty() && send_sessions.is_empty() {
1✔
NEW
84
            println!("No sessions to resume.");
×
NEW
85
            return Ok(());
×
86
        }
1✔
87

1✔
88
        let mut tasks = Vec::new();
1✔
89

90
        for session in recv_sessions {
2✔
91
            let self_clone = self.clone();
1✔
92
            tasks.push(tokio::spawn(async move {
1✔
93
                self_clone.spawn_payjoin_receiver(session, None).await
1✔
94
            }));
1✔
95
        }
1✔
96

97
        for session in send_sessions {
1✔
NEW
98
            let self_clone = self.clone();
×
NEW
99
            tasks.push(tokio::spawn(async move { self_clone.spawn_payjoin_sender(session).await }));
×
NEW
100
        }
×
101

102
        let mut interrupt = self.interrupt.clone();
1✔
103
        tokio::select! {
1✔
104
            _ = async {
1✔
105
                for task in tasks {
1✔
106
                    let _ = task.await;
1✔
107
                }
NEW
108
            } => {
×
NEW
109
                println!("All resumed sessions completed.");
×
NEW
110
            }
×
111
            _ = interrupt.changed() => {
1✔
112
                println!("Resumed sessions were interrupted.");
1✔
113
            }
1✔
114
        }
115
        Ok(())
1✔
116
    }
2✔
117
}
118

119
impl App {
120
    #[allow(clippy::incompatible_msrv)]
121
    async fn spawn_payjoin_sender(&self, mut req_ctx: Sender) -> Result<()> {
2✔
122
        let mut interrupt = self.interrupt.clone();
2✔
123
        tokio::select! {
2✔
124
            res = self.long_poll_post(&mut req_ctx) => {
2✔
125
                self.process_pj_response(res?)?;
1✔
126
                self.db.clear_send_session(req_ctx.endpoint())?;
1✔
127
            }
128
            _ = interrupt.changed() => {
2✔
129
                println!("Interrupted. Call `send` with the same arguments to resume this session or `resume` to resume all sessions.");
1✔
130
            }
1✔
131
        }
132
        Ok(())
2✔
133
    }
2✔
134

135
    #[allow(clippy::incompatible_msrv)]
136
    async fn spawn_payjoin_receiver(
2✔
137
        &self,
2✔
138
        mut session: Receiver,
2✔
139
        amount: Option<Amount>,
2✔
140
    ) -> Result<()> {
2✔
141
        println!("Receive session established");
2✔
142
        let mut pj_uri = session.pj_uri();
2✔
143
        pj_uri.amount = amount;
2✔
144
        println!("Request Payjoin by sharing this Payjoin Uri:");
2✔
145
        println!("{}", pj_uri);
2✔
146

2✔
147
        let mut interrupt = self.interrupt.clone();
2✔
148
        let receiver = tokio::select! {
2✔
149
            res = self.long_poll_fallback(&mut session) => res,
2✔
150
            _ = interrupt.changed() => {
2✔
151
                println!("Interrupted. Call the `resume` command to resume all sessions.");
1✔
152
                return Ok(());
1✔
153
            }
154
        }?;
×
155

156
        println!("Fallback transaction received. Consider broadcasting this to get paid if the Payjoin fails:");
1✔
157
        println!("{}", serialize_hex(&receiver.extract_tx_to_schedule_broadcast()));
1✔
158
        let mut payjoin_proposal = match self.process_v2_proposal(receiver.clone()) {
1✔
159
            Ok(proposal) => proposal,
1✔
160
            Err(Error::ReplyToSender(e)) => {
×
NEW
161
                return Err(
×
NEW
162
                    handle_recoverable_error(e, receiver, &self.config.v2()?.ohttp_relay).await
×
163
                );
164
            }
165
            Err(e) => return Err(e.into()),
×
166
        };
167
        let (req, ohttp_ctx) = payjoin_proposal
1✔
168
            .extract_v2_req(&self.config.v2()?.ohttp_relay)
1✔
169
            .map_err(|e| anyhow!("v2 req extraction failed {}", e))?;
1✔
170
        println!("Got a request from the sender. Responding with a Payjoin proposal.");
1✔
171
        let res = post_request(req).await?;
1✔
172
        payjoin_proposal
1✔
173
            .process_res(&res.bytes().await?, ohttp_ctx)
1✔
174
            .map_err(|e| anyhow!("Failed to deserialize response {}", e))?;
1✔
175
        let payjoin_psbt = payjoin_proposal.psbt().clone();
1✔
176
        println!(
1✔
177
            "Response successful. Watch mempool for successful Payjoin. TXID: {}",
1✔
178
            payjoin_psbt.extract_tx_unchecked_fee_rate().clone().compute_txid()
1✔
179
        );
1✔
180
        self.db.clear_recv_session()?;
1✔
181
        Ok(())
1✔
182
    }
2✔
183

184
    async fn long_poll_post(&self, req_ctx: &mut Sender) -> Result<Psbt> {
2✔
185
        match req_ctx.extract_v2(self.config.v2()?.ohttp_relay.clone()) {
2✔
186
            Ok((req, ctx)) => {
2✔
187
                println!("Posting Original PSBT Payload request...");
2✔
188
                let response = post_request(req).await?;
2✔
189
                println!("Sent fallback transaction");
2✔
190
                let v2_ctx = Arc::new(ctx.process_response(&response.bytes().await?)?);
2✔
191
                loop {
192
                    let (req, ohttp_ctx) =
3✔
193
                        v2_ctx.extract_req(self.config.v2()?.ohttp_relay.clone())?;
3✔
194
                    let response = post_request(req).await?;
3✔
195
                    match v2_ctx.process_response(&response.bytes().await?, ohttp_ctx) {
2✔
196
                        Ok(Some(psbt)) => return Ok(psbt),
1✔
197
                        Ok(None) => {
1✔
198
                            println!("No response yet.");
1✔
199
                        }
1✔
200
                        Err(re) => {
×
201
                            println!("{}", re);
×
202
                            log::debug!("{:?}", re);
×
203
                            return Err(anyhow!("Response error").context(re));
×
204
                        }
205
                    }
206
                }
207
            }
208
            Err(_) => {
209
                let (req, v1_ctx) = req_ctx.extract_v1()?;
×
210
                println!("Posting Original PSBT Payload request...");
×
211
                let response = post_request(req).await?;
×
212
                println!("Sent fallback transaction");
×
213
                match v1_ctx.process_response(&mut response.bytes().await?.to_vec().as_slice()) {
×
214
                    Ok(psbt) => Ok(psbt),
×
215
                    Err(re) => {
×
216
                        println!("{}", re);
×
217
                        log::debug!("{:?}", re);
×
218
                        Err(anyhow!("Response error").context(re))
×
219
                    }
220
                }
221
            }
222
        }
223
    }
1✔
224

225
    async fn long_poll_fallback(
2✔
226
        &self,
2✔
227
        session: &mut payjoin::receive::v2::Receiver,
2✔
228
    ) -> Result<payjoin::receive::v2::UncheckedProposal> {
2✔
229
        loop {
230
            let (req, context) = session.extract_req(&self.config.v2()?.ohttp_relay)?;
2✔
231
            println!("Polling receive request...");
2✔
232
            let ohttp_response = post_request(req).await?;
2✔
233
            let proposal = session
1✔
234
                .process_res(ohttp_response.bytes().await?.to_vec().as_slice(), context)
1✔
235
                .map_err(|_| anyhow!("GET fallback failed"))?;
1✔
236
            log::debug!("got response");
1✔
237
            if let Some(proposal) = proposal {
1✔
238
                break Ok(proposal);
1✔
239
            }
×
240
        }
241
    }
1✔
242

243
    fn process_v2_proposal(
1✔
244
        &self,
1✔
245
        proposal: payjoin::receive::v2::UncheckedProposal,
1✔
246
    ) -> Result<payjoin::receive::v2::PayjoinProposal, Error> {
1✔
247
        let wallet = self.wallet();
1✔
248

1✔
249
        // in a payment processor where the sender could go offline, this is where you schedule to broadcast the original_tx
1✔
250
        let _to_broadcast_in_failure_case = proposal.extract_tx_to_schedule_broadcast();
1✔
251

252
        // Receive Check 1: Can Broadcast
253
        let proposal =
1✔
254
            proposal.check_broadcast_suitability(None, |tx| Ok(wallet.can_broadcast(tx)?))?;
1✔
255
        log::trace!("check1");
1✔
256

257
        // Receive Check 2: receiver can't sign for proposal inputs
258
        let proposal = proposal.check_inputs_not_owned(|input| Ok(wallet.is_mine(input)?))?;
1✔
259
        log::trace!("check2");
1✔
260

261
        // Receive Check 3: have we seen this input before? More of a check for non-interactive i.e. payment processor receivers.
262
        let payjoin = proposal
1✔
263
            .check_no_inputs_seen_before(|input| Ok(self.db.insert_input_seen_before(*input)?))?;
1✔
264
        log::trace!("check3");
1✔
265

266
        let payjoin = payjoin
1✔
267
            .identify_receiver_outputs(|output_script| Ok(wallet.is_mine(output_script)?))?
2✔
268
            .commit_outputs();
1✔
269

1✔
270
        let provisional_payjoin =
1✔
271
            try_contributing_inputs(payjoin.clone(), &wallet).unwrap_or_else(|e| {
1✔
272
                log::warn!("Failed to contribute inputs: {}", e);
×
273
                payjoin.commit_inputs()
×
274
            });
1✔
275

276
        let payjoin_proposal = provisional_payjoin.finalize_proposal(
1✔
277
            |psbt| Ok(wallet.process_psbt(psbt)?),
1✔
278
            None,
1✔
279
            self.config.max_fee_rate,
1✔
280
        )?;
1✔
281
        let payjoin_proposal_psbt = payjoin_proposal.psbt();
1✔
282
        log::debug!("Receiver's Payjoin proposal PSBT Rsponse: {:#?}", payjoin_proposal_psbt);
1✔
283
        Ok(payjoin_proposal)
1✔
284
    }
1✔
285
}
286

287
/// Handle request error by sending an error response over the directory
288
async fn handle_recoverable_error(
×
289
    e: ReplyableError,
×
290
    mut receiver: UncheckedProposal,
×
291
    ohttp_relay: &payjoin::Url,
×
292
) -> anyhow::Error {
×
293
    let (err_req, err_ctx) = match receiver.extract_err_req(&e, ohttp_relay) {
×
294
        Ok(req_ctx) => req_ctx,
×
295
        Err(e) => return anyhow!("Failed to extract error request: {}", e),
×
296
    };
297

298
    let err_response = match post_request(err_req).await {
×
299
        Ok(response) => response,
×
300
        Err(e) => return anyhow!("Failed to post error request: {}", e),
×
301
    };
302

303
    let err_bytes = match err_response.bytes().await {
×
304
        Ok(bytes) => bytes,
×
305
        Err(e) => return anyhow!("Failed to get error response bytes: {}", e),
×
306
    };
307

308
    if let Err(e) = receiver.process_err_res(&err_bytes, err_ctx) {
×
309
        return anyhow!("Failed to process error response: {}", e);
×
310
    }
×
311

×
312
    e.into()
×
313
}
×
314

315
fn try_contributing_inputs(
1✔
316
    payjoin: payjoin::receive::v2::WantsInputs,
1✔
317
    wallet: &BitcoindWallet,
1✔
318
) -> Result<payjoin::receive::v2::ProvisionalProposal> {
1✔
319
    let candidate_inputs = wallet.list_unspent()?;
1✔
320
    let selected_input = payjoin
1✔
321
        .try_preserving_privacy(candidate_inputs)
1✔
322
        .map_err(|e| anyhow!("Failed to make privacy preserving selection: {}", e))?;
1✔
323
    log::debug!("selected input: {:#?}", selected_input);
1✔
324

325
    Ok(payjoin
1✔
326
        .contribute_inputs(vec![selected_input])
1✔
327
        .expect("This shouldn't happen. Failed to contribute inputs.")
1✔
328
        .commit_inputs())
1✔
329
}
1✔
330

331
async fn unwrap_ohttp_keys_or_else_fetch(config: &Config) -> Result<payjoin::OhttpKeys> {
1✔
332
    if let Some(keys) = config.v2()?.ohttp_keys.clone() {
1✔
333
        println!("Using OHTTP Keys from config");
1✔
334
        Ok(keys)
1✔
335
    } else {
336
        println!("Bootstrapping private network transport over Oblivious HTTP");
×
NEW
337
        let ohttp_relay = config.v2()?.ohttp_relay.clone();
×
NEW
338
        let payjoin_directory = config.v2()?.pj_directory.clone();
×
339
        #[cfg(feature = "_danger-local-https")]
340
        let ohttp_keys = {
×
341
            let cert_der = crate::app::read_local_cert()?;
×
342
            payjoin::io::fetch_ohttp_keys_with_cert(ohttp_relay, payjoin_directory, cert_der)
×
343
                .await?
×
344
        };
345
        #[cfg(not(feature = "_danger-local-https"))]
346
        let ohttp_keys = payjoin::io::fetch_ohttp_keys(ohttp_relay, payjoin_directory).await?;
347
        Ok(ohttp_keys)
×
348
    }
349
}
1✔
350

351
async fn post_request(req: payjoin::Request) -> Result<reqwest::Response> {
8✔
352
    let http = http_agent()?;
8✔
353
    http.post(req.url)
8✔
354
        .header("Content-Type", req.content_type)
8✔
355
        .body(req.body)
8✔
356
        .send()
8✔
357
        .await
8✔
358
        .map_err(map_reqwest_err)
6✔
359
}
6✔
360

361
fn map_reqwest_err(e: reqwest::Error) -> anyhow::Error {
×
362
    match e.status() {
×
363
        Some(status_code) => anyhow!("HTTP request failed: {} {}", status_code, e),
×
364
        None => anyhow!("No HTTP response: {}", e),
×
365
    }
366
}
×
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc