Documentation Portal
API Reference

askrene-listlayers

lightning-askrene-listlayers -- Command to display information about layers

SYNOPSIS

askrene-listlayers [layer]

DESCRIPTION

Command added in v24.11.

The askrene-listlayers RPC command reports any modifications each layer (or, the layer specified) would make to the topology, if it were used for getroutes.

  • layer (string, optional): The name of the layer to report on.

RETURN VALUE

On success, an object containing layers is returned. It is an array of objects, where each object contains:

  • layer (string): The name of the layer.
  • persistent (boolean): Whether the layer is saved across restarts.
  • disabled_nodes (array of pubkeys):
    • (pubkey, optional): The id of the disabled node.
  • created_channels (array of objects):
    • source (pubkey): The source node id for the channel.
    • destination (pubkey): The destination node id for the channel.
    • short_channel_id (short_channel_id): The short channel id for the channel.
    • capacity_msat (msat): The capacity (onchain size) of the channel.
  • channel_updates (array of objects):
    • short_channel_id_dir (short_channel_id_dir): The short channel id and direction this update applies to.
    • enabled (boolean, optional): True if this can be used, false otherwise.
    • htlc_minimum_msat (msat, optional): The minimum value allowed in this direction.
    • htlc_maximum_msat (msat, optional): The maximum value allowed in this direction.
    • fee_base_msat (msat, optional): The base fee to apply to use the channel in this direction.
    • fee_proportional_millionths (u32, optional): The proportional fee (in parts per million) to apply to use the channel in this direction.
    • cltv_expiry_delta (u16, optional): The CLTV delay required for this direction.
  • constraints (array of objects):
    • short_channel_id_dir (short_channel_id_dir): The short channel id and direction
    • timestamp (u64, optional): The UNIX timestamp when this constraint was created.
    • maximum_msat (msat, optional): The maximum value which this channel could pass.
    • minimum_msat (msat, optional): The minimum value which this channel could pass.
  • disabled_channels (array of short_channel_id_dirs, optional):
    • (short_channel_id_dir, optional): The channel and direction which is disabled.
  • biases (array of objects, optional):
    • short_channel_id_dir (short_channel_id_dir): The short channel id and direction
    • bias (integer): The bias (-100 to +100)
    • description (string, optional): Description/annotation for the bias

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.

SEE ALSO

lightning-getroutes(7), lightning-askrene-disable-node(7), lightning-askrene-create-channel(7), lightning-askrene-inform-channel(7), lightning-askrene-bias-channel(7), lightning-askrene-age(7)

RESOURCES

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

EXAMPLES

Example 1:

Request:

lightning-cli askrene-listlayers "test_layers"

{
  "id": "example:askrene-listlayers#1",
  "method": "askrene-listlayers",
  "params": [
    "test_layers"
  ]
}

Response:

{
  "layers": [
    {
      "layer": "test_layers",
      "persistent": false,
      "disabled_nodes": [
        "nodeid010101010101010101010101010101010101010101010101010101010101"
      ],
      "created_channels": [
        {
          "source": "nodeid010101010101010101010101010101010101010101010101010101010101",
          "destination": "nodeid030303030303030303030303030303030303030303030303030303030303",
          "short_channel_id": "0x0x1",
          "capacity_msat": 1000000000
        }
      ],
      "channel_updates": [
        {
          "short_channel_id_dir": "0x0x1/0",
          "htlc_minimum_msat": 100,
          "htlc_maximum_msat": 900000000,
          "fee_base_msat": 1,
          "fee_proportional_millionths": 2,
          "cltv_expiry_delta": 18
        }
      ],
      "constraints": [
        {
          "short_channel_id_dir": "0x0x1/1",
          "timestamp": 1738000000,
          "minimum_msat": 100000
        }
      ],
      "biases": [
        {
          "short_channel_id_dir": "109x1x1/1",
          "description": "bigger bias",
          "bias": -5
        }
      ]
    }
  ]
}

Example 2:

Request:

lightning-cli askrene-listlayers

{
  "id": "example:askrene-listlayers#2",
  "method": "askrene-listlayers",
  "params": {}
}

Response:

{
  "layers": [
    {
      "layer": "test_layers",
      "persistent": false,
      "disabled_nodes": [
        "nodeid010101010101010101010101010101010101010101010101010101010101"
      ],
      "created_channels": [
        {
          "source": "nodeid010101010101010101010101010101010101010101010101010101010101",
          "destination": "nodeid030303030303030303030303030303030303030303030303030303030303",
          "short_channel_id": "0x0x1",
          "capacity_msat": 1000000000
        }
      ],
      "channel_updates": [
        {
          "short_channel_id_dir": "0x0x1/0",
          "htlc_minimum_msat": 100,
          "htlc_maximum_msat": 900000000,
          "fee_base_msat": 1,
          "fee_proportional_millionths": 2,
          "cltv_expiry_delta": 18
        }
      ],
      "constraints": [
        {
          "short_channel_id_dir": "0x0x1/1",
          "timestamp": 1738000000,
          "minimum_msat": 100000
        }
      ],
      "biases": [
        {
          "short_channel_id_dir": "109x1x1/1",
          "description": "bigger bias",
          "bias": -5
        }
      ]
    },
    {
      "layer": "xpay",
      "persistent": true,
      "disabled_nodes": [],
      "created_channels": [],
      "channel_updates": [],
      "constraints": [],
      "biases": []
    }
  ]
}