2019-08-10 01:12:44 +01:00
|
|
|
|
.TH "LIGHTNING-WITHDRAW" "7" "" "" "lightning-withdraw"
|
|
|
|
|
|
.SH NAME
|
2019-08-28 04:35:29 +01:00
|
|
|
|
|
2019-08-10 01:12:44 +01:00
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
|
|
2019-08-28 04:35:29 +01:00
|
|
|
|
\fBwithdraw\fR \fIdestination\fR \fIsatoshi\fR [\fIfeerate\fR] [\fIminconf\fR] [\fIutxos\fR]
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
|
|
|
|
|
|
|
The \fBwithdraw\fR RPC command sends funds from c-lightning’s internal
|
|
|
|
|
|
wallet to the address specified in \fIdestination\fR\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The address can be of any Bitcoin accepted type, including bech32\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\fIsatoshi\fR is the amount to be withdrawn from the internal wallet
|
|
|
|
|
|
(expressed, as name suggests, in satoshi)\. The string \fIall\fR can be used
|
|
|
|
|
|
to specify withdrawal of all available funds\. Otherwise, it is in
|
|
|
|
|
|
satoshi precision; it can be a whole number, a whole number ending in
|
|
|
|
|
|
\fIsat\fR, a whole number ending in \fI000msat\fR, or a number with 1 to 8
|
|
|
|
|
|
decimal places ending in \fIbtc\fR\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\fIfeerate\fR is an optional feerate to use\. It can be one of the strings
|
|
|
|
|
|
\fIurgent\fR (aim for next block), \fInormal\fR (next 4 blocks or so) or \fIslow\fR
|
|
|
|
|
|
(next 100 blocks or so) to use lightningd’s internal estimates: \fInormal\fR
|
|
|
|
|
|
is the default\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Otherwise, \fIfeerate\fR is a number, with an optional suffix: \fIperkw\fR means
|
|
|
|
|
|
the number is interpreted as satoshi-per-kilosipa (weight), and \fIperkb\fR
|
|
|
|
|
|
means it is interpreted bitcoind-style as satoshi-per-kilobyte\. Omitting
|
|
|
|
|
|
the suffix is equivalent to \fIperkb\fR\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\fIminconf\fR specifies the minimum number of confirmations that used
|
|
|
|
|
|
outputs should have\. Default is 1\.
|
|
|
|
|
|
|
2019-08-28 04:35:29 +01:00
|
|
|
|
|
|
|
|
|
|
\fIutxos\fR specifies the utxos to be used to be withdrawn from, as an array
|
|
|
|
|
|
of "txid:vout"\. These must be drawn from the node's available UTXO set\.
|
|
|
|
|
|
|
2019-08-10 01:12:44 +01:00
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
|
|
|
|
|
|
|
On success, an object with attributes \fItx\fR and \fItxid\fR will be returned\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\fItx\fR represents the raw bitcoin, fully signed, transaction and \fItxid\fR
|
|
|
|
|
|
represent the bitcoin transaction id\.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
On failure, an error is reported and the withdrawal transaction is not
|
|
|
|
|
|
created\.
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-06-15 20:20:31 +01:00
|
|
|
|
The following error codes may occur:
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
2019-08-28 04:35:29 +01:00
|
|
|
|
.RS
|
2019-08-10 01:12:44 +01:00
|
|
|
|
.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\.
|
|
|
|
|
|
|
2019-08-28 04:35:29 +01:00
|
|
|
|
.RE
|
2019-08-10 01:12:44 +01:00
|
|
|
|
.SH AUTHOR
|
|
|
|
|
|
|
2019-08-28 04:35:29 +01:00
|
|
|
|
Felix \fBNone\fR (\fI<fixone@gmail.com\fR)> is mainly responsible\.
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
|
|
|
|
|
|
|
\fBlightning-listfunds\fR(7), \fBlightning-fundchannel\fR(7), \fBlightning-newaddr\fR(7),
|
|
|
|
|
|
\fBlightning-txprepare\fR(7)\.
|
|
|
|
|
|
|
|
|
|
|
|
.SH RESOURCES
|
|
|
|
|
|
|
2019-08-28 04:35:29 +01:00
|
|
|
|
Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
|
2019-08-10 01:12:44 +01:00
|
|
|
|
|
