mirror of
https://github.com/logos-messaging/go-libp2p-pubsub.git
synced 2026-01-02 12:53:09 +00:00
b421b3ab05
## GossipSub v1.2 implementation Specification: libp2p/specs#548 ### Work Summary Sending IDONTWANT Implement a smart queue Add priorities to the smart queue Put IDONTWANT packets into the smart priority queue as soon as the node gets the packets Handling IDONTWANT Use a map to remember the message ids whose IDONTWANT packets have been received Implement max_idontwant_messages (ignore the IDONWANT packets if the max is reached) Clear the message IDs from the cache after 3 heartbeats Hash the message IDs before putting them into the cache. More requested features Add a feature test to not send IDONTWANT if the other side doesnt support it ### Commit Summary * Replace sending channel with the smart rpcQueue Since we want to implement a priority queue later, we need to replace the normal sending channels with the new smart structures first. * Implement UrgentPush in the smart rpcQueue UrgentPush allows you to push an rpc packet to the front of the queue so that it will be popped out fast. * Add IDONTWANT to rpc.proto and trace.proto * Send IDONTWANT right before validation step Most importantly, this commit adds a new method called PreValidation to the interface PubSubRouter, which will be called right before validating the gossipsub message. In GossipSubRouter, PreValidation will send the IDONTWANT controll messages to all the mesh peers of the topics of the received messages. * Test GossipSub IDONWANT sending * Send IDONWANT only for large messages * Handle IDONTWANT control messages When receiving IDONTWANTs, the host should remember the message ids contained in IDONTWANTs using a hash map. When receiving messages with those ids, it shouldn't forward them to the peers who already sent the IDONTWANTs. When the maximum number of IDONTWANTs is reached for any particular peer, the host should ignore any excessive IDONTWANTs from that peer. * Clear expired message IDs from the IDONTWANT cache If the messages IDs received from IDONTWANTs are older than 3 heartbeats, they should be removed from the IDONTWANT cache. * Keep the hashes of IDONTWANT message ids instead Rather than keeping the raw message ids, keep their hashes instead to save memory and protect again memory DoS attacks. * Increase GossipSubMaxIHaveMessages to 1000 * fixup! Clear expired message IDs from the IDONTWANT cache * Not send IDONTWANT if the receiver doesn't support * fixup! Replace sending channel with the smart rpcQueue * Not use pointers in rpcQueue * Simply rcpQueue by using only one mutex * Check ctx error in rpc sending worker Co-authored-by: Steven Allen <steven@stebalien.com> * fixup! Simply rcpQueue by using only one mutex * fixup! Keep the hashes of IDONTWANT message ids instead * Use AfterFunc instead implementing our own * Fix misc lint errors * fixup! Fix misc lint errors * Revert "Increase GossipSubMaxIHaveMessages to 1000" This reverts commit 6fabcdd068a5f5238c5280a3460af9c3998418ec. * Increase GossipSubMaxIDontWantMessages to 1000 * fixup! Handle IDONTWANT control messages * Skip TestGossipsubConnTagMessageDeliveries * Skip FuzzAppendOrMergeRPC * Revert "Skip FuzzAppendOrMergeRPC" This reverts commit f141e13234de0960d139339acb636a1afea9e219. * fixup! Send IDONWANT only for large messages * fixup! fixup! Keep the hashes of IDONTWANT message ids instead * fixup! Implement UrgentPush in the smart rpcQueue * fixup! Use AfterFunc instead implementing our own --------- Co-authored-by: Steven Allen <steven@stebalien.com>
57 lines
1.7 KiB
Go
57 lines
1.7 KiB
Go
package pubsub
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/libp2p/go-libp2p/core/protocol"
|
|
)
|
|
|
|
// GossipSubFeatureTest is a feature test function; it takes a feature and a protocol ID and
|
|
// should return true if the feature is supported by the protocol
|
|
type GossipSubFeatureTest = func(GossipSubFeature, protocol.ID) bool
|
|
|
|
// GossipSubFeature is a feature discriminant enum
|
|
type GossipSubFeature int
|
|
|
|
const (
|
|
// Protocol supports basic GossipSub Mesh -- gossipsub-v1.0 compatible
|
|
GossipSubFeatureMesh = iota
|
|
// Protocol supports Peer eXchange on prune -- gossipsub-v1.1 compatible
|
|
GossipSubFeaturePX
|
|
// Protocol supports IDONTWANT -- gossipsub-v1.2 compatible
|
|
GossipSubFeatureIdontwant
|
|
)
|
|
|
|
// GossipSubDefaultProtocols is the default gossipsub router protocol list
|
|
var GossipSubDefaultProtocols = []protocol.ID{GossipSubID_v12, GossipSubID_v11, GossipSubID_v10, FloodSubID}
|
|
|
|
// GossipSubDefaultFeatures is the feature test function for the default gossipsub protocols
|
|
func GossipSubDefaultFeatures(feat GossipSubFeature, proto protocol.ID) bool {
|
|
switch feat {
|
|
case GossipSubFeatureMesh:
|
|
return proto == GossipSubID_v12 || proto == GossipSubID_v11 || proto == GossipSubID_v10
|
|
case GossipSubFeaturePX:
|
|
return proto == GossipSubID_v12 || proto == GossipSubID_v11
|
|
case GossipSubFeatureIdontwant:
|
|
return proto == GossipSubID_v12
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
// WithGossipSubProtocols is a gossipsub router option that configures a custom protocol list
|
|
// and feature test function
|
|
func WithGossipSubProtocols(protos []protocol.ID, feature GossipSubFeatureTest) Option {
|
|
return func(ps *PubSub) error {
|
|
gs, ok := ps.rt.(*GossipSubRouter)
|
|
if !ok {
|
|
return fmt.Errorf("pubsub router is not gossipsub")
|
|
}
|
|
|
|
gs.protos = protos
|
|
gs.feature = feature
|
|
|
|
return nil
|
|
}
|
|
}
|