vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-reserveinputs.7.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
lightning-reserveinputs -- Construct a transaction and reserve the UTXOs it spends
==================================================================================
SYNOPSIS
--------
reserveinputs: add exclusive flag. This is the normal case: you only want to reserve inputs which are not already reserved. This saves you iterating through the results and unreserving some if you weren't exclusive. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 06:32:49 +01:00
**reserveinputs** *psbt* [*exclusive*]
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
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 06:31:49 +01:00
The **reserveinputs** RPC command places (or increases) reservations on any
inputs specified in *psbt* which are known to lightningd. It will fail
with an error it any of the inputs are known to be spent.
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
reserveinputs: add exclusive flag. This is the normal case: you only want to reserve inputs which are not already reserved. This saves you iterating through the results and unreserving some if you weren't exclusive. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 06:32:49 +01:00
Normally the command will fail (with no reservations made) if an input
is already reserved. If *exclusive* is set to *False*, then existing
reservations are simply extended, rather than causing failure.
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
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 06:31:49 +01:00
On success, an *reservations* array is returned, with an entry for each input
which was reserved:
- *txid* is the input transaction id.
- *vout* is the input index.
- *was_reserved* indicates whether the input was already reserved.
- *reserved* indicates that the input is now reserved (i.e. true).
- *reserved_to_block* indicates what blockheight the reservation will expire.
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
On failure, an error is reported and no UTXOs are reserved.
The following error codes may occur:
reserveinputs: add exclusive flag. This is the normal case: you only want to reserve inputs which are not already reserved. This saves you iterating through the results and unreserving some if you weren't exclusive. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 06:32:49 +01:00
- -32602: Invalid parameter, such as specifying a spent/reserved input in *psbt*.
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01: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>