forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lightning-connect.7.txt
64 lines (49 loc) · 1.59 KB
/
lightning-connect.7.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
LIGHTNING-CONNECT(7)
====================
:doctype: manpage
NAME
----
lightning-connect - Command for connecting to another
lightning node.
SYNOPSIS
--------
*connect* 'node_id'[@('ip_addr'|'hostname')[:'port']]
or
*connect* 'node_id'[ ('ip_addr'|'hostname')[:'port']]
DESCRIPTION
-----------
The *connect* RPC command establishes a new connection
with another node in the Lightning Network.
'node_id' represents the target node's public key and
'ip_addr' can be either IPv4 or IPv6.
If not specified the 'port' is assumed to be 9375
(default lightning port).
If neither 'ip_addr' or 'hostname' is specified,
connection will be attempted to an IP belonging to
'node_id' learned through gossip with other already
connected peers
Connecting to a node is just the first step in opening
a channel with another node, once the peer is connected
a channel can be opened with lightning-fundchannel(7)
RETURN VALUE
------------
On success the response will include just the peer id
(peer's public key)
ERRORS
------
If 'node_id' or 'ip_addr' are invalid or if 'hostname'
can't be resolved to a valid IP address an error message
will be returned. An error will also be returned if the
simplified version (only 'node_id') is used and there's
no published IP for the peer. *connect* will make up to
10(?) attempts to connect to the peer before giving up
AUTHOR
------
Felix <[email protected]> is mainly responsible.
SEE ALSO
--------
lightning-fundchannel(7), lightning-listpeers(7),
lightning-listchannels(7), lightning-disconnect(7)
RESOURCES
---------
Main web site: https://github.com/ElementsProject/lightning