mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
2ddecdc95a
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
44 lines
1.2 KiB
Groff
Generated
44 lines
1.2 KiB
Groff
Generated
.TH "LIGHTNING-SIGNMESSAGE" "7" "" "" "lightning-signmessage"
|
|
.SH NAME
|
|
lightning-signmessage - Command to create a signature from this node
|
|
.SH SYNOPSIS
|
|
|
|
\fBsignmessage\fR \fImessage\fR
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBsignmessage\fR RPC command creates a digital signature of
|
|
\fImessage\fR using this node's secret key\. A receiver who knows your
|
|
node's \fIid\fR and the \fImessage\fR can be sure that the resulting signature could
|
|
only be created by something with access to this node's secret key\.
|
|
|
|
|
|
\fImessage\fR must be less that 65536 characters\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object is returned, containing:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBsignature\fR (hex): The signature (always 128 characters)
|
|
.IP \[bu]
|
|
\fBrecid\fR (hex): The recovery id (0, 1, 2 or 3) (always 2 characters)
|
|
.IP \[bu]
|
|
\fBzbase\fR (string): \fIsignature\fR and \fIrecid\fR encoded in a style compatible with \fBlnd\fR's \fBSignMessageRequest\fR (\fIhttps://api.lightning.community/#grpc-request-signmessagerequest\fR)
|
|
|
|
.RE
|
|
.SH AUTHOR
|
|
|
|
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBlightning-checkmessage\fR(7)
|
|
|
|
.SH RESOURCES
|
|
|
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
|
|
|
\" SHA256STAMP:9b93ee7140ffee478035e0b2a13a71dc3797bb65e04aaed4f2caa95043f39614
|