Don't require Refund::description in API
[rust-lightning] / lightning / src / ln / offers_tests.rs
index 4910f38f311bdc0f4d712d686a13fee393a2d254..24ff1c25c8f7692975eeca9ebb195ee111c57ed8 100644 (file)
@@ -46,11 +46,12 @@ 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;
 use crate::offers::invoice_error::InvoiceError;
-use crate::offers::invoice_request::InvoiceRequest;
+use crate::offers::invoice_request::{InvoiceRequest, InvoiceRequestFields};
 use crate::offers::parse::Bolt12SemanticError;
 use crate::onion_message::messenger::PeeledOnion;
 use crate::onion_message::offers::OffersMessage;
@@ -267,10 +268,10 @@ 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(), bob_id);
+       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));
@@ -282,10 +283,10 @@ 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(), bob_id);
+       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));
@@ -332,10 +333,10 @@ 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(), bob_id);
+       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()));
@@ -381,12 +382,11 @@ 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();
-       let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext { offer_id: offer.id() });
-       assert_ne!(offer.signing_pubkey(), alice_id);
+       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));
@@ -408,6 +408,16 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
        alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
 
        let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
+       let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
+               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,
+               },
+       });
        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));
@@ -474,9 +484,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);
@@ -534,11 +542,10 @@ 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();
-       let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext { offer_id: offer.id() });
-       assert_ne!(offer.signing_pubkey(), alice_id);
+       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));
@@ -552,6 +559,16 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
        alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
 
        let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
+       let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
+               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,
+               },
+       });
        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));
@@ -594,9 +611,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);
@@ -649,12 +664,11 @@ 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();
-       let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext { offer_id: offer.id() });
-       assert_eq!(offer.signing_pubkey(), alice_id);
+       assert_eq!(offer.signing_pubkey(), Some(alice_id));
        assert!(offer.paths().is_empty());
 
        let payment_id = PaymentId([1; 32]);
@@ -664,6 +678,18 @@ fn pays_for_offer_without_blinded_paths() {
        let onion_message = bob.onion_messenger.next_onion_message_for_peer(alice_id).unwrap();
        alice.onion_messenger.handle_onion_message(&bob_id, &onion_message);
 
+       let (invoice_request, _) = extract_invoice_request(alice, &onion_message);
+       let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
+               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 onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
        bob.onion_messenger.handle_onion_message(&alice_id, &onion_message);
 
@@ -694,9 +720,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();
@@ -730,7 +754,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),
        }
@@ -750,7 +774,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),
@@ -773,7 +797,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();
@@ -801,9 +825,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();
@@ -835,7 +857,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();
 
@@ -869,7 +891,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();
 
@@ -902,13 +924,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),
@@ -955,7 +977,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();
 
@@ -1019,9 +1041,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();
 
@@ -1070,9 +1090,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);