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
|
|
|
|
|
-----------
|
|
|
|
|
|
2021-10-24 11:44:56 +02:00
|
|
|
The **withdraw** RPC command sends funds from c-lightning's internal
|
2019-08-10 01:54:18 +02:00
|
|
|
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*
|
2021-10-24 11:44:56 +02:00
|
|
|
(next 100 blocks or so) to use lightningd's internal estimates: *normal*
|
2019-08-10 01:54:18 +02:00
|
|
|
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
|
|
|
|
|
------------
|
|
|
|
|
|
2021-06-16 03:10:17 +02:00
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
|
|
|
On success, an object is returned, containing:
|
|
|
|
|
- **tx** (hex): the fully signed bitcoin transaction
|
|
|
|
|
- **txid** (txid): the transaction id of *tx*
|
|
|
|
|
- **psbt** (string): the PSBT representing the unsigned transaction
|
2021-09-03 12:07:59 +02:00
|
|
|
|
2021-06-16 03:10:17 +02:00
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
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),
|
2020-07-12 05:30:35 +02:00
|
|
|
lightning-txprepare(7), lightning-feerates(7).
|
2019-08-10 01:54:18 +02:00
|
|
|
|
|
|
|
|
RESOURCES
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Main web site: <https://github.com/ElementsProject/lightning>
|
2020-08-25 03:33:16 +02:00
|
|
|
|
2021-11-04 15:15:51 +01:00
|
|
|
[comment]: # ( SHA256STAMP:cef8d48a59313019e671900621426733d47be2f0c22d5cb2d06ce0b9b7d43592)
|
