Skip to content

Commit 3ef72bf

Browse files
ddustinsangbida
authored andcommitted
splice: Add documentation for splicein
1 parent 791e412 commit 3ef72bf

4 files changed

Lines changed: 136 additions & 0 deletions

File tree

contrib/msggen/msggen/schema.json

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34045,6 +34045,73 @@
3404534045
}
3404634046
]
3404734047
},
34048+
"splicein.json": {
34049+
"$schema": "../rpc-schema-draft.json",
34050+
"type": "object",
34051+
"additionalProperties": false,
34052+
"added": "v26.04",
34053+
"rpc": "splicein",
34054+
"title": "Command to splice funds into a channel",
34055+
"warning": "experimental-splicing only",
34056+
"description": [
34057+
"`splicein` is the command to move funds into a channel."
34058+
],
34059+
"request": {
34060+
"required": [
34061+
"channel",
34062+
"amount"
34063+
],
34064+
"properties": {
34065+
"channel": {
34066+
"type": "string",
34067+
"description": [
34068+
"channel identifier or channel query. Format is the same as is used in `dev-splice`."
34069+
]
34070+
},
34071+
"amount": {
34072+
"type": "string",
34073+
"description": [
34074+
"Amount in satoshis taken from the internal wallet and add to the channel. Format is the same as is used in `dev-splice`."
34075+
]
34076+
}
34077+
}
34078+
},
34079+
"response": {
34080+
"required": [],
34081+
"properties": {
34082+
"psbt": {
34083+
"type": "string",
34084+
"description": [
34085+
"The final psbt"
34086+
]
34087+
},
34088+
"tx": {
34089+
"type": "string",
34090+
"description": [
34091+
"The final transaction in hex"
34092+
]
34093+
},
34094+
"txid": {
34095+
"type": "string",
34096+
"description": [
34097+
"The txid of the final transaction"
34098+
]
34099+
}
34100+
}
34101+
},
34102+
"usage": [
34103+
"`splicein` is the command to add funds to a channel. It takes `amount` funds from your onchain wallet and places them into `channel`."
34104+
],
34105+
"author": [
34106+
"Dusty [@dusty_daemon](mailto:@dustydaemon) is mainly responsible."
34107+
],
34108+
"see_also": [
34109+
"lightning-dev-splice(7)"
34110+
],
34111+
"resources": [
34112+
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
34113+
]
34114+
},
3404834115
"sql-template.json": {
3404934116
"$schema": "../rpc-schema-draft.json",
3405034117
"type": "object",

doc/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ MARKDOWNPAGES := doc/addgossip.7 \
135135
doc/signmessage.7 \
136136
doc/signmessagewithkey.7 \
137137
doc/signpsbt.7 \
138+
doc/splicein.7 \
138139
doc/splice_init.7 \
139140
doc/splice_signed.7 \
140141
doc/splice_update.7 \

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ Core Lightning Documentation
154154
splice_init <splice_init.7.md>
155155
splice_signed <splice_signed.7.md>
156156
splice_update <splice_update.7.md>
157+
splicein <splicein.7.md>
157158
sql <sql.7.md>
158159
staticbackup <staticbackup.7.md>
159160
stop <stop.7.md>

doc/schemas/splicein.json

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"$schema": "../rpc-schema-draft.json",
3+
"type": "object",
4+
"additionalProperties": false,
5+
"added": "v26.04",
6+
"rpc": "splicein",
7+
"title": "Command to splice funds into a channel",
8+
"warning": "experimental-splicing only",
9+
"description": [
10+
"`splicein` is the command to move funds into a channel."
11+
],
12+
"request": {
13+
"required": [
14+
"channel",
15+
"amount"
16+
],
17+
"properties": {
18+
"channel": {
19+
"type": "string",
20+
"description": [
21+
"channel identifier or channel query. Format is the same as is used in `dev-splice`."
22+
]
23+
},
24+
"amount": {
25+
"type": "string",
26+
"description": [
27+
"Amount in satoshis taken from the internal wallet and add to the channel. Format is the same as is used in `dev-splice`."
28+
]
29+
}
30+
}
31+
},
32+
"response": {
33+
"required": [],
34+
"properties": {
35+
"psbt": {
36+
"type": "string",
37+
"description": [
38+
"The final psbt"
39+
]
40+
},
41+
"tx": {
42+
"type": "string",
43+
"description": [
44+
"The final transaction in hex"
45+
]
46+
},
47+
"txid": {
48+
"type": "string",
49+
"description": [
50+
"The txid of the final transaction"
51+
]
52+
}
53+
}
54+
},
55+
"usage": [
56+
"`splicein` is the command to add funds to a channel. It takes `amount` funds from your onchain wallet and places them into `channel`."
57+
],
58+
"author": [
59+
"Dusty [@dusty_daemon](mailto:@dustydaemon) is mainly responsible."
60+
],
61+
"see_also": [
62+
"lightning-dev-splice(7)"
63+
],
64+
"resources": [
65+
"Main web site: [https://github.com/ElementsProject/lightning](https://github.com/ElementsProject/lightning)"
66+
]
67+
}

0 commit comments

Comments
 (0)