Errors

ShahanaFarooqui · Dec 21, 2023 · 27cebe3 · 27cebe3
1 parent 0bbf9f3
commit 27cebe3
Show file tree

Hide file tree

Showing 43 changed files with 131 additions and 258 deletions.
diff --git a/doc/lightning-datastore.7.md b/doc/lightning-datastore.7.md
@@ -43,6 +43,8 @@ On success, an object is returned, containing:
 
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
+ERRORS
+------
 
 The following error codes may occur:
 

diff --git a/doc/lightning-fetchinvoice.7.md b/doc/lightning-fetchinvoice.7.md
@@ -41,6 +41,9 @@ On success, an object is returned, containing:
 
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
+ERRORS
+------
+
 The following error codes may occur:
 
 - -1: Catchall nonspecific error.

diff --git a/doc/lightning-fundchannel.7.md b/doc/lightning-fundchannel.7.md
@@ -39,8 +39,8 @@ On success, an object is returned, containing:
 - **close_to** (hex, optional): The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`
 - **mindepth** (u32, optional): Number of confirmations before we consider the channel active.
 
-ERROR
-------
+ERRORS
+-------
 
 The following error codes may occur:
 

diff --git a/doc/lightning-invoice.7.md b/doc/lightning-invoice.7.md
@@ -16,62 +16,6 @@ lightning daemon can use to pay this invoice. This token includes a
 *route hint* description of an incoming channel with capacity to pay the
 invoice, if any exists.
 
-The *amount\_msat* parameter can be the string "any", which creates an
-invoice that can be paid with any amount. Otherwise it is a positive value in
-millisatoshi precision; it can be a whole number, or a whole number
-ending in *msat* or *sat*, or a number with three decimal places ending
-in *sat*, or a number with 1 to 11 decimal places ending in *btc*.
-
-The *label* must be a unique string or number (which is treated as a
-string, so "01" is different from "1"); it is never revealed to other
-nodes on the lightning network, but it can be used to query the status
-of this invoice.
-
-The *description* is a short description of purpose of payment, e.g. *1
-cup of coffee*. This value is encoded into the BOLT11 invoice and is
-viewable by any node you send this invoice to (unless *deschashonly* is
-true as described below). It must be UTF-8, and cannot use *\\u* JSON
-escape codes.
-
-The *expiry* is optionally the time the invoice is valid for, in seconds.
-If no value is provided the default of 604800 (1 week) is used.
-
-The *fallbacks* array is one or more fallback addresses to include in
-the invoice (in order from most-preferred to least): note that these
-arrays are not currently tracked to fulfill the invoice.
-
-The *preimage* is a 64-digit hex string to be used as payment preimage
-for the created invoice. By default, if unspecified, lightningd will
-generate a secure pseudorandom preimage seeded from an appropriate
-entropy source on your system. **IMPORTANT**: if you specify the
-*preimage*, you are responsible, to ensure appropriate care for
-generating using a secure pseudorandom generator seeded with sufficient
-entropy, and keeping the preimage secret. This parameter is an advanced
-feature intended for use with cutting-edge cryptographic protocols and
-should not be used unless explicitly needed.
-
-If specified, *exposeprivatechannels* overrides the default route hint
-logic, which will use unpublished channels only if there are no
-published channels. If *true* unpublished channels are always considered
-as a route hint candidate; if *false*, never.  If it is a short channel id
-(e.g. *1x1x3*) or array of short channel ids (or a remote alias), only those specific channels
-will be considered candidates, even if they are public or dead-ends.
-
-The route hint is selected from the set of incoming channels of which:
-peer's balance minus their reserves is at least *amount\_msat*, state is
-normal, the peer is connected and not a dead end (i.e. has at least one
-other public channel). The selection uses some randomness to prevent
-probing, but favors channels that become more balanced after the
-payment.
-
-If specified, *cltv* sets the *min\_final\_cltv\_expiry* for the invoice.
-Otherwise, it's set to the parameter **cltv-final**.
-
-If *deschashonly* is true (default false), then the bolt11 returned
-contains a hash of the *description*, rather than the *description*
-itself: this allows much longer descriptions, but they must be
-communicated via some other mechanism.
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-invoicerequest.7.md b/doc/lightning-invoicerequest.7.md
@@ -17,33 +17,6 @@ invoice, and payment of it.  The reader of the resulting
 `invoice_request` can use lightning-sendinvoice(7) to collect their
 payment.
 
-The *amount* parameter can be a positive value in millisatoshi
-precision; it can be a whole number, or a whole number ending in
-*msat* or *sat*, or a number with three decimal places ending in
-*sat*, or a number with 1 to 11 decimal places ending in *btc*.
-
-The *description* is a short description of purpose of the payment,
-e.g. *ATM withdrawl*. This value is encoded into the resulting
-`invoice_request` and is viewable by anyone you expose it to. It must
-be UTF-8, and cannot use *\\u* JSON escape codes.
-
-The *issuer* is another (optional) field exposed in the
-`invoice_request`, and reflects who is issuing it (i.e. you) if
-appropriate.
-
-The *label* field is an internal-use name for the offer, which can
-be any UTF-8 string.
-
-The *absolute\_expiry* is optionally the time the offer is valid
-until, in seconds since the first day of 1970 UTC.  If not set, the
-`invoice_request` remains valid (though it can be deactivated by the
-issuer of course).  This is encoded in the `invoice_request`.
-
-*single\_use* (default true) indicates that the `invoice_request` is
-only valid once; we may attempt multiple payments, but as soon as one
-is successful no more invoices are accepted (i.e. only one person can
-take the money).
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-keysend.7.md b/doc/lightning-keysend.7.md
@@ -22,22 +22,6 @@ generated on the destination, and the only way sender could have it is by
 sending a payment. Please ensure that this matches your use-case when using
 `keysend`.
 
-`destination` is the 33 byte, hex-encoded, node ID of the node that the payment should go to.
-`amount\_msat` is in millisatoshi precision; it can be a whole number, or a whole number with suffix `msat` or `sat`, or a three decimal point number with suffix `sat`, or an 1 to 11 decimal point number suffixed by `btc`.
-
-The `label` field is used to attach a label to payments, and is returned in lightning-listpays(7) and lightning-listsendpays(7).
-The `maxfeepercent` limits the money paid in fees as percentage of the total amount that is to be transferred, and defaults to *0.5*.
-The `exemptfee` option can be used for tiny payments which would be dominated by the fee leveraged by forwarding nodes.
-Setting `exemptfee` allows the `maxfeepercent` check to be skipped on fees that are smaller than *exemptfee* (default: 5000 millisatoshi).
-
-The response will occur when the payment fails or succeeds.
-Unlike lightning-pay(7), issuing the same `keysend` commands multiple times will result in multiple payments being sent.
-
-Until *retry\_for* seconds passes (default: 60), the command will keep finding routes and retrying the payment.
-However, a payment may be delayed for up to `maxdelay` blocks by another node; clients should be prepared for this worst case.
-
-*extratlvs* is an optional dictionary of additional fields to insert into the final tlv.  The format is 'fieldnumber': 'hexstring'.
-
 When using *lightning-cli*, you may skip optional parameters by using
 *null*. Alternatively, use **-k** option to provide parameters by name.
 
@@ -87,6 +71,9 @@ The following warnings may also be returned:
 
 You can monitor the progress and retries of a payment using the lightning-paystatus(7) command.
 
+ERRORS
+------
+
 The following error codes may occur:
 
 - `-1`: Catchall nonspecific error.

diff --git a/doc/lightning-listchannels.7.md b/doc/lightning-listchannels.7.md
@@ -13,15 +13,6 @@ The **listchannels** RPC command returns data on channels that are known
 to the node. Because channels may be bidirectional, up to 2 objects will
 be returned for each channel (one for each direction).
 
-If *short\_channel\_id* is a short channel id, then only known channels with a
-matching *short\_channel\_id* are returned.  Otherwise, it must be null.
-
-If *source* is a node id, then only channels leading from that node id
-are returned.
-
-If *destination* is a node id, then only channels leading to that node id
-are returned.
-
 Only one of *short\_channel\_id*, *source* or *destination* can be supplied.
 If nothing is supplied, data on all lightning channels known to this
 node, are returned. These can be local channels or public channels

diff --git a/doc/lightning-listclosedchannels.7.md b/doc/lightning-listclosedchannels.7.md
@@ -13,10 +13,6 @@ The **listclosedchannels** RPC command returns data on channels which
 are otherwise forgotten (more than 100 blocks after they're completely
 resolved onchain).
 
-If no *id* is supplied, then channel data on all historical channels are given.
-
-Supplying *id* will filter the results to only match channels to that peer.  Note that prior to v23.05, old peers were forgotten.
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-listdatastore.7.md b/doc/lightning-listdatastore.7.md
@@ -12,9 +12,6 @@ DESCRIPTION
 The **listdatastore** RPC command allows plugins to fetch data which was
 stored in the Core Lightning database.
 
-All immediate children of the *key* (or root children) are returned:
-a *key* with children won't have a *hex* or *generation* entry.
-
 RETURN VALUE
 ------------
 
@@ -29,6 +26,9 @@ On success, an object containing **datastore** is returned.  It is an array of o
 
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
+ERRORS
+------
+
 The following error codes may occur:
 
 - -32602: invalid parameters.

diff --git a/doc/lightning-listforwards.7.md b/doc/lightning-listforwards.7.md
@@ -12,18 +12,6 @@ DESCRIPTION
 The **listforwards** RPC command displays all htlcs that have been
 attempted to be forwarded by the Core Lightning node.
 
-If *status* is specified, then only the forwards with the given status are returned.
-*status* can be either *offered* or *settled* or *failed* or *local\_failed*
-
-If *in\_channel* or *out\_channel* is specified, then only the matching forwards
-on the given in/out channel are returned.
-
-If neither *in\_channel* or *out\_channel* is specified,
-`index` controls ordering, by `created` (default) or `updated`.  If
-`index` is specified, `start` may be specified to start from that
-value, which is generally returned from lightning-wait(7), and `limit`
-can be used to specify the maximum number of entries to return.
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-listfunds.7.md b/doc/lightning-listfunds.7.md
@@ -13,9 +13,6 @@ The **listfunds** RPC command displays all funds available, either in
 unspent outputs (UTXOs) in the internal wallet or funds locked in
 currently open channels.
 
-*spent* is a boolean: if true, then the *outputs* will include spent outputs
-in addition to the unspent ones. Default is false.
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-listhtlcs.7.md b/doc/lightning-listhtlcs.7.md
@@ -11,9 +11,7 @@ DESCRIPTION
 
 The **listhtlcs** RPC command gets all HTLCs (which, generally, we
 remember for as long as a channel is open, even if they've completed
-long ago).  If given a short channel id (e.g. 1x2x3) or full 64-byte
-hex channel id, it will only list htlcs for that channel (which
-must be known).
+long ago).
 
 RETURN VALUE
 ------------

diff --git a/doc/lightning-listinvoicerequests.7.md b/doc/lightning-listinvoicerequests.7.md
@@ -12,11 +12,6 @@ DESCRIPTION
 The **listinvoicerequests** RPC command gets the status of a specific `invoice_request`,
 if it exists, or the status of all `invoice_requests` if given no argument.
 
-A specific invoice can be queried by providing the `invreq_id`, which
-is presented by lightning-invoicerequest(7), or can be calculated from
-a bolt12 invoice.  If `active_only` is `true` (default is `false`) then
-only active invoice\_requests are returned.
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md
@@ -12,15 +12,7 @@ DESCRIPTION
 The **listinvoices** RPC command gets the status of a specific invoice,
 if it exists, or the status of all invoices if given no argument.
 
-A specific invoice can be queried by providing either the `label`
-provided when creating the invoice, the `invstring` string representing
-the invoice, the `payment_hash` of the invoice, or the local `offer_id`
-this invoice was issued for. Only one of the query parameters can be used at once.
-
-`index` controls ordering, by `created` (default) or `updated`.  If
-`index` is specified, `start` may be specified to start from that
-value, which is generally returned from lightning-wait(7), and `limit`
-can be used to specify the maximum number of entries to return.
+Only one of the query parameters can be used from *label*, *invstring*, *payment_hash*, or *offer_id*
 
 RETURN VALUE
 ------------

diff --git a/doc/lightning-listpays.7.md b/doc/lightning-listpays.7.md
@@ -11,7 +11,6 @@ DESCRIPTION
 
 The **listpay** RPC command gets the status of all *pay* commands, or a
 single one if either *bolt11* or *payment\_hash* was specified.
-It is possible filter the payments also by *status*.
 
 RETURN VALUE
 ------------

diff --git a/doc/lightning-listpeerchannels.7.md b/doc/lightning-listpeerchannels.7.md
@@ -15,9 +15,6 @@ If no *id* is supplied, then channel data on all lightning nodes that are
 connected, or not connected but have open channels with this node, are
 returned.
 
-Supplying *id* will filter the results to only return channel data that match *id*,
-if one exists.
-
 RETURN VALUE
 ------------
 

diff --git a/doc/lightning-listpeers.7.md b/doc/lightning-listpeers.7.md
@@ -20,13 +20,6 @@ If no *id* is supplied, then data on all lightning nodes that are
 connected, or not connected but have open channels with this node, are
 returned.
 
-Supplying *id* will filter the results to only return data on a node
-with a matching *id*, if one exists.
-
-Supplying *level* will show log entries related to that peer at the
-given log level. Valid log levels are "io", "debug", "info", and
-"unusual".
-
 If a channel is open with a node and the connection has been lost, then
 the node will still appear in the output of the command and the value of
 the *connected* attribute of the node will be "false".

diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md
@@ -12,17 +12,11 @@ DESCRIPTION
 The **listsendpays** RPC command gets the status of all *sendpay*
 commands (which is also used by the *pay* command), or with *bolt11* or
 *payment\_hash* limits results to that specific payment. You cannot
-specify both. It is possible filter the payments also by *status*.
+specify both. It is possible to filter the payments also by *status*.
 
 Note that there may be more than one concurrent *sendpay*
 command per *pay*, so this command should be used with caution.
 
-If neither *bolt11* or *payment\_hash* is specified,
-`index` controls ordering, by `created` (default) or `updated`.  If
-`index` is specified, `start` may be specified to start from that
-value, which is generally returned from lightning-wait(7), and `limit`
-can be used to specify the maximum number of entries to return.
-
 RETURN VALUE
 ------------
 
@@ -60,8 +54,7 @@ If **status** is "failed":
 AUTHOR
 ------
 
-Christian Decker <<[email protected]>> is mainly
-responsible.
+Christian Decker <<[email protected]>> is mainly responsible.
 
 SEE ALSO
 --------

diff --git a/doc/lightning-makesecret.7.md b/doc/lightning-makesecret.7.md
@@ -11,9 +11,6 @@ DESCRIPTION
 
 The **makesecret** RPC command derives a secret key from the HSM\_secret.
 
-One of *hex* or *string* must be specified: *hex* can be any hex data,
-*string* is a UTF-8 string interpreted literally.
-
 RETURN VALUE
 ------------
 
@@ -24,6 +21,8 @@ On success, an object is returned, containing:
 
 [comment]: # (GENERATE-FROM-SCHEMA-END)
 
+ERRORS
+------
 
 The following error codes may occur:
 

diff --git a/doc/lightning-newaddr.7.md b/doc/lightning-newaddr.7.md
@@ -14,15 +14,7 @@ subsequently be used to fund channels managed by the Core Lightning node.
 
 The funding transaction needs to be confirmed before funds can be used.
 
-*addresstype* specifies the type of address wanted; currently *bech32*
-(e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet
-or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on
-bitcoin mainnet), or *p2tr* taproot addresses. The special value *all*
-generates all known address types for the same underlying key.
-
-If no *addresstype* is specified the address generated is a *bech32* address.
-
-To send an on-chain payment _from_ the Core Lightning node wallet, use `withdraw`. 
+To send an on-chain payment from the Core Lightning node wallet, use `withdraw`. 
 
 RETURN VALUE
 ------------

diff --git a/doc/lightning-notifications.7.md b/doc/lightning-notifications.7.md
@@ -10,11 +10,10 @@ DESCRIPTION
 -----------
 
 The **notifications** the RPC command enabled notifications for this JSON-RPC
-connection.  By default (and for backwards-compatibility) notifications are
-disabled.
+connection.  By default (and for backwards-compatibility) notifications are disabled.
 
-Various commands, especially complex and slow ones, offer
-notifications which indicate their progress.
+Various commands, especially complex and slow ones, offer notifications which indicate 
+their progress.
 
 EXAMPLE JSON REQUEST
 --------------------

diff --git a/doc/lightning-pay.7.md b/doc/lightning-pay.7.md
@@ -114,6 +114,9 @@ The following warnings may also be returned:
 You can monitor the progress and retries of a payment using the
 lightning-paystatus(7) command.
 
+ERRORS
+------
+
 The following error codes may occur:
 
 - -1: Catchall nonspecific error.
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,6 +43,8 @@ On success, an object is returned, containing: @@
     [comment]: # (GENERATE-FROM-SCHEMA-END)
+    ERRORS
+    ------
     The following error codes may occur:
@@ Expand Down @@