mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 01:43:36 +01:00
Code Issues Projects Releases Wiki Activity

doc: Add documentation for the RPC getemergencyrecoverdata.

Browse Source
This commit is contained in:
Aditya Sharma 2024-08-08 11:19:25 +05:30 committed by ShahanaFarooqui
parent 4c775f16aa
commit 2be7433ae6
4 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
contrib/msggen/msggen/schema.json
View File

@ -13430,6 +13430,54 @@
}
]
},
"lightning-getemergencyrecoverdata.json": {
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "getemergencyrecoverdata",
"title": "Command to fetch data from the emergency.recover file",
"description": [
"The **getemergencyrecoverdata** RPC command is used to fetch data from the emergency.recover file, which contains encrypted data."
],
"request": {
"required": [],
"properties": {}
},
"response": {
"required": [
"filedata"
],
"properties": {
"filedata": {
"type": "hex",
"description": [
"The raw, hex-encoded, emergency.recover file"
]
}
}
},
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:getemergencyrecoverdata#1",
"method": "getemergencyrecoverdata",
"params": {}
},
"response": {
"filedata": "5b3142fa0dd1115c29654b44780dcd9cf56cd53f9168061e964b39f3ce596962594b25660cba5d90ef07cfccbe1620f378ef284c7d1afed49d"
}
}
]
},
"lightning-getinfo.json": {
"$schema": "../rpc-schema-draft.json",
"type": "object",

1
doc/Makefile
View File

@ -60,6 +60,7 @@ GENERATE_MARKDOWN := doc/lightning-addgossip.7 \
doc/lightning-fundchannel_start.7 \
doc/lightning-funderupdate.7 \
doc/lightning-fundpsbt.7 \
doc/lightning-getemergencyrecoverdata.7 \
doc/lightning-getinfo.7 \
doc/lightning-getlog.7 \
doc/lightning-getroute.7 \

1
doc/index.rst
View File

@ -69,6 +69,7 @@ Core Lightning Documentation
lightning-fundchannel_start <lightning-fundchannel_start.7.md>
lightning-funderupdate <lightning-funderupdate.7.md>
lightning-fundpsbt <lightning-fundpsbt.7.md>
lightning-getemergencyrecoverdata <lightning-getemergencyrecoverdata.7.md>
lightning-getinfo <lightning-getinfo.7.md>
lightning-getlog <lightning-getlog.7.md>
lightning-getroute <lightning-getroute.7.md>

48
doc/schemas/lightning-getemergencyrecoverdata.json Normal file
View File

@ -0,0 +1,48 @@
{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "getemergencyrecoverdata",
"title": "Command to fetch data from the emergency.recover file",
"description": [
"The **getemergencyrecoverdata** RPC command is used to fetch data from the emergency.recover file, which contains encrypted data."
],
"request": {
"required": [],
"properties": {}
},
"response": {
"required": [
"filedata"
],
"properties": {
"filedata": {
"type": "hex",
"description": [
"The raw, hex-encoded, emergency.recover file"
]
}
}
},
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:getemergencyrecoverdata#1",
"method": "getemergencyrecoverdata",
"params": {}
},
"response": {
"filedata": "5b3142fa0dd1115c29654b44780dcd9cf56cd53f9168061e964b39f3ce596962594b25660cba5d90ef07cfccbe1620f378ef284c7d1afed49d"
}
}
]
}