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

NAME
     funderupdate -- Command for adjusting node funding v2 channels

SYNOPSIS
     funderupdate  [policy]  [policy_mod] [leases_only] [min_their_funding_msat]
     [max_their_funding_msat] [per_channel_min_msat] [per_channel_max_msat] [re-
     serve_tank_msat]  [fuzz_percent]  [fund_probability]  [lease_fee_base_msat]
     [lease_fee_basis]	 [funding_weight]   [channel_fee_max_base_msat]   [chan-
     nel_fee_max_proportional_thousandths] [compact_lease]

DESCRIPTION
     NOTE: Must have --experimental-dual-fund enabled for these settings to take
     effect.

     For channel open requests using dual funding.

     Note: to maximize channel leases, best policy setting is (match, 100).

     Setting any of the 5  options  from  lease_fee_base_msat,	lease_fee_basis,
     funding_weight,   channel_fee_max_base_msat   and,  channel_fee_max_propor-
     tional_thousandths will activate channel leases for this node,  and  adver-
     tise  these values via the lightning gossip network. If any one is set, the
     other values will be the default.

     *	policy (string, optional) (one of "match", "available", "fixed"): Funder
	plugin will use to decide how much capital to commit to a v2 open  chan-
	nel request.  There are three policy options, detailed below:
	*  match  --  Contribute  policy_mod  percent  of their requested funds.
	   Valid policy_mod values are 0 to 200. If this is a channel lease  re-
	   quest,  we match based on their requested funds. If it is not a chan-
	   nel lease request (and lease_only is  false),  then	we  match  their
	   funding amount. Note: any lease match less than 100 will likely fail,
	   as clients will not accept a lease less than their request.
	*  available -- Contribute policy_mod percent of our available node wal-
	   let funds. Valid policy_mod values are 0 to 100.
	*  fixed  -- Contributes a fixed  policy_mod sats to v2 channel open re-
	   quests. The default is fixed.
     *	policy_mod (msat, optional): Number or 'modification' to  apply  to  the
	policy. The default is 0sats.
     *	leases_only   (boolean,   optional):   Only   contribute  funds  to  op-
	tion_will_fund requests which pay to lease funds. It will  fund  any  v2
	open  request  using  policy  even  if it's they're not seeking to lease
	funds. Note that option_will_fund commits funds for 4032 blocks  (~1mo).
	Must  also  set  lease_fee_base_msat,  lease_fee_basis,  funding_weight,
	channel_fee_max_base_msat, and	channel_fee_max_proportional_thousandths
	to advertise available channel leases. The default is False.
     *	min_their_funding_msat	(msat,	optional):  Minimum funding sats that we
	require in order to activate our contribution policy to the v2 open. The
	default is 10k sats.
     *	max_their_funding_msat (msat, optional): Maximum funding  sats	that  we
	will  consider	to  activate our contribution policy to the v2 open. Any
	channel open above this will not  be  funded.  The  default  is  no  max
	(UINT_MAX).
     *	per_channel_min_msat  (msat, optional): Minimum amount that we will con-
	tribute to a channel open. The default is 10k sats.
     *	per_channel_max_msat (msat, optional): Maximum amount that we will  con-
	tribute to a channel open. The default is no max (UINT_MAX).
     *	reserve_tank_msat (msat, optional): Amount of sats to leave available in
	the node wallet. The default is zero sats.
     *	fuzz_percent (u32, optional): A percentage to fuzz the resulting contri-
	bution	amount	by. Valid values are 0 to 100. Note that turning this on
	with (match, 100) policy will randomly fail option_will_fund leases,  as
	most  clients expect an exact or greater match of their requested_funds.
	The default is 0% (no fuzz).
     *	fund_probability (u32, optional): The percent of  v2  channel  open  re-
	quests to apply our policy to. Valid values are integers from 0 (fund 0%
	of  all open requests) to 100 (fund every request). Useful for randomiz-
	ing opens that receive funds. Useful for randomizing opens that  receive
	funds. The default is 100.
     *	lease_fee_base_msat (msat, optional): Flat fee for a channel lease. Node
	will receive this much extra added to their channel balance, paid by the
	opening node. Note that the minimum is 1sat. The default is 2k sats.
     *	lease_fee_basis  (u32, optional): A basis fee that's calculated as 1/10k
	of the total requested funds the peer is asking for. Node  will  receive
	the  total of lease_fee_basis times requested funds / 10k satoshis added
	to their channel balance, paid by the opening node. The default is 0.65%
	(65 basis points).
     *	funding_weight (u32, optional): To calculate the fee the peer will  com-
	pensate  your  node  for its contributing inputs to the funding transac-
	tion. The total fee is	calculated  as	the  open_channel2.funding_feer-
	ate_perkw times this funding_weight divided by 1000. Node will have this
	funding  fee  added  to their channel balance, paid by the opening node.
	The default is 2 inputs + 1 P2WPKH output.
     *	channel_fee_max_base_msat (msat, optional): A commitment  to  a  maximum
	channel_fee_base_msat  that  your  node will charge for routing payments
	over this leased channel during the lease duration. The  default  is  5k
	sats.
     *	channel_fee_max_proportional_thousandths  (u32,  optional): A commitment
	to a maximum channel_fee_proportional_millionths  that	your  node  will
	charge	for  routing  payments over this leased channel during the lease
	duration. Note that it's denominated in 'thousandths'. A setting of 1 is
	equal to 1k ppm; 5 is 5k ppm, etc. The default is 100 (100k ppm).
     *	compact_lease (hex, optional): A  compact  description	of  the  channel
	lease  params. When opening a channel, passed in to fundchannel to indi-
	cate the terms we expect from the peer.

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

     *	summary (string): Summary of the  current  funding  policy  e.g.  (match
	100).
     *	policy	(string)  (one	of "match", "available", "fixed"): Policy funder
	plugin will use to decide how much capital to commit to a v2 open  chan-
	nel request.
     *	policy_mod  (u32): The policy_mod is the number or 'modification' to ap-
	ply to the policy.
     *	leases_only (boolean): Only contribute funds to  option_will_fund  lease
	requests.
     *	min_their_funding_msat	(msat): The minimum funding sats that we require
	from peer to activate our funding policy.
     *	max_their_funding_msat (msat): The maximum funding sats that we'll allow
	from peer to activate our funding policy.
     *	per_channel_min_msat (msat): The minimum amount  that  we  will  fund  a
	channel open with.
     *	per_channel_max_msat  (msat):  The  maximum  amount  that we will fund a
	channel open with.
     *	reserve_tank_msat (msat): Amount of sats to leave available in the  node
	wallet.
     *	fuzz_percent (u32): Percentage to fuzz our funding amount by.
     *	fund_probability  (u32): Percent of opens to consider funding. 100 means
	we'll consider funding every requested open channel request.
     *	lease_fee_base_msat (msat, optional): Flat fee to charge for  a  channel
	lease.
     *	lease_fee_basis  (u32, optional): Proportional fee to charge for a chan-
	nel lease, calculated as 1/10,000th of requested funds.
     *	funding_weight (u32, optional): Transaction weight  the  channel  opener
	will pay us for a leased funding transaction.
     *	channel_fee_max_base_msat     (msat,	 optional):	Maximum    chan-
	nel_fee_base_msat we'll charge for routing funds leased on this channel.
     *	channel_fee_max_proportional_thousandths (u32, optional): Maximum  chan-
	nel_fee_proportional_millitionths  we'll charge for routing funds leased
	on this channel, in thousandths.
     *	compact_lease (hex, optional): Compact description of the channel  lease
	parameters.

ERRORS
     The following error code may occur:

     *	-32602: If the given parameters are invalid.

AUTHOR
     Lisa Neigut niftynei@gmail.com is mainly responsible.

SEE ALSO
     lightning-fundchannel(7), lightning-listfunds(7)

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

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli funderupdate

     {
       "id": "example:funderupdate#1",
       "method": "funderupdate",
       "params": {}
     }

     Response:

     {
       "summary": "fixed (0sat)",
       "policy": "fixed",
       "policy_mod": 0,
       "leases_only": true,
       "min_their_funding_msat": 10000000,
       "max_their_funding_msat": 4294967295000,
       "per_channel_min_msat": 10000000,
       "per_channel_max_msat": 4294967295000,
       "reserve_tank_msat": 0,
       "fuzz_percent": 0,
       "fund_probability": 100
     }

     Example 2:

     Request:

     $ lightning-cli funderupdate -k "policy"="fixed" "policy_mod"="50000sat" "min_their_funding_msat"=1000 "per_channel_min_msat"="1000sat" "per_channel_max_msat"="500000sat" "fund_probability"=100 "fuzz_percent"=0 "leases_only"=False

     {
       "id": "example:funderupdate#2",
       "method": "funderupdate",
       "params": {
	 "policy": "fixed",
	 "policy_mod": "50000sat",
	 "min_their_funding_msat": 1000,
	 "per_channel_min_msat": "1000sat",
	 "per_channel_max_msat": "500000sat",
	 "fund_probability": 100,
	 "fuzz_percent": 0,
	 "leases_only": false
       }
     }

     Response:

     {
       "summary": "fixed (50000sat)",
       "policy": "fixed",
       "policy_mod": 50000,
       "leases_only": false,
       "min_their_funding_msat": 1000,
       "max_their_funding_msat": 4294967295000,
       "per_channel_min_msat": 1000000,
       "per_channel_max_msat": 500000000,
       "reserve_tank_msat": 0,
       "fuzz_percent": 0,
       "fund_probability": 100
     }

Core Lightning v26.06.1 			       LIGHTNING-FUNDERUPDATE(7)
home | help