mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 14:24:09 +01:00
04884ca664
Merge information from `*.request.json` & `*.schema.json`. Also consolidate remaining details from `*.md` files and create a single file in schemas folder.
86 lines
2.5 KiB
JSON
86 lines
2.5 KiB
JSON
{
|
|
"$schema": "../rpc-schema-draft.json",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"rpc": "delforward",
|
|
"title": "Command for removing a forwarding entry",
|
|
"description": [
|
|
"The **delforward** RPC command removes a single forward from **listforwards**, using the uniquely-identifying *in_channel* and *in_htlc_id* (and, as a sanity check, the *status*) given by that command.",
|
|
"",
|
|
"This command is mainly used by the *autoclean* plugin (see lightningd- config(7)), As these database entries are only kept for your own analysis, removing them has no effect on the running of your node."
|
|
],
|
|
"request": {
|
|
"required": [
|
|
"in_channel",
|
|
"in_htlc_id",
|
|
"status"
|
|
],
|
|
"properties": {
|
|
"in_channel": {
|
|
"type": "short_channel_id",
|
|
"description": [
|
|
"Only the matching forwards on the given inbound channel are deleted. Note: for **listforwards** entries without an *in_htlc_id* entry (no longer created in v22.11, but can exist from older versions), a value of 18446744073709551615 can be used, but then it will delete *all* entries without *in_htlc_id* for this *in_channel* and *status*."
|
|
]
|
|
},
|
|
"in_htlc_id": {
|
|
"type": "u64",
|
|
"description": [
|
|
"The unique HTLC id the sender gave this (not present if incoming channel was closed before upgrade to v22.11)."
|
|
]
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": [
|
|
"The status of the forward to delete. You cannot delete forwards which have status *offered* (i.e. are currently active)."
|
|
],
|
|
"enum": [
|
|
"settled",
|
|
"local_failed",
|
|
"failed"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"response": {
|
|
"required": [],
|
|
"properties": {}
|
|
},
|
|
"errors": [
|
|
"The following errors may be reported:",
|
|
"",
|
|
"- 1401: The forward specified does not exist."
|
|
],
|
|
"example_json_request": [
|
|
{
|
|
"id": "example:delforward#1",
|
|
"method": "delforward",
|
|
"params": {
|
|
"in_channel": "103x1x0",
|
|
"in_htlc_id": 2,
|
|
"status": "local_failed"
|
|
}
|
|
},
|
|
{
|
|
"id": "example:delforward#2",
|
|
"method": "delforward",
|
|
"params": [
|
|
"103x1x0",
|
|
1,
|
|
"failed"
|
|
]
|
|
}
|
|
],
|
|
"example_json_response": [
|
|
{},
|
|
{}
|
|
],
|
|
"author": [
|
|
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
|
|
],
|
|
"see_also": [
|
|
"lightning-autoclean(7)"
|
|
],
|
|
"resources": [
|
|
"Main web site: <https://github.com/ElementsProject/lightning>"
|
|
]
|
|
}
|