lightning-unreserveinputs -- Release reserved UTXOs
SYNOPSIS
unreserveinputs psbt [reserve]
DESCRIPTION
The unreserveinputs RPC command releases (or reduces reservation) on UTXOs which were previously marked as reserved, generally by lightning-reserveinputs(7).
- psbt (string): Inputs to unreserve are the inputs specified in the passed-in psbt.
- reserve (u32, optional): The number of blocks to decrease reservation by. The default is 72.
RETURN VALUE
On success, an object containing reservations is returned. It is an array of objects, where each object contains:
- txid (txid): The transaction id.
- vout (u32): The output number which was reserved.
- was_reserved (boolean): Whether the input was already reserved (usually
true
). - reserved (boolean): Whether the input is now reserved (may still be
true
if it was reserved for a long time).
If reserved is true:
- reserved_to_block (u32): What blockheight the reservation will expire.
ERRORS
On failure, an error is reported and no UTXOs are unreserved.
- -32602: Invalid parameter, i.e. an unparseable PSBT.
AUTHOR
Lisa Neigut <[email protected]> is mainly responsible.
SEE ALSO
lightning-unreserveinputs(7), lightning-signpsbt(7), lightning-sendpsbt(7)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning
EXAMPLES
Example 1:
Request:
lightning-cli unreserveinputs -k "psbt"="cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000" "reserve"=200
{
"id": "example:unreserveinputs#1",
"method": "unreserveinputs",
"params": {
"psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000310000",
"reserve": 200
}
}
Response:
{
"reservations": []
}
Example 2:
Request:
lightning-cli unreserveinputs "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000"
{
"id": "example:unreserveinputs#2",
"method": "unreserveinputs",
"params": [
"cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000410000"
]
}
Response:
{
"reservations": []
}