package node import ( "context" "errors" "net" "strconv" "github.com/ethereum/go-ethereum/p2p/enode" "github.com/ethereum/go-ethereum/p2p/enr" "github.com/libp2p/go-libp2p/core/event" "github.com/multiformats/go-multiaddr" ma "github.com/multiformats/go-multiaddr" madns "github.com/multiformats/go-multiaddr-dns" "github.com/waku-org/go-waku/waku/v2/protocol" wenr "github.com/waku-org/go-waku/waku/v2/protocol/enr" "github.com/waku-org/go-waku/waku/v2/protocol/relay" "go.uber.org/zap" ) func (w *WakuNode) updateLocalNode(localnode *enode.LocalNode, multiaddrs []ma.Multiaddr, ipAddr *net.TCPAddr, udpPort uint, wakuFlags wenr.WakuEnrBitfield, advertiseAddr []ma.Multiaddr, shouldAutoUpdate bool) error { var options []wenr.ENROption options = append(options, wenr.WithUDPPort(udpPort)) options = append(options, wenr.WithWakuBitfield(wakuFlags)) // Reset ENR fields wenr.DeleteField(localnode, wenr.MultiaddrENRField) wenr.DeleteField(localnode, enr.TCP(0).ENRKey()) wenr.DeleteField(localnode, enr.IPv4{}.ENRKey()) wenr.DeleteField(localnode, enr.IPv6{}.ENRKey()) if advertiseAddr != nil { // An advertised address disables libp2p address updates // and discv5 predictions ipAddr, err := selectMostExternalAddress(advertiseAddr) if err != nil { return err } options = append(options, wenr.WithIP(ipAddr)) } else if !shouldAutoUpdate { // We received a libp2p address update. Autoupdate is disabled // Using a static ip will disable endpoint prediction. options = append(options, wenr.WithIP(ipAddr)) } else { if ipAddr.Port != 0 { // We received a libp2p address update, but we should still // allow discv5 to update the enr record. We set the localnode // keys manually. It's possible that the ENR record might get // updated automatically ip4 := ipAddr.IP.To4() ip6 := ipAddr.IP.To16() if ip4 != nil && !ip4.IsUnspecified() { localnode.SetFallbackIP(ip4) localnode.Set(enr.IPv4(ip4)) localnode.Set(enr.TCP(uint16(ipAddr.Port))) } else { localnode.Delete(enr.IPv4{}) localnode.Delete(enr.TCP(0)) localnode.SetFallbackIP(net.IP{127, 0, 0, 1}) } if ip4 == nil && ip6 != nil && !ip6.IsUnspecified() { localnode.Set(enr.IPv6(ip6)) localnode.Set(enr.TCP6(ipAddr.Port)) } else { localnode.Delete(enr.IPv6{}) localnode.Delete(enr.TCP6(0)) } } } // Writing the IP + Port has priority over writting the multiaddress which might fail or not // depending on the enr having space options = append(options, wenr.WithMultiaddress(multiaddrs...)) return wenr.Update(w.log, localnode, options...) } func isPrivate(addr *net.TCPAddr) bool { return addr.IP.IsPrivate() } func isExternal(addr *net.TCPAddr) bool { return !isPrivate(addr) && !addr.IP.IsLoopback() && !addr.IP.IsUnspecified() } func isLoopback(addr *net.TCPAddr) bool { return addr.IP.IsLoopback() } func filterIP(ss []*net.TCPAddr, fn func(*net.TCPAddr) bool) (ret []*net.TCPAddr) { for _, s := range ss { if fn(s) { ret = append(ret, s) } } return } func extractIPAddressForENR(addr ma.Multiaddr) (*net.TCPAddr, error) { // It's a p2p-circuit address. We shouldnt use these // for building the ENR record default keys _, err := addr.ValueForProtocol(ma.P_CIRCUIT) if err == nil { return nil, errors.New("can't use IP address from a p2p-circuit address") } // ws and wss addresses are handled by the multiaddr key // they shouldnt be used for building the ENR record default keys _, err = addr.ValueForProtocol(ma.P_WS) if err == nil { return nil, errors.New("can't use IP address from a ws address") } _, err = addr.ValueForProtocol(ma.P_WSS) if err == nil { return nil, errors.New("can't use IP address from a wss address") } var ipStr string dns4, err := addr.ValueForProtocol(ma.P_DNS4) if err != nil { ipStr, err = addr.ValueForProtocol(ma.P_IP4) if err != nil { return nil, err } } else { netIP, err := net.ResolveIPAddr("ip4", dns4) if err != nil { return nil, err } ipStr = netIP.String() } portStr, err := addr.ValueForProtocol(ma.P_TCP) if err != nil { return nil, err } port, err := strconv.Atoi(portStr) if err != nil { return nil, err } return &net.TCPAddr{ IP: net.ParseIP(ipStr), Port: port, }, nil } func selectMostExternalAddress(addresses []ma.Multiaddr) (*net.TCPAddr, error) { var ipAddrs []*net.TCPAddr for _, addr := range addresses { ipAddr, err := extractIPAddressForENR(addr) if err != nil { continue } ipAddrs = append(ipAddrs, ipAddr) } externalIPs := filterIP(ipAddrs, isExternal) if len(externalIPs) > 0 { return externalIPs[0], nil } privateIPs := filterIP(ipAddrs, isPrivate) if len(privateIPs) > 0 { return privateIPs[0], nil } loopback := filterIP(ipAddrs, isLoopback) if len(loopback) > 0 { return loopback[0], nil } return nil, errors.New("could not obtain ip address") } func decapsulateP2P(addr ma.Multiaddr) (ma.Multiaddr, error) { p2p, err := addr.ValueForProtocol(ma.P_P2P) if err != nil { return nil, err } p2pAddr, err := ma.NewMultiaddr("/p2p/" + p2p) if err != nil { return nil, err } addr = addr.Decapsulate(p2pAddr) return addr, nil } func decapsulateCircuitRelayAddr(ctx context.Context, addr ma.Multiaddr) (ma.Multiaddr, error) { _, err := addr.ValueForProtocol(ma.P_CIRCUIT) if err != nil { return nil, errors.New("not a circuit relay address") } // We remove the node's multiaddress from the addr addr, _ = ma.SplitFunc(addr, func(c ma.Component) bool { return c.Protocol().Code == ma.P_CIRCUIT }) // If the multiaddress is a dns4 address, we resolve it addrs, err := madns.DefaultResolver.Resolve(ctx, addr) if err != nil { return nil, err } if len(addrs) > 0 { return addrs[0], nil } return addr, nil } func selectWSListenAddresses(addresses []ma.Multiaddr) ([]ma.Multiaddr, error) { var result []ma.Multiaddr for _, addr := range addresses { // It's a p2p-circuit address. We dont use these at this stage yet _, err := addr.ValueForProtocol(ma.P_CIRCUIT) if err == nil { continue } _, noWS := addr.ValueForProtocol(ma.P_WSS) _, noWSS := addr.ValueForProtocol(ma.P_WS) if noWS != nil && noWSS != nil { // Neither WS or WSS found continue } addr, err = decapsulateP2P(addr) if err == nil { result = append(result, addr) } } return result, nil } func selectCircuitRelayListenAddresses(ctx context.Context, addresses []ma.Multiaddr) ([]ma.Multiaddr, error) { var result []ma.Multiaddr for _, addr := range addresses { addr, err := decapsulateCircuitRelayAddr(ctx, addr) if err != nil { continue } _, noWS := addr.ValueForProtocol(ma.P_WSS) _, noWSS := addr.ValueForProtocol(ma.P_WS) if noWS == nil || noWSS == nil { // WS or WSS found continue } result = append(result, addr) } return result, nil } func filter0Port(addresses []ma.Multiaddr) ([]ma.Multiaddr, error) { var result []ma.Multiaddr for _, addr := range addresses { portStr, err := addr.ValueForProtocol(ma.P_TCP) if err != nil && !errors.Is(err, multiaddr.ErrProtocolNotFound) { return nil, err } port, err := strconv.Atoi(portStr) if err != nil { return nil, err } if port != 0 { result = append(result, addr) } } return result, nil } func (w *WakuNode) getENRAddresses(ctx context.Context, addrs []ma.Multiaddr) (extAddr *net.TCPAddr, multiaddr []ma.Multiaddr, err error) { extAddr, err = selectMostExternalAddress(addrs) if err != nil { return nil, nil, err } wssAddrs, err := selectWSListenAddresses(addrs) if err != nil { return nil, nil, err } circuitAddrs, err := selectCircuitRelayListenAddresses(ctx, addrs) if err != nil { return nil, nil, err } if len(circuitAddrs) != 0 { // Node is unreachable, hence why we have circuit relay multiaddr // We prefer these instead of any ws/s address multiaddr = append(multiaddr, circuitAddrs...) } else { multiaddr = append(multiaddr, wssAddrs...) } multiaddr, err = filter0Port(multiaddr) if err != nil { return nil, nil, err } return } func (w *WakuNode) setupENR(ctx context.Context, addrs []ma.Multiaddr) error { ipAddr, multiaddresses, err := w.getENRAddresses(ctx, addrs) if err != nil { w.log.Error("obtaining external address", zap.Error(err)) return err } err = w.updateLocalNode(w.localNode, multiaddresses, ipAddr, w.opts.udpPort, w.wakuFlag, w.opts.advertiseAddrs, w.opts.discV5autoUpdate) if err != nil { w.log.Error("updating localnode ENR record", zap.Error(err)) return err } if w.Relay() != nil { err = w.watchTopicShards(ctx) if err != nil { return err } } w.enrChangeCh <- struct{}{} return nil } func (w *WakuNode) SetRelayShards(rs protocol.RelayShards) error { err := wenr.Update(w.log, w.localNode, wenr.WithWakuRelaySharding(rs)) if err != nil { return err } return nil } func (w *WakuNode) watchTopicShards(ctx context.Context) error { evtRelaySubscribed, err := w.Relay().Events().Subscribe(new(relay.EvtRelaySubscribed)) if err != nil { return err } evtRelayUnsubscribed, err := w.Relay().Events().Subscribe(new(relay.EvtRelayUnsubscribed)) if err != nil { return err } go func() { defer evtRelaySubscribed.Close() defer evtRelayUnsubscribed.Close() for { select { case <-ctx.Done(): return case <-evtRelayUnsubscribed.Out(): case <-evtRelaySubscribed.Out(): topics := w.Relay().Topics() rs, err := protocol.TopicsToRelayShards(topics...) if err != nil { w.log.Warn("could not set ENR shard info", zap.Error(err)) continue } if len(rs) > 0 { if len(rs) > 1 { w.log.Warn("could not set ENR shard info", zap.String("error", "multiple clusters found, use sharded topics within the same cluster")) continue } } if len(rs) == 1 { w.log.Info("updating advertised relay shards in ENR", zap.Any("newShardInfo", rs[0])) if len(rs[0].ShardIDs) != len(topics) { w.log.Warn("A mix of named and static shards found. ENR shard will contain only the following shards", zap.Any("shards", rs[0])) } err = wenr.Update(w.log, w.localNode, wenr.WithWakuRelaySharding(rs[0])) if err != nil { w.log.Warn("could not set ENR shard info", zap.Error(err)) continue } w.enrChangeCh <- struct{}{} } } } }() return nil } func (w *WakuNode) registerAndMonitorReachability(ctx context.Context) { var myEventSub event.Subscription var err error if myEventSub, err = w.host.EventBus().Subscribe(new(event.EvtLocalReachabilityChanged)); err != nil { w.log.Error("failed to register with libp2p for reachability status", zap.Error(err)) return } w.wg.Add(1) go func() { defer myEventSub.Close() defer w.wg.Done() for { select { case evt := <-myEventSub.Out(): reachability := evt.(event.EvtLocalReachabilityChanged).Reachability w.log.Info("Node reachability changed", zap.Stringer("newReachability", reachability)) case <-ctx.Done(): return } } }() }