2020-06-10 01:20:18 +01:00
|
|
|
lightning-reserveinputs -- Construct a transaction and reserve the UTXOs it spends
|
|
|
|
|
==================================================================================
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
|
2022-01-26 17:18:49 +00:00
|
|
|
**reserveinputs** *psbt* [*exclusive*] [*reserve*]
|
2020-06-10 01:20:18 +01:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
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
|
2020-07-15 06:39:47 +01:00
|
|
|
with an error if any of the inputs are known to be spent, and ignore inputs
|
|
|
|
|
which are unknown.
|
2020-06-10 01:20:18 +01:00
|
|
|
|
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.
|
|
|
|
|
|
2021-05-26 02:19:37 +01:00
|
|
|
By default, reservations are for the next 72 blocks (approximately 6
|
|
|
|
|
hours), but this can be changed by setting *reserve*.
|
2020-06-10 01:20:18 +01:00
|
|
|
|
|
|
|
|
RETURN VALUE
|
|
|
|
|
------------
|
|
|
|
|
|
2021-06-16 02:10:17 +01:00
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
|
|
|
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
|
|
|
|
|
- **reserved** (boolean): whether the input is now reserved (always *true*)
|
|
|
|
|
- **reserved_to_block** (u32): what blockheight the reservation will expire
|
2021-09-03 11:07:59 +01:00
|
|
|
|
2021-06-16 02:10:17 +01:00
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
|
|
2020-07-15 06:39:47 +01:00
|
|
|
On success, a *reservations* array is returned, with an entry for each input
|
2020-07-15 06:31:49 +01:00
|
|
|
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.
|
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:
|
2020-07-15 06:32:49 +01:00
|
|
|
- -32602: Invalid parameter, such as specifying a spent/reserved input in *psbt*.
|
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>
|
2020-08-25 02:33:16 +01:00
|
|
|
|
2022-07-13 16:45:39 +01:00
|
|
|
[comment]: # ( SHA256STAMP:45c13e920465d313c693db6bfea8ac2f66d1e40226ef78241f82f51df9b715b2)
|
