routerrpc: add XAddLocalChanAliases & XDeleteLocalChanAliases

This commit is contained in:
George Tsagkarelis authored and Oliver Gugger committed 2024-09-05 10:29:42 +02:00
1 parent 604bd81100
commit 70f82bc4ff
12 files changed
+1137 -232

No files matched your search

+128
View File
@@ -514,6 +514,72 @@
]
}
},
"/v2/router/x/addaliases": {
"post": {
"summary": "XAddLocalChanAliases is an experimental API that creates a set of new\nchannel SCID alias mappings. The final total set of aliases in the manager\nafter the add operation is returned. This is only a locally stored alias,\nand will not be communicated to the channel peer via any message. Therefore,\nrouting over such an alias will only work if the peer also calls this same\nRPC on their end. If an alias already exists, an error is returned",
"operationId": "Router_XAddLocalChanAliases",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/routerrpcAddAliasesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/routerrpcAddAliasesRequest"
}
}
],
"tags": [
"Router"
]
}
},
"/v2/router/x/deletealiases": {
"post": {
"summary": "XDeleteLocalChanAliases is an experimental API that deletes a set of alias\nmappings. The final total set of aliases in the manager after the delete\noperation is returned. The deletion will not be communicated to the channel\npeer via any message.",
"operationId": "Router_XDeleteLocalChanAliases",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/routerrpcDeleteAliasesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/routerrpcDeleteAliasesRequest"
}
}
],
"tags": [
"Router"
]
}
},
"/v2/router/x/importhistory": {
"post": {
"summary": "lncli: `importmc`\nXImportMissionControl is an experimental API that imports the state provided\nto the internal mission control's state, using all results which are more\nrecent than our existing values. These values will only be imported\nin-memory, and will not be persisted across restarts.",
@@ -619,6 +685,24 @@
}
}
},
"lnrpcAliasMap": {
"type": "object",
"properties": {
"base_scid": {
"type": "string",
"format": "uint64",
"description": "For non-zero-conf channels, this is the confirmed SCID. Otherwise, this is\nthe first assigned \"base\" alias."
},
"aliases": {
"type": "array",
"items": {
"type": "string",
"format": "uint64"
},
"description": "The set of all aliases stored for the base SCID."
}
}
},
"lnrpcChannelPoint": {
"type": "object",
"properties": {
@@ -1102,6 +1186,28 @@
}
}
},
"routerrpcAddAliasesRequest": {
"type": "object",
"properties": {
"alias_maps": {
"type": "array",
"items": {
"$ref": "#/definitions/lnrpcAliasMap"
}
}
}
},
"routerrpcAddAliasesResponse": {
"type": "object",
"properties": {
"alias_maps": {
"type": "array",
"items": {
"$ref": "#/definitions/lnrpcAliasMap"
}
}
}
},
"routerrpcAprioriParameters": {
"type": "object",
"properties": {
@@ -1213,6 +1319,28 @@
}
}
},
"routerrpcDeleteAliasesRequest": {
"type": "object",
"properties": {
"alias_maps": {
"type": "array",
"items": {
"$ref": "#/definitions/lnrpcAliasMap"
}
}
}
},
"routerrpcDeleteAliasesResponse": {
"type": "object",
"properties": {
"alias_maps": {
"type": "array",
"items": {
"$ref": "#/definitions/lnrpcAliasMap"
}
}
}
},
"routerrpcFailureDetail": {
"type": "string",
"enum": [