QSP-13 Only Allow Snappy P2P Encoding

beacon-chain/main.go

@@ -71,7 +71,6 @@ var appFlags = []cli.Flag{
 	cmd.P2PMetadata,
 	cmd.P2PAllowList,
 	cmd.P2PDenyList,
-	cmd.P2PEncoding,
 	cmd.P2PPubsub,
 	cmd.DataDirFlag,
 	cmd.VerbosityFlag,

beacon-chain/node/node.go

@@ -374,7 +374,6 @@ func (b *BeaconNode) registerP2P(cliCtx *cli.Context) error {
 		DenyListCIDR:      sliceutil.SplitCommaSeparated(cliCtx.StringSlice(cmd.P2PDenyList.Name)),
 		EnableUPnP:        cliCtx.Bool(cmd.EnableUPnPFlag.Name),
 		DisableDiscv5:     cliCtx.Bool(flags.DisableDiscv5.Name),
-		Encoding:          cliCtx.String(cmd.P2PEncoding.Name),
 		StateNotifier:     b,
 		PubSub:            cliCtx.String(cmd.P2PPubsub.Name),
 	})

beacon-chain/p2p/broadcaster_test.go

@@ -25,11 +25,9 @@ func TestService_Broadcast(t *testing.T) {
 	}
 
 	p := &Service{
-		host:   p1.BHost,
-		pubsub: p1.PubSub(),
-		cfg: &Config{
-			Encoding: "ssz",
-		},
+		host:                  p1.BHost,
+		pubsub:                p1.PubSub(),
+		cfg:                   &Config{},
 		genesisTime:           time.Now(),
 		genesisValidatorsRoot: []byte{'A'},
 	}

beacon-chain/p2p/config.go

@@ -25,7 +25,6 @@ type Config struct {
 	MaxPeers            uint
 	AllowListCIDR       string
 	DenyListCIDR        []string
-	Encoding            string
 	StateNotifier       statefeed.Notifier
 	PubSub              string
 }

beacon-chain/p2p/discovery_test.go

@@ -41,7 +41,7 @@ func createAddrAndPrivKey(t *testing.T) (net.IP, *ecdsa.PrivateKey) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	pkey, err := privKey(&Config{Encoding: "ssz", DataDir: tempPath})
+	pkey, err := privKey(&Config{DataDir: tempPath})
 	if err != nil {
 		t.Fatalf("Could not get private key: %v", err)
 	}
@@ -95,7 +95,6 @@ func TestStartDiscV5_DiscoverAllPeers(t *testing.T) {
 		port = 3000 + i
 		cfg := &Config{
 			Discv5BootStrapAddr: []string{bootNode.String()},
-			Encoding:            "ssz",
 			UDPPort:             uint(port),
 		}
 		ipAddr, pkey := createAddrAndPrivKey(t)
@@ -167,7 +166,7 @@ func TestMultiAddrConversion_OK(t *testing.T) {
 
 func TestStaticPeering_PeersAreAdded(t *testing.T) {
 	cfg := &Config{
-		Encoding: "ssz", MaxPeers: 30,
+		MaxPeers: 30,
 	}
 	port := 6000
 	var staticPeers []string

beacon-chain/p2p/encoder/network_encoding.go

@@ -4,12 +4,6 @@ import (
 	"io"
 )
 
-// Defines the different encoding formats
-const (
-	SSZ       = "ssz"        // SSZ is SSZ only.
-	SSZSnappy = "ssz-snappy" // SSZSnappy is SSZ with snappy compression.
-)
-
 // NetworkEncoding represents an encoder compatible with Ethereum 2.0 p2p.
 type NetworkEncoding interface {
 	// DecodeGossip to the provided gossip message. The interface must be a pointer to the decoding destination.

beacon-chain/p2p/encoder/ssz.go

@@ -31,9 +31,7 @@ var bufReaderPool = new(sync.Pool)
 
 // SszNetworkEncoder supports p2p networking encoding using SimpleSerialize
 // with snappy compression (if enabled).
-type SszNetworkEncoder struct {
-	UseSnappyCompression bool
-}
+type SszNetworkEncoder struct{}
 
 func (e SszNetworkEncoder) doEncode(msg interface{}) ([]byte, error) {
 	if v, ok := msg.(fastssz.Marshaler); ok {
@@ -54,9 +52,7 @@ func (e SszNetworkEncoder) EncodeGossip(w io.Writer, msg interface{}) (int, erro
 	if uint64(len(b)) > MaxGossipSize {
 		return 0, errors.Errorf("gossip message exceeds max gossip size: %d bytes > %d bytes", len(b), MaxGossipSize)
 	}
-	if e.UseSnappyCompression {
-		b = snappy.Encode(nil /*dst*/, b)
-	}
+	b = snappy.Encode(nil /*dst*/, b)
 	return w.Write(b)
 }
 
@@ -75,10 +71,7 @@ func (e SszNetworkEncoder) EncodeWithLength(w io.Writer, msg interface{}) (int,
 	if err != nil {
 		return 0, err
 	}
-	if e.UseSnappyCompression {
-		return writeSnappyBuffer(w, b)
-	}
-	return w.Write(b)
+	return writeSnappyBuffer(w, b)
 }
 
 // EncodeWithMaxLength the proto message to the io.Writer. This encoding prefixes the byte slice with a protobuf varint
@@ -99,10 +92,7 @@ func (e SszNetworkEncoder) EncodeWithMaxLength(w io.Writer, msg interface{}, max
 	if err != nil {
 		return 0, err
 	}
-	if e.UseSnappyCompression {
-		return writeSnappyBuffer(w, b)
-	}
-	return w.Write(b)
+	return writeSnappyBuffer(w, b)
 }
 
 func (e SszNetworkEncoder) doDecode(b []byte, to interface{}) error {
@@ -126,12 +116,10 @@ func (e SszNetworkEncoder) doDecode(b []byte, to interface{}) error {
 
 // DecodeGossip decodes the bytes to the protobuf gossip message provided.
 func (e SszNetworkEncoder) DecodeGossip(b []byte, to interface{}) error {
-	if e.UseSnappyCompression {
-		var err error
-		b, err = snappy.Decode(nil /*dst*/, b)
-		if err != nil {
-			return err
-		}
+	var err error
+	b, err = snappy.Decode(nil /*dst*/, b)
+	if err != nil {
+		return err
 	}
 	if uint64(len(b)) > MaxGossipSize {
 		return errors.Errorf("gossip message exceeds max gossip size: %d bytes > %d bytes", len(b), MaxGossipSize)
@@ -157,10 +145,8 @@ func (e SszNetworkEncoder) DecodeWithMaxLength(r io.Reader, to interface{}, maxS
 	if msgLen > maxSize {
 		return fmt.Errorf("remaining bytes %d goes over the provided max limit of %d", msgLen, maxSize)
 	}
-	if e.UseSnappyCompression {
-		r = newBufferedReader(r)
-		defer bufReaderPool.Put(r)
-	}
+	r = newBufferedReader(r)
+	defer bufReaderPool.Put(r)
 	b := make([]byte, e.MaxLength(int(msgLen)))
 	numOfBytes, err := r.Read(b)
 	if err != nil {
@@ -171,19 +157,13 @@ func (e SszNetworkEncoder) DecodeWithMaxLength(r io.Reader, to interface{}, maxS
 
 // ProtocolSuffix returns the appropriate suffix for protocol IDs.
 func (e SszNetworkEncoder) ProtocolSuffix() string {
-	if e.UseSnappyCompression {
-		return "/ssz_snappy"
-	}
-	return "/ssz"
+	return "/ssz_snappy"
 }
 
 // MaxLength specifies the maximum possible length of an encoded
 // chunk of data.
 func (e SszNetworkEncoder) MaxLength(length int) int {
-	if e.UseSnappyCompression {
-		return snappy.MaxEncodedLen(length)
-	}
-	return length
+	return snappy.MaxEncodedLen(length)
 }
 
 // Writes a bytes value through a snappy buffered writer.

beacon-chain/p2p/encoder/ssz_test.go

@@ -12,13 +12,13 @@ import (
 )
 
 func TestSszNetworkEncoder_RoundTrip(t *testing.T) {
-	e := &encoder.SszNetworkEncoder{UseSnappyCompression: false}
+	e := &encoder.SszNetworkEncoder{}
 	testRoundTripWithLength(t, e)
 	testRoundTripWithGossip(t, e)
 }
 
 func TestSszNetworkEncoder_RoundTrip_Snappy(t *testing.T) {
-	e := &encoder.SszNetworkEncoder{UseSnappyCompression: true}
+	e := &encoder.SszNetworkEncoder{}
 	testRoundTripWithLength(t, e)
 	testRoundTripWithGossip(t, e)
 }
@@ -69,7 +69,7 @@ func TestSszNetworkEncoder_EncodeWithMaxLength(t *testing.T) {
 		Foo: []byte("fooooo"),
 		Bar: 9001,
 	}
-	e := &encoder.SszNetworkEncoder{UseSnappyCompression: false}
+	e := &encoder.SszNetworkEncoder{}
 	maxLength := uint64(5)
 	_, err := e.EncodeWithMaxLength(buf, msg, maxLength)
 	wanted := fmt.Sprintf("which is larger than the provided max limit of %d", maxLength)
@@ -87,7 +87,7 @@ func TestSszNetworkEncoder_DecodeWithMaxLength(t *testing.T) {
 		Foo: []byte("fooooo"),
 		Bar: 4242,
 	}
-	e := &encoder.SszNetworkEncoder{UseSnappyCompression: false}
+	e := &encoder.SszNetworkEncoder{}
 	maxLength := uint64(5)
 	_, err := e.EncodeGossip(buf, msg)
 	if err != nil {
@@ -105,7 +105,7 @@ func TestSszNetworkEncoder_DecodeWithMaxLength(t *testing.T) {
 }
 
 func TestSszNetworkEncoder_DecodeWithMaxLength_TooLarge(t *testing.T) {
-	e := &encoder.SszNetworkEncoder{UseSnappyCompression: false}
+	e := &encoder.SszNetworkEncoder{}
 	if err := e.DecodeWithMaxLength(nil, nil, encoder.MaxChunkSize+1); err == nil {
 		t.Fatal("Nil error")
 	} else if !strings.Contains(err.Error(), "exceeds max chunk size") {

beacon-chain/p2p/fork_test.go

@@ -38,7 +38,6 @@ func TestStartDiscv5_DifferentForkDigests(t *testing.T) {
 	bootNode := bootListener.Self()
 	cfg := &Config{
 		Discv5BootStrapAddr: []string{bootNode.String()},
-		Encoding:            "ssz",
 		UDPPort:             uint(port),
 	}
 
@@ -132,7 +131,6 @@ func TestStartDiscv5_SameForkDigests_DifferentNextForkData(t *testing.T) {
 	bootNode := bootListener.Self()
 	cfg := &Config{
 		Discv5BootStrapAddr: []string{bootNode.String()},
-		Encoding:            "ssz",
 		UDPPort:             uint(port),
 	}
 
@@ -250,7 +248,7 @@ func TestDiscv5_AddRetrieveForkEntryENR(t *testing.T) {
 	if err := os.Mkdir(tempPath, 0700); err != nil {
 		t.Fatal(err)
 	}
-	pkey, err := privKey(&Config{Encoding: "ssz", DataDir: tempPath})
+	pkey, err := privKey(&Config{DataDir: tempPath})
 	if err != nil {
 		t.Fatalf("Could not get private key: %v", err)
 	}
@@ -288,7 +286,7 @@ func TestAddForkEntry_Genesis(t *testing.T) {
 	if err := os.Mkdir(tempPath, 0700); err != nil {
 		t.Fatal(err)
 	}
-	pkey, err := privKey(&Config{Encoding: "ssz", DataDir: tempPath})
+	pkey, err := privKey(&Config{DataDir: tempPath})
 	if err != nil {
 		t.Fatalf("Could not get private key: %v", err)
 	}

beacon-chain/p2p/options_test.go

@@ -40,7 +40,6 @@ func TestPrivateKeyLoading(t *testing.T) {
 	log.WithField("file", file.Name()).WithField("key", out).Info("Wrote key to file")
 	cfg := &Config{
 		PrivateKey: file.Name(),
-		Encoding:   "ssz",
 	}
 	pKey, err := privKey(cfg)
 	if err != nil {

beacon-chain/p2p/sender_test.go

@@ -20,7 +20,7 @@ func TestService_Send(t *testing.T) {
 
 	svc := &Service{
 		host: p1.BHost,
-		cfg:  &Config{Encoding: "ssz"},
+		cfg:  &Config{},
 	}
 
 	msg := &testpb.TestSimpleMessage{
@@ -32,7 +32,7 @@ func TestService_Send(t *testing.T) {
 	var wg sync.WaitGroup
 	wg.Add(1)
 
-	p2.SetStreamHandler("/testing/1/ssz", func(stream network.Stream) {
+	p2.SetStreamHandler("/testing/1/ssz_snappy", func(stream network.Stream) {
 		rcvd := &testpb.TestSimpleMessage{}
 		if err := svc.Encoding().DecodeWithLength(stream, rcvd); err != nil {
 			t.Fatal(err)

beacon-chain/p2p/service.go

@@ -284,15 +284,7 @@ func (s *Service) Started() bool {
 
 // Encoding returns the configured networking encoding.
 func (s *Service) Encoding() encoder.NetworkEncoding {
-	encoding := s.cfg.Encoding
-	switch encoding {
-	case encoder.SSZ:
-		return &encoder.SszNetworkEncoder{}
-	case encoder.SSZSnappy:
-		return &encoder.SszNetworkEncoder{UseSnappyCompression: true}
-	default:
-		panic("Invalid Network Encoding Flag Provided")
-	}
+	return &encoder.SszNetworkEncoder{}
 }
 
 // PubSub returns the p2p pubsub framework.

beacon-chain/p2p/service_test.go

@@ -103,9 +103,8 @@ func TestService_Start_OnlyStartsOnce(t *testing.T) {
 	hook := logTest.NewGlobal()
 
 	cfg := &Config{
-		TCPPort:  2000,
-		UDPPort:  2000,
-		Encoding: "ssz",
+		TCPPort: 2000,
+		UDPPort: 2000,
 	}
 	s, err := NewService(cfg)
 	if err != nil {
@@ -180,7 +179,6 @@ func TestListenForNewNodes(t *testing.T) {
 	cfg = &Config{
 		BootstrapNodeAddr:   []string{bootNode.String()},
 		Discv5BootStrapAddr: []string{bootNode.String()},
-		Encoding:            "ssz",
 		MaxPeers:            30,
 	}
 	for i := 1; i <= 5; i++ {

beacon-chain/p2p/subnets_test.go

@@ -41,7 +41,6 @@ func TestStartDiscV5_DiscoverPeersWithSubnets(t *testing.T) {
 		cfg := &Config{
 			BootstrapNodeAddr:   []string{bootNode.String()},
 			Discv5BootStrapAddr: []string{bootNode.String()},
-			Encoding:            "ssz",
 			MaxPeers:            30,
 			UDPPort:             uint(port),
 		}
@@ -74,7 +73,6 @@ func TestStartDiscV5_DiscoverPeersWithSubnets(t *testing.T) {
 	cfg := &Config{
 		BootstrapNodeAddr:   []string{bootNode.String()},
 		Discv5BootStrapAddr: []string{bootNode.String()},
-		Encoding:            "ssz",
 		MaxPeers:            30,
 		UDPPort:             uint(port),
 	}

beacon-chain/usage.go

@@ -121,7 +121,6 @@ var appHelpFlagGroups = []flagGroup{
 			cmd.P2PDenyList,
 			cmd.StaticPeers,
 			cmd.EnableUPnPFlag,
-			cmd.P2PEncoding,
 			cmd.P2PPubsub,
 			flags.MinSyncPeers,
 		},

fuzz/rpc_status_fuzz.go

@@ -29,7 +29,6 @@ func init() {
 	var err error
 	p, err = p2p.NewService(&p2p.Config{
 		NoDiscovery: true,
-		Encoding:    "ssz",
 	})
 	if err != nil {
 		panic(errors.Wrap(err, "could not create new p2p service"))

shared/cmd/flags.go

@@ -154,12 +154,6 @@ var (
 			"192.168.0.0/16 would deny connections from peers on your local network only. The " +
 			"default is to accept all connections.",
 	}
-	// P2PEncoding defines the encoding format for p2p messages.
-	P2PEncoding = &cli.StringFlag{
-		Name:  "p2p-encoding",
-		Usage: "The encoding format of messages sent over the wire. The default is 0, which represents ssz",
-		Value: "ssz-snappy",
-	}
 	// P2PPubsub defines the pubsub router to use for p2p messages.
 	P2PPubsub = &cli.StringFlag{
 		Name:  "p2p-pubsub",

shared/featureconfig/flags.go

@@ -164,6 +164,11 @@ var devModeFlags = []cli.Flag{
 const deprecatedUsage = "DEPRECATED. DO NOT USE."
 
 var (
+	deprecatedP2PEncoding = &cli.StringFlag{
+		Name:   "p2p-encoding",
+		Usage:  deprecatedUsage,
+		Hidden: true,
+	}
 	deprecatedEnableKadDht = &cli.BoolFlag{
 		Name:   "enable-kad-dht",
 		Usage:  deprecatedUsage,
@@ -433,6 +438,7 @@ var (
 )
 
 var deprecatedFlags = []cli.Flag{
+	deprecatedP2PEncoding,
 	deprecatedEnableKadDht,
 	deprecatedWeb3ProviderFlag,
 	deprecatedEnableDynamicCommitteeSubnets,