core-lightning/doc/schemas/lightning-batching.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "additionalProperties": false,
  "rpc": "batching",
  "title": "Command to allow database batching.",
  "description": [
    "The **batching** RPC command allows (but does not guarantee!) database commitments to be deferred when multiple commands are issued on this RPC connection. This is only useful if many commands are being given at once, in which case it can offer a performance improvement (the cost being that if there is a crash, it's unclear how many of the commands will have been persisted)."
  ],
  "request": {
    "required": [
      "enable"
    ],
    "properties": {
      "enable": {
        "type": "boolean",
        "description": [
          "Whether to enable or disable transaction batching."
        ],
        "default": "False"
      }
    }
  },
  "response": {
    "properties": {}
  },
  "json_example": [
    {
      "request": {
        "id": "example:batching#1",
        "method": "batching",
        "params": {
          "enable": true
        }
      },
      "response": {}
    }
  ],
  "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."
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ]
}