core-lightning/doc/schemas/lightning-recoverchannel.json
ShahanaFarooqui 9592facf83 doc: Lock example values
Changelog-Added: Test script generates all RPC documentation examples now.
2024-11-26 21:45:19 +10:30

82 lines
3.8 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"rpc": "recoverchannel",
"title": "Command for recovering channels bundeled in an array in the form of *Static Backup*",
"description": [
"The **recoverchannel** RPC command tries to force the peer (with whom you already had a channel) to close the channel and sweeps on-chain fund. This method is not spontaneous and depends on the peer, so use it in case of severe data loss.",
"",
"The *scb* parameter is an array containing minimum required info to reconnect and sweep funds. You can get the scb for already stored channels by using the RPC command 'staticbackup'."
],
"request": {
"required": [
"scb"
],
"additionalProperties": false,
"properties": {
"scb": {
"type": "array",
"description": [
"SCB of the channels in an array."
],
"items": {
"type": "hex"
}
}
}
},
"response": {
"required": [
"stubs"
],
"additionalProperties": false,
"properties": {
"stubs": {
"type": "array",
"items": {
"type": "string",
"description": [
"Channel IDs of channels successfully inserted."
]
}
}
}
},
"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:recoverchannel#1",
"method": "recoverchannel",
"params": {
"scb": [
"0000000000000001channelid0340000340000340000340000340000340000340000340000340000nodeid03030303030303030303030303030303030303030303030303030303030300017f000001034003400340034003400340034003400340034003400340034003400340034003400340034003400340034003400003401000",
"0000000000000002channelid0340200340200340200340200340200340200340200340200340200nodeid03030303030303030303030303030303030303030303030303030303030300017f000001034203420342034203420342034203420342034203420342034203420342034203420342034203420342034203420003401000",
"0000000000000003channelid0410000410000410000410000410000410000410000410000410000nodeid01010101010101010101010101010101010101010101010101010101010100017f000001041004100410041004100410041004100410041004100410041004100410041004100410041004100410041004100003401000",
"0000000000000004channelid0120000120000120000120000120000120000120000120000120000nodeid01010101010101010101010101010101010101010101010101010101010100017f000001012001200120012001200120012001200120012001200120012001200120012001200120012001200120012001200003401000",
"0000000000000005channelid1520015200152001520015200152001520015200152001520015200nodeid01010101010101010101010101010101010101010101010101010101010100017f000001015201520152015201520152015201520152015201520152015201520152015201520152015201520152015201520003401000",
"0000000000000006channelid1240012400124001240012400124001240012400124001240012400nodeid02020202020202020202020202020202020202020202020202020202020200017f000001012401240124012401240124012401240124012401240124012401240124012401240124012401240124012401240003401000"
]
}
},
"response": {
"stubs": [
"09eb55872cd9039ecd08281af756e23b15aad4129fd6a9bcd71b472114ebf43a",
"21bd30cac60f477f2c4267220b1702a6ec5780db34f9934fa94b8c0508bf3357",
"222d999f537e32e9458c5db17a63e012dcced61340de06fda5bc30566270b0aa",
"7512083907c74ed3a045e9bf772b3d72948eb93daf84a1cee57108800451aaf2",
"a4a379248e49d207cc984646e632e1a31105a85708b9d6d961a5018fdd489f5a",
"f4e1de801de57374d5737da622611e3a1ad9f16d5df9c30fceecc11ce732eeeb"
]
}
}
]
}