home | help 
LIGHTNING-ASKRENE-CREATE-LAYER(7)	       LIGHTNING-ASKRENE-CREATE-LAYER(7)

NAME
     askrene-create-layer -- Command to create a new layer

SYNOPSIS
     askrene-create-layer layer [persistent]

DESCRIPTION
     Command added in v24.11.

     The  askrene-create-layer	RPC command tells askrene to create a new, empty
     layer.  This layer can then be populated  with  askrene-create-channel  and
     askrene-inform-channel, and be used in getroutes.

     *	layer (string): The name of the layer to create.
     *	persistent  (boolean, optional): True if askrene should save and restore
	this layer.  As a side-effect, create-layer also succeeds if  the  layer
	already exists and persistent is true. The default is False.

RETURN VALUE
     On  success, an object containing layers is returned. It is an array of ob-
     jects, where each object contains:

     *	layer (string): The name of the layer.
     *	persistent  (boolean):	Whether  the  layer  is  saved/restored   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):
	*  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.
	*  delay (u16, optional): 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.
     *	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)
	*  timestamp (u64): The UNIX  timestamp  when  this  bias  was	created.
	   (added v25.12)
	*  description	(string, optional): Description/annotation to display in
	   askrene-listlayers(7)
     *	node_biases (array of objects, optional) (added v25.12):
	*  node (pubkey): The id of the biased node. (added v25.12)
	*  in_bias (integer): The bias (-100  to  +100)  on  incoming  channels.
	   (added v25.12)
	*  out_bias  (integer):  The  bias  (-100 to +100) on outgoing channels.
	   (added v25.12)
	*  timestamp (u64): The UNIX timestamp when this  bias	was  created  or
	   last updated. (added v25.12)
	*  description	(string,  optional): A human readable annotation. (added
	   v25.12)

AUTHOR
     Rusty Russell rusty@rustcorp.com.au is mainly responsible.

SEE ALSO
     lightning-askrene-remove-layer(7),    lightning-getroutes(7),    lightning-
     askrene-create-channel(7),  lightning-askrene-inform-channel(7), lightning-
     askrene-listlayers(7), lightning-askrene-age(7)

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

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli askrene-create-layer -k "layer"="test_layers"

     {
       "id": "example:askrene-create-layer#1",
       "method": "askrene-create-layer",
       "params": {
	 "layer": "test_layers"
       }
     }

     Response:

     {
       "layers": [
	 {
	   "layer": "test_layers",
	   "persistent": false,
	   "disabled_nodes": [],
	   "created_channels": [],
	   "channel_updates": [],
	   "constraints": [],
	   "biases": [],
	   "node_biases": []
	 }
       ]
     }

Core Lightning v26.06.1 		       LIGHTNING-ASKRENE-CREATE-LAYER(7)
home | help