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

57 lines
1.6 KiB
Markdown
Raw Normal View History

add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
lightning-unreserveinputs -- Release reserved UTXOs
===================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 17:18:49 +00:00
**unreserveinputs** *psbt* [*reserve*]
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 **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 01:20:18 +01:00
The inputs to unreserve are the inputs specified in the passed-in *psbt*.
sendpsbt, fundpsbt, utxopsbt, reserveinputs, unreserveinputs: allow custom number of blocks to reserve. Not an API break: reserve=true|false still works for fundpsbt and utxopsbt, but we also allow a raw number in there. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 02:19:37 +01:00
If *reserve* is specified, it is the number of blocks to decrease
reservation by; default is 72.
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
RETURN VALUE
------------
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
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 (usually `true`)
- **reserved** (boolean): whether the input is now reserved (may still be `true` if it was reserved for a long time)
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 02:10:17 +01:00
If **reserved** is *true*:
- **reserved_to_block** (u32): what blockheight the reservation will expire
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 11:07:59 +01:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01: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 06:31:49 +01:00
On failure, an error is reported and no UTXOs are unreserved.
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01: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 06:31:49 +01:00
- -32602: Invalid parameter, i.e. an unparseable 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>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 02:33:16 +01:00
jsonschema: Formatting json schema and regenerate docs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2021-11-04 14:15:51 +00:00
[comment]: # ( SHA256STAMP:f7aca3e1a40d66e07986cb9e98033e815c4eea2237dc75664a6c47951a8132ed)