From fa42b5ea8288faacd2a1cf67269c8f764ecd6326 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Wed, 21 Dec 2022 16:39:37 +0000 Subject: [PATCH] Fix capitalization broken in 9d7bb73b599a7a9d8468a2f0c54d28f0ce6cf5 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 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lightning/src/chain/keysinterface.rs b/lightning/src/chain/keysinterface.rs index 76781376f..58abe7e9d 100644 --- a/lightning/src/chain/keysinterface.rs +++ b/lightning/src/chain/keysinterface.rs @@ -483,10 +483,12 @@ pub trait NodeSigner { fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result; /// 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`]. /// -- 2.39.5