core-lightning/doc/schemas/lightning-askrene-update-channel.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "additionalProperties": false,
  "rpc": "askrene-update-channel",
  "title": "Command to manipulate channel in a layer (EXPERIMENTAL)",
  "description": [
    "WARNING: experimental, so API may change.",
    "",
    "The **askrene-update-channel** RPC command overrides updates for an existing channel when the layer is applied."
  ],
  "request": {
    "required": [
      "layer",
      "short_channel_id_dir"
    ],
    "properties": {
      "layer": {
        "type": "string",
        "description": [
          "The name of the layer to apply this change to."
        ]
      },
      "short_channel_id_dir": {
        "type": "short_channel_id_dir",
        "description": [
          "The channel and direction to apply the change to."
        ]
      },
      "htlc_min": {
        "type": "msat",
        "description": [
          "The minimum value allowed in this direction."
        ]
      },
      "htlc_max": {
        "type": "msat",
        "description": [
          "The maximum value allowed in this direction."
        ]
      },
      "base_fee": {
        "type": "msat",
        "description": [
          "The base fee to apply to use the channel in this direction."
        ]
      },
      "proportional_fee": {
        "type": "u32",
        "description": [
          "The proportional fee (in parts per million) to apply to use the channel in this direction."
        ]
      },
      "cltv_expiry_delta": {
        "type": "u16",
        "description": [
          "The CLTV delay required for this direction."
        ]
      }
    }
  },
  "response": {
    "required": [],
    "properties": {}
  },
  "see_also": [
    "lightning-getroutes(7)",
    "lightning-askrene-create-channel(7)"
  ],
  "author": [
    "Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ]
}