diff --git a/doc/lightning-addgossip.7.md b/doc/lightning-addgossip.7.md index 44620dde0..97bcc008f 100644 --- a/doc/lightning-addgossip.7.md +++ b/doc/lightning-addgossip.7.md @@ -42,4 +42,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:bdc678495e0e0e626cdc71e73e8179dc8350de9862c4458933607fa62d8a16f7) +[comment]: # ( SHA256STAMP:4d9f888d10faca2bf94d1b52510cf21fbeebae4efda0946f03d04b0ef4bc88a2) diff --git a/doc/lightning-autocleaninvoice.7.md b/doc/lightning-autocleaninvoice.7.md index 241026c79..f3d2dfe33 100644 --- a/doc/lightning-autocleaninvoice.7.md +++ b/doc/lightning-autocleaninvoice.7.md @@ -32,8 +32,8 @@ On success, an object is returned, containing: If **enabled** is *true*: - - **expired_by** (u64): how long an invoice must be expired (seconds) before we delete it - - **cycle_seconds** (u64): how long an invoice must be expired (seconds) before we delete it + - **expired\_by** (u64): how long an invoice must be expired (seconds) before we delete it + - **cycle\_seconds** (u64): how long an invoice must be expired (seconds) before we delete it [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -52,4 +52,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:43767e7e2dde51d1d5a250d3ffac510cf53305f11d9984a9f37ceb6b28c386ea) +[comment]: # ( SHA256STAMP:06bb1ef610c0f82d3d370f468575f2d6e837a11473acd1267baab829aa505052) diff --git a/doc/lightning-bkpr-channelsapy.7.md b/doc/lightning-bkpr-channelsapy.7.md index 5be11265e..4a4b8a10f 100644 --- a/doc/lightning-bkpr-channelsapy.7.md +++ b/doc/lightning-bkpr-channelsapy.7.md @@ -21,30 +21,30 @@ 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: +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 -- **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) -- **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 -- **utilization_in** (string): Sats routed inbound / total start balance -- **apy_out** (string): Fees earned on outbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY) -- **apy_in** (string): Fees earned on inbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY) -- **apy_total** (string): Total fees earned on routed payments / total start balance for the length of time this channel has been open amortized to a year (APY) -- **fees_in_msat** (msat, optional): Fees earned on routed inbound -- **utilization_out_initial** (string, optional): Sats routed outbound / our start balance -- **utilization_in_initial** (string, optional): Sats routed inbound / our start balance -- **apy_out_initial** (string, optional): Fees earned on outbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY) -- **apy_in_initial** (string, optional): Fees earned on inbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY) -- **apy_total_initial** (string, optional): Total fees earned on routed payments / our start balance for the length of time this channel has been open amortized to a year (APY) -- **apy_lease** (string, optional): Lease fees earned over total amount leased for the lease term, amortized to a year (APY). Only appears if channel was leased out by us +- **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) +- **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 +- **utilization\_in** (string): Sats routed inbound / total start balance +- **apy\_out** (string): Fees earned on outbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY) +- **apy\_in** (string): Fees earned on inbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY) +- **apy\_total** (string): Total fees earned on routed payments / total start balance for the length of time this channel has been open amortized to a year (APY) +- **fees\_in\_msat** (msat, optional): Fees earned on routed inbound +- **utilization\_out\_initial** (string, optional): Sats routed outbound / our start balance +- **utilization\_in\_initial** (string, optional): Sats routed inbound / our start balance +- **apy\_out\_initial** (string, optional): Fees earned on outbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY) +- **apy\_in\_initial** (string, optional): Fees earned on inbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY) +- **apy\_total\_initial** (string, optional): Total fees earned on routed payments / our start balance for the length of time this channel has been open amortized to a year (APY) +- **apy\_lease** (string, optional): Lease fees earned over total amount leased for the lease term, amortized to a year (APY). Only appears if channel was leased out by us [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -65,4 +65,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c86f82cd78e639f70e640c4d36e0a28a5087a74c931207501d9121049ff9b5d2) +[comment]: # ( SHA256STAMP:296069892023c371e26305e8ab54d04a50aefeeff37a8a465d07893a8c39e61c) diff --git a/doc/lightning-bkpr-dumpincomecsv.7.md b/doc/lightning-bkpr-dumpincomecsv.7.md index 42967be30..20980fd26 100644 --- a/doc/lightning-bkpr-dumpincomecsv.7.md +++ b/doc/lightning-bkpr-dumpincomecsv.7.md @@ -35,8 +35,8 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **csv_file** (string): File that the csv was generated to -- **csv_format** (string): Format to print csv as (one of "cointracker", "koinly", "harmony", "quickbooks") +- **csv\_file** (string): File that the csv was generated to +- **csv\_format** (string): Format to print csv as (one of "cointracker", "koinly", "harmony", "quickbooks") [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -57,4 +57,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:13920567775dacf15991bc281ccac0bf3f80599e87c3df9e73ca4564445ed6eb) +[comment]: # ( SHA256STAMP:4d9326acde55e8124ea61a7e2430f035d3a4957995a76ddef61ecb2a3debd042) diff --git a/doc/lightning-bkpr-inspect.7.md b/doc/lightning-bkpr-inspect.7.md index 865d31484..faa45103c 100644 --- a/doc/lightning-bkpr-inspect.7.md +++ b/doc/lightning-bkpr-inspect.7.md @@ -20,19 +20,19 @@ RETURN VALUE On success, an object containing **txs** is returned. It is an array of objects, where each object contains: - **txid** (txid): transaction id -- **fees_paid_msat** (msat): Amount paid in sats for this tx +- **fees\_paid\_msat** (msat): Amount paid in sats for this tx - **outputs** (array of objects): - **account** (string): Account this output affected - **outnum** (u32): Index of output - - **output_value_msat** (msat): Value of the output + - **output\_value\_msat** (msat): Value of the output - **currency** (string): human-readable bech32 part for this coin type - - **credit_msat** (msat, optional): Amount credited to account - - **debit_msat** (msat, optional): Amount debited from account - - **originating_account** (string, optional): Account this output originated from - - **output_tag** (string, optional): Description of output creation event - - **spend_tag** (string, optional): Description of output spend event - - **spending_txid** (txid, optional): Transaction this output was spent in - - **payment_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. + - **credit\_msat** (msat, optional): Amount credited to account + - **debit\_msat** (msat, optional): Amount debited from account + - **originating\_account** (string, optional): Account this output originated from + - **output\_tag** (string, optional): Description of output creation event + - **spend\_tag** (string, optional): Description of output spend event + - **spending\_txid** (txid, optional): Transaction this output was spent in + - **payment\_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. - **blockheight** (u32, optional): Blockheight of transaction [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -52,4 +52,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:a89c90315d210fcf1fd45bf4edef04a72165834867f860447e33d89840eac59f) +[comment]: # ( SHA256STAMP:022a11cd4bdaec7b1b39e30faaf5489de1db08684a3952b3a3152343e91c8c4c) diff --git a/doc/lightning-bkpr-listaccountevents.7.md b/doc/lightning-bkpr-listaccountevents.7.md index 113d3d4c1..aede7dccd 100644 --- a/doc/lightning-bkpr-listaccountevents.7.md +++ b/doc/lightning-bkpr-listaccountevents.7.md @@ -28,8 +28,8 @@ On success, an object containing **events** is returned. It is an array of obje - **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 +- **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 @@ -38,7 +38,7 @@ If **type** is "chain": - **outpoint** (string): The txid:outnum for this event - **blockheight** (u32): For chain events, blockheight this occured at - **origin** (string, optional): The account this movement originated from - - **payment_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. + - **payment\_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. - **txid** (txid, optional): The txid of the transaction that created this event - **description** (string, optional): The description of this event @@ -48,10 +48,10 @@ If **type** is "onchain_fee": If **type** is "channel": - - **fees_msat** (msat, optional): Amount paid in fees - - **is_rebalance** (boolean, optional): Is this payment part of a rebalance - - **payment_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. - - **part_id** (u32, optional): Counter for multi-part payments + - **fees\_msat** (msat, optional): Amount paid in fees + - **is\_rebalance** (boolean, optional): Is this payment part of a rebalance + - **payment\_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. + - **part\_id** (u32, optional): Counter for multi-part payments [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -71,4 +71,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:50051a63881ea83154a36bbdccaf3915601574ed193ade6a5522260c85fa941c) +[comment]: # ( SHA256STAMP:3b120f28969d50351823707c11f77a0264031b1ddec07794ac117b0e8e2d7a75) diff --git a/doc/lightning-bkpr-listbalances.7.md b/doc/lightning-bkpr-listbalances.7.md index c0e4977cc..a98b3780c 100644 --- a/doc/lightning-bkpr-listbalances.7.md +++ b/doc/lightning-bkpr-listbalances.7.md @@ -23,16 +23,16 @@ On success, an object containing **accounts** is returned. It is an array of ob - **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 + - **balance\_msat** (msat): Current account balance + - **coin\_type** (string): coin type, same as HRP for bech32 -If **peer_id** is present: +If **peer\_id** is present: - - **peer_id** (pubkey): Node id for the peer this account is with - - **we_opened** (boolean): Did we initiate this account open (open the channel) - - **account_closed** (boolean): - - **account_resolved** (boolean): Has this channel been closed and all outputs resolved? - - **resolved_at_block** (u32, optional): Blockheight account resolved on chain + - **peer\_id** (pubkey): Node id for the peer this account is with + - **we\_opened** (boolean): Did we initiate this account open (open the channel) + - **account\_closed** (boolean): + - **account\_resolved** (boolean): Has this channel been closed and all outputs resolved? + - **resolved\_at\_block** (u32, optional): Blockheight account resolved on chain [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -53,4 +53,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:42302ecee2bab01fca04477e5b4d793f11757e0b7a2f43c6878ff8ecf857cc34) +[comment]: # ( SHA256STAMP:ae354f9ee2c0f3805923c7c1fbbf490d43c838449fe25758a6884c2f1686d20e) diff --git a/doc/lightning-bkpr-listincome.7.md b/doc/lightning-bkpr-listincome.7.md index d35db63ae..d18a784eb 100644 --- a/doc/lightning-bkpr-listincome.7.md +++ b/doc/lightning-bkpr-listincome.7.md @@ -26,18 +26,18 @@ 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: +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 - **tag** (string): Type of income event -- **credit_msat** (msat): Amount earned (income) -- **debit_msat** (msat): Amount spent (expenses) +- **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 - **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 -- **payment_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. +- **payment\_id** (hex, optional): lightning payment identifier. For an htlc, this will be the preimage. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -57,4 +57,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:67cedc19eeb5d684cda2efd025e42d1d89fd1d899d8b66ac0d9b663139cc3517) +[comment]: # ( SHA256STAMP:23bcaf41a3451f716cbeedc992c84b88a823d3aa219fd848e3c6c47ae9bbca55) diff --git a/doc/lightning-check.7.md b/doc/lightning-check.7.md index cd5fc4a0f..d4fa3f167 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:74e2865a8316ad266499fc9a0ce2aa7ce9794da90d7039f91150c0560df901f1) +[comment]: # ( SHA256STAMP:bd1993b3b95a6c1a9e21873632a829514eb4e9d00ad5084bb099798c8977de06) diff --git a/doc/lightning-checkmessage.7.md b/doc/lightning-checkmessage.7.md index c0058e557..853cedec6 100644 --- a/doc/lightning-checkmessage.7.md +++ b/doc/lightning-checkmessage.7.md @@ -50,4 +50,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:aa3f01d9f9c1fa61f8b4fc850c3a982e3ea57abcb33338ad36930bb5c70124ce) +[comment]: # ( SHA256STAMP:9642945217c12b5ce41af5aef0547a42b6db5baa97ed88e6fde91345bb9a75f3) diff --git a/doc/lightning-close.7.md b/doc/lightning-close.7.md index 61a33083f..349f6a73b 100644 --- a/doc/lightning-close.7.md +++ b/doc/lightning-close.7.md @@ -135,4 +135,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:54eec92e876d0e05041f708cd8453a16cc1a178df8c966620f8bf6536ba6e36d) +[comment]: # ( SHA256STAMP:89f0bd65ba94f07afaddac259a766d89e26a9acf646c0491c869d923db3091eb) diff --git a/doc/lightning-commando-rune.7.md b/doc/lightning-commando-rune.7.md index 1304a715a..5708f883c 100644 --- a/doc/lightning-commando-rune.7.md +++ b/doc/lightning-commando-rune.7.md @@ -192,11 +192,11 @@ RETURN VALUE On success, an object is returned, containing: - **rune** (string): the resulting rune -- **unique_id** (string): the id of this rune: this is set at creation and cannot be changed (even as restrictions are added) +- **unique\_id** (string): the id of this rune: this is set at creation and cannot be changed (even as restrictions are added) The following warnings may also be returned: -- **warning_unrestricted_rune**: A warning shown when runes are created with powers that could drain your node +- **warning\_unrestricted\_rune**: A warning shown when runes are created with powers that could drain your node [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -219,4 +219,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:b9cf90aabe3e87fb41bc1da93d9efd3e6dc629be487f65fb815bed3bad4adb0b) +[comment]: # ( SHA256STAMP:843aaf64ccded63baf949f0103dd0f18b9652f259f1d35e0fd67f45ee58c4e8f) diff --git a/doc/lightning-connect.7.md b/doc/lightning-connect.7.md index 345d5c99b..ae5b2fa51 100644 --- a/doc/lightning-connect.7.md +++ b/doc/lightning-connect.7.md @@ -104,4 +104,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:98dfa22262e5192ef0fa14b0a9ede95f932a6f0966f847bdfd87b1d1a1b37789) +[comment]: # ( SHA256STAMP:27f1e0ad88e7908bbb450ffc1ba5c53855225adf126155cd62ddbd61a599c3ea) diff --git a/doc/lightning-createinvoice.7.md b/doc/lightning-createinvoice.7.md index abb6c9251..b8130b3f8 100644 --- a/doc/lightning-createinvoice.7.md +++ b/doc/lightning-createinvoice.7.md @@ -34,19 +34,19 @@ 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) +- **expires\_at** (u64): UNIX timestamp of when invoice expires (or expired) - **bolt11** (string, optional): the bolt11 string (always present unless **bolt12** is) - **bolt12** (string, optional): the bolt12 string instead of **bolt11** (**experimental-offers** only) -- **amount_msat** (msat, optional): The amount of the invoice (if it has one) -- **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) -- **local_offer_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters) -- **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice (**experimental-offers** only). +- **amount\_msat** (msat, optional): The amount of the invoice (if it has one) +- **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) +- **local\_offer\_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters) +- **payer\_note** (string, optional): the optional *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:56c128b40e64b4433487be292f99e4f68576e80466cc4a5b544572465901bb64) +[comment]: # ( SHA256STAMP:1d552c5038b6062cd384b7f143ad139ab5275a2b44be09e6d51d7111109caca2) diff --git a/doc/lightning-createonion.7.md b/doc/lightning-createonion.7.md index e8f136ba4..9e6768eab 100644 --- a/doc/lightning-createonion.7.md +++ b/doc/lightning-createonion.7.md @@ -93,7 +93,7 @@ RETURN VALUE On success, an object is returned, containing: - **onion** (hex): the onion packet (*onion_size* bytes) -- **shared_secrets** (array of secrets): one shared secret for each node in the *hops* parameter: +- **shared\_secrets** (array of secrets): one shared secret for each node in the *hops* parameter: - the shared secret with this hop (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -133,4 +133,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:9c19a1960c2d7db91b312ab7e738395e36260130e093a576c1c79dba40d25b59) +[comment]: # ( SHA256STAMP:719bc9feedb006638b14f3e6cd01aba479620f771868d8d954b34166224f1c8f) diff --git a/doc/lightning-datastore.7.md b/doc/lightning-datastore.7.md index 796abce1e..7313b5925 100644 --- a/doc/lightning-datastore.7.md +++ b/doc/lightning-datastore.7.md @@ -66,4 +66,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:3319dbcf6a05a45cb0a28fddb27050ddd7139c8ed1537c8204e8c722b5acd65e) +[comment]: # ( SHA256STAMP:f3f48ed1c5c5ccab128c4ce782b2f209896fe0ca6440e00799935dff9bef3f2e) diff --git a/doc/lightning-decode.7.md b/doc/lightning-decode.7.md index ad2b21006..8a642cebb 100644 --- a/doc/lightning-decode.7.md +++ b/doc/lightning-decode.7.md @@ -29,133 +29,133 @@ On success, an object is returned, containing: If **type** is "bolt12 offer", and **valid** is *true*: - - **offer_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) - - **node_id** (point32): x-only public key of the offering node + - **offer\_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) + - **node\_id** (point32): x-only public key of the offering node - **description** (string): the description of the purpose of the offer - **signature** (bip340sig, optional): BIP-340 signature of the *node_id* on this offer - **chains** (array of hexs, optional): which blockchains this offer is for (missing implies bitcoin mainnet only): - the genesis blockhash (always 64 characters) - **currency** (string, optional): ISO 4217 code of the currency (missing implies Bitcoin) (always 3 characters) - - **minor_unit** (u32, optional): the number of decimal places to apply to amount (if currency known) + - **minor\_unit** (u32, optional): the number of decimal places to apply to amount (if currency known) - **amount** (u64, optional): the amount in the *currency* adjusted by *minor_unit*, if any - - **amount_msat** (msat, optional): the amount in bitcoin (if specified, and no *currency*) - - **send_invoice** (boolean, optional): present if this is a send_invoice offer (always *true*) - - **refund_for** (hex, optional): the *payment_preimage* of invoice this is a refund for (always 64 characters) + - **amount\_msat** (msat, optional): the amount in bitcoin (if specified, and no *currency*) + - **send\_invoice** (boolean, optional): present if this is a send_invoice offer (always *true*) + - **refund\_for** (hex, optional): the *payment_preimage* of invoice this is a refund for (always 64 characters) - **vendor** (string, optional): the name of the vendor for this offer - **features** (hex, optional): the array of feature bits for this offer - - **absolute_expiry** (u64, optional): UNIX timestamp of when this offer expires + - **absolute\_expiry** (u64, optional): UNIX timestamp of when this offer expires - **paths** (array of objects, optional): Paths to the destination: - **blinding** (pubkey): blinding factor for this path - **path** (array of objects): an individual path: - - **node_id** (pubkey): node_id of the hop - - **encrypted_recipient_data** (hex): encrypted TLV entry for this hop - - **quantity_min** (u64, optional): the minimum quantity - - **quantity_max** (u64, optional): the maximum quantity + - **node\_id** (pubkey): node_id of the hop + - **encrypted\_recipient\_data** (hex): encrypted TLV entry for this hop + - **quantity\_min** (u64, optional): the minimum quantity + - **quantity\_max** (u64, optional): the maximum quantity - **recurrence** (object, optional): how often to this offer should be used: - - **time_unit** (u32): the BOLT12 time unit + - **time\_unit** (u32): the BOLT12 time unit - **period** (u32): how many *time_unit* per payment period - - **time_unit_name** (string, optional): the name of *time_unit* (if valid) + - **time\_unit\_name** (string, optional): the name of *time_unit* (if valid) - **basetime** (u64, optional): period starts at this UNIX timestamp - - **start_any_period** (u64, optional): you can start at any period (only if **basetime** present) + - **start\_any\_period** (u64, optional): you can start at any period (only if **basetime** present) - **limit** (u32, optional): maximum period number for recurrence - **paywindow** (object, optional): when within a period will payment be accepted (default is prior and during the period): - - **seconds_before** (u32): seconds prior to period start - - **seconds_after** (u32): seconds after to period start - - **proportional_amount** (boolean, optional): amount should be scaled if payed after period start (always *true*) + - **seconds\_before** (u32): seconds prior to period start + - **seconds\_after** (u32): seconds after to period start + - **proportional\_amount** (boolean, optional): amount should be scaled if payed after period start (always *true*) - the following warnings are possible: - - **warning_offer_unknown_currency**: The currency code is unknown (so no **minor_unit**) + - **warning\_offer\_unknown\_currency**: The currency code is unknown (so no **minor_unit**) If **type** is "bolt12 offer", and **valid** is *false*: - the following warnings are possible: - - **warning_offer_missing_description**: No **description** + - **warning\_offer\_missing\_description**: No **description** If **type** is "bolt12 invoice", and **valid** is *true*: - - **node_id** (point32): x-only public key of the offering node + - **node\_id** (point32): x-only public key of the offering node - **signature** (bip340sig): BIP-340 signature of the *node_id* on this offer - - **amount_msat** (msat): the amount in bitcoin + - **amount\_msat** (msat): the amount in bitcoin - **description** (string): the description of the purpose of the offer - - **created_at** (u64): the UNIX timestamp of invoice creation - - **payment_hash** (hex): the hash of the *payment_preimage* (always 64 characters) - - **relative_expiry** (u32): the number of seconds after *created_at* when this expires - - **min_final_cltv_expiry** (u32): the number of blocks required by destination - - **offer_id** (hex, optional): the id of this offer (merkle hash of non-signature fields) (always 64 characters) + - **created\_at** (u64): the UNIX timestamp of invoice creation + - **payment\_hash** (hex): the hash of the *payment_preimage* (always 64 characters) + - **relative\_expiry** (u32): the number of seconds after *created_at* when this expires + - **min\_final\_cltv\_expiry** (u32): the number of blocks required by destination + - **offer\_id** (hex, optional): the id of this offer (merkle hash of non-signature fields) (always 64 characters) - **chain** (hex, optional): which blockchain this invoice is for (missing implies bitcoin mainnet only) (always 64 characters) - - **send_invoice** (boolean, optional): present if this offer was a send_invoice offer (always *true*) - - **refund_for** (hex, optional): the *payment_preimage* of invoice this is a refund for (always 64 characters) + - **send\_invoice** (boolean, optional): present if this offer was a send_invoice offer (always *true*) + - **refund\_for** (hex, optional): the *payment_preimage* of invoice this is a refund for (always 64 characters) - **vendor** (string, optional): the name of the vendor for this offer - **features** (hex, optional): the array of feature bits for this offer - **paths** (array of objects, optional): Paths to the destination: - **blinding** (pubkey): blinding factor for this path - **path** (array of objects): an individual path: - - **node_id** (pubkey): node_id of the hop - - **encrypted_recipient_data** (hex): encrypted TLV entry for this hop + - **node\_id** (pubkey): node_id of the hop + - **encrypted\_recipient\_data** (hex): encrypted TLV entry for this hop - **quantity** (u64, optional): the quantity ordered - - **recurrence_counter** (u32, optional): the 0-based counter for a recurring payment - - **recurrence_start** (u32, optional): the optional start period for a recurring payment - - **recurrence_basetime** (u32, optional): the UNIX timestamp of the first recurrence period start - - **payer_key** (point32, optional): the transient key which identifies the payer - - **payer_info** (hex, optional): the payer-provided blob to derive payer_key + - **recurrence\_counter** (u32, optional): the 0-based counter for a recurring payment + - **recurrence\_start** (u32, optional): the optional start period for a recurring payment + - **recurrence\_basetime** (u32, optional): the UNIX timestamp of the first recurrence period start + - **payer\_key** (point32, optional): the transient key which identifies the payer + - **payer\_info** (hex, optional): the payer-provided blob to derive payer_key - **fallbacks** (array of objects, optional): onchain addresses: - **version** (u8): Segwit address version - **hex** (hex): Raw encoded segwit address - **address** (string, optional): bech32 segwit address - - **refund_signature** (bip340sig, optional): the payer key signature to get a refund + - **refund\_signature** (bip340sig, optional): the payer key signature to get a refund If **type** is "bolt12 invoice", and **valid** is *false*: - **fallbacks** (array of objects, optional): - the following warnings are possible: - - **warning_invoice_fallbacks_version_invalid**: **version** is > 16 + - **warning\_invoice\_fallbacks\_version\_invalid**: **version** is > 16 - the following warnings are possible: - - **warning_invoice_missing_amount**: **amount_msat* missing - - **warning_invoice_missing_description**: No **description** - - **warning_invoice_missing_blinded_payinfo**: Has **paths** without payinfo - - **warning_invoice_invalid_blinded_payinfo**: Does not have exactly one payinfo for each of **paths** - - **warning_invoice_missing_recurrence_basetime**: Has **recurrence_counter** without **recurrence_basetime** - - **warning_invoice_missing_created_at**: Missing **created_at** - - **warning_invoice_missing_payment_hash**: Missing **payment_hash** - - **warning_invoice_refund_signature_missing_payer_key**: Missing **payer_key** for refund_signature - - **warning_invoice_refund_signature_invalid**: **refund_signature** incorrect - - **warning_invoice_refund_missing_signature**: No **refund_signature** + - **warning\_invoice\_missing\_amount**: **amount_msat* missing + - **warning\_invoice\_missing\_description**: No **description** + - **warning\_invoice\_missing\_blinded\_payinfo**: Has **paths** without payinfo + - **warning\_invoice\_invalid\_blinded\_payinfo**: Does not have exactly one payinfo for each of **paths** + - **warning\_invoice\_missing\_recurrence\_basetime**: Has **recurrence_counter** without **recurrence_basetime** + - **warning\_invoice\_missing\_created\_at**: Missing **created_at** + - **warning\_invoice\_missing\_payment\_hash**: Missing **payment_hash** + - **warning\_invoice\_refund\_signature\_missing\_payer\_key**: Missing **payer_key** for refund_signature + - **warning\_invoice\_refund\_signature\_invalid**: **refund_signature** incorrect + - **warning\_invoice\_refund\_missing\_signature**: No **refund_signature** If **type** is "bolt12 invoice_request", and **valid** is *true*: - - **offer_id** (hex): the id of the offer this is requesting (merkle hash of non-signature fields) (always 64 characters) - - **payer_key** (point32): the transient key which identifies the payer + - **offer\_id** (hex): the id of the offer this is requesting (merkle hash of non-signature fields) (always 64 characters) + - **payer\_key** (point32): the transient key which identifies the payer - **chain** (hex, optional): which blockchain this invoice_request is for (missing implies bitcoin mainnet only) (always 64 characters) - - **amount_msat** (msat, optional): the amount in bitcoin + - **amount\_msat** (msat, optional): the amount in bitcoin - **features** (hex, optional): the array of feature bits for this offer - **quantity** (u64, optional): the quantity ordered - - **recurrence_counter** (u32, optional): the 0-based counter for a recurring payment - - **recurrence_start** (u32, optional): the optional start period for a recurring payment - - **payer_info** (hex, optional): the payer-provided blob to derive payer_key - - **recurrence_signature** (bip340sig, optional): the payer key signature + - **recurrence\_counter** (u32, optional): the 0-based counter for a recurring payment + - **recurrence\_start** (u32, optional): the optional start period for a recurring payment + - **payer\_info** (hex, optional): the payer-provided blob to derive payer_key + - **recurrence\_signature** (bip340sig, optional): the payer key signature If **type** is "bolt12 invoice_request", and **valid** is *false*: - the following warnings are possible: - - **warning_invoice_request_missing_offer_id**: No **offer_id** - - **warning_invoice_request_missing_payer_key**: No **payer_key** - - **warning_invoice_request_missing_recurrence_signature**: No **recurrence_signature** - - **warning_invoice_request_invalid_recurrence_signature**: **recurrence_signature** incorrect + - **warning\_invoice\_request\_missing\_offer\_id**: No **offer_id** + - **warning\_invoice\_request\_missing\_payer\_key**: No **payer_key** + - **warning\_invoice\_request\_missing\_recurrence\_signature**: No **recurrence_signature** + - **warning\_invoice\_request\_invalid\_recurrence\_signature**: **recurrence_signature** incorrect If **type** is "bolt11 invoice", and **valid** is *true*: - **currency** (string): the BIP173 name for the currency - - **created_at** (u64): the UNIX-style timestamp of the invoice + - **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 + - **min\_final\_cltv\_expiry** (u32): the minimum CLTV delay for the final node + - **amount\_msat** (msat, optional): Amount the invoice asked for - **description** (string, optional): the description of the purpose of the purchase - - **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) + - **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 @@ -163,10 +163,10 @@ If **type** is "bolt11 invoice", and **valid** is *true*: - **routes** (array of arrays, optional): Route hints to the *payee*: - hops in the route: - **pubkey** (pubkey): the public key of the node - - **short_channel_id** (short_channel_id): a channel to the next peer - - **fee_base_msat** (msat): the base fee for payments - - **fee_proportional_millionths** (u32): the parts-per-million fee for payments - - **cltv_expiry_delta** (u32): the CLTV delta across this hop + - **short\_channel\_id** (short_channel_id): a channel to the next peer + - **fee\_base\_msat** (msat): the base fee for payments + - **fee\_proportional\_millionths** (u32): the parts-per-million fee for payments + - **cltv\_expiry\_delta** (u32): the CLTV delta across this hop - **extra** (array of objects, optional): Any extra fields we didn't know how to parse: - **tag** (string): The bech32 letter which identifies this field (always 1 characters) - **data** (string): The bech32 data for this field @@ -179,7 +179,7 @@ If **type** is "rune", and **valid** is *true*: - **alternatives** (array of strings): each way restriction can be met: any can pass: - the alternative of form fieldname condition fieldname - **summary** (string): human-readable summary of this restriction - - **unique_id** (string, optional): unique id (always a numeric id on runes we create) + - **unique\_id** (string, optional): unique id (always a numeric id on runes we create) - **version** (string, optional): rune version, not currently set on runes we create If **type** is "rune", and **valid** is *false*: @@ -187,7 +187,7 @@ If **type** is "rune", and **valid** is *false*: - **valid** (boolean) (always *false*) - **hex** (hex, optional): the raw rune in hex - the following warnings are possible: - - **warning_rune_invalid_utf8**: the rune contains invalid UTF-8 strings + - **warning\_rune\_invalid\_utf8**: the rune contains invalid UTF-8 strings [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -211,4 +211,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:2a6cc144b0f2436cc87886cf80f635f7c37e70c5a82e88ad7439ba660046523a) +[comment]: # ( SHA256STAMP:7497fbb2f802f2eef2b6c1a8005d31f4778af94c9d0384192a8ba1a4af936549) diff --git a/doc/lightning-decodepay.7.md b/doc/lightning-decodepay.7.md index e7bb66745..25433d5a2 100644 --- a/doc/lightning-decodepay.7.md +++ b/doc/lightning-decodepay.7.md @@ -19,18 +19,18 @@ RETURN VALUE On success, an object is returned, containing: - **currency** (string): the BIP173 name for the currency -- **created_at** (u64): the UNIX-style timestamp of the invoice +- **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 +- **min\_final\_cltv\_expiry** (u32): the minimum CLTV delay for the final node +- **amount\_msat** (msat, optional): Amount the invoice asked for - **description** (string, optional): the description of the purpose of the purchase -- **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) +- **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 @@ -38,10 +38,10 @@ On success, an object is returned, containing: - **routes** (array of arrays, optional): Route hints to the *payee*: - hops in the route: - **pubkey** (pubkey): the public key of the node - - **short_channel_id** (short_channel_id): a channel to the next peer - - **fee_base_msat** (msat): the base fee for payments - - **fee_proportional_millionths** (u32): the parts-per-million fee for payments - - **cltv_expiry_delta** (u32): the CLTV delta across this hop + - **short\_channel\_id** (short_channel_id): a channel to the next peer + - **fee\_base\_msat** (msat): the base fee for payments + - **fee\_proportional\_millionths** (u32): the parts-per-million fee for payments + - **cltv\_expiry\_delta** (u32): the CLTV delta across this hop - **extra** (array of objects, optional): Any extra fields we didn't know how to parse: - **tag** (string): The bech32 letter which identifies this field (always 1 characters) - **data** (string): The bech32 data for this field @@ -71,4 +71,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:120150143d95a3f3b9685fc07c9630b5721d903ce4b85159242df3a804201698) +[comment]: # ( SHA256STAMP:b2a483f6fcb07e4bcddb088520049eee1d33447136e2634bf4207d54c21022e9) diff --git a/doc/lightning-deldatastore.7.md b/doc/lightning-deldatastore.7.md index b8e0d882e..e8cfc4513 100644 --- a/doc/lightning-deldatastore.7.md +++ b/doc/lightning-deldatastore.7.md @@ -49,4 +49,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:6037971086a82e77e86621112e806e7b061c17cd5d5f9f82dff0af734f3965e5) +[comment]: # ( SHA256STAMP:3d70f21bc0945835995b820ab6d65b1ac6e88a9f13240f30acffd32315d41e70) diff --git a/doc/lightning-delexpiredinvoice.7.md b/doc/lightning-delexpiredinvoice.7.md index 5689eb61c..4f3fc644e 100644 --- a/doc/lightning-delexpiredinvoice.7.md +++ b/doc/lightning-delexpiredinvoice.7.md @@ -38,4 +38,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:23050bf2eaaf606c63069c7686f45b69133cb2c0827537eee4367921b897842f) +[comment]: # ( SHA256STAMP:c2aef71377094e4c4ab09d3c18b3b8448e5fed1fcc2a6afd47ab218afb011b5e) diff --git a/doc/lightning-delinvoice.7.md b/doc/lightning-delinvoice.7.md index c8d9f3522..3bb95d720 100644 --- a/doc/lightning-delinvoice.7.md +++ b/doc/lightning-delinvoice.7.md @@ -28,25 +28,25 @@ 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) +- **expires\_at** (u64): UNIX timestamp when invoice expires (or expired) - **bolt11** (string, optional): BOLT11 string - **bolt12** (string, optional): BOLT12 string -- **amount_msat** (msat, optional): the amount required to pay this invoice +- **amount\_msat** (msat, optional): the amount required to pay this invoice - **description** (string, optional): description used in the invoice If **bolt12** is present: - - **local_offer_id** (hex, optional): offer for which this invoice was created - - **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice + - **local\_offer\_id** (hex, optional): offer for which this invoice was created + - **payer\_note** (string, optional): the optional *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) + - **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) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -81,4 +81,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:48ff64ba8dcb03b0e727f962b7b16a3768dd2382e5a3414c7ad243884b674667) +[comment]: # ( SHA256STAMP:a869dc2b48e763c47f3af1c27143d194db96948f19fbcec82df343bd3b6c4468) diff --git a/doc/lightning-delpay.7.md b/doc/lightning-delpay.7.md index 919b1e5d7..a3bf29c30 100644 --- a/doc/lightning-delpay.7.md +++ b/doc/lightning-delpay.7.md @@ -39,15 +39,15 @@ 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 +- **amount\_sent\_msat** (msat): the amount we actually sent, including fees +- **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **partid** (u64, optional): unique ID within this (multi-part) payment - **destination** (pubkey, optional): the final destination of the payment if known -- **amount_msat** (msat, optional): the amount the destination received, if known +- **amount\_msat** (msat, optional): the amount the destination received, if known - **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) +- **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) - **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only). @@ -102,4 +102,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:dbe8ab5ab8d0d5ab602fac4af3a567bd1f7899f25304683323da6621b8196213) +[comment]: # ( SHA256STAMP:f687e5248b633be5e6e3bb515b7b006858a3f2499bb5955240b3e18dd80794a8) diff --git a/doc/lightning-disableoffer.7.md b/doc/lightning-disableoffer.7.md index 6e7c5541f..842ec0d24 100644 --- a/doc/lightning-disableoffer.7.md +++ b/doc/lightning-disableoffer.7.md @@ -37,11 +37,11 @@ Note: the returned object is the same format as **listoffers**. [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **offer_id** (hex): the merkle hash of the offer (always 64 characters) +- **offer\_id** (hex): the merkle hash of the offer (always 64 characters) - **active** (boolean): Whether the offer can produce invoices/payments (always *false*) -- **single_use** (boolean): Whether the offer is disabled after first successful use +- **single\_use** (boolean): Whether the offer is disabled after first successful use - **bolt12** (string): The bolt12 string representing this offer -- **bolt12_unsigned** (string): The bolt12 string representing this offer, without signature +- **bolt12\_unsigned** (string): The bolt12 string representing this offer, without signature - **used** (boolean): Whether the offer has had an invoice paid / payment made - **label** (string, optional): The label provided when offer was created @@ -75,4 +75,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:17db907802f8417021d203710d1f4bb9e171f6d64952e8b6608d2875a947edb0) +[comment]: # ( SHA256STAMP:a2489ae6d986292861555d66a1fb0c8c39efe460db5e324ddbb27b9be1650296) diff --git a/doc/lightning-disconnect.7.md b/doc/lightning-disconnect.7.md index feac6b777..2a7b4f679 100644 --- a/doc/lightning-disconnect.7.md +++ b/doc/lightning-disconnect.7.md @@ -59,4 +59,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:bdc678495e0e0e626cdc71e73e8179dc8350de9862c4458933607fa62d8a16f7) +[comment]: # ( SHA256STAMP:4d9f888d10faca2bf94d1b52510cf21fbeebae4efda0946f03d04b0ef4bc88a2) diff --git a/doc/lightning-feerates.7.md b/doc/lightning-feerates.7.md index b29ba413c..0328e8fa4 100644 --- a/doc/lightning-feerates.7.md +++ b/doc/lightning-feerates.7.md @@ -48,33 +48,33 @@ RETURN VALUE On success, an object is returned, containing: - **perkb** (object, optional): If *style* parameter was perkb: - - **min_acceptable** (u32): The smallest feerate that you can use, usually the minimum relayed feerate of the backend - - **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). + - **min\_acceptable** (u32): The smallest feerate that you can use, usually the minimum relayed feerate of the backend + - **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 - - **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 + - **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 + - **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 - **perkw** (object, optional): If *style* parameter was perkw: - - **min_acceptable** (u32): The smallest feerate that you can use, usually the minimum relayed feerate of the backend - - **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). + - **min\_acceptable** (u32): The smallest feerate that you can use, usually the minimum relayed feerate of the backend + - **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 - - **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 + - **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 + - **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 -- **onchain_fee_estimates** (object, optional): - - **opening_channel_satoshis** (u64): Estimated cost of typical channel open - - **mutual_close_satoshis** (u64): Estimated cost of typical channel close - - **unilateral_close_satoshis** (u64): Estimated cost of typical unilateral close (without HTLCs) - - **htlc_timeout_satoshis** (u64): Estimated cost of typical HTLC timeout transaction - - **htlc_success_satoshis** (u64): Estimated cost of typical HTLC fulfillment transaction +- **onchain\_fee\_estimates** (object, optional): + - **opening\_channel\_satoshis** (u64): Estimated cost of typical channel open + - **mutual\_close\_satoshis** (u64): Estimated cost of typical channel close + - **unilateral\_close\_satoshis** (u64): Estimated cost of typical unilateral close (without HTLCs) + - **htlc\_timeout\_satoshis** (u64): Estimated cost of typical HTLC timeout transaction + - **htlc\_success\_satoshis** (u64): Estimated cost of typical HTLC fulfillment transaction The following warnings may also be returned: -- **warning_missing_feerates**: Some fee estimates are missing +- **warning\_missing\_feerates**: Some fee estimates are missing [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -121,4 +121,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:25001249ab0ced5ea1fa3520fd1f090eb1b16b1a43a49452d39bffa33a49f009) +[comment]: # ( SHA256STAMP:8b9053a3047bc47e9cb86d8ae059e9b955194d1761d07b33ed7b78c85f434c34) diff --git a/doc/lightning-fetchinvoice.7.md b/doc/lightning-fetchinvoice.7.md index 696114f47..dd8701790 100644 --- a/doc/lightning-fetchinvoice.7.md +++ b/doc/lightning-fetchinvoice.7.md @@ -53,17 +53,17 @@ On success, an object is returned, containing: - **invoice** (string): The BOLT12 invoice we fetched - **changes** (object): Summary of changes from offer: - - **description_appended** (string, optional): extra characters appended to the *description* field. + - **description\_appended** (string, optional): extra characters appended to the *description* field. - **description** (string, optional): a completely replaced *description* field - - **vendor_removed** (string, optional): The *vendor* from the offer, which is missing in the invoice + - **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*: + - **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*: - **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 - - **paywindow_start** (u64): UNIX timestamp of the earliest time that the next invoice can be fetched - - **paywindow_end** (u64): UNIX timestamp of the latest time that the next invoice can be fetched + - **paywindow\_start** (u64): UNIX timestamp of the earliest time that the next invoice can be fetched + - **paywindow\_end** (u64): UNIX timestamp of the latest time that the next invoice can be fetched [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -89,4 +89,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:336245434880c274390e89e464ee7731508059c2e4614e1e0dbaeccdc6a315bc) +[comment]: # ( SHA256STAMP:003592ea0876d08b2109a0daa5e10328e049013f8e44d3eccc5805885a16a375) diff --git a/doc/lightning-fundchannel.7.md b/doc/lightning-fundchannel.7.md index ed27a4b80..babc38327 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:c4e05ea6ec3e86b5506c7531d60809a165a2b84e97c92e57387868f34dd0b9db) +[comment]: # ( SHA256STAMP:f1c2b762c111ecb6d569075377e1a79cd9fceb60863fc56aeddcdbcd51445812) diff --git a/doc/lightning-fundchannel_cancel.7.md b/doc/lightning-fundchannel_cancel.7.md index d79111997..ab68df060 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:ac234f1fece4dd8d1a9b9af2e053088e83fa4c7e10fb5f9b99db9c4607df3228) +[comment]: # ( SHA256STAMP:6e9501860847adfa98cf725e65297322428986f6345aeb04cd0ece150780ec66) diff --git a/doc/lightning-fundchannel_complete.7.md b/doc/lightning-fundchannel_complete.7.md index f6f46fa66..248571b90 100644 --- a/doc/lightning-fundchannel_complete.7.md +++ b/doc/lightning-fundchannel_complete.7.md @@ -29,8 +29,8 @@ 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) -- **commitments_secured** (boolean): Indication that channel is safe to use (always *true*) +- **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:7d1740964e0509e5bc36b22dd9612cb8fc4e5d345cbb8e92b1e03295c7d36075) +[comment]: # ( SHA256STAMP:b0602c5c3ab5370199776b56656451538712b989e9bfc169934ddabeff56894c) diff --git a/doc/lightning-fundchannel_start.7.md b/doc/lightning-fundchannel_start.7.md index e697c9bed..c6239df49 100644 --- a/doc/lightning-fundchannel_start.7.md +++ b/doc/lightning-fundchannel_start.7.md @@ -44,14 +44,14 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) 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. +- **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: -- **warning_usage**: A warning not to prematurely broadcast the funding transaction (always present!) +- **warning\_usage**: A warning not to prematurely broadcast the funding transaction (always present!) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -85,4 +85,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:56c7001a34cee3ee79c18c8d0b71979a1f140fdc247222c0b05c4bd2b7f142e5) +[comment]: # ( SHA256STAMP:d76e01b4e00915ca84e6960c8718028bc220712a4c387711c01977c3ee80ddf4) diff --git a/doc/lightning-funderupdate.7.md b/doc/lightning-funderupdate.7.md index 424a943a8..4419642fe 100644 --- a/doc/lightning-funderupdate.7.md +++ b/doc/lightning-funderupdate.7.md @@ -109,21 +109,21 @@ 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. -- **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. -- **per_channel_min_msat** (msat): The minimum amount that we will fund a channel open with. -- **per_channel_max_msat** (msat): The maximum amount that we will fund a channel open with. -- **reserve_tank_msat** (msat): Amount of sats to leave available in the node wallet. -- **fuzz_percent** (u32): Percentage to fuzz our funding amount by. -- **fund_probability** (u32): Percent of opens to consider funding. 100 means we'll consider funding every requested open channel request. -- **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. -- **compact_lease** (hex, optional): Compact description of the channel lease parameters. +- **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. +- **per\_channel\_min\_msat** (msat): The minimum amount that we will fund a channel open with. +- **per\_channel\_max\_msat** (msat): The maximum amount that we will fund a channel open with. +- **reserve\_tank\_msat** (msat): Amount of sats to leave available in the node wallet. +- **fuzz\_percent** (u32): Percentage to fuzz our funding amount by. +- **fund\_probability** (u32): Percent of opens to consider funding. 100 means we'll consider funding every requested open channel request. +- **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. +- **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:b07236a4cbe24e7aa13324002b044dc66b5457405cb9e448eaeeafe3c729cab4) +[comment]: # ( SHA256STAMP:c5895e85860542fa6d71d4acf8b1e0d43acaf395331b357064150ee1d52ddcca) diff --git a/doc/lightning-fundpsbt.7.md b/doc/lightning-fundpsbt.7.md index 07740e217..3402dcce7 100644 --- a/doc/lightning-fundpsbt.7.md +++ b/doc/lightning-fundpsbt.7.md @@ -74,16 +74,16 @@ RETURN VALUE 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) +- **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) - **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 - - **was_reserved** (boolean): Whether this output was previously reserved (always *false*) + - **was\_reserved** (boolean): Whether this output was previously reserved (always *false*) - **reserved** (boolean): Whether this output is now reserved (always *true*) - - **reserved_to_block** (u32): The blockheight the reservation will expire + - **reserved\_to\_block** (u32): The blockheight the reservation will expire [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -115,4 +115,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:f687ab47b409b04ff97ad3bdb42880b23dfe4e0bb38f54a64b74e1a16c07ee81) +[comment]: # ( SHA256STAMP:7503bff4054024adf29a560f8612e2c504fe1252c71c3a3bb08282808fb299a7) diff --git a/doc/lightning-getinfo.7.md b/doc/lightning-getinfo.7.md index 20ae5b46d..0a546473d 100644 --- a/doc/lightning-getinfo.7.md +++ b/doc/lightning-getinfo.7.md @@ -31,16 +31,16 @@ On success, an object is returned, containing: - **id** (pubkey): The public key unique to this node - **alias** (string): The fun alias this node will advertize (up to 32 characters) - **color** (hex): The favorite RGB color this node will advertize (always 6 characters) -- **num_peers** (u32): The total count of peers, connected or with channels -- **num_pending_channels** (u32): The total count of channels being opened -- **num_active_channels** (u32): The total count of channels in normal state -- **num_inactive_channels** (u32): The total count of channels waiting for opening or closing transactions to be mined +- **num\_peers** (u32): The total count of peers, connected or with channels +- **num\_pending\_channels** (u32): The total count of channels being opened +- **num\_active\_channels** (u32): The total count of channels in normal state +- **num\_inactive\_channels** (u32): The total count of channels waiting for opening or closing transactions to be mined - **version** (string): Identifies what bugs you are running into - **lightning-dir** (string): Identifies where you can find the configuration and other related files - **blockheight** (u32): The highest block height we've learned - **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: +- **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 @@ -60,8 +60,8 @@ On success, an object is returned, containing: The following warnings may also be returned: -- **warning_bitcoind_sync**: Bitcoind is not up-to-date with network. -- **warning_lightningd_sync**: Lightningd is still loading latest blocks from bitcoind. +- **warning\_bitcoind\_sync**: Bitcoind is not up-to-date with network. +- **warning\_lightningd\_sync**: Lightningd is still loading latest blocks from bitcoind. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -131,4 +131,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:1d3258e769579e140755acc9808b9008b0f81fc0ded50311ee64ba628aee04ad) +[comment]: # ( SHA256STAMP:a517e840e673273a35128e8168d8f58f7795bf0bcfca00f25b859f6e171b08a0) diff --git a/doc/lightning-getlog.7.md b/doc/lightning-getlog.7.md index 0163bc58b..130f037f0 100644 --- a/doc/lightning-getlog.7.md +++ b/doc/lightning-getlog.7.md @@ -31,22 +31,22 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) 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 +- **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 - **log** (array of objects): - **type** (string) (one of "SKIPPED", "BROKEN", "UNUSUAL", "INFO", "DEBUG", "IO_IN", "IO_OUT") If **type** is "SKIPPED": - - **num_skipped** (u32): number of unprinted log entries (deleted or below *level* parameter) + - **num\_skipped** (u32): number of unprinted log entries (deleted or below *level* parameter) If **type** is "BROKEN", "UNUSUAL", "INFO" or "DEBUG": - **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 + - **node\_id** (pubkey, optional): The peer this is associated with If **type** is "IO_IN" or "IO_OUT": @@ -54,7 +54,7 @@ On success, an object is returned, containing: - **source** (string): The particular logbook this was found in - **log** (string): The associated log message - **data** (hex): The IO which occurred - - **node_id** (pubkey, optional): The peer this is associated with + - **node\_id** (pubkey, optional): The peer this is associated with [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -94,4 +94,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:778a192de637d247689c270b3cdc5b100baa749a866093b7a5c709b546e53c2c) +[comment]: # ( SHA256STAMP:95995a847dd9f3c2d51494a396761b42051e44bb6376de2e3c3e72634e7fd079) diff --git a/doc/lightning-getroute.7.md b/doc/lightning-getroute.7.md index 7ab5efa77..4d0dd03ad 100644 --- a/doc/lightning-getroute.7.md +++ b/doc/lightning-getroute.7.md @@ -283,7 +283,7 @@ On success, an object containing **route** is returned. It is an array of objec - **id** (pubkey): The node at the end of this hop - **channel** (short_channel_id): The channel joining these nodes - **direction** (u32): 0 if this channel is traversed from lesser to greater **id**, otherwise 1 -- **amount_msat** (msat): The amount expected by the node at the end of this hop +- **amount\_msat** (msat): The amount expected by the node at the end of this hop - **delay** (u32): The total CLTV expected by the node at the end of this hop - **style** (string): The features understood by the destination node (always "tlv") @@ -310,4 +310,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:95668bff3a9ec23bd7cebfc60a6af56bce0e6559fa8218b14390017b1348ef61) +[comment]: # ( SHA256STAMP:7aca069c04bac7139f82387d91e0ea148cc42f375c4cb11232189c874be87dcf) diff --git a/doc/lightning-help.7.md b/doc/lightning-help.7.md index f6621a39f..48f460045 100644 --- a/doc/lightning-help.7.md +++ b/doc/lightning-help.7.md @@ -68,4 +68,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:288d00779f245c6e07fb7f6826e44b78a6dad296e0cd92855bf419523bbe2024) +[comment]: # ( SHA256STAMP:a87a95be3154ca98238cea4abdcb0524a831a0f78998b82eed1041da742ffa4c) diff --git a/doc/lightning-invoice.7.md b/doc/lightning-invoice.7.md index 5e04421fd..e3350ffc3 100644 --- a/doc/lightning-invoice.7.md +++ b/doc/lightning-invoice.7.md @@ -79,17 +79,17 @@ 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) -- **expires_at** (u64): UNIX timestamp of when invoice expires +- **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: -- **warning_capacity**: even using all possible channels, there's not enough incoming capacity to pay this invoice. -- **warning_offline**: there would be enough incoming capacity, but some channels are offline, so there isn't. -- **warning_deadends**: there would be enough incoming capacity, but some channels are dead-ends (no other public channels from those peers), so there isn't. -- **warning_private_unused**: there would be enough incoming capacity, but some channels are unannounced and *exposeprivatechannels* is *false*, so there isn't. -- **warning_mpp**: there is sufficient capacity, but not in a single channel, so the payer will have to use multi-part payments. +- **warning\_capacity**: even using all possible channels, there's not enough incoming capacity to pay this invoice. +- **warning\_offline**: there would be enough incoming capacity, but some channels are offline, so there isn't. +- **warning\_deadends**: there would be enough incoming capacity, but some channels are dead-ends (no other public channels from those peers), so there isn't. +- **warning\_private\_unused**: there would be enough incoming capacity, but some channels are unannounced and *exposeprivatechannels* is *false*, so there isn't. +- **warning\_mpp**: there is sufficient capacity, but not in a single channel, so the payer will have to use multi-part payments. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -119,4 +119,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c040289df896608002a560a3bf4213f155ca81aacfe2de45771c2dcba1517b98) +[comment]: # ( SHA256STAMP:8e72905b6a11d025e5955b9997213d8219e1290cc26307fe517a3e0f19cc818e) diff --git a/doc/lightning-keysend.7.md b/doc/lightning-keysend.7.md index 148b54d21..f69e8c103 100644 --- a/doc/lightning-keysend.7.md +++ b/doc/lightning-keysend.7.md @@ -68,18 +68,18 @@ 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) -- **created_at** (number): the UNIX timestamp showing when this payment was initiated +- **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 -- **amount_sent_msat** (msat): Total amount we sent (including fees) +- **amount\_msat** (msat): Amount the recipient received +- **amount\_sent\_msat** (msat): Total amount we sent (including fees) - **status** (string): status of payment (always "complete") - **destination** (pubkey, optional): the final destination of the payment The following warnings may also be returned: -- **warning_partial_completion**: Not all parts of a multi-part payment have completed +- **warning\_partial\_completion**: Not all parts of a multi-part payment have completed [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -116,4 +116,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:17d0a04f94d00f4f842cd1924f490678167498559098b27bc4ac29dd907c3af1) +[comment]: # ( SHA256STAMP:6aca5a797d5e9bca63bbdc478d5ee0ce1dde592d3a4a4247f75d1831c8e6f38a) diff --git a/doc/lightning-listchannels.7.md b/doc/lightning-listchannels.7.md index 648b097c0..c23459e26 100644 --- a/doc/lightning-listchannels.7.md +++ b/doc/lightning-listchannels.7.md @@ -35,19 +35,19 @@ On success, an object containing **channels** is returned. It is an array of ob - **source** (pubkey): the source node - **destination** (pubkey): the destination node -- **short_channel_id** (short_channel_id): short channel id of channel +- **short\_channel\_id** (short_channel_id): short channel id of channel - **public** (boolean): true if this is announced (otherwise it must be our channel) -- **amount_msat** (msat): the total capacity of this channel (always a whole number of satoshis) -- **message_flags** (u8): as defined by BOLT #7 -- **channel_flags** (u8): as defined by BOLT #7 +- **amount\_msat** (msat): the total capacity of this channel (always a whole number of satoshis) +- **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* -- **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 +- **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 -- **htlc_minimum_msat** (msat): The smallest payment *source* will allow via this channel +- **htlc\_minimum\_msat** (msat): The smallest payment *source* will allow via this channel - **features** (hex): BOLT #9 features bitmap for this channel -- **htlc_maximum_msat** (msat, optional): The largest payment *source* will allow via this channel +- **htlc\_maximum\_msat** (msat, optional): The largest payment *source* will allow via this channel [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -79,4 +79,4 @@ Lightning RFC site - BOLT \#7: -[comment]: # ( SHA256STAMP:332e2a7c3f544a1cfc2a1a5e0728d54756249852f4060ca9fd47c137263b1e9d) +[comment]: # ( SHA256STAMP:2c4d604d1cec7372129bc863b1e056943abb24d6a354c0e9ae76d8fdecfd4953) diff --git a/doc/lightning-listconfigs.7.md b/doc/lightning-listconfigs.7.md index 9ebe710a0..237a147b7 100644 --- a/doc/lightning-listconfigs.7.md +++ b/doc/lightning-listconfigs.7.md @@ -215,4 +215,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:6df5cfe511b7223a7a39fab1f36dcb46d8caef2726d9dbdf6c892a03cf4369f0) +[comment]: # ( SHA256STAMP:633de58c810a3d0692e4fe7c58265cf4eec1fe85dffc0139a9af1b23936b61e8) diff --git a/doc/lightning-listdatastore.7.md b/doc/lightning-listdatastore.7.md index 5b4125e2e..ed71f94be 100644 --- a/doc/lightning-listdatastore.7.md +++ b/doc/lightning-listdatastore.7.md @@ -47,4 +47,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:3b6eb48324fe4bab31a40460af1d5c98b8a938f27c1af758b15c955bb2204e58) +[comment]: # ( SHA256STAMP:45448ccd8947127b2008b4b7d8ab30bb348a45c9ddbced2c690d8b08a102d058) diff --git a/doc/lightning-listforwards.7.md b/doc/lightning-listforwards.7.md index 269aa8e25..b661b0456 100644 --- a/doc/lightning-listforwards.7.md +++ b/doc/lightning-listforwards.7.md @@ -24,22 +24,22 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **forwards** is returned. It is an array of objects, where each object contains: -- **in_channel** (short_channel_id): the channel that received the HTLC -- **in_msat** (msat): the value of the incoming HTLC +- **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") -- **received_time** (number): the UNIX timestamp when this was received -- **out_channel** (short_channel_id, optional): the channel that the HTLC (trying to) forward to -- **payment_hash** (hex, optional): payment hash sought by HTLC (always 64 characters) +- **received\_time** (number): the UNIX timestamp when this was received +- **out\_channel** (short_channel_id, optional): the channel that the HTLC (trying to) forward to +- **payment\_hash** (hex, optional): payment hash sought by HTLC (always 64 characters) - **style** (string, optional): Either a legacy onion format or a modern tlv format (one of "legacy", "tlv") -If **out_msat** is present: +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* + - **fee\_msat** (msat): the amount this paid in fees + - **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 + - **resolved\_time** (number): the UNIX timestamp when this was resolved If **status** is "local_failed" or "failed": @@ -63,4 +63,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:cc82cc624fd377f957a83e1d3a49607a7cfa3c87505ba70a3f3fa07d6d922089) +[comment]: # ( SHA256STAMP:e3c26f73040deb441a572d848eda3d6da924c490e5b9ac55c5d87432f4144646) diff --git a/doc/lightning-listfunds.7.md b/doc/lightning-listfunds.7.md index 02cc98605..d2596e263 100644 --- a/doc/lightning-listfunds.7.md +++ b/doc/lightning-listfunds.7.md @@ -25,7 +25,7 @@ On success, an object is returned, containing: - **outputs** (array of objects): - **txid** (txid): the ID of the spendable transaction - **output** (u32): the index within *txid* - - **amount_msat** (msat): the amount of the output + - **amount\_msat** (msat): the amount of the output - **scriptpubkey** (hex): the scriptPubkey of the output - **status** (string) (one of "unconfirmed", "confirmed", "spent") - **reserved** (boolean): whether this UTXO is currently reserved for an in-flight tx @@ -38,23 +38,23 @@ On success, an object is returned, containing: If **reserved** is "true": - - **reserved_to_block** (u32): Block height where reservation will expire + - **reserved\_to\_block** (u32): Block height where reservation will expire - **channels** (array of objects): - - **peer_id** (pubkey): the peer with which the channel is opened - - **our_amount_msat** (msat): available satoshis on our node's end of the channel - - **amount_msat** (msat): total channel value - - **funding_txid** (txid): funding transaction id - - **funding_output** (u32): the 0-based index of the output in the funding transaction + - **peer\_id** (pubkey): the peer with which the channel is opened + - **our\_amount\_msat** (msat): available satoshis on our node's end of the channel + - **amount\_msat** (msat): total channel value + - **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") If **state** is "CHANNELD_NORMAL": - - **short_channel_id** (short_channel_id): short channel id of channel + - **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": - - **short_channel_id** (short_channel_id, optional): short channel id of channel (only if funding reached lockin depth before closing) + - **short\_channel\_id** (short_channel_id, optional): short channel id of channel (only if funding reached lockin depth before closing) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -73,4 +73,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:999fb813822e397fdb22dc79cfb5b766e79766073a8c2803a47b56ea4786fb8e) +[comment]: # ( SHA256STAMP:319598cb35f3a9c6f336191363b1e38df74b467c0989942b5f4e0a998d0f6339) diff --git a/doc/lightning-listinvoices.7.md b/doc/lightning-listinvoices.7.md index 04eff6ca1..df0c33dc1 100644 --- a/doc/lightning-listinvoices.7.md +++ b/doc/lightning-listinvoices.7.md @@ -24,22 +24,22 @@ 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 +- **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable - **description** (string, optional): description used in the invoice -- **amount_msat** (msat, optional): the amount required to pay this invoice +- **amount\_msat** (msat, optional): the amount required to pay this invoice - **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) -- **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice (**experimental-offers** only). +- **local\_offer\_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters) +- **payer\_note** (string, optional): the optional *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) - - **paid_at** (u64): UNIX timestamp of when it was paid - - **payment_preimage** (secret): proof of payment (always 64 characters) + - **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) + - **paid\_at** (u64): UNIX timestamp of when it was paid + - **payment\_preimage** (secret): proof of payment (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -58,4 +58,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:06dceb4701a60fc36d9823c107fc34d2b2d5d13cb7c60ae0ec1db3128cffa55f) +[comment]: # ( SHA256STAMP:bfa699310cf025668febb42385b52e6238dfbbc0b5303a28989433d3645495c2) diff --git a/doc/lightning-listnodes.7.md b/doc/lightning-listnodes.7.md index a46fdfb08..f13eed35c 100644 --- a/doc/lightning-listnodes.7.md +++ b/doc/lightning-listnodes.7.md @@ -30,9 +30,9 @@ 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: +If **last\_timestamp** is present: - **alias** (string): The fun alias this node advertized (up to 32 characters) - **color** (hex): The favorite RGB color this node advertized (always 6 characters) @@ -45,15 +45,15 @@ If **last_timestamp** is present: - **address** (string): address in expected format for **type** -If **option_will_fund** is present: +If **option\_will\_fund** is present: - - **option_will_fund** (object): - - **lease_fee_base_msat** (msat): the fixed fee for a lease (whole number of satoshis) - - **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 + - **option\_will\_fund** (object): + - **lease\_fee\_base\_msat** (msat): the fixed fee for a lease (whole number of satoshis) + - **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 [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -99,4 +99,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:eca3d33813f3b3169317b8c4f573663416dd0e87d050a14feff64b754a70c2cb) +[comment]: # ( SHA256STAMP:452467d60a45d9d685b054644c94a8b7998d5e9f5dd30474006fe9f4f002eb67) diff --git a/doc/lightning-listoffers.7.md b/doc/lightning-listoffers.7.md index 037a215f5..6d1a14a7b 100644 --- a/doc/lightning-listoffers.7.md +++ b/doc/lightning-listoffers.7.md @@ -32,11 +32,11 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object containing **offers** is returned. It is an array of objects, where each object contains: -- **offer_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) +- **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 -- **single_use** (boolean): whether this expires as soon as it's paid +- **single\_use** (boolean): whether this expires as soon as it's paid - **bolt12** (string): the bolt12 encoding of the offer -- **bolt12_unsigned** (string): the bolt12 encoding of the offer, without signature +- **bolt12\_unsigned** (string): the bolt12 encoding of the offer, without signature - **used** (boolean): True if an associated invoice has been paid - **label** (string, optional): the (optional) user-specified label @@ -81,4 +81,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:c8335d88dde3b056b69d4d4b3cb819844dbbb219410fb0277a148fcf7b4d2ed6) +[comment]: # ( SHA256STAMP:61677f64d10f6ffad32d19f98273925c5f2a1d9cda47bdb5c44cf5a30a34a62d) diff --git a/doc/lightning-listpays.7.md b/doc/lightning-listpays.7.md index e04180eda..6ae899217 100644 --- a/doc/lightning-listpays.7.md +++ b/doc/lightning-listpays.7.md @@ -19,9 +19,9 @@ 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 +- **created\_at** (u64): the UNIX timestamp showing when this payment was initiated - **destination** (pubkey, optional): the final destination of the payment if known - **label** (string, optional): the label, if given to sendpay - **bolt11** (string, optional): the bolt11 string (if pay supplied one) @@ -30,13 +30,13 @@ On success, an object containing **pays** is returned. It is an array of object If **status** is "pending" or "complete": - - **amount_sent_msat** (msat): the amount we actually sent, including fees - - **amount_msat** (msat, optional): the amount the destination received, if known + - **amount\_sent\_msat** (msat): the amount we actually sent, including fees + - **amount\_msat** (msat, optional): the amount the destination received, if known If **status** is "complete": - **preimage** (hex): proof of payment (always 64 characters) - - **number_of_parts** (u64, optional): the number of parts for a successful payment (only if more than one). + - **number\_of\_parts** (u64, optional): the number of parts for a successful payment (only if more than one). If **status** is "failed": @@ -61,4 +61,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:074ced29c00a0aff31098ccaae1c1f56364cc3aaaad34485a7c6b1c3cd9b3670) +[comment]: # ( SHA256STAMP:fd723be0ea9b4d6722adad5d325de6cf9c53e1842281205a82ee74ab702a17bd) diff --git a/doc/lightning-listpeers.7.md b/doc/lightning-listpeers.7.md index ab9dbe7a1..6445cff5d 100644 --- a/doc/lightning-listpeers.7.md +++ b/doc/lightning-listpeers.7.md @@ -48,81 +48,81 @@ On success, an object containing **peers** is returned. It is an array of objec - **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") - - **scratch_txid** (txid, optional): The txid we would use if we went onchain now + - **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) - - **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 - - **last_feerate** (string, optional): For inflight opens, the most recent feerate used on the channel open - - **next_feerate** (string, optional): For inflight opens, the next feerate we'll use for the channel open - - **next_fee_step** (u32, optional): For inflight opens, the next feerate step we'll use for the channel open + - **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 + - **last\_feerate** (string, optional): For inflight opens, the most recent feerate used on the channel open + - **next\_feerate** (string, optional): For inflight opens, the next feerate we'll use for the channel open + - **next\_fee\_step** (u32, optional): For inflight opens, the next feerate step we'll use for the channel open - **inflight** (array of objects, optional): Current candidate funding transactions (only for dual-funding): - - **funding_txid** (txid): ID of the funding transaction - - **funding_outnum** (u32): The 0-based output number of the funding transaction which opens the channel + - **funding\_txid** (txid): ID of the funding transaction + - **funding\_outnum** (u32): The 0-based output number of the funding transaction which opens the channel - **feerate** (string): The feerate for this funding transaction in per-1000-weight, with "kpw" appended - - **total_funding_msat** (msat): total amount in the channel - - **our_funding_msat** (msat): amount we have in the channel - - **scratch_txid** (txid): The commitment transaction txid we would use if we went onchain now - - **close_to** (hex, optional): scriptPubkey which we have to close to if we mutual close + - **total\_funding\_msat** (msat): total amount in the channel + - **our\_funding\_msat** (msat): amount we have in the channel + - **scratch\_txid** (txid): The commitment transaction txid we would use if we went onchain now + - **close\_to** (hex, optional): scriptPubkey which we have to close to if we mutual close - **private** (boolean, optional): if False, we will not announce this channel - **closer** (string, optional): Who initiated the channel close (one of "local", "remote") - **funding** (object, optional): - - **local_funds_msat** (msat): Amount of channel we funded - - **remote_funds_msat** (msat): Amount of channel they funded - - **local_msat** (msat, optional): Amount of channel we funded (deprecated) - - **remote_msat** (msat, optional): Amount of channel they funded (deprecated) - - **pushed_msat** (msat, optional): Amount pushed from opener to peer - - **fee_paid_msat** (msat, optional): Amount we paid peer at open - - **fee_rcvd_msat** (msat, optional): Amount we were paid by peer at open - - **to_us_msat** (msat, optional): how much of channel is owed to us - - **min_to_us_msat** (msat, optional): least amount owed to us ever - - **max_to_us_msat** (msat, optional): most amount owed to us ever - - **total_msat** (msat, optional): total amount in the channel - - **fee_base_msat** (msat, optional): amount we charge to use the channel - - **fee_proportional_millionths** (u32, optional): amount we charge to use the channel in parts-per-million - - **dust_limit_msat** (msat, optional): minimum amount for an output on the channel transactions - - **max_total_htlc_in_msat** (msat, optional): max amount accept in a single payment - - **their_reserve_msat** (msat, optional): minimum we insist they keep in channel - - **our_reserve_msat** (msat, optional): minimum they insist we keep in channel - - **spendable_msat** (msat, optional): total we could send through channel - - **receivable_msat** (msat, optional): total peer could send through channel - - **minimum_htlc_in_msat** (msat, optional): the minimum amount HTLC we accept - - **minimum_htlc_out_msat** (msat, optional): the minimum amount HTLC we will send - - **maximum_htlc_out_msat** (msat, optional): the maximum amount HTLC we will send - - **their_to_self_delay** (u32, optional): the number of blocks before they can take their funds if they unilateral close - - **our_to_self_delay** (u32, optional): the number of blocks before we can take our funds if we unilateral close - - **max_accepted_htlcs** (u32, optional): Maximum number of incoming HTLC we will accept at once + - **local\_funds\_msat** (msat): Amount of channel we funded + - **remote\_funds\_msat** (msat): Amount of channel they funded + - **local\_msat** (msat, optional): Amount of channel we funded (deprecated) + - **remote\_msat** (msat, optional): Amount of channel they funded (deprecated) + - **pushed\_msat** (msat, optional): Amount pushed from opener to peer + - **fee\_paid\_msat** (msat, optional): Amount we paid peer at open + - **fee\_rcvd\_msat** (msat, optional): Amount we were paid by peer at open + - **to\_us\_msat** (msat, optional): how much of channel is owed to us + - **min\_to\_us\_msat** (msat, optional): least amount owed to us ever + - **max\_to\_us\_msat** (msat, optional): most amount owed to us ever + - **total\_msat** (msat, optional): total amount in the channel + - **fee\_base\_msat** (msat, optional): amount we charge to use the channel + - **fee\_proportional\_millionths** (u32, optional): amount we charge to use the channel in parts-per-million + - **dust\_limit\_msat** (msat, optional): minimum amount for an output on the channel transactions + - **max\_total\_htlc\_in\_msat** (msat, optional): max amount accept in a single payment + - **their\_reserve\_msat** (msat, optional): minimum we insist they keep in channel + - **our\_reserve\_msat** (msat, optional): minimum they insist we keep in channel + - **spendable\_msat** (msat, optional): total we could send through channel + - **receivable\_msat** (msat, optional): total peer could send through channel + - **minimum\_htlc\_in\_msat** (msat, optional): the minimum amount HTLC we accept + - **minimum\_htlc\_out\_msat** (msat, optional): the minimum amount HTLC we will send + - **maximum\_htlc\_out\_msat** (msat, optional): the maximum amount HTLC we will send + - **their\_to\_self\_delay** (u32, optional): the number of blocks before they can take their funds if they unilateral close + - **our\_to\_self\_delay** (u32, optional): the number of blocks before we can take our funds if we unilateral close + - **max\_accepted\_htlcs** (u32, optional): Maximum number of incoming HTLC we will accept at once - **alias** (object, optional): - **local** (short_channel_id, optional): An alias assigned by this node to this channel, used for outgoing payments - **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: + - **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): - Billboard log of significant changes - - **in_payments_offered** (u64, optional): Number of incoming payment attempts - - **in_offered_msat** (msat, optional): Total amount of incoming payment attempts - - **in_payments_fulfilled** (u64, optional): Number of successful incoming payment attempts - - **in_fulfilled_msat** (msat, optional): Total amount of successful incoming payment attempts - - **out_payments_offered** (u64, optional): Number of outgoing payment attempts - - **out_offered_msat** (msat, optional): Total amount of outgoing payment attempts - - **out_payments_fulfilled** (u64, optional): Number of successful outgoing payment attempts - - **out_fulfilled_msat** (msat, optional): Total amount of successful outgoing payment attempts + - **in\_payments\_offered** (u64, optional): Number of incoming payment attempts + - **in\_offered\_msat** (msat, optional): Total amount of incoming payment attempts + - **in\_payments\_fulfilled** (u64, optional): Number of successful incoming payment attempts + - **in\_fulfilled\_msat** (msat, optional): Total amount of successful incoming payment attempts + - **out\_payments\_offered** (u64, optional): Number of outgoing payment attempts + - **out\_offered\_msat** (msat, optional): Total amount of outgoing payment attempts + - **out\_payments\_fulfilled** (u64, optional): Number of successful outgoing payment attempts + - **out\_fulfilled\_msat** (msat, optional): Total amount of successful outgoing payment attempts - **htlcs** (array of objects, optional): current HTLCs in this channel: - **direction** (string): Whether it came from peer, or is going to peer (one of "in", "out") - **id** (u64): Unique ID for this htlc on this channel in this direction - - **amount_msat** (msat): Amount send/received for this HTLC + - **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) - - **local_trimmed** (boolean, optional): if this is too small to enforce onchain (always *true*) + - **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": @@ -133,43 +133,43 @@ On success, an object containing **peers** is returned. It is an array of objec - **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: + If **close\_to** is present: - - **close_to_addr** (string, optional): The bitcoin address we will close to + - **close\_to\_addr** (string, optional): The bitcoin address we will close to - If **scratch_txid** is present: + If **scratch\_txid** is present: - - **last_tx_fee_msat** (msat): fee attached to this the current tx + - **last\_tx\_fee\_msat** (msat): fee attached to this the current tx - If **short_channel_id** is present: + If **short\_channel\_id** is present: - **direction** (u32): 0 if we're the lesser node_id, 1 if we're the greater If **inflight** is present: - - **initial_feerate** (string): The feerate for the initial funding transaction in per-1000-weight, with "kpw" appended - - **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 + - **initial\_feerate** (string): The feerate for the initial funding transaction in per-1000-weight, with "kpw" appended + - **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") If **type** is "SKIPPED": - - **num_skipped** (u32): number of deleted/omitted entries + - **num\_skipped** (u32): number of deleted/omitted entries If **type** is "BROKEN", "UNUSUAL", "INFO" or "DEBUG": - **time** (string): UNIX timestamp with 9 decimal places - **source** (string): The particular logbook this was found in - **log** (string): The actual log message - - **node_id** (pubkey): The peer this is associated with + - **node\_id** (pubkey): The peer this is associated with 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 - **log** (string): The actual log message - - **node_id** (pubkey): The peer this is associated with + - **node\_id** (pubkey): The peer this is associated with - **data** (hex): The IO which occurred If **connected** is *true*: @@ -177,7 +177,7 @@ If **connected** is *true*: - **netaddr** (array of strings): A single entry array: - address, e.g. 1.2.3.4:1234 - **features** (hex): bitmap of BOLT #9 features from peer's INIT message - - **remote_addr** (string, optional): The public IPv4/6 address the peer sees us from, e.g. 1.2.3.4:1234 + - **remote\_addr** (string, optional): The public IPv4/6 address the peer sees us from, e.g. 1.2.3.4:1234 [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -399,4 +399,4 @@ Main web site: Lightning RFC site (BOLT \#9): -[comment]: # ( SHA256STAMP:c99d53a4b3ada3bae6972f97eea600b7a039958313772cd6370eec818c2e4a99) +[comment]: # ( SHA256STAMP:e80b24123fdeea4eacda71bb7d824b9234bf17c68239ebf7915d2ab747c58fdc) diff --git a/doc/lightning-listsendpays.7.md b/doc/lightning-listsendpays.7.md index bf36a15e1..09d873857 100644 --- a/doc/lightning-listsendpays.7.md +++ b/doc/lightning-listsendpays.7.md @@ -26,12 +26,12 @@ 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 -- **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 (one of "pending", "failed", "complete") -- **created_at** (u64): the UNIX timestamp showing when this payment was initiated -- **amount_sent_msat** (msat): The amount sent +- **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 -- **amount_msat** (msat, optional): The amount delivered to destination (if known) +- **amount\_msat** (msat, optional): The amount delivered to destination (if known) - **destination** (pubkey, optional): the final destination of the payment if known - **label** (string, optional): the label, if given to sendpay - **bolt11** (string, optional): the bolt11 string (if pay supplied one) @@ -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:0a901adcb1b30622fdab38aa39a5073087488b2ad446fb1b9efdc791ac954591) +[comment]: # ( SHA256STAMP:c5d98a40542cb43881bea138bf3da404eba5bc73ed9e0acc8343e0423cc9c602) diff --git a/doc/lightning-listtransactions.7.md b/doc/lightning-listtransactions.7.md index f02023e8a..7aae61bb6 100644 --- a/doc/lightning-listtransactions.7.md +++ b/doc/lightning-listtransactions.7.md @@ -41,7 +41,7 @@ On success, an object containing **transactions** is returned. It is an array o - **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 + - **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) @@ -105,4 +105,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:9cb66a3febe7c37e1892e2fc9f486a6e896e9406a1d9514e5283d4c5f8f6b707) +[comment]: # ( SHA256STAMP:e1f4e86db0fd48d695ad0c30ace5dea6f40e1502847a258ef9580e30b52712f7) diff --git a/doc/lightning-makesecret.7.md b/doc/lightning-makesecret.7.md index 532a16c0c..283b204cc 100644 --- a/doc/lightning-makesecret.7.md +++ b/doc/lightning-makesecret.7.md @@ -42,4 +42,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:c011f9e0b3ebd79b4172daf518d216dda9149c86e23918d0fe979f83b09fd117) +[comment]: # ( SHA256STAMP:47f98983bc74e75b5e9ad55ebc84771a7819717e8e41f2398d0e0227a8670044) diff --git a/doc/lightning-multifundchannel.7.md b/doc/lightning-multifundchannel.7.md index 0b60d6e59..93a8190c6 100644 --- a/doc/lightning-multifundchannel.7.md +++ b/doc/lightning-multifundchannel.7.md @@ -102,11 +102,11 @@ 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 -- **channel_ids** (array of objects): +- **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") @@ -159,4 +159,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:19cdc2bffdec420ae1fc48591af22a49d2d85104d6a14dcc166909f23e86ecfa) +[comment]: # ( SHA256STAMP:d5af7087b3e31d80df0ce5c09c55b51141bfbf158802d7f5cd82caa21110453e) diff --git a/doc/lightning-multiwithdraw.7.md b/doc/lightning-multiwithdraw.7.md index 0d81e2308..b5a63c0fa 100644 --- a/doc/lightning-multiwithdraw.7.md +++ b/doc/lightning-multiwithdraw.7.md @@ -72,4 +72,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:e2b8a4f88c61ef7823e1b8541719d2d5ccb05181116785ac8e9be02816d65c0d) +[comment]: # ( SHA256STAMP:3c79c00a7115ea353d0eb27b8fb6db0203dbd40226291fc0b5f57bc29bd8acc8) diff --git a/doc/lightning-newaddr.7.md b/doc/lightning-newaddr.7.md index 98b8d4ed3..6ac38029e 100644 --- a/doc/lightning-newaddr.7.md +++ b/doc/lightning-newaddr.7.md @@ -58,4 +58,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:7bf0734c6f42effdd936443ddc7eace065616bb345efcb3d76850fe7d07052c0) +[comment]: # ( SHA256STAMP:0d4165582ac09b6f130bd6910873f5073ab7ff852711fa1fb45177726a978899) diff --git a/doc/lightning-notifications.7.md b/doc/lightning-notifications.7.md index 9d03be3bf..fefa8de8a 100644 --- a/doc/lightning-notifications.7.md +++ b/doc/lightning-notifications.7.md @@ -102,4 +102,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:bdc678495e0e0e626cdc71e73e8179dc8350de9862c4458933607fa62d8a16f7) +[comment]: # ( SHA256STAMP:4d9f888d10faca2bf94d1b52510cf21fbeebae4efda0946f03d04b0ef4bc88a2) diff --git a/doc/lightning-offer.7.md b/doc/lightning-offer.7.md index 01675a63e..8818c6f3c 100644 --- a/doc/lightning-offer.7.md +++ b/doc/lightning-offer.7.md @@ -97,11 +97,11 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **offer_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) +- **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 -- **bolt12_unsigned** (string): the bolt12 encoding of the offer, without a signature +- **bolt12\_unsigned** (string): the bolt12 encoding of the offer, without a signature - **used** (boolean): True if an associated invoice has been paid - **created** (boolean): false if the offer already existed - **label** (string, optional): the (optional) user-specified label @@ -135,4 +135,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:b4a362fe13f683f82bda5a293805d5d506719382c846ad363c357fef4a5cef7c) +[comment]: # ( SHA256STAMP:62546f8bd62788615d20aa1881fc55328bea3fd3793d4395984972cbf33c7219) diff --git a/doc/lightning-offerout.7.md b/doc/lightning-offerout.7.md index 5430a8118..9d632356e 100644 --- a/doc/lightning-offerout.7.md +++ b/doc/lightning-offerout.7.md @@ -56,11 +56,11 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **offer_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) +- **offer\_id** (hex): the id of this offer (merkle hash of non-signature fields) (always 64 characters) - **active** (boolean): whether this will pay a matching incoming invoice (always *true*) -- **single_use** (boolean): whether this expires as soon as it's paid out (always *true*) +- **single\_use** (boolean): whether this expires as soon as it's paid out (always *true*) - **bolt12** (string): the bolt12 encoding of the offer -- **bolt12_unsigned** (string): the bolt12 encoding of the offer, without a signature +- **bolt12\_unsigned** (string): the bolt12 encoding of the offer, without a signature - **used** (boolean): True if an incoming invoice has been paid (always *false*) - **created** (boolean): false if the offer already existed - **label** (string, optional): the (optional) user-specified label @@ -100,4 +100,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1aeec6f596cae41738c39a12c02ee1c899569953f5be9378a06c9911082de1db) +[comment]: # ( SHA256STAMP:e13d4ef2c90ce11239857da6cab6489ddbaae473b31f2f10d8e5d1cd46e952a3) diff --git a/doc/lightning-openchannel_abort.7.md b/doc/lightning-openchannel_abort.7.md index e088c1d6f..a88ed1045 100644 --- a/doc/lightning-openchannel_abort.7.md +++ b/doc/lightning-openchannel_abort.7.md @@ -22,8 +22,8 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **channel_id** (hex): the channel id of the aborted channel (always 64 characters) -- **channel_canceled** (boolean): whether this is completely canceled (there may be remaining in-flight transactions) +- **channel\_id** (hex): the channel id of the aborted channel (always 64 characters) +- **channel\_canceled** (boolean): whether this is completely canceled (there may be remaining in-flight transactions) - **reason** (string): usually "Abort requested", but if it happened to fail at the same time it could be different [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -55,4 +55,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:ea00b648aba89bc585ae67bfcc821dabda2c2ffea6b0dffab80ba46edaf2e3ba) +[comment]: # ( SHA256STAMP:b02ee781aadf998bf031e8e797622ae9a6307c6c3a0c6d1fdaa3760cbbc6c0c6) diff --git a/doc/lightning-openchannel_bump.7.md b/doc/lightning-openchannel_bump.7.md index 216067372..2e9846de3 100644 --- a/doc/lightning-openchannel_bump.7.md +++ b/doc/lightning-openchannel_bump.7.md @@ -38,10 +38,10 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **channel_id** (hex): the channel id of the channel (always 64 characters) +- **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* +- **commitments\_secured** (boolean): whether the *psbt* is complete (always *false*) +- **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:ba49815f17a30831671c7253051b15192c55882b524f4999ae0928829bd3fff7) +[comment]: # ( SHA256STAMP:40407dc22bff8d157f1f87683e8b97ab6a0495ec1454e5ef05d4a050eb10dfc8) diff --git a/doc/lightning-openchannel_init.7.md b/doc/lightning-openchannel_init.7.md index 7c48a3b1f..2b9916ce5 100644 --- a/doc/lightning-openchannel_init.7.md +++ b/doc/lightning-openchannel_init.7.md @@ -53,10 +53,10 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **channel_id** (hex): the channel id of the channel (always 64 characters) +- **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* +- **commitments\_secured** (boolean): whether the *psbt* is complete (always *false*) +- **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:1dad89ace6e2434e6f1baeed18c4813799a3e560708de28c9ef2b34120dc903e) +[comment]: # ( SHA256STAMP:f78d8a4c015cad1e5065d8ae23375aa33bd9f318cd526ee88f65cccb6cda6ad9) diff --git a/doc/lightning-openchannel_signed.7.md b/doc/lightning-openchannel_signed.7.md index 5576e110b..9111eab70 100644 --- a/doc/lightning-openchannel_signed.7.md +++ b/doc/lightning-openchannel_signed.7.md @@ -32,7 +32,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **channel_id** (hex): the channel id of the channel (always 64 characters) +- **channel\_id** (hex): the channel id of the channel (always 64 characters) - **tx** (hex): the funding transaction - **txid** (txid): The txid of the **tx** @@ -67,4 +67,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:35d894ae39df25214656482a1680639fb2660783b4f95d1a042ae74c716c595f) +[comment]: # ( SHA256STAMP:7e31569a2b356664ff818c9afc8347aa2dcd1ba128ff9a5f74fda6f441aa5904) diff --git a/doc/lightning-openchannel_update.7.md b/doc/lightning-openchannel_update.7.md index 73b038cc8..f05b35060 100644 --- a/doc/lightning-openchannel_update.7.md +++ b/doc/lightning-openchannel_update.7.md @@ -31,11 +31,11 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **channel_id** (hex): the channel id of the channel (always 64 characters) +- **channel\_id** (hex): the channel id of the channel (always 64 characters) - **psbt** (string): the PSBT of the funding transaction -- **commitments_secured** (boolean): whether the *psbt* is complete (if true, sign *psbt* and call `openchannel_signed` to complete the channel open) -- **funding_outnum** (u32): The index of the funding output in the psbt -- **close_to** (hex, optional): scriptPubkey which we have to close to if we mutual close +- **commitments\_secured** (boolean): whether the *psbt* is complete (if true, sign *psbt* and call `openchannel_signed` to complete the channel open) +- **funding\_outnum** (u32): The index of the funding output in the psbt +- **close\_to** (hex, optional): scriptPubkey which we have to close to if we mutual close [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -72,4 +72,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:92a20c9731a38c03189d7396e196c0439ef4311407529542b41af967e365c43b) +[comment]: # ( SHA256STAMP:b1a1c34c05ff7f47d9ff790eb17d8df4ccfcfabf8471958fec8bf97ddebfc45d) diff --git a/doc/lightning-parsefeerate.7.md b/doc/lightning-parsefeerate.7.md index af34e7ce0..139fb704a 100644 --- a/doc/lightning-parsefeerate.7.md +++ b/doc/lightning-parsefeerate.7.md @@ -44,4 +44,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:9c3b23f12660f53e954687b1fcb1b4bfc629bd0714363c0f21c44958c499fd51) +[comment]: # ( SHA256STAMP:cf5309537ecb4aa57a6a74e607d1c0d581df22c43aa5d62a90d4eb43e63237f0) diff --git a/doc/lightning-pay.7.md b/doc/lightning-pay.7.md index 8fc84ed79..f7f6add17 100644 --- a/doc/lightning-pay.7.md +++ b/doc/lightning-pay.7.md @@ -95,18 +95,18 @@ 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) -- **created_at** (number): the UNIX timestamp showing when this payment was initiated +- **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 -- **amount_sent_msat** (msat): Total amount we sent (including fees) +- **amount\_msat** (msat): Amount the recipient received +- **amount\_sent\_msat** (msat): Total amount we sent (including fees) - **status** (string): status of payment (one of "complete", "pending", "failed") - **destination** (pubkey, optional): the final destination of the payment The following warnings may also be returned: -- **warning_partial_completion**: Not all parts of a multi-part payment have completed +- **warning\_partial\_completion**: Not all parts of a multi-part payment have completed [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -167,4 +167,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:13926b44871e0a8d805eed668c371401a97f112a50481d49838975dcb7593329) +[comment]: # ( SHA256STAMP:24e27fab68719a3d6bae0e845cba95223d8c18a4f4c9a045225898cbd6abc2ef) diff --git a/doc/lightning-ping.7.md b/doc/lightning-ping.7.md index e7aeeb5c8..8f03facb2 100644 --- a/doc/lightning-ping.7.md +++ b/doc/lightning-ping.7.md @@ -70,4 +70,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:8fd43121667f09f763914b27e53b8aecd855e1a611681f34de5e19f4ed13aabe) +[comment]: # ( SHA256STAMP:6c9c92f2387bb0108495d45cf2919203a805bd78db8a2d2a88ada80e881c04e3) diff --git a/doc/lightning-plugin.7.md b/doc/lightning-plugin.7.md index ae123f647..1579bb5b1 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:f19b2a53065fd2e571593330112e30e99845b88acbd58237d25c94c224c64686) +[comment]: # ( SHA256STAMP:17dc5bb65dc652ab4dee5fda0c3c9a909edc931c357773cbc988aede3d9fb49a) diff --git a/doc/lightning-reserveinputs.7.md b/doc/lightning-reserveinputs.7.md index 8a604e7b6..98e161d65 100644 --- a/doc/lightning-reserveinputs.7.md +++ b/doc/lightning-reserveinputs.7.md @@ -29,9 +29,9 @@ On success, an object containing **reservations** is returned. It is an array o - **txid** (txid): the transaction id - **vout** (u32): the output number which was reserved -- **was_reserved** (boolean): whether the input was already reserved +- **was\_reserved** (boolean): whether the input was already reserved - **reserved** (boolean): whether the input is now reserved (always *true*) -- **reserved_to_block** (u32): what blockheight the reservation will expire +- **reserved\_to\_block** (u32): what blockheight the reservation will expire [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -64,4 +64,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:14873cda2c903c231c6707234b6b161b3cabf84ebe48c274e4c7f5f980207d13) +[comment]: # ( SHA256STAMP:f0aed27b4a1de3f76f62ba9882df18c596e017491ff04614666ce05bc8bb2535) diff --git a/doc/lightning-sendcustommsg.7.md b/doc/lightning-sendcustommsg.7.md index 1d8cf01b1..436183d08 100644 --- a/doc/lightning-sendcustommsg.7.md +++ b/doc/lightning-sendcustommsg.7.md @@ -69,4 +69,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:ad5ceedef94690f4332e8b7b0fe5b639df6f38c6776d3c3be6f6f833f1eb954a) +[comment]: # ( SHA256STAMP:a4314cf59d13dee507086aa5353a1456238a4e57e4a166bdd0a2fa66a4be3736) diff --git a/doc/lightning-sendinvoice.7.md b/doc/lightning-sendinvoice.7.md index 3a4ff7370..37f27df9a 100644 --- a/doc/lightning-sendinvoice.7.md +++ b/doc/lightning-sendinvoice.7.md @@ -43,18 +43,18 @@ 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 +- **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable +- **amount\_msat** (msat, optional): the amount required to pay this invoice - **bolt12** (string, optional): the BOLT12 string 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) - - **paid_at** (u64): UNIX timestamp of when it was paid - - **payment_preimage** (hex): proof of payment (always 64 characters) + - **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) + - **paid\_at** (u64): UNIX timestamp of when it was paid + - **payment\_preimage** (hex): proof of payment (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -80,4 +80,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:2eb62b2da6067b6d6b2f5585d521600b722a45d7a6c74da882891fd5aa00bc77) +[comment]: # ( SHA256STAMP:adff5e5f321dc5245067f4ed6ad9a404f5f4a783ae5ab2715a9064cbd570f7f1) diff --git a/doc/lightning-sendonion.7.md b/doc/lightning-sendonion.7.md index d2d181963..8bc0152ee 100644 --- a/doc/lightning-sendonion.7.md +++ b/doc/lightning-sendonion.7.md @@ -94,11 +94,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 -- **amount_msat** (msat, optional): The amount delivered to destination (if known) +- **created\_at** (u64): the UNIX timestamp showing when this payment was initiated +- **amount\_sent\_msat** (msat): The amount sent +- **amount\_msat** (msat, optional): The amount delivered to destination (if known) - **destination** (pubkey, optional): the final destination of the payment if known - **label** (string, optional): the label, if given to sendpay - **bolt11** (string, optional): the bolt11 string (if supplied) @@ -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/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md -[comment]: # ( SHA256STAMP:84195897945d1b1f8b4aabff611ded8198aa7a1aa959fcf903ec7bd3de1d1ebf) +[comment]: # ( SHA256STAMP:f98e537a7fe2e1b3f9bc10366317c1f1663e0fc6c6618564c38cc10181161658) diff --git a/doc/lightning-sendonionmessage.7.md b/doc/lightning-sendonionmessage.7.md index d045fbbd5..1549d25d5 100644 --- a/doc/lightning-sendonionmessage.7.md +++ b/doc/lightning-sendonionmessage.7.md @@ -43,4 +43,4 @@ Main web site: [bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md -[comment]: # ( SHA256STAMP:267a098af220600b0c3ed3e50e2704c24d7330c428fd80aaa22d0aec59a4efe1) +[comment]: # ( SHA256STAMP:8e7f2c4372f12ee7f79df114e9ac9539ad6b19821e6c808e47d1ba9f7981e8ea) diff --git a/doc/lightning-sendpay.7.md b/doc/lightning-sendpay.7.md index 11b0db655..b834bd391 100644 --- a/doc/lightning-sendpay.7.md +++ b/doc/lightning-sendpay.7.md @@ -69,12 +69,12 @@ 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 +- **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 -- **amount_msat** (msat, optional): The amount delivered to destination (if known) +- **amount\_msat** (msat, optional): The amount delivered to destination (if known) - **destination** (pubkey, optional): the final destination of the payment if known - **label** (string, optional): the *label*, if given to sendpay - **partid** (u64, optional): the *partid*, if given to sendpay @@ -83,7 +83,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": @@ -142,4 +142,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:08f06099569549e627f675c647aba1b7576c8662c4ad6906ca1ff56062fc9afc) +[comment]: # ( SHA256STAMP:9b56a1eedebe426c6ed6018fa92f963884b8aea2787d602e1e413c2f79884ce0) diff --git a/doc/lightning-sendpsbt.7.md b/doc/lightning-sendpsbt.7.md index 42baad2d4..2dd0cfe97 100644 --- a/doc/lightning-sendpsbt.7.md +++ b/doc/lightning-sendpsbt.7.md @@ -66,4 +66,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:e2b8a4f88c61ef7823e1b8541719d2d5ccb05181116785ac8e9be02816d65c0d) +[comment]: # ( SHA256STAMP:3c79c00a7115ea353d0eb27b8fb6db0203dbd40226291fc0b5f57bc29bd8acc8) diff --git a/doc/lightning-setchannel.7.md b/doc/lightning-setchannel.7.md index 1ee6b4171..98f93ed3c 100644 --- a/doc/lightning-setchannel.7.md +++ b/doc/lightning-setchannel.7.md @@ -68,16 +68,16 @@ 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) -- **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) +- **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) - 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 + - **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 [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -107,4 +107,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:f133a8053cf5b0d5f6d8823c62fceda134af24c43411307b764db3f3e2f4d261) +[comment]: # ( SHA256STAMP:28a16d5b1392dd72f9d7a040ce8e37907114fbaf1aed106314fab3f9126afba2) diff --git a/doc/lightning-setchannelfee.7.md b/doc/lightning-setchannelfee.7.md index ddd6a006a..30c39072d 100644 --- a/doc/lightning-setchannelfee.7.md +++ b/doc/lightning-setchannelfee.7.md @@ -52,9 +52,9 @@ On success, an object is returned, containing: - **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:165a54776eba3c727efc309a2e9d22bec204a4bd909b002b83082a97aa29c400) +[comment]: # ( SHA256STAMP:bd5af1e2190426012541af0eb582ca22461fb38ec70c7a235f4e7e92f7fc565d) diff --git a/doc/lightning-signmessage.7.md b/doc/lightning-signmessage.7.md index 8fa4891eb..d94b2c398 100644 --- a/doc/lightning-signmessage.7.md +++ b/doc/lightning-signmessage.7.md @@ -42,4 +42,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:163cdae723e4b50715255b233ff2a817481ccff0b778d56c2ed0b88bd0cdc8a6) +[comment]: # ( SHA256STAMP:cf7372c221ee6846fb8e7aca3e841b687e4b4f21262a0cc8a430b375e17e70cb) diff --git a/doc/lightning-signpsbt.7.md b/doc/lightning-signpsbt.7.md index fea7c48f0..197a219da 100644 --- a/doc/lightning-signpsbt.7.md +++ b/doc/lightning-signpsbt.7.md @@ -41,7 +41,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **signed_psbt** (string): The fully signed PSBT +- **signed\_psbt** (string): The fully signed PSBT [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -72,4 +72,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:9604daeee442beb457ce32f5f66fceb337e92bf7a613f8ca2e81214c5d3200db) +[comment]: # ( SHA256STAMP:79690a411b6db6801192bd462e2cf2c627a0a10e65a326e2801dc0e35e734714) diff --git a/doc/lightning-stop.7.md b/doc/lightning-stop.7.md index d82b83098..198d3eb0b 100644 --- a/doc/lightning-stop.7.md +++ b/doc/lightning-stop.7.md @@ -42,4 +42,4 @@ RESOURCES --------- Main web site: -[comment]: # ( SHA256STAMP:2af4e0809f45c5a980e95a85d95295df42d9fa25660315fc73e6b38c193a91ce) +[comment]: # ( SHA256STAMP:cd6076ec79da278cca6f68be0560d71dc1b46651c3db48d81aafe1d19da0ff96) diff --git a/doc/lightning-txdiscard.7.md b/doc/lightning-txdiscard.7.md index 7cf342aea..51f3da93b 100644 --- a/doc/lightning-txdiscard.7.md +++ b/doc/lightning-txdiscard.7.md @@ -18,7 +18,7 @@ RETURN VALUE [comment]: # (GENERATE-FROM-SCHEMA-START) On success, an object is returned, containing: -- **unsigned_tx** (hex): the unsigned transaction +- **unsigned\_tx** (hex): the unsigned transaction - **txid** (txid): the transaction id of *unsigned_tx* [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -45,4 +45,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:79152df2e06a1da8e6da7693b967b5e0187fd0281418839048c7453acac1c839) +[comment]: # ( SHA256STAMP:d763d6dda590b36227f606a404223327147606b495a20926d14a0f8444effdd7) diff --git a/doc/lightning-txprepare.7.md b/doc/lightning-txprepare.7.md index b58348045..7cb6f754c 100644 --- a/doc/lightning-txprepare.7.md +++ b/doc/lightning-txprepare.7.md @@ -56,7 +56,7 @@ RETURN VALUE On success, an object is returned, containing: - **psbt** (string): the PSBT representing the unsigned transaction -- **unsigned_tx** (hex): 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. [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -85,4 +85,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1b5693f74931f9a5746415a81268bdbd229e88250498b6ff86e3a76f8f2991c3) +[comment]: # ( SHA256STAMP:d0570b649a356bb7575da21dfe2f6287fe0a0eac388411470fa22897f7175b83) diff --git a/doc/lightning-txsend.7.md b/doc/lightning-txsend.7.md index 6ebfe5c8c..d020c4f5a 100644 --- a/doc/lightning-txsend.7.md +++ b/doc/lightning-txsend.7.md @@ -45,4 +45,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:5ae95391f068ecafbb0fb742454ea4bf31e1cd47b56f7a82120f2b5b08aea070) +[comment]: # ( SHA256STAMP:8a96f2a5dd68a060602176385238fc7a9255928eef6d5b7f68916eaeb60428f3) diff --git a/doc/lightning-unreserveinputs.7.md b/doc/lightning-unreserveinputs.7.md index 6665a3c14..82ddb5831 100644 --- a/doc/lightning-unreserveinputs.7.md +++ b/doc/lightning-unreserveinputs.7.md @@ -26,12 +26,12 @@ On success, an object containing **reservations** is returned. It is an array o - **txid** (txid): the transaction id - **vout** (u32): the output number which was reserved -- **was_reserved** (boolean): whether the input was already reserved (usually `true`) +- **was\_reserved** (boolean): whether the input was already reserved (usually `true`) - **reserved** (boolean): whether the input is now reserved (may still be `true` if it was reserved for a long time) If **reserved** is *true*: - - **reserved_to_block** (u32): what blockheight the reservation will expire + - **reserved\_to\_block** (u32): what blockheight the reservation will expire [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -55,4 +55,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:9952e49efe40455558a4f1660e5e823570308c92c1762e74581ca5596961c7c6) +[comment]: # ( SHA256STAMP:d5ec7b9dba4387f8f1c59f1d97fe00cc8abcab793c0bb23f3bc32b02b7e2e882) diff --git a/doc/lightning-utxopsbt.7.md b/doc/lightning-utxopsbt.7.md index deaf5b74c..0be62bad7 100644 --- a/doc/lightning-utxopsbt.7.md +++ b/doc/lightning-utxopsbt.7.md @@ -47,16 +47,16 @@ RETURN VALUE 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) +- **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) - **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 - - **was_reserved** (boolean): Whether this output was previously reserved + - **was\_reserved** (boolean): Whether this output was previously reserved - **reserved** (boolean): Whether this output is now reserved (always *true*) - - **reserved_to_block** (u32): The blockheight the reservation will expire + - **reserved\_to\_block** (u32): The blockheight the reservation will expire [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -100,4 +100,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:1ccbb9c0a0d791e155ebc027465b908c3b2d5f9bd56eba7f5d22003c8e8172e0) +[comment]: # ( SHA256STAMP:0fa67418b5d62dc8dd0ccdbda4113da73a3d7761e23c2ad697a533783c43c37d) diff --git a/doc/lightning-waitanyinvoice.7.md b/doc/lightning-waitanyinvoice.7.md index 2e7d45280..cc6859b7b 100644 --- a/doc/lightning-waitanyinvoice.7.md +++ b/doc/lightning-waitanyinvoice.7.md @@ -38,19 +38,19 @@ 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 +- **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable +- **amount\_msat** (msat, optional): the amount required to pay this invoice - **bolt11** (string, optional): the BOLT11 string (always present unless *bolt12* is) - **bolt12** (string, optional): the BOLT12 string (always present unless *bolt11* is) 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) - - **paid_at** (u64): UNIX timestamp of when it was paid - - **payment_preimage** (secret): proof of payment (always 64 characters) + - **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) + - **paid\_at** (u64): UNIX timestamp of when it was paid + - **payment\_preimage** (secret): proof of payment (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -75,4 +75,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:ce034f1801260480032a98348aae928055f3d9edf12f45cefcd8b6007289ff83) +[comment]: # ( SHA256STAMP:016afebade3ee5a7ac5abbd125f8db78f6c8b41f0e510c8f4c3b6a385e6f3a26) diff --git a/doc/lightning-waitblockheight.7.md b/doc/lightning-waitblockheight.7.md index ef57b6c1d..f773a5178 100644 --- a/doc/lightning-waitblockheight.7.md +++ b/doc/lightning-waitblockheight.7.md @@ -39,4 +39,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:7db14bcda8226b184a2cdccb41e0db717d257683bb69b684a61e065af7ab076d) +[comment]: # ( SHA256STAMP:4419a83c7852353e07eaa8ac3e6786c6b1d714a9a3d981fc78adfe4a73008514) diff --git a/doc/lightning-waitinvoice.7.md b/doc/lightning-waitinvoice.7.md index 6ec5f86eb..94207e966 100644 --- a/doc/lightning-waitinvoice.7.md +++ b/doc/lightning-waitinvoice.7.md @@ -20,19 +20,19 @@ 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 +- **expires\_at** (u64): UNIX timestamp of when it will become / became unpayable +- **amount\_msat** (msat, optional): the amount required to pay this invoice - **bolt11** (string, optional): the BOLT11 string (always present unless *bolt12* is) - **bolt12** (string, optional): the BOLT12 string (always present unless *bolt11* is) 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) - - **paid_at** (u64): UNIX timestamp of when it was paid - - **payment_preimage** (secret): proof of payment (always 64 characters) + - **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) + - **paid\_at** (u64): UNIX timestamp of when it was paid + - **payment\_preimage** (secret): proof of payment (always 64 characters) [comment]: # (GENERATE-FROM-SCHEMA-END) @@ -60,4 +60,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:ce034f1801260480032a98348aae928055f3d9edf12f45cefcd8b6007289ff83) +[comment]: # ( SHA256STAMP:016afebade3ee5a7ac5abbd125f8db78f6c8b41f0e510c8f4c3b6a385e6f3a26) diff --git a/doc/lightning-waitsendpay.7.md b/doc/lightning-waitsendpay.7.md index d3d07631c..0cd670e3b 100644 --- a/doc/lightning-waitsendpay.7.md +++ b/doc/lightning-waitsendpay.7.md @@ -36,12 +36,12 @@ 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 +- **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 -- **amount_msat** (msat, optional): The amount delivered to destination (if known) +- **amount\_msat** (msat, optional): The amount delivered to destination (if known) - **destination** (pubkey, optional): the final destination of the payment if known - **label** (string, optional): the label, if given to sendpay - **partid** (u64, optional): the *partid*, if given to sendpay @@ -50,7 +50,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) @@ -103,4 +103,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:470c164c81adea9053cf276b92c3faf2d0fc4937c747a4c2d06524c601afd1c3) +[comment]: # ( SHA256STAMP:30601f9dab9b0168e7db387cdd9d6750116f9adad8f125f0bac507a79f9bcf67) diff --git a/doc/lightning-withdraw.7.md b/doc/lightning-withdraw.7.md index 0e95f1368..74301e971 100644 --- a/doc/lightning-withdraw.7.md +++ b/doc/lightning-withdraw.7.md @@ -74,4 +74,4 @@ RESOURCES Main web site: -[comment]: # ( SHA256STAMP:2d79ddd7910ea1f5b3a1a0a0d9494229fa600c9a1669ce0904a364f550d847dd) +[comment]: # ( SHA256STAMP:bbb1e5637721b3415ff3498d141f9da7d38bd75b297f5c0d262e838314dd2f37) diff --git a/tools/fromschema.py b/tools/fromschema.py index ce818a3b1..b5cbc9100 100755 --- a/tools/fromschema.py +++ b/tools/fromschema.py @@ -69,11 +69,16 @@ def output_range(properties): output(' (one of {})'.format(', '.join([json_value(p) for p in properties['enum']]))) +def fmt_propname(propname): + """Pretty-print format a property name""" + return '**{}**'.format(propname.replace('_', '\\_')) + + def output_member(propname, properties, is_optional, indent, print_type=True, prefix=None): """Generate description line(s) for this member""" if prefix is None: - prefix = '- **{}**'.format(propname) + prefix = '- ' + fmt_propname(propname) output(indent + prefix) # We make them explicitly note if they don't want a type! @@ -179,7 +184,7 @@ def output_members(sub, indent=''): # "required" are fields that simply must be present for r in ifclause['if'].get('required', []): - conditions.append('**{}** is present'.format(r)) + conditions.append(fmt_propname(r) + ' is present') # "properties" are enums of field values for tag, vals in ifclause['if'].get('properties', {}).items(): @@ -187,7 +192,7 @@ def output_members(sub, indent=''): assert 'description' not in vals whichvalues = vals['enum'] - cond = "**{}** is".format(tag) + cond = fmt_propname(tag) + " is" if len(whichvalues) == 1: cond += " {}".format(json_value(whichvalues[0])) else: @@ -229,12 +234,12 @@ def generate_from_schema(schema): output('On success, an empty object is returned.\n') sub = schema elif len(toplevels) == 1 and props[toplevels[0]]['type'] == 'object': - output('On success, an object containing **{}** is returned. It is an object containing:\n\n'.format(toplevels[0])) + output('On success, an object containing {} is returned. It is an object containing:\n\n'.format(fmt_propname(toplevels[0]))) # Don't have a description field here, it's not used. assert 'description' not in toplevels[0] sub = props[toplevels[0]] elif len(toplevels) == 1 and props[toplevels[0]]['type'] == 'array': - output('On success, an object containing **{}** is returned. It is an array of objects, where each object contains:\n\n'.format(toplevels[0])) + output('On success, an object containing {} is returned. It is an array of objects, where each object contains:\n\n'.format(fmt_propname(toplevels[0]))) # Don't have a description field here, it's not used. assert 'description' not in toplevels[0] sub = props[toplevels[0]]['items'] @@ -247,7 +252,7 @@ def generate_from_schema(schema): if warnings: outputs(['\n', 'The following warnings may also be returned:\n\n']) for w, desc in warnings: - output("- **{}**: {}\n".format(w, desc)) + output("- {}: {}\n".format(fmt_propname(w), desc)) # GH markdown rendering gets upset if there isn't a blank line # between a list and the end comment.