mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-20 13:54:36 +01:00
Code Issues Projects Releases Wiki Activity

doc: Annotate secrets and hashes in the JSON Schemas

Browse source
This commit is contained in:
Christian Decker 2022-04-01 14:43:34 +10:30 • committed by Rusty Russell
parent d0f6e8c8a6
commit 4aec3d3b9c
35 changed files with 77 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/lightning-createinvoice.7.md
View file

@ -33,7 +33,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **label** (string): the label for the invoice
- **payment_hash** (hex): 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)
@ -43,7 +43,7 @@ On success, an object is returned, containing:
- **pay_index** (u64, optional): Incrementing id for when this was paid (**status** *paid* only)
- **amount_received_msat** (msat, optional): Amount actually received (**status** *paid* only)
- **paid_at** (u64, optional): UNIX timestamp of when invoice was paid (**status** *paid* only)
- **payment_preimage** (hex, optional): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **payment_preimage** (secret, optional): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **local_offer_id** (hex, optional): the *id* of our offer which created this invoice (**experimental-offers** only). (always 64 characters)
- **payer_note** (string, optional): the optional *payer_note* from invoice_request which created this invoice (**experimental-offers** only).
@ -74,4 +74,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:ea89ed849c8ad6cac8e1e136999046d1f7589bf176be0e65438174357f87ed11)
[comment]: # ( SHA256STAMP:b07a315a6460449b64ab848ce9fc4cfe6ac862d63c8ab922434238a2b83d7902)

4
doc/lightning-createonion.7.md
View file

@ -92,7 +92,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **onion** (hex): the onion packet (*onion_size* bytes)
- **shared_secrets** (array of hexs): 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: <https://github.com/ElementsProject/lightning>
[bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
[comment]: # ( SHA256STAMP:23e999fedfde74a200c0e6626fa828548b3b60952de30c5885cd63b1922f4508)
[comment]: # ( SHA256STAMP:eabebca3c38ac8e01fb9a0891bde7913ce2832b7ee179c0b4617d104a0e6c009)

6
doc/lightning-delinvoice.7.md
View file

@ -27,7 +27,7 @@ Note: The return is the same as an object from lightning-listinvoice(7).
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **label** (string): Unique label given at creation time
- **payment_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **payment_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **status** (string): State of invoice (one of "paid", "expired", "unpaid")
- **expires_at** (u64): UNIX timestamp when invoice expires (or expired)
- **bolt11** (string, optional): BOLT11 string
@ -43,7 +43,7 @@ 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** (hex): SHA256 of this is the *payment_hash* offered in the invoice (always 64 characters)
- **payment_preimage** (secret): SHA256 of this is the *payment_hash* offered in the invoice (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
@ -78,4 +78,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:73d9097734e85d438de90844ab78bdd737e6df53620542887170c7564a86b90b)
[comment]: # ( SHA256STAMP:407d741b622621da127dc1e55c98c299ace970f8244bc14574dddcafbf9aa1fc)

6
doc/lightning-invoice.7.md
View file

@ -78,8 +78,8 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **bolt11** (string): the bolt11 string
- **payment_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **payment_secret** (hex): the *payment_secret* to place in the onion (always 64 characters)
- **payment_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **payment_secret** (secret): the *payment_secret* to place in the onion (always 64 characters)
- **expires_at** (u64): UNIX timestamp of when invoice expires
The following warnings may also be returned:
@ -117,4 +117,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:f7d82473482e5454fc03641fddcfa97984e6a597e7ad377ced2cbed1512e91ed)
[comment]: # ( SHA256STAMP:834b9d7b84845d423a677662b66b9109b3b8c4b7219a91d98f2817561d68a8cd)

6
doc/lightning-keysend.7.md
View file

@ -67,8 +67,8 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **payment_preimage** (hex): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **payment_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **payment_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **payment_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **created_at** (number): the UNIX timestamp showing when this payment was initiated
- **parts** (u32): how many attempts this took
- **amount_msat** (msat): Amount the recipient received
@ -114,4 +114,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:bf507985544575c4ef2fe194fda6a693378cb8ab3bfb30ca7a7c066be271be29)
[comment]: # ( SHA256STAMP:449315de94f49452c3d485775dd97bc2517763be420ebc74024914680359d1ff)

6
doc/lightning-listinvoices.7.md
View file

@ -23,7 +23,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
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** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **payment_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **status** (string): Whether it's paid, unpaid or unpayable (one of "unpaid", "paid", "expired")
- **expires_at** (u64): UNIX timestamp of when it will become / became unpayable
- **description** (string, optional): description used in the invoice
@ -37,7 +37,7 @@ 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)
- **payment_preimage** (secret): proof of payment (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
@ -56,4 +56,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:d1328ecc2a4e76ede8c9adc3a63d18ce36be305ddcee7cf717039f79642cfd41)
[comment]: # ( SHA256STAMP:1178a5178a20b2aca9c52fe39e332bd1d6c4f20fa302639bed0fbfc6eb348c40)

6
doc/lightning-listpeers.7.md
View file

@ -53,7 +53,7 @@ On success, an object containing **peers** is returned. It is an array of objec
- **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** (hex, optional): The full channel_id (always 64 characters)
- **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
@ -113,7 +113,7 @@ On success, an object containing **peers** is returned. It is an array of objec
- **id** (u64): Unique ID for this htlc on this channel in this direction
- **amount_msat** (msat): Amount send/received for this HTLC
- **expiry** (u32): Block this HTLC expires at
- **payment_hash** (hex): the hash of the payment_preimage which will prove payment (always 64 characters)
- **payment_hash** (hash): the hash of the payment_preimage which will prove payment (always 64 characters)
- **local_trimmed** (boolean, optional): if this is too small to enforce onchain (always *true*)
- **status** (string, optional): set if this HTLC is currently waiting on a hook (and shows what plugin)
@ -380,4 +380,4 @@ Main web site: <https://github.com/ElementsProject/lightning> Lightning
RFC site (BOLT \#9):
<https://github.com/lightningnetwork/lightning-rfc/blob/master/09-features.md>
[comment]: # ( SHA256STAMP:147b7008c8f4acb031df625e0731614339a75ee5861cb9f40cd542b1017e3660)
[comment]: # ( SHA256STAMP:6b0ec5c899c8685487190209f594635030205a275e1dc6d61a7b057adbf66192)

6
doc/lightning-listsendpays.7.md
View file

@ -25,7 +25,7 @@ Note that the returned array is ordered by increasing *id*.
[comment]: # (GENERATE-FROM-SCHEMA-START)
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** (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
@ -37,7 +37,7 @@ On success, an object containing **payments** is returned. It is an array of ob
- **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only).
If **status** is "complete":
- **payment_preimage** (hex): 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":
- **erroronion** (hex, optional): the onion message returned
@ -60,4 +60,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:1dfcb495e0004b9dadffd7f69b58275bf9168c9f4007675b390ebbaea07ffde6)
[comment]: # ( SHA256STAMP:b03c2f306bafb1919f0933ebc695657bd691591484ddcb39b1e8706335593cd2)

6
doc/lightning-pay.7.md
View file

@ -78,8 +78,8 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **payment_preimage** (hex): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **payment_hash** (hex): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **payment_preimage** (secret): the proof of payment: SHA256 of this **payment_hash** (always 64 characters)
- **payment_hash** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **created_at** (number): the UNIX timestamp showing when this payment was initiated
- **parts** (u32): how many attempts this took
- **amount_msat** (msat): Amount the recipient received
@ -149,4 +149,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:e537b9c74918559db99e673fac63cfa43a347ab80c32f33012ab3655b9edc45e)
[comment]: # ( SHA256STAMP:b8ff255c1f4d284535d70f13d3bd85c3d20ef8fdee081835a57fb04528311db6)

6
doc/lightning-sendonion.7.md
View file

@ -89,7 +89,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **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** (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
@ -101,7 +101,7 @@ On success, an object is returned, containing:
- **partid** (u64, optional): the partid (if supplied) to sendonion/sendpay
If **status** is "complete":
- **payment_preimage** (hex): 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":
- **message** (string, optional): Monitor status with listpays or waitsendpay
@ -128,4 +128,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[bolt04]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
[comment]: # ( SHA256STAMP:b8fd5d1c31eb2db10b2f32960752ae1c90150ffeb470c5ea635cb1034e8b1438)
[comment]: # ( SHA256STAMP:d2f4991d271147dd8c13859376f36f2d8843a96034e818a434555a09bf6fd003)

6
doc/lightning-sendpay.7.md
View file

@ -67,7 +67,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **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** (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
@ -80,7 +80,7 @@ On success, an object is returned, containing:
- **bolt12** (string, optional): the bolt12 string (if supplied: **experimental-offers** only).
If **status** is "complete":
- **payment_preimage** (hex): 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":
- **message** (string): Monitor status with listpays or waitsendpay
@ -138,4 +138,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:44540ace609ccfa7b023526d7a92ba7cf4a6058f3ae2124c20fa65b92137e41b)
[comment]: # ( SHA256STAMP:a7f55104f3bdb21057a410a33902b92aca38aaa83b1e0e7e6876a911316132ed)

6
doc/lightning-waitanyinvoice.7.md
View file

@ -37,7 +37,7 @@ RETURN VALUE
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** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **status** (string): Whether it's paid or expired (one of "paid", "expired")
- **expires_at** (u64): UNIX timestamp of when it will become / became unpayable
- **amount_msat** (msat, optional): the amount required to pay this invoice
@ -48,7 +48,7 @@ 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)
- **payment_preimage** (secret): proof of payment (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
@ -73,4 +73,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:33df5fb9bcbcb6d2240d0d18b970b2300414aae36b81fb276fcedfc21480d22f)
[comment]: # ( SHA256STAMP:6c4df3bb97df9f87583725ef31e803900ac548e17506692f9da365a3e4bbf18f)

6
doc/lightning-waitinvoice.7.md
View file

@ -19,7 +19,7 @@ RETURN VALUE
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** (hash): the hash of the *payment_preimage* which will prove payment (always 64 characters)
- **status** (string): Whether it's paid or expired (one of "paid", "expired")
- **expires_at** (u64): UNIX timestamp of when it will become / became unpayable
- **amount_msat** (msat, optional): the amount required to pay this invoice
@ -30,7 +30,7 @@ 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)
- **payment_preimage** (secret): proof of payment (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
@ -58,4 +58,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:33df5fb9bcbcb6d2240d0d18b970b2300414aae36b81fb276fcedfc21480d22f)
[comment]: # ( SHA256STAMP:6c4df3bb97df9f87583725ef31e803900ac548e17506692f9da365a3e4bbf18f)

6
doc/lightning-waitsendpay.7.md
View file

@ -35,7 +35,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **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** (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
@ -48,7 +48,7 @@ On success, an object is returned, containing:
- **bolt12** (string, optional): the bolt12 string (if supplied for pay: **experimental-offers** only).
If **status** is "complete":
- **payment_preimage** (hex): 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)
@ -101,4 +101,4 @@ RESOURCES
Main web site: <https://github.com/ElementsProject/lightning>
[comment]: # ( SHA256STAMP:3f89cf80acc1e9363509f0a053a617f8b381790823f8cd05fa6c708eb72fcc7e)
[comment]: # ( SHA256STAMP:96e5cfd0bd6f2d6b7a25a60f846283592404cee07ef142e58cd56929cc6923c9)

4
doc/schemas/createinvoice.schema.json
View file

@ -23,7 +23,7 @@
"description": "the bolt12 string instead of **bolt11** (**experimental-offers** only)"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -62,7 +62,7 @@
"description": "UNIX timestamp of when invoice was paid (**status** *paid* only)"
},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64

2
doc/schemas/createonion.request.json
View file

@ -32,7 +32,7 @@
"description": ""
},
"session_key": {
"type": "hex"
"type": "secret"
},
"onion_size": {
"type": "u16"

2
doc/schemas/createonion.schema.json
View file

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

4
doc/schemas/delinvoice.schema.json
View file

@ -33,7 +33,7 @@
"description": "description used in the invoice"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -154,7 +154,7 @@
"description": "UNIX timestamp of when payment was received"
},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "SHA256 of this is the *payment_hash* offered in the invoice",
"maxLength": 64,
"minLength": 64

4
doc/schemas/invoice.schema.json
View file

@ -14,13 +14,13 @@
"description": "the bolt11 string"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
},
"payment_secret": {
"type": "hex",
"type": "secret",
"description": "the *payment_secret* to place in the onion",
"maxLength": 64,
"minLength": 64

4
doc/schemas/keysend.schema.json
View file

@ -13,7 +13,7 @@
],
"properties": {
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64
@ -23,7 +23,7 @@
"description": "the final destination of the payment"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64

4
doc/schemas/listinvoices.schema.json
View file

@ -27,7 +27,7 @@
"description": "description used in the invoice"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -119,7 +119,7 @@
"description": "UNIX timestamp of when it was paid"
},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "proof of payment",
"maxLength": 64,
"minLength": 64

4
doc/schemas/listpeers.schema.json
View file

@ -226,7 +226,7 @@
"description": "The short_channel_id (once locked in)"
},
"channel_id": {
"type": "hex",
"type": "hash",
"description": "The full channel_id",
"minLength": 64,
"maxLength": 64
@ -632,7 +632,7 @@
"description": "Block this HTLC expires at"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the payment_preimage which will prove payment",
"maxLength": 64,
"minLength": 64

2
doc/schemas/listsendpays.request.json
View file

@ -8,7 +8,7 @@
"type": "string"
},
"payment_hash": {
"type": "hex"
"type": "hash"
},
"status": {
"type": "string",

4
doc/schemas/listsendpays.schema.json
View file

@ -28,7 +28,7 @@
"description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -110,7 +110,7 @@
"bolt11": {},
"bolt12": {},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64

4
doc/schemas/pay.schema.json
View file

@ -13,7 +13,7 @@
],
"properties": {
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64
@ -23,7 +23,7 @@
"description": "the final destination of the payment"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64

4
doc/schemas/sendonion.request.json
View file

@ -31,7 +31,7 @@
}
},
"payment_hash": {
"type": "hex"
"type": "hash"
},
"label": {
"type": "string"
@ -39,7 +39,7 @@
"shared_secrets": {
"type": "array",
"items": {
"type": "hex"
"type": "secret"
}
},
"partid": {

4
doc/schemas/sendonion.schema.json
View file

@ -15,7 +15,7 @@
"description": "unique ID for this payment attempt"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -100,7 +100,7 @@
"bolt12": {},
"partid": {},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64

4
doc/schemas/sendpay.request.json
View file

@ -34,7 +34,7 @@
}
},
"payment_hash": {
"type": "hex"
"type": "hash"
},
"label": {
"type": "string"
@ -46,7 +46,7 @@
"type": "string"
},
"payment_secret": {
"type": "hex"
"type": "secret"
},
"partid": {
"type": "u16"

4
doc/schemas/sendpay.schema.json
View file

@ -19,7 +19,7 @@
"description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -104,7 +104,7 @@
"bolt11": {},
"bolt12": {},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64

2
doc/schemas/txdiscard.request.json
View file

@ -7,7 +7,7 @@
],
"properties": {
"txid": {
"type": "hex"
"type": "txid"
}
}
}

2
doc/schemas/txsend.request.json
View file

@ -7,7 +7,7 @@
],
"properties": {
"txid": {
"type": "hex"
"type": "txid"
}
}
}

4
doc/schemas/waitanyinvoice.schema.json
View file

@ -19,7 +19,7 @@
"description": "description used in the invoice"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -98,7 +98,7 @@
"description": "UNIX timestamp of when it was paid"
},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "proof of payment",
"maxLength": 64,
"minLength": 64

4
doc/schemas/waitinvoice.schema.json
View file

@ -19,7 +19,7 @@
"description": "description used in the invoice"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -98,7 +98,7 @@
"description": "UNIX timestamp of when it was paid"
},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "proof of payment",
"maxLength": 64,
"minLength": 64

2
doc/schemas/waitsendpay.request.json
View file

@ -7,7 +7,7 @@
],
"properties": {
"payment_hash": {
"type": "hex"
"type": "hash"
},
"timeout": {
"type": "u32"

4
doc/schemas/waitsendpay.schema.json
View file

@ -19,7 +19,7 @@
"description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash"
},
"payment_hash": {
"type": "hex",
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment",
"maxLength": 64,
"minLength": 64
@ -103,7 +103,7 @@
"bolt11": {},
"bolt12": {},
"payment_preimage": {
"type": "hex",
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash**",
"maxLength": 64,
"minLength": 64