prysm-pulse/beacon-chain/sync/service.go

package sync

import (
	"context"
	"sync"

	"github.com/libp2p/go-libp2p-core/peer"
	"github.com/prysmaticlabs/prysm/beacon-chain/blockchain"
	"github.com/prysmaticlabs/prysm/beacon-chain/db"
	"github.com/prysmaticlabs/prysm/beacon-chain/operations"
	"github.com/prysmaticlabs/prysm/beacon-chain/p2p"
	pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
	"github.com/prysmaticlabs/prysm/shared"
)

var _ = shared.Service(&RegularSync{})

// Config to set up the regular sync service.
type Config struct {
	P2P        p2p.P2P
	DB         db.Database
	Operations *operations.Service
	Chain      blockchainService
}

// This defines the interface for interacting with block chain service
type blockchainService interface {
	blockchain.BlockReceiver
	blockchain.HeadFetcher
	blockchain.FinalizationFetcher
	blockchain.AttestationReceiver
	blockchain.ChainFeeds
}

// NewRegularSync service.
func NewRegularSync(cfg *Config) *RegularSync {
	r := &RegularSync{
		ctx:          context.Background(),
		db:           cfg.DB,
		p2p:          cfg.P2P,
		operations:   cfg.Operations,
		chain:        cfg.Chain,
		helloTracker: make(map[peer.ID]*pb.Hello),
	}

	r.registerRPCHandlers()
	r.registerSubscribers()

	return r
}

// RegularSync service is responsible for handling all run time p2p related operations as the
// main entry point for network messages.
type RegularSync struct {
	ctx              context.Context
	p2p              p2p.P2P
	db               db.Database
	operations       *operations.Service
	chain            blockchainService
	helloTracker     map[peer.ID]*pb.Hello
	helloTrackerLock sync.RWMutex
	chainStarted     bool
}

// Start the regular sync service.
func (r *RegularSync) Start() {
	r.p2p.AddConnectionHandler(r.sendRPCHelloRequest)
}

// Stop the regular sync service.
func (r *RegularSync) Stop() error {
	return nil
}

// Status of the currently running regular sync service.
func (r *RegularSync) Status() error {
	return nil
}

// Syncing returns true if the node is currently syncing with the network.
func (r *RegularSync) Syncing() bool {
	// TODO(3147): Use real value.
	return false
}

// Hellos returns the map of hello messages received so far.
func (r *RegularSync) Hellos() map[peer.ID]*pb.Hello {
	r.helloTrackerLock.RLock()
	defer r.helloTrackerLock.RUnlock()
	return r.helloTracker
}

// Checker defines a struct which can verify whether a node is currently
// synchronizing a chain with the rest of peers in the network.
type Checker interface {
	Syncing() bool
	Status() error
}

// HelloTracker interface for accessing the hello / handshake messages received so far.
type HelloTracker interface {
	Hellos() map[peer.ID]*pb.Hello
}