Skip to content

Commit fa42b5e

Browse files
committed
Fix capitalization broken in 9d7bb73
9d7bb73 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.
1 parent ac690e8 commit fa42b5e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

lightning/src/chain/keysinterface.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,10 +483,12 @@ pub trait NodeSigner {
483483
fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()>;
484484

485485
/// Sign an invoice.
486+
///
486487
/// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
487488
/// this trait to parse the invoice and make sure they're signing what they expect, rather than
488489
/// blindly signing the hash.
489-
/// The hrp is ascii bytes, while the invoice data is base32.
490+
///
491+
/// The `hrp_bytes` are ASCII bytes, while the `invoice_data` is base32.
490492
///
491493
/// The secret key used to sign the invoice is dependent on the [`Recipient`].
492494
///

0 commit comments

Comments
 (0)