mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
b0d6996ed6
This matters: if we connected, the address is probably usable for future connections.
But if they connected, the port is probably not (but the IP address may be).
Changelog-Added: JSON-RPC: `connect` returns "direction" ("in": they iniatated, or "out": we initiated)
Changelog-Added: plugins: `peer_connected` hook and `connect` notifications have "direction" field.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
101 lines
2.6 KiB
Groff
Generated
101 lines
2.6 KiB
Groff
Generated
.TH "LIGHTNING-CONNECT" "7" "" "" "lightning-connect"
|
||
.SH NAME
|
||
lightning-connect - Command for connecting to another lightning node
|
||
.SH SYNOPSIS
|
||
|
||
\fBconnect\fR \fIid\fR [\fIhost\fR \fIport\fR]
|
||
|
||
.SH DESCRIPTION
|
||
|
||
The \fBconnect\fR RPC command establishes a new connection with another
|
||
node in the Lightning Network\.
|
||
|
||
|
||
\fIid\fR represents the target node’s public key\. As a convenience, \fIid\fR may
|
||
be of the form \fIid@host\fR or \fIid@host:port\fR\. In this case, the \fIhost\fR and
|
||
\fIport\fR parameters must be omitted\.
|
||
|
||
|
||
\fIhost\fR is the peer’s hostname or IP address\.
|
||
|
||
|
||
If not specified, the \fIport\fR defaults to 9735\.
|
||
|
||
|
||
If \fIhost\fR is not specified (or doesn't work), the connection will be attempted to an IP
|
||
belonging to \fIid\fR obtained through gossip with other already connected
|
||
peers\.
|
||
This can fail if your C-lightning node is a fresh install that has not
|
||
connected to any peers yet (your node has no gossip yet),
|
||
or if the target \fIid\fR is a fresh install that has no channels yet
|
||
(nobody will gossip about a node until it has one published channel)\.
|
||
|
||
|
||
If \fIhost\fR begins with a \fI/\fR it is interpreted as a local path, and the
|
||
connection will be made to that local socket (see \fBbind-addr\fR in
|
||
\fBlightningd-config\fR(5))\.
|
||
|
||
|
||
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
|
||
\fBlightning-fundchannel\fR(7)\.
|
||
|
||
.SH RETURN VALUE
|
||
|
||
On success the peer \fIid\fR is returned, as well as a hexidecimal
|
||
\fIfeatures\fR bitmap, a \fIdirection\fR ("in" if they connected to us, "out"
|
||
if we connected to them") and an \fIaddress\fR object as per
|
||
\fBlightning-listnodes\fR(7)\. Note that \fIaddress\fR will be less useful if
|
||
"direction" is "in", especially if a proxy is in use\.
|
||
|
||
.SH ERRORS
|
||
|
||
On failure, one of the following errors will be returned:
|
||
|
||
.nf
|
||
.RS
|
||
{ "code" : 400, "message" : "Unable to connect, no address known for peer" }
|
||
|
||
|
||
.RE
|
||
|
||
.fi
|
||
|
||
If some addresses are known but connecting to all of them failed, the message
|
||
will contain details about the failures:
|
||
|
||
.nf
|
||
.RS
|
||
{ "code" : 401, "message" : "..." }
|
||
|
||
|
||
.RE
|
||
|
||
.fi
|
||
|
||
If the given parameters are wrong:
|
||
|
||
.nf
|
||
.RS
|
||
{ "code" : -32602, "message" : "..." }
|
||
|
||
|
||
.RE
|
||
|
||
.fi
|
||
.SH AUTHOR
|
||
|
||
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
|
||
Felix \fI<fixone@gmail.com\fR> is the original author of this manpage\.
|
||
|
||
.SH SEE ALSO
|
||
|
||
\fBlightning-fundchannel\fR(7), \fBlightning-listpeers\fR(7),
|
||
\fBlightning-listchannels\fR(7), \fBlightning-disconnect\fR(7)
|
||
|
||
.SH RESOURCES
|
||
|
||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||
|
||
\" SHA256STAMP:a392b6683fad5fe218e7a985e1eaf5d7439f38d7c74212c275cfa64db284efc0
|