aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-20 23:54:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: schemas for everything else.

Browse Source 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
This commit is contained in:
Rusty Russell
2021-06-16 10:40:17 +09:30
parent 977cb62e12
commit 2ddecdc95a
118 changed files with 3026 additions and 417 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/lightning-openchannel_init.7 generated
View File

@@ -45,13 +45,19 @@ sent on close\. Only valid if both peers have negotiated
.SH RETURN VALUE
On success, returns the \fIchannel_id\fR for this channel; an updated
incomplete \fIinitialpsbt\fR for this funding transaction; and the flag
\fIcommitments_secured\fR, which indiciates the completeness of the
passed back \fIpsbt\fR\. (Will always be false)\. Also returns the
\fIfunding_serial\fR, indicating the serial_id of the funding output
in the \fIpsbt\fR\.
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBchannel_id\fR (hex): the channel id of the channel (always 64 characters)
.IP \[bu]
\fBcommitments_secured\fR (boolean): whether the \fIpsbt\fR is complete (always \fIfalse\fR)
.IP \[bu]
\fBfunding_serial\fR (u64): the serial_id of the funding output in the \fIpsbt\fR
.IP \[bu]
\fBintiialpsbt\fR (string, optional): the (incomplete) PSBT of the funding transaction
.RE
If the peer does not support \fBoption_dual_fund\fR, this command
will return an error\.
@@ -99,4 +105,4 @@ lightning-fundchannel_\fBcomplete\fR(7), \fBlightning-fundchannel\fR(7),
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:8e37cb8813751e06f59b108e8a335b5b5269e5764c346838a6ddf79138ccea6e
\" SHA256STAMP:4663cea3fc74a8e91e7a3de6997a7b5a236bacf84dda3ed826cbbd7d544c39e8