mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00
Code Issues Projects Releases Wiki Activity
67cde96397
core-lightning/doc/lightning-unreserveinputs.7.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
lightning-unreserveinputs -- Release reserved UTXOs
===================================================
SYNOPSIS
--------
**unreserveinputs** *psbt*
DESCRIPTION
-----------
wallet: new JSON commands reserveinputs and unreserveinputs. reserveinputs marks UTXOs reserved for 12 hours, so we won't select them for spending: unreserveinputs marks them available again. Exposes param_psbt() for wider use. Disabled the test_sign_and_send_psbt since we're altering the API; the final patch restores it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:31:49 +02:00
The **unreserveinputs** RPC command releases (or reduces reservation)
on UTXOs which were previously marked as reserved, generally by
lightning-reserveinputs(7).
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
The inputs to unreserve are the inputs specified in the passed-in *psbt*.
RETURN VALUE
------------
wallet: new JSON commands reserveinputs and unreserveinputs. reserveinputs marks UTXOs reserved for 12 hours, so we won't select them for spending: unreserveinputs marks them available again. Exposes param_psbt() for wider use. Disabled the test_sign_and_send_psbt since we're altering the API; the final patch restores it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:31:49 +02:00
On success, an *reservations* array is returned, with an entry for each input
which was reserved:
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
wallet: new JSON commands reserveinputs and unreserveinputs. reserveinputs marks UTXOs reserved for 12 hours, so we won't select them for spending: unreserveinputs marks them available again. Exposes param_psbt() for wider use. Disabled the test_sign_and_send_psbt since we're altering the API; the final patch restores it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:31:49 +02:00
- *txid* is the input transaction id.
- *vout* is the input index.
- *was_reserved* indicates whether the input was already reserved (generally true)
- *reserved* indicates that the input is now reserved (may still be true, if it was previously reserved for a long time).
- *reserved_to_block* (if *reserved* is still true) indicates what blockheight the reservation will expire.
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
wallet: new JSON commands reserveinputs and unreserveinputs. reserveinputs marks UTXOs reserved for 12 hours, so we won't select them for spending: unreserveinputs marks them available again. Exposes param_psbt() for wider use. Disabled the test_sign_and_send_psbt since we're altering the API; the final patch restores it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:31:49 +02:00
On failure, an error is reported and no UTXOs are unreserved.
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
The following error codes may occur:
wallet: new JSON commands reserveinputs and unreserveinputs. reserveinputs marks UTXOs reserved for 12 hours, so we won't select them for spending: unreserveinputs marks them available again. Exposes param_psbt() for wider use. Disabled the test_sign_and_send_psbt since we're altering the API; the final patch restores it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:31:49 +02:00
- -32602: Invalid parameter, i.e. an unparseable PSBT.
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
AUTHOR
------
niftynei <<niftynei@gmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-unreserveinputs(7), lightning-signpsbt(7), lightning-sendpsbt(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
Reference in New Issue Copy Permalink