core-lightning/doc/schemas/lightning-emergencyrecover.json
ShahanaFarooqui 04884ca664 doc: Merge request and schema jsons in a single file
Merge information from `*.request.json` & `*.schema.json`. Also consolidate remaining details from `*.md` files and create a single file in schemas folder.
2024-03-19 14:58:59 +10:30

63 lines
1.7 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "emergencyrecover",
"title": "Command for recovering channels from the emergency.recovery file in the lightning directory",
"description": [
"The **emergencyrecover** RPC command fetches data from the emergency.recover file and tries to reconnect to the peer and force him to close the channel. The data in this file has enough information to reconnect and sweep the funds.",
"",
"This recovery method is not spontaneous and it depends on the peer, so it should be used as a last resort to recover the funds stored in a channel in case of severe data loss."
],
"request": {
"required": [],
"properties": {}
},
"response": {
"required": [
"stubs"
],
"properties": {
"stubs": {
"type": "array",
"items": {
"type": "hash",
"description": [
"Channel IDs of channels successfully inserted."
]
}
}
}
},
"example_json_request": [
{
"id": "example:emergencyrecover#1",
"method": "emergencyrecover",
"params": "{}"
},
{
"id": "example:emergencyrecover#2",
"method": "emergencyrecover",
"params": "{}"
}
],
"example_json_response": [
{
"stubs": []
},
{
"stubs": [
"c00734472f344fdadd0bf787de182e5cf144ccda5d731b0f7c75befd1f1eff52"
]
}
],
"author": [
"Aditya <<aditya.sharma20111@gmail.com>> is mainly responsible."
],
"see_also": [
"lightning-getsharedsecret(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}