]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Fix capitalization broken in 9d7bb73b599a7a9d8468a2f0c54d28f0ce6cf5 2022-12-1910-followups
authorMatt Corallo <git@bluematt.me>
Wed, 21 Dec 2022 16:39:37 +0000 (16:39 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 21 Dec 2022 16:39:37 +0000 (16:39 +0000)
9d7bb73b599a7a9d8468a2f0c54d28f0ce6cf543 broke some capitalization
in docs for `sign_invoice`, which we fix here as well as taking
this opportunity to clean up the `sign_invoice` docs more
generally.

lightning/src/chain/keysinterface.rs

index 76781376f4ba1ea587fe12d7cecfec58ea373384..58abe7e9ddcb2dcf71ce26ec9ddd9d1824bb2f47 100644 (file)
@@ -483,10 +483,12 @@ pub trait NodeSigner {
        fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()>;
 
        /// Sign an invoice.
+       ///
        /// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
        /// this trait to parse the invoice and make sure they're signing what they expect, rather than
        /// blindly signing the hash.
-       /// The hrp is ascii bytes, while the invoice data is base32.
+       ///
+       /// The `hrp_bytes` are ASCII bytes, while the `invoice_data` is base32.
        ///
        /// The secret key used to sign the invoice is dependent on the [`Recipient`].
        ///