1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Functional tests for the BOLT 12 Offers payment flow.
12 //! [`ChannelManager`] provides utilities to create [`Offer`]s and [`Refund`]s along with utilities
13 //! to initiate and request payment for them, respectively. It also manages the payment flow via
14 //! implementing [`OffersMessageHandler`]. This module tests that functionality, including the
15 //! resulting [`Event`] generation.
17 //! Two-node success tests use an announced channel:
21 //! While two-node failure tests use an unannounced channel:
25 //! Six-node tests use unannounced channels for the sender and recipient and announced channels for
26 //! the rest of the network.
32 //! Alice ... Bob -------- Charlie ... David
38 //! Unnamed nodes are needed to ensure unannounced nodes can create two-hop blinded paths.
40 //! Nodes without channels are disconnected and connected as needed to ensure that deterministic
41 //! blinded paths are used.
43 use bitcoin::network::Network;
44 use bitcoin::secp256k1::PublicKey;
45 use core::time::Duration;
46 use crate::blinded_path::{BlindedPath, IntroductionNode};
47 use crate::blinded_path::payment::{Bolt12OfferContext, Bolt12RefundContext, PaymentContext};
48 use crate::events::{Event, MessageSendEventsProvider, PaymentPurpose};
49 use crate::ln::channelmanager::{Bolt12PaymentError, MAX_SHORT_LIVED_RELATIVE_EXPIRY, PaymentId, RecentPaymentDetails, Retry, self};
50 use crate::ln::functional_test_utils::*;
51 use crate::ln::msgs::{ChannelMessageHandler, Init, NodeAnnouncement, OnionMessage, OnionMessageHandler, RoutingMessageHandler, SocketAddress, UnsignedGossipMessage, UnsignedNodeAnnouncement};
52 use crate::ln::outbound_payment::IDEMPOTENCY_TIMEOUT_TICKS;
53 use crate::offers::invoice::Bolt12Invoice;
54 use crate::offers::invoice_error::InvoiceError;
55 use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
56 use crate::offers::parse::Bolt12SemanticError;
57 use crate::onion_message::messenger::PeeledOnion;
58 use crate::onion_message::offers::OffersMessage;
59 use crate::onion_message::packet::ParsedOnionMessageContents;
60 use crate::routing::gossip::{NodeAlias, NodeId};
61 use crate::sign::{NodeSigner, Recipient};
63 use crate::prelude::*;
65 macro_rules! expect_recent_payment {
66 ($node: expr, $payment_state: path, $payment_id: expr) => {
67 match $node.node.list_recent_payments().first() {
68 Some(&$payment_state { payment_id: actual_payment_id, .. }) => {
69 assert_eq!($payment_id, actual_payment_id);
71 Some(_) => panic!("Unexpected recent payment state"),
72 None => panic!("No recent payments"),
77 fn connect_peers<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>) {
78 let node_id_a = node_a.node.get_our_node_id();
79 let node_id_b = node_b.node.get_our_node_id();
82 features: node_a.init_features(&node_id_b),
84 remote_network_address: None,
87 features: node_b.init_features(&node_id_a),
89 remote_network_address: None,
92 node_a.node.peer_connected(&node_id_b, &init_b, true).unwrap();
93 node_b.node.peer_connected(&node_id_a, &init_a, false).unwrap();
94 node_a.onion_messenger.peer_connected(&node_id_b, &init_b, true).unwrap();
95 node_b.onion_messenger.peer_connected(&node_id_a, &init_a, false).unwrap();
98 fn disconnect_peers<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, peers: &[&Node<'a, 'b, 'c>]) {
100 node_a.node.peer_disconnected(&node_b.node.get_our_node_id());
101 node_b.node.peer_disconnected(&node_a.node.get_our_node_id());
102 node_a.onion_messenger.peer_disconnected(&node_b.node.get_our_node_id());
103 node_b.onion_messenger.peer_disconnected(&node_a.node.get_our_node_id());
107 fn announce_node_address<'a, 'b, 'c>(
108 node: &Node<'a, 'b, 'c>, peers: &[&Node<'a, 'b, 'c>], address: SocketAddress,
110 let features = node.onion_messenger.provided_node_features()
111 | node.gossip_sync.provided_node_features();
113 let announcement = UnsignedNodeAnnouncement {
116 node_id: NodeId::from_pubkey(&node.keys_manager.get_node_id(Recipient::Node).unwrap()),
118 alias: NodeAlias([0u8; 32]),
119 addresses: vec![address],
120 excess_address_data: Vec::new(),
121 excess_data: Vec::new(),
123 let signature = node.keys_manager.sign_gossip_message(
124 UnsignedGossipMessage::NodeAnnouncement(&announcement)
127 let msg = NodeAnnouncement {
129 contents: announcement
132 node.gossip_sync.handle_node_announcement(&msg).unwrap();
134 peer.gossip_sync.handle_node_announcement(&msg).unwrap();
138 fn resolve_introduction_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, path: &BlindedPath) -> PublicKey {
139 path.public_introduction_node_id(&node.network_graph.read_only())
140 .and_then(|node_id| node_id.as_pubkey().ok())
144 fn route_bolt12_payment<'a, 'b, 'c>(
145 node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], invoice: &Bolt12Invoice
147 // Monitor added when handling the invoice onion message.
148 check_added_monitors(node, 1);
150 let mut events = node.node.get_and_clear_pending_msg_events();
151 assert_eq!(events.len(), 1);
152 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
154 // Use a fake payment_hash and bypass checking for the PaymentClaimable event since the
155 // invoice contains the payment_hash but it was encrypted inside an onion message.
156 let amount_msats = invoice.amount_msats();
157 let payment_hash = invoice.payment_hash();
158 let args = PassAlongPathArgs::new(node, path, amount_msats, payment_hash, ev)
159 .without_clearing_recipient_events();
160 do_pass_along_path(args);
163 fn claim_bolt12_payment<'a, 'b, 'c>(
164 node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], expected_payment_context: PaymentContext
166 let recipient = &path[path.len() - 1];
167 let payment_purpose = match get_event!(recipient, Event::PaymentClaimable) {
168 Event::PaymentClaimable { purpose, .. } => purpose,
169 _ => panic!("No Event::PaymentClaimable"),
171 let payment_preimage = match payment_purpose.preimage() {
172 Some(preimage) => preimage,
173 None => panic!("No preimage in Event::PaymentClaimable"),
175 match payment_purpose {
176 PaymentPurpose::Bolt12OfferPayment { payment_context, .. } => {
177 assert_eq!(PaymentContext::Bolt12Offer(payment_context), expected_payment_context);
179 PaymentPurpose::Bolt12RefundPayment { payment_context, .. } => {
180 assert_eq!(PaymentContext::Bolt12Refund(payment_context), expected_payment_context);
182 _ => panic!("Unexpected payment purpose: {:?}", payment_purpose),
184 claim_payment(node, path, payment_preimage);
187 fn extract_invoice_request<'a, 'b, 'c>(
188 node: &Node<'a, 'b, 'c>, message: &OnionMessage
189 ) -> (InvoiceRequest, BlindedPath) {
190 match node.onion_messenger.peel_onion_message(message) {
191 Ok(PeeledOnion::Receive(message, _, reply_path)) => match message {
192 ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
193 OffersMessage::InvoiceRequest(invoice_request) => (invoice_request, reply_path.unwrap()),
194 OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
195 OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
197 ParsedOnionMessageContents::Custom(message) => panic!("Unexpected custom message: {:?}", message),
199 Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
200 Err(e) => panic!("Failed to process onion message {:?}", e),
204 fn extract_invoice<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, message: &OnionMessage) -> Bolt12Invoice {
205 match node.onion_messenger.peel_onion_message(message) {
206 Ok(PeeledOnion::Receive(message, _, _)) => match message {
207 ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
208 OffersMessage::InvoiceRequest(invoice_request) => panic!("Unexpected invoice_request: {:?}", invoice_request),
209 OffersMessage::Invoice(invoice) => invoice,
210 OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
212 ParsedOnionMessageContents::Custom(message) => panic!("Unexpected custom message: {:?}", message),
214 Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
215 Err(e) => panic!("Failed to process onion message {:?}", e),
219 fn extract_invoice_error<'a, 'b, 'c>(
220 node: &Node<'a, 'b, 'c>, message: &OnionMessage
222 match node.onion_messenger.peel_onion_message(message) {
223 Ok(PeeledOnion::Receive(message, _, _)) => match message {
224 ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
225 OffersMessage::InvoiceRequest(invoice_request) => panic!("Unexpected invoice_request: {:?}", invoice_request),
226 OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
227 OffersMessage::InvoiceError(error) => error,
229 ParsedOnionMessageContents::Custom(message) => panic!("Unexpected custom message: {:?}", message),
231 Ok(PeeledOnion::Forward(_, _)) => panic!("Unexpected onion message forward"),
232 Err(e) => panic!("Failed to process onion message {:?}", e),
236 /// Checks that blinded paths without Tor-only nodes are preferred when constructing an offer.
238 fn prefers_non_tor_nodes_in_blinded_paths() {
239 let mut accept_forward_cfg = test_default_channel_config();
240 accept_forward_cfg.accept_forwards_to_priv_channels = true;
242 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
243 features.set_onion_messages_optional();
244 features.set_route_blinding_optional();
246 let chanmon_cfgs = create_chanmon_cfgs(6);
247 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
249 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
251 let node_chanmgrs = create_node_chanmgrs(
252 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
254 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
256 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
257 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
258 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
259 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
260 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
261 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
262 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
264 // Add an extra channel so that more than one of Bob's peers have MIN_PEER_CHANNELS.
265 create_announced_chan_between_nodes_with_value(&nodes, 4, 5, 10_000_000, 1_000_000_000);
267 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
268 let bob_id = bob.node.get_our_node_id();
269 let charlie_id = charlie.node.get_our_node_id();
271 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
272 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
274 let tor = SocketAddress::OnionV2([255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]);
275 announce_node_address(charlie, &[alice, bob, david, &nodes[4], &nodes[5]], tor.clone());
278 .create_offer_builder(None).unwrap()
279 .amount_msats(10_000_000)
281 assert_ne!(offer.signing_pubkey(), Some(bob_id));
282 assert!(!offer.paths().is_empty());
283 for path in offer.paths() {
284 let introduction_node_id = resolve_introduction_node(david, &path);
285 assert_ne!(introduction_node_id, bob_id);
286 assert_ne!(introduction_node_id, charlie_id);
289 // Use a one-hop blinded path when Bob is announced and all his peers are Tor-only.
290 announce_node_address(&nodes[4], &[alice, bob, charlie, david, &nodes[5]], tor.clone());
291 announce_node_address(&nodes[5], &[alice, bob, charlie, david, &nodes[4]], tor.clone());
294 .create_offer_builder(None).unwrap()
295 .amount_msats(10_000_000)
297 assert_ne!(offer.signing_pubkey(), Some(bob_id));
298 assert!(!offer.paths().is_empty());
299 for path in offer.paths() {
300 let introduction_node_id = resolve_introduction_node(david, &path);
301 assert_eq!(introduction_node_id, bob_id);
305 /// Checks that blinded paths prefer an introduction node that is the most connected.
307 fn prefers_more_connected_nodes_in_blinded_paths() {
308 let mut accept_forward_cfg = test_default_channel_config();
309 accept_forward_cfg.accept_forwards_to_priv_channels = true;
311 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
312 features.set_onion_messages_optional();
313 features.set_route_blinding_optional();
315 let chanmon_cfgs = create_chanmon_cfgs(6);
316 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
318 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
320 let node_chanmgrs = create_node_chanmgrs(
321 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
323 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
325 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
326 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
327 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
328 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
329 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
330 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
331 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
333 // Add extra channels so that more than one of Bob's peers have MIN_PEER_CHANNELS and one has
334 // more than the others.
335 create_announced_chan_between_nodes_with_value(&nodes, 0, 4, 10_000_000, 1_000_000_000);
336 create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 10_000_000, 1_000_000_000);
338 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
339 let bob_id = bob.node.get_our_node_id();
341 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
342 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
345 .create_offer_builder(None).unwrap()
346 .amount_msats(10_000_000)
348 assert_ne!(offer.signing_pubkey(), Some(bob_id));
349 assert!(!offer.paths().is_empty());
350 for path in offer.paths() {
351 let introduction_node_id = resolve_introduction_node(david, &path);
352 assert_eq!(introduction_node_id, nodes[4].node.get_our_node_id());
356 /// Checks that blinded paths are compact for short-lived offers.
358 fn creates_short_lived_offer() {
359 let chanmon_cfgs = create_chanmon_cfgs(2);
360 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
361 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
362 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
364 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
366 let alice = &nodes[0];
367 let alice_id = alice.node.get_our_node_id();
370 let absolute_expiry = alice.node.duration_since_epoch() + MAX_SHORT_LIVED_RELATIVE_EXPIRY;
371 let offer = alice.node
372 .create_offer_builder(Some(absolute_expiry)).unwrap()
374 assert_eq!(offer.absolute_expiry(), Some(absolute_expiry));
375 assert!(!offer.paths().is_empty());
376 for path in offer.paths() {
377 let introduction_node_id = resolve_introduction_node(bob, &path);
378 assert_eq!(introduction_node_id, alice_id);
379 assert!(matches!(path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
383 /// Checks that blinded paths are not compact for long-lived offers.
385 fn creates_long_lived_offer() {
386 let chanmon_cfgs = create_chanmon_cfgs(2);
387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
389 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
391 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
393 let alice = &nodes[0];
394 let alice_id = alice.node.get_our_node_id();
396 let absolute_expiry = alice.node.duration_since_epoch() + MAX_SHORT_LIVED_RELATIVE_EXPIRY
397 + Duration::from_secs(1);
398 let offer = alice.node
399 .create_offer_builder(Some(absolute_expiry))
402 assert_eq!(offer.absolute_expiry(), Some(absolute_expiry));
403 assert!(!offer.paths().is_empty());
404 for path in offer.paths() {
405 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
408 let offer = alice.node
409 .create_offer_builder(None).unwrap()
411 assert_eq!(offer.absolute_expiry(), None);
412 assert!(!offer.paths().is_empty());
413 for path in offer.paths() {
414 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
418 /// Checks that blinded paths are compact for short-lived refunds.
420 fn creates_short_lived_refund() {
421 let chanmon_cfgs = create_chanmon_cfgs(2);
422 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
423 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
424 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
426 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
428 let alice = &nodes[0];
430 let bob_id = bob.node.get_our_node_id();
432 let absolute_expiry = bob.node.duration_since_epoch() + MAX_SHORT_LIVED_RELATIVE_EXPIRY;
433 let payment_id = PaymentId([1; 32]);
434 let refund = bob.node
435 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
438 assert_eq!(refund.absolute_expiry(), Some(absolute_expiry));
439 assert!(!refund.paths().is_empty());
440 for path in refund.paths() {
441 let introduction_node_id = resolve_introduction_node(alice, &path);
442 assert_eq!(introduction_node_id, bob_id);
443 assert!(matches!(path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
447 /// Checks that blinded paths are not compact for long-lived refunds.
449 fn creates_long_lived_refund() {
450 let chanmon_cfgs = create_chanmon_cfgs(2);
451 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
452 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
453 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
455 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
458 let bob_id = bob.node.get_our_node_id();
460 let absolute_expiry = bob.node.duration_since_epoch() + MAX_SHORT_LIVED_RELATIVE_EXPIRY
461 + Duration::from_secs(1);
462 let payment_id = PaymentId([1; 32]);
463 let refund = bob.node
464 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
467 assert_eq!(refund.absolute_expiry(), Some(absolute_expiry));
468 assert!(!refund.paths().is_empty());
469 for path in refund.paths() {
470 assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
474 /// Checks that an offer can be paid through blinded paths and that ephemeral pubkeys are used
475 /// rather than exposing a node's pubkey.
477 fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
478 let mut accept_forward_cfg = test_default_channel_config();
479 accept_forward_cfg.accept_forwards_to_priv_channels = true;
481 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
482 features.set_onion_messages_optional();
483 features.set_route_blinding_optional();
485 let chanmon_cfgs = create_chanmon_cfgs(6);
486 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
488 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
490 let node_chanmgrs = create_node_chanmgrs(
491 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
493 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
495 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
496 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
497 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
498 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
499 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
500 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
501 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
503 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
504 let alice_id = alice.node.get_our_node_id();
505 let bob_id = bob.node.get_our_node_id();
506 let charlie_id = charlie.node.get_our_node_id();
507 let david_id = david.node.get_our_node_id();
509 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
510 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
512 let offer = alice.node
513 .create_offer_builder(None)
515 .amount_msats(10_000_000)
517 assert_ne!(offer.signing_pubkey(), Some(alice_id));
518 assert!(!offer.paths().is_empty());
519 for path in offer.paths() {
520 assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
523 let payment_id = PaymentId([1; 32]);
524 david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None)
526 expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
528 connect_peers(david, bob);
530 let onion_message = david.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
531 bob.onion_messenger.handle_onion_message(&david_id, &onion_message);
533 connect_peers(alice, charlie);
535 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
536 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
538 let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
539 let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
540 offer_id: offer.id(),
541 invoice_request: InvoiceRequestFields {
542 payer_id: invoice_request.payer_id(),
544 payer_note_truncated: None,
547 assert_eq!(invoice_request.amount_msats(), None);
548 assert_ne!(invoice_request.payer_id(), david_id);
549 assert_eq!(reply_path.introduction_node, IntroductionNode::NodeId(charlie_id));
551 let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
552 charlie.onion_messenger.handle_onion_message(&alice_id, &onion_message);
554 let onion_message = charlie.onion_messenger.next_onion_message_for_peer(david_id).unwrap();
555 david.onion_messenger.handle_onion_message(&charlie_id, &onion_message);
557 let invoice = extract_invoice(david, &onion_message);
558 assert_eq!(invoice.amount_msats(), 10_000_000);
559 assert_ne!(invoice.signing_pubkey(), alice_id);
560 assert!(!invoice.payment_paths().is_empty());
561 for (_, path) in invoice.payment_paths() {
562 assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
565 route_bolt12_payment(david, &[charlie, bob, alice], &invoice);
566 expect_recent_payment!(david, RecentPaymentDetails::Pending, payment_id);
568 claim_bolt12_payment(david, &[charlie, bob, alice], payment_context);
569 expect_recent_payment!(david, RecentPaymentDetails::Fulfilled, payment_id);
572 /// Checks that a refund can be paid through blinded paths and that ephemeral pubkeys are used
573 /// rather than exposing a node's pubkey.
575 fn creates_and_pays_for_refund_using_two_hop_blinded_path() {
576 let mut accept_forward_cfg = test_default_channel_config();
577 accept_forward_cfg.accept_forwards_to_priv_channels = true;
579 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
580 features.set_onion_messages_optional();
581 features.set_route_blinding_optional();
583 let chanmon_cfgs = create_chanmon_cfgs(6);
584 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
586 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
588 let node_chanmgrs = create_node_chanmgrs(
589 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
591 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
593 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
594 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
595 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
596 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
597 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
598 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
599 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
601 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
602 let alice_id = alice.node.get_our_node_id();
603 let bob_id = bob.node.get_our_node_id();
604 let charlie_id = charlie.node.get_our_node_id();
605 let david_id = david.node.get_our_node_id();
607 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
608 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
610 let absolute_expiry = Duration::from_secs(u64::MAX);
611 let payment_id = PaymentId([1; 32]);
612 let refund = david.node
613 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
616 assert_eq!(refund.amount_msats(), 10_000_000);
617 assert_eq!(refund.absolute_expiry(), Some(absolute_expiry));
618 assert_ne!(refund.payer_id(), david_id);
619 assert!(!refund.paths().is_empty());
620 for path in refund.paths() {
621 assert_eq!(path.introduction_node, IntroductionNode::NodeId(charlie_id));
623 expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
625 let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
626 let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
628 connect_peers(alice, charlie);
630 let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
631 charlie.onion_messenger.handle_onion_message(&alice_id, &onion_message);
633 let onion_message = charlie.onion_messenger.next_onion_message_for_peer(david_id).unwrap();
634 david.onion_messenger.handle_onion_message(&charlie_id, &onion_message);
636 let invoice = extract_invoice(david, &onion_message);
637 assert_eq!(invoice, expected_invoice);
639 assert_eq!(invoice.amount_msats(), 10_000_000);
640 assert_ne!(invoice.signing_pubkey(), alice_id);
641 assert!(!invoice.payment_paths().is_empty());
642 for (_, path) in invoice.payment_paths() {
643 assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
646 route_bolt12_payment(david, &[charlie, bob, alice], &invoice);
647 expect_recent_payment!(david, RecentPaymentDetails::Pending, payment_id);
649 claim_bolt12_payment(david, &[charlie, bob, alice], payment_context);
650 expect_recent_payment!(david, RecentPaymentDetails::Fulfilled, payment_id);
653 /// Checks that an offer can be paid through a one-hop blinded path and that ephemeral pubkeys are
654 /// used rather than exposing a node's pubkey. However, the node's pubkey is still used as the
655 /// introduction node of the blinded path.
657 fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
658 let chanmon_cfgs = create_chanmon_cfgs(2);
659 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
660 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
661 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
663 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
665 let alice = &nodes[0];
666 let alice_id = alice.node.get_our_node_id();
668 let bob_id = bob.node.get_our_node_id();
670 let offer = alice.node
671 .create_offer_builder(None).unwrap()
672 .amount_msats(10_000_000)
674 assert_ne!(offer.signing_pubkey(), Some(alice_id));
675 assert!(!offer.paths().is_empty());
676 for path in offer.paths() {
677 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
680 let payment_id = PaymentId([1; 32]);
681 bob.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None).unwrap();
682 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
684 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
685 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
687 let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
688 let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
689 offer_id: offer.id(),
690 invoice_request: InvoiceRequestFields {
691 payer_id: invoice_request.payer_id(),
693 payer_note_truncated: None,
696 assert_eq!(invoice_request.amount_msats(), None);
697 assert_ne!(invoice_request.payer_id(), bob_id);
698 assert_eq!(reply_path.introduction_node, IntroductionNode::NodeId(bob_id));
700 let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
701 bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
703 let invoice = extract_invoice(bob, &onion_message);
704 assert_eq!(invoice.amount_msats(), 10_000_000);
705 assert_ne!(invoice.signing_pubkey(), alice_id);
706 assert!(!invoice.payment_paths().is_empty());
707 for (_, path) in invoice.payment_paths() {
708 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
711 route_bolt12_payment(bob, &[alice], &invoice);
712 expect_recent_payment!(bob, RecentPaymentDetails::Pending, payment_id);
714 claim_bolt12_payment(bob, &[alice], payment_context);
715 expect_recent_payment!(bob, RecentPaymentDetails::Fulfilled, payment_id);
718 /// Checks that a refund can be paid through a one-hop blinded path and that ephemeral pubkeys are
719 /// used rather than exposing a node's pubkey. However, the node's pubkey is still used as the
720 /// introduction node of the blinded path.
722 fn creates_and_pays_for_refund_using_one_hop_blinded_path() {
723 let chanmon_cfgs = create_chanmon_cfgs(2);
724 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
725 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
726 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
728 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
730 let alice = &nodes[0];
731 let alice_id = alice.node.get_our_node_id();
733 let bob_id = bob.node.get_our_node_id();
735 let absolute_expiry = Duration::from_secs(u64::MAX);
736 let payment_id = PaymentId([1; 32]);
737 let refund = bob.node
738 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
741 assert_eq!(refund.amount_msats(), 10_000_000);
742 assert_eq!(refund.absolute_expiry(), Some(absolute_expiry));
743 assert_ne!(refund.payer_id(), bob_id);
744 assert!(!refund.paths().is_empty());
745 for path in refund.paths() {
746 assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
748 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
750 let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
751 let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
753 let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
754 bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
756 let invoice = extract_invoice(bob, &onion_message);
757 assert_eq!(invoice, expected_invoice);
759 assert_eq!(invoice.amount_msats(), 10_000_000);
760 assert_ne!(invoice.signing_pubkey(), alice_id);
761 assert!(!invoice.payment_paths().is_empty());
762 for (_, path) in invoice.payment_paths() {
763 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
766 route_bolt12_payment(bob, &[alice], &invoice);
767 expect_recent_payment!(bob, RecentPaymentDetails::Pending, payment_id);
769 claim_bolt12_payment(bob, &[alice], payment_context);
770 expect_recent_payment!(bob, RecentPaymentDetails::Fulfilled, payment_id);
773 /// Checks that an invoice for an offer without any blinded paths can be requested. Note that while
774 /// the requested is sent directly using the node's pubkey, the response and the payment still use
775 /// blinded paths as required by the spec.
777 fn pays_for_offer_without_blinded_paths() {
778 let chanmon_cfgs = create_chanmon_cfgs(2);
779 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
780 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
781 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
783 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
785 let alice = &nodes[0];
786 let alice_id = alice.node.get_our_node_id();
788 let bob_id = bob.node.get_our_node_id();
790 let offer = alice.node
791 .create_offer_builder(None).unwrap()
793 .amount_msats(10_000_000)
795 assert_eq!(offer.signing_pubkey(), Some(alice_id));
796 assert!(offer.paths().is_empty());
798 let payment_id = PaymentId([1; 32]);
799 bob.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None).unwrap();
800 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
802 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
803 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
805 let (invoice_request, _) = extract_invoice_request(alice, &onion_message);
806 let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
807 offer_id: offer.id(),
808 invoice_request: InvoiceRequestFields {
809 payer_id: invoice_request.payer_id(),
811 payer_note_truncated: None,
815 let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
816 bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
818 let invoice = extract_invoice(bob, &onion_message);
819 route_bolt12_payment(bob, &[alice], &invoice);
820 expect_recent_payment!(bob, RecentPaymentDetails::Pending, payment_id);
822 claim_bolt12_payment(bob, &[alice], payment_context);
823 expect_recent_payment!(bob, RecentPaymentDetails::Fulfilled, payment_id);
826 /// Checks that a refund without any blinded paths can be paid. Note that while the invoice is sent
827 /// directly using the node's pubkey, the payment still use blinded paths as required by the spec.
829 fn pays_for_refund_without_blinded_paths() {
830 let chanmon_cfgs = create_chanmon_cfgs(2);
831 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
832 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
833 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
835 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
837 let alice = &nodes[0];
838 let alice_id = alice.node.get_our_node_id();
840 let bob_id = bob.node.get_our_node_id();
842 let absolute_expiry = Duration::from_secs(u64::MAX);
843 let payment_id = PaymentId([1; 32]);
844 let refund = bob.node
845 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
849 assert_eq!(refund.payer_id(), bob_id);
850 assert!(refund.paths().is_empty());
851 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
853 let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
854 let expected_invoice = alice.node.request_refund_payment(&refund).unwrap();
856 let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
857 bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
859 let invoice = extract_invoice(bob, &onion_message);
860 assert_eq!(invoice, expected_invoice);
862 route_bolt12_payment(bob, &[alice], &invoice);
863 expect_recent_payment!(bob, RecentPaymentDetails::Pending, payment_id);
865 claim_bolt12_payment(bob, &[alice], payment_context);
866 expect_recent_payment!(bob, RecentPaymentDetails::Fulfilled, payment_id);
869 /// Checks that a deferred invoice can be paid asynchronously from an Event::InvoiceReceived.
871 fn pays_bolt12_invoice_asynchronously() {
872 let mut manually_pay_cfg = test_default_channel_config();
873 manually_pay_cfg.manually_handle_bolt12_invoices = true;
875 let chanmon_cfgs = create_chanmon_cfgs(2);
876 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
877 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_pay_cfg)]);
878 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
880 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
882 let alice = &nodes[0];
883 let alice_id = alice.node.get_our_node_id();
885 let bob_id = bob.node.get_our_node_id();
887 let offer = alice.node
888 .create_offer_builder(None).unwrap()
889 .amount_msats(10_000_000)
892 let payment_id = PaymentId([1; 32]);
893 bob.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None).unwrap();
894 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
896 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
897 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
899 let (invoice_request, _) = extract_invoice_request(alice, &onion_message);
900 let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
901 offer_id: offer.id(),
902 invoice_request: InvoiceRequestFields {
903 payer_id: invoice_request.payer_id(),
905 payer_note_truncated: None,
909 let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
910 bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
912 let invoice = match get_event!(bob, Event::InvoiceReceived) {
913 Event::InvoiceReceived { payment_id: actual_payment_id, invoice, .. } => {
914 assert_eq!(actual_payment_id, payment_id);
917 _ => panic!("No Event::InvoiceReceived"),
919 assert_eq!(invoice.amount_msats(), 10_000_000);
920 assert_ne!(invoice.signing_pubkey(), alice_id);
921 assert!(!invoice.payment_paths().is_empty());
922 for (_, path) in invoice.payment_paths() {
923 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
926 assert!(bob.node.send_payment_for_bolt12_invoice(&invoice).is_ok());
928 bob.node.send_payment_for_bolt12_invoice(&invoice),
929 Err(Bolt12PaymentError::DuplicateInvoice),
932 route_bolt12_payment(bob, &[alice], &invoice);
933 expect_recent_payment!(bob, RecentPaymentDetails::Pending, payment_id);
935 claim_bolt12_payment(bob, &[alice], payment_context);
936 expect_recent_payment!(bob, RecentPaymentDetails::Fulfilled, payment_id);
939 bob.node.send_payment_for_bolt12_invoice(&invoice),
940 Err(Bolt12PaymentError::DuplicateInvoice),
943 for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
944 bob.node.timer_tick_occurred();
948 bob.node.send_payment_for_bolt12_invoice(&invoice),
949 Err(Bolt12PaymentError::UnexpectedInvoice),
953 /// Checks that an offer can be created using an unannounced node as a blinded path's introduction
954 /// node. This is only preferred if there are no other options which may indicated either the offer
955 /// is intended for the unannounced node or that the node is actually announced (e.g., an LSP) but
956 /// the recipient doesn't have a network graph.
958 fn creates_offer_with_blinded_path_using_unannounced_introduction_node() {
959 let chanmon_cfgs = create_chanmon_cfgs(2);
960 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
961 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
962 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
964 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
966 let alice = &nodes[0];
967 let alice_id = alice.node.get_our_node_id();
969 let bob_id = bob.node.get_our_node_id();
971 let offer = alice.node
972 .create_offer_builder(None).unwrap()
973 .amount_msats(10_000_000)
975 assert_ne!(offer.signing_pubkey(), Some(alice_id));
976 assert!(!offer.paths().is_empty());
977 for path in offer.paths() {
978 assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
981 let payment_id = PaymentId([1; 32]);
982 bob.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None).unwrap();
983 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
985 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
986 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
988 let (_, reply_path) = extract_invoice_request(alice, &onion_message);
989 assert_eq!(reply_path.introduction_node, IntroductionNode::NodeId(alice_id));
992 /// Checks that a refund can be created using an unannounced node as a blinded path's introduction
993 /// node. This is only preferred if there are no other options which may indicated either the refund
994 /// is intended for the unannounced node or that the node is actually announced (e.g., an LSP) but
995 /// the sender doesn't have a network graph.
997 fn creates_refund_with_blinded_path_using_unannounced_introduction_node() {
998 let chanmon_cfgs = create_chanmon_cfgs(2);
999 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1000 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1001 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1003 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1005 let alice = &nodes[0];
1006 let alice_id = alice.node.get_our_node_id();
1007 let bob = &nodes[1];
1008 let bob_id = bob.node.get_our_node_id();
1010 let absolute_expiry = Duration::from_secs(u64::MAX);
1011 let payment_id = PaymentId([1; 32]);
1012 let refund = bob.node
1013 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
1016 assert_ne!(refund.payer_id(), bob_id);
1017 assert!(!refund.paths().is_empty());
1018 for path in refund.paths() {
1019 assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
1021 expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
1024 /// Fails creating or paying an offer when a blinded path cannot be created because no peers are
1027 fn fails_creating_or_paying_for_offer_without_connected_peers() {
1028 let chanmon_cfgs = create_chanmon_cfgs(6);
1029 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1030 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1031 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1033 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1034 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1035 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1036 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1037 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1038 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
1039 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
1041 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1043 disconnect_peers(alice, &[bob, charlie, david, &nodes[4], &nodes[5]]);
1044 disconnect_peers(david, &[bob, charlie, &nodes[4], &nodes[5]]);
1046 let absolute_expiry = alice.node.duration_since_epoch() + MAX_SHORT_LIVED_RELATIVE_EXPIRY;
1047 match alice.node.create_offer_builder(Some(absolute_expiry)) {
1048 Ok(_) => panic!("Expected error"),
1049 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
1052 let mut args = ReconnectArgs::new(alice, bob);
1053 args.send_channel_ready = (true, true);
1054 reconnect_nodes(args);
1056 let offer = alice.node
1057 .create_offer_builder(Some(absolute_expiry)).unwrap()
1058 .amount_msats(10_000_000)
1061 let payment_id = PaymentId([1; 32]);
1063 match david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
1064 Ok(_) => panic!("Expected error"),
1065 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
1068 assert!(nodes[0].node.list_recent_payments().is_empty());
1070 let mut args = ReconnectArgs::new(charlie, david);
1071 args.send_channel_ready = (true, true);
1072 reconnect_nodes(args);
1075 david.node.pay_for_offer(
1076 &offer, None, None, None, payment_id, Retry::Attempts(0), None
1080 expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
1083 /// Fails creating or sending an invoice for a refund when a blinded path cannot be created because
1084 /// no peers are connected.
1086 fn fails_creating_refund_or_sending_invoice_without_connected_peers() {
1087 let mut accept_forward_cfg = test_default_channel_config();
1088 accept_forward_cfg.accept_forwards_to_priv_channels = true;
1090 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
1091 features.set_onion_messages_optional();
1092 features.set_route_blinding_optional();
1094 let chanmon_cfgs = create_chanmon_cfgs(6);
1095 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1097 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
1099 let node_chanmgrs = create_node_chanmgrs(
1100 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
1102 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1104 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1105 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1106 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1107 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1108 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1109 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
1110 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
1112 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1114 disconnect_peers(alice, &[bob, charlie, david, &nodes[4], &nodes[5]]);
1115 disconnect_peers(david, &[bob, charlie, &nodes[4], &nodes[5]]);
1117 let absolute_expiry = david.node.duration_since_epoch() + MAX_SHORT_LIVED_RELATIVE_EXPIRY;
1118 let payment_id = PaymentId([1; 32]);
1119 match david.node.create_refund_builder(
1120 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
1122 Ok(_) => panic!("Expected error"),
1123 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
1126 let mut args = ReconnectArgs::new(charlie, david);
1127 args.send_channel_ready = (true, true);
1128 reconnect_nodes(args);
1130 let refund = david.node
1131 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
1135 match alice.node.request_refund_payment(&refund) {
1136 Ok(_) => panic!("Expected error"),
1137 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
1140 let mut args = ReconnectArgs::new(alice, bob);
1141 args.send_channel_ready = (true, true);
1142 reconnect_nodes(args);
1144 assert!(alice.node.request_refund_payment(&refund).is_ok());
1147 /// Fails creating an invoice request when the offer contains an unsupported chain.
1149 fn fails_creating_invoice_request_for_unsupported_chain() {
1150 let chanmon_cfgs = create_chanmon_cfgs(2);
1151 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1152 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1153 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1155 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1157 let alice = &nodes[0];
1158 let bob = &nodes[1];
1160 let offer = alice.node
1161 .create_offer_builder(None).unwrap()
1163 .chain(Network::Signet)
1166 let payment_id = PaymentId([1; 32]);
1167 match bob.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
1168 Ok(_) => panic!("Expected error"),
1169 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1173 /// Fails requesting a payment when the refund contains an unsupported chain.
1175 fn fails_sending_invoice_with_unsupported_chain_for_refund() {
1176 let chanmon_cfgs = create_chanmon_cfgs(2);
1177 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1178 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1179 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1181 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1183 let alice = &nodes[0];
1184 let bob = &nodes[1];
1186 let absolute_expiry = Duration::from_secs(u64::MAX);
1187 let payment_id = PaymentId([1; 32]);
1188 let refund = bob.node
1189 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
1191 .chain(Network::Signet)
1194 match alice.node.request_refund_payment(&refund) {
1195 Ok(_) => panic!("Expected error"),
1196 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1200 /// Fails creating an invoice request when a blinded reply path cannot be created.
1202 fn fails_creating_invoice_request_without_blinded_reply_path() {
1203 let chanmon_cfgs = create_chanmon_cfgs(6);
1204 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1205 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1206 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1208 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1209 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1210 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1211 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1212 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1214 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1216 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
1217 disconnect_peers(david, &[bob, charlie, &nodes[4], &nodes[5]]);
1219 let offer = alice.node
1220 .create_offer_builder(None).unwrap()
1221 .amount_msats(10_000_000)
1224 let payment_id = PaymentId([1; 32]);
1226 match david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
1227 Ok(_) => panic!("Expected error"),
1228 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
1231 assert!(nodes[0].node.list_recent_payments().is_empty());
1235 fn fails_creating_invoice_request_with_duplicate_payment_id() {
1236 let chanmon_cfgs = create_chanmon_cfgs(6);
1237 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1238 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1239 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1241 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1242 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1243 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1244 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1245 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1246 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
1247 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
1249 let (alice, _bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1251 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
1253 let offer = alice.node
1254 .create_offer_builder(None).unwrap()
1255 .amount_msats(10_000_000)
1258 let payment_id = PaymentId([1; 32]);
1260 david.node.pay_for_offer(
1261 &offer, None, None, None, payment_id, Retry::Attempts(0), None
1264 expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
1266 match david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None) {
1267 Ok(_) => panic!("Expected error"),
1268 Err(e) => assert_eq!(e, Bolt12SemanticError::DuplicatePaymentId),
1271 expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
1275 fn fails_creating_refund_with_duplicate_payment_id() {
1276 let chanmon_cfgs = create_chanmon_cfgs(2);
1277 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1278 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1279 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1281 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1283 let absolute_expiry = Duration::from_secs(u64::MAX);
1284 let payment_id = PaymentId([1; 32]);
1286 nodes[0].node.create_refund_builder(
1287 10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
1290 expect_recent_payment!(nodes[0], RecentPaymentDetails::AwaitingInvoice, payment_id);
1292 match nodes[0].node.create_refund_builder(
1293 10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
1295 Ok(_) => panic!("Expected error"),
1296 Err(e) => assert_eq!(e, Bolt12SemanticError::DuplicatePaymentId),
1299 expect_recent_payment!(nodes[0], RecentPaymentDetails::AwaitingInvoice, payment_id);
1303 fn fails_sending_invoice_without_blinded_payment_paths_for_offer() {
1304 let mut accept_forward_cfg = test_default_channel_config();
1305 accept_forward_cfg.accept_forwards_to_priv_channels = true;
1307 // Clearing route_blinding prevents forming any payment paths since the node is unannounced.
1308 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
1309 features.set_onion_messages_optional();
1310 features.clear_route_blinding();
1312 let chanmon_cfgs = create_chanmon_cfgs(6);
1313 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1315 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
1317 let node_chanmgrs = create_node_chanmgrs(
1318 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
1320 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1322 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1323 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1324 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1325 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1326 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1327 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
1328 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
1330 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1331 let alice_id = alice.node.get_our_node_id();
1332 let bob_id = bob.node.get_our_node_id();
1333 let charlie_id = charlie.node.get_our_node_id();
1334 let david_id = david.node.get_our_node_id();
1336 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
1337 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
1339 let offer = alice.node
1340 .create_offer_builder(None).unwrap()
1341 .amount_msats(10_000_000)
1344 let payment_id = PaymentId([1; 32]);
1345 david.node.pay_for_offer(&offer, None, None, None, payment_id, Retry::Attempts(0), None)
1348 connect_peers(david, bob);
1350 let onion_message = david.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
1351 bob.onion_messenger.handle_onion_message(&david_id, &onion_message);
1353 connect_peers(alice, charlie);
1355 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
1356 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
1358 let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
1359 charlie.onion_messenger.handle_onion_message(&alice_id, &onion_message);
1361 let onion_message = charlie.onion_messenger.next_onion_message_for_peer(david_id).unwrap();
1362 david.onion_messenger.handle_onion_message(&charlie_id, &onion_message);
1364 let invoice_error = extract_invoice_error(david, &onion_message);
1365 assert_eq!(invoice_error, InvoiceError::from(Bolt12SemanticError::MissingPaths));
1369 fn fails_sending_invoice_without_blinded_payment_paths_for_refund() {
1370 let mut accept_forward_cfg = test_default_channel_config();
1371 accept_forward_cfg.accept_forwards_to_priv_channels = true;
1373 // Clearing route_blinding prevents forming any payment paths since the node is unannounced.
1374 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
1375 features.set_onion_messages_optional();
1376 features.clear_route_blinding();
1378 let chanmon_cfgs = create_chanmon_cfgs(6);
1379 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1381 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
1383 let node_chanmgrs = create_node_chanmgrs(
1384 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
1386 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1388 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1389 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1390 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1391 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1392 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1393 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
1394 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
1396 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1398 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
1399 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
1401 let absolute_expiry = Duration::from_secs(u64::MAX);
1402 let payment_id = PaymentId([1; 32]);
1403 let refund = david.node
1404 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
1408 match alice.node.request_refund_payment(&refund) {
1409 Ok(_) => panic!("Expected error"),
1410 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
1415 fn fails_paying_invoice_more_than_once() {
1416 let mut accept_forward_cfg = test_default_channel_config();
1417 accept_forward_cfg.accept_forwards_to_priv_channels = true;
1419 let mut features = channelmanager::provided_init_features(&accept_forward_cfg);
1420 features.set_onion_messages_optional();
1421 features.set_route_blinding_optional();
1423 let chanmon_cfgs = create_chanmon_cfgs(6);
1424 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1426 *node_cfgs[1].override_init_features.borrow_mut() = Some(features);
1428 let node_chanmgrs = create_node_chanmgrs(
1429 6, &node_cfgs, &[None, Some(accept_forward_cfg), None, None, None, None]
1431 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433 create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
1434 create_unannounced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 1_000_000_000);
1435 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 1_000_000_000);
1436 create_announced_chan_between_nodes_with_value(&nodes, 1, 4, 10_000_000, 1_000_000_000);
1437 create_announced_chan_between_nodes_with_value(&nodes, 1, 5, 10_000_000, 1_000_000_000);
1438 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 10_000_000, 1_000_000_000);
1439 create_announced_chan_between_nodes_with_value(&nodes, 2, 5, 10_000_000, 1_000_000_000);
1441 let (alice, bob, charlie, david) = (&nodes[0], &nodes[1], &nodes[2], &nodes[3]);
1442 let alice_id = alice.node.get_our_node_id();
1443 let bob_id = bob.node.get_our_node_id();
1444 let charlie_id = charlie.node.get_our_node_id();
1445 let david_id = david.node.get_our_node_id();
1447 disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
1448 disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
1450 let absolute_expiry = Duration::from_secs(u64::MAX);
1451 let payment_id = PaymentId([1; 32]);
1452 let refund = david.node
1453 .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
1456 expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
1458 // Alice sends the first invoice
1459 alice.node.request_refund_payment(&refund).unwrap();
1461 connect_peers(alice, charlie);
1463 let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
1464 charlie.onion_messenger.handle_onion_message(&alice_id, &onion_message);
1466 let onion_message = charlie.onion_messenger.next_onion_message_for_peer(david_id).unwrap();
1467 david.onion_messenger.handle_onion_message(&charlie_id, &onion_message);
1469 // David pays the first invoice
1470 let payment_context = PaymentContext::Bolt12Refund(Bolt12RefundContext {});
1471 let invoice1 = extract_invoice(david, &onion_message);
1473 route_bolt12_payment(david, &[charlie, bob, alice], &invoice1);
1474 expect_recent_payment!(david, RecentPaymentDetails::Pending, payment_id);
1476 claim_bolt12_payment(david, &[charlie, bob, alice], payment_context);
1477 expect_recent_payment!(david, RecentPaymentDetails::Fulfilled, payment_id);
1479 disconnect_peers(alice, &[charlie]);
1481 // Alice sends the second invoice
1482 alice.node.request_refund_payment(&refund).unwrap();
1484 connect_peers(alice, charlie);
1485 connect_peers(david, bob);
1487 let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
1488 charlie.onion_messenger.handle_onion_message(&alice_id, &onion_message);
1490 let onion_message = charlie.onion_messenger.next_onion_message_for_peer(david_id).unwrap();
1491 david.onion_messenger.handle_onion_message(&charlie_id, &onion_message);
1493 let invoice2 = extract_invoice(david, &onion_message);
1494 assert_eq!(invoice1.payer_metadata(), invoice2.payer_metadata());
1496 // David sends an error instead of paying the second invoice
1497 let onion_message = david.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
1498 bob.onion_messenger.handle_onion_message(&david_id, &onion_message);
1500 let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
1501 alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
1503 let invoice_error = extract_invoice_error(alice, &onion_message);
1504 assert_eq!(invoice_error, InvoiceError::from_string("DuplicateInvoice".to_string()));