LIGHTNING-BATCHING(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

✨ NAME ✨

Okay so this is LIGHTNING-BATCHING(7), bestie — the manual page for batching, and its whole NAME moment is: batching — Command to allow database batching. 🎀

🌸 SYNOPSIS 🌸

Short and sweet, the synopsis is literally:

batching enable

💖 DESCRIPTION 💖

The batching RPC command is the one that allows database commitments to be deferred when multiple commands are issued on this RPC connection. But read the fine print, bestie: it allows that deferral, it does not guarantee it. 💅

This is only useful if many commands are being given at once, in which case it can offer a performance improvement. The cost? If there is a crash, it's unclear how many of the commands will have been persisted. So yes: possible speed-up, possible crash confusion — keep that in mind. 😭

  • enable (boolean) — Whether to enable or disable transaction batching. The default is False.

🫶 RETURN VALUE 🫶

On success, an empty object is returned. That's the whole flex: {}. ✨

💀 ERRORS 💀

On failure, one of the following error codes may be returned:

  • -32602: Error in given parameters.

👑 AUTHOR 👑

Rusty Russell rusty@blockstream.com wrote the initial version of this man page. Iconic behavior, honestly. 🌟

🌈 RESOURCES 🌈

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

🍓 EXAMPLES 🍓

Example 1:

Request:

$ lightning-cli batching -k "enable"=True

{
  "id": "example:batching#1",
  "method": "batching",
  "params": {
    "enable": true
  }
}

Response:

{}

Source/version sign-off: Core Lightning v26.06.9 — that's the build this page is repping. Manual name: LIGHTNING-BATCHING(7). The original footer didn't show a separate date, so no invented date here, bestie — just the version/source and manual-name receipts. Mwah 💋

📦 where this page comes from