68 lines
1.7 KiB
Groff
68 lines
1.7 KiB
Groff
.TH "LIGHTNING-UNRESERVEINPUTS" "7" "" "" "lightning-unreserveinputs"
|
|
.SH NAME
|
|
lightning-unreserveinputs - Release reserved UTXOs
|
|
.SH SYNOPSIS
|
|
|
|
\fBunreserveinputs\fR \fIpsbt\fR [\fIreserve\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\.
|
|
|
|
|
|
If \fIreserve\fR is specified, it is the number of blocks to decrease
|
|
reservation by; default is 72\.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success, an object containing \fBreservations\fR is returned\. It is an array of objects, where each object contains:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBtxid\fR (txid): the transaction id
|
|
.IP \[bu]
|
|
\fBvout\fR (u32): the output number which was reserved
|
|
.IP \[bu]
|
|
\fBwas_reserved\fR (boolean): whether the input was already reserved (usually \fBtrue\fR)
|
|
.IP \[bu]
|
|
\fBreserved\fR (boolean): whether the input is now reserved (may still be \fBtrue\fR if it was reserved for a long time)
|
|
|
|
.RE
|
|
|
|
If \fBreserved\fR is \fItrue\fR:
|
|
|
|
.RS
|
|
.IP \[bu]
|
|
\fBreserved_to_block\fR (u32): 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:ff7207d1205cf34ae8f1487f8cec719ea15d9d27ed2d805a8c095eb0d22935c8
|