2019-08-31 14:30:56 +02:00
|
|
|
|
lightning-withdraw -- Command for withdrawing funds from the internal wallet
|
|
|
|
|
|
============================================================================
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
|
--------
|
|
|
|
|
|
|
2019-08-28 05:35:29 +02:00
|
|
|
|
**withdraw** *destination* *satoshi* \[*feerate*\] \[*minconf*\] \[*utxos*\]
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
|
|
The **withdraw** RPC command sends funds from c-lightning’s internal
|
|
|
|
|
|
wallet to the address specified in *destination*.
|
|
|
|
|
|
|
|
|
|
|
|
The address can be of any Bitcoin accepted type, including bech32.
|
|
|
|
|
|
|
|
|
|
|
|
*satoshi* is the amount to be withdrawn from the internal wallet
|
|
|
|
|
|
(expressed, as name suggests, in satoshi). The string *all* 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
|
|
|
|
|
|
*sat*, a whole number ending in *000msat*, or a number with 1 to 8
|
|
|
|
|
|
decimal places ending in *btc*.
|
|
|
|
|
|
|
|
|
|
|
|
*feerate* is an optional feerate to use. It can be one of the strings
|
|
|
|
|
|
*urgent* (aim for next block), *normal* (next 4 blocks or so) or *slow*
|
|
|
|
|
|
(next 100 blocks or so) to use lightningd’s internal estimates: *normal*
|
|
|
|
|
|
is the default.
|
|
|
|
|
|
|
|
|
|
|
|
Otherwise, *feerate* is a number, with an optional suffix: *perkw* means
|
|
|
|
|
|
the number is interpreted as satoshi-per-kilosipa (weight), and *perkb*
|
|
|
|
|
|
means it is interpreted bitcoind-style as satoshi-per-kilobyte. Omitting
|
|
|
|
|
|
the suffix is equivalent to *perkb*.
|
|
|
|
|
|
|
|
|
|
|
|
*minconf* specifies the minimum number of confirmations that used
|
|
|
|
|
|
outputs should have. Default is 1.
|
|
|
|
|
|
|
2019-08-28 05:35:29 +02:00
|
|
|
|
*utxos* 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:54:18 +02:00
|
|
|
|
RETURN VALUE
|
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
|
On success, an object with attributes *tx* and *txid* will be returned.
|
|
|
|
|
|
|
|
|
|
|
|
*tx* represents the raw bitcoin, fully signed, transaction and *txid*
|
|
|
|
|
|
represent the bitcoin transaction id.
|
|
|
|
|
|
|
|
|
|
|
|
On failure, an error is reported and the withdrawal transaction is not
|
|
|
|
|
|
created.
|
|
|
|
|
|
|
|
|
|
|
|
The following error codes may occur:
|
|
|
|
|
|
- -1: Catchall nonspecific error.
|
|
|
|
|
|
- 301: There are not enough funds in the internal wallet (including
|
|
|
|
|
|
fees) to create the transaction.
|
|
|
|
|
|
- 302: The dust limit is not met.
|
|
|
|
|
|
|
|
|
|
|
|
AUTHOR
|
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
|
|
Felix <<fixone@gmail.com>> is mainly responsible.
|
|
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
|
|
lightning-listfunds(7), lightning-fundchannel(7), lightning-newaddr(7),
|
|
|
|
|
|
lightning-txprepare(7).
|
|
|
|
|
|
|
|
|
|
|
|
RESOURCES
|
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
