core-lightning/doc/lightning-txdiscard.7.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

lightning-txdiscard -- Abandon a transaction from txprepare, release inputs
===========================================================================
SYNOPSIS
--------
**txdiscard** *txid*
DESCRIPTION
-----------
The **txdiscard** RPC command releases inputs which were reserved for
use of the *txid* from lightning-txprepare(7).
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **unsigned_tx** (hex): the unsigned transaction
- **txid** (txid): the transaction id of *unsigned_tx*
[comment]: # (GENERATE-FROM-SCHEMA-END)
If there is no matching *txid*, an error is reported. Note that this may
happen due to incorrect usage, such as **txdiscard** or **txsend**
already being called for *txid*.
The following error codes may occur:
- -1: An unknown *txid*.
AUTHOR
------
Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.
SEE ALSO
--------
lightning-txprepare(7), lightning-txsend(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:116f3262cc632e3a437d6629cd641020549f60b1264ad093e6591d5e5f83a6f0)