doc/schemas: remove unnecessary length restrictions.

If we have a specific type (not just "hex") the length is implied.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2023-01-30 16:54:16 +10:30 committed by Alex Myers
parent 9589ea0240
commit fa127a4071
30 changed files with 71 additions and 127 deletions

View File

@ -34,7 +34,7 @@ RETURN VALUE
On success, an object is returned, containing: On success, an object is returned, containing:
- **label** (string): the label for the invoice - **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
- **status** (string): Whether it has been paid, or can no longer be paid (one of "paid", "expired", "unpaid") - **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** - **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)
@ -44,7 +44,7 @@ On success, an object is returned, containing:
- **pay\_index** (u64, optional): Incrementing id for when this was paid (**status** *paid* only) - **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) - **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) - **paid\_at** (u64, optional): UNIX timestamp of when invoice was paid (**status** *paid* only)
- **payment\_preimage** (secret, optional): the proof of payment: SHA256 of this **payment\_hash** (always 64 characters) - **payment\_preimage** (secret, optional): the proof of payment: SHA256 of this **payment\_hash**
- **local\_offer\_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters) - **local\_offer\_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters)
- **invreq\_payer\_note** (string, optional): the optional *invreq\_payer\_note* from invoice\_request which created this invoice (**experimental-offers** only). - **invreq\_payer\_note** (string, optional): the optional *invreq\_payer\_note* from invoice\_request which created this invoice (**experimental-offers** only).
@ -75,4 +75,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:1da48df402e8ea4fa1e5901d3272dc9d09f32fd62b03cf90393778add281b732) [comment]: # ( SHA256STAMP:fffebe36aa6671261082894e8b1429035c08f797064a60b03e3e9ea10ea71038)

View File

@ -93,7 +93,7 @@ On success, an object is returned, containing:
- **onion** (hex): the onion packet (*onion\_size* bytes) - **onion** (hex): the onion packet (*onion\_size* bytes)
- **shared\_secrets** (array of secrets): one shared secret for each node in the *hops* parameter: - **shared\_secrets** (array of secrets): one shared secret for each node in the *hops* parameter:
- the shared secret with this hop (always 64 characters) - the shared secret with this hop
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -132,4 +132,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:31882493866e2d3fea36ab68e610637609967fc1095bc926da9bdfbd578de08b) [comment]: # ( SHA256STAMP:08d376f24ca65df41645bd82fa8c8d19fa8610fb5e41f252f001845334b68fbb)

View File

@ -28,7 +28,7 @@ Note: The return is the same as an object from lightning-listinvoice(7).
On success, an object is returned, containing: On success, an object is returned, containing:
- **label** (string): Unique label given at creation time - **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
- **status** (string): State of invoice (one of "paid", "expired", "unpaid") - **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 - **bolt11** (string, optional): BOLT11 string
@ -46,7 +46,7 @@ If **status** is "paid":
- **pay\_index** (u64): unique index for this invoice payment - **pay\_index** (u64): unique index for this invoice payment
- **amount\_received\_msat** (msat): how much was actually received - **amount\_received\_msat** (msat): how much was actually received
- **paid\_at** (u64): UNIX timestamp of when payment was received - **paid\_at** (u64): UNIX timestamp of when payment was received
- **payment\_preimage** (secret): SHA256 of this is the *payment\_hash* offered in the invoice (always 64 characters) - **payment\_preimage** (secret): SHA256 of this is the *payment\_hash* offered in the invoice
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -81,4 +81,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:453b05959f4f08b5d7f09d2ba6f5504d8775d3e8a81b7e02b20f755dfe3ded88) [comment]: # ( SHA256STAMP:7135589b2dd43b221132efed8753afd2e3ecc0aa9ad5706753fbd6c5b54c1509)

View File

@ -79,8 +79,8 @@ RETURN VALUE
On success, an object is returned, containing: On success, an object is returned, containing:
- **bolt11** (string): the bolt11 string - **bolt11** (string): the bolt11 string
- **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
- **payment\_secret** (secret): the *payment\_secret* to place in the onion (always 64 characters) - **payment\_secret** (secret): the *payment\_secret* to place in the onion
- **expires\_at** (u64): UNIX timestamp of when invoice expires - **expires\_at** (u64): UNIX timestamp of when invoice expires
The following warnings may also be returned: The following warnings may also be returned:
@ -119,4 +119,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:49fea13084112f78db0e63ad61c1771be94b87d6fa3c34ac77466db638f327cb) [comment]: # ( SHA256STAMP:095393c4a1050a9a458eba1033162e99283019329747a66b6461a5bb13fa7a2f)

View File

@ -70,8 +70,8 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START) [comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing: On success, an object is returned, containing:
- **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**
- **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
- **created\_at** (number): the UNIX timestamp showing when this payment was initiated - **created\_at** (number): the UNIX timestamp showing when this payment was initiated
- **parts** (u32): how many attempts this took - **parts** (u32): how many attempts this took
- **amount\_msat** (msat): Amount the recipient received - **amount\_msat** (msat): Amount the recipient received
@ -118,4 +118,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:41c043374bbe8d916ed6f381efc451c54151ad4de146f397aa0fb317ecbde422) [comment]: # ( SHA256STAMP:388b5d185f053b32176eef14bc659c405f56b4096b7635d2eac38583b0285889)

View File

@ -24,7 +24,7 @@ RETURN VALUE
On success, an object containing **invoices** is returned. It is an array of objects, where each object contains: 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 - **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
- **status** (string): Whether it's paid, unpaid or unpayable (one of "unpaid", "paid", "expired") - **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 - **description** (string, optional): description used in the invoice
@ -39,7 +39,7 @@ If **status** is "paid":
- **pay\_index** (u64): Unique incrementing index for this payment - **pay\_index** (u64): Unique incrementing index for this payment
- **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay)
- **paid\_at** (u64): UNIX timestamp of when it was paid - **paid\_at** (u64): UNIX timestamp of when it was paid
- **payment\_preimage** (secret): proof of payment (always 64 characters) - **payment\_preimage** (secret): proof of payment
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -58,4 +58,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:651c927eb891cd7110124d7a3c472e64fb24299bd3f8216f7cdd7880f8c8821f) [comment]: # ( SHA256STAMP:258d690221dce5a8811f361e59a5c0059190f140e420c65cd37cfd0987efea3a)

View File

@ -36,7 +36,7 @@ On success, an object containing **channels** is returned. It is an array of ob
- **perkb** (u32): Feerate per 1000 virtual bytes - **perkb** (u32): Feerate per 1000 virtual bytes
- **owner** (string, optional): The current subdaemon controlling this connection - **owner** (string, optional): The current subdaemon controlling this connection
- **short\_channel\_id** (short\_channel\_id, optional): The short\_channel\_id (once locked in) - **short\_channel\_id** (short\_channel\_id, optional): The short\_channel\_id (once locked in)
- **channel\_id** (hash, optional): The full channel\_id (funding txid Xored with output number) (always 64 characters) - **channel\_id** (hash, optional): The full channel\_id (funding txid Xored with output number)
- **funding\_txid** (txid, optional): ID of the funding transaction - **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 - **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 - **initial\_feerate** (string, optional): For inflight opens, the first feerate used to initiate the channel open
@ -103,7 +103,7 @@ On success, an object containing **channels** is returned. It is an array of ob
- **id** (u64): Unique ID for this htlc on this channel in this direction - **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 (after which an `in` direction HTLC will be returned to the peer, an `out` returned to us). If this expiry is too close, lightningd(8) will automatically unilaterally close the channel in order to enforce the timeout onchain. - **expiry** (u32): Block this HTLC expires at (after which an `in` direction HTLC will be returned to the peer, an `out` returned to us). If this expiry is too close, lightningd(8) will automatically unilaterally close the channel in order to enforce the timeout onchain.
- **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
- **local\_trimmed** (boolean, optional): If this is too small to enforce onchain; it doesn't appear in the commitment transaction and will not be enforced in a unilateral close. Generally true if the HTLC (after subtracting onchain fees) is below the `dust_limit_msat` for the channel. (always *true*) - **local\_trimmed** (boolean, optional): If this is too small to enforce onchain; it doesn't appear in the commitment transaction and will not be enforced in a unilateral close. Generally true if the HTLC (after subtracting onchain fees) is below the `dust_limit_msat` for the channel. (always *true*)
- **status** (string, optional): set if this HTLC is currently waiting on a hook (and shows what plugin) - **status** (string, optional): set if this HTLC is currently waiting on a hook (and shows what plugin)
@ -191,4 +191,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9): RFC site (BOLT \#9):
<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md> <https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>
[comment]: # ( SHA256STAMP:64f0c002713473b6b8e06fc6b5eba0dc830b98df21f8aa5be9a80052c5b7a7e7) [comment]: # ( SHA256STAMP:4abe4d7c2e43629d536f4ef906c579a36e2636b183692ffee1474a18438ab630)

View File

@ -27,7 +27,7 @@ On success, an object containing **payments** is returned. It is an array of ob
- **id** (u64): unique ID for this payment attempt - **id** (u64): unique ID for this payment attempt
- **groupid** (u64): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash - **groupid** (u64): Grouping key to disambiguate multiple attempts to pay an invoice or the same payment\_hash
- **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment (always 64 characters) - **payment\_hash** (hash): the hash of the *payment\_preimage* which will prove payment
- **status** (string): status of the payment (one of "pending", "failed", "complete") - **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
- **amount\_sent\_msat** (msat): The amount sent - **amount\_sent\_msat** (msat): The amount sent
@ -41,7 +41,7 @@ On success, an object containing **payments** is returned. It is an array of ob
If **status** is "complete": 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**
If **status** is "failed": If **status** is "failed":
@ -65,4 +65,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:c00443620140062eadf4ccdc32f08102d8278c80975437a708e1b4913b6ab85a) [comment]: # ( SHA256STAMP:9de82a239bae09bf777bdb988170c7ec43946ea49c9dfa908430f65d0a42fdbb)

View File

@ -20,7 +20,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START) [comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing: On success, an object is returned, containing:
- **secret** (secret): the pseudorandom key derived from HSM\_secret (always 64 characters) - **secret** (secret): the pseudorandom key derived from HSM\_secret
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -38,4 +38,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:3c8977e48a221ea5354f1affb1ae86b606aca2df4af32bad0a101386a12556a3) [comment]: # ( SHA256STAMP:94f3d533a330909b8f46d03d6a3fdd4c54105a948ee7ffa23ed853d785dd4f60)

View File

@ -96,8 +96,8 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START) [comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing: On success, an object is returned, containing:
- **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**
- **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
- **created\_at** (number): the UNIX timestamp showing when this payment was initiated - **created\_at** (number): the UNIX timestamp showing when this payment was initiated
- **parts** (u32): how many attempts this took - **parts** (u32): how many attempts this took
- **amount\_msat** (msat): Amount the recipient received - **amount\_msat** (msat): Amount the recipient received
@ -168,4 +168,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:6e644d1071a3e0b9f53e67ced3b29702d93849402e3e6893f41db9f4b23da064) [comment]: # ( SHA256STAMP:d220052ef3c013560eb3b4b379a5f5aa5ff4ce719b0bd2f05f0645cfc25804f9)

View File

@ -94,7 +94,7 @@ RETURN VALUE
On success, an object is returned, containing: On success, an object is returned, containing:
- **id** (u64): unique ID for this payment attempt - **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
- **status** (string): status of the payment (could be complete if already sent previously) (one of "pending", "complete") - **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 - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated
- **amount\_sent\_msat** (msat): The amount sent - **amount\_sent\_msat** (msat): The amount sent
@ -107,7 +107,7 @@ On success, an object is returned, containing:
If **status** is "complete": 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**
If **status** is "pending": If **status** is "pending":
@ -135,4 +135,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md [bolt04]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md
[comment]: # ( SHA256STAMP:88fc091802bfa0295ce3b2e445160d2357a66d6501328bdb086498960b2f915d) [comment]: # ( SHA256STAMP:ffc19dc92199d296f1f8bc974923abd76378f361ff68697137b9dab864d65094)

View File

@ -68,7 +68,7 @@ RETURN VALUE
On success, an object is returned, containing: On success, an object is returned, containing:
- **id** (u64): unique ID for this payment attempt - **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
- **status** (string): status of the payment (could be complete if already sent previously) (one of "pending", "complete") - **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 - **created\_at** (u64): the UNIX timestamp showing when this payment was initiated
- **amount\_sent\_msat** (msat): The amount sent - **amount\_sent\_msat** (msat): The amount sent
@ -83,7 +83,7 @@ On success, an object is returned, containing:
If **status** is "complete": 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**
If **status** is "pending": If **status** is "pending":
@ -142,4 +142,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:50657fd6d5bef4f88ae1d38c5ddfe0d42eb67f222d51e90b03354c68c56f7905) [comment]: # ( SHA256STAMP:1cc526944ea1119f507383f58a9c251dff2ca0b86c15675317753328549be78d)

View File

@ -38,7 +38,7 @@ On success, an object is returned, containing:
- **label** (string): unique label supplied at invoice creation - **label** (string): unique label supplied at invoice creation
- **description** (string): description used in the invoice - **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
- **status** (string): Whether it's paid or expired (one of "paid", "expired") - **status** (string): Whether it's paid or expired (one of "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
- **amount\_msat** (msat, optional): the amount required to pay this invoice - **amount\_msat** (msat, optional): the amount required to pay this invoice
@ -50,7 +50,7 @@ If **status** is "paid":
- **pay\_index** (u64): Unique incrementing index for this payment - **pay\_index** (u64): Unique incrementing index for this payment
- **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay)
- **paid\_at** (u64): UNIX timestamp of when it was paid - **paid\_at** (u64): UNIX timestamp of when it was paid
- **payment\_preimage** (secret): proof of payment (always 64 characters) - **payment\_preimage** (secret): proof of payment
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -75,4 +75,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:846510edabc52b21c0ae6482a49e373ebe7feeb4697b6a6f48d85b30351086f2) [comment]: # ( SHA256STAMP:455c57c49af09b9360b8c4a052828ce71f75cb178a63646eb2621e9e9f0faa5a)

View File

@ -20,7 +20,7 @@ On success, an object is returned, containing:
- **label** (string): unique label supplied at invoice creation - **label** (string): unique label supplied at invoice creation
- **description** (string): description used in the invoice - **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
- **status** (string): Whether it's paid or expired (one of "paid", "expired") - **status** (string): Whether it's paid or expired (one of "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
- **amount\_msat** (msat, optional): the amount required to pay this invoice - **amount\_msat** (msat, optional): the amount required to pay this invoice
@ -32,7 +32,7 @@ If **status** is "paid":
- **pay\_index** (u64): Unique incrementing index for this payment - **pay\_index** (u64): Unique incrementing index for this payment
- **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay) - **amount\_received\_msat** (msat): the amount actually received (could be slightly greater than *amount\_msat*, since clients may overpay)
- **paid\_at** (u64): UNIX timestamp of when it was paid - **paid\_at** (u64): UNIX timestamp of when it was paid
- **payment\_preimage** (secret): proof of payment (always 64 characters) - **payment\_preimage** (secret): proof of payment
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -60,4 +60,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:846510edabc52b21c0ae6482a49e373ebe7feeb4697b6a6f48d85b30351086f2) [comment]: # ( SHA256STAMP:455c57c49af09b9360b8c4a052828ce71f75cb178a63646eb2621e9e9f0faa5a)

View File

@ -36,7 +36,7 @@ RETURN VALUE
On success, an object is returned, containing: On success, an object is returned, containing:
- **id** (u64): unique ID for this payment attempt - **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
- **status** (string): status of the payment (always "complete") - **status** (string): status of the payment (always "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
- **amount\_sent\_msat** (msat): The amount sent - **amount\_sent\_msat** (msat): The amount sent
@ -51,7 +51,7 @@ On success, an object is returned, containing:
If **status** is "complete": 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**
[comment]: # (GENERATE-FROM-SCHEMA-END) [comment]: # (GENERATE-FROM-SCHEMA-END)
@ -104,4 +104,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning> Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:6131f1442571e836e38b1570e75639c3d499b4602659a19ad03aa7156d58d949) [comment]: # ( SHA256STAMP:42da651674955a4e839abc7677263fbdda3a62ba3ce7c251b698828d604b0d4c)

View File

@ -24,9 +24,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"amount_msat": { "amount_msat": {
"type": "msat", "type": "msat",
@ -63,9 +61,7 @@
}, },
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
}, },
"local_offer_id": { "local_offer_id": {
"type": "hex", "type": "hex",

View File

@ -16,9 +16,7 @@
"description": "one shared secret for each node in the *hops* parameter", "description": "one shared secret for each node in the *hops* parameter",
"items": { "items": {
"type": "secret", "type": "secret",
"description": "the shared secret with this hop", "description": "the shared secret with this hop"
"maxLength": 64,
"minLength": 64
} }
} }
} }

View File

@ -34,9 +34,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -155,9 +153,7 @@
}, },
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "SHA256 of this is the *payment_hash* offered in the invoice", "description": "SHA256 of this is the *payment_hash* offered in the invoice"
"maxLength": 64,
"minLength": 64
} }
} }
}, },

View File

@ -15,15 +15,11 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"payment_secret": { "payment_secret": {
"type": "secret", "type": "secret",
"description": "the *payment_secret* to place in the onion", "description": "the *payment_secret* to place in the onion"
"maxLength": 64,
"minLength": 64
}, },
"expires_at": { "expires_at": {
"type": "u64", "type": "u64",

View File

@ -14,9 +14,7 @@
"properties": { "properties": {
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
}, },
"destination": { "destination": {
"type": "pubkey", "type": "pubkey",
@ -24,9 +22,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"created_at": { "created_at": {
"type": "number", "type": "number",

View File

@ -28,9 +28,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -120,9 +118,7 @@
}, },
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "proof of payment", "description": "proof of payment"
"maxLength": 64,
"minLength": 64
} }
} }
}, },

View File

@ -77,9 +77,7 @@
}, },
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
"description": "The full channel_id (funding txid Xored with output number)", "description": "The full channel_id (funding txid Xored with output number)"
"minLength": 64,
"maxLength": 64
}, },
"funding_txid": { "funding_txid": {
"type": "txid", "type": "txid",
@ -502,9 +500,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the payment_preimage which will prove payment", "description": "the hash of the payment_preimage which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"local_trimmed": { "local_trimmed": {
"type": "boolean", "type": "boolean",

View File

@ -34,9 +34,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -122,9 +120,7 @@
"bolt12": {}, "bolt12": {},
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
} }
} }
} }

View File

@ -8,9 +8,7 @@
"properties": { "properties": {
"secret": { "secret": {
"type": "secret", "type": "secret",
"description": "the pseudorandom key derived from HSM_secret", "description": "the pseudorandom key derived from HSM_secret"
"maxLength": 64,
"minLength": 64
} }
} }
} }

View File

@ -14,9 +14,7 @@
"properties": { "properties": {
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
}, },
"destination": { "destination": {
"type": "pubkey", "type": "pubkey",
@ -24,9 +22,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"created_at": { "created_at": {
"type": "number", "type": "number",

View File

@ -16,9 +16,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -101,9 +99,7 @@
"partid": {}, "partid": {},
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
} }
} }
} }

View File

@ -20,9 +20,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -110,9 +108,7 @@
"bolt12": {}, "bolt12": {},
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
} }
} }
} }

View File

@ -20,9 +20,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -99,9 +97,7 @@
}, },
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "proof of payment", "description": "proof of payment"
"maxLength": 64,
"minLength": 64
} }
} }
}, },

View File

@ -20,9 +20,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -99,9 +97,7 @@
}, },
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "proof of payment", "description": "proof of payment"
"maxLength": 64,
"minLength": 64
} }
} }
}, },

View File

@ -20,9 +20,7 @@
}, },
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment", "description": "the hash of the *payment_preimage* which will prove payment"
"maxLength": 64,
"minLength": 64
}, },
"status": { "status": {
"type": "string", "type": "string",
@ -109,9 +107,7 @@
"bolt12": {}, "bolt12": {},
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**", "description": "the proof of payment: SHA256 of this **payment_hash**"
"maxLength": 64,
"minLength": 64
} }
} }
} }