p2p

Documentation

Index

• Constants
• func New(ctx context.Context, logger *zap.Logger, cfg *Config) (network.Network, error)
• func TransformEnr(enr string) []string
• type Config
• type SyncStream
  • func (s *SyncStream) Close() error
  • func (s *SyncStream) CloseWrite() error
  • func (s *SyncStream) Read(p []byte) (n int, err error)
  • func (s *SyncStream) RemotePeer() string
  • func (s *SyncStream) Write(p []byte) (n int, err error)

Constants

const (
	// DiscoveryInterval is how often we re-publish our mDNS records.
	DiscoveryInterval = time.Second

	// DiscoveryServiceTag is used in our mDNS advertisements to discover other chat peers.
	DiscoveryServiceTag = "bloxstaking.ssv"

	// MsgChanSize is the buffer size of the message channel
	MsgChanSize = 128
)

Functions

func New

func New(ctx context.Context, logger *zap.Logger, cfg *Config) (network.Network, error)

New is the constructor of p2pNetworker

func TransformEnr

func TransformEnr(enr string) []string

TransformEnr converts defaults enr value and convert it to slice

Types

type Config

type Config struct {
	// yaml/env arguments
	Enr              string        `yaml:"Enr" env:"ENR_KEY" env-description:"enr used in discovery" env-default:""`
	DiscoveryType    string        `yaml:"DiscoveryType" env:"DISCOVERY_TYPE_KEY" env-description:"Method to use in discovery" env-default:"discv5"`
	TCPPort          int           `yaml:"TcpPort" env:"TCP_PORT" env-default:"13000"`
	UDPPort          int           `yaml:"UdpPort" env:"UDP_PORT" env-default:"12000"`
	HostAddress      string        `yaml:"HostAddress" env:"HOST_ADDRESS" env-required:"true" env-description:"External ip node is exposed for discovery"`
	HostDNS          string        `yaml:"HostDNS" env:"HOST_DNS" env-description:"External DNS node is exposed for discovery"`
	RequestTimeout   time.Duration `yaml:"RequestTimeout" env:"P2P_REQUEST_TIMEOUT"  env-default:"5s"`
	MaxBatchResponse uint64        `` /* 133-byte string literal not displayed */
	PubSubTraceOut   string        `yaml:"PubSubTraceOut" env:"PUBSUB_TRACE_OUT" env-description:"File path to hold collected pubsub traces"`

	// objects / instances
	HostID              peer.ID
	Topics              map[string]*pubsub.Topic
	Discv5BootStrapAddr []string

	// Network private key is used for network identity
	NetworkPrivateKey *ecdsa.PrivateKey
}

Config - describe the config options for p2p network

type SyncStream

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

SyncStream is a wrapper struct for the core.Stream interface to match the network.SyncStream interface

func (*SyncStream) Close

func (s *SyncStream) Close() error

Close closes the stream

func (*SyncStream) CloseWrite

func (s *SyncStream) CloseWrite() error

CloseWrite closes write stream

func (*SyncStream) Read

func (s *SyncStream) Read(p []byte) (n int, err error)

Read reads data to p

func (*SyncStream) RemotePeer

func (s *SyncStream) RemotePeer() string

RemotePeer returns connected peer

func (*SyncStream) Write

func (s *SyncStream) Write(p []byte) (n int, err error)

Write writes p to stream