aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-01-06 07:34:21 +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

15
doc/lightning-withdraw.7 generated
View File

@@ -43,12 +43,17 @@ of "txid:vout"\. These must be drawn from the node's available UTXO set\.
.SH RETURN VALUE
On success, an object with attributes \fItx\fR, \fItxid\fR and \fIpsbt\fR will be returned\.
On success, an object is returned, containing:
.RS
.IP \[bu]
\fBtx\fR (hex): the fully signed bitcoin transaction
.IP \[bu]
\fBtxid\fR (txid): the transaction id of \fItx\fR
.IP \[bu]
\fBpsbt\fR (string): the PSBT representing the unsigned transaction
\fItx\fR and \fIpsbt\fR represent the fully signed bitcoin transaction and \fItxid\fR
represents the bitcoin transaction id\.
.RE
On failure, an error is reported and the withdrawal transaction is not
created\.
@@ -79,4 +84,4 @@ Felix \fI<fixone@gmail.com\fR> is mainly responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
\" SHA256STAMP:0afffd7ffd7b22415e67816cc43d3be6fdde8deda863a0981f383cdc7ba48513
\" SHA256STAMP:73c614c0d138af8d355472158960de42ac3f6a5f0bed1dc1e0868ef28a90c8fd