Skip to content

Commit 75ece86

Browse files
fixup: Improve sign_message documentation
1 parent c1a2329 commit 75ece86

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lightning/src/sign/mod.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -932,6 +932,11 @@ pub trait NodeSigner {
932932
fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()>;
933933

934934
/// Sign an arbitrary message with the node's secret key.
935+
///
936+
/// Creates a digital signature of a message given the node's secret.
937+
/// A receiver knowing the node's id and the message can be sure that the signature was generated by the caller.
938+
/// An `Err` can be returned to signal that the signer is unavailable / cannot produce a valid
939+
/// signature.
935940
fn sign_message(&self, msg: &[u8]) -> Result<String, ()>;
936941
}
937942

0 commit comments

Comments
 (0)