2018-04-26 11:18:36 +01:00
|
|
|
LIGHTNING-CONNECT(7)
|
|
|
|
|
====================
|
|
|
|
|
:doctype: manpage
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
lightning-connect - Command for connecting to another
|
|
|
|
|
lightning node.
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2019-02-08 16:53:45 +00:00
|
|
|
*connect* 'id' ['host' 'port']
|
2018-04-26 11:18:36 +01:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
The *connect* RPC command establishes a new connection
|
|
|
|
|
with another node in the Lightning Network.
|
|
|
|
|
|
2019-02-08 16:53:45 +00:00
|
|
|
'id' represents the target node's public key.
|
|
|
|
|
As a convenience, 'id' may be of the form 'id@host' or 'id@host:port'.
|
|
|
|
|
In this case, the 'host' and 'port' parameters must be omitted.
|
|
|
|
|
|
|
|
|
|
'host' is the peer's hostname or IP address.
|
2018-04-26 11:18:36 +01:00
|
|
|
|
2019-02-08 16:53:45 +00:00
|
|
|
If not specified, the 'port' defaults to 9375.
|
2018-04-26 11:18:36 +01:00
|
|
|
|
2019-02-08 16:53:45 +00:00
|
|
|
If 'host' is not specified, the
|
2018-04-26 11:18:36 +01:00
|
|
|
connection will be attempted to an IP belonging to
|
2019-02-08 16:53:45 +00:00
|
|
|
'id' obtained through gossip with other already
|
|
|
|
|
connected peers.
|
2018-04-26 11:18:36 +01:00
|
|
|
|
|
|
|
|
Connecting to a node is just the first step in opening
|
2019-02-08 16:53:45 +00:00
|
|
|
a channel with another node.
|
|
|
|
|
Once the peer is connected a channel can be opened with
|
|
|
|
|
lightning-fundchannel(7).
|
2018-04-26 11:18:36 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
RETURN VALUE
|
|
|
|
|
------------
|
2019-02-08 16:53:45 +00:00
|
|
|
On success the peer 'id' is returned.
|
2018-04-26 11:18:36 +01:00
|
|
|
|
2019-02-08 16:53:45 +00:00
|
|
|
The following error codes may occur:
|
|
|
|
|
|
|
|
|
|
* -1. Catchall nonspecific error.
|
|
|
|
|
This may occur if the host is not valid or there are problems
|
|
|
|
|
communicating with the peer.
|
|
|
|
|
*connect* will make up to 10 attempts to connect to the peer before
|
|
|
|
|
giving up.
|
2018-04-26 11:18:36 +01:00
|
|
|
|
|
|
|
|
AUTHOR
|
|
|
|
|
------
|
2019-02-08 16:53:45 +00:00
|
|
|
Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
|
|
|
|
|
Felix <fixone@gmail.com> is the original author of this manpage.
|
2018-04-26 11:18:36 +01:00
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
lightning-fundchannel(7), lightning-listpeers(7),
|
|
|
|
|
lightning-listchannels(7), lightning-disconnect(7)
|
|
|
|
|
|
|
|
|
|
RESOURCES
|
|
|
|
|
---------
|
|
|
|
|
Main web site: https://github.com/ElementsProject/lightning
|
