From 28b7c704dcf8ddc0c3545371acd5f2eee6eb3c9c Mon Sep 17 00:00:00 2001 From: Jesse de Wit Date: Wed, 7 Dec 2022 15:49:39 +0100 Subject: [PATCH] add reserve to the fundchannel docs [ Trivial conflict rebase -- RR ] --- doc/lightning-fundchannel.7.md | 6 ++++++ doc/lightning-multifundchannel.7.md | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/doc/lightning-fundchannel.7.md b/doc/lightning-fundchannel.7.md index 58d9fff54751..9ea163664a63 100644 --- a/doc/lightning-fundchannel.7.md +++ b/doc/lightning-fundchannel.7.md @@ -6,6 +6,7 @@ SYNOPSIS **fundchannel** *id* *amount* [*feerate*] [*announce*] [*minconf*] [*utxos*] [*push\_msat*] [*close\_to*] [*request\_amt*] [*compact\_lease*] +[*reserve*] DESCRIPTION ----------- @@ -72,6 +73,11 @@ much liquidity into the channel. Must also pass in *compact\_lease*. channel lease terms. If the peer's terms don't match this set, we will fail to open the channel. +*reserve* is the amount we want the peer to maintain on its side of the channel. +Default is 1% of the funding amount. It can be a whole number, a whole number +ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 +decimal places ending in *btc*. + This example shows how to use lightning-cli to open new channel with peer 03f...fc1 from one whole utxo bcc1...39c:0 diff --git a/doc/lightning-multifundchannel.7.md b/doc/lightning-multifundchannel.7.md index 489c806fe28e..8c200014112d 100644 --- a/doc/lightning-multifundchannel.7.md +++ b/doc/lightning-multifundchannel.7.md @@ -57,6 +57,10 @@ Readiness is indicated by **listpeers** reporting a *state* of * *compact\_lease* is a compact represenation of the peer's expected channel lease terms. If the peer's terms don't match this set, we will fail to open the channel to this destination. +* *reserve* is the amount we want the peer to maintain on its side of the + channel. Default is 1% of the funding amount. It can be a whole number, a + whole number ending in *sat*, a whole number ending in *000msat*, or a number + with 1 to 8 decimal places ending in *btc*. There must be at least one entry in *destinations*; it cannot be an empty array.