Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-SPLICE_INIT(7)			      LIGHTNING-SPLICE_INIT(7)

NAME
       lightning-splice_init --	Command	to initiate a channel to a peer

SYNOPSIS
       (WARNING: experimental-splicing only)

       splice_init  channel_id	relative_amount	[initialpsbt] [feerate_per_kw]
       [force_feerate]

DESCRIPTION
       Command added in	v23.08.

       splice_init is a	low level RPC command which initiates a	channel	splice
       for a given channel specified by	channel_id.

         channel_id (hash): The channel id of the channel to be spliced.
         relative_amount (integer): A positive	or negative amount of satoshis
	  to add or subtract from the channel. Note you	may need to add	a dou-
	  ble dash (--)	after splice_init if using a negative  relative_amount
	  so  it is not	interpretted as	a command modifier. For	example: shell
	  $ lightning-cli splice_init -- $CHANNEL_ID -100000.
         initialpsbt (string, optional): The (optional) base 64 encoded  PSBT
	  to  begin  with.  If	not specified, one will	be generated automati-
	  cally.
         feerate_per_kw (u32, optional): The miner fee	we promise our peer to
	  pay for our side of the splice  transaction.	It  is	calculated  by
	  feerate_per_kw * our_bytes_in_splice_tx / 1000.
         force_feerate	 (boolean,  optional): By default splices will fail if
	  the fee provided looks too high. This	is to protect against acciden-
	  tally	setting	your fee higher	than intended.	Set  force_feerate  to
	  true to skip this saftey check.

RETURN VALUE
       On success, an object is	returned, containing:

         psbt (string): The (incomplete) PSBT of the splice transaction.

AUTHOR
       Dusty <<@dusty_daemon>> is mainly responsible.

SEE ALSO
       lightning-splice_signed(7), lightning-splice_update(7)

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

USAGE
       Here  is	 an example set	of splice commands that	will splice in 100,000
       sats to the first channel that comes out	of listpeerchannels.

       The example assumes you already have at least one confirmed channel.

       1: Get the channel id of	the first channel.

       CHANNEL_ID=$(echo $(lightning-cli listpeerchannels) | jq	-r ".channels[0].channel_id")

       2: Get the PSBT from fundpsbt.

       INITIALPSBT=$(echo $(lightning-cli fundpsbt -k satoshi=100000sat	feerate=urgent startweight=800 excess_as_change=true) |	jq -r ".psbt")

       3: Initiate the splice by passing channel id and	 initialpsbt  received
       from above steps.

       PSBT_SPLICE_INIT=$(echo $(lightning-cli splice_init $CHANNEL_ID 100000 $INITIALPSBT) | jq -r ".psbt")

       4: Update the PSBT with the splice_update command.

       PSBT_SPLICE_UPDATE=$(echo $(lightning-cli splice_update $CHANNEL_ID $PSBT_SPLICE_INIT) |	jq -r ".psbt")

       5: Sign the updated PSBT.

       SIGNPSBT=$(echo $(lightning-cli signpsbt	-k psbt="$PSBT_SPLICE_UPDATE") | jq -r ".signed_psbt")

       6:  Finally, call splice_signed with channel id and signed PSBT parame-
       ters.

       $ lightning-cli splice_signed $CHANNEL_ID $SIGNPSBT

EXAMPLES
       Example 1:

       Request:

       $ lightning-cli splice_init -k "channel_id"="channelid0780000780000780000780000780000780000780000780000780000" "relative_amount"=100000 "initialpsbt"="cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000"

       {
	 "id": "example:splice_init#1",
	 "method": "splice_init",
	 "params": {
	   "channel_id": "channelid0780000780000780000780000780000780000780000780000780000",
	   "relative_amount": 100000,
	   "initialpsbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000713000"
	 }
       }

       Response:

       {
	 "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000711000"
       }

       Example 2:

       Request:

       $ lightning-cli splice_init "channelid0780000780000780000780000780000780000780000780000780000" "-105000"	"cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000"

       {
	 "id": "example:splice_init#2",
	 "method": "splice_init",
	 "params": [
	   "channelid0780000780000780000780000780000780000780000780000780000",
	   -105000,
	   "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000714000"
	 ]
       }

       Response:

       {
	 "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQpsbt712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000712000"
       }

Core Lightning v25.02				      LIGHTNING-SPLICE_INIT(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-splice_init&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help