core-lightning/doc/schemas/lightning-askrene-create-channel.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

73 lines
2.0 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"rpc": "askrene-create-channel",
"title": "Command to add a channel to layer",
"added": "v24.11",
"description": [
"The **askrene-create-channel** RPC command tells askrene create a channel in the given layer. To actually populate the channel use *askrene-update-channel* in each direction."
],
"request": {
"required": [
"layer",
"source",
"destination",
"short_channel_id",
"capacity_msat"
],
"additionalProperties": false,
"properties": {
"layer": {
"type": "string",
"description": [
"The name of the layer to apply this change to."
]
},
"source": {
"type": "pubkey",
"description": [
"The source node id for the channel."
]
},
"destination": {
"type": "pubkey",
"description": [
"The destination node id for the channel."
]
},
"short_channel_id": {
"type": "short_channel_id",
"description": [
"The short channel id for the channel. If a channel with this short channel id already exists in *layer*, the *source*, *destination* and *capacity_msat* must be the same."
]
},
"capacity_msat": {
"type": "msat",
"description": [
"The capacity (onchain size) of the channel.",
"NOTE: this is in millisatoshis!"
]
}
}
},
"response": {
"required": [],
"additionalProperties": false,
"properties": {}
},
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-disable-node(7)",
"lightning-askrene-update-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>"
]
}