mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-26 13:18:57 +00:00
96 lines
2.9 KiB
Go
96 lines
2.9 KiB
Go
package p2p
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/ethereum/go-ethereum/p2p/enr"
|
|
"github.com/gogo/protobuf/proto"
|
|
"github.com/libp2p/go-libp2p-core/connmgr"
|
|
"github.com/libp2p/go-libp2p-core/host"
|
|
"github.com/libp2p/go-libp2p-core/network"
|
|
"github.com/libp2p/go-libp2p-core/peer"
|
|
pubsub "github.com/libp2p/go-libp2p-pubsub"
|
|
ethpb "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/p2p/encoder"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/p2p/peers"
|
|
pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
|
|
)
|
|
|
|
// P2P represents the full p2p interface composed of all of the sub-interfaces.
|
|
type P2P interface {
|
|
Broadcaster
|
|
SetStreamHandler
|
|
EncodingProvider
|
|
PubSubProvider
|
|
PubSubTopicUser
|
|
PeerManager
|
|
Sender
|
|
ConnectionHandler
|
|
PeersProvider
|
|
MetadataProvider
|
|
}
|
|
|
|
// Broadcaster broadcasts messages to peers over the p2p pubsub protocol.
|
|
type Broadcaster interface {
|
|
Broadcast(context.Context, proto.Message) error
|
|
BroadcastAttestation(ctx context.Context, subnet uint64, att *ethpb.Attestation) error
|
|
}
|
|
|
|
// SetStreamHandler configures p2p to handle streams of a certain topic ID.
|
|
type SetStreamHandler interface {
|
|
SetStreamHandler(topic string, handler network.StreamHandler)
|
|
}
|
|
|
|
// PubSubTopicUser provides way to join, use and leave PubSub topics.
|
|
type PubSubTopicUser interface {
|
|
JoinTopic(topic string, opts ...pubsub.TopicOpt) (*pubsub.Topic, error)
|
|
LeaveTopic(topic string) error
|
|
PublishToTopic(ctx context.Context, topic string, data []byte, opts ...pubsub.PubOpt) error
|
|
SubscribeToTopic(topic string, opts ...pubsub.SubOpt) (*pubsub.Subscription, error)
|
|
}
|
|
|
|
// ConnectionHandler configures p2p to handle connections with a peer.
|
|
type ConnectionHandler interface {
|
|
AddConnectionHandler(f func(ctx context.Context, id peer.ID) error,
|
|
j func(ctx context.Context, id peer.ID) error)
|
|
AddDisconnectionHandler(f func(ctx context.Context, id peer.ID) error)
|
|
connmgr.ConnectionGater
|
|
}
|
|
|
|
// EncodingProvider provides p2p network encoding.
|
|
type EncodingProvider interface {
|
|
Encoding() encoder.NetworkEncoding
|
|
}
|
|
|
|
// PubSubProvider provides the p2p pubsub protocol.
|
|
type PubSubProvider interface {
|
|
PubSub() *pubsub.PubSub
|
|
}
|
|
|
|
// PeerManager abstracts some peer management methods from libp2p.
|
|
type PeerManager interface {
|
|
Disconnect(peer.ID) error
|
|
PeerID() peer.ID
|
|
Host() host.Host
|
|
ENR() *enr.Record
|
|
RefreshENR()
|
|
FindPeersWithSubnet(ctx context.Context, index uint64) (bool, error)
|
|
AddPingMethod(reqFunc func(ctx context.Context, id peer.ID) error)
|
|
}
|
|
|
|
// Sender abstracts the sending functionality from libp2p.
|
|
type Sender interface {
|
|
Send(context.Context, interface{}, string, peer.ID) (network.Stream, error)
|
|
}
|
|
|
|
// PeersProvider abstracts obtaining our current list of known peers status.
|
|
type PeersProvider interface {
|
|
Peers() *peers.Status
|
|
}
|
|
|
|
// MetadataProvider returns the metadata related information for the local peer.
|
|
type MetadataProvider interface {
|
|
Metadata() *pb.MetaData
|
|
MetadataSeq() uint64
|
|
}
|