splice: Add docs for easy spliceout command
What changed, and why it matters
This commit only adds documentation and a JSON schema for an existing 'spliceout' command. No code behavior changes, no bug fixes, and no security-related changes are present.
No security action needed. This is a documentation-only commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit adds documentation files (doc/schemas/spliceout.json, doc/Makefile entry, doc/index.rst entry) and updates contrib/msggen/msggen/schema.json to include the spliceout RPC schema. It is purely documentation/metadata. There is no executable code change, no vulnerability fix, and no security-relevant logic introduced.
Changed components
doc/schemas/spliceout.jsondoc/Makefiledoc/index.rstcontrib/msggen/msggen/schema.jsonInspect captured patch +172 / −0
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
index 36e2ba81..70c47f45 100644
--- a/contrib/msggen/msggen/schema.json
+++ b/contrib/msggen/msggen/schema.json
@@ -34112,6 +34112,91 @@
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
]
},
+ "spliceout.json": {
+ "$schema": "../rpc-schema-draft.json",
+ "type": "object",
+ "additionalProperties": false,
+ "added": "v26.04",
+ "rpc": "spliceout",
+ "title": "Command to splice funds out of a channel",
+ "warning": "experimental-splicing only",
+ "description": [
+ "`spliceout` is the command to move funds into a channel."
+ ],
+ "request": {
+ "required": [
+ "channel",
+ "amount"
+ ],
+ "properties": {
+ "channel": {
+ "type": "string",
+ "description": [
+ "channel identifier or channel query. Format is the same as is used in `dev-splice`."
+ ]
+ },
+ "amount": {
+ "type": "string",
+ "description": [
+ "Amount in satoshis taken from the channel. Format is the same as is used in `dev-splice`."
+ ]
+ },
+ "destination": {
+ "type": "string",
+ "description": [
+ "Where to send the funds to. Defaults to `wallet` which sends the funds to your onchain wallet. Specify a bitcoin address to send funds to that address or specify a channel identifier to send funds to another channel. Format is the same as is used in `dev-splice`."
+ ]
+ },
+ "force_feerate": {
+ "type": "boolean",
+ "description": [
+ "By default splices will fail if the fee provided looks too high. This is to protect against accidentally setting your fee higher than intended. Set `force_feerate` to true to skip this saftey check"
+ ]
+ }
+ }
+ },
+ "response": {
+ "required": [],
+ "properties": {
+ "psbt": {
+ "type": "string",
+ "description": [
+ "The final psbt"
+ ]
+ },
+ "tx": {
+ "type": "string",
+ "description": [
+ "The final transaction in hex"
+ ]
+ },
+ "txid": {
+ "type": "string",
+ "description": [
+ "The txid of the final transaction"
+ ]
+ }
+ }
+ },
+ "usage": [
+ "`spliceout` is the command take funds from a channel. It takes `amount` funds from the specified `channel` and puts them somewhere.",
+ "",
+ "The default destination is your onchain wallet.",
+ "By specifying the `destination` as a bitcoin address, the funds will be sent to the specified address",
+ "By specifying the `destination` as a channel identifier, the funds will be sent to the specified channel. This accomplishes a simple \"cross-splice\".",
+ "",
+ "The fee for the transaction will be taken from channel funds."
+ ],
+ "author": [
+ "Dusty [@dusty_daemon](mailto:@dustydaemon) is mainly responsible."
+ ],
+ "see_also": [
+ "lightning-dev-splice(7)"
+ ],
+ "resources": [
+ "Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
+ ]
+ },
"sql-template.json": {
"$schema": "../rpc-schema-draft.json",
"type": "object",
diff --git a/doc/Makefile b/doc/Makefile
index 8fa6fa49..4898e6e5 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -139,6 +139,7 @@ MARKDOWNPAGES := doc/addgossip.7 \
doc/splice_init.7 \
doc/splice_signed.7 \
doc/splice_update.7 \
+ doc/spliceout.7 \
doc/staticbackup.7 \
doc/stop.7 \
doc/txdiscard.7 \
diff --git a/doc/index.rst b/doc/index.rst
index dcc2ea10..edf186b9 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -155,6 +155,7 @@ Core Lightning Documentation
splice_signed <splice_signed.7.md>
splice_update <splice_update.7.md>
splicein <splicein.7.md>
+ spliceout <spliceout.7.md>
sql <sql.7.md>
staticbackup <staticbackup.7.md>
stop <stop.7.md>
diff --git a/doc/schemas/spliceout.json b/doc/schemas/spliceout.json
new file mode 100644
index 00000000..8ffc1498
--- /dev/null
+++ b/doc/schemas/spliceout.json
@@ -0,0 +1,85 @@
+{
+ "$schema": "../rpc-schema-draft.json",
+ "type": "object",
+ "additionalProperties": false,
+ "added": "v26.04",
+ "rpc": "spliceout",
+ "title": "Command to splice funds out of a channel",
+ "warning": "experimental-splicing only",
+ "description": [
+ "`spliceout` is the command to move funds into a channel."
+ ],
+ "request": {
+ "required": [
+ "channel",
+ "amount"
+ ],
+ "properties": {
+ "channel": {
+ "type": "string",
+ "description": [
+ "channel identifier or channel query. Format is the same as is used in `dev-splice`."
+ ]
+ },
+ "amount": {
+ "type": "string",
+ "description": [
+ "Amount in satoshis taken from the channel. Format is the same as is used in `dev-splice`."
+ ]
+ },
+ "destination": {
+ "type": "string",
+ "description": [
+ "Where to send the funds to. Defaults to `wallet` which sends the funds to your onchain wallet. Specify a bitcoin address to send funds to that address or specify a channel identifier to send funds to another channel. Format is the same as is used in `dev-splice`."
+ ]
+ },
+ "force_feerate": {
+ "type": "boolean",
+ "description": [
+ "By default splices will fail if the fee provided looks too high. This is to protect against accidentally setting your fee higher than intended. Set `force_feerate` to true to skip this saftey check"
+ ]
+ }
+ }
+ },
+ "response": {
+ "required": [],
+ "properties": {
+ "psbt": {
+ "type": "string",
+ "description": [
+ "The final psbt"
+ ]
+ },
+ "tx": {
+ "type": "string",
+ "description": [
+ "The final transaction in hex"
+ ]
+ },
+ "txid": {
+ "type": "string",
+ "description": [
+ "The txid of the final transaction"
+ ]
+ }
+ }
+ },
+ "usage": [
+ "`spliceout` is the command take funds from a channel. It takes `amount` funds from the specified `channel` and puts them somewhere.",
+ "",
+ "The default destination is your onchain wallet.",
+ "By specifying the `destination` as a bitcoin address, the funds will be sent to the specified address",
+ "By specifying the `destination` as a channel identifier, the funds will be sent to the specified channel. This accomplishes a simple \"cross-splice\".",
+ "",
+ "The fee for the transaction will be taken from channel funds."
+ ],
+ "author": [
+ "Dusty [@dusty_daemon](mailto:@dustydaemon) is mainly responsible."
+ ],
+ "see_also": [
+ "lightning-dev-splice(7)"
+ ],
+ "resources": [
+ "Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
+ ]
+}
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.