Skip to content

Commit

Permalink
Add missing requests
Browse files Browse the repository at this point in the history
  • Loading branch information
ShahanaFarooqui committed Dec 15, 2023
1 parent dafc4af commit 1096e2e
Show file tree
Hide file tree
Showing 60 changed files with 745 additions and 379 deletions.
2 changes: 0 additions & 2 deletions doc/lightning-autoclean-once.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ The *subsystem*s currently supported are:
* `expiredinvoices`: invoices which were not paid (and cannot be) (`expired` in listinvoices `status`).
* `paidinvoices`: invoices which were paid (`paid` in listinvoices `status).

*age* is a non-zero number in seconds.

RETURN VALUE
------------

Expand Down
3 changes: 0 additions & 3 deletions doc/lightning-batching.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ which case it can offer a performance improvement (the cost being that if
there is a crash, it's unclear how many of the commands will have been
persisted).

*enable* is *true* to enable batching, *false* to disable it (the
default).

EXAMPLE JSON REQUEST
--------------------

Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-disableinvoicerequest.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ lightning-disableinvoicerequest -- Command for removing an invoice request
SYNOPSIS
--------

**(WARNING: experimental-offers only)**

**disableinvoicerequest** *invreq\_id*

DESCRIPTION
-----------

**(WARNING: experimental-offers only)**

The **disableinvoicerequest** RPC command disables an
invoice\_request, so that no further invoices will be accepted (and
thus, no further payments made)..
Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-disableoffer.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ lightning-disableoffer -- Command for removing an offer
SYNOPSIS
--------

**(WARNING: experimental-offers only)**

**disableoffer** *offer\_id*

DESCRIPTION
-----------

**(WARNING: experimental-offers only)**

The **disableoffer** RPC command disables an offer, so that no further
invoices will be given out.

Expand Down
4 changes: 2 additions & 2 deletions doc/lightning-fetchinvoice.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ lightning-fetchinvoice -- Command for fetch an invoice for an offer
SYNOPSIS
--------

**(WARNING: experimental-offers only)**

**fetchinvoice** *offer* [*amount\_msat*] [*quantity*] [*recurrence\_counter*] [*recurrence\_start*] [*recurrence\_label*] [*timeout*] [*payer\_note*]

DESCRIPTION
-----------

**(WARNING: experimental-offers only)**

The **fetchinvoice** RPC command contacts the issuer of an *offer* to get
an actual invoice that can be paid. It highlights any changes between the
offer and the returned invoice.
Expand Down
2 changes: 0 additions & 2 deletions doc/lightning-fundchannel_cancel.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ DESCRIPTION
`fundchannel_cancel` is a lower level RPC command. It allows channel opener
to cancel a channel before funding broadcast with a connected peer.

*id* is the node id of the remote peer with which to cancel.

Note that the funding transaction MUST NOT be broadcast before
`fundchannel_cancel`. Broadcasting transaction before `fundchannel_cancel`
WILL lead to unrecoverable loss of funds.
Expand Down
5 changes: 0 additions & 5 deletions doc/lightning-fundchannel_complete.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@ DESCRIPTION
`fundchannel_complete` is a lower level RPC command. It allows a user to
complete an initiated channel establishment with a connected peer.

*id* is the node id of the remote peer.

*psbt* is the transaction to use for funding (does not need to be
signed but must be otherwise complete).

Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command
Expand Down
22 changes: 0 additions & 22 deletions doc/lightning-fundchannel_start.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,6 @@ DESCRIPTION
`fundchannel_start` is a lower level RPC command. It allows a user to
initiate channel establishment with a connected peer.

*id* is the node id of the remote peer.

*amount* is the satoshi value that the channel will be funded at. This
value MUST be accurate, otherwise the negotiated commitment transactions
will not encompass the correct channel value.

*feerate* is an optional field. Sets the feerate for subsequent
commitment transactions: see **fundchannel**. Note that this is ignored
for channels with *option\_anchors\_zero\_fee\_htlc\_tx* (we always use a low
commitment fee for these).

*announce* whether or not to announce this channel.

*close\_to* is a Bitcoin address to which the channel funds should be sent to
on close. Only valid if both peers have negotiated `option_upfront_shutdown_script`.
Returns `close_to` set to closing script iff is negotiated.

*push\_msat* is the amount of millisatoshis to push to the channel peer at
open. Note that this is a gift to the peer -- these satoshis are
added to the initial balance of the peer at channel start and are largely
unrecoverable once pushed.

Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed by running
`fundchannel_complete`, as the commitment transactions for this channel
Expand Down
43 changes: 9 additions & 34 deletions doc/lightning-funderupdate.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,14 @@ SYNOPSIS

**funderupdate** [*policy*] [*policy\_mod*] [*leases\_only*] [*min\_their\_funding\_msat*] [*max\_their\_funding\_msat*] [*per\_channel\_min\_msat*] [*per\_channel\_max\_msat*] [*reserve\_tank\_msat*] [*fuzz\_percent*] [*fund\_probability*] [*lease\_fee\_base\_msat*] [*lease\_fee\_basis*] [*funding\_weight*] [*channel\_fee\_max\_base\_msat*] [*channel\_fee\_max\_proportional\_thousandths*] [*compact\_lease*]

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

DESCRIPTION
-----------

For channel open requests using
NOTE: Must have --experimental-dual-fund enabled for these settings to take effect.

For channel open requests using dual funding.

*policy*, *policy\_mod* is the policy the funder plugin will use to decide
how much capital to commit to a v2 open channel request. There are three
policy options, detailed below: `match`, `available`, and `fixed`.
The *policy\_mod* is the number or 'modification' to apply to the policy.
Default is (fixed, 0sats).
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
Expand All @@ -33,69 +28,50 @@ Default is (fixed, 0sats).
Note: to maximize channel leases, best policy setting is (match, 100).

*leases\_only* will only contribute funds to `option_will_fund` requests
which pay to lease funds. Defaults to false, will fund any v2 open request
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.

*min\_their\_funding\_msat* is the minimum funding sats that we require in order
to activate our contribution policy to the v2 open. Defaults to 10k sats.

*max\_their\_funding\_msat* is the 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. Defaults to no max (`UINT_MAX`).

*per\_channel\_min\_msat* is the minimum amount that we will contribute to a
channel open. Defaults to 10k sats.

*per\_channel\_max\_msat* is the maximum amount that we will contribute to a
channel open. Defaults to no max (`UINT_MAX`).

*reserve\_tank\_msat* is the amount of sats to leave available in the node wallet.
Defaults to zero sats.

*fuzz\_percent* is a percentage to fuzz the resulting contribution 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`.
Defaults to 0% (no fuzz).

*fund\_probability* is the percent of v2 channel open requests to apply our
policy to. Valid values are integers from 0 (fund 0% of all open requests)
to 100 (fund every request). Useful for randomizing opens that receive funds.
Defaults to 100.

Setting any of the next 5 options will activate channel leases for this node,
and advertise these values via the lightning gossip network. If any one is set,
the other values will be the default.

*lease\_fee\_base\_msat* is the flat fee for a channel lease. Node will
receive this much extra added to their channel balance, paid by the opening
node. Defaults to 2k sats. Note that the minimum is 1sat.
node.

*lease\_fee\_basis* is 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. Default is 0.65% (65 basis points)
balance, paid by the opening node.

*funding\_weight* is used to calculate the fee the peer will compensate your
node for its contributing inputs to the funding transaction. The total fee
is calculated as the `open_channel2`.`funding_feerate_perkw` times this
*funding\_weight* divided by 1000. Node will have this funding fee added
to their channel balance, paid by the opening node. Default is
2 inputs + 1 P2WPKH output.
to their channel balance, paid by the opening node.

*channel\_fee\_max\_base\_msat* is 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. Default is 5k sats.
over this leased channel during the lease duration.

*channel\_fee\_max\_proportional\_thousandths* is 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. Default is 100 (100k ppm).
to 1k ppm; `5` is 5k ppm, etc.

*compact\_lease* is a compact description of the channel lease params. When
opening a channel, passed in to `fundchannel` to indicate the terms we
Expand Down Expand Up @@ -141,7 +117,6 @@ SEE ALSO

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


RESOURCES
---------

Expand Down
2 changes: 0 additions & 2 deletions doc/lightning-getlog.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ DESCRIPTION

The **getlog** the RPC command to show logs, with optional log *level*.

- *level*: A string that represents the log level (*broken*, *unusual*, *info*, *debug*, or *io*). The default is *info*.

EXAMPLE JSON REQUEST
--------------------

Expand Down
2 changes: 0 additions & 2 deletions doc/lightning-listconfigs.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ SYNOPSIS
DESCRIPTION
-----------

*config* (optional) is a configuration option name to restrict return.

The **listconfigs** RPC command to list all configuration options, or with *config* only one.

The returned values reflect the current configuration, including
Expand Down
7 changes: 3 additions & 4 deletions doc/lightning-listoffers.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ lightning-listoffers -- Command for listing offers
SYNOPSIS
--------

**(WARNING: experimental-offers only)**

**listoffers** [*offer\_id*] [*active\_only*]

DESCRIPTION
-----------

**(WARNING: experimental-offers only)**

The **listoffers** RPC command list all offers, or with `offer_id`,
only the offer with that offer\_id (if it exists). If `active_only` is
set and is true, only offers with `active` true are returned.
only the offer with that offer\_id (if it exists).

EXAMPLE JSON REQUEST
------------
Expand Down
62 changes: 1 addition & 61 deletions doc/lightning-multifundchannel.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,67 +22,7 @@ Once the transaction is confirmed, normal channel operations may begin.
Readiness is indicated by **listpeers** reporting a *state* of
`CHANNELD_NORMAL` for the channel.

*destinations* is an array of objects, with the fields:

* *id* is the node ID, with an optional *@host:port* appended to it
in a manner understood by **connect**; see lightning-connect(7).
Each entry in the *destinations* array must have a unique node *id*.
* *amount* is the amount in satoshis taken from the internal wallet
to fund the channel (but if we have any anchor channels, this will always leave at least `min-emergency-msat` as change).
The string *all* can be used to specify all available funds
(or 16,777,215 satoshi if more is available and large channels were
not negotiated with the peer).
Otherwise it is in satoshi precision; 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*.
The value cannot be less than the dust limit, currently 546 satoshi
as of this writing, nor more than 16,777,215 satoshi
(unless large channels were negotiated with the peer).
* *announce* is an optional flag that indicates whether to announce
the channel with this, default `true`.
If set to `false`, the channel is unpublished.
* *push\_msat* is the amount of millisatoshis to outright give to the
node.
This is a gift to the peer, and you do not get a proof-of-payment
out of this.
* *close\_to* is a Bitcoin address to which the channel funds should be sent to
on close. Only valid if both peers have negotiated
`option_upfront_shutdown_script`. Returns `close_to` set to
closing script iff is negotiated.
* *request\_amt* is the amount of liquidity you'd like to lease from peer.
If peer supports `option_will_fund`, indicates to them to include this
much liquidity into the channel. Must also pass in *compact\_lease*.
* *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.

*feerate* is an optional feerate used for the opening transaction, and
if *commitment\_feerate* is not set, as initial feerate for commitment
and HTLC transactions. See NOTES in lightning-feerates(7) for possible
values. The default is *normal*.

*minconf* specifies the minimum number of confirmations that used
outputs should have. Default is 1.

*utxos* specifies the utxos to be used to fund the channel, as an array
of "txid:vout".

*minchannels*, if specified, will re-attempt funding as long as at least
this many peers remain (must not be zero).
The **multifundchannel** command will only fail if too many peers fail
the funding process.

*commitment\_feerate* is the initial feerate for commitment and HTLC
transactions. See *feerate* for valid values.
There must be at least one entry in *destinations*; it cannot be an empty array.

RETURN VALUE
------------
Expand Down
20 changes: 1 addition & 19 deletions doc/lightning-multiwithdraw.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,7 @@ DESCRIPTION
-----------

The **multiwithdraw** RPC command sends funds from Core Lightning's internal
wallet to the addresses specified in *outputs*,
which is an array containing objects of the form `{address: amount}`.
The `amount` may be the string *"all"*, indicating that all onchain funds
be sent to the specified address.
Otherwise, it is in satoshi precision;
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*.

*feerate* is an optional feerate: see NOTES in lightning-feerates(7)
for possible values. The default is *normal*.

*minconf* specifies the minimum number of confirmations that used
outputs should have. Default is 1.

*utxos* specifies the utxos to be used to be withdrawn from, as an array
of "txid:vout". These must be drawn from the node's available UTXO set.
wallet to the addresses specified in *outputs*.

RETURN VALUE
------------
Expand Down
2 changes: 0 additions & 2 deletions doc/lightning-notifications.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ disabled.
Various commands, especially complex and slow ones, offer
notifications which indicate their progress.

- *enable*: *true* to enable notifications, *false* to disable them.

EXAMPLE JSON REQUEST
--------------------

Expand Down
Loading

0 comments on commit 1096e2e

Please sign in to comment.