diff --git a/doc/lightning-addgossip.7.md b/doc/lightning-addgossip.7.md index cc214f11f..e5ad29508 100644 --- a/doc/lightning-addgossip.7.md +++ b/doc/lightning-addgossip.7.md @@ -42,4 +42,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:326e5801f65998e13e909d8b682e9fbc9824f3a43aa7da1d76b871882e52f293) +[comment]: # ( SHA256STAMP:6ab8038cbad395e5a65a52fe66948740ad360c123e42c28d5879f5f03369b744) diff --git a/doc/lightning-autoclean-once.7.md b/doc/lightning-autoclean-once.7.md index e14de540e..77f4983b0 100644 --- a/doc/lightning-autoclean-once.7.md +++ b/doc/lightning-autoclean-once.7.md @@ -67,4 +67,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:eebeb7600540caf66857b98c384ae7ee9a2a651398a7aec005703e71e72a6d62) +[comment]: # ( SHA256STAMP:9853f639595b1fd8d04e41cf7fe8de9bb90d1cb132c70dd4f8db8a7cf6f1233b) diff --git a/doc/lightning-autoclean-status.7.md b/doc/lightning-autoclean-status.7.md index ca22f2675..6c71bb1a9 100644 --- a/doc/lightning-autoclean-status.7.md +++ b/doc/lightning-autoclean-status.7.md @@ -91,4 +91,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:9431024693a7c26f9519ef24bdfb8b5c26902bdc0631d427f89c9e49ecd88e13) +[comment]: # ( SHA256STAMP:151fc6cdfd277cac7e6f18e98384b40a6cc1c2a3eb2d0f1e3c26442aa0e9e8d4) diff --git a/doc/lightning-batching.7.md b/doc/lightning-batching.7.md index d69d8b290..d45cda59b 100644 --- a/doc/lightning-batching.7.md +++ b/doc/lightning-batching.7.md @@ -52,4 +52,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:326e5801f65998e13e909d8b682e9fbc9824f3a43aa7da1d76b871882e52f293) +[comment]: # ( SHA256STAMP:6ab8038cbad395e5a65a52fe66948740ad360c123e42c28d5879f5f03369b744) diff --git a/doc/lightning-bkpr-channelsapy.7.md b/doc/lightning-bkpr-channelsapy.7.md index e688f187e..b8f53a09e 100644 --- a/doc/lightning-bkpr-channelsapy.7.md +++ b/doc/lightning-bkpr-channelsapy.7.md @@ -23,14 +23,14 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **channels\_apy** is returned. It is an array of objects, where each object contains: -- **account** (string): The account name. If the account is a channel, the channel_id. The 'net' entry is the rollup of all channel accounts +- **account** (string): The account name. If the account is a channel, the channel\_id. The 'net' entry is the rollup of all channel accounts - **routed\_out\_msat** (msat): Sats routed (outbound) - **routed\_in\_msat** (msat): Sats routed (inbound) - **lease\_fee\_paid\_msat** (msat): Sats paid for leasing inbound (liquidity ads) - **lease\_fee\_earned\_msat** (msat): Sats earned for leasing outbound (liquidity ads) - **pushed\_out\_msat** (msat): Sats pushed to peer at open - **pushed\_in\_msat** (msat): Sats pushed in from peer at open -- **our\_start\_balance\_msat** (msat): Starting balance in channel at funding. Note that if our start ballance is zero, any _initial field will be omitted (can't divide by zero) +- **our\_start\_balance\_msat** (msat): Starting balance in channel at funding. Note that if our start ballance is zero, any \_initial field will be omitted (can't divide by zero) - **channel\_start\_balance\_msat** (msat): Total starting balance at funding - **fees\_out\_msat** (msat): Fees earned on routed outbound - **utilization\_out** (string): Sats routed outbound / total start balance @@ -65,4 +65,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:8ec833f8261ab8b559f0d645d6da45322b388905413ef262d95f5039d533fdc8) +[comment]: # ( SHA256STAMP:97fb832389b1084e25015a7a46b5d84b37e8e08f7c9e9eb678beb0d026f161dd) diff --git a/doc/lightning-bkpr-dumpincomecsv.7.md b/doc/lightning-bkpr-dumpincomecsv.7.md index 214517845..440cad07e 100644 --- a/doc/lightning-bkpr-dumpincomecsv.7.md +++ b/doc/lightning-bkpr-dumpincomecsv.7.md @@ -57,4 +57,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1375c000d025b6cb72daa3b2ea64ec3212ae1aa5552c0d87918fd869d2fc5a0b) +[comment]: # ( SHA256STAMP:8c27ebf6e36fb26051ec724d44497d765454cac071d287586d2b0490e690c01c) diff --git a/doc/lightning-bkpr-inspect.7.md b/doc/lightning-bkpr-inspect.7.md index 0fd01cf2b..a5119cd5b 100644 --- a/doc/lightning-bkpr-inspect.7.md +++ b/doc/lightning-bkpr-inspect.7.md @@ -52,4 +52,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:ea50ea813e46669b522ebd466619ac6f7a4be5ae38b4f976a7db70a3c01b7fae) +[comment]: # ( SHA256STAMP:1fc6c84962d2c670b3555dbdb7ffdddf33c4f5c445f3cfbab474a6c017ead06b) diff --git a/doc/lightning-bkpr-listaccountevents.7.md b/doc/lightning-bkpr-listaccountevents.7.md index 610b618d3..cb09197f3 100644 --- a/doc/lightning-bkpr-listaccountevents.7.md +++ b/doc/lightning-bkpr-listaccountevents.7.md @@ -25,13 +25,13 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **events** is returned. It is an array of objects, where each object contains: -- **account** (string): The account name. If the account is a channel, the channel_id -- **type** (string): Coin movement type (one of "onchain_fee", "chain", "channel") +- **account** (string): The account name. If the account is a channel, the channel\_id +- **type** (string): Coin movement type (one of "onchain\_fee", "chain", "channel") - **tag** (string): Description of movement - **credit\_msat** (msat): Amount credited - **debit\_msat** (msat): Amount debited - **currency** (string): human-readable bech32 part for this coin type -- **timestamp** (u32): Timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp +- **timestamp** (u32): Timestamp this event was recorded by the node. For consolidated events such as onchain\_fees, the most recent timestamp If **type** is "chain": @@ -42,7 +42,7 @@ If **type** is "chain": - **txid** (txid, optional): The txid of the transaction that created this event - **description** (string, optional): The description of this event -If **type** is "onchain_fee": +If **type** is "onchain\_fee": - **txid** (txid): The txid of the transaction that created this event @@ -71,4 +71,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1ac0919bf29ebc37a92283d15a9ffa06f0f46be5fb55920b335d0c43e02a6ee4) +[comment]: # ( SHA256STAMP:2326473627193f2e7d2a1688d046106996a43602ccad64df16913e89bf67b3e8) diff --git a/doc/lightning-bkpr-listbalances.7.md b/doc/lightning-bkpr-listbalances.7.md index 21cad1db1..851e6efff 100644 --- a/doc/lightning-bkpr-listbalances.7.md +++ b/doc/lightning-bkpr-listbalances.7.md @@ -21,7 +21,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **accounts** is returned. It is an array of objects, where each object contains: -- **account** (string): The account name. If the account is a channel, the channel_id +- **account** (string): The account name. If the account is a channel, the channel\_id - **balances** (array of objects): - **balance\_msat** (msat): Current account balance - **coin\_type** (string): coin type, same as HRP for bech32 @@ -53,4 +53,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:2801e5f237043c6f85d35e2f4a5f69aab5d1cb6a9fcbea9ead1da2daa93265c8) +[comment]: # ( SHA256STAMP:ece6c722354576bd5de4d116547546129cdb22e950ce5e9fde3c4d7466bd255c) diff --git a/doc/lightning-bkpr-listincome.7.md b/doc/lightning-bkpr-listincome.7.md index c65bba9ca..b56cca892 100644 --- a/doc/lightning-bkpr-listincome.7.md +++ b/doc/lightning-bkpr-listincome.7.md @@ -28,12 +28,12 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **income\_events** is returned. It is an array of objects, where each object contains: -- **account** (string): The account name. If the account is a channel, the channel_id +- **account** (string): The account name. If the account is a channel, the channel\_id - **tag** (string): Type of income event - **credit\_msat** (msat): Amount earned (income) - **debit\_msat** (msat): Amount spent (expenses) - **currency** (string): human-readable bech32 part for this coin type -- **timestamp** (u32): Timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp +- **timestamp** (u32): Timestamp this event was recorded by the node. For consolidated events such as onchain\_fees, the most recent timestamp - **description** (string, optional): More information about this event. If a `invoice` type, typically the bolt11/bolt12 description - **outpoint** (string, optional): The txid:outnum for this event, if applicable - **txid** (txid, optional): The txid of the transaction that created this event, if applicable @@ -57,4 +57,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:24a4784f87f26283e8849e525d51b376d3e69ae20c0941cfd745a7d07af8032a) +[comment]: # ( SHA256STAMP:8d35ccd4a389f70dc69bda4b66bd834bd48198191565fe37d4af8caa165a8108) diff --git a/doc/lightning-check.7.md b/doc/lightning-check.7.md index c859c61cb..e35c18707 100644 --- a/doc/lightning-check.7.md +++ b/doc/lightning-check.7.md @@ -26,7 +26,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **command\_to\_check** (string): the *command_to_check* argument +- **command\_to\_check** (string): the *command\_to\_check* argument [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -41,4 +41,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:22c1ad9baf37cb8c7c4b587047d40ef23f0af3d821feaf1aab6d365d724b08fe) +[comment]: # ( SHA256STAMP:0a799d16e3f191b6c5dbea039ba32c6824718b326a1178b1f4948461c8ba6a0b) diff --git a/doc/lightning-checkmessage.7.md b/doc/lightning-checkmessage.7.md index 6d5c3af4a..da5b0c378 100644 --- a/doc/lightning-checkmessage.7.md +++ b/doc/lightning-checkmessage.7.md @@ -50,4 +50,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:28b7c05443a785461a0134e3c2761a2e2d698cb71044f4d895d15ac7f2ee4316) +[comment]: # ( SHA256STAMP:7a8b174b98e2e339e0001de740d19ac83042617eaad9b160fa5a8a3525ce7bc4) diff --git a/doc/lightning-close.7.md b/doc/lightning-close.7.md index 5cc64a384..fdf3b171d 100644 --- a/doc/lightning-close.7.md +++ b/doc/lightning-close.7.md @@ -135,4 +135,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6a438338ae697732f0100f9e1566b9b8d189778cdb05681305e060487d68663e) +[comment]: # ( SHA256STAMP:f323b7998a41c28a6c398b8e4ebbefcd227b7624dcf7c03373b518bc55211dd6) diff --git a/doc/lightning-commando-rune.7.md b/doc/lightning-commando-rune.7.md index fa05c91fe..f78e0b7f1 100644 --- a/doc/lightning-commando-rune.7.md +++ b/doc/lightning-commando-rune.7.md @@ -218,4 +218,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:08ded3c93fea629f414a96f12ac02de1000743a487ec8989ba1510a59861ccc1) +[comment]: # ( SHA256STAMP:5f4371a060861ca04019948242803f8b6254627f9993a866ec6e119d8a14cef6) diff --git a/doc/lightning-connect.7.md b/doc/lightning-connect.7.md index ab6752fa3..189b3da8c 100644 --- a/doc/lightning-connect.7.md +++ b/doc/lightning-connect.7.md @@ -104,4 +104,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:581c6243302c8fa5c9234de97e1f6af842bbfee544850c55281924721b46432f) +[comment]: # ( SHA256STAMP:b9f59ec875e50da2251c3e9e6166e62cfc473a46e29eece96705f34c27841782) diff --git a/doc/lightning-createinvoice.7.md b/doc/lightning-createinvoice.7.md index 09468bb4e..587d20022 100644 --- a/doc/lightning-createinvoice.7.md +++ b/doc/lightning-createinvoice.7.md @@ -34,7 +34,7 @@ RETURN VALUE On success, an object is returned, containing: - **label** (string): the label for the invoice -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): Whether it has been paid, or can no longer be paid (one of "paid", "expired", "unpaid") - **description** (string): Description extracted from **bolt11** or **bolt12** - **expires\_at** (u64): UNIX timestamp of when invoice expires (or expired) @@ -44,9 +44,9 @@ On success, an object is returned, containing: - **pay\_index** (u64, optional): Incrementing id for when this was paid (**status** *paid* only) - **amount\_received\_msat** (msat, optional): Amount actually received (**status** *paid* only) - **paid\_at** (u64, optional): UNIX timestamp of when invoice was paid (**status** *paid* only) -- **payment\_preimage** (secret, optional): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) +- **payment\_preimage** (secret, optional): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) - **local\_offer\_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters) -- **invreq\_payer\_note** (string, optional): the optional *invreq_payer_note* from invoice_request which created this invoice (**experimental-offers** only). +- **invreq\_payer\_note** (string, optional): the optional *invreq\_payer\_note* from invoice\_request which created this invoice (**experimental-offers** only). [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -75,4 +75,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:3acf2924a8670605f70a7976cf4909b60addf4b1aeebc9b9a104151cffa2c984) +[comment]: # ( SHA256STAMP:8f1ca1ec7fafd96f38d6ffaa0b9b1d0ac0a5ec5d535c45b8b4cb08257468a6b2) diff --git a/doc/lightning-createonion.7.md b/doc/lightning-createonion.7.md index 2827988e6..e3615360a 100644 --- a/doc/lightning-createonion.7.md +++ b/doc/lightning-createonion.7.md @@ -91,7 +91,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **onion** (hex): the onion packet (*onion_size* bytes) +- **onion** (hex): the onion packet (*onion\_size* bytes) - **shared\_secrets** (array of secrets): one shared secret for each node in the *hops* parameter: - the shared secret with this hop (always 64 characters) @@ -132,4 +132,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c8bd0abd35904cb009b95a7d345be4cc254cff2a427dcf04679a64a6e62dce1e) +[comment]: # ( SHA256STAMP:da11700fff0b97851d2c649b3717a3b51c606a930b84dbdd24fb3367dd7de8cb) diff --git a/doc/lightning-datastore.7.md b/doc/lightning-datastore.7.md index 81c7409f7..052798f8c 100644 --- a/doc/lightning-datastore.7.md +++ b/doc/lightning-datastore.7.md @@ -66,4 +66,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:cb5bccd7efd8438c61b909bda419e0300993b2b2267cb335c1f91d12bd402b3e) +[comment]: # ( SHA256STAMP:65c6c1cb555e5042c3d5d7ad4f9577ec75838d497349c8caee7e186486e09d04) diff --git a/doc/lightning-decode.7.md b/doc/lightning-decode.7.md index 1ecf05503..eda2c2bd6 100644 --- a/doc/lightning-decode.7.md +++ b/doc/lightning-decode.7.md @@ -24,7 +24,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **type** (string): what kind of object it decoded to (one of "bolt12 offer", "bolt12 invoice", "bolt12 invoice_request", "bolt11 invoice", "rune") +- **type** (string): what kind of object it decoded to (one of "bolt12 offer", "bolt12 invoice", "bolt12 invoice\_request", "bolt11 invoice", "rune") - **valid** (boolean): if this is false, you *MUST* not use the result except for diagnostics! If **type** is "bolt12 offer", and **valid** is *true*: @@ -47,7 +47,7 @@ If **type** is "bolt12 offer", and **valid** is *true*: - **first\_node\_id** (pubkey): the (presumably well-known) public key of the start of the path - **blinding** (pubkey): blinding factor for this path - **path** (array of objects): an individual path: - - **blinded\_node\_id** (pubkey): node_id of the hop + - **blinded\_node\_id** (pubkey): node\_id of the hop - **encrypted\_recipient\_data** (hex): encrypted TLV entry for this hop - **offer\_recurrence** (object, optional): how often to this offer should be used: - **time\_unit** (u32): the BOLT12 time unit @@ -76,13 +76,13 @@ If **type** is "bolt12 offer", and **valid** is *false*: - **warning\_invalid\_offer\_currency**: `offer_currency_code` is not valid UTF8 - **warning\_invalid\_offer\_issuer**: `offer_issuer` is not valid UTF8 -If **type** is "bolt12 invoice_request", and **valid** is *true*: +If **type** is "bolt12 invoice\_request", and **valid** is *true*: - **offer\_description** (string): the description of the purpose of the offer - **offer\_node\_id** (pubkey): public key of the offering node - - **invreq\_metadata** (hex): the payer-provided blob to derive invreq_payer_id + - **invreq\_metadata** (hex): the payer-provided blob to derive invreq\_payer\_id - **invreq\_payer\_id** (hex): the payer-provided key - - **signature** (bip340sig): BIP-340 signature of the `invreq_payer_id` on this invoice_request + - **signature** (bip340sig): BIP-340 signature of the `invreq_payer_id` on this invoice\_request - **offer\_id** (hex, optional): the id we use to identify this offer (always 64 characters) - **offer\_chains** (array of hexs, optional): which blockchains this offer is for (missing implies bitcoin mainnet only): - the genesis blockhash (always 64 characters) @@ -99,7 +99,7 @@ If **type** is "bolt12 invoice_request", and **valid** is *true*: - **first\_node\_id** (pubkey): the (presumably well-known) public key of the start of the path - **blinding** (pubkey): blinding factor for this path - **path** (array of objects): an individual path: - - **blinded\_node\_id** (pubkey): node_id of the hop + - **blinded\_node\_id** (pubkey): node\_id of the hop - **encrypted\_recipient\_data** (hex): encrypted TLV entry for this hop - **offer\_recurrence** (object, optional): how often to this offer should be used: - **time\_unit** (u32): the BOLT12 time unit @@ -114,7 +114,7 @@ If **type** is "bolt12 invoice_request", and **valid** is *true*: - **proportional\_amount** (boolean, optional): amount should be scaled if payed after period start (always *true*) - **invreq\_chain** (hex, optional): which blockchain this offer is for (missing implies bitcoin mainnet only) (always 64 characters) - **invreq\_amount\_msat** (msat, optional): the amount the invoice should be for - - **invreq\_features** (hex, optional): the feature bits of the invoice_request + - **invreq\_features** (hex, optional): the feature bits of the invoice\_request - **invreq\_quantity** (u64, optional): the number of items to invoice for - **invreq\_payer\_note** (string, optional): a note attached by the payer - **invreq\_recurrence\_counter** (u32, optional): which number request this is for the same invoice @@ -126,7 +126,7 @@ If **type** is "bolt12 invoice_request", and **valid** is *true*: - the following warnings are possible: - **warning\_unknown\_offer\_currency**: The currency code is unknown (so no `currency_minor_unit`) -If **type** is "bolt12 invoice_request", and **valid** is *false*: +If **type** is "bolt12 invoice\_request", and **valid** is *false*: - the following warnings are possible: - **warning\_invalid\_offer\_description**: `offer_description` is not valid UTF8 @@ -143,20 +143,20 @@ If **type** is "bolt12 invoice", and **valid** is *true*: - **offer\_description** (string): the description of the purpose of the offer - **offer\_node\_id** (pubkey): public key of the offering node - - **invreq\_metadata** (hex): the payer-provided blob to derive invreq_payer_id + - **invreq\_metadata** (hex): the payer-provided blob to derive invreq\_payer\_id - **invreq\_payer\_id** (hex): the payer-provided key - **invoice\_paths** (array of objects): Paths to pay the destination: - **first\_node\_id** (pubkey): the (presumably well-known) public key of the start of the path - **blinding** (pubkey): blinding factor for this path - **path** (array of objects): an individual path: - - **blinded\_node\_id** (pubkey): node_id of the hop + - **blinded\_node\_id** (pubkey): node\_id of the hop - **encrypted\_recipient\_data** (hex): encrypted TLV entry for this hop - **fee\_base\_msat** (msat, optional): basefee for path - **fee\_proportional\_millionths** (u32, optional): proportional fee for path - **cltv\_expiry\_delta** (u32, optional): CLTV delta for path - **features** (hex, optional): features allowed for path - **invoice\_created\_at** (u64): the UNIX timestamp of invoice creation - - **invoice\_payment\_hash** (hex): the hash of the *payment_preimage* (always 64 characters) + - **invoice\_payment\_hash** (hex): the hash of the *payment\_preimage* (always 64 characters) - **invoice\_amount\_msat** (msat): the amount required to fulfill invoice - **signature** (bip340sig): BIP-340 signature of the `offer_node_id` on this invoice - **offer\_id** (hex, optional): the id we use to identify this offer (always 64 characters) @@ -175,7 +175,7 @@ If **type** is "bolt12 invoice", and **valid** is *true*: - **first\_node\_id** (pubkey): the (presumably well-known) public key of the start of the path - **blinding** (pubkey): blinding factor for this path - **path** (array of objects): an individual path: - - **blinded\_node\_id** (pubkey): node_id of the hop + - **blinded\_node\_id** (pubkey): node\_id of the hop - **encrypted\_recipient\_data** (hex): encrypted TLV entry for this hop - **offer\_recurrence** (object, optional): how often to this offer should be used: - **time\_unit** (u32): the BOLT12 time unit @@ -190,18 +190,18 @@ If **type** is "bolt12 invoice", and **valid** is *true*: - **proportional\_amount** (boolean, optional): amount should be scaled if payed after period start (always *true*) - **invreq\_chain** (hex, optional): which blockchain this offer is for (missing implies bitcoin mainnet only) (always 64 characters) - **invreq\_amount\_msat** (msat, optional): the amount the invoice should be for - - **invreq\_features** (hex, optional): the feature bits of the invoice_request + - **invreq\_features** (hex, optional): the feature bits of the invoice\_request - **invreq\_quantity** (u64, optional): the number of items to invoice for - **invreq\_payer\_note** (string, optional): a note attached by the payer - **invreq\_recurrence\_counter** (u32, optional): which number request this is for the same invoice - **invreq\_recurrence\_start** (u32, optional): when we're requesting to start an invoice at a non-zero period - - **invoice\_relative\_expiry** (u32, optional): the number of seconds after *invoice_created_at* when this expires + - **invoice\_relative\_expiry** (u32, optional): the number of seconds after *invoice\_created\_at* when this expires - **invoice\_fallbacks** (array of objects, optional): onchain addresses: - **version** (u8): Segwit address version - **hex** (hex): Raw encoded segwit address - **address** (string, optional): bech32 segwit address - **invoice\_features** (hex, optional): the feature bits of the invoice - - **invoice\_node\_id** (pubkey, optional): the id to pay (usually the same as offer_node_id) + - **invoice\_node\_id** (pubkey, optional): the id to pay (usually the same as offer\_node\_id) - **invoice\_recurrence\_basetime** (u64, optional): the UNIX timestamp to base the invoice periods on - **unknown\_invoice\_tlvs** (array of objects, optional): Any extra fields we didn't know how to parse: - **type** (u64): The type @@ -238,7 +238,7 @@ If **type** is "bolt11 invoice", and **valid** is *true*: - **created\_at** (u64): the UNIX-style timestamp of the invoice - **expiry** (u64): the number of seconds this is valid after `created_at` - **payee** (pubkey): the public key of the recipient - - **payment\_hash** (hex): the hash of the *payment_preimage* (always 64 characters) + - **payment\_hash** (hex): the hash of the *payment\_preimage* (always 64 characters) - **signature** (signature): signature of the *payee* on this invoice - **min\_final\_cltv\_expiry** (u32): the minimum CLTV delay for the final node - **amount\_msat** (msat, optional): Amount the invoice asked for @@ -246,7 +246,7 @@ If **type** is "bolt11 invoice", and **valid** is *true*: - **description\_hash** (hex, optional): the hash of the description, in place of *description* (always 64 characters) - **payment\_secret** (hex, optional): the secret to hand to the payee node (always 64 characters) - **features** (hex, optional): the features bitmap for this invoice - - **payment\_metadata** (hex, optional): the payment_metadata to put in the payment + - **payment\_metadata** (hex, optional): the payment\_metadata to put in the payment - **fallbacks** (array of objects, optional): onchain addresses: - **type** (string): the address type (if known) (one of "P2PKH", "P2SH", "P2WPKH", "P2WSH") - **hex** (hex): Raw encoded address @@ -302,4 +302,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1d13c0e0619d05d8c49cf9fbed90f0baf260d59fd8c16bd283d3b211e8be9878) +[comment]: # ( SHA256STAMP:7920e365fe0f41fc2aa99c9e99af7c0666da229310ce50c2c2728c973069b2a7) diff --git a/doc/lightning-decodepay.7.md b/doc/lightning-decodepay.7.md index 9ba5a8b3a..f142a1c64 100644 --- a/doc/lightning-decodepay.7.md +++ b/doc/lightning-decodepay.7.md @@ -22,7 +22,7 @@ On success, an object is returned, containing: - **created\_at** (u64): the UNIX-style timestamp of the invoice - **expiry** (u64): the number of seconds this is valid after *timestamp* - **payee** (pubkey): the public key of the recipient -- **payment\_hash** (hex): the hash of the *payment_preimage* (always 64 characters) +- **payment\_hash** (hex): the hash of the *payment\_preimage* (always 64 characters) - **signature** (signature): signature of the *payee* on this invoice - **min\_final\_cltv\_expiry** (u32): the minimum CLTV delay for the final node - **amount\_msat** (msat, optional): Amount the invoice asked for @@ -30,7 +30,7 @@ On success, an object is returned, containing: - **description\_hash** (hex, optional): the hash of the description, in place of *description* (always 64 characters) - **payment\_secret** (hex, optional): the secret to hand to the payee node (always 64 characters) - **features** (hex, optional): the features bitmap for this invoice -- **payment\_metadata** (hex, optional): the payment_metadata to put in the payment +- **payment\_metadata** (hex, optional): the payment\_metadata to put in the payment - **fallbacks** (array of objects, optional): onchain addresses: - **type** (string): the address type (if known) (one of "P2PKH", "P2SH", "P2WPKH", "P2WSH") - **hex** (hex): Raw encoded address @@ -71,4 +71,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c98fd8cac46b5446ff2d01ede6b082f64a83d4b5745d06e410af3e1dd91be8e2) +[comment]: # ( SHA256STAMP:a1163f7535526b8f9bcea137c6cd5d270e0730d2d58f8c8487794415273dd489) diff --git a/doc/lightning-deldatastore.7.md b/doc/lightning-deldatastore.7.md index c991b49a1..9651d2157 100644 --- a/doc/lightning-deldatastore.7.md +++ b/doc/lightning-deldatastore.7.md @@ -49,4 +49,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:262227d8b4aaee5cad954afa4335b29bceabd787f346d1e5a990614edac7f5e7) +[comment]: # ( SHA256STAMP:0d9d6e4336f6317ca85628b76f2aa40a5172b54333a1a3931e1284d9a803f61b) diff --git a/doc/lightning-delexpiredinvoice.7.md b/doc/lightning-delexpiredinvoice.7.md index e2a9c3c45..bfda28704 100644 --- a/doc/lightning-delexpiredinvoice.7.md +++ b/doc/lightning-delexpiredinvoice.7.md @@ -38,4 +38,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:01526643e128e75057c668cd5dd36e79f075ca847bc692629e1c773b6c940ae6) +[comment]: # ( SHA256STAMP:aa572f59f54ad8ca0d2c43d41574e9068c7d5dc371927638b7c8a0c1c3b6e496) diff --git a/doc/lightning-delforward.7.md b/doc/lightning-delforward.7.md index 091aab806..c5ab8cdda 100644 --- a/doc/lightning-delforward.7.md +++ b/doc/lightning-delforward.7.md @@ -55,4 +55,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:200de829c6635242cb2dd8ec0650c2fa8f5fcbf413f4a704884516df80492fcb) +[comment]: # ( SHA256STAMP:4aff9673290966c7b09e65672da5dc8ef4d2601d3d1681009b329a4f8ceb9af6) diff --git a/doc/lightning-delinvoice.7.md b/doc/lightning-delinvoice.7.md index 9a1551e81..4c33f2d0a 100644 --- a/doc/lightning-delinvoice.7.md +++ b/doc/lightning-delinvoice.7.md @@ -28,7 +28,7 @@ Note: The return is the same as an object from lightning-listinvoice(7). On success, an object is returned, containing: - **label** (string): Unique label given at creation time -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): State of invoice (one of "paid", "expired", "unpaid") - **expires\_at** (u64): UNIX timestamp when invoice expires (or expired) - **bolt11** (string, optional): BOLT11 string @@ -39,14 +39,14 @@ On success, an object is returned, containing: If **bolt12** is present: - **local\_offer\_id** (hex, optional): offer for which this invoice was created - - **invreq\_payer\_note** (string, optional): the optional *invreq_payer_note* from invoice_request which created this invoice + - **invreq\_payer\_note** (string, optional): the optional *invreq\_payer\_note* from invoice\_request which created this invoice If **status** is "paid": - **pay\_index** (u64): unique index for this invoice payment - **amount\_received\_msat** (msat): how much was actually received - **paid\_at** (u64): UNIX timestamp of when payment was received - - **payment\_preimage** (secret): SHA256 of this is the *payment_hash* offered in the invoice (always 64 characters) + - **payment\_preimage** (secret): SHA256 of this is the *payment\_hash* offered in the invoice (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -81,4 +81,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:961571f6b2155f0452ac376bdf957474dd20e97e05a89efdf590f6e4da310f4f) +[comment]: # ( SHA256STAMP:c21dd851c40769c1b79489ccaf364c4647a67bf6cd1a34dd96a8574016d66d96) diff --git a/doc/lightning-delpay.7.md b/doc/lightning-delpay.7.md index 4568ebfbb..9414040d5 100644 --- a/doc/lightning-delpay.7.md +++ b/doc/lightning-delpay.7.md @@ -42,7 +42,7 @@ payments will be returned -- one payment object for each partid. On success, an object containing **payments** is returned. It is an array of objects, where each object contains: - **id** (u64): unique ID for this payment attempt -- **payment\_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hex): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): status of the payment (one of "pending", "failed", "complete") - **amount\_sent\_msat** (msat): the amount we actually sent, including fees - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated @@ -50,7 +50,7 @@ On success, an object containing **payments** is returned. It is an array of ob - **destination** (pubkey, optional): the final destination of the payment if known - **amount\_msat** (msat, optional): the amount the destination received, if known - **completed\_at** (u64, optional): the UNIX timestamp showing when this payment was completed -- **groupid** (u64, optional): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash +- **groupid** (u64, optional): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash - **payment\_preimage** (hex, optional): proof of payment (always 64 characters) - **label** (string, optional): the label, if given to sendpay - **bolt11** (string, optional): the bolt11 string (if pay supplied one) @@ -106,4 +106,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:1ce2241eeae759ed5566342fb7810e62fa2c618f2465314f17376ebe9b6d24f8) +[comment]: # ( SHA256STAMP:6f1e5f66278e49d10d5556abfabbab6a178f0dbd518b669ce93a32e6763dd458) diff --git a/doc/lightning-disableoffer.7.md b/doc/lightning-disableoffer.7.md index d074eb958..3f3e453bb 100644 --- a/doc/lightning-disableoffer.7.md +++ b/doc/lightning-disableoffer.7.md @@ -74,4 +74,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:b471374a7c160373b328c2171953225b7fa27d26314a270e95320c1b6ef57307) +[comment]: # ( SHA256STAMP:f6896438745837d5f1f5999553b397660eded7b22e5d0765ce5feaa3fc14e48e) diff --git a/doc/lightning-disconnect.7.md b/doc/lightning-disconnect.7.md index 68b5f5277..cae3b959c 100644 --- a/doc/lightning-disconnect.7.md +++ b/doc/lightning-disconnect.7.md @@ -59,4 +59,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:326e5801f65998e13e909d8b682e9fbc9824f3a43aa7da1d76b871882e52f293) +[comment]: # ( SHA256STAMP:6ab8038cbad395e5a65a52fe66948740ad360c123e42c28d5879f5f03369b744) diff --git a/doc/lightning-feerates.7.md b/doc/lightning-feerates.7.md index 9e0dbe79e..23e1ebc67 100644 --- a/doc/lightning-feerates.7.md +++ b/doc/lightning-feerates.7.md @@ -52,7 +52,7 @@ On success, an object is returned, containing: - **max\_acceptable** (u32): The largest feerate we will accept from remote negotiations. If a peer attempts to set the feerate higher than this we will unilaterally close the channel (or simply forget it if it's not open yet). - **opening** (u32, optional): Default feerate for lightning-fundchannel(7) and lightning-withdraw(7) - **mutual\_close** (u32, optional): Feerate to aim for in cooperative shutdown. Note that since mutual close is a **negotiation**, the actual feerate used in mutual close will be somewhere between this and the corresponding mutual close feerate of the peer. - - **unilateral\_close** (u32, optional): Feerate for commitment_transaction in a live channel which we originally funded + - **unilateral\_close** (u32, optional): Feerate for commitment\_transaction in a live channel which we originally funded - **delayed\_to\_us** (u32, optional): Feerate for returning unilateral close funds to our wallet - **htlc\_resolution** (u32, optional): Feerate for returning unilateral close HTLC outputs to our wallet - **penalty** (u32, optional): Feerate to start at when penalizing a cheat attempt @@ -61,7 +61,7 @@ On success, an object is returned, containing: - **max\_acceptable** (u32): The largest feerate we will accept from remote negotiations. If a peer attempts to set the feerate higher than this we will unilaterally close the channel (or simply forget it if it's not open yet). - **opening** (u32, optional): Default feerate for lightning-fundchannel(7) and lightning-withdraw(7) - **mutual\_close** (u32, optional): Feerate to aim for in cooperative shutdown. Note that since mutual close is a **negotiation**, the actual feerate used in mutual close will be somewhere between this and the corresponding mutual close feerate of the peer. - - **unilateral\_close** (u32, optional): Feerate for commitment_transaction in a live channel which we originally funded + - **unilateral\_close** (u32, optional): Feerate for commitment\_transaction in a live channel which we originally funded - **delayed\_to\_us** (u32, optional): Feerate for returning unilateral close funds to our wallet - **htlc\_resolution** (u32, optional): Feerate for returning unilateral close HTLC outputs to our wallet - **penalty** (u32, optional): Feerate to start at when penalizing a cheat attempt @@ -121,4 +121,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:d448abe4c00efb8cb68edf6f8316f130ed45a26223b151ac0647bf5b69aec4fd) +[comment]: # ( SHA256STAMP:c4fbacd9a36de4ed8307deae74f49e40a158435d726aee02f5c37f7a31a71400) diff --git a/doc/lightning-fetchinvoice.7.md b/doc/lightning-fetchinvoice.7.md index e7d159a4f..fce644ef5 100644 --- a/doc/lightning-fetchinvoice.7.md +++ b/doc/lightning-fetchinvoice.7.md @@ -58,7 +58,7 @@ On success, an object is returned, containing: - **vendor\_removed** (string, optional): The *vendor* from the offer, which is missing in the invoice - **vendor** (string, optional): a completely replaced *vendor* field - **amount\_msat** (msat, optional): the amount, if different from the offer amount multiplied by any *quantity* (or the offer had no amount, or was not in BTC). -- **next\_period** (object, optional): Only for recurring invoices if the next period is under the *recurrence_limit*: +- **next\_period** (object, optional): Only for recurring invoices if the next period is under the *recurrence\_limit*: - **counter** (u64): the index of the next period to fetchinvoice - **starttime** (u64): UNIX timestamp that the next period starts - **endtime** (u64): UNIX timestamp that the next period ends @@ -89,4 +89,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:18164ef676c71c8d3abde89d974b3c74bd7fdb43356a737f937b2fb060795a47) +[comment]: # ( SHA256STAMP:59b33634070b62e711cae7457bfb08874851e4e001512feaefc5ddac1a5b3b5b) diff --git a/doc/lightning-fundchannel.7.md b/doc/lightning-fundchannel.7.md index cd302efa6..58d9fff54 100644 --- a/doc/lightning-fundchannel.7.md +++ b/doc/lightning-fundchannel.7.md @@ -88,8 +88,8 @@ On success, an object is returned, containing: - **tx** (hex): The raw transaction which funded the channel - **txid** (txid): The txid of the transaction which funded the channel - **outnum** (u32): The 0-based output index showing which output funded the channel -- **channel\_id** (hex): The channel_id of the resulting channel (always 64 characters) -- **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` +- **channel\_id** (hex): The channel\_id of the resulting channel (always 64 characters) +- **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. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -115,4 +115,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:bca36e910b93b86fc42c2d047e703e9760250757cbf09d8cacdf4e3fe1a1f605) +[comment]: # ( SHA256STAMP:ed7d5aa730bf6b87b3f7072272b984539ca991670c13f85a0da8d4d1333549ae) diff --git a/doc/lightning-fundchannel_cancel.7.md b/doc/lightning-fundchannel_cancel.7.md index 2a2ce70e5..7909c2f0f 100644 --- a/doc/lightning-fundchannel_cancel.7.md +++ b/doc/lightning-fundchannel_cancel.7.md @@ -60,4 +60,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:a6b67ae1ecd3bfe5c41e17710342ce32e93675775653bfcffc5b7413c6a15726) +[comment]: # ( SHA256STAMP:d8a18db4d75c051ec89cd2a52add52aea04e78608c625270238c992b977ec173) diff --git a/doc/lightning-fundchannel_complete.7.md b/doc/lightning-fundchannel_complete.7.md index 55d74f971..f63679929 100644 --- a/doc/lightning-fundchannel_complete.7.md +++ b/doc/lightning-fundchannel_complete.7.md @@ -29,7 +29,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **channel\_id** (hex): The channel_id of the resulting channel (always 64 characters) +- **channel\_id** (hex): The channel\_id of the resulting channel (always 64 characters) - **commitments\_secured** (boolean): Indication that channel is safe to use (always *true*) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -62,4 +62,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6852cb54595920fa692b6c0a816b44efa7623a3fd12af90602a137f7de0fc57c) +[comment]: # ( SHA256STAMP:a1853aa4288c0ee50956328f02e86b580de0dffc8b73e204c8f5daaa79c51a0c) diff --git a/doc/lightning-fundchannel_start.7.md b/doc/lightning-fundchannel_start.7.md index 01a0c6cae..551c4e168 100644 --- a/doc/lightning-fundchannel_start.7.md +++ b/doc/lightning-fundchannel_start.7.md @@ -46,7 +46,7 @@ On success, an object is returned, containing: - **funding\_address** (string): The address to send funding to for the channel. DO NOT SEND COINS TO THIS ADDRESS YET. - **scriptpubkey** (hex): The raw scriptPubkey for the address -- **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` +- **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. The following warnings may also be returned: @@ -85,4 +85,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:b054bc55f69cc1f23f78f342974a8476eab84146bbcf57ab30095e8eba3ed849) +[comment]: # ( SHA256STAMP:ca4ad15c25dc588980dea11be9d3f73c9da3688a5e81bfc13660eabe93cbec13) diff --git a/doc/lightning-funderupdate.7.md b/doc/lightning-funderupdate.7.md index 4a9f6c44e..865f8d542 100644 --- a/doc/lightning-funderupdate.7.md +++ b/doc/lightning-funderupdate.7.md @@ -109,7 +109,7 @@ On success, an object is returned, containing: - **summary** (string): Summary of the current funding policy e.g. (match 100) - **policy** (string): Policy funder plugin will use to decide how much captial to commit to a v2 open channel request (one of "match", "available", "fixed") -- **policy\_mod** (u32): The *policy_mod* is the number or 'modification' to apply to the policy. +- **policy\_mod** (u32): The *policy\_mod* is the number or 'modification' to apply 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. @@ -121,8 +121,8 @@ On success, an object is returned, containing: - **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 channel 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 channel_fee_base_msat we'll charge for routing funds leased on this channel. -- **channel\_fee\_max\_proportional\_thousandths** (u32, optional): Maximum channel_fee_proportional_millitionths we'll charge for routing funds leased on this channel, in thousandths. +- **channel\_fee\_max\_base\_msat** (msat, optional): Maximum channel\_fee\_base\_msat we'll charge for routing funds leased on this channel. +- **channel\_fee\_max\_proportional\_thousandths** (u32, optional): Maximum channel\_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. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -147,4 +147,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:03b74bb9d03466181e3f643f718a07388e722e4a6ea1fbb30350e22a7fc491c3) +[comment]: # ( SHA256STAMP:13eef3ba929ea98506f6ed3d042072be6f70fd01d503ca5f7b49480dea7af627) diff --git a/doc/lightning-fundpsbt.7.md b/doc/lightning-fundpsbt.7.md index b66f4f492..5b7728a27 100644 --- a/doc/lightning-fundpsbt.7.md +++ b/doc/lightning-fundpsbt.7.md @@ -76,8 +76,8 @@ On success, an object is returned, containing: - **psbt** (string): Unsigned PSBT which fulfills the parameters given - **feerate\_per\_kw** (u32): The feerate used to create the PSBT, in satoshis-per-kiloweight - **estimated\_final\_weight** (u32): The estimated weight of the transaction once fully signed -- **excess\_msat** (msat): The amount above *satoshi* which is available. This could be zero, or dust; it will be zero if *change_outnum* is also returned -- **change\_outnum** (u32, optional): The 0-based output number where change was placed (only if parameter *excess_as_change* was true and there was sufficient funds) +- **excess\_msat** (msat): The amount above *satoshi* which is available. This could be zero, or dust; it will be zero if *change\_outnum* is also returned +- **change\_outnum** (u32, optional): The 0-based output number where change was placed (only if parameter *excess\_as\_change* was true and there was sufficient funds) - **reservations** (array of objects, optional): If *reserve* was true or a non-zero number, just as per lightning-reserveinputs(7): - **txid** (txid): The txid of the transaction - **vout** (u32): The 0-based output number @@ -115,4 +115,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:0f290582f49c6103258b7f781a9e7fa4075ec6c05335a459a91da0b6fd58c68d) +[comment]: # ( SHA256STAMP:35947e2b2c402a87c4bad3a5a90443bfe5db44d71cb515541074abfc4dc3f24d) diff --git a/doc/lightning-getinfo.7.md b/doc/lightning-getinfo.7.md index 99cc81369..142f6f54a 100644 --- a/doc/lightning-getinfo.7.md +++ b/doc/lightning-getinfo.7.md @@ -41,9 +41,9 @@ On success, an object is returned, containing: - **network** (string): represents the type of network on the node are working (e.g: `bitcoin`, `testnet`, or `regtest`) - **fees\_collected\_msat** (msat): Total routing fees collected by this node - **our\_features** (object, optional): Our BOLT #9 feature bits (as hexstring) for various contexts: - - **init** (hex): features (incl. globalfeatures) in our init message, these also restrict what we offer in open_channel or accept in accept_channel - - **node** (hex): features in our node_announcement message - - **channel** (hex): negotiated channel features we (as channel initiator) publish in the channel_announcement message + - **init** (hex): features (incl. globalfeatures) in our init message, these also restrict what we offer in open\_channel or accept in accept\_channel + - **node** (hex): features in our node\_announcement message + - **channel** (hex): negotiated channel features we (as channel initiator) publish in the channel\_announcement message - **invoice** (hex): features in our BOLT11 invoices - **address** (array of objects, optional): The addresses we announce to the world: - **type** (string): Type of connection (one of "dns", "ipv4", "ipv6", "torv2", "torv3", "websocket") @@ -131,4 +131,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:0e54af449933b833f2e74bab9fde46096a79d69b4d958a548c7c0b7cc5654e99) +[comment]: # ( SHA256STAMP:ce2b96e2e97cf6bc1e311d6125253dfbed900f13c001f518e9a0b4f202a0e1d6) diff --git a/doc/lightning-getlog.7.md b/doc/lightning-getlog.7.md index d4c3942fc..19b605d5b 100644 --- a/doc/lightning-getlog.7.md +++ b/doc/lightning-getlog.7.md @@ -33,9 +33,9 @@ On success, an object is returned, containing: - **created\_at** (string): UNIX timestamp with 9 decimal places, when logging was initialized - **bytes\_used** (u32): The number of bytes used by logging records -- **bytes\_max** (u32): The bytes_used values at which records will be trimmed +- **bytes\_max** (u32): The bytes\_used values at which records will be trimmed - **log** (array of objects): - - **type** (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "IO_IN", "IO_OUT") + - **type** (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "IO\_IN", "IO\_OUT") If **type** is "SKIPPED": @@ -43,14 +43,14 @@ On success, an object is returned, containing: If **type** is "BROKEN", "UNUSUAL", "INFO" or "DEBUG": - - **time** (string): UNIX timestamp with 9 decimal places after **created_at** + - **time** (string): UNIX timestamp with 9 decimal places after **created\_at** - **source** (string): The particular logbook this was found in - **log** (string): The actual log message - **node\_id** (pubkey, optional): The peer this is associated with - If **type** is "IO_IN" or "IO_OUT": + If **type** is "IO\_IN" or "IO\_OUT": - - **time** (string): Seconds after **created_at**, with 9 decimal places + - **time** (string): Seconds after **created\_at**, with 9 decimal places - **source** (string): The particular logbook this was found in - **log** (string): The associated log message - **data** (hex): The IO which occurred @@ -94,4 +94,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:0f6e346c57e59aa8ebe0aee9bcb7ded6f66776752e55c4c125f4a80d98cf90fd) +[comment]: # ( SHA256STAMP:6b925456a06076ba98a04df3ff6931d2cd5d09ccec82829301428493ff824e34) diff --git a/doc/lightning-getroute.7.md b/doc/lightning-getroute.7.md index 128afe20a..5e66f6946 100644 --- a/doc/lightning-getroute.7.md +++ b/doc/lightning-getroute.7.md @@ -310,4 +310,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:e592a238b3701399c1e8de45cb7186b9714742daefa2f33287019f860c1cc24d) +[comment]: # ( SHA256STAMP:7456e80dc70830703bd8fd05d4047f721592bc3c1b2c51fbcb54ce0d87167380) diff --git a/doc/lightning-help.7.md b/doc/lightning-help.7.md index bf46d269b..0c4539e5b 100644 --- a/doc/lightning-help.7.md +++ b/doc/lightning-help.7.md @@ -68,4 +68,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:48f9ef4d1d73aa13ebd1ffa37107111c35c1a197bbcf00f52c5149847ca57ac1) +[comment]: # ( SHA256STAMP:64c5aa03469d6cb3e00e46141a5f11e499a0cc74a13b5600b26aa6dd1539346f) diff --git a/doc/lightning-invoice.7.md b/doc/lightning-invoice.7.md index b490a8a3d..eb1464fb0 100644 --- a/doc/lightning-invoice.7.md +++ b/doc/lightning-invoice.7.md @@ -79,8 +79,8 @@ RETURN VALUE On success, an object is returned, containing: - **bolt11** (string): the bolt11 string -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) -- **payment\_secret** (secret): the *payment_secret* to place in the onion (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) +- **payment\_secret** (secret): the *payment\_secret* to place in the onion (always 64 characters) - **expires\_at** (u64): UNIX timestamp of when invoice expires The following warnings may also be returned: @@ -119,4 +119,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:4dd2b9d74116f77ad09ad4162ba8438db79e79d1aa99b23e2c993d754327649d) +[comment]: # ( SHA256STAMP:e3b07ce2a4cbe9198d5a65df1e49b628a8a7e857770e004a1d84c41c67601712) diff --git a/doc/lightning-keysend.7.md b/doc/lightning-keysend.7.md index ac99a6d8b..ffa889bfd 100644 --- a/doc/lightning-keysend.7.md +++ b/doc/lightning-keysend.7.md @@ -70,8 +70,8 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **created\_at** (number): the UNIX timestamp showing when this payment was initiated - **parts** (u32): how many attempts this took - **amount\_msat** (msat): Amount the recipient received @@ -118,4 +118,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:d208bd6f3e78b039a4790b8de599ffd819aa169c59430ac487fd7030cd3fe640) +[comment]: # ( SHA256STAMP:b6a047c09d40be10ed9027ca0f38332a57bfe7a232fa66fa5a669cf76e2731cd) diff --git a/doc/lightning-listchannels.7.md b/doc/lightning-listchannels.7.md index 49af830d0..7be7d4f1b 100644 --- a/doc/lightning-listchannels.7.md +++ b/doc/lightning-listchannels.7.md @@ -41,7 +41,7 @@ On success, an object containing **channels** is returned. It is an array of ob - **message\_flags** (u8): as defined by BOLT #7 - **channel\_flags** (u8): as defined by BOLT #7 - **active** (boolean): true unless source has disabled it, or it's a local channel and the peer is disconnected or it's still opening or closing -- **last\_update** (u32): UNIX timestamp on the last channel_update from *source* +- **last\_update** (u32): UNIX timestamp on the last channel\_update from *source* - **base\_fee\_millisatoshi** (u32): Base fee changed by *source* to use this channel - **fee\_per\_millionth** (u32): Proportional fee changed by *source* to use this channel, in parts-per-million - **delay** (u32): The number of blocks delay required by *source* to use this channel @@ -79,4 +79,4 @@ Lightning RFC site - BOLT \#7: -[comment]: # ( SHA256STAMP:baf45b77bd2ba22e245e007b57d8e5f70d06cbf9cebf7ed1431da6a0cf6f367a) +[comment]: # ( SHA256STAMP:693b8297d390522cd68a27b607194567cebb7bf021f769c82d430afced9d0029) diff --git a/doc/lightning-listconfigs.7.md b/doc/lightning-listconfigs.7.md index cc4b79ee0..543689956 100644 --- a/doc/lightning-listconfigs.7.md +++ b/doc/lightning-listconfigs.7.md @@ -101,7 +101,7 @@ On success, an object is returned, containing: - **accept-htlc-tlv-types** (string, optional): `accept-extra-tlvs-type` fields from config or cmdline, or not present - **tor-service-password** (string, optional): `tor-service-password` field from config or cmdline, if any - **dev-allowdustreserve** (boolean, optional): Whether we allow setting dust reserves -- **announce-addr-dns** (boolean, optional): Whether we put DNS entries into node_announcement +- **announce-addr-dns** (boolean, optional): Whether we put DNS entries into node\_announcement [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -219,4 +219,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:745268f7f4e4eb19d04ec1a221fbb734d89b4a266049cde3adc3131d86423294) +[comment]: # ( SHA256STAMP:862a1d319a30cb4a0e851d0d57b62eef78d7b7e35f76c70c6bc71d4d2f270a94) diff --git a/doc/lightning-listdatastore.7.md b/doc/lightning-listdatastore.7.md index e3c6e0928..2f0b91c82 100644 --- a/doc/lightning-listdatastore.7.md +++ b/doc/lightning-listdatastore.7.md @@ -47,4 +47,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:699f7121a6f1aac9ea8afe39f4bac0e696e97754579d544a141fe2a0e404305f) +[comment]: # ( SHA256STAMP:ccb9085c7ad0757e324e4e74d5a22009153f2a9f40f4e926c15fc918ab2bab4f) diff --git a/doc/lightning-listforwards.7.md b/doc/lightning-listforwards.7.md index 88570c472..7fa489a96 100644 --- a/doc/lightning-listforwards.7.md +++ b/doc/lightning-listforwards.7.md @@ -26,23 +26,23 @@ On success, an object containing **forwards** is returned. It is an array of ob - **in\_channel** (short\_channel\_id): the channel that received the HTLC - **in\_msat** (msat): the value of the incoming HTLC -- **status** (string): still ongoing, completed, failed locally, or failed after forwarding (one of "offered", "settled", "local_failed", "failed") +- **status** (string): still ongoing, completed, failed locally, or failed after forwarding (one of "offered", "settled", "local\_failed", "failed") - **received\_time** (number): the UNIX timestamp when this was received - **in\_htlc\_id** (u64, optional): the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11) - **out\_channel** (short\_channel\_id, optional): the channel that the HTLC (trying to) forward to -- **out\_htlc\_id** (u64, optional): the unique HTLC id we gave this when sending (may be missing even if out_channel is present, for old forwards before v22.11) +- **out\_htlc\_id** (u64, optional): the unique HTLC id we gave this when sending (may be missing even if out\_channel is present, for old forwards before v22.11) - **style** (string, optional): Either a legacy onion format or a modern tlv format (one of "legacy", "tlv") If **out\_msat** is present: - **fee\_msat** (msat): the amount this paid in fees - - **out\_msat** (msat): the amount we sent out the *out_channel* + - **out\_msat** (msat): the amount we sent out the *out\_channel* If **status** is "settled" or "failed": - **resolved\_time** (number): the UNIX timestamp when this was resolved -If **status** is "local_failed" or "failed": +If **status** is "local\_failed" or "failed": - **failcode** (u32, optional): the numeric onion code returned - **failreason** (string, optional): the name of the onion code returned @@ -64,4 +64,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:15bf997ae8e93ab28b0084d9cc45fc80fb18b2bcf705f690f77617f0b66b069d) +[comment]: # ( SHA256STAMP:2627ce6a1e4877810e690a40fda2145292ce15f0b1393d3b35b4c54b599b044e) diff --git a/doc/lightning-listfunds.7.md b/doc/lightning-listfunds.7.md index 29b4abdcd..165e3f66a 100644 --- a/doc/lightning-listfunds.7.md +++ b/doc/lightning-listfunds.7.md @@ -46,13 +46,13 @@ On success, an object is returned, containing: - **funding\_txid** (txid): funding transaction id - **funding\_output** (u32): the 0-based index of the output in the funding transaction - **connected** (boolean): whether the channel peer is connected - - **state** (string): the channel state, in particular "CHANNELD_NORMAL" means the channel can be used normally (one of "OPENINGD", "CHANNELD_AWAITING_LOCKIN", "CHANNELD_NORMAL", "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN", "ONCHAIN", "DUALOPEND_OPEN_INIT", "DUALOPEND_AWAITING_LOCKIN") + - **state** (string): the channel state, in particular "CHANNELD\_NORMAL" means the channel can be used normally (one of "OPENINGD", "CHANNELD\_AWAITING\_LOCKIN", "CHANNELD\_NORMAL", "CHANNELD\_SHUTTING\_DOWN", "CLOSINGD\_SIGEXCHANGE", "CLOSINGD\_COMPLETE", "AWAITING\_UNILATERAL", "FUNDING\_SPEND\_SEEN", "ONCHAIN", "DUALOPEND\_OPEN\_INIT", "DUALOPEND\_AWAITING\_LOCKIN") - If **state** is "CHANNELD_NORMAL": + If **state** is "CHANNELD\_NORMAL": - **short\_channel\_id** (short\_channel\_id): short channel id of channel - If **state** is "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN" or "ONCHAIN": + If **state** is "CHANNELD\_SHUTTING\_DOWN", "CLOSINGD\_SIGEXCHANGE", "CLOSINGD\_COMPLETE", "AWAITING\_UNILATERAL", "FUNDING\_SPEND\_SEEN" or "ONCHAIN": - **short\_channel\_id** (short\_channel\_id, optional): short channel id of channel (only if funding reached lockin depth before closing) @@ -73,4 +73,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:62a8754ad2a24dfb5bb4e412a2e710748bd54ef0cffaaeb7ce352f6273742431) +[comment]: # ( SHA256STAMP:5c118dc7780049bcd320aa16d301bf778552fe6ae42c9d598a3926ab0c14694d) diff --git a/doc/lightning-listhtlcs.7.md b/doc/lightning-listhtlcs.7.md index 6c8f265c5..541b97331 100644 --- a/doc/lightning-listhtlcs.7.md +++ b/doc/lightning-listhtlcs.7.md @@ -27,7 +27,7 @@ On success, an object containing **htlcs** is returned. It is an array of objec - **amount\_msat** (msat): the value of the HTLC - **direction** (string): out if we offered this to the peer, in if they offered it (one of "out", "in") - **payment\_hash** (hex): payment hash sought by HTLC (always 64 characters) -- **state** (string): The first 10 states are for `in`, the next 10 are for `out`. (one of "SENT_ADD_HTLC", "SENT_ADD_COMMIT", "RCVD_ADD_REVOCATION", "RCVD_ADD_ACK_COMMIT", "SENT_ADD_ACK_REVOCATION", "RCVD_REMOVE_HTLC", "RCVD_REMOVE_COMMIT", "SENT_REMOVE_REVOCATION", "SENT_REMOVE_ACK_COMMIT", "RCVD_REMOVE_ACK_REVOCATION", "RCVD_ADD_HTLC", "RCVD_ADD_COMMIT", "SENT_ADD_REVOCATION", "SENT_ADD_ACK_COMMIT", "RCVD_ADD_ACK_REVOCATION", "SENT_REMOVE_HTLC", "SENT_REMOVE_COMMIT", "RCVD_REMOVE_REVOCATION", "RCVD_REMOVE_ACK_COMMIT", "SENT_REMOVE_ACK_REVOCATION") +- **state** (string): The first 10 states are for `in`, the next 10 are for `out`. (one of "SENT\_ADD\_HTLC", "SENT\_ADD\_COMMIT", "RCVD\_ADD\_REVOCATION", "RCVD\_ADD\_ACK\_COMMIT", "SENT\_ADD\_ACK\_REVOCATION", "RCVD\_REMOVE\_HTLC", "RCVD\_REMOVE\_COMMIT", "SENT\_REMOVE\_REVOCATION", "SENT\_REMOVE\_ACK\_COMMIT", "RCVD\_REMOVE\_ACK\_REVOCATION", "RCVD\_ADD\_HTLC", "RCVD\_ADD\_COMMIT", "SENT\_ADD\_REVOCATION", "SENT\_ADD\_ACK\_COMMIT", "RCVD\_ADD\_ACK\_REVOCATION", "SENT\_REMOVE\_HTLC", "SENT\_REMOVE\_COMMIT", "RCVD\_REMOVE\_REVOCATION", "RCVD\_REMOVE\_ACK\_COMMIT", "SENT\_REMOVE\_ACK\_REVOCATION") [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -46,4 +46,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6ef16f6e1f54522435130d99f224ca41a38fb3c5bc26886ccdaddc69f1abb946) +[comment]: # ( SHA256STAMP:444e5aefafe607226d36b80adfebef7bf0b9173dbb28bbfcc7f78aaed0eac682) diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md index 177c946e4..4b8438f3c 100644 --- a/doc/lightning-listinvoices.7.md +++ b/doc/lightning-listinvoices.7.md @@ -24,7 +24,7 @@ RETURN VALUE On success, an object containing **invoices** is returned. It is an array of objects, where each object contains: - **label** (string): unique label supplied at invoice creation -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): Whether it's paid, unpaid or unpayable (one of "unpaid", "paid", "expired") - **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable - **description** (string, optional): description used in the invoice @@ -32,12 +32,12 @@ On success, an object containing **invoices** is returned. It is an array of ob - **bolt11** (string, optional): the BOLT11 string (always present unless *bolt12* is) - **bolt12** (string, optional): the BOLT12 string (always present unless *bolt11* is) - **local\_offer\_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters) -- **invreq\_payer\_note** (string, optional): the optional *invreq_payer_note* from invoice_request which created this invoice (**experimental-offers** only). +- **invreq\_payer\_note** (string, optional): the optional *invreq\_payer\_note* from invoice\_request which created this invoice (**experimental-offers** only). If **status** is "paid": - **pay\_index** (u64): Unique incrementing index for this payment - - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay) + - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **paid\_at** (u64): UNIX timestamp of when it was paid - **payment\_preimage** (secret): proof of payment (always 64 characters) @@ -58,4 +58,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:5c64a05bbf7485840010b16005c6f5d57725e4b0bf0a2a2106febe91ff0d4eb8) +[comment]: # ( SHA256STAMP:67af32ecf6319aec4376074b0f0a1b42cf111cbb3acec0108d7f3607dc441252) diff --git a/doc/lightning-listnodes.7.md b/doc/lightning-listnodes.7.md index 63c5bf4af..633b4e39a 100644 --- a/doc/lightning-listnodes.7.md +++ b/doc/lightning-listnodes.7.md @@ -30,7 +30,7 @@ RETURN VALUE On success, an object containing **nodes** is returned. It is an array of objects, where each object contains: - **nodeid** (pubkey): the public key of the node -- **last\_timestamp** (u32, optional): A node_announcement has been received for this node (UNIX timestamp) +- **last\_timestamp** (u32, optional): A node\_announcement has been received for this node (UNIX timestamp) If **last\_timestamp** is present: @@ -52,8 +52,8 @@ If **option\_will\_fund** is present: - **lease\_fee\_basis** (u32): the proportional fee in basis points (parts per 10,000) for a lease - **funding\_weight** (u32): the onchain weight you'll have to pay for a lease - **channel\_fee\_max\_base\_msat** (msat): the maximum base routing fee this node will charge during the lease - - **channel\_fee\_max\_proportional\_thousandths** (u32): the maximum proportional routing fee this node will charge during the lease (in thousandths, not millionths like channel_update) - - **compact\_lease** (hex): the lease as represented in the node_announcement + - **channel\_fee\_max\_proportional\_thousandths** (u32): the maximum proportional routing fee this node will charge during the lease (in thousandths, not millionths like channel\_update) + - **compact\_lease** (hex): the lease as represented in the node\_announcement [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -99,4 +99,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:7f1378c1376ade1c9912c8eef3ebc77b13cbc5194ee813f8f1b4e0061338e0bb) +[comment]: # ( SHA256STAMP:030d48d2a5fc02cb26fc2a35125116085eb67d0afc39066259adacc433a3d38b) diff --git a/doc/lightning-listoffers.7.md b/doc/lightning-listoffers.7.md index fddcd2421..f7275532c 100644 --- a/doc/lightning-listoffers.7.md +++ b/doc/lightning-listoffers.7.md @@ -80,4 +80,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:985a6bae4b0a1702cd02998859c8072eee44b219c15294af4f4078465531c8c9) +[comment]: # ( SHA256STAMP:088d6fef8790bc9151b07f9b974568ce612c7fea8f52fdcaaf52b32e4ef8d5f2) diff --git a/doc/lightning-listpays.7.md b/doc/lightning-listpays.7.md index 737784e3f..e7ff59c00 100644 --- a/doc/lightning-listpays.7.md +++ b/doc/lightning-listpays.7.md @@ -19,7 +19,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **pays** is returned. It is an array of objects, where each object contains: -- **payment\_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hex): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): status of the payment (one of "pending", "failed", "complete") - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **destination** (pubkey, optional): the final destination of the payment if known @@ -57,4 +57,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1175415c0f9398e1087d68dd75266bf894249053a4e57f16b8ee16cf5ffa414f) +[comment]: # ( SHA256STAMP:ee5242e7cf0a7c1385ab26885436b723b916f0d4e17080323876781e8c2aee76) diff --git a/doc/lightning-listpeers.7.md b/doc/lightning-listpeers.7.md index e71b95435..683877930 100644 --- a/doc/lightning-listpeers.7.md +++ b/doc/lightning-listpeers.7.md @@ -44,17 +44,17 @@ On success, an object containing **peers** is returned. It is an array of objec - **id** (pubkey): the public key of the peer - **connected** (boolean): True if the peer is currently connected - **channels** (array of objects): - - **state** (string): the channel state, in particular "CHANNELD_NORMAL" means the channel can be used normally (one of "OPENINGD", "CHANNELD_AWAITING_LOCKIN", "CHANNELD_NORMAL", "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN", "ONCHAIN", "DUALOPEND_OPEN_INIT", "DUALOPEND_AWAITING_LOCKIN") + - **state** (string): the channel state, in particular "CHANNELD\_NORMAL" means the channel can be used normally (one of "OPENINGD", "CHANNELD\_AWAITING\_LOCKIN", "CHANNELD\_NORMAL", "CHANNELD\_SHUTTING\_DOWN", "CLOSINGD\_SIGEXCHANGE", "CLOSINGD\_COMPLETE", "AWAITING\_UNILATERAL", "FUNDING\_SPEND\_SEEN", "ONCHAIN", "DUALOPEND\_OPEN\_INIT", "DUALOPEND\_AWAITING\_LOCKIN") - **opener** (string): Who initiated the channel (one of "local", "remote") - **features** (array of strings): - - BOLT #9 features which apply to this channel (one of "option_static_remotekey", "option_anchor_outputs", "option_zeroconf") + - BOLT #9 features which apply to this channel (one of "option\_static\_remotekey", "option\_anchor\_outputs", "option\_zeroconf") - **scratch\_txid** (txid, optional): The txid we would use if we went onchain now - **feerate** (object, optional): Feerates for the current tx: - **perkw** (u32): Feerate per 1000 weight (i.e kSipa) - **perkb** (u32): Feerate per 1000 virtual bytes - **owner** (string, optional): The current subdaemon controlling this connection - - **short\_channel\_id** (short\_channel\_id, optional): The short_channel_id (once locked in) - - **channel\_id** (hash, optional): The full channel_id (always 64 characters) + - **short\_channel\_id** (short\_channel\_id, optional): The short\_channel\_id (once locked in) + - **channel\_id** (hash, optional): The full channel\_id (always 64 characters) - **funding\_txid** (txid, optional): ID of the funding transaction - **funding\_outnum** (u32, optional): The 0-based output number of the funding transaction which opens the channel - **initial\_feerate** (string, optional): For inflight opens, the first feerate used to initiate the channel open @@ -102,8 +102,8 @@ On success, an object containing **peers** is returned. It is an array of objec - **remote** (short\_channel\_id, optional): An alias assigned by the remote node to this channel, usable in routehints and invoices - **state\_changes** (array of objects, optional): Prior state changes: - **timestamp** (string): UTC timestamp of form YYYY-mm-ddTHH:MM:SS.%03dZ - - **old\_state** (string): Previous state (one of "OPENINGD", "CHANNELD_AWAITING_LOCKIN", "CHANNELD_NORMAL", "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN", "ONCHAIN", "DUALOPEND_OPEN_INIT", "DUALOPEND_AWAITING_LOCKIN") - - **new\_state** (string): New state (one of "OPENINGD", "CHANNELD_AWAITING_LOCKIN", "CHANNELD_NORMAL", "CHANNELD_SHUTTING_DOWN", "CLOSINGD_SIGEXCHANGE", "CLOSINGD_COMPLETE", "AWAITING_UNILATERAL", "FUNDING_SPEND_SEEN", "ONCHAIN", "DUALOPEND_OPEN_INIT", "DUALOPEND_AWAITING_LOCKIN") + - **old\_state** (string): Previous state (one of "OPENINGD", "CHANNELD\_AWAITING\_LOCKIN", "CHANNELD\_NORMAL", "CHANNELD\_SHUTTING\_DOWN", "CLOSINGD\_SIGEXCHANGE", "CLOSINGD\_COMPLETE", "AWAITING\_UNILATERAL", "FUNDING\_SPEND\_SEEN", "ONCHAIN", "DUALOPEND\_OPEN\_INIT", "DUALOPEND\_AWAITING\_LOCKIN") + - **new\_state** (string): New state (one of "OPENINGD", "CHANNELD\_AWAITING\_LOCKIN", "CHANNELD\_NORMAL", "CHANNELD\_SHUTTING\_DOWN", "CLOSINGD\_SIGEXCHANGE", "CLOSINGD\_COMPLETE", "AWAITING\_UNILATERAL", "FUNDING\_SPEND\_SEEN", "ONCHAIN", "DUALOPEND\_OPEN\_INIT", "DUALOPEND\_AWAITING\_LOCKIN") - **cause** (string): What caused the change (one of "unknown", "local", "user", "remote", "protocol", "onchain") - **message** (string): Human-readable explanation - **status** (array of strings, optional): @@ -121,17 +121,17 @@ On success, an object containing **peers** is returned. It is an array of objec - **id** (u64): Unique ID for this htlc on this channel in this direction - **amount\_msat** (msat): Amount send/received for this HTLC - **expiry** (u32): Block this HTLC expires at - - **payment\_hash** (hash): the hash of the payment_preimage which will prove payment (always 64 characters) + - **payment\_hash** (hash): the hash of the payment\_preimage which will prove payment (always 64 characters) - **local\_trimmed** (boolean, optional): if this is too small to enforce onchain (always *true*) - **status** (string, optional): set if this HTLC is currently waiting on a hook (and shows what plugin) If **direction** is "out": - - **state** (string): Status of the HTLC (one of "SENT_ADD_HTLC", "SENT_ADD_COMMIT", "RCVD_ADD_REVOCATION", "RCVD_ADD_ACK_COMMIT", "SENT_ADD_ACK_REVOCATION", "RCVD_REMOVE_HTLC", "RCVD_REMOVE_COMMIT", "SENT_REMOVE_REVOCATION", "SENT_REMOVE_ACK_COMMIT", "RCVD_REMOVE_ACK_REVOCATION") + - **state** (string): Status of the HTLC (one of "SENT\_ADD\_HTLC", "SENT\_ADD\_COMMIT", "RCVD\_ADD\_REVOCATION", "RCVD\_ADD\_ACK\_COMMIT", "SENT\_ADD\_ACK\_REVOCATION", "RCVD\_REMOVE\_HTLC", "RCVD\_REMOVE\_COMMIT", "SENT\_REMOVE\_REVOCATION", "SENT\_REMOVE\_ACK\_COMMIT", "RCVD\_REMOVE\_ACK\_REVOCATION") If **direction** is "in": - - **state** (string): Status of the HTLC (one of "RCVD_ADD_HTLC", "RCVD_ADD_COMMIT", "SENT_ADD_REVOCATION", "SENT_ADD_ACK_COMMIT", "RCVD_ADD_ACK_REVOCATION", "SENT_REMOVE_HTLC", "SENT_REMOVE_COMMIT", "RCVD_REMOVE_REVOCATION", "RCVD_REMOVE_ACK_COMMIT", "SENT_REMOVE_ACK_REVOCATION") + - **state** (string): Status of the HTLC (one of "RCVD\_ADD\_HTLC", "RCVD\_ADD\_COMMIT", "SENT\_ADD\_REVOCATION", "SENT\_ADD\_ACK\_COMMIT", "RCVD\_ADD\_ACK\_REVOCATION", "SENT\_REMOVE\_HTLC", "SENT\_REMOVE\_COMMIT", "RCVD\_REMOVE\_REVOCATION", "RCVD\_REMOVE\_ACK\_COMMIT", "SENT\_REMOVE\_ACK\_REVOCATION") If **close\_to** is present: @@ -143,7 +143,7 @@ On success, an object containing **peers** is returned. It is an array of objec If **short\_channel\_id** is present: - - **direction** (u32): 0 if we're the lesser node_id, 1 if we're the greater + - **direction** (u32): 0 if we're the lesser node\_id, 1 if we're the greater If **inflight** is present: @@ -151,7 +151,7 @@ On success, an object containing **peers** is returned. It is an array of objec - **last\_feerate** (string): The feerate for the latest funding transaction in per-1000-weight, with "kpw" appended - **next\_feerate** (string): The minimum feerate for the next funding transaction in per-1000-weight, with "kpw" appended - **log** (array of objects, optional): if *level* is specified, logs for this peer: - - **type** (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "IO_IN", "IO_OUT") + - **type** (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "IO\_IN", "IO\_OUT") If **type** is "SKIPPED": @@ -164,7 +164,7 @@ On success, an object containing **peers** is returned. It is an array of objec - **log** (string): The actual log message - **node\_id** (pubkey): The peer this is associated with - If **type** is "IO_IN" or "IO_OUT": + If **type** is "IO\_IN" or "IO\_OUT": - **time** (string): UNIX timestamp with 9 decimal places - **source** (string): The particular logbook this was found in @@ -399,4 +399,4 @@ Main web site: Lightning RFC site (BOLT \#9): -[comment]: # ( SHA256STAMP:108f43815e3475b88fd9b6a4a8f868e9d729c5d7616e0b0cc2c14f8922f54955) +[comment]: # ( SHA256STAMP:faff728119e12d98202be265991e8b2c17dfa1a611bc52586c662fe8bfdccf53) diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md index fb575eb59..a5d4a6d5b 100644 --- a/doc/lightning-listsendpays.7.md +++ b/doc/lightning-listsendpays.7.md @@ -26,8 +26,8 @@ Note that the returned array is ordered by increasing *id*. On success, an object containing **payments** is returned. It is an array of objects, where each object contains: - **id** (u64): unique ID for this payment attempt -- **groupid** (u64): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **groupid** (u64): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): status of the payment (one of "pending", "failed", "complete") - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **amount\_sent\_msat** (msat): The amount sent @@ -40,7 +40,7 @@ On success, an object containing **payments** is returned. It is an array of ob If **status** is "complete": - - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) + - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) If **status** is "failed": @@ -64,4 +64,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:eddbf227775b367fbea5d90dfc1d06bc87b9301e4b862b0d755592432ef58f89) +[comment]: # ( SHA256STAMP:bd2975d79d2000a8f390da4744c79a924b4fba8268830d086d5024defe8ac274) diff --git a/doc/lightning-listtransactions.7.md b/doc/lightning-listtransactions.7.md index b43e763ff..344d29fab 100644 --- a/doc/lightning-listtransactions.7.md +++ b/doc/lightning-listtransactions.7.md @@ -37,17 +37,17 @@ On success, an object containing **transactions** is returned. It is an array o - **txid** (txid): the transaction id spent - **index** (u32): the output spent - **sequence** (u32): the nSequence value - - **type** (string, optional): the purpose of this input (*EXPERIMENTAL_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel_funding", "channel_mutual_close", "channel_unilateral_close", "channel_sweep", "channel_htlc_success", "channel_htlc_timeout", "channel_penalty", "channel_unilateral_cheat") - - **channel** (short\_channel\_id, optional): the channel this input is associated with (*EXPERIMENTAL_FEATURES* only) + - **type** (string, optional): the purpose of this input (*EXPERIMENTAL\_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel\_funding", "channel\_mutual\_close", "channel\_unilateral\_close", "channel\_sweep", "channel\_htlc\_success", "channel\_htlc\_timeout", "channel\_penalty", "channel\_unilateral\_cheat") + - **channel** (short\_channel\_id, optional): the channel this input is associated with (*EXPERIMENTAL\_FEATURES* only) - **outputs** (array of objects): Each output, in order: - **index** (u32): the 0-based output number - **amount\_msat** (msat): the amount of the output - **scriptPubKey** (hex): the scriptPubKey - - **type** (string, optional): the purpose of this output (*EXPERIMENTAL_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel_funding", "channel_mutual_close", "channel_unilateral_close", "channel_sweep", "channel_htlc_success", "channel_htlc_timeout", "channel_penalty", "channel_unilateral_cheat") - - **channel** (short\_channel\_id, optional): the channel this output is associated with (*EXPERIMENTAL_FEATURES* only) + - **type** (string, optional): the purpose of this output (*EXPERIMENTAL\_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel\_funding", "channel\_mutual\_close", "channel\_unilateral\_close", "channel\_sweep", "channel\_htlc\_success", "channel\_htlc\_timeout", "channel\_penalty", "channel\_unilateral\_cheat") + - **channel** (short\_channel\_id, optional): the channel this output is associated with (*EXPERIMENTAL\_FEATURES* only) - **type** (array of strings, optional): - - Reason we care about this transaction (*EXPERIMENTAL_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel_funding", "channel_mutual_close", "channel_unilateral_close", "channel_sweep", "channel_htlc_success", "channel_htlc_timeout", "channel_penalty", "channel_unilateral_cheat") -- **channel** (short\_channel\_id, optional): the channel this transaction is associated with (*EXPERIMENTAL_FEATURES* only) + - Reason we care about this transaction (*EXPERIMENTAL\_FEATURES* only) (one of "theirs", "deposit", "withdraw", "channel\_funding", "channel\_mutual\_close", "channel\_unilateral\_close", "channel\_sweep", "channel\_htlc\_success", "channel\_htlc\_timeout", "channel\_penalty", "channel\_unilateral\_cheat") +- **channel** (short\_channel\_id, optional): the channel this transaction is associated with (*EXPERIMENTAL\_FEATURES* only) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -105,4 +105,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:f7c39908eaa1a2561597c8f97658b873953daab0a68ed2e9b68e434a55d55efe) +[comment]: # ( SHA256STAMP:1a1afbcbcdbd19df28020d48c581dfff6ed4f5beaf557e1423edb6828eb78a07) diff --git a/doc/lightning-makesecret.7.md b/doc/lightning-makesecret.7.md index 75402e12f..517389c35 100644 --- a/doc/lightning-makesecret.7.md +++ b/doc/lightning-makesecret.7.md @@ -20,7 +20,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **secret** (secret): the pseudorandom key derived from HSM_secret (always 64 characters) +- **secret** (secret): the pseudorandom key derived from HSM\_secret (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -38,4 +38,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:0ef7c3e2172219fa647d1c447cb82daa7857c6c53a27fd191bff83f59ce6b9f7) +[comment]: # ( SHA256STAMP:5560433bde5292bad74eab0b688d8e6baa0a51562670a4f486d41b4eb2103ca8) diff --git a/doc/lightning-multifundchannel.7.md b/doc/lightning-multifundchannel.7.md index c4a13a38a..489c806fe 100644 --- a/doc/lightning-multifundchannel.7.md +++ b/doc/lightning-multifundchannel.7.md @@ -105,11 +105,11 @@ On success, an object is returned, containing: - **channel\_ids** (array of objects): - **id** (pubkey): The peer we opened the channel with - **outnum** (u32): The 0-based output index showing which output funded the channel - - **channel\_id** (hex): The channel_id of the resulting channel (always 64 characters) - - **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` + - **channel\_id** (hex): The channel\_id of the resulting channel (always 64 characters) + - **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` - **failed** (array of objects, optional): any peers we failed to open with (if *minchannels* was specified less than the number of destinations): - **id** (pubkey): The peer we failed to open the channel with - - **method** (string): What stage we failed at (one of "connect", "openchannel_init", "fundchannel_start", "fundchannel_complete") + - **method** (string): What stage we failed at (one of "connect", "openchannel\_init", "fundchannel\_start", "fundchannel\_complete") - **error** (object): - **code** (integer): JSON error code from failing stage - **message** (string): Message from stage @@ -159,4 +159,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:a507d57bbf36455924497c8354f41e225bc16f63f12fe01b4f7c4af37f0c6960) +[comment]: # ( SHA256STAMP:0dc2b563ed6995f65388a52b01e8882a167ead3c1d3b3dc985486cd8b4dfe157) diff --git a/doc/lightning-multiwithdraw.7.md b/doc/lightning-multiwithdraw.7.md index c090387d7..3a1732799 100644 --- a/doc/lightning-multiwithdraw.7.md +++ b/doc/lightning-multiwithdraw.7.md @@ -72,4 +72,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:6c0054088c17481dedbedb6a5ed4be7f09ce8783780707432907508ebf4bbd7a) +[comment]: # ( SHA256STAMP:632868a585b9150a80ccc4ba173d90a8beebab8e604c06f1ccdc4493604152e3) diff --git a/doc/lightning-newaddr.7.md b/doc/lightning-newaddr.7.md index 1c47a13b4..8c2902c98 100644 --- a/doc/lightning-newaddr.7.md +++ b/doc/lightning-newaddr.7.md @@ -58,4 +58,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:e9650b5f1f4374007c8fde63dae2ac9981c952ed8074aabade39fcc0ebe21333) +[comment]: # ( SHA256STAMP:2178e43f4b90a07f1d31679f86e7e5b1bc5239333ba64652614f03847c869fd4) diff --git a/doc/lightning-notifications.7.md b/doc/lightning-notifications.7.md index 3940d12ab..8443a38d4 100644 --- a/doc/lightning-notifications.7.md +++ b/doc/lightning-notifications.7.md @@ -102,4 +102,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:326e5801f65998e13e909d8b682e9fbc9824f3a43aa7da1d76b871882e52f293) +[comment]: # ( SHA256STAMP:6ab8038cbad395e5a65a52fe66948740ad360c123e42c28d5879f5f03369b744) diff --git a/doc/lightning-offer.7.md b/doc/lightning-offer.7.md index 1626f52d6..ffccb3646 100644 --- a/doc/lightning-offer.7.md +++ b/doc/lightning-offer.7.md @@ -100,7 +100,7 @@ On success, an object is returned, containing: - **offer\_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) - **active** (boolean): whether this can still be used (always *true*) -- **single\_use** (boolean): whether this expires as soon as it's paid (reflects the *single_use* parameter) +- **single\_use** (boolean): whether this expires as soon as it's paid (reflects the *single\_use* parameter) - **bolt12** (string): the bolt12 encoding of the offer - **used** (boolean): True if an associated invoice has been paid - **created** (boolean): false if the offer already existed @@ -135,4 +135,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:217af2aae777229992e2ee07c6f8040d4ca5b75ee2064590584de13162974fe2) +[comment]: # ( SHA256STAMP:a9cd6cc9f41fefc87c060ee979599f55154a11fc3a9b5dca046cea3e9c2385c2) diff --git a/doc/lightning-offerout.7.md b/doc/lightning-offerout.7.md index c09f8fc72..f89dce17d 100644 --- a/doc/lightning-offerout.7.md +++ b/doc/lightning-offerout.7.md @@ -99,4 +99,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:903e40a51c806613da956ce1b4021e9aac964c11d0d0c2714aeb68a12f083265) +[comment]: # ( SHA256STAMP:4f780ca32d486bd715eed86a130b87ff1515fce6f9e225cb13219267b82b33bb) diff --git a/doc/lightning-openchannel_abort.7.md b/doc/lightning-openchannel_abort.7.md index 93a2b5244..197f15049 100644 --- a/doc/lightning-openchannel_abort.7.md +++ b/doc/lightning-openchannel_abort.7.md @@ -55,4 +55,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:ed449af5b443c981faaff360cb2276816bbc7cd80f85fdb4403987c29d65baed) +[comment]: # ( SHA256STAMP:f80423882383e5cb39b86543eb8cfbc0d9b6731ea85af3b3e1fb8973b9355781) diff --git a/doc/lightning-openchannel_bump.7.md b/doc/lightning-openchannel_bump.7.md index a333bf054..c83e79c8c 100644 --- a/doc/lightning-openchannel_bump.7.md +++ b/doc/lightning-openchannel_bump.7.md @@ -41,7 +41,7 @@ On success, an object is returned, containing: - **channel\_id** (hex): the channel id of the channel (always 64 characters) - **psbt** (string): the (incomplete) PSBT of the RBF transaction - **commitments\_secured** (boolean): whether the *psbt* is complete (always *false*) -- **funding\_serial** (u64): the serial_id of the funding output in the *psbt* +- **funding\_serial** (u64): the serial\_id of the funding output in the *psbt* [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -81,4 +81,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:3cba5d1c16925322754eae979e956132e8b94e40da0dee6925037a8854d9b791) +[comment]: # ( SHA256STAMP:fe2bf77f2cb693ee91ab1977d05ba8431b0a8bed67aa1bbda6992bf64604081b) diff --git a/doc/lightning-openchannel_init.7.md b/doc/lightning-openchannel_init.7.md index 585df587b..aa3e9f7fe 100644 --- a/doc/lightning-openchannel_init.7.md +++ b/doc/lightning-openchannel_init.7.md @@ -56,7 +56,7 @@ On success, an object is returned, containing: - **channel\_id** (hex): the channel id of the channel (always 64 characters) - **psbt** (string): the (incomplete) PSBT of the funding transaction - **commitments\_secured** (boolean): whether the *psbt* is complete (always *false*) -- **funding\_serial** (u64): the serial_id of the funding output in the *psbt* +- **funding\_serial** (u64): the serial\_id of the funding output in the *psbt* [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -103,4 +103,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:18421f03dece31aafe32cb1a9b520dd6b898e018cb187de6d666e391232fab4e) +[comment]: # ( SHA256STAMP:ca7708f0c64afc898cb336eafb26ee384895f83b2026aecab75596372d33e46e) diff --git a/doc/lightning-openchannel_signed.7.md b/doc/lightning-openchannel_signed.7.md index ec3b8b304..f201634ba 100644 --- a/doc/lightning-openchannel_signed.7.md +++ b/doc/lightning-openchannel_signed.7.md @@ -67,4 +67,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:41e2a4aed1aaac01675f99e91326197afa370a05e32b2ef20cbbb8247de57289) +[comment]: # ( SHA256STAMP:2ee447b0f9d13ebe8898addc99f52a9024f0e80f67fa505dcc35a3256c3e4c55) diff --git a/doc/lightning-openchannel_update.7.md b/doc/lightning-openchannel_update.7.md index 52a7b75ee..28ea83c84 100644 --- a/doc/lightning-openchannel_update.7.md +++ b/doc/lightning-openchannel_update.7.md @@ -72,4 +72,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:14632f65d4c44b34762d3fa7e0f5b823a519d3dc5fc7a2a69f677000efd937fb) +[comment]: # ( SHA256STAMP:223ec3a444341e4c269eab3c3fbe80f13df9258b5f7a548d9e32698a5d4d6790) diff --git a/doc/lightning-parsefeerate.7.md b/doc/lightning-parsefeerate.7.md index 0a516d1e0..92156eec6 100644 --- a/doc/lightning-parsefeerate.7.md +++ b/doc/lightning-parsefeerate.7.md @@ -19,7 +19,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **perkw** (u32, optional): Value of *feerate_str* in kilosipa +- **perkw** (u32, optional): Value of *feerate\_str* in kilosipa [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -44,4 +44,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:62a45d5091e5bdb4581a2986a66681616315999b8497038864ece8e3308c3f50) +[comment]: # ( SHA256STAMP:e61c7a3d05b16533716be2052d7235829c1fb69896d38e6ad31baf12a3f4cb02) diff --git a/doc/lightning-pay.7.md b/doc/lightning-pay.7.md index d9932b0b3..5c2d53bb3 100644 --- a/doc/lightning-pay.7.md +++ b/doc/lightning-pay.7.md @@ -95,8 +95,8 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **created\_at** (number): the UNIX timestamp showing when this payment was initiated - **parts** (u32): how many attempts this took - **amount\_msat** (msat): Amount the recipient received @@ -167,4 +167,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6f7640af4859e4605f4369a4e17fcfbaead1be53928ad8101cc44fde6f441a97) +[comment]: # ( SHA256STAMP:735dd61146b04745f1e884037ead662a386fec2c41e2de1a8698d6bb03f63540) diff --git a/doc/lightning-ping.7.md b/doc/lightning-ping.7.md index 5ed7c9dc6..6e7dee573 100644 --- a/doc/lightning-ping.7.md +++ b/doc/lightning-ping.7.md @@ -70,4 +70,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:f33aa4d93ca623ff7cd5e4062e0533f617b00372797f8ee0d2498479d2fe08a9) +[comment]: # ( SHA256STAMP:fe8760ada0a86222a74dc1c78ff111325a2247d5ca90683347b8e8f5dee8a867) diff --git a/doc/lightning-plugin.7.md b/doc/lightning-plugin.7.md index 9da161408..a35f959c1 100644 --- a/doc/lightning-plugin.7.md +++ b/doc/lightning-plugin.7.md @@ -84,4 +84,4 @@ RESOURCES Main web site: [writing plugins]: PLUGINS.md -[comment]: # ( SHA256STAMP:3d7e6647d7fb3eab2a8c6361bb0cbe60efbd822f30f31e08cce68e2aa41ba532) +[comment]: # ( SHA256STAMP:5e067df44c38f3ee529cc30ac66050830244d0d9b91d7ad386e3c50aa841b0e9) diff --git a/doc/lightning-reserveinputs.7.md b/doc/lightning-reserveinputs.7.md index 1e7f9a457..74cdf6c52 100644 --- a/doc/lightning-reserveinputs.7.md +++ b/doc/lightning-reserveinputs.7.md @@ -64,4 +64,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:7fd7e24084f7e7da57bccd98cbcf511be56e44e282813c964bdd69d0785dfd22) +[comment]: # ( SHA256STAMP:c3bb624daff32be6701e54505432ee6d33aab6491e3286791331d0b680fee737) diff --git a/doc/lightning-sendcustommsg.7.md b/doc/lightning-sendcustommsg.7.md index cbff52cc2..65c28aef9 100644 --- a/doc/lightning-sendcustommsg.7.md +++ b/doc/lightning-sendcustommsg.7.md @@ -69,4 +69,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:fded86dbe217eacf0c170db87140fd5f10f23c22760ac08b7aa4d2faa4764b3a) +[comment]: # ( SHA256STAMP:2427c75c952bbbd5a3ccf69a217516a73079a014bb656aff3de7038a26cd301b) diff --git a/doc/lightning-sendinvoice.7.md b/doc/lightning-sendinvoice.7.md index 4badc41e8..b95fd9509 100644 --- a/doc/lightning-sendinvoice.7.md +++ b/doc/lightning-sendinvoice.7.md @@ -43,7 +43,7 @@ On success, an object is returned, containing: - **label** (string): unique label supplied at invoice creation - **description** (string): description used in the invoice -- **payment\_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hex): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): Whether it's paid, unpaid or unpayable (one of "unpaid", "paid", "expired") - **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable - **amount\_msat** (msat, optional): the amount required to pay this invoice @@ -52,7 +52,7 @@ On success, an object is returned, containing: If **status** is "paid": - **pay\_index** (u64): Unique incrementing index for this payment - - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay) + - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **paid\_at** (u64): UNIX timestamp of when it was paid - **payment\_preimage** (hex): proof of payment (always 64 characters) @@ -80,4 +80,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:23d06329b3d5d2d21639ecc152b541788bb204188c24a0294f97582401b2b3dc) +[comment]: # ( SHA256STAMP:32b4918787ebd97b7a64cca0fe7d26f259688cbbad93ce89a4dd3e9201d66b78) diff --git a/doc/lightning-sendonion.7.md b/doc/lightning-sendonion.7.md index fdf52a027..0002cf4ed 100644 --- a/doc/lightning-sendonion.7.md +++ b/doc/lightning-sendonion.7.md @@ -94,7 +94,7 @@ RETURN VALUE On success, an object is returned, containing: - **id** (u64): unique ID for this payment attempt -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): status of the payment (could be complete if already sent previously) (one of "pending", "complete") - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **amount\_sent\_msat** (msat): The amount sent @@ -107,7 +107,7 @@ On success, an object is returned, containing: If **status** is "complete": - - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) + - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) If **status** is "pending": @@ -135,4 +135,4 @@ RESOURCES Main web site: [bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md -[comment]: # ( SHA256STAMP:84283d16d289b6f72ffac0fdca6791bb49ac9ec1ef2bbb06028c18453bb15f02) +[comment]: # ( SHA256STAMP:d01679d11406d49930e69a7492550a36118950b0d93acca5c26b299fc91680a4) diff --git a/doc/lightning-sendonionmessage.7.md b/doc/lightning-sendonionmessage.7.md index 05d2c6fd1..1e50eceac 100644 --- a/doc/lightning-sendonionmessage.7.md +++ b/doc/lightning-sendonionmessage.7.md @@ -43,4 +43,4 @@ Main web site: [bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md -[comment]: # ( SHA256STAMP:200de829c6635242cb2dd8ec0650c2fa8f5fcbf413f4a704884516df80492fcb) +[comment]: # ( SHA256STAMP:4aff9673290966c7b09e65672da5dc8ef4d2601d3d1681009b329a4f8ceb9af6) diff --git a/doc/lightning-sendpay.7.md b/doc/lightning-sendpay.7.md index 9e6dfb161..1ffb22f96 100644 --- a/doc/lightning-sendpay.7.md +++ b/doc/lightning-sendpay.7.md @@ -69,11 +69,11 @@ RETURN VALUE On success, an object is returned, containing: - **id** (u64): unique ID for this payment attempt -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): status of the payment (could be complete if already sent previously) (one of "pending", "complete") - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **amount\_sent\_msat** (msat): The amount sent -- **groupid** (u64, optional): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash +- **groupid** (u64, optional): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash - **amount\_msat** (msat, optional): The amount delivered to destination (if known) - **destination** (pubkey, optional): the final destination of the payment if known - **completed\_at** (u64, optional): the UNIX timestamp showing when this payment was completed @@ -84,7 +84,7 @@ On success, an object is returned, containing: If **status** is "complete": - - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) + - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) If **status** is "pending": @@ -143,4 +143,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c129f537b1af8a5dc767a25a72be419634cb21ebc26a9e6b9bb091db8db7e6ca) +[comment]: # ( SHA256STAMP:b7f1a5efd80156722e5f9cca6f291306fcd22ab7b9b2754beac880f2ae5a7418) diff --git a/doc/lightning-sendpsbt.7.md b/doc/lightning-sendpsbt.7.md index 2829e58f9..b2150cc98 100644 --- a/doc/lightning-sendpsbt.7.md +++ b/doc/lightning-sendpsbt.7.md @@ -66,4 +66,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:6c0054088c17481dedbedb6a5ed4be7f09ce8783780707432907508ebf4bbd7a) +[comment]: # ( SHA256STAMP:632868a585b9150a80ccc4ba173d90a8beebab8e604c06f1ccdc4493604152e3) diff --git a/doc/lightning-setchannel.7.md b/doc/lightning-setchannel.7.md index 0df477cc1..87b01106e 100644 --- a/doc/lightning-setchannel.7.md +++ b/doc/lightning-setchannel.7.md @@ -68,13 +68,13 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **channels** is returned. It is an array of objects, where each object contains: -- **peer\_id** (pubkey): The node_id of the peer -- **channel\_id** (hex): The channel_id of the channel (always 64 characters) +- **peer\_id** (pubkey): The node\_id of the peer +- **channel\_id** (hex): The channel\_id of the channel (always 64 characters) - **fee\_base\_msat** (msat): The resulting feebase (this is the BOLT #7 name) - **fee\_proportional\_millionths** (u32): The resulting feeppm (this is the BOLT #7 name) -- **minimum\_htlc\_out\_msat** (msat): The resulting htlcmin we will advertize (the BOLT #7 name is htlc_minimum_msat) -- **maximum\_htlc\_out\_msat** (msat): The resulting htlcmax we will advertize (the BOLT #7 name is htlc_maximum_msat) -- **short\_channel\_id** (short\_channel\_id, optional): the short_channel_id (if locked in) +- **minimum\_htlc\_out\_msat** (msat): The resulting htlcmin we will advertize (the BOLT #7 name is htlc\_minimum\_msat) +- **maximum\_htlc\_out\_msat** (msat): The resulting htlcmax we will advertize (the BOLT #7 name is htlc\_maximum\_msat) +- **short\_channel\_id** (short\_channel\_id, optional): the short\_channel\_id (if locked in) - the following warnings are possible: - **warning\_htlcmin\_too\_low**: The requested htlcmin was too low for this peer, so we set it to the minimum they will allow - **warning\_htlcmax\_too\_high**: The requested htlcmax was greater than the channel capacity, so we set it to the channel capacity @@ -107,4 +107,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:0f7cd751f329360a8cd957dfc8ea0b7d579aa05f4de4f8577039e50266a04f30) +[comment]: # ( SHA256STAMP:31300838ff4b12d9bf43879c91a5d51af76f70ebe8527a35ba476801424c3e65) diff --git a/doc/lightning-setchannelfee.7.md b/doc/lightning-setchannelfee.7.md index 52a6f5c63..e6d290a8c 100644 --- a/doc/lightning-setchannelfee.7.md +++ b/doc/lightning-setchannelfee.7.md @@ -49,12 +49,12 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **base** (u32): The fee_base_msat value -- **ppm** (u32): The fee_proportional_millionths value +- **base** (u32): The fee\_base\_msat value +- **ppm** (u32): The fee\_proportional\_millionths value - **channels** (array of objects): channel(s) whose rate is now set: - - **peer\_id** (pubkey): The node_id of the peer - - **channel\_id** (hex): The channel_id of the channel (always 64 characters) - - **short\_channel\_id** (short\_channel\_id, optional): the short_channel_id (if locked in) + - **peer\_id** (pubkey): The node\_id of the peer + - **channel\_id** (hex): The channel\_id of the channel (always 64 characters) + - **short\_channel\_id** (short\_channel\_id, optional): the short\_channel\_id (if locked in) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -83,4 +83,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:a7f079e9a25ee5f4c3d8bf3ed2c61d2f807eae99e6bfe02b0737a9692aca503b) +[comment]: # ( SHA256STAMP:f4de7a0b01820a22b9b8f20e2cce249d3b0d2be10346e745e1066b101a37df3d) diff --git a/doc/lightning-signmessage.7.md b/doc/lightning-signmessage.7.md index 71f829016..b9cc39ad9 100644 --- a/doc/lightning-signmessage.7.md +++ b/doc/lightning-signmessage.7.md @@ -42,4 +42,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6ff35aee05f86de2c44be50a156afc1e325183d8c9333bff68114c8d846a75e6) +[comment]: # ( SHA256STAMP:ac618ebda6ab3acac85729f7b3e5607ccdcc78c75e40129ced84ae02e321f5c3) diff --git a/doc/lightning-signpsbt.7.md b/doc/lightning-signpsbt.7.md index 2effa067c..b5bfab9fe 100644 --- a/doc/lightning-signpsbt.7.md +++ b/doc/lightning-signpsbt.7.md @@ -72,4 +72,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:0daef100b12490126849fcb93a9e861554807d1a5acf68bc17de92a30505e18a) +[comment]: # ( SHA256STAMP:655ef649bd68e29da6026cacf3d6f7399c5d9b2ac153c53e66cda9ece3fd761f) diff --git a/doc/lightning-stop.7.md b/doc/lightning-stop.7.md index fb6c3c911..e8f2c6494 100644 --- a/doc/lightning-stop.7.md +++ b/doc/lightning-stop.7.md @@ -42,4 +42,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:2103952683449a5aa313eefa9c850dc0ae1cf4aa65edeb7897a8748a010a9349) +[comment]: # ( SHA256STAMP:3ad64970d67b1084b6f33bb690ba1dd3744292a60b3efe8a845f88a0ebc61450) diff --git a/doc/lightning-txdiscard.7.md b/doc/lightning-txdiscard.7.md index 22d5292a3..722532bd4 100644 --- a/doc/lightning-txdiscard.7.md +++ b/doc/lightning-txdiscard.7.md @@ -19,7 +19,7 @@ RETURN VALUE On success, an object is returned, containing: - **unsigned\_tx** (hex): the unsigned transaction -- **txid** (txid): the transaction id of *unsigned_tx* +- **txid** (txid): the transaction id of *unsigned\_tx* [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -45,4 +45,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:f52ad03cccaea672deefada22f0a11acff9d0c4f98ccfedca12759eaa6bac057) +[comment]: # ( SHA256STAMP:3b3b5c8e6bc2f30080053f93cc7db3dfc39bef118354ebfc2ed62e621329afc4) diff --git a/doc/lightning-txprepare.7.md b/doc/lightning-txprepare.7.md index e885f8daf..427f42aa3 100644 --- a/doc/lightning-txprepare.7.md +++ b/doc/lightning-txprepare.7.md @@ -57,7 +57,7 @@ On success, an object is returned, containing: - **psbt** (string): the PSBT representing the unsigned transaction - **unsigned\_tx** (hex): the unsigned transaction -- **txid** (txid): the transaction id of *unsigned_tx*; you hand this to lightning-txsend(7) or lightning-txdiscard(7), as the inputs of this transaction are reserved. +- **txid** (txid): the transaction id of *unsigned\_tx*; you hand this to lightning-txsend(7) or lightning-txdiscard(7), as the inputs of this transaction are reserved. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -85,4 +85,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c13561bf71189143811cd4bd49db69c163b8443f1660931671eb1e95e0a7e3ff) +[comment]: # ( SHA256STAMP:200dbb8ac175dbb5321e699cfa78dd319a96ceef0d61a7569415544503562d52) diff --git a/doc/lightning-txsend.7.md b/doc/lightning-txsend.7.md index abba2b31d..f67f9aede 100644 --- a/doc/lightning-txsend.7.md +++ b/doc/lightning-txsend.7.md @@ -45,4 +45,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:dcb4d5f03b44bf3bc6852f97f56c0ac7d34505df71f042ed86a0daf4927dcaff) +[comment]: # ( SHA256STAMP:db5c1f15e439f7784dcb759d444cf4f0844aa8093c6af2252e5989e1b75f0523) diff --git a/doc/lightning-unreserveinputs.7.md b/doc/lightning-unreserveinputs.7.md index 93f4fe078..c6256e757 100644 --- a/doc/lightning-unreserveinputs.7.md +++ b/doc/lightning-unreserveinputs.7.md @@ -55,4 +55,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:41e0fba4aea57e12d91366a55663e7331e952b223eeb8fc9f83deb5a948f63b4) +[comment]: # ( SHA256STAMP:4560823ed1adae2127b71b599cdaae1539bd5c87c03ecf593beed5813bb68511) diff --git a/doc/lightning-utxopsbt.7.md b/doc/lightning-utxopsbt.7.md index 0d1b8aab0..b6abc1219 100644 --- a/doc/lightning-utxopsbt.7.md +++ b/doc/lightning-utxopsbt.7.md @@ -49,8 +49,8 @@ On success, an object is returned, containing: - **psbt** (string): Unsigned PSBT which fulfills the parameters given - **feerate\_per\_kw** (u32): The feerate used to create the PSBT, in satoshis-per-kiloweight - **estimated\_final\_weight** (u32): The estimated weight of the transaction once fully signed -- **excess\_msat** (msat): The amount above *satoshi* which is available. This could be zero, or dust; it will be zero if *change_outnum* is also returned -- **change\_outnum** (u32, optional): The 0-based output number where change was placed (only if parameter *excess_as_change* was true and there was sufficient funds) +- **excess\_msat** (msat): The amount above *satoshi* which is available. This could be zero, or dust; it will be zero if *change\_outnum* is also returned +- **change\_outnum** (u32, optional): The 0-based output number where change was placed (only if parameter *excess\_as\_change* was true and there was sufficient funds) - **reservations** (array of objects, optional): If *reserve* was true or a non-zero number, just as per lightning-reserveinputs(7): - **txid** (txid): The txid of the transaction - **vout** (u32): The 0-based output number @@ -100,4 +100,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c2c513b40099c9cd2ef7bda1c430fdff055499b67ef2ff9edf7772ea4d87fb2d) +[comment]: # ( SHA256STAMP:237c832f7a7c1ea2567192b7432f4ea7fe79e553c9c531acf5be733b92095464) diff --git a/doc/lightning-waitanyinvoice.7.md b/doc/lightning-waitanyinvoice.7.md index a2f3c8f9d..670b72960 100644 --- a/doc/lightning-waitanyinvoice.7.md +++ b/doc/lightning-waitanyinvoice.7.md @@ -38,7 +38,7 @@ On success, an object is returned, containing: - **label** (string): unique label supplied at invoice creation - **description** (string): description used in the invoice -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): Whether it's paid or expired (one of "paid", "expired") - **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable - **amount\_msat** (msat, optional): the amount required to pay this invoice @@ -48,7 +48,7 @@ On success, an object is returned, containing: If **status** is "paid": - **pay\_index** (u64): Unique incrementing index for this payment - - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay) + - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **paid\_at** (u64): UNIX timestamp of when it was paid - **payment\_preimage** (secret): proof of payment (always 64 characters) @@ -75,4 +75,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:2b0c9e70bb03f5cf9999731fdf5b8bcd761ea70ef6fc04575a1c2451174ea769) +[comment]: # ( SHA256STAMP:bd853f0a27258e0e3780c0dd6cdd8fca7ba8d95a00d247704ed3f3f55c2f086e) diff --git a/doc/lightning-waitblockheight.7.md b/doc/lightning-waitblockheight.7.md index 801bfb8d3..7b84b715b 100644 --- a/doc/lightning-waitblockheight.7.md +++ b/doc/lightning-waitblockheight.7.md @@ -39,4 +39,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:e84e2ddf33c5abafe434ad0dcd76a3c1e6e2a2bdbba5dcf786f2a2ed80e61061) +[comment]: # ( SHA256STAMP:b7986f9829dd7616ac4236c175b9d7011c27de19dd4fb50138b5957c59678177) diff --git a/doc/lightning-waitinvoice.7.md b/doc/lightning-waitinvoice.7.md index 6000f5063..7980f4be0 100644 --- a/doc/lightning-waitinvoice.7.md +++ b/doc/lightning-waitinvoice.7.md @@ -20,7 +20,7 @@ On success, an object is returned, containing: - **label** (string): unique label supplied at invoice creation - **description** (string): description used in the invoice -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): Whether it's paid or expired (one of "paid", "expired") - **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable - **amount\_msat** (msat, optional): the amount required to pay this invoice @@ -30,7 +30,7 @@ On success, an object is returned, containing: If **status** is "paid": - **pay\_index** (u64): Unique incrementing index for this payment - - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay) + - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **paid\_at** (u64): UNIX timestamp of when it was paid - **payment\_preimage** (secret): proof of payment (always 64 characters) @@ -60,4 +60,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:2b0c9e70bb03f5cf9999731fdf5b8bcd761ea70ef6fc04575a1c2451174ea769) +[comment]: # ( SHA256STAMP:bd853f0a27258e0e3780c0dd6cdd8fca7ba8d95a00d247704ed3f3f55c2f086e) diff --git a/doc/lightning-waitsendpay.7.md b/doc/lightning-waitsendpay.7.md index 8144833a6..a7035d671 100644 --- a/doc/lightning-waitsendpay.7.md +++ b/doc/lightning-waitsendpay.7.md @@ -36,11 +36,11 @@ RETURN VALUE On success, an object is returned, containing: - **id** (u64): unique ID for this payment attempt -- **payment\_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters) +- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **status** (string): status of the payment (always "complete") - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **amount\_sent\_msat** (msat): The amount sent -- **groupid** (u64, optional): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash +- **groupid** (u64, optional): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash - **amount\_msat** (msat, optional): The amount delivered to destination (if known) - **destination** (pubkey, optional): the final destination of the payment if known - **completed\_at** (number, optional): the UNIX timestamp showing when this payment was completed @@ -51,7 +51,7 @@ On success, an object is returned, containing: If **status** is "complete": - - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters) + - **payment\_preimage** (secret): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -104,4 +104,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:f4dbe3ecc88a294f7bb983a2f2b8e9613e440e4564580e51dd30fc83ba218a91) +[comment]: # ( SHA256STAMP:5c783babcd7a98ef4f1bd676f7aa36c3441d52414dcd1038183d9c4445ddcf7d) diff --git a/doc/lightning-withdraw.7.md b/doc/lightning-withdraw.7.md index 6a52452e7..533c6934a 100644 --- a/doc/lightning-withdraw.7.md +++ b/doc/lightning-withdraw.7.md @@ -74,4 +74,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:fcfd3c91a3cee9bbd36e86edccb5d6407b19c2beda7de1f51ebba5fbd1c2340a) +[comment]: # ( SHA256STAMP:7ec01e1903d75e2a8694c50d051c40fcbdb8a8001943c79748ca8fd41d5d59b1) diff --git a/tools/fromschema.py b/tools/fromschema.py index e6c4b9c6d..5fc76d4d9 100755 --- a/tools/fromschema.py +++ b/tools/fromschema.py @@ -4,6 +4,12 @@ # https://creativecommons.org/publicdomain/zero/1.0/ from argparse import ArgumentParser import json +import re + + +def esc_underscores(s): + """Backslash-escape underscores outside of backtick-enclosed spans""" + return ''.join(['\\_' if x == '_' else x for x in re.findall(r'[^`_\\]+|`(?:[^`\\]|\\.)*`|\\.|_', s)]) def json_value(obj): @@ -13,7 +19,7 @@ def json_value(obj): return '*true*' return '*false*' if type(obj) is str: - return '"' + obj + '"' + return '"' + esc_underscores(obj) + '"' if obj is None: return '*null*' assert False @@ -30,9 +36,9 @@ def output(line): def output_type(properties, is_optional): - typename = properties['type'].replace('_', '\\_') + typename = esc_underscores(properties['type']) if typename == 'array': - typename += ' of {}s'.format(properties['items']['type'].replace('_', '\\_')) + typename += ' of {}s'.format(esc_underscores(properties['items']['type'])) if is_optional: typename += ", optional" output(" ({})".format(typename)) @@ -67,7 +73,7 @@ def output_range(properties): def fmt_propname(propname): """Pretty-print format a property name""" - return '**{}**'.format(propname.replace('_', '\\_')) + return '**{}**'.format(esc_underscores(propname)) def output_member(propname, properties, is_optional, indent, print_type=True, prefix=None): @@ -84,7 +90,7 @@ def output_member(propname, properties, is_optional, indent, print_type=True, pr output_type(properties, is_optional) if 'description' in properties: - output(": {}".format(properties['description'])) + output(": {}".format(esc_underscores(properties['description']))) output_range(properties) @@ -103,10 +109,10 @@ def output_array(items, indent): if items['type'] == 'object': output_members(items, indent) elif items['type'] == 'array': - output(indent + '- {}:\n'.format(items['description'])) + output(indent + '- {}:\n'.format(esc_underscores(items['description']))) output_array(items['items'], indent + ' ') else: - output(indent + '- {}'.format(items['description'])) + output(indent + '- {}'.format(esc_underscores(items['description']))) output_range(items) output('\n')