github.com/celestiaorg/celestia-node@v0.15.0-beta.1/nodebuilder/p2p/pubsub.go

package p2p

import (
	"context"
	"fmt"
	"net"
	"time"

	pubsub "github.com/libp2p/go-libp2p-pubsub"
	pubsub_pb "github.com/libp2p/go-libp2p-pubsub/pb"
	"github.com/libp2p/go-libp2p-pubsub/timecache"
	hst "github.com/libp2p/go-libp2p/core/host"
	"github.com/libp2p/go-libp2p/core/peer"
	"github.com/libp2p/go-libp2p/core/protocol"
	"go.uber.org/fx"
	"golang.org/x/crypto/blake2b"

	"github.com/celestiaorg/go-fraud"
	"github.com/celestiaorg/go-fraud/fraudserv"
	headp2p "github.com/celestiaorg/go-header/p2p"

	"github.com/celestiaorg/celestia-node/header"
)

func init() {
	// TODO(@Wondertan): Requires deeper analysis
	// configure larger overlay parameters
	// the default ones are pretty conservative
	pubsub.GossipSubD = 8
	pubsub.GossipSubDscore = 6
	pubsub.GossipSubDout = 3
	pubsub.GossipSubDlo = 6
	pubsub.GossipSubDhi = 12
	pubsub.GossipSubDlazy = 12

	pubsub.GossipSubIWantFollowupTime = 5 * time.Second
	pubsub.GossipSubHistoryLength = 10 // cache msgs longer
	// MutualPeers will wait for 30secs before connecting
	pubsub.GossipSubDirectConnectInitialDelay = 30 * time.Second
}

// pubSub provides a constructor for PubSub protocol with GossipSub routing.
func pubSub(cfg Config, params pubSubParams) (*pubsub.PubSub, error) {
	fpeers, err := cfg.mutualPeers()
	if err != nil {
		return nil, err
	}

	isBootstrapper := isBootstrapper()

	if isBootstrapper {
		// Turn off the mesh in bootstrappers as per:
		//
		//
		//https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#recommendations-for-network-operators
		pubsub.GossipSubD = 0
		pubsub.GossipSubDscore = 0
		pubsub.GossipSubDlo = 0
		pubsub.GossipSubDhi = 0
		pubsub.GossipSubDout = 0
		pubsub.GossipSubDlazy = 64
		pubsub.GossipSubGossipFactor = 0.25
		pubsub.GossipSubPruneBackoff = 5 * time.Minute
	}

	// TODO(@Wondertan) Validate and improve default peer scoring params
	// Сurrent parameters are based on:
	//	* https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#peer-scoring
	//  * lotus
	//  * prysm
	topicScores := topicScoreParams(params)
	peerScores, err := peerScoreParams(params.Bootstrappers, cfg)
	if err != nil {
		return nil, err
	}

	peerScores.Topics = topicScores
	scoreThresholds := peerScoreThresholds()

	opts := []pubsub.Option{
		pubsub.WithSeenMessagesStrategy(timecache.Strategy_LastSeen),
		pubsub.WithPeerScore(peerScores, scoreThresholds),
		pubsub.WithPeerExchange(cfg.PeerExchange || isBootstrapper),
		pubsub.WithDirectPeers(fpeers),
		pubsub.WithMessageIdFn(hashMsgID),
		// specifying sub protocol helps to avoid conflicts with
		// floodsub(because gossipsub supports floodsub protocol by default).
		pubsub.WithGossipSubProtocols([]protocol.ID{pubsub.GossipSubID_v11}, pubsub.GossipSubDefaultFeatures),
	}

	return pubsub.NewGossipSub(
		params.Ctx,
		params.Host,
		opts...,
	)
}

func hashMsgID(m *pubsub_pb.Message) string {
	hash := blake2b.Sum256(m.Data)
	return string(hash[:])
}

type pubSubParams struct {
	fx.In

	Ctx           context.Context
	Host          hst.Host
	Bootstrappers Bootstrappers
	Network       Network
	Unmarshaler   fraud.ProofUnmarshaler[*header.ExtendedHeader]
}

func topicScoreParams(params pubSubParams) map[string]*pubsub.TopicScoreParams {
	mp := map[string]*pubsub.TopicScoreParams{
		headp2p.PubsubTopicID(params.Network.String()): &headp2p.GossibSubScore,
	}

	for _, pt := range params.Unmarshaler.List() {
		mp[fraudserv.PubsubTopicID(pt.String(), params.Network.String())] = &fraudserv.GossibSubScore
	}

	return mp
}

func peerScoreParams(bootstrappers Bootstrappers, cfg Config) (*pubsub.PeerScoreParams, error) {
	bootstrapperSet := map[peer.ID]struct{}{}
	for _, b := range bootstrappers {
		bootstrapperSet[b.ID] = struct{}{}
	}

	ipColocFactWl := make([]*net.IPNet, 0, len(cfg.IPColocationWhitelist))
	for _, strIP := range cfg.IPColocationWhitelist {
		_, ipNet, err := net.ParseCIDR(strIP)
		if err != nil {
			return nil, fmt.Errorf("error while parsing whitelist collocation CIDR string: %w", err)
		}
		ipColocFactWl = append(ipColocFactWl, ipNet)
	}

	// See
	// https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#the-score-function
	return &pubsub.PeerScoreParams{
		AppSpecificScore: func(p peer.ID) float64 {
			// return a heavy positive score for bootstrappers so that we don't unilaterally prune
			// them and accept PX from them
			_, ok := bootstrapperSet[p]
			if ok {
				return 2500
			}

			// TODO(@Wondertan):
			//  Plug the application specific score to the node itself in order
			//  to provide feedback to the pubsub system based on observed behavior
			return 0
		},
		AppSpecificWeight: 1,

		// This sets the IP colocation threshold to 5 peers before we apply penalties
		// The aim is to protect the PubSub from naive bots collocated on the same machine/datacenter
		IPColocationFactorThreshold: 10,
		IPColocationFactorWeight:    -100,
		IPColocationFactorWhitelist: ipColocFactWl,

		BehaviourPenaltyThreshold: 6,
		BehaviourPenaltyWeight:    -10,
		BehaviourPenaltyDecay:     pubsub.ScoreParameterDecay(time.Hour),

		// Scores should not only grow and this defines a decay function equal for each peer
		DecayInterval: pubsub.DefaultDecayInterval,
		DecayToZero:   pubsub.DefaultDecayToZero,

		// this retains *non-positive* scores for 6 hours
		RetainScore: 6 * time.Hour,
	}, nil
}

func peerScoreThresholds() *pubsub.PeerScoreThresholds {
	//
	//https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters
	return &pubsub.PeerScoreThresholds{
		GossipThreshold:             -1000,
		PublishThreshold:            -2000,
		GraylistThreshold:           -8000,
		AcceptPXThreshold:           1000,
		OpportunisticGraftThreshold: 5,
	}
}