Skip to content

Commit 1fc5dc9

Browse files
fixonecdecker
fixone
authored and
cdecker
committed
documentation: newaddr, listfunds and withdraw
1 parent e36cf35 commit 1fc5dc9

8 files changed

+452
-3
lines changed

‎doc/Makefile

+4-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ MANPAGES := doc/lightning-cli.1 \
1818
doc/lightning-sendpay.7 \
1919
doc/lightning-waitinvoice.7 \
2020
doc/lightning-waitanyinvoice.7 \
21-
doc/lightning-waitsendpay.7
21+
doc/lightning-waitsendpay.7 \
22+
doc/lightning-newaddr.7 \
23+
doc/lightning-withdraw.7 \
24+
doc/lightning-listfunds.7
2225

2326
doc-all: $(MANPAGES)
2427

‎doc/lightning-listfunds.7

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
'\" t
2+
.\" Title: lightning-listfunds
3+
.\" Author: [see the "AUTHOR" section]
4+
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5+
.\" Date: 04/26/2018
6+
.\" Manual: \ \&
7+
.\" Source: \ \&
8+
.\" Language: English
9+
.\"
10+
.TH "LIGHTNING\-LISTFUNDS" "7" "04/26/2018" "\ \&" "\ \&"
11+
.\" -----------------------------------------------------------------
12+
.\" * Define some portability stuff
13+
.\" -----------------------------------------------------------------
14+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
.\" http://bugs.debian.org/507673
16+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
.ie \n(.g .ds Aq \(aq
19+
.el .ds Aq '
20+
.\" -----------------------------------------------------------------
21+
.\" * set default formatting
22+
.\" -----------------------------------------------------------------
23+
.\" disable hyphenation
24+
.nh
25+
.\" disable justification (adjust text to left margin only)
26+
.ad l
27+
.\" -----------------------------------------------------------------
28+
.\" * MAIN CONTENT STARTS HERE *
29+
.\" -----------------------------------------------------------------
30+
.SH "NAME"
31+
lightning-listfunds \- Command showing all funds currently managed by the c\-lightning node\&.
32+
.SH "SYNOPSIS"
33+
.sp
34+
\fBlistfunds\fR
35+
.SH "DESCRIPTION"
36+
.sp
37+
The \fBlistfunds\fR RPC command displays all funds available, either in unspent outputs (UTXOs) in the internal wallet or funds locked in currently open channels\&.
38+
.SH "RETURN VALUE"
39+
.sp
40+
On success two arrays will be returned: \fIoutputs\fR with funds currently locked onchain in UTXOs and \fIchannels\fR with funds readily spendable in channels\&.
41+
.sp
42+
Each entry in \fIoutputs\fR will include:
43+
.sp
44+
.RS 4
45+
.ie n \{\
46+
\h'-04'\(bu\h'+03'\c
47+
.\}
48+
.el \{\
49+
.sp -1
50+
.IP \(bu 2.3
51+
.\}
52+
\fItxid\fR
53+
.RE
54+
.sp
55+
.RS 4
56+
.ie n \{\
57+
\h'-04'\(bu\h'+03'\c
58+
.\}
59+
.el \{\
60+
.sp -1
61+
.IP \(bu 2.3
62+
.\}
63+
\fIaddress\fR
64+
.RE
65+
.sp
66+
.RS 4
67+
.ie n \{\
68+
\h'-04'\(bu\h'+03'\c
69+
.\}
70+
.el \{\
71+
.sp -1
72+
.IP \(bu 2.3
73+
.\}
74+
\fIoutput\fR
75+
.RE
76+
.sp
77+
.RS 4
78+
.ie n \{\
79+
\h'-04'\(bu\h'+03'\c
80+
.\}
81+
.el \{\
82+
.sp -1
83+
.IP \(bu 2.3
84+
.\}
85+
\fIvalue\fR
86+
.RE
87+
.sp
88+
.RS 4
89+
.ie n \{\
90+
\h'-04'\(bu\h'+03'\c
91+
.\}
92+
.el \{\
93+
.sp -1
94+
.IP \(bu 2.3
95+
.\}
96+
\fIstatus\fR
97+
.RE
98+
.sp
99+
Each entry in \fIchannels\fR will include:
100+
.sp
101+
.RS 4
102+
.ie n \{\
103+
\h'-04'\(bu\h'+03'\c
104+
.\}
105+
.el \{\
106+
.sp -1
107+
.IP \(bu 2.3
108+
.\}
109+
\fIpeer_id\fR
110+
\- the peer with which the channel is opened\&.
111+
.RE
112+
.sp
113+
.RS 4
114+
.ie n \{\
115+
\h'-04'\(bu\h'+03'\c
116+
.\}
117+
.el \{\
118+
.sp -1
119+
.IP \(bu 2.3
120+
.\}
121+
\fIshort_channel_id\fR
122+
\- as per BOLT 7 (representing the block, transaction number and output index of the channel funding transaction)\&.
123+
.RE
124+
.sp
125+
.RS 4
126+
.ie n \{\
127+
\h'-04'\(bu\h'+03'\c
128+
.\}
129+
.el \{\
130+
.sp -1
131+
.IP \(bu 2.3
132+
.\}
133+
\fIchannel_sat\fR
134+
\- available satoshis on our node\(cqs end of the channel (values rounded to the nearest satoshi as internal storage is in milisatoshi)\&.
135+
.RE
136+
.sp
137+
.RS 4
138+
.ie n \{\
139+
\h'-04'\(bu\h'+03'\c
140+
.\}
141+
.el \{\
142+
.sp -1
143+
.IP \(bu 2.3
144+
.\}
145+
\fIchannel_total_sat\fR
146+
\- total channel value in satoshi (values rounded to the nearest satoshi as internal storage is in milisatoshi)\&.
147+
.RE
148+
.sp
149+
.RS 4
150+
.ie n \{\
151+
\h'-04'\(bu\h'+03'\c
152+
.\}
153+
.el \{\
154+
.sp -1
155+
.IP \(bu 2.3
156+
.\}
157+
\fIfunding_txid\fR
158+
\- funding transaction id\&.
159+
.RE
160+
.SH "AUTHOR"
161+
.sp
162+
Felix <fixone@gmail\&.com> is mainly responsible\&.
163+
.SH "SEE ALSO"
164+
.sp
165+
lightning\-newaddr(7), lightning\-fundchannel(7), lightning\-withdraw(7)
166+
.SH "RESOURCES"
167+
.sp
168+
Main web site: https://github\&.com/ElementsProject/lightning

‎doc/lightning-listfunds.7.txt

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
LIGHTNING-LISTFUNDS(7)
2+
======================
3+
:doctype: manpage
4+
5+
NAME
6+
----
7+
lightning-listfunds - Command showing all funds currently managed by
8+
the c-lightning node.
9+
10+
SYNOPSIS
11+
--------
12+
*listfunds*
13+
14+
DESCRIPTION
15+
-----------
16+
The *listfunds* RPC command displays all funds available, either in
17+
unspent outputs (UTXOs) in the internal wallet or funds locked in
18+
currently open channels.
19+
20+
RETURN VALUE
21+
------------
22+
On success two arrays will be returned: 'outputs' with funds
23+
currently locked onchain in UTXOs and 'channels' with funds
24+
readily spendable in channels.
25+
26+
Each entry in 'outputs' will include:
27+
28+
- 'txid'
29+
30+
- 'address'
31+
32+
- 'output'
33+
34+
- 'value'
35+
36+
- 'status'
37+
38+
Each entry in 'channels' will include:
39+
40+
- 'peer_id' - the peer with which the channel is opened.
41+
42+
- 'short_channel_id' - as per BOLT 7 (representing the block, transaction
43+
number and output index of the channel funding transaction).
44+
45+
- 'channel_sat' - available satoshis on our node's end of the channel
46+
(values rounded to the nearest satoshi as internal storage is in milisatoshi).
47+
48+
- 'channel_total_sat' - total channel value in satoshi
49+
(values rounded to the nearest satoshi as internal storage is in milisatoshi).
50+
51+
- 'funding_txid' - funding transaction id.
52+
53+
AUTHOR
54+
------
55+
Felix <[email protected]> is mainly responsible.
56+
57+
SEE ALSO
58+
--------
59+
lightning-newaddr(7), lightning-fundchannel(7), lightning-withdraw(7)
60+
61+
RESOURCES
62+
---------
63+
Main web site: https://github.com/ElementsProject/lightning

‎doc/lightning-listpayments.7

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: lightning-listpayments
33
.\" Author: [see the "AUTHOR" section]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 01/18/2018
5+
.\" Date: 04/26/2018
66
.\" Manual: \ \&
77
.\" Source: \ \&
88
.\" Language: English
99
.\"
10-
.TH "LIGHTNING\-LISTPAYME" "7" "01/18/2018" "\ \&" "\ \&"
10+
.TH "LIGHTNING\-LISTPAYME" "7" "04/26/2018" "\ \&" "\ \&"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------

‎doc/lightning-newaddr.7

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
'\" t
2+
.\" Title: lightning-newaddr
3+
.\" Author: [see the "AUTHOR" section]
4+
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5+
.\" Date: 04/26/2018
6+
.\" Manual: \ \&
7+
.\" Source: \ \&
8+
.\" Language: English
9+
.\"
10+
.TH "LIGHTNING\-NEWADDR" "7" "04/26/2018" "\ \&" "\ \&"
11+
.\" -----------------------------------------------------------------
12+
.\" * Define some portability stuff
13+
.\" -----------------------------------------------------------------
14+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
.\" http://bugs.debian.org/507673
16+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
.ie \n(.g .ds Aq \(aq
19+
.el .ds Aq '
20+
.\" -----------------------------------------------------------------
21+
.\" * set default formatting
22+
.\" -----------------------------------------------------------------
23+
.\" disable hyphenation
24+
.nh
25+
.\" disable justification (adjust text to left margin only)
26+
.ad l
27+
.\" -----------------------------------------------------------------
28+
.\" * MAIN CONTENT STARTS HERE *
29+
.\" -----------------------------------------------------------------
30+
.SH "NAME"
31+
lightning-newaddr \- Command for generating a new address to be used by c\-lightning\&.
32+
.SH "SYNOPSIS"
33+
.sp
34+
\fBnewaddr\fR [ \fIp2sh\-segwit\fR | \fIbech32\fR ]
35+
.SH "DESCRIPTION"
36+
.sp
37+
The \fBnewaddr\fR RPC command generates a new address which can subsequently be used to fund channels managed by the c\-lightning node\&.
38+
.sp
39+
The funding transaction needs to be confirmed before funds can be used\&.
40+
.sp
41+
The optional parameter specifies the type of address wanted i\&.e\&. p2sh\-segwit (e\&.g\&. 2MxaozoqWwiUcuD9KKgUSrLFDafLqimT9Ta on bitcoin testnet or 3MZxzq3jBSKNQ2e7dzneo9hy4FvNzmMmt3 on bitcoin mainnet) or bech32 (e\&.g\&. tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg on bitcoin testnet or bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej on bitcoin mainnet)\&.
42+
.sp
43+
If not specified the address generated is p2sh\-segwit\&.
44+
.SH "RETURN VALUE"
45+
.sp
46+
On success, a new address will be returned\&.
47+
.SH "ERRORS"
48+
.sp
49+
If a non recognized address type is requested an error message will be returned
50+
.SH "AUTHOR"
51+
.sp
52+
Felix <fixone@gmail\&.com> is mainly responsible\&.
53+
.SH "SEE ALSO"
54+
.sp
55+
lightning\-listfunds(7), lightning\-fundchannel(7), lightning\-withdraw(7)
56+
.SH "RESOURCES"
57+
.sp
58+
Main web site: https://github\&.com/ElementsProject/lightning

‎doc/lightning-newaddr.7.txt

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
LIGHTNING-NEWADDR(7)
2+
====================
3+
:doctype: manpage
4+
5+
NAME
6+
----
7+
lightning-newaddr - Command for generating a new address to
8+
be used by c-lightning.
9+
10+
SYNOPSIS
11+
--------
12+
*newaddr* [ 'p2sh-segwit' | 'bech32' ]
13+
14+
DESCRIPTION
15+
-----------
16+
The *newaddr* RPC command generates a new address which can
17+
subsequently be used to fund channels managed by the c-lightning node.
18+
19+
The funding transaction needs to be confirmed before funds can be used.
20+
21+
The optional parameter specifies the type of address wanted i.e.
22+
p2sh-segwit (e.g. 2MxaozoqWwiUcuD9KKgUSrLFDafLqimT9Ta on bitcoin testnet
23+
or 3MZxzq3jBSKNQ2e7dzneo9hy4FvNzmMmt3 on bitcoin mainnet) or bech32
24+
(e.g. tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg on bitcoin testnet or
25+
bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej on bitcoin mainnet).
26+
27+
If not specified the address generated is p2sh-segwit.
28+
29+
RETURN VALUE
30+
------------
31+
On success, a new address will be returned.
32+
33+
ERRORS
34+
------
35+
If a non recognized address type is requested an error message will be returned
36+
37+
AUTHOR
38+
------
39+
Felix <[email protected]> is mainly responsible.
40+
41+
SEE ALSO
42+
--------
43+
lightning-listfunds(7), lightning-fundchannel(7), lightning-withdraw(7)
44+
45+
RESOURCES
46+
---------
47+
Main web site: https://github.com/ElementsProject/lightning

0 commit comments

Comments
 (0)