core-lightning/doc/lightning-txdiscard.7
Rusty Russell 2ddecdc95a doc: schemas for everything else.
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.
2021-06-25 09:49:33 +09:30

50 lines
1.1 KiB
Groff
Generated

.TH "LIGHTNING-TXDISCARD" "7" "" "" "lightning-txdiscard"
.SH NAME
lightning-txdiscard - Abandon a transaction from txprepare, release inputs
.SH SYNOPSIS
\fBtxdiscard\fR \fItxid\fR
.SH DESCRIPTION
The \fBtxdiscard\fR RPC command releases inputs which were reserved for
use of the \fItxid\fR from \fBlightning-txprepare\fR(7)\.
.SH RETURN VALUE
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBunsigned_tx\fR (hex): the unsigned transaction
.IP \[bu]
\fBtxid\fR (txid): the transaction id of \fIunsigned_tx\fR
.RE
If there is no matching \fItxid\fR, an error is reported\. Note that this may
happen due to incorrect usage, such as \fBtxdiscard\fR or \fBtxsend\fR
already being called for \fItxid\fR\.
The following error codes may occur:
.RS
.IP \[bu]
-1: An unknown \fItxid\fR\.
.RE
.SH AUTHOR
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-txprepare\fR(7), \fBlightning-txsend\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:af562e4efa41431ac7692900acd231e8baf91c1fab4884788ee9746242aac8d6