core-lightning/doc/schemas/createonion.request.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "hops",
    "assocdata"
  ],
  "properties": {
    "hops": {
      "type": "array",
      "description": "a JSON list of dicts, each specifying a node and the payload destined for that node",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "pubkey",
          "payload"
        ],
        "properties": {
          "pubkey": {
            "type": "pubkey",
            "description": "node pubkey"
          },
          "payload": {
            "type": "hex",
            "description": "payload to be sent to the node"
          }
        }
      }
    },
    "assocdata": {
      "type": "hex",
      "description": "the associated data that the onion should commit to. If the onion is to be used to send a payment later it MUST match the `payment_hash` of the payment in order to be valid"
    },
    "session_key": {
      "type": "secret",
      "description": "can be used to specify a secret that is used to generate the shared secrets used to encrypt the onion for each hop. It should only be used for testing or if a specific shared secret is important. If not specified it will be securely generated internally, and the shared secrets will be returned"
    },
    "onion_size": {
      "type": "u16",
      "description": "a size different from the default payment onion (1300 bytes). May be used for custom protocols like trampoline routing"
    }
  }
}