You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/loop.1
+70Lines changed: 70 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -470,6 +470,8 @@ withdrawing
470
470
withdrawn
471
471
looping_in
472
472
looped_in
473
+
opening_channel
474
+
channel_published
473
475
publish_expired_deposit
474
476
sweep_htlc_timeout
475
477
htlc_timeout_swept
@@ -564,3 +566,71 @@ Loop in funds from static address deposits.
564
566
.PP
565
567
\fB--verbose,-v\fP: show expanded details
566
568
569
+
.SS openchannel
570
+
.PP
571
+
Open a channel to a an existing peer.
572
+
573
+
.PP
574
+
\fB--base_fee_msat\fP="": the base fee in milli-satoshis that will be charged for each forwarded HTLC, regardless of payment size (default: 0)
575
+
576
+
.PP
577
+
\fB--channel_type\fP="": (optional) the type of channel to propose to the remote peer ("tweakless", "anchors", "taproot")
578
+
579
+
.PP
580
+
\fB--close_address\fP="": (optional) an address to enforce payout of our funds to on cooperative close. Note that if this value is set on channel open, you will \fInot\fP be able to cooperatively close to a different address.
581
+
582
+
.PP
583
+
\fB--fee_rate_ppm\fP="": the fee rate ppm (parts per million) that will be charged proportionally based on the value of each forwarded HTLC, the lowest possible rate is 0 with a granularity of 0.000001 (millionths) (default: 0)
584
+
585
+
.PP
586
+
\fB--fundmax\fP: if set, the wallet will attempt to commit the maximum possible local amount to the channel. This must not be set at the same time as local_amt
587
+
588
+
.PP
589
+
\fB--help,-h\fP: show help
590
+
591
+
.PP
592
+
\fB--local_amt\fP="": the number of satoshis the wallet should commit to the channel (default: 0)
593
+
594
+
.PP
595
+
\fB--max_local_csv\fP="": (optional) the maximum number of blocks that we will allow the remote peer to require we wait before accessing our funds in the case of a unilateral close. (default: 0)
596
+
597
+
.PP
598
+
\fB--memo\fP="": (optional) a note-to-self containing some useful
599
+
information about the channel. This is stored
600
+
locally only, and is purely for reference. It
601
+
has no bearing on the channel's operation. Max
602
+
allowed length is 500 characters
603
+
604
+
.PP
605
+
\fB--min_htlc_msat\fP="": (optional) the minimum value we will require for incoming HTLCs on the channel (default: 0)
606
+
607
+
.PP
608
+
\fB--node_key\fP="": the identity public key of the target node/peer serialized in compressed format
609
+
610
+
.PP
611
+
\fB--private\fP: make the channel private, such that it won't be announced to the greater network, and nodes other than the two channel endpoints must be explicitly told about it to be able to route through it
612
+
613
+
.PP
614
+
\fB--push_amt\fP="": the number of satoshis to give the remote side as part of the initial commitment state, this is equivalent to first opening a channel and sending the remote party funds, but done all in one step (default: 0)
615
+
616
+
.PP
617
+
\fB--remote_csv_delay\fP="": (optional) the number of blocks we will require our channel counterparty to wait before accessing its funds in case of unilateral close. If this is not set, we will scale the value according to the channel size (default: 0)
618
+
619
+
.PP
620
+
\fB--remote_max_value_in_flight_msat\fP="": (optional) the maximum value in msat that can be pending within the channel at any given time (default: 0)
621
+
622
+
.PP
623
+
\fB--remote_reserve_sats\fP="": (optional) the minimum number of satoshis we require the remote node to keep as a direct payment. If not specified, a default of 1% of the channel capacity will be used. (default: 0)
624
+
625
+
.PP
626
+
\fB--sat_per_vbyte\fP="": (optional) a manual fee expressed in sat/vbyte that should be used when crafting the transaction (default: 0)
627
+
628
+
.PP
629
+
\fB--scid_alias\fP: (optional) whether a scid-alias channel type should be negotiated.
630
+
631
+
.PP
632
+
\fB--utxo\fP="": a utxo specified as outpoint(tx:idx) which will be used to fund a channel. This flag can be repeatedly used to fund a channel with a selection of utxos. The selected funds can either be entirely spent by specifying the fundmax flag or partially by selecting a fraction of the sum of the outpoints in local_amt (default: [])
633
+
634
+
.PP
635
+
\fB--zero_conf\fP: (optional) whether a zero-conf channel open should be attempted.
0 commit comments