core-lightning/doc/lightning-unreserveinputs.7
Rusty Russell a00179d557 doc, wiregen: use SHA256 stamps instead of git versions.
This should be more robust in future: we SHA256 all of the deps.
For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-31 21:33:26 -05:00

59 lines
1.5 KiB
Groff
Generated

.TH "LIGHTNING-UNRESERVEINPUTS" "7" "" "" "lightning-unreserveinputs"
.SH NAME
lightning-unreserveinputs - Release reserved UTXOs
.SH SYNOPSIS
\fBunreserveinputs\fR \fIpsbt\fR
.SH DESCRIPTION
The \fBunreserveinputs\fR RPC command releases (or reduces reservation)
on UTXOs which were previously marked as reserved, generally by
\fBlightning-reserveinputs\fR(7)\.
The inputs to unreserve are the inputs specified in the passed-in \fIpsbt\fR\.
.SH RETURN VALUE
On success, an \fIreservations\fR array is returned, with an entry for each input
which was reserved:
.RS
.IP \[bu]
\fItxid\fR is the input transaction id\.
.IP \[bu]
\fIvout\fR is the input index\.
.IP \[bu]
\fIwas_reserved\fR indicates whether the input was already reserved (generally true)
.IP \[bu]
\fIreserved\fR indicates that the input is now reserved (may still be true, if it was previously reserved for a long time)\.
.IP \[bu]
\fIreserved_to_block\fR (if \fIreserved\fR is still true) indicates what blockheight the reservation will expire\.
.RE
On failure, an error is reported and no UTXOs are unreserved\.
The following error codes may occur:
.RS
.IP \[bu]
-32602: Invalid parameter, i\.e\. an unparseable PSBT\.
.RE
.SH AUTHOR
niftynei \fI<niftynei@gmail.com\fR> is mainly responsible\.
.SH SEE ALSO
\fBlightning-unreserveinputs\fR(7), \fBlightning-signpsbt\fR(7), \fBlightning-sendpsbt\fR(7)
.SH RESOURCES
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:2f6d02c98127f7ab54e5c298761be2c4138f79fd6c156eed9ae19ead03db8593