mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-23 06:55:13 +01:00
Code Issues Projects Releases Wiki Activity
core-lightning/doc/lightning-makesecret.7.md

42 lines
996 B
Markdown
Raw Normal View History

doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 07:09:12 +05:30
lightning-makesecret -- Command for deriving pseudorandom key from HSM
=====================================================================
SYNOPSIS
--------
lightningd: have `makesecret` take `hex` or `string` (just like `datastore`) Changelog-Added: JSON-RPC: `makesecret` can take a string argument instead of hex. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-29 13:18:53 +09:30
**makesecret** [*hex*] [*string*]
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 07:09:12 +05:30
DESCRIPTION
-----------
The **makesecret** RPC command derives a secret key from the HSM_secret.
lightningd: have `makesecret` take `hex` or `string` (just like `datastore`) Changelog-Added: JSON-RPC: `makesecret` can take a string argument instead of hex. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-29 13:18:53 +09:30
One of *hex* or *string* must be specified: *hex* can be any hex data,
*string* is a UTF-8 string interpreted literally.
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 07:09:12 +05:30
RETURN VALUE
------------
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 07:03:09 +09:30
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 07:09:12 +05:30
- **secret** (secret): the pseudorandom key derived from HSM_secret (always 64 characters)
[comment]: # (GENERATE-FROM-SCHEMA-END)
The following error codes may occur:
- -1: Catchall nonspecific error.
AUTHOR
------
Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible.
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: escape output types (esp `short_channel_id`). We can also remove the listpeers closer hack, which was removed from the schema already. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 10:38:00 +09:30
[comment]: # ( SHA256STAMP:0ef7c3e2172219fa647d1c447cb82daa7857c6c53a27fd191bff83f59ce6b9f7)
Reference in a new issue Copy permalink