Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

askrene: batch create channels #7666

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ doc-wrongdir:

GENERATE_MARKDOWN := doc/lightning-addgossip.7 \
doc/lightning-addpsbtoutput.7 \
doc/lightning-askrene-create-channel.7 \
doc/lightning-askrene-create-channels.7 \
doc/lightning-askrene-disable-node.7 \
doc/lightning-askrene-inform-channel.7 \
doc/lightning-askrene-listlayers.7 \
Expand Down
105 changes: 0 additions & 105 deletions doc/schemas/lightning-askrene-create-channel.json

This file was deleted.

116 changes: 116 additions & 0 deletions doc/schemas/lightning-askrene-create-channels.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "askrene-create-channels",
"title": "Command to add channels to layer (EXPERIMENTAL)",
"description": [
"WARNING: experimental, so API may change.",
"",
"The **askrene-create-channels** RPC command tells askrene to populate one direction of a list of channels in the given layer. If the channels already exist, they will be overridden. If the layer does not exist, it will be created."
],
"request": {
"required": [
"layer",
"channels"
],
"properties": {
"layer": {
"type": "string",
"description": [
"The name of the layer to apply this change to."
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"required": [
"source",
"destination",
"short_channel_id",
"capacity_msat",
"htlc_mininum_msat",
"htlc_maximum_msat",
"fee_base_msat",
"fee_proportional_millionths",
"delay"
],
"properties": {
"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."
]
},
"htlc_mininum_msat": {
"type": "msat",
"description": [
"The minimum value allowed in this direction."
]
},
"htlc_maximum_msat": {
"type": "msat",
"description": [
"The maximum value allowed in this direction."
]
},
"fee_base_msat": {
"type": "msat",
"description": [
"The base fee to apply to use the channel in this direction."
]
},
"fee_proportional_millionths": {
"type": "u32",
"description": [
"The proportional fee (in parts per million) to apply to use the channel in this direction."
]
},
"delay": {
"type": "u16",
"description": [
"The CLTV delay required for this direction."
]
}
}
}
}
}
},
"response": {
"required": [],
"properties": {}
},
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-disable-node(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>"
]
}
4 changes: 2 additions & 2 deletions doc/schemas/lightning-askrene-disable-node.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"description": [
"WARNING: experimental, so API may change.",
"",
"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."
"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-channels or askrene-inform-channel, that would be racy if new channels appeared."
],
"request": {
"required": [
Expand Down Expand Up @@ -35,7 +35,7 @@
},
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-create-channels(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-listlayers(7)",
"lightning-askrene-age(7)"
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/lightning-askrene-inform-channel.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-disable-node(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-create-channels(7)",
"lightning-askrene-listlayers(7)",
"lightning-askrene-age(7)"
],
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/lightning-askrene-listlayers.json
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-disable-node(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-create-channels(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-age(7)"
],
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/lightning-askrene-reserve.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"lightning-getroutes(7)",
"lightning-askrene-unreserve(7)",
"lightning-askrene-disable-node(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-create-channels(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-listlayers(7)",
"lightning-askrene-age(7)"
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/lightning-askrene-unreserve.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"lightning-getroutes(7)",
"lightning-askrene-reserve(7)",
"lightning-askrene-disable-node(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-create-channels(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-listlayers(7)",
"lightning-askrene-age(7)"
Expand Down
2 changes: 1 addition & 1 deletion doc/schemas/lightning-getroutes.json
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
"lightning-askrene-reserve(7)",
"lightning-askrene-unreserve(7)",
"lightning-askrene-disable-node(7)",
"lightning-askrene-create-channel(7)",
"lightning-askrene-create-channels(7)",
"lightning-askrene-inform-channel(7)",
"lightning-askrene-report(7)",
"lightning-askrene-age(7)"
Expand Down
Loading
Loading