LIGHTNING-TXPREPARE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💸 lightning-txprepare(7) — the “get ready to withdraw” bestie manual 💸

Okay so bestie, this is the manual for lightning-txprepare(7) — the page all about txprepare. It’s giving “prep the transaction, don’t send it yet,” and honestly? iconic. 🎀

🌸 NAME 🌸

txprepare — Command to prepare to withdraw funds from the internal wallet. 💖

✨ SYNOPSIS ✨

txprepare outputs [feerate] [minconf] [utxos]

🦋 DESCRIPTION 🦋

Okay so txprepare is the RPC command that creates an unsigned transaction. It spends funds from Core Lightning’s internal wallet to the outputs you specify. No cap, that’s the whole job. 💸

txprepare is similar to the first part of a withdraw command, but it supports multiple outputs and uses outputs as the parameter. The second part is provided by txsend. Periodt. ✨

  • outputs (array of outputdescs): Format is like: [{destination1: amount1}, {destination2: amount2}] or [{destination: *all*}]. It supports any number of confirmed outputs. Yes, any number — slay.
    • (outputdesc, optional)
  • feerate (feerate, optional): Used for the transaction as initial feerate. The default is normal.
  • minconf (u32, optional): The minimum number of confirmations that used outputs should have. The default is 1.
  • utxos (array of outpoints, optional): To be used to fund the transaction, 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:

  • psbt (string): The PSBT representing the unsigned transaction.
  • unsigned_tx (hex): The unsigned transaction.
  • txid (txid): The transaction id of unsigned_tx; you hand this to lightning-txsend(7) or lightning-txdiscard(7), as the inputs of this transaction are reserved. iykyk — those inputs are spoken for. 🫶

💀 ERRORS 💀

On failure, an error is reported and the 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.

🫶 AUTHOR 🫶

Rusty Russell rusty@rustcorp.com.au is mainly responsible. Thank you Rusty, king. 👑

🌈 SEE ALSO 🌈

🧚 RESOURCES 🧚

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

🍓 EXAMPLES 🍓

Example 1:

Request:

$ lightning-cli txprepare "[{'bcrt1p0002020202020202020202020202020202020202020202020202020202': 16777216}]"
{
  "id": "example:txprepare#1",
  "method": "txprepare",
  "params": [
    [
      {
        "bcrt1p0002020202020202020202020202020202020202020202020202020202": 16777216
      }
    ]
  ]
}

Response:

{
  "unsigned_tx": "0200000000000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006000600060006",
  "txid": "txidtxprep000100001000010000100001000010000100001000010000100001",
  "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000101000"
}

Example 2:

Request:

$ lightning-cli txprepare -k "outputs"='[{"bcrt1p0003030303030303030303030303030303030303030303030303030303": 16777216}]'
{
  "id": "example:txprepare#2",
  "method": "txprepare",
  "params": {
    "outputs": [
      {
        "bcrt1p0003030303030303030303030303030303030303030303030303030303": 16777216
      }
    ]
  }
}

Response:

{
  "unsigned_tx": "020000000000020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002000200020002",
  "txid": "txidtxprep000200002000020000200002000020000200002000020000200002",
  "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000201000"
}

✨ That’s the whole page, bestie! Source/version: Core Lightning v26.06.9 · manual page: LIGHTNING-TXPREPARE(7) · date: not listed in the footer, so we’re not making one up. 💖

📦 where this page comes from