Fix BlindedPath::new_for_payment docs
authorValentine Wallace <vwallace@protonmail.com>
Mon, 28 Aug 2023 17:20:11 +0000 (13:20 -0400)
committerValentine Wallace <vwallace@protonmail.com>
Mon, 28 Aug 2023 17:20:11 +0000 (13:20 -0400)
lightning/src/blinded_path/mod.rs

index 89087a10cd414ac9fdeae4331490ef97e73666ea..8569a9ef9743f8a3cb326517a77a152cccc82ad4 100644 (file)
@@ -75,10 +75,9 @@ impl BlindedPath {
                })
        }
 
-       /// Create a blinded path for a payment, to be forwarded along `path`. The last node
-       /// in `path` will be the destination node.
+       /// Create a blinded path for a payment, to be forwarded along `intermediate_nodes`.
        ///
-       /// Errors if `path` is empty or a node id in `path` is invalid.
+       /// Errors if a provided node id is invalid.
        //  TODO: make all payloads the same size with padding + add dummy hops
        pub fn new_for_payment<ES: EntropySource, T: secp256k1::Signing + secp256k1::Verification>(
                intermediate_nodes: &[(PublicKey, payment::ForwardTlvs)], payee_node_id: PublicKey,