mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-23 15:00:34 +01:00
976c0c90bc
- Changed ALL `doc/schemas/lightning-*.json` file's `json_example` to `examples` - Change the heading from example to examples - Bring shell command before the json command - Move Example to the end of the page - Remove horizontal line from Example
102 lines
2.8 KiB
JSON
102 lines
2.8 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"rpc": "check",
|
|
"title": "Command for verifying parameters",
|
|
"description": [
|
|
"The **check** RPC command verifies another command without actually making any changes.",
|
|
"",
|
|
"This is guaranteed to be safe, and will do all checks up to the point where something in the system would need to be altered (such as checking that channels are in the right state, peers connected, etc).",
|
|
"",
|
|
"It does not guarantee successful execution of the command in all cases. For example, a call to lightning-getroute(7) may still fail to find a route even if checking the parameters succeeds."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"command_to_check"
|
|
],
|
|
"properties": {
|
|
"command_to_check": {
|
|
"type": "string",
|
|
"description": [
|
|
"Name of the relevant command."
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"properties": {
|
|
"command_to_check": {
|
|
"type": "string",
|
|
"description": [
|
|
"The *command_to_check* argument."
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"command_to_check"
|
|
]
|
|
},
|
|
"author": [
|
|
"Mark Beckwith <<wythe@intrig.com>> and Rusty Russell <<rusty@rustcorp.com.au>> are mainly responsible."
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
],
|
|
"examples": [
|
|
{
|
|
"request": {
|
|
"id": "example:check#1",
|
|
"method": "check",
|
|
"params": {
|
|
"command_to_check": "sendpay",
|
|
"route": [
|
|
{
|
|
"amount_msat": 1011,
|
|
"id": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
|
|
"delay": 20,
|
|
"channel": "1x1x1"
|
|
},
|
|
{
|
|
"amount_msat": 1000,
|
|
"id": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d",
|
|
"delay": 10,
|
|
"channel": "2x2x2"
|
|
}
|
|
],
|
|
"payment_hash": "0000000000000000000000000000000000000000000000000000000000000000"
|
|
}
|
|
},
|
|
"response": {
|
|
"command_to_check": "sendpay"
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:check#2",
|
|
"method": "check",
|
|
"params": {
|
|
"command_to_check": "dev",
|
|
"subcommand": "slowcmd",
|
|
"msec": 1000
|
|
}
|
|
},
|
|
"response": {
|
|
"command_to_check": "dev"
|
|
}
|
|
},
|
|
{
|
|
"request": {
|
|
"id": "example:check#3",
|
|
"method": "check",
|
|
"params": {
|
|
"command_to_check": "recover",
|
|
"hsmsecret": "6c696768746e696e672d31000000000000000000000000000000000000000000"
|
|
}
|
|
},
|
|
"response": {
|
|
"command_to_check": "recover"
|
|
}
|
|
}
|
|
]
|
|
}
|