Skip to content

Commit 2be7433

Browse files
adi2011ShahanaFarooqui
authored andcommitted
doc: Add documentation for the RPC getemergencyrecoverdata.
1 parent 4c775f1 commit 2be7433

File tree

4 files changed

+98
-0
lines changed

4 files changed

+98
-0
lines changed

contrib/msggen/msggen/schema.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13430,6 +13430,54 @@
1343013430
}
1343113431
]
1343213432
},
13433+
"lightning-getemergencyrecoverdata.json": {
13434+
"$schema": "../rpc-schema-draft.json",
13435+
"type": "object",
13436+
"additionalProperties": false,
13437+
"rpc": "getemergencyrecoverdata",
13438+
"title": "Command to fetch data from the emergency.recover file",
13439+
"description": [
13440+
"The **getemergencyrecoverdata** RPC command is used to fetch data from the emergency.recover file, which contains encrypted data."
13441+
],
13442+
"request": {
13443+
"required": [],
13444+
"properties": {}
13445+
},
13446+
"response": {
13447+
"required": [
13448+
"filedata"
13449+
],
13450+
"properties": {
13451+
"filedata": {
13452+
"type": "hex",
13453+
"description": [
13454+
"The raw, hex-encoded, emergency.recover file"
13455+
]
13456+
}
13457+
}
13458+
},
13459+
"author": [
13460+
"Aditya <<[email protected]>> is mainly responsible."
13461+
],
13462+
"see_also": [
13463+
"lightning-getsharedsecret(7)"
13464+
],
13465+
"resources": [
13466+
"Main web site: <https://github.com/ElementsProject/lightning>"
13467+
],
13468+
"examples": [
13469+
{
13470+
"request": {
13471+
"id": "example:getemergencyrecoverdata#1",
13472+
"method": "getemergencyrecoverdata",
13473+
"params": {}
13474+
},
13475+
"response": {
13476+
"filedata": "5b3142fa0dd1115c29654b44780dcd9cf56cd53f9168061e964b39f3ce596962594b25660cba5d90ef07cfccbe1620f378ef284c7d1afed49d"
13477+
}
13478+
}
13479+
]
13480+
},
1343313481
"lightning-getinfo.json": {
1343413482
"$schema": "../rpc-schema-draft.json",
1343513483
"type": "object",

doc/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ GENERATE_MARKDOWN := doc/lightning-addgossip.7 \
6060
doc/lightning-fundchannel_start.7 \
6161
doc/lightning-funderupdate.7 \
6262
doc/lightning-fundpsbt.7 \
63+
doc/lightning-getemergencyrecoverdata.7 \
6364
doc/lightning-getinfo.7 \
6465
doc/lightning-getlog.7 \
6566
doc/lightning-getroute.7 \

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Core Lightning Documentation
6969
lightning-fundchannel_start <lightning-fundchannel_start.7.md>
7070
lightning-funderupdate <lightning-funderupdate.7.md>
7171
lightning-fundpsbt <lightning-fundpsbt.7.md>
72+
lightning-getemergencyrecoverdata <lightning-getemergencyrecoverdata.7.md>
7273
lightning-getinfo <lightning-getinfo.7.md>
7374
lightning-getlog <lightning-getlog.7.md>
7475
lightning-getroute <lightning-getroute.7.md>
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$schema": "../rpc-schema-draft.json",
3+
"type": "object",
4+
"additionalProperties": false,
5+
"rpc": "getemergencyrecoverdata",
6+
"title": "Command to fetch data from the emergency.recover file",
7+
"description": [
8+
"The **getemergencyrecoverdata** RPC command is used to fetch data from the emergency.recover file, which contains encrypted data."
9+
],
10+
"request": {
11+
"required": [],
12+
"properties": {}
13+
},
14+
"response": {
15+
"required": [
16+
"filedata"
17+
],
18+
"properties": {
19+
"filedata": {
20+
"type": "hex",
21+
"description": [
22+
"The raw, hex-encoded, emergency.recover file"
23+
]
24+
}
25+
}
26+
},
27+
"author": [
28+
"Aditya <<[email protected]>> is mainly responsible."
29+
],
30+
"see_also": [
31+
"lightning-getsharedsecret(7)"
32+
],
33+
"resources": [
34+
"Main web site: <https://github.com/ElementsProject/lightning>"
35+
],
36+
"examples": [
37+
{
38+
"request": {
39+
"id": "example:getemergencyrecoverdata#1",
40+
"method": "getemergencyrecoverdata",
41+
"params": {}
42+
},
43+
"response": {
44+
"filedata": "5b3142fa0dd1115c29654b44780dcd9cf56cd53f9168061e964b39f3ce596962594b25660cba5d90ef07cfccbe1620f378ef284c7d1afed49d"
45+
}
46+
}
47+
]
48+
}

0 commit comments

Comments
 (0)