76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
lightning-withdraw -- Command for withdrawing funds from the internal wallet
|
||
============================================================================
|
||
|
||
SYNOPSIS
|
||
--------
|
||
|
||
**withdraw** *destination* *satoshi* \[*feerate*\] \[*minconf*\] \[*utxos*\]
|
||
|
||
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.
|
||
|
||
*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.
|
||
|
||
RETURN VALUE
|
||
------------
|
||
|
||
[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
|
||
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
||
|
||
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), lightning-feerates(7).
|
||
|
||
RESOURCES
|
||
---------
|
||
|
||
Main web site: <https://github.com/ElementsProject/lightning>
|
||
|
||
[comment]: # ( SHA256STAMP:e233afb9fefd986fbcba8709f6cce8a221db8772f48c00a481a68fb0326c641d)
|