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

payjoin / rust-payjoin / 14175090533

31 Mar 2025 03:17PM UTC coverage: 81.754% (+0.1%) from 81.653%
14175090533

push

github

web-flow
Move testing constants to payjoin-test-utils (#613)

Pull out the test constant commit from #586 into its own PR

6 of 6 new or added lines in 2 files covered. (100.0%)

138 existing lines in 11 files now uncovered.

5211 of 6374 relevant lines covered (81.75%)

725.38 hits per line

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

76.58
/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::{NewReceiver, Receiver, UncheckedProposal};
8
use payjoin::receive::{Error, ImplementationError, 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::v2::{ReceiverPersister, SenderPersister};
18
use crate::db::Database;
19

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

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

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

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

70
    async fn receive_payjoin(&self, amount: Amount) -> Result<()> {
1✔
71
        let address = self.wallet().get_new_address()?;
1✔
72
        let ohttp_keys = unwrap_ohttp_keys_or_else_fetch(&self.config).await?;
1✔
73
        let mut persister = ReceiverPersister::new(self.db.clone());
1✔
74
        let new_receiver = NewReceiver::new(
1✔
75
            address,
1✔
76
            self.config.v2()?.pj_directory.clone(),
1✔
77
            ohttp_keys.clone(),
1✔
78
            None,
1✔
UNCOV
79
        )?;
×
80
        let storage_token = new_receiver
1✔
81
            .persist(&mut persister)
1✔
82
            .map_err(|e| anyhow!("Failed to persist receiver: {}", e))?;
1✔
83
        let session = Receiver::load(storage_token, &persister)
1✔
84
            .map_err(|e| anyhow!("Failed to load receiver: {}", e))?;
1✔
85
        self.spawn_payjoin_receiver(session, Some(amount)).await
1✔
86
    }
2✔
87

88
    #[allow(clippy::incompatible_msrv)]
89
    async fn resume_payjoins(&self) -> Result<()> {
1✔
90
        let recv_sessions = self.db.get_recv_sessions()?;
1✔
91
        let send_sessions = self.db.get_send_sessions()?;
1✔
92

93
        if recv_sessions.is_empty() && send_sessions.is_empty() {
1✔
UNCOV
94
            println!("No sessions to resume.");
×
UNCOV
95
            return Ok(());
×
96
        }
1✔
97

1✔
98
        let mut tasks = Vec::new();
1✔
99

100
        for session in recv_sessions {
2✔
101
            let self_clone = self.clone();
1✔
102
            tasks.push(tokio::spawn(async move {
1✔
103
                self_clone.spawn_payjoin_receiver(session, None).await
1✔
104
            }));
1✔
105
        }
1✔
106

107
        for session in send_sessions {
1✔
108
            let self_clone = self.clone();
×
109
            tasks.push(tokio::spawn(async move { self_clone.spawn_payjoin_sender(session).await }));
×
110
        }
×
111

112
        let mut interrupt = self.interrupt.clone();
1✔
113
        tokio::select! {
1✔
114
            _ = async {
1✔
115
                for task in tasks {
1✔
116
                    let _ = task.await;
1✔
117
                }
UNCOV
118
            } => {
×
UNCOV
119
                println!("All resumed sessions completed.");
×
UNCOV
120
            }
×
121
            _ = interrupt.changed() => {
1✔
122
                println!("Resumed sessions were interrupted.");
1✔
123
            }
1✔
124
        }
125
        Ok(())
1✔
126
    }
2✔
127
}
128

129
impl App {
130
    #[allow(clippy::incompatible_msrv)]
131
    async fn spawn_payjoin_sender(&self, mut req_ctx: Sender) -> Result<()> {
2✔
132
        let mut interrupt = self.interrupt.clone();
2✔
133
        tokio::select! {
2✔
134
            res = self.long_poll_post(&mut req_ctx) => {
2✔
135
                self.process_pj_response(res?)?;
1✔
136
                self.db.clear_send_session(req_ctx.endpoint())?;
1✔
137
            }
138
            _ = interrupt.changed() => {
2✔
139
                println!("Interrupted. Call `send` with the same arguments to resume this session or `resume` to resume all sessions.");
1✔
140
            }
1✔
141
        }
142
        Ok(())
2✔
143
    }
2✔
144

145
    #[allow(clippy::incompatible_msrv)]
146
    async fn spawn_payjoin_receiver(
2✔
147
        &self,
2✔
148
        mut session: Receiver,
2✔
149
        amount: Option<Amount>,
2✔
150
    ) -> Result<()> {
2✔
151
        println!("Receive session established");
2✔
152
        let mut pj_uri = session.pj_uri();
2✔
153
        pj_uri.amount = amount;
2✔
154
        println!("Request Payjoin by sharing this Payjoin Uri:");
2✔
155
        println!("{}", pj_uri);
2✔
156

2✔
157
        let mut interrupt = self.interrupt.clone();
2✔
158
        let receiver = tokio::select! {
2✔
159
            res = self.long_poll_fallback(&mut session) => res,
2✔
160
            _ = interrupt.changed() => {
2✔
161
                println!("Interrupted. Call the `resume` command to resume all sessions.");
1✔
162
                return Ok(());
1✔
163
            }
UNCOV
164
        }?;
×
165

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

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

235
    async fn long_poll_fallback(
2✔
236
        &self,
2✔
237
        session: &mut payjoin::receive::v2::Receiver,
2✔
238
    ) -> Result<payjoin::receive::v2::UncheckedProposal> {
2✔
239
        loop {
240
            let (req, context) = session.extract_req(&self.config.v2()?.ohttp_relay)?;
2✔
241
            println!("Polling receive request...");
2✔
242
            let ohttp_response = post_request(req).await?;
2✔
243
            let proposal = session
1✔
244
                .process_res(ohttp_response.bytes().await?.to_vec().as_slice(), context)
1✔
245
                .map_err(|_| anyhow!("GET fallback failed"))?;
1✔
246
            log::debug!("got response");
1✔
247
            if let Some(proposal) = proposal {
1✔
248
                break Ok(proposal);
1✔
UNCOV
249
            }
×
250
        }
251
    }
1✔
252

253
    fn process_v2_proposal(
1✔
254
        &self,
1✔
255
        proposal: payjoin::receive::v2::UncheckedProposal,
1✔
256
    ) -> Result<payjoin::receive::v2::PayjoinProposal, Error> {
1✔
257
        let wallet = self.wallet();
1✔
258

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

262
        // Receive Check 1: Can Broadcast
263
        let proposal =
1✔
264
            proposal.check_broadcast_suitability(None, |tx| Ok(wallet.can_broadcast(tx)?))?;
1✔
265
        log::trace!("check1");
1✔
266

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

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

276
        let payjoin = payjoin
1✔
277
            .identify_receiver_outputs(|output_script| Ok(wallet.is_mine(output_script)?))?
2✔
278
            .commit_outputs();
1✔
279

280
        let provisional_payjoin = try_contributing_inputs(payjoin.clone(), &wallet)
1✔
281
            .map_err(ReplyableError::Implementation)?;
1✔
282

283
        let payjoin_proposal = provisional_payjoin.finalize_proposal(
1✔
284
            |psbt| Ok(wallet.process_psbt(psbt)?),
1✔
285
            None,
1✔
286
            self.config.max_fee_rate,
1✔
287
        )?;
1✔
288
        let payjoin_proposal_psbt = payjoin_proposal.psbt();
1✔
289
        log::debug!("Receiver's Payjoin proposal PSBT Rsponse: {:#?}", payjoin_proposal_psbt);
1✔
290
        Ok(payjoin_proposal)
1✔
291
    }
1✔
292
}
293

294
/// Handle request error by sending an error response over the directory
UNCOV
295
async fn handle_recoverable_error(
×
296
    e: ReplyableError,
×
297
    mut receiver: UncheckedProposal,
×
298
    ohttp_relay: &payjoin::Url,
×
UNCOV
299
) -> anyhow::Error {
×
UNCOV
300
    let to_return = anyhow!("Replied with error: {}", e);
×
301
    let (err_req, err_ctx) = match receiver.extract_err_req(&e.into(), ohttp_relay) {
×
302
        Ok(req_ctx) => req_ctx,
×
303
        Err(e) => return anyhow!("Failed to extract error request: {}", e),
×
304
    };
305

306
    let err_response = match post_request(err_req).await {
×
307
        Ok(response) => response,
×
308
        Err(e) => return anyhow!("Failed to post error request: {}", e),
×
309
    };
310

311
    let err_bytes = match err_response.bytes().await {
×
UNCOV
312
        Ok(bytes) => bytes,
×
UNCOV
313
        Err(e) => return anyhow!("Failed to get error response bytes: {}", e),
×
314
    };
315

UNCOV
316
    if let Err(e) = receiver.process_err_res(&err_bytes, err_ctx) {
×
UNCOV
317
        return anyhow!("Failed to process error response: {}", e);
×
UNCOV
318
    }
×
UNCOV
319

×
UNCOV
320
    to_return
×
UNCOV
321
}
×
322

323
fn try_contributing_inputs(
1✔
324
    payjoin: payjoin::receive::v2::WantsInputs,
1✔
325
    wallet: &BitcoindWallet,
1✔
326
) -> Result<payjoin::receive::v2::ProvisionalProposal, ImplementationError> {
1✔
327
    let candidate_inputs = wallet.list_unspent()?;
1✔
328

329
    let selected_input =
1✔
330
        payjoin.try_preserving_privacy(candidate_inputs).map_err(ImplementationError::from)?;
1✔
331

332
    Ok(payjoin
1✔
333
        .contribute_inputs(vec![selected_input])
1✔
334
        .map_err(ImplementationError::from)?
1✔
335
        .commit_inputs())
1✔
336
}
1✔
337

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

358
async fn post_request(req: payjoin::Request) -> Result<reqwest::Response> {
8✔
359
    let http = http_agent()?;
8✔
360
    http.post(req.url)
8✔
361
        .header("Content-Type", req.content_type)
8✔
362
        .body(req.body)
8✔
363
        .send()
8✔
364
        .await
8✔
365
        .map_err(map_reqwest_err)
6✔
366
}
6✔
367

UNCOV
368
fn map_reqwest_err(e: reqwest::Error) -> anyhow::Error {
×
UNCOV
369
    match e.status() {
×
UNCOV
370
        Some(status_code) => anyhow!("HTTP request failed: {} {}", status_code, e),
×
UNCOV
371
        None => anyhow!("No HTTP response: {}", e),
×
372
    }
UNCOV
373
}
×
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