Skip to content

*: improve NAT hole punching #4516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KaloyanTanev wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −77
Open

*: improve NAT hole punching #4516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion app/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,6 @@ func wireP2P(ctx context.Context, life *lifecycle.Manager, conf Config,
life.RegisterStart(lifecycle.AsyncAppCtx, lifecycle.StartP2PPing, p2p.NewPingService(p2pNode, peerIDs, conf.TestConfig.TestPingConfig))
life.RegisterStart(lifecycle.AsyncAppCtx, lifecycle.StartP2PEventCollector, p2p.NewEventCollector(p2pNode))
life.RegisterStart(lifecycle.AsyncAppCtx, lifecycle.StartP2PRouters, p2p.NewRelayRouter(p2pNode, peerIDs, relays))
life.RegisterStart(lifecycle.AsyncAppCtx, lifecycle.StartForceDirectConns, p2p.ForceDirectConnections(p2pNode, peerIDs))
life.RegisterStart(lifecycle.AsyncAppCtx, lifecycle.StartForceQUICConns, p2p.UpgradeToQUICConnections(p2pNode, peerIDs))

return p2pNode, nil
Expand Down
1 change: 0 additions & 1 deletion app/lifecycle/order.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ const (
StartValidatorAPI
StartP2PPing
StartP2PRouters
StartForceDirectConns
StartForceQUICConns
StartP2PConsensus
StartSimulator
Expand Down
28 changes: 13 additions & 15 deletions app/lifecycle/orderstart_string.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions app/lifecycle/orderstop_string.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

59 changes: 2 additions & 57 deletions p2p/p2p.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ func NewNode(ctx context.Context, cfg Config, key *k1.PrivateKey, connGater Conn
libp2p.ConnectionGater(connGater),
// Enable Autonat (required for hole punching)
libp2p.EnableNATService(),
libp2p.EnableHolePunching(),
libp2p.AddrsFactory(func(internalAddrs []ma.Multiaddr) []ma.Multiaddr {
return filterAdvertisedAddrs(externalAddrs, internalAddrs, filterPrivateAddrs)
}),
Expand Down Expand Up @@ -292,49 +293,6 @@ func (f peerRoutingFunc) FindPeer(ctx context.Context, p peer.ID) (peer.AddrInfo
return f(ctx, p)
}

// ForceDirectConnections attempts to establish a direct connection if there is an existing relay connection to the peer.
// The idea is to enable switching to a direct connection as soon as the host has a connection to the peer.
func ForceDirectConnections(p2pNode host.Host, peerIDs []peer.ID) lifecycle.HookFuncCtx {
forceDirectConn := func(ctx context.Context) {
for _, p := range peerIDs {
if p2pNode.ID() == p {
continue // Skip self
}

conns := p2pNode.Network().ConnsToPeer(p)
if len(conns) == 0 {
// Skip if there isn't any existing connection to peer. Note that we only force direct connection
// if there is already an existing relay connection between the host and peer.
continue
}

if isDirectConnAvailable(conns) {
continue
}

// All existing connections are through relays, so we can try force dialing a direct connection.
err := p2pNode.Connect(network.WithForceDirectDial(ctx, "relay_to_direct"), peer.AddrInfo{ID: p})
if err == nil {
log.Debug(ctx, "Forced direct connection to peer successful", z.Str("peer", PeerName(p)))
}
}
}

return func(ctx context.Context) {
ticker := time.NewTicker(1 * time.Minute)
defer ticker.Stop()

for {
select {
case <-ctx.Done():
return
case <-ticker.C:
forceDirectConn(ctx)
}
}
}
}

// isQUICEnabled returns true if the host has an address or listening address on QUIC.
func isQUICEnabled(h host.Host) bool {
if slices.ContainsFunc(h.Network().ListenAddresses(), isQUICAddr) {
Expand All @@ -350,19 +308,6 @@ func isQUICEnabled(h host.Host) bool {
return false
}

// isDirectConnAvailable returns true if direct connection is available in the given set of connections.
func isDirectConnAvailable(conns []network.Conn) bool {
for _, conn := range conns {
if IsRelayAddr(conn.RemoteMultiaddr()) {
continue
}

return true
}

return false
}

// UpgradeToQUICConnections tries to upgrade a direct TCP connection to a direct QUIC connection
// if there is known QUIC addresses from the peerstore.
func UpgradeToQUICConnections(p2pNode host.Host, peerIDs []peer.ID) lifecycle.HookFuncCtx {
Expand Down Expand Up @@ -457,7 +402,7 @@ func UpgradeToQUICConnections(p2pNode host.Host, peerIDs []peer.ID) lifecycle.Ho

if !hasDirectTCPConn(conns) {
log.Debug(ctx, "No direct connection via TCP to peer", z.Str("peer", PeerName(p)), z.Any("conns", conns))
continue // no direct TPC connection to upgrade to QUIC, ForceDirectConnections shall upgrade to direct
continue // no direct TCP connection to upgrade to QUIC, hole punching shall upgrade to direct
}

// Get known QUIC addrs from peerstore
Expand Down
Loading