LIGHTNING-WITHDRAW(7)

πŸ“¦
version 26.06.9 Β· 2 versions
, in nixpkgs unstable

✨ NAME ✨

okay bestie, welcome to lightning-withdraw(7) β€” aka LIGHTNING-WITHDRAW(7), capital letters and all πŸ’… β€” and the command is withdraw, aka Command for withdrawing funds from the internal wallet. It's giving "move funds out of the internal wallet," and we are reading every single detail together, no skipping, periodt.


🌸 SYNOPSIS 🌸

withdraw destination satoshi [feerate] [minconf] [utxos]

πŸ’– DESCRIPTION πŸ’–

The withdraw RPC command sends funds from Core Lightning's internal wallet to the address specified in destination. That's the whole plot, but the details are the main character energy.

  • destination (string) β€” any Bitcoin accepted type, including bech32. Yep, all the accepted Bitcoin address types are invited to the party.
  • satoshi (sat_or_all) β€” 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 (possibly restricted by the utxos parameter, and note that if we have any anchor channels, this will always leave at least min-emergency-msat as change). 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 (feerate, optional) β€” used for the withdrawal as initial feerate. The default is normal.
  • minconf (u16, optional) β€” minimum number of confirmations that used outputs should have. The default is 1.
  • utxos (array of outpoints, optional) β€” 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.:
    • (outpoint, optional)

🫢 RETURN VALUE 🫢

On success, an object is returned, containing:

  • tx (hex) β€” the fully signed bitcoin transaction. Signed and sealed, bestie.
  • txid (txid) β€” the transaction id of tx.
  • psbt (string) β€” the PSBT representing the unsigned transaction.

😭 ERRORS 😭

On failure, an error is reported and the withdrawal transaction is not created. No transaction, no vibes.

  • -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.
  • 313 β€” the min-emergency-msat reserve not be preserved (and we have anchor channels).

πŸ‘‘ AUTHOR πŸ‘‘

Felix fixone@gmail.com is mainly responsible. Icon behavior, honestly.

πŸ¦‹ SEE ALSO πŸ¦‹

🌈 RESOURCES 🌈

Main web site: https://github.com/ElementsProject/lightning

πŸŽ€ EXAMPLES πŸŽ€

Example 1

Request:

$ lightning-cli withdraw -k "destination"="bcrt1qcqqv0101010101010101010101010101010101" "satoshi"=555555
{
  "id": "example:withdraw#1",
  "method": "withdraw",
  "params": {
    "destination": "bcrt1qcqqv0101010101010101010101010101010101",
    "satoshi": 555555
  }
}

Response:

{
  "tx": "020000000001wthdrw9100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000910009100091000",
  "txid": "txidwithdraw2191000910009100091000910009100091000910009100091000",
  "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000911000"
}

Example 2

Request:

$ lightning-cli withdraw -k "destination"="bcrt1phtprcvhz02020202020202020202020202020202020202020202020202" "satoshi"="all" "feerate"="20000perkb" "minconf"=0 "utxos"='["utxo020202020202020202020202020202020202020202020202020202020202:1"]'
{
  "id": "example:withdraw#2",
  "method": "withdraw",
  "params": {
    "destination": "bcrt1phtprcvhz02020202020202020202020202020202020202020202020202",
    "satoshi": "all",
    "feerate": "20000perkb",
    "minconf": 0,
    "utxos": [
      "utxo020202020202020202020202020202020202020202020202020202020202:1"
    ]
  }
}

Response:

{
  "tx": "020000000002wthdrw92000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000920009200092000",
  "txid": "txidwithdraw2292000920009200092000920009200092000920009200092000",
  "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000922000"
}

okay that's the whole page, bestie β€” source/version energy is Core Lightning v26.06.9, and the manual is lightning-withdraw(7) / LIGHTNING-WITHDRAW(7). You ate this read, no cap πŸ’…βœ¨

πŸ“¦ where this page comes from