package peermanager import ( "context" "time" "github.com/libp2p/go-libp2p/core/event" "github.com/libp2p/go-libp2p/core/host" "github.com/libp2p/go-libp2p/core/network" "github.com/libp2p/go-libp2p/core/peer" "github.com/libp2p/go-libp2p/core/peerstore" "github.com/libp2p/go-libp2p/core/protocol" ma "github.com/multiformats/go-multiaddr" "github.com/waku-org/go-waku/logging" wps "github.com/waku-org/go-waku/waku/v2/peerstore" wenr "github.com/waku-org/go-waku/waku/v2/protocol/enr" "github.com/waku-org/go-waku/waku/v2/protocol/relay" "github.com/waku-org/go-waku/waku/v2/utils" "go.uber.org/zap" ) // PeerManager applies various controls and manage connections towards peers. type PeerManager struct { peerConnector *PeerConnectionStrategy maxRelayPeers int logger *zap.Logger InRelayPeersTarget int OutRelayPeersTarget int host host.Host serviceSlots *ServiceSlots ctx context.Context sub event.Subscription } const peerConnectivityLoopSecs = 15 // 80% relay peers 20% service peers func relayAndServicePeers(maxConnections int) (int, int) { return maxConnections - maxConnections/5, maxConnections / 5 } // 66% inRelayPeers 33% outRelayPeers func inAndOutRelayPeers(relayPeers int) (int, int) { outRelayPeers := relayPeers / 3 // const minOutRelayConns = 10 if outRelayPeers < minOutRelayConns { outRelayPeers = minOutRelayConns } return relayPeers - outRelayPeers, outRelayPeers } // NewPeerManager creates a new peerManager instance. func NewPeerManager(maxConnections int, logger *zap.Logger) *PeerManager { maxRelayPeers, _ := relayAndServicePeers(maxConnections) inRelayPeersTarget, outRelayPeersTarget := inAndOutRelayPeers(maxRelayPeers) pm := &PeerManager{ logger: logger.Named("peer-manager"), maxRelayPeers: maxRelayPeers, InRelayPeersTarget: inRelayPeersTarget, OutRelayPeersTarget: outRelayPeersTarget, serviceSlots: NewServiceSlot(), } logger.Info("PeerManager init values", zap.Int("maxConnections", maxConnections), zap.Int("maxRelayPeers", maxRelayPeers), zap.Int("outRelayPeersTarget", outRelayPeersTarget), zap.Int("inRelayPeersTarget", pm.InRelayPeersTarget)) return pm } // SetHost sets the host to be used in order to access the peerStore. func (pm *PeerManager) SetHost(host host.Host) { pm.host = host } // SetPeerConnector sets the peer connector to be used for establishing relay connections. func (pm *PeerManager) SetPeerConnector(pc *PeerConnectionStrategy) { pm.peerConnector = pc } func (pm *PeerManager) SubscribeToRelayEvtBus(bus event.Bus) error { var err error pm.sub, err = bus.Subscribe(new(relay.EvtPeerTopic)) if err != nil { return err } return nil } func (pm *PeerManager) peerEventLoop(ctx context.Context) { defer pm.sub.Close() for { select { case e := <-pm.sub.Out(): peerEvt := e.(relay.EvtPeerTopic) wps := pm.host.Peerstore().(*wps.WakuPeerstoreImpl) peerID := peerEvt.PeerID if peerEvt.State == relay.PEER_JOINED { err := wps.AddPubSubTopic(peerID, peerEvt.Topic) if err != nil { pm.logger.Error("failed to add pubSubTopic for peer", logging.HostID("peerID", peerID), zap.String("topic", peerEvt.Topic), zap.Error(err)) } } else if peerEvt.State == relay.PEER_LEFT { err := wps.RemovePubSubTopic(peerID, peerEvt.Topic) if err != nil { pm.logger.Error("failed to remove pubSubTopic for peer", logging.HostID("peerID", peerID), zap.Error(err)) } } else { pm.logger.Error("unknown peer event received", zap.Int("eventState", int(peerEvt.State))) } case <-ctx.Done(): return } } } // Start starts the processing to be done by peer manager. func (pm *PeerManager) Start(ctx context.Context) { pm.ctx = ctx if pm.sub != nil { go pm.peerEventLoop(ctx) } go pm.connectivityLoop(ctx) } // This is a connectivity loop, which currently checks and prunes inbound connections. func (pm *PeerManager) connectivityLoop(ctx context.Context) { t := time.NewTicker(peerConnectivityLoopSecs * time.Second) defer t.Stop() for { select { case <-ctx.Done(): return case <-t.C: pm.connectToRelayPeers() } } } // GroupPeersByDirection returns all the connected peers in peer store grouped by Inbound or outBound direction func (pm *PeerManager) GroupPeersByDirection() (inPeers peer.IDSlice, outPeers peer.IDSlice, err error) { peers := pm.host.Network().Peers() for _, p := range peers { direction, err := pm.host.Peerstore().(wps.WakuPeerstore).Direction(p) if err == nil { if direction == network.DirInbound { inPeers = append(inPeers, p) } else if direction == network.DirOutbound { outPeers = append(outPeers, p) } } else { pm.logger.Error("Failed to retrieve peer direction", logging.HostID("peerID", p), zap.Error(err)) } } return inPeers, outPeers, nil } func (pm *PeerManager) getRelayPeers() (inRelayPeers peer.IDSlice, outRelayPeers peer.IDSlice) { //Group peers by their connected direction inbound or outbound. inPeers, outPeers, err := pm.GroupPeersByDirection() if err != nil { return } pm.logger.Debug("Number of peers connected", zap.Int("inPeers", inPeers.Len()), zap.Int("outPeers", outPeers.Len())) //Need to filter peers to check if they support relay if inPeers.Len() != 0 { inRelayPeers, _ = utils.FilterPeersByProto(pm.host, inPeers, relay.WakuRelayID_v200) } if outPeers.Len() != 0 { outRelayPeers, _ = utils.FilterPeersByProto(pm.host, outPeers, relay.WakuRelayID_v200) } return } func (pm *PeerManager) connectToRelayPeers() { //Check for out peer connections and connect to more peers. inRelayPeers, outRelayPeers := pm.getRelayPeers() pm.logger.Info("Number of Relay peers connected", zap.Int("inRelayPeers", inRelayPeers.Len()), zap.Int("outRelayPeers", outRelayPeers.Len())) if inRelayPeers.Len() > 0 && inRelayPeers.Len() > pm.InRelayPeersTarget { pm.pruneInRelayConns(inRelayPeers) } if outRelayPeers.Len() > pm.OutRelayPeersTarget { return } totalRelayPeers := inRelayPeers.Len() + outRelayPeers.Len() // Establish additional connections connected peers are lesser than target. //What if the not connected peers in peerstore are not relay peers??? if totalRelayPeers < pm.maxRelayPeers { //Find not connected peers. notConnectedPeers := pm.getNotConnectedPers() if notConnectedPeers.Len() == 0 { return } //Connect to eligible peers. numPeersToConnect := pm.maxRelayPeers - totalRelayPeers if numPeersToConnect > notConnectedPeers.Len() { numPeersToConnect = notConnectedPeers.Len() } pm.connectToPeers(notConnectedPeers[0:numPeersToConnect]) } //Else: Should we raise some sort of unhealthy event?? } func addrInfoToPeerData(origin wps.Origin, peerID peer.ID, host host.Host) PeerData { return PeerData{ Origin: origin, AddrInfo: peer.AddrInfo{ ID: peerID, Addrs: host.Peerstore().Addrs(peerID), }, } } func (pm *PeerManager) connectToPeers(peers peer.IDSlice) { for _, peerID := range peers { peerData := addrInfoToPeerData(wps.PeerManager, peerID, pm.host) pm.peerConnector.PushToChan(peerData) } } func (pm *PeerManager) getNotConnectedPers() (notConnectedPeers peer.IDSlice) { for _, peerID := range pm.host.Peerstore().Peers() { if pm.host.Network().Connectedness(peerID) != network.Connected { notConnectedPeers = append(notConnectedPeers, peerID) } } return } func (pm *PeerManager) pruneInRelayConns(inRelayPeers peer.IDSlice) { //Start disconnecting peers, based on what? //For now, just disconnect most recently connected peers //TODO: Need to have more intelligent way of doing this, maybe peer scores. pm.logger.Info("Number of in peer connections exceed targer relay peers, hence pruning", zap.Int("inRelayPeers", inRelayPeers.Len()), zap.Int("inRelayPeersTarget", pm.InRelayPeersTarget)) for pruningStartIndex := pm.InRelayPeersTarget; pruningStartIndex < inRelayPeers.Len(); pruningStartIndex++ { p := inRelayPeers[pruningStartIndex] err := pm.host.Network().ClosePeer(p) if err != nil { pm.logger.Warn("Failed to disconnect connection towards peer", logging.HostID("peerID", p)) } pm.logger.Debug("Successfully disconnected connection towards peer", logging.HostID("peerID", p)) } } // AddDiscoveredPeer to add dynamically discovered peers. // Note that these peers will not be set in service-slots. // TODO: It maybe good to set in service-slots based on services supported in the ENR func (pm *PeerManager) AddDiscoveredPeer(p PeerData) { // Try to fetch shard info from ENR to arrive at pubSub topics. if len(p.PubSubTopics) == 0 && p.ENR != nil { shards, err := wenr.RelaySharding(p.ENR.Record()) if err != nil { pm.logger.Error("Could not derive relayShards from ENR", zap.Error(err), logging.HostID("peer", p.AddrInfo.ID), zap.String("enr", p.ENR.String())) } else { if shards != nil { p.PubSubTopics = make([]string, 0) topics := shards.Topics() for _, topic := range topics { topicStr := topic.String() p.PubSubTopics = append(p.PubSubTopics, topicStr) } } else { pm.logger.Info("ENR doesn't have relay shards", logging.HostID("peer", p.AddrInfo.ID)) } } } _ = pm.addPeer(p.AddrInfo.ID, p.AddrInfo.Addrs, p.Origin, p.PubSubTopics) if p.ENR != nil { err := pm.host.Peerstore().(wps.WakuPeerstore).SetENR(p.AddrInfo.ID, p.ENR) if err != nil { pm.logger.Error("could not store enr", zap.Error(err), logging.HostID("peer", p.AddrInfo.ID), zap.String("enr", p.ENR.String())) } } } // addPeer adds peer to only the peerStore. // It also sets additional metadata such as origin, ENR and supported protocols func (pm *PeerManager) addPeer(ID peer.ID, addrs []ma.Multiaddr, origin wps.Origin, pubSubTopics []string, protocols ...protocol.ID) error { pm.logger.Info("adding peer to peerstore", logging.HostID("peer", ID)) pm.host.Peerstore().AddAddrs(ID, addrs, peerstore.AddressTTL) err := pm.host.Peerstore().(wps.WakuPeerstore).SetOrigin(ID, origin) if err != nil { pm.logger.Error("could not set origin", zap.Error(err), logging.HostID("peer", ID)) return err } if len(protocols) > 0 { err = pm.host.Peerstore().AddProtocols(ID, protocols...) if err != nil { return err } } if len(pubSubTopics) == 0 { // Probably the peer is discovered via DNSDiscovery (for which we don't have pubSubTopic info) //If pubSubTopic and enr is empty or no shard info in ENR,then set to defaultPubSubTopic pubSubTopics = []string{relay.DefaultWakuTopic} } err = pm.host.Peerstore().(wps.WakuPeerstore).SetPubSubTopics(ID, pubSubTopics) if err != nil { pm.logger.Error("could not store pubSubTopic", zap.Error(err), logging.HostID("peer", ID), zap.Strings("topics", pubSubTopics)) } return nil } // AddPeer adds peer to the peerStore and also to service slots func (pm *PeerManager) AddPeer(address ma.Multiaddr, origin wps.Origin, pubSubTopics []string, protocols ...protocol.ID) (peer.ID, error) { //Assuming all addresses have peerId info, err := peer.AddrInfoFromP2pAddr(address) if err != nil { return "", err } //Add Service peers to serviceSlots. for _, proto := range protocols { pm.addPeerToServiceSlot(proto, info.ID) } //Add to the peer-store err = pm.addPeer(info.ID, info.Addrs, origin, pubSubTopics, protocols...) if err != nil { return "", err } return info.ID, nil } // RemovePeer deletes peer from the peerStore after disconnecting it. // It also removes the peer from serviceSlot. func (pm *PeerManager) RemovePeer(peerID peer.ID) { pm.host.Peerstore().RemovePeer(peerID) //Search if this peer is in serviceSlot and if so, remove it from there // TODO:Add another peer which is statically configured to the serviceSlot. pm.serviceSlots.removePeer(peerID) } // addPeerToServiceSlot adds a peerID to serviceSlot. // Adding to peerStore is expected to be already done by caller. // If relay proto is passed, it is not added to serviceSlot. func (pm *PeerManager) addPeerToServiceSlot(proto protocol.ID, peerID peer.ID) { if proto == relay.WakuRelayID_v200 { pm.logger.Warn("Cannot add Relay peer to service peer slots") return } //For now adding the peer to serviceSlot which means the latest added peer would be given priority. //TODO: Ideally we should sort the peers per service and return best peer based on peer score or RTT etc. pm.logger.Info("Adding peer to service slots", logging.HostID("peer", peerID), zap.String("service", string(proto))) // getPeers returns nil for WakuRelayIDv200 protocol, but we don't run this ServiceSlot code for WakuRelayIDv200 protocol pm.serviceSlots.getPeers(proto).add(peerID) } // SelectPeer is used to return a random peer that supports a given protocol. // If a list of specific peers is passed, the peer will be chosen from that list assuming // it supports the chosen protocol, otherwise it will chose a peer from the service slot. // If a peer cannot be found in the service slot, a peer will be selected from node peerstore func (pm *PeerManager) SelectPeer(proto protocol.ID, specificPeers []peer.ID) (peer.ID, error) { // @TODO We need to be more strategic about which peers we dial. Right now we just set one on the service. // Ideally depending on the query and our set of peers we take a subset of ideal peers. // This will require us to check for various factors such as: // - which topics they track // - latency? //Try to fetch from serviceSlot if slot := pm.serviceSlots.getPeers(proto); slot != nil { if peerID, err := slot.getRandom(); err == nil { return peerID, nil } } // if not found in serviceSlots or proto == WakuRelayIDv200 filteredPeers, err := utils.FilterPeersByProto(pm.host, specificPeers, proto) if err != nil { return "", err } return utils.SelectRandomPeer(filteredPeers, pm.logger) }