libp2p

Documentation

Index

• Constants
• type Options
• type Service
  • func New(ctx context.Context, signer beecrypto.Signer, networkID uint64, ...) (*Service, error)
  • func (s *Service) AddProtocol(p p2p.ProtocolSpec) (err error)
  • func (s *Service) Addresses() (addresses []ma.Multiaddr, err error)
  • func (s *Service) Blocklist(overlay swarm.Address, duration time.Duration, reason string) error
  • func (s *Service) Blocklisted(overlay swarm.Address) (bool, error)
  • func (s *Service) BlocklistedPeers() ([]p2p.BlockListedPeer, error)
  • func (s *Service) Close() error
  • func (s *Service) Connect(ctx context.Context, addr ma.Multiaddr) (address *bzz.Address, err error)
  • func (s *Service) Disconnect(overlay swarm.Address, reason string) (err error)
  • func (s *Service) GetWelcomeMessage() string
  • func (s *Service) Halt()
  • func (s *Service) Metrics() []prometheus.Collector
  • func (s *Service) NATManager() basichost.NATManager
  • func (s *Service) NetworkStatus() p2p.NetworkStatus
  • func (s *Service) NewStream(ctx context.Context, overlay swarm.Address, headers p2p.Headers, ...) (p2p.Stream, error)
  • func (s *Service) Peers() []p2p.Peer
  • func (s *Service) Ping(ctx context.Context, addr ma.Multiaddr) (rtt time.Duration, err error)
  • func (s *Service) Ready() error
  • func (s *Service) SetPickyNotifier(n p2p.PickyNotifier)
  • func (s *Service) SetWelcomeMessage(val string) error
• type UpnpAddressResolver
  • func (r *UpnpAddressResolver) Resolve(observedAddress ma.Multiaddr) (ma.Multiaddr, error)

Constants

const (
	IncomingStreamCountLimit = 5_000
	OutgoingStreamCountLimit = 10_000
)

Types

type Options

type Options struct {
	PrivateKey      *ecdsa.PrivateKey
	NATAddr         string
	EnableWS        bool
	FullNode        bool
	LightNodeLimit  int
	WelcomeMessage  string
	Nonce           []byte
	ValidateOverlay bool

	HeadersRWTimeout time.Duration
	Registry         *prometheus.Registry
	// contains filtered or unexported fields
}

type Service

type Service struct {
	HeadersRWTimeout time.Duration
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, signer beecrypto.Signer, networkID uint64, overlay swarm.Address, addr string, ab addressbook.Putter, storer storage.StateStorer, lightNodes *lightnode.Container, logger log.Logger, tracer *tracing.Tracer, o Options) (*Service, error)

func (*Service) AddProtocol

func (s *Service) AddProtocol(p p2p.ProtocolSpec) (err error)

func (*Service) Addresses

func (s *Service) Addresses() (addresses []ma.Multiaddr, err error)

func (*Service) Blocklist

func (s *Service) Blocklist(overlay swarm.Address, duration time.Duration, reason string) error

func (*Service) Blocklisted

func (s *Service) Blocklisted(overlay swarm.Address) (bool, error)

func (*Service) BlocklistedPeers

func (s *Service) BlocklistedPeers() ([]p2p.BlockListedPeer, error)

func (*Service) Close

func (s *Service) Close() error

func (*Service) Connect

func (s *Service) Connect(ctx context.Context, addr ma.Multiaddr) (address *bzz.Address, err error)

func (*Service) Disconnect

func (s *Service) Disconnect(overlay swarm.Address, reason string) (err error)

func (*Service) GetWelcomeMessage

func (s *Service) GetWelcomeMessage() string

GetWelcomeMessage returns the value of the welcome message.

func (*Service) Halt

func (s *Service) Halt()

func (*Service) Metrics

func (s *Service) Metrics() []prometheus.Collector

func (*Service) NATManager

func (s *Service) NATManager() basichost.NATManager

func (*Service) NetworkStatus

func (s *Service) NetworkStatus() p2p.NetworkStatus

NetworkStatus implements the p2p.NetworkStatuser interface.

func (*Service) NewStream

func (s *Service) NewStream(ctx context.Context, overlay swarm.Address, headers p2p.Headers, protocolName, protocolVersion, streamName string) (p2p.Stream, error)

func (*Service) Peers

func (s *Service) Peers() []p2p.Peer

func (*Service) Ping

func (s *Service) Ping(ctx context.Context, addr ma.Multiaddr) (rtt time.Duration, err error)

func (*Service) Ready

func (s *Service) Ready() error

func (*Service) SetPickyNotifier

func (s *Service) SetPickyNotifier(n p2p.PickyNotifier)

func (*Service) SetWelcomeMessage

func (s *Service) SetWelcomeMessage(val string) error

SetWelcomeMessage sets the welcome message for the handshake protocol.

type UpnpAddressResolver

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

func (*UpnpAddressResolver) Resolve

func (r *UpnpAddressResolver) Resolve(observedAddress ma.Multiaddr) (ma.Multiaddr, error)

Resolve checks if there is a possible better advertisable underlay then the provided observed address. In some NAT situations, for example in the case when nodes are behind upnp, observer might send the observed address with a wrong port. In this case, observed address is compared to addresses provided by host, and if there is a same address but with different port, that one is used as advertisable address instead of provided observed one. TODO: this is a quickfix and it will be improved in the future