Skip to content

Commit

Permalink
docs: update the docs in according with the new code
Browse files Browse the repository at this point in the history
Suggested-by: @rustyrussell 

Signed-off-by: Vincenzo Palazzo <[email protected]>

# Title: 

Signed-off-by: Vincenzo Palazzo <[email protected]>
  • Loading branch information
vincenzopalazzo authored and rustyrussell committed Jun 27, 2022
1 parent 4b11f96 commit c07d44b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
4 changes: 3 additions & 1 deletion bitcoin/chainparams.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ struct chainparams {
const struct bitcoin_blkid genesis_blockhash;
const int rpc_port;
/**
* BOLT 1: The default TCP port depends on the network used. The most common networks are:
* BOLT 1:
*
* The default TCP port depends on the network used. The most common networks are:
*
* - Bitcoin mainet with port number 9735 or the corresponding hexadecimal `0x2607`;
* - Bitcoin testnet with port number 19735 (`0x4D17`);
Expand Down
6 changes: 5 additions & 1 deletion doc/lightning-connect.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ be of the form *id@host* or *id@host:port*. In this case, the *host* and

*host* is the peer's hostname or IP address.

If not specified, the *port* defaults to 9735.
If not specified, the *port* depends on the current network:
- bitcoin **mainnet**: 9735.
- bitcoin **testnet**: 19735.
- bitcoin **signet**: 39735.
- bitcoin **regtest**: 19846.

If *host* is not specified (or doesn't work), the connection will be attempted to an IP
belonging to *id* obtained through gossip with other already connected
Expand Down
3 changes: 2 additions & 1 deletion doc/lightningd-config.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,8 @@ network.
Note that for simple setups, the implicit *autolisten* option does the
right thing: for the mainnet (bitcoin) network it will try to bind to
port 9735 on IPv4 and IPv6, and will announce it to peers if it seems
like a public address.
like a public address (and other default ports for other networks,
as described below).

Core Lightning also support IPv4/6 address discovery behind NAT routers.
If your node detects an new public address, it will update its announcement.
Expand Down

0 comments on commit c07d44b

Please sign in to comment.