f - document sign_message

Author: jkczyz

lightning/src/offers/merkle.rs

@@ -24,6 +24,10 @@ tlv_stream!(SignatureTlvStream, SignatureTlvStreamRef, SIGNATURE_TYPES, {
 	(240, signature: Signature),
 });
 
+/// Signs a message digest consisting of a tagged hash of the given bytes, checking if it can be
+/// verified with the supplied pubkey.
+///
+/// Assumes `bytes` is a well-formed TLV stream containing at least one TLV record.
 pub(super) fn sign_message<F>(
 	sign: F, tag: &str, bytes: &[u8], pubkey: PublicKey,
 ) -> Result<Signature, secp256k1::Error>