mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-10 07:37:05 +01:00
c3254e6639
mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
55 lines
1.5 KiB
Groff
55 lines
1.5 KiB
Groff
.TH "LIGHTNING-TXPREPARE" "7" "" "" "lightning-txprepare"
|
||
.SH NAME
|
||
lightning-txprepare - Command to prepare to withdraw funds from the internal wallet
|
||
.SH SYNOPSIS
|
||
|
||
\fBtxprepare\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR] [\fIminconf\fR]
|
||
|
||
.SH DESCRIPTION
|
||
|
||
The \fBtxprepare\fR RPC command creates an unsigned transaction which
|
||
spends funds from c-lightning’s internal wallet to the address specified
|
||
in \fIdestination\fR\.
|
||
|
||
|
||
Effectively, it is the first part of a \fBwithdraw\fR command, and uses
|
||
the same parameters\. The second part is provided by \fBtxsend\fR\.
|
||
|
||
.SH RETURN VALUE
|
||
|
||
On success, an object with attributes \fIunsigned_tx\fR and \fItxid\fR will be
|
||
returned\. You need to hand \fItxid\fR to \fBtxsend\fR or \fBtxdiscard\fR, as the
|
||
inputs of this transaction are reserved until then, or until the daemon
|
||
restarts\.
|
||
|
||
|
||
\fIunsigned_tx\fR represents the raw bitcoin transaction (not yet signed)
|
||
and \fItxid\fR represent the bitcoin transaction id\.
|
||
|
||
|
||
On failure, an error is reported and the transaction is not created\.
|
||
|
||
|
||
The following error codes may occur:
|
||
|
||
.IP \[bu]
|
||
-1: Catchall nonspecific error\.
|
||
.IP \[bu]
|
||
301: There are not enough funds in the internal wallet (including
|
||
fees) to create the transaction\.
|
||
.IP \[bu]
|
||
302: The dust limit is not met\.
|
||
|
||
.SH AUTHOR
|
||
|
||
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
||
|
||
.SH SEE ALSO
|
||
|
||
\fBlightning-withdraw\fR(7), \fBlightning-txsend\fR(7), \fBlightning-txdiscard\fR(7)
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|