core-lightning/doc/schemas/lightning-recoverchannel.json
2024-08-09 23:56:45 -07:00

82 lines
3.8 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"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"
],
"properties": {
"scb": {
"type": "array",
"description": [
"SCB of the channels in an array."
],
"items": {
"type": "hex"
}
}
}
},
"response": {
"required": [
"stubs"
],
"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": [
[
"0000000000000006f4e1de801de57374d5737da622611e3a1ad9f16d5df9c30fceecc11ce732eeeb022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d5900017f0000019b987577c455da982b1753df79c56f9d8d2b75d1401e60a5af322ab27b13b20d75970000000100000000000f42400003401000",
"000000000000000121bd30cac60f477f2c4267220b1702a6ec5780db34f9934fa94b8c0508bf3357035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d00017f000001e610e23fcc9e6306ce636b203217b22409bf9bab2211f9f432de781dedb6377dab5a0000000100000000000f42400003401000",
"00000000000000027512083907c74ed3a045e9bf772b3d72948eb93daf84a1cee57108800451aaf2035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d00017f000001e610ee1db407eb3e47be3e93e1abc05b13806ee7aef8550c517a4974c72bf91866410000000100000000000f42400003401000",
"0000000000000003222d999f537e32e9458c5db17a63e012dcced61340de06fda5bc30566270b0aa0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351800017f0000019bc5b15661ec5c17599de0858401b72d6be66c34b48a3bb6e679542809f395e6bb2000000000000000000bebb3cb0003401000",
"0000000000000004a4a379248e49d207cc984646e632e1a31105a85708b9d6d961a5018fdd489f5a0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351800017f000001c1ac184e7462759ff83049b19582db049d40076f83a7a70181374ca0ea91644a3d9c0000000200000000000075300003401000",
"000000000000000509eb55872cd9039ecd08281af756e23b15aad4129fd6a9bcd71b472114ebf43a0266e4598d1d3c415f572a8488830b60f7e744ed9235eb0b1ba93283b315c0351800017f000001c1ace9067c9d125df7150261c80eec3ab9cf8731679752b84f090ab3ea6e36c93d3100000001000000000000c3500003401000"
]
]
},
"response": {
"stubs": [
"f4e1de801de57374d5737da622611e3a1ad9f16d5df9c30fceecc11ce732eeeb",
"21bd30cac60f477f2c4267220b1702a6ec5780db34f9934fa94b8c0508bf3357",
"7512083907c74ed3a045e9bf772b3d72948eb93daf84a1cee57108800451aaf2",
"222d999f537e32e9458c5db17a63e012dcced61340de06fda5bc30566270b0aa",
"a4a379248e49d207cc984646e632e1a31105a85708b9d6d961a5018fdd489f5a",
"09eb55872cd9039ecd08281af756e23b15aad4129fd6a9bcd71b472114ebf43a"
]
}
}
]
}