Builder for creating static invoices from offers
[rust-lightning] / lightning / src / ln / offers_tests.rs
index e89e113e8ea887e37373c39f4b6e9f8a28754342..eedd82c569be4acdb1c0d50390db02c7819e5b18 100644 (file)
 //! Nodes without channels are disconnected and connected as needed to ensure that deterministic
 //! blinded paths are used.
 
-use bitcoin::network::constants::Network;
+use bitcoin::network::Network;
+use bitcoin::secp256k1::PublicKey;
 use core::time::Duration;
 use crate::blinded_path::{BlindedPath, IntroductionNode};
 use crate::blinded_path::payment::{Bolt12OfferContext, Bolt12RefundContext, PaymentContext};
 use crate::events::{Event, MessageSendEventsProvider, PaymentPurpose};
 use crate::ln::channelmanager::{PaymentId, RecentPaymentDetails, Retry, self};
-use crate::ln::features::InvoiceRequestFeatures;
 use crate::ln::functional_test_utils::*;
 use crate::ln::msgs::{ChannelMessageHandler, Init, NodeAnnouncement, OnionMessage, OnionMessageHandler, RoutingMessageHandler, SocketAddress, UnsignedGossipMessage, UnsignedNodeAnnouncement};
 use crate::offers::invoice::Bolt12Invoice;
@@ -134,6 +134,12 @@ fn announce_node_address<'a, 'b, 'c>(
        }
 }
 
+fn resolve_introduction_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, path: &BlindedPath) -> PublicKey {
+       path.public_introduction_node_id(&node.network_graph.read_only())
+               .and_then(|node_id| node_id.as_pubkey().ok())
+               .unwrap()
+}
+
 fn route_bolt12_payment<'a, 'b, 'c>(
        node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], invoice: &Bolt12Invoice
 ) {
@@ -179,11 +185,11 @@ fn claim_bolt12_payment<'a, 'b, 'c>(
 
 fn extract_invoice_request<'a, 'b, 'c>(
        node: &Node<'a, 'b, 'c>, message: &OnionMessage
-) -> (InvoiceRequest, Option<BlindedPath>) {
+) -> (InvoiceRequest, BlindedPath) {
        match node.onion_messenger.peel_onion_message(message) {
                Ok(PeeledOnion::Receive(message, _, reply_path)) => match message {
                        ParsedOnionMessageContents::Offers(offers_message) => match offers_message {
-                               OffersMessage::InvoiceRequest(invoice_request) => (invoice_request, reply_path),
+                               OffersMessage::InvoiceRequest(invoice_request) => (invoice_request, reply_path.unwrap()),
                                OffersMessage::Invoice(invoice) => panic!("Unexpected invoice: {:?}", invoice),
                                OffersMessage::InvoiceError(error) => panic!("Unexpected invoice_error: {:?}", error),
                        },
@@ -268,14 +274,15 @@ fn prefers_non_tor_nodes_in_blinded_paths() {
        announce_node_address(charlie, &[alice, bob, david, &nodes[4], &nodes[5]], tor.clone());
 
        let offer = bob.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
        assert_ne!(offer.signing_pubkey(), Some(bob_id));
        assert!(!offer.paths().is_empty());
        for path in offer.paths() {
-               assert_ne!(path.introduction_node, IntroductionNode::NodeId(bob_id));
-               assert_ne!(path.introduction_node, IntroductionNode::NodeId(charlie_id));
+               let introduction_node_id = resolve_introduction_node(david, &path);
+               assert_ne!(introduction_node_id, bob_id);
+               assert_ne!(introduction_node_id, charlie_id);
        }
 
        // Use a one-hop blinded path when Bob is announced and all his peers are Tor-only.
@@ -283,13 +290,14 @@ fn prefers_non_tor_nodes_in_blinded_paths() {
        announce_node_address(&nodes[5], &[alice, bob, charlie, david, &nodes[4]], tor.clone());
 
        let offer = bob.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
        assert_ne!(offer.signing_pubkey(), Some(bob_id));
        assert!(!offer.paths().is_empty());
        for path in offer.paths() {
-               assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
+               let introduction_node_id = resolve_introduction_node(david, &path);
+               assert_eq!(introduction_node_id, bob_id);
        }
 }
 
@@ -333,13 +341,14 @@ fn prefers_more_connected_nodes_in_blinded_paths() {
        disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
 
        let offer = bob.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
        assert_ne!(offer.signing_pubkey(), Some(bob_id));
        assert!(!offer.paths().is_empty());
        for path in offer.paths() {
-               assert_eq!(path.introduction_node, IntroductionNode::NodeId(nodes[4].node.get_our_node_id()));
+               let introduction_node_id = resolve_introduction_node(david, &path);
+               assert_eq!(introduction_node_id, nodes[4].node.get_our_node_id());
        }
 }
 
@@ -382,14 +391,16 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
        disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string())
+               .create_offer_builder()
                .unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
        assert_ne!(offer.signing_pubkey(), Some(alice_id));
        assert!(!offer.paths().is_empty());
        for path in offer.paths() {
-               assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
+               let introduction_node_id = resolve_introduction_node(david, &path);
+               assert_eq!(introduction_node_id, bob_id);
+               assert!(matches!(path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
        }
 
        let payment_id = PaymentId([1; 32]);
@@ -412,15 +423,15 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
                offer_id: offer.id(),
                invoice_request: InvoiceRequestFields {
                        payer_id: invoice_request.payer_id(),
-                       amount_msats: None,
-                       features: InvoiceRequestFeatures::empty(),
                        quantity: None,
                        payer_note_truncated: None,
                },
        });
+       let introduction_node_id = resolve_introduction_node(alice, &reply_path);
        assert_eq!(invoice_request.amount_msats(), None);
        assert_ne!(invoice_request.payer_id(), david_id);
-       assert_eq!(reply_path.unwrap().introduction_node, IntroductionNode::NodeId(charlie_id));
+       assert_eq!(introduction_node_id, charlie_id);
+       assert!(matches!(reply_path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
 
        let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
        charlie.onion_messenger.handle_onion_message(&alice_id, &onion_message);
@@ -484,9 +495,7 @@ fn creates_and_pays_for_refund_using_two_hop_blinded_path() {
        let absolute_expiry = Duration::from_secs(u64::MAX);
        let payment_id = PaymentId([1; 32]);
        let refund = david.node
-               .create_refund_builder(
-                       "refund".to_string(), 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
-               )
+               .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
                .unwrap()
                .build().unwrap();
        assert_eq!(refund.amount_msats(), 10_000_000);
@@ -494,7 +503,9 @@ fn creates_and_pays_for_refund_using_two_hop_blinded_path() {
        assert_ne!(refund.payer_id(), david_id);
        assert!(!refund.paths().is_empty());
        for path in refund.paths() {
-               assert_eq!(path.introduction_node, IntroductionNode::NodeId(charlie_id));
+               let introduction_node_id = resolve_introduction_node(alice, &path);
+               assert_eq!(introduction_node_id, charlie_id);
+               assert!(matches!(path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
        }
        expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
@@ -544,13 +555,15 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
        let bob_id = bob.node.get_our_node_id();
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
        assert_ne!(offer.signing_pubkey(), Some(alice_id));
        assert!(!offer.paths().is_empty());
        for path in offer.paths() {
-               assert_eq!(path.introduction_node, IntroductionNode::NodeId(alice_id));
+               let introduction_node_id = resolve_introduction_node(bob, &path);
+               assert_eq!(introduction_node_id, alice_id);
+               assert!(matches!(path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
        }
 
        let payment_id = PaymentId([1; 32]);
@@ -565,15 +578,15 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
                offer_id: offer.id(),
                invoice_request: InvoiceRequestFields {
                        payer_id: invoice_request.payer_id(),
-                       amount_msats: None,
-                       features: InvoiceRequestFeatures::empty(),
                        quantity: None,
                        payer_note_truncated: None,
                },
        });
+       let introduction_node_id = resolve_introduction_node(alice, &reply_path);
        assert_eq!(invoice_request.amount_msats(), None);
        assert_ne!(invoice_request.payer_id(), bob_id);
-       assert_eq!(reply_path.unwrap().introduction_node, IntroductionNode::NodeId(bob_id));
+       assert_eq!(introduction_node_id, bob_id);
+       assert!(matches!(reply_path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
 
        let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
        bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
@@ -613,9 +626,7 @@ fn creates_and_pays_for_refund_using_one_hop_blinded_path() {
        let absolute_expiry = Duration::from_secs(u64::MAX);
        let payment_id = PaymentId([1; 32]);
        let refund = bob.node
-               .create_refund_builder(
-                       "refund".to_string(), 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
-               )
+               .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
                .unwrap()
                .build().unwrap();
        assert_eq!(refund.amount_msats(), 10_000_000);
@@ -623,7 +634,9 @@ fn creates_and_pays_for_refund_using_one_hop_blinded_path() {
        assert_ne!(refund.payer_id(), bob_id);
        assert!(!refund.paths().is_empty());
        for path in refund.paths() {
-               assert_eq!(path.introduction_node, IntroductionNode::NodeId(bob_id));
+               let introduction_node_id = resolve_introduction_node(alice, &path);
+               assert_eq!(introduction_node_id, bob_id);
+               assert!(matches!(path.introduction_node, IntroductionNode::DirectedShortChannelId(..)));
        }
        expect_recent_payment!(bob, RecentPaymentDetails::AwaitingInvoice, payment_id);
 
@@ -668,7 +681,7 @@ fn pays_for_offer_without_blinded_paths() {
        let bob_id = bob.node.get_our_node_id();
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .clear_paths()
                .amount_msats(10_000_000)
                .build().unwrap();
@@ -687,8 +700,6 @@ fn pays_for_offer_without_blinded_paths() {
                offer_id: offer.id(),
                invoice_request: InvoiceRequestFields {
                        payer_id: invoice_request.payer_id(),
-                       amount_msats: None,
-                       features: InvoiceRequestFeatures::empty(),
                        quantity: None,
                        payer_note_truncated: None,
                },
@@ -724,9 +735,7 @@ fn pays_for_refund_without_blinded_paths() {
        let absolute_expiry = Duration::from_secs(u64::MAX);
        let payment_id = PaymentId([1; 32]);
        let refund = bob.node
-               .create_refund_builder(
-                       "refund".to_string(), 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
-               )
+               .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
                .unwrap()
                .clear_paths()
                .build().unwrap();
@@ -760,7 +769,7 @@ fn fails_creating_offer_without_blinded_paths() {
 
        create_unannounced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 1_000_000_000);
 
-       match nodes[0].node.create_offer_builder("coffee".to_string()) {
+       match nodes[0].node.create_offer_builder() {
                Ok(_) => panic!("Expected error"),
                Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
        }
@@ -780,7 +789,7 @@ fn fails_creating_refund_without_blinded_paths() {
        let payment_id = PaymentId([1; 32]);
 
        match nodes[0].node.create_refund_builder(
-               "refund".to_string(), 10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
+               10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
        ) {
                Ok(_) => panic!("Expected error"),
                Err(e) => assert_eq!(e, Bolt12SemanticError::MissingPaths),
@@ -803,7 +812,7 @@ fn fails_creating_invoice_request_for_unsupported_chain() {
        let bob = &nodes[1];
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .clear_chains()
                .chain(Network::Signet)
                .build().unwrap();
@@ -831,9 +840,7 @@ fn fails_sending_invoice_with_unsupported_chain_for_refund() {
        let absolute_expiry = Duration::from_secs(u64::MAX);
        let payment_id = PaymentId([1; 32]);
        let refund = bob.node
-               .create_refund_builder(
-                       "refund".to_string(), 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
-               )
+               .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
                .unwrap()
                .chain(Network::Signet)
                .build().unwrap();
@@ -865,7 +872,7 @@ fn fails_creating_invoice_request_without_blinded_reply_path() {
        disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
 
@@ -899,7 +906,7 @@ fn fails_creating_invoice_request_with_duplicate_payment_id() {
        disconnect_peers(alice, &[charlie, david, &nodes[4], &nodes[5]]);
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
 
@@ -932,13 +939,13 @@ fn fails_creating_refund_with_duplicate_payment_id() {
        let payment_id = PaymentId([1; 32]);
        assert!(
                nodes[0].node.create_refund_builder(
-                       "refund".to_string(), 10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
+                       10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
                ).is_ok()
        );
        expect_recent_payment!(nodes[0], RecentPaymentDetails::AwaitingInvoice, payment_id);
 
        match nodes[0].node.create_refund_builder(
-               "refund".to_string(), 10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
+               10_000, absolute_expiry, payment_id, Retry::Attempts(0), None
        ) {
                Ok(_) => panic!("Expected error"),
                Err(e) => assert_eq!(e, Bolt12SemanticError::DuplicatePaymentId),
@@ -985,7 +992,7 @@ fn fails_sending_invoice_without_blinded_payment_paths_for_offer() {
        disconnect_peers(david, &[bob, &nodes[4], &nodes[5]]);
 
        let offer = alice.node
-               .create_offer_builder("coffee".to_string()).unwrap()
+               .create_offer_builder().unwrap()
                .amount_msats(10_000_000)
                .build().unwrap();
 
@@ -1049,9 +1056,7 @@ fn fails_sending_invoice_without_blinded_payment_paths_for_refund() {
        let absolute_expiry = Duration::from_secs(u64::MAX);
        let payment_id = PaymentId([1; 32]);
        let refund = david.node
-               .create_refund_builder(
-                       "refund".to_string(), 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
-               )
+               .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
                .unwrap()
                .build().unwrap();
 
@@ -1100,9 +1105,7 @@ fn fails_paying_invoice_more_than_once() {
        let absolute_expiry = Duration::from_secs(u64::MAX);
        let payment_id = PaymentId([1; 32]);
        let refund = david.node
-               .create_refund_builder(
-                       "refund".to_string(), 10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None
-               )
+               .create_refund_builder(10_000_000, absolute_expiry, payment_id, Retry::Attempts(0), None)
                .unwrap()
                .build().unwrap();
        expect_recent_payment!(david, RecentPaymentDetails::AwaitingInvoice, payment_id);