forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlightning-txprepare.7
64 lines (38 loc) · 1.58 KB
/
lightning-txprepare.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.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:
.RS
.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\.
.RE
.SH AUTHOR
Rusty Russell \fBNone\fR (\fI<[email protected]\fR)> is mainly responsible\.
.SH SEE ALSO
\fBlightning-withdraw\fR(7), \fBlightning-txsend\fR(7), \fBlightning-txdiscard\fR(7)
.SH RESOURCES
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
.HL
Last updated 2019-06-08 16:03:59 CEST