p2p

package
v5.0.4-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 3, 2024 License: GPL-3.0 Imports: 85 Imported by: 4

Documentation

Overview

Package p2p implements the Ethereum consensus networking specification.

Canonical spec reference: https://github.com/ethereum/consensus-specs/blob/dev/specs/phase0/p2p-interface.md

Prysm specific implementation design docs

This package is heavily utilizes the libp2p go implementation by Protocol Labs.

Package p2p defines the network protocol implementation for Ethereum consensus used by beacon nodes, including peer discovery using discv5, gossip-sub using libp2p, and handing peer lifecycles + handshakes.

Index

Constants

View Source 
const (
	// V1 RPC Topics
	// RPCStatusTopicV1 defines the v1 topic for the status rpc method.
	RPCStatusTopicV1 = protocolPrefix + StatusMessageName + SchemaVersionV1
	// RPCGoodByeTopicV1 defines the v1 topic for the goodbye rpc method.
	RPCGoodByeTopicV1 = protocolPrefix + GoodbyeMessageName + SchemaVersionV1
	// RPCBlocksByRangeTopicV1 defines v1 the topic for the blocks by range rpc method.
	RPCBlocksByRangeTopicV1 = protocolPrefix + BeaconBlocksByRangeMessageName + SchemaVersionV1
	// RPCBlocksByRootTopicV1 defines the v1 topic for the blocks by root rpc method.
	RPCBlocksByRootTopicV1 = protocolPrefix + BeaconBlocksByRootsMessageName + SchemaVersionV1
	// RPCPingTopicV1 defines the v1 topic for the ping rpc method.
	RPCPingTopicV1 = protocolPrefix + PingMessageName + SchemaVersionV1
	// RPCMetaDataTopicV1 defines the v1 topic for the metadata rpc method.
	RPCMetaDataTopicV1 = protocolPrefix + MetadataMessageName + SchemaVersionV1

	// RPCBlobSidecarsByRangeTopicV1 is a topic for requesting blob sidecars
	// in the slot range [start_slot, start_slot + count), leading up to the current head block as selected by fork choice.
	// Protocol ID: /eth2/beacon_chain/req/blob_sidecars_by_range/1/ - New in deneb.
	RPCBlobSidecarsByRangeTopicV1 = protocolPrefix + BlobSidecarsByRangeName + SchemaVersionV1
	// RPCBlobSidecarsByRootTopicV1 is a topic for requesting blob sidecars by their block root. New in deneb.
	// /eth2/beacon_chain/req/blob_sidecars_by_root/1/
	RPCBlobSidecarsByRootTopicV1 = protocolPrefix + BlobSidecarsByRootName + SchemaVersionV1

	// V2 RPC Topics
	// RPCBlocksByRangeTopicV2 defines v2 the topic for the blocks by range rpc method.
	RPCBlocksByRangeTopicV2 = protocolPrefix + BeaconBlocksByRangeMessageName + SchemaVersionV2
	// RPCBlocksByRootTopicV2 defines the v2 topic for the blocks by root rpc method.
	RPCBlocksByRootTopicV2 = protocolPrefix + BeaconBlocksByRootsMessageName + SchemaVersionV2
	// RPCMetaDataTopicV2 defines the v2 topic for the metadata rpc method.
	RPCMetaDataTopicV2 = protocolPrefix + MetadataMessageName + SchemaVersionV2
)
View Source 
const (
	// GossipProtocolAndDigest represents the protocol and fork digest prefix in a gossip topic.
	GossipProtocolAndDigest = "/eth2/%x/"

	// Message Types
	//
	// GossipAttestationMessage is the name for the attestation message type. It is
	// specially extracted so as to determine the correct message type from an attestation
	// subnet.
	GossipAttestationMessage = "beacon_attestation"
	// GossipSyncCommitteeMessage is the name for the sync committee message type. It is
	// specially extracted so as to determine the correct message type from a sync committee
	// subnet.
	GossipSyncCommitteeMessage = "sync_committee"
	// GossipBlockMessage is the name for the block message type.
	GossipBlockMessage = "beacon_block"
	// GossipExitMessage is the name for the voluntary exit message type.
	GossipExitMessage = "voluntary_exit"
	// GossipProposerSlashingMessage is the name for the proposer slashing message type.
	GossipProposerSlashingMessage = "proposer_slashing"
	// GossipAttesterSlashingMessage is the name for the attester slashing message type.
	GossipAttesterSlashingMessage = "attester_slashing"
	// GossipAggregateAndProofMessage is the name for the attestation aggregate and proof message type.
	GossipAggregateAndProofMessage = "beacon_aggregate_and_proof"
	// GossipContributionAndProofMessage is the name for the sync contribution and proof message type.
	GossipContributionAndProofMessage = "sync_committee_contribution_and_proof"
	// GossipBlsToExecutionChangeMessage is the name for the bls to execution change message type.
	GossipBlsToExecutionChangeMessage = "bls_to_execution_change"
	// GossipBlobSidecarMessage is the name for the blob sidecar message type.
	GossipBlobSidecarMessage = "blob_sidecar"
	// Topic Formats
	//
	// AttestationSubnetTopicFormat is the topic format for the attestation subnet.
	AttestationSubnetTopicFormat = GossipProtocolAndDigest + GossipAttestationMessage + "_%d"
	// SyncCommitteeSubnetTopicFormat is the topic format for the sync committee subnet.
	SyncCommitteeSubnetTopicFormat = GossipProtocolAndDigest + GossipSyncCommitteeMessage + "_%d"
	// BlockSubnetTopicFormat is the topic format for the block subnet.
	BlockSubnetTopicFormat = GossipProtocolAndDigest + GossipBlockMessage
	// ExitSubnetTopicFormat is the topic format for the voluntary exit subnet.
	ExitSubnetTopicFormat = GossipProtocolAndDigest + GossipExitMessage
	// ProposerSlashingSubnetTopicFormat is the topic format for the proposer slashing subnet.
	ProposerSlashingSubnetTopicFormat = GossipProtocolAndDigest + GossipProposerSlashingMessage
	// AttesterSlashingSubnetTopicFormat is the topic format for the attester slashing subnet.
	AttesterSlashingSubnetTopicFormat = GossipProtocolAndDigest + GossipAttesterSlashingMessage
	// AggregateAndProofSubnetTopicFormat is the topic format for the aggregate and proof subnet.
	AggregateAndProofSubnetTopicFormat = GossipProtocolAndDigest + GossipAggregateAndProofMessage
	// SyncContributionAndProofSubnetTopicFormat is the topic format for the sync aggregate and proof subnet.
	SyncContributionAndProofSubnetTopicFormat = GossipProtocolAndDigest + GossipContributionAndProofMessage
	// BlsToExecutionChangeSubnetTopicFormat is the topic format for the bls to execution change subnet.
	BlsToExecutionChangeSubnetTopicFormat = GossipProtocolAndDigest + GossipBlsToExecutionChangeMessage
	// BlobSubnetTopicFormat is the topic format for the blob subnet.
	BlobSubnetTopicFormat = GossipProtocolAndDigest + GossipBlobSidecarMessage + "_%d"
)
View Source 
const BeaconBlocksByRangeMessageName = "/beacon_blocks_by_range"

BeaconBlocksByRangeMessageName specifies the name for the beacon blocks by range message topic.

View Source 
const BeaconBlocksByRootsMessageName = "/beacon_blocks_by_root"

BeaconBlocksByRootsMessageName specifies the name for the beacon blocks by root message topic.

View Source 
const BlobSidecarsByRangeName = "/blob_sidecars_by_range"

BlobSidecarsByRangeName is the name for the BlobSidecarsByRange v1 message topic.

View Source 
const BlobSidecarsByRootName = "/blob_sidecars_by_root"

BlobSidecarsByRootName is the name for the BlobSidecarsByRoot v1 message topic.

View Source 
const GoodbyeMessageName = "/goodbye"

GoodbyeMessageName specifies the name for the goodbye message topic.

View Source 
const MetadataMessageName = "/metadata"

MetadataMessageName specifies the name for the metadata message topic.

View Source 
const PingMessageName = "/ping"

PingMessageName Specifies the name for the ping message topic.

View Source 
const SchemaVersionV1 = "/1"

SchemaVersionV1 specifies the schema version for our rpc protocol ID.

View Source 
const SchemaVersionV2 = "/2"

SchemaVersionV2 specifies the next schema version for our rpc protocol ID.

View Source 
const StatusMessageName = "/status"

StatusMessageName specifies the name for the status message topic.

Variables

View Source 
var ErrMessageNotMapped = errors.New("message type is not mapped to a PubSub topic")

ErrMessageNotMapped occurs on a Broadcast attempt when a message has not been defined in the GossipTypeMapping.

View Source 
var GossipTypeMapping = make(map[reflect.Type]string, len(gossipTopicMappings))

GossipTypeMapping is the inverse of GossipTopicMappings so that an arbitrary protobuf message can be mapped to a protocol ID string.

View Source 
var OmitContextBytesV1 = map[string]bool{
	StatusMessageName:              true,
	GoodbyeMessageName:             true,
	BeaconBlocksByRangeMessageName: true,
	BeaconBlocksByRootsMessageName: true,
	PingMessageName:                true,
	MetadataMessageName:            true,
}

OmitContextBytesV1 keeps track of which RPC methods do not write context bytes in their v1 incarnations. Phase0 did not have the notion of context bytes, which prefix wire-encoded values with a [4]byte identifier to convey the schema for the receiver to use. These RPCs had a version bump to V2 when the context byte encoding was introduced. For other RPC methods, context bytes are always required.

View Source 
var RPCTopicMappings = map[string]interface{}{

	RPCStatusTopicV1: new(pb.Status),

	RPCGoodByeTopicV1: new(primitives.SSZUint64),

	RPCBlocksByRangeTopicV1: new(pb.BeaconBlocksByRangeRequest),
	RPCBlocksByRangeTopicV2: new(pb.BeaconBlocksByRangeRequest),

	RPCBlocksByRootTopicV1: new(p2ptypes.BeaconBlockByRootsReq),
	RPCBlocksByRootTopicV2: new(p2ptypes.BeaconBlockByRootsReq),

	RPCPingTopicV1: new(primitives.SSZUint64),

	RPCMetaDataTopicV1: new(interface{}),
	RPCMetaDataTopicV2: new(interface{}),

	RPCBlobSidecarsByRangeTopicV1: new(pb.BlobSidecarsByRangeRequest),

	RPCBlobSidecarsByRootTopicV1: new(p2ptypes.BlobSidecarsByRootReq),
}

RPCTopicMappings map the base message type to the rpc request.

Functions

func AllTopics 

func AllTopics() []string

AllTopics returns all topics stored in our gossip mapping.

func ExtractGossipDigest 

func ExtractGossipDigest(topic string) ([4]byte, error)

ExtractGossipDigest extracts the relevant fork digest from the gossip topic. Topics are in the form of /eth2/{fork-digest}/{topic} and this method extracts the fork digest from the topic string to a 4 byte array.

func GossipTopicMappings 

func GossipTopicMappings(topic string, epoch primitives.Epoch) proto.Message

GossipTopicMappings is a function to return the assigned data type versioned by epoch.

func MakePeer 

func MakePeer(addr string) (*peer.AddrInfo, error)

MakePeer from multiaddress string.

func MsgID 

func MsgID(genesisValidatorsRoot []byte, pmsg *pubsubpb.Message) string

MsgID is a content addressable ID function.

Ethereum Beacon Chain spec defines the message ID as: 

The `message-id` of a gossipsub message MUST be the following 20 byte value computed from the message data:
If `message.data` has a valid snappy decompression, set `message-id` to the first 20 bytes of the `SHA256` hash of
the concatenation of `MESSAGE_DOMAIN_VALID_SNAPPY` with the snappy decompressed message data,
i.e. `SHA256(MESSAGE_DOMAIN_VALID_SNAPPY + snappy_decompress(message.data))[:20]`.

Otherwise, set `message-id` to the first 20 bytes of the `SHA256` hash of
the concatenation of `MESSAGE_DOMAIN_INVALID_SNAPPY` with the raw message data,
i.e. `SHA256(MESSAGE_DOMAIN_INVALID_SNAPPY + message.data)[:20]`.

func MultiAddressBuilder 

func MultiAddressBuilder(ip net.IP, tcpPort, quicPort uint) ([]ma.Multiaddr, error)

MultiAddressBuilder takes in an ip address string and port to produce a go multiaddr format.

func ParseBootStrapAddrs added in v5.0.2 

func ParseBootStrapAddrs(addrs []string) (discv5Nodes []string)

func PeersFromStringAddrs 

func PeersFromStringAddrs(addrs []string) ([]ma.Multiaddr, error)

PeersFromStringAddrs converts peer raw ENRs into multiaddrs for p2p.

func SerializeENR 

func SerializeENR(record *enr.Record) (string, error)

SerializeENR takes the enr record in its key-value form and serializes it.

func TopicDeconstructor 

func TopicDeconstructor(topic string) (string, string, string, error)

TopicDeconstructor splits the provided topic to its logical sub-sections. It is assumed all input topics will follow the specific schema: /protocol-prefix/message-name/schema-version/... For the purposes of deconstruction, only the first 3 components are relevant.

func TopicFromMessage 

func TopicFromMessage(msg string, epoch primitives.Epoch) (string, error)

TopicFromMessage constructs the rpc topic from the provided message type and epoch.

func VerifyTopicMapping 

func VerifyTopicMapping(topic string, msg interface{}) error

VerifyTopicMapping verifies that the topic and its accompanying message type is correct.

Types

type Broadcaster 

type Broadcaster interface {
	Broadcast(context.Context, proto.Message) error
	BroadcastAttestation(ctx context.Context, subnet uint64, att *ethpb.Attestation) error
	BroadcastSyncCommitteeMessage(ctx context.Context, subnet uint64, sMsg *ethpb.SyncCommitteeMessage) error
	BroadcastBlob(ctx context.Context, subnet uint64, blob *ethpb.BlobSidecar) error
}

Broadcaster broadcasts messages to peers over the p2p pubsub protocol.

type Config 

type Config struct {
	NoDiscovery          bool
	EnableUPnP           bool
	StaticPeerID         bool
	StaticPeers          []string
	Discv5BootStrapAddrs []string
	RelayNodeAddr        string
	LocalIP              string
	HostAddress          string
	HostDNS              string
	PrivateKey           string
	DataDir              string
	MetaDataDir          string
	QUICPort             uint
	TCPPort              uint
	UDPPort              uint
	MaxPeers             uint
	QueueSize            uint
	AllowListCIDR        string
	DenyListCIDR         []string
	StateNotifier        statefeed.Notifier
	DB                   db.ReadOnlyDatabase
	ClockWaiter          startup.ClockWaiter
}

Config for the p2p service. These parameters are set from application level flags to initialize the p2p service.

type ConnectionHandler 

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
}

ConnectionHandler configures p2p to handle connections with a peer.

type EncodingProvider 

type EncodingProvider interface {
	Encoding() encoder.NetworkEncoding
}

EncodingProvider provides p2p network encoding.

type Listener 

type Listener interface {
	Self() *enode.Node
	Close()
	Lookup(enode.ID) []*enode.Node
	Resolve(*enode.Node) *enode.Node
	RandomNodes() enode.Iterator
	Ping(*enode.Node) error
	RequestENR(*enode.Node) (*enode.Node, error)
	LocalNode() *enode.LocalNode
}

Listener defines the discovery V5 network interface that is used to communicate with other peers.

type MetadataProvider 

type MetadataProvider interface {
	Metadata() metadata.Metadata
	MetadataSeq() uint64
}

MetadataProvider returns the metadata related information for the local peer.

type P2P 

type P2P interface {
	Broadcaster
	SetStreamHandler
	PubSubProvider
	PubSubTopicUser
	SenderEncoder
	PeerManager
	ConnectionHandler
	PeersProvider
	MetadataProvider
}

P2P represents the full p2p interface composed of all of the sub-interfaces.

type PeerManager 

type PeerManager interface {
	Disconnect(peer.ID) error
	PeerID() peer.ID
	Host() host.Host
	ENR() *enr.Record
	DiscoveryAddresses() ([]multiaddr.Multiaddr, error)
	RefreshENR()
	FindPeersWithSubnet(ctx context.Context, topic string, subIndex uint64, threshold int) (bool, error)
	AddPingMethod(reqFunc func(ctx context.Context, id peer.ID) error)
}

PeerManager abstracts some peer management methods from libp2p.

type PeersProvider 

type PeersProvider interface {
	Peers() *peers.Status
}

PeersProvider abstracts obtaining our current list of known peers status.

type PubSubProvider 

type PubSubProvider interface {
	PubSub() *pubsub.PubSub
}

PubSubProvider provides the p2p pubsub protocol.

type PubSubTopicUser 

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)
}

PubSubTopicUser provides way to join, use and leave PubSub topics.

type RPCTopic 

type RPCTopic string

RPCTopic is a type used to denote and represent a req/resp topic.

func (RPCTopic) MessageType 

func (r RPCTopic) MessageType() string

MessageType returns the message type of the rpc topic.

func (RPCTopic) ProtocolPrefix 

func (r RPCTopic) ProtocolPrefix() string

ProtocolPrefix returns the protocol prefix of the rpc topic.

func (RPCTopic) Version 

func (r RPCTopic) Version() string

Version returns the schema version of the rpc topic.

type Sender 

type Sender interface {
	Send(context.Context, interface{}, string, peer.ID) (network.Stream, error)
}

Sender abstracts the sending functionality from libp2p.

type SenderEncoder 

type SenderEncoder interface {
	EncodingProvider
	Sender
}

SenderEncoder allows sending functionality from libp2p as well as encoding for requests and responses.

type Service 

type Service struct {
	// contains filtered or unexported fields
}

Service for managing peer to peer (p2p) networking.

func NewService 

func NewService(ctx context.Context, cfg *Config) (*Service, error)

NewService initializes a new p2p service compatible with shared.Service interface. No connections are made until the Start function is called during the service registry startup.

func (*Service) AddConnectionHandler 

func (s *Service) AddConnectionHandler(reqFunc, goodByeFunc func(ctx context.Context, id peer.ID) error)

AddConnectionHandler adds a callback function which handles the connection with a newly added peer. It performs a handshake with that peer by sending a hello request and validating the response from the peer.

func (*Service) AddDisconnectionHandler 

func (s *Service) AddDisconnectionHandler(handler func(ctx context.Context, id peer.ID) error)

AddDisconnectionHandler disconnects from peers. It handles updating the peer status. This also calls the handler responsible for maintaining other parts of the sync or p2p system.

func (*Service) AddPingMethod 

func (s *Service) AddPingMethod(reqFunc func(ctx context.Context, id peer.ID) error)

AddPingMethod adds the metadata ping rpc method to the p2p service, so that it can be used to refresh ENR.

func (*Service) Broadcast 

func (s *Service) Broadcast(ctx context.Context, msg proto.Message) error

Broadcast a message to the p2p network, the message is assumed to be broadcasted to the current fork.

func (*Service) BroadcastAttestation 

func (s *Service) BroadcastAttestation(ctx context.Context, subnet uint64, att *ethpb.Attestation) error

BroadcastAttestation broadcasts an attestation to the p2p network, the message is assumed to be broadcasted to the current fork.

func (*Service) BroadcastBlob 

func (s *Service) BroadcastBlob(ctx context.Context, subnet uint64, blob *ethpb.BlobSidecar) error

BroadcastBlob broadcasts a blob to the p2p network, the message is assumed to be broadcasted to the current fork and to the input subnet.

func (*Service) BroadcastSyncCommitteeMessage 

func (s *Service) BroadcastSyncCommitteeMessage(ctx context.Context, subnet uint64, sMsg *ethpb.SyncCommitteeMessage) error

BroadcastSyncCommitteeMessage broadcasts a sync committee message to the p2p network, the message is assumed to be broadcasted to the current fork.

func (*Service) CanSubscribe 

func (s *Service) CanSubscribe(topic string) bool

CanSubscribe returns true if the topic is of interest and we could subscribe to it.

func (*Service) Connect 

func (s *Service) Connect(pi peer.AddrInfo) error

Connect to a specific peer.

func (*Service) Disconnect 

func (s *Service) Disconnect(pid peer.ID) error

Disconnect from a peer.

func (*Service) DiscoveryAddresses 

func (s *Service) DiscoveryAddresses() ([]multiaddr.Multiaddr, error)

DiscoveryAddresses represents our enr addresses as multiaddresses.

func (*Service) ENR 

func (s *Service) ENR() *enr.Record

ENR returns the local node's current ENR.

func (*Service) Encoding 

func (*Service) Encoding() encoder.NetworkEncoding

Encoding returns the configured networking encoding.

func (*Service) FilterIncomingSubscriptions 

func (s *Service) FilterIncomingSubscriptions(_ peer.ID, subs []*pubsubpb.RPC_SubOpts) ([]*pubsubpb.RPC_SubOpts, error)

FilterIncomingSubscriptions is invoked for all RPCs containing subscription notifications. This method returns only the topics of interest and may return an error if the subscription request contains too many topics.

func (*Service) FindPeersWithSubnet 

func (s *Service) FindPeersWithSubnet(ctx context.Context, topic string,
	index uint64, threshold int) (bool, error)

FindPeersWithSubnet performs a network search for peers subscribed to a particular subnet. Then it tries to connect with those peers. This method will block until either: - the required amount of peers are found, or - the context is terminated. On some edge cases, this method may hang indefinitely while peers are actually found. In such a case, the user should cancel the context and re-run the method again.

func (*Service) Host 

func (s *Service) Host() host.Host

Host returns the currently running libp2p host of the service.

func (*Service) InfoHandler 

func (s *Service) InfoHandler(w http.ResponseWriter, _ *http.Request)

InfoHandler is a handler to serve /p2p page in metrics.

func (*Service) InterceptAccept 

func (s *Service) InterceptAccept(n network.ConnMultiaddrs) (allow bool)

InterceptAccept checks whether the incidental inbound connection is allowed.

func (*Service) InterceptAddrDial 

func (s *Service) InterceptAddrDial(pid peer.ID, m multiaddr.Multiaddr) (allow bool)

InterceptAddrDial tests whether we're permitted to dial the specified multiaddr for the given peer.

func (*Service) InterceptPeerDial 

func (*Service) InterceptPeerDial(_ peer.ID) (allow bool)

InterceptPeerDial tests whether we're permitted to Dial the specified peer.

func (*Service) InterceptSecured 

func (*Service) InterceptSecured(_ network.Direction, _ peer.ID, _ network.ConnMultiaddrs) (allow bool)

InterceptSecured tests whether a given connection, now authenticated, is allowed.

func (*Service) InterceptUpgraded 

func (*Service) InterceptUpgraded(_ network.Conn) (allow bool, reason control.DisconnectReason)

InterceptUpgraded tests whether a fully capable connection is allowed.

func (*Service) JoinTopic 

func (s *Service) JoinTopic(topic string, opts ...pubsub.TopicOpt) (*pubsub.Topic, error)

JoinTopic will join PubSub topic, if not already joined.

func (*Service) LeaveTopic 

func (s *Service) LeaveTopic(topic string) error

LeaveTopic closes topic and removes corresponding handler from list of joined topics. This method will return error if there are outstanding event handlers or subscriptions.

func (*Service) Metadata 

func (s *Service) Metadata() metadata.Metadata

Metadata returns a copy of the peer's metadata.

func (*Service) MetadataSeq 

func (s *Service) MetadataSeq() uint64

MetadataSeq returns the metadata sequence number.

func (*Service) PeerID 

func (s *Service) PeerID() peer.ID

PeerID returns the Peer ID of the local peer.

func (*Service) Peers 

func (s *Service) Peers() *peers.Status

Peers returns the peer status interface.

func (*Service) PubSub 

func (s *Service) PubSub() *pubsub.PubSub

PubSub returns the p2p pubsub framework.

func (*Service) PublishToTopic 

func (s *Service) PublishToTopic(ctx context.Context, topic string, data []byte, opts ...pubsub.PubOpt) error

PublishToTopic joins (if necessary) and publishes a message to a PubSub topic.

func (*Service) RefreshENR 

func (s *Service) RefreshENR()

RefreshENR uses an epoch to refresh the enr entry for our node with the tracked committee ids for the epoch, allowing our node to be dynamically discoverable by others given our tracked committee ids.

func (*Service) Send 

func (s *Service) Send(ctx context.Context, message interface{}, baseTopic string, pid peer.ID) (network.Stream, error)

Send a message to a specific peer. The returned stream may be used for reading, but has been closed for writing.

When done, the caller must Close or Reset on the stream.

func (*Service) SetStreamHandler 

func (s *Service) SetStreamHandler(topic string, handler network.StreamHandler)

SetStreamHandler sets the protocol handler on the p2p host multiplexer. This method is a pass through to libp2pcore.Host.SetStreamHandler.

func (*Service) Start 

func (s *Service) Start()

Start the p2p service.

func (*Service) Started 

func (s *Service) Started() bool

Started returns true if the p2p service has successfully started.

func (*Service) Status 

func (s *Service) Status() error

Status of the p2p service. Will return an error if the service is considered unhealthy to indicate that this node should not serve traffic until the issue has been resolved.

func (*Service) Stop 

func (s *Service) Stop() error

Stop the p2p service and terminate all peer connections.

func (*Service) SubscribeToTopic 

func (s *Service) SubscribeToTopic(topic string, opts ...pubsub.SubOpt) (*pubsub.Subscription, error)

SubscribeToTopic joins (if necessary) and subscribes to PubSub topic.

type SetStreamHandler 

type SetStreamHandler interface {
	SetStreamHandler(topic string, handler network.StreamHandler)
}

SetStreamHandler configures p2p to handle streams of a certain topic ID.

Source Files

View all Source files

Directories

Path Synopsis
Package encoder allows for registering custom data encoders for information sent as raw bytes over the wire via p2p to other nodes.
 Package encoder allows for registering custom data encoders for information sent as raw bytes over the wire via p2p to other nodes.
Package peers provides information about peers at the Ethereum consensus protocol level.
 Package peers provides information about peers at the Ethereum consensus protocol level.
peerdata
scorers
Package testing includes useful utilities for mocking a beacon node's p2p service for unit tests.
 Package testing includes useful utilities for mocking a beacon node's p2p service for unit tests.
Package types contains all the respective p2p types that are required for sync but cannot be represented as a protobuf schema.
 Package types contains all the respective p2p types that are required for sync but cannot be represented as a protobuf schema.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.