feat(dot/peerset): Implement peer scoring (ChainSafe#1791)

* Implement peerState and PSM (Peer Set Manager) and add test cases. * Address comments and add unit test. * Remove channel from sorted peers
timwu20 · Nov 8, 2021 · 1c989ad · 1c989ad
1 parent d7147cf
commit 1c989ad
Show file tree

Hide file tree

Showing 43 changed files with 2,405 additions and 205 deletions.
diff --git a/chain/dev/defaults.go b/chain/dev/defaults.go
@@ -17,9 +17,10 @@
 package dev
 
 import (
+	log "github.com/ChainSafe/log15"
+
 	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/runtime/wasmer"
-	log "github.com/ChainSafe/log15"
 )
 
 var (
@@ -76,7 +77,7 @@ var (
 	// NetworkConfig
 
 	// DefaultNetworkPort network port
-	DefaultNetworkPort = uint32(7001)
+	DefaultNetworkPort = uint16(7001)
 	// DefaultNetworkBootnodes network bootnodes
 	DefaultNetworkBootnodes = []string(nil)
 	// DefaultNoBootstrap disables bootstrap

diff --git a/chain/gssmr/defaults.go b/chain/gssmr/defaults.go
@@ -19,9 +19,10 @@ package gssmr
 import (
 	"time"
 
+	log "github.com/ChainSafe/log15"
+
 	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/runtime/wasmer"
-	log "github.com/ChainSafe/log15"
 )
 
 var (
@@ -78,7 +79,7 @@ var (
 	// NetworkConfig
 
 	// DefaultNetworkPort network port
-	DefaultNetworkPort = uint32(7001)
+	DefaultNetworkPort = uint16(7001)
 	// DefaultNetworkBootnodes network bootnodes
 	DefaultNetworkBootnodes = []string(nil)
 	// DefaultNoBootstrap disables bootstrap

diff --git a/chain/kusama/defaults.go b/chain/kusama/defaults.go
@@ -17,9 +17,10 @@
 package kusama
 
 import (
+	log "github.com/ChainSafe/log15"
+
 	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/runtime/wasmer"
-	log "github.com/ChainSafe/log15"
 )
 
 var (
@@ -72,7 +73,7 @@ var (
 	// NetworkConfig
 
 	// DefaultNetworkPort network port
-	DefaultNetworkPort = uint32(7001)
+	DefaultNetworkPort = uint16(7001)
 	// DefaultNetworkBootnodes network bootnodes
 	DefaultNetworkBootnodes = []string(nil)
 	// DefaultNoBootstrap disables bootstrap

diff --git a/chain/polkadot/defaults.go b/chain/polkadot/defaults.go
@@ -17,9 +17,10 @@
 package polkadot
 
 import (
+	log "github.com/ChainSafe/log15"
+
 	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/runtime/wasmer"
-	log "github.com/ChainSafe/log15"
 )
 
 var (
@@ -73,7 +74,7 @@ var (
 	// NetworkConfig
 
 	// DefaultNetworkPort network port
-	DefaultNetworkPort = uint32(7001)
+	DefaultNetworkPort = uint16(7001)
 	// DefaultNetworkBootnodes network bootnodes
 	DefaultNetworkBootnodes = []string(nil)
 	// DefaultNoBootstrap disables bootstrap

diff --git a/cmd/gossamer/config.go b/cmd/gossamer/config.go
@@ -652,7 +652,7 @@ func setDotNetworkConfig(ctx *cli.Context, tomlCfg ctoml.NetworkConfig, cfg *dot
 
 	// check --port flag and update node configuration
 	if port := ctx.GlobalUint(PortFlag.Name); port != 0 {
-		cfg.Port = uint32(port)
+		cfg.Port = uint16(port)
 	}
 
 	// check --bootnodes flag and update node configuration

diff --git a/dot/config.go b/dot/config.go
@@ -20,14 +20,15 @@ import (
 	"encoding/json"
 	"time"
 
+	log "github.com/ChainSafe/log15"
+
 	"github.com/ChainSafe/gossamer/chain/dev"
 	"github.com/ChainSafe/gossamer/chain/gssmr"
 	"github.com/ChainSafe/gossamer/chain/kusama"
 	"github.com/ChainSafe/gossamer/chain/polkadot"
 	"github.com/ChainSafe/gossamer/dot/state/pruner"
 	"github.com/ChainSafe/gossamer/dot/types"
 	"github.com/ChainSafe/gossamer/lib/genesis"
-	log "github.com/ChainSafe/log15"
 )
 
 // TODO: update config to have toml rules and perhaps un-export some fields, since we don't want to expose all
@@ -85,7 +86,7 @@ type AccountConfig struct {
 
 // NetworkConfig is to marshal/unmarshal toml network config vars
 type NetworkConfig struct {
-	Port              uint32
+	Port              uint16
 	Bootnodes         []string
 	ProtocolID        string
 	NoBootstrap       bool

diff --git a/dot/config/toml/config.go b/dot/config/toml/config.go
@@ -63,7 +63,7 @@ type AccountConfig struct {
 
 // NetworkConfig is to marshal/unmarshal toml network config vars
 type NetworkConfig struct {
-	Port              uint32   `toml:"port,omitempty"`
+	Port              uint16   `toml:"port,omitempty"`
 	Bootnodes         []string `toml:"bootnodes,omitempty"`
 	ProtocolID        string   `toml:"protocol,omitempty"`
 	NoBootstrap       bool     `toml:"nobootstrap,omitempty"`

diff --git a/dot/core/interface.go b/dot/core/interface.go
@@ -20,7 +20,10 @@ import (
 	"math/big"
 	"sync"
 
+	"github.com/libp2p/go-libp2p-core/peer"
+
 	"github.com/ChainSafe/gossamer/dot/network"
+	"github.com/ChainSafe/gossamer/dot/peerset"
 	"github.com/ChainSafe/gossamer/dot/types"
 	"github.com/ChainSafe/gossamer/lib/common"
 	"github.com/ChainSafe/gossamer/lib/runtime"
@@ -86,6 +89,7 @@ type TransactionState interface {
 type Network interface {
 	GossipMessage(network.NotificationsMessage)
 	IsSynced() bool
+	ReportPeer(change peerset.ReputationChange, p peer.ID)
 }
 
 // EpochState is the interface for state.EpochState

diff --git a/dot/core/messages.go b/dot/core/messages.go
@@ -17,15 +17,21 @@
 package core
 
 import (
+	"errors"
+
+	"github.com/libp2p/go-libp2p-core/peer"
+
 	"github.com/ChainSafe/gossamer/dot/network"
+	"github.com/ChainSafe/gossamer/dot/peerset"
 	"github.com/ChainSafe/gossamer/dot/types"
+	"github.com/ChainSafe/gossamer/lib/runtime"
 	"github.com/ChainSafe/gossamer/lib/transaction"
 )
 
 // HandleTransactionMessage validates each transaction in the message and
 // adds valid transactions to the transaction queue of the BABE session
 // returns boolean for transaction propagation, true - transactions should be propagated
-func (s *Service) HandleTransactionMessage(msg *network.TransactionMessage) (bool, error) {
+func (s *Service) HandleTransactionMessage(peerID peer.ID, msg *network.TransactionMessage) (bool, error) {
 	logger.Debug("received TransactionMessage")
 
 	if !s.net.IsSynced() {
@@ -64,6 +70,12 @@ func (s *Service) HandleTransactionMessage(msg *network.TransactionMessage) (boo
 			externalExt := types.Extrinsic(append([]byte{byte(types.TxnExternal)}, tx...))
 			val, err := rt.ValidateTransaction(externalExt)
 			if err != nil {
+				if errors.Is(err, runtime.ErrInvalidTransaction) {
+					s.net.ReportPeer(peerset.ReputationChange{
+						Value:  peerset.BadTransactionValue,
+						Reason: peerset.BadTransactionReason,
+					}, peerID)
+				}
 				logger.Debug("failed to validate transaction", "err", err)
 				return nil
 			}
@@ -88,6 +100,11 @@ func (s *Service) HandleTransactionMessage(msg *network.TransactionMessage) (boo
 		}
 	}
 
+	s.net.ReportPeer(peerset.ReputationChange{
+		Value:  peerset.GoodTransactionValue,
+		Reason: peerset.GoodTransactionReason,
+	}, peerID)
+
 	msg.Extrinsics = toPropagate
 	return len(msg.Extrinsics) > 0, nil
 }

diff --git a/dot/core/messages_test.go b/dot/core/messages_test.go
@@ -21,6 +21,10 @@ import (
 	"testing"
 	"time"
 
+	"github.com/centrifuge/go-substrate-rpc-client/v3/signature"
+	ctypes "github.com/centrifuge/go-substrate-rpc-client/v3/types"
+	"github.com/stretchr/testify/require"
+
 	"github.com/ChainSafe/gossamer/dot/core/mocks"
 	"github.com/ChainSafe/gossamer/dot/network"
 	"github.com/ChainSafe/gossamer/dot/state"
@@ -31,11 +35,6 @@ import (
 	"github.com/ChainSafe/gossamer/lib/keystore"
 	"github.com/ChainSafe/gossamer/lib/runtime"
 	"github.com/ChainSafe/gossamer/pkg/scale"
-
-	"github.com/centrifuge/go-substrate-rpc-client/v3/signature"
-	ctypes "github.com/centrifuge/go-substrate-rpc-client/v3/types"
-
-	"github.com/stretchr/testify/require"
 )
 
 func createExtrinsic(t *testing.T, rt runtime.Instance, genHash common.Hash, nonce uint64) types.Extrinsic {
@@ -128,6 +127,10 @@ func TestService_HandleBlockProduced(t *testing.T) {
 }
 
 func TestService_HandleTransactionMessage(t *testing.T) {
+	t.Parallel()
+
+	const peer1 = "testPeer1"
+
 	kp, err := sr25519.GenerateKeypair()
 	require.NoError(t, err)
 
@@ -158,7 +161,7 @@ func TestService_HandleTransactionMessage(t *testing.T) {
 
 	extBytes := createExtrinsic(t, rt, genHash, 0)
 	msg := &network.TransactionMessage{Extrinsics: []types.Extrinsic{extBytes}}
-	b, err := s.HandleTransactionMessage(msg)
+	b, err := s.HandleTransactionMessage(peer1, msg)
 	require.NoError(t, err)
 	require.True(t, b)
 
@@ -168,7 +171,7 @@ func TestService_HandleTransactionMessage(t *testing.T) {
 
 	extBytes = []byte(`bogus extrinsic`)
 	msg = &network.TransactionMessage{Extrinsics: []types.Extrinsic{extBytes}}
-	b, err = s.HandleTransactionMessage(msg)
+	b, err = s.HandleTransactionMessage(peer1, msg)
 	require.NoError(t, err)
 	require.False(t, b)
 }
diff --git a/dot/core/mocks/Network.go b/dot/core/mocks/Network.go
diff --git a/dot/core/test_helpers.go b/dot/core/test_helpers.go
@@ -21,8 +21,11 @@ import (
 	"path/filepath"
 	"testing"
 
+	log "github.com/ChainSafe/log15"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+
 	coremocks "github.com/ChainSafe/gossamer/dot/core/mocks"
-	"github.com/ChainSafe/gossamer/dot/network"
 	"github.com/ChainSafe/gossamer/dot/state"
 	"github.com/ChainSafe/gossamer/lib/common"
 	"github.com/ChainSafe/gossamer/lib/crypto/sr25519"
@@ -32,9 +35,6 @@ import (
 	rtstorage "github.com/ChainSafe/gossamer/lib/runtime/storage"
 	"github.com/ChainSafe/gossamer/lib/runtime/wasmer"
 	"github.com/ChainSafe/gossamer/lib/utils"
-	log "github.com/ChainSafe/log15"
-	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/require"
 )
 
 // NewTestService creates a new test core service
@@ -127,6 +127,7 @@ func NewTestService(t *testing.T, cfg *Config) *Service {
 		net := new(coremocks.Network)
 		net.On("GossipMessage", mock.AnythingOfType("*network.TransactionMessage"))
 		net.On("IsSynced").Return(true)
+		net.On("ReportPeer", mock.AnythingOfType("peerset.ReputationChange"), mock.AnythingOfType("peer.ID"))
 		cfg.Network = net
 	}
 
@@ -148,10 +149,5 @@ func NewTestService(t *testing.T, cfg *Config) *Service {
 	s, err := NewService(cfg)
 	require.NoError(t, err)
 
-	if net, ok := cfg.Network.(*network.Service); ok {
-		net.SetTransactionHandler(s)
-		_ = net.Stop()
-	}
-
 	return s
 }
diff --git a/dot/network/config.go b/dot/network/config.go
@@ -33,7 +33,7 @@ const (
 	DefaultBasePath = "~/.gossamer/gssmr"
 
 	// DefaultPort the default value for Config.Port
-	DefaultPort = uint32(7000)
+	DefaultPort = uint16(7000)
 
 	// DefaultRandSeed the default value for Config.RandSeed (0 = non-deterministic)
 	DefaultRandSeed = int64(0)
@@ -74,7 +74,7 @@ type Config struct {
 	TransactionHandler TransactionHandler
 
 	// Port the network port used for listening
-	Port uint32
+	Port uint16
 	// RandSeed the seed used to generate the network p2p identity (0 = non-deterministic random seed)
 	RandSeed int64
 	// Bootnodes the peer addresses used for bootstrapping