Skip to content

Commit

Permalink
doc/lightning-decode.7: Update the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Aditya Sharma authored and Aditya Sharma committed Oct 15, 2023
1 parent 75fd9e0 commit f3014f5
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/lightning-decode.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The **decode** RPC command checks and parses:
or `LIGHTNING:`) as specified by the BOLT 11 and BOLT 12
specifications.
- a *rune* as created by lightning-commando-rune(7).
- a *encrypted_blob* which contains the content of emergency.recover file.

It may decode other formats in future.

Expand All @@ -24,7 +25,7 @@ RETURN VALUE
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:

- **type** (string): what kind of object it decoded to (one of "bolt12 offer", "bolt12 invoice", "bolt12 invoice\_request", "bolt11 invoice", "rune")
- **type** (string): what kind of object it decoded to (one of "bolt12 offer", "bolt12 invoice", "bolt12 invoice\_request", "bolt11 invoice", "rune", "encrypted_blob")
- **valid** (boolean): if this is false, you *MUST* not use the result except for diagnostics!

If **type** is "bolt12 offer", and **valid** is *true*:
Expand Down Expand Up @@ -281,6 +282,9 @@ If **type** is "rune", and **valid** is *false*:
- the following warnings are possible:
- **warning\_rune\_invalid\_utf8**: the rune contains invalid UTF-8 strings

If **type** is "encrypted_blob":
- **decrypted_blob** (hex): The decrypted blob

[comment]: # (GENERATE-FROM-SCHEMA-END)

AUTHOR
Expand Down

0 comments on commit f3014f5

Please sign in to comment.