core-lightning/doc/schemas/lightning-askrene-disable-node.json
Rusty Russell 48f50a26bf askrene: commit to API.
This does not mean it won't change, just that it will be backwards compatible.

Changelog-Added: Plugins: `askrene` which provides `getroutes` and a complete API for adding information in layers.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-11-08 21:48:55 +10:30

50 lines
1.4 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"rpc": "askrene-disable-node",
"title": "Command to disable all channels to/from a node in a layer",
"added": "v24.11",
"description": [
"The **askrene-disable-node** RPC command tells askrene to disable all channels connected to a node whenever the given layer is used. This is mainly useful to force the use of alternate paths: while individual channels can be disabled using askrene-create-channel or askrene-inform-channel, that would be racy if new channels appeared."
],
"request": {
"required": [
"layer",
"node"
],
"additionalProperties": false,
"properties": {
"layer": {
"type": "string",
"description": [
"The name of the layer to apply this change to."
]
},
"node": {
"type": "pubkey",
"description": [
"The node to disable. It does not need to exist."
]
}
}
},
"response": {
"required": [],
"additionalProperties": false,
"properties": {}
},
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-listlayers(7)",
"lightning-askrene-age(7)"
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}