lightning-askrene-listlayers -- Command to display information about layers (EXPERIMENTAL)

SYNOPSIS

askrene-listlayers [layer]

DESCRIPTION

WARNING: experimental, so API may change.

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.
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.
- htlc_minimum_msat (msat): The minimum value allowed in this direction.
- htlc_maximum_msat (msat): The maximum value allowed in this direction.
- fee_base_msat (msat): The base fee to apply to use the channel in this direction.
- fee_proportional_millionths (u32): The proportional fee (in parts per million) to apply to use the channel in this direction.
- delay (u16): The CLTV delay required for this direction.
constraints (array of objects):
- short_channel_id (short_channel_id): The short channel id.
- direction (u32): The direction.
- maximum_msat (msat, optional): The maximum value which this channel could pass. This or minimum_msat will be present, but not both.
- minimum_msat (msat, optional): The minimum value which this channel could pass. This or minimum_msat will be present, but not both.

AUTHOR

Rusty Russell <[email protected]> is mainly responsible.

RESOURCES

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