pex

README

go-libp2p-pex

Implementation of libp2p peer discovery module which uses custom Peer EXchange protocol

Install

go get github.com/Secured-Finance/go-libp2p-pex

Usage

Check out the Go Docs.

Contribute

PRs accepted.

License

This project is licensed under the MIT license, Copyright (c) 2021 Secured Finance. For more information see LICENSE.md.

Documentation

Index

• Constants
• Variables
• type DiscoveryNetworkManager
  • func NewPEXDiscoveryNetwork(ctx context.Context, pex *PEXDiscovery) *DiscoveryNetworkManager
• type Handler
• type PEXDiscovery
  • func NewPEXDiscovery(h host.Host, bootstrapNodes []ma.Multiaddr, updateInterval time.Duration) (*PEXDiscovery, error)
  • func (pd *PEXDiscovery) Advertise(ctx context.Context, ns string, opts ...discovery.Option) (time.Duration, error)
  • func (pd *PEXDiscovery) FindPeers(ctx context.Context, ns string, opts ...discovery.Option) (<-chan peer.AddrInfo, error)
• type PEXMessage
• type StreamWrapper
  • func (sw *StreamWrapper) SendMessage(ctx context.Context, msg *PEXMessage) error
  • func (sw *StreamWrapper) SendRequest(ctx context.Context, msg *PEXMessage) (*PEXMessage, error)

Constants

const (
	PEXProtocolID = "/pex/2.0.0"

	DefaultGetPeersMaxCount = 30
)

const (
	MessageTypeGetPeers = iota
	MessageTypeAdvertise
	MessageTypePing
	MessageTypePong
)

Variables

var (
	Random = rand.New(cryptoSource{})
)

Types

type DiscoveryNetworkManager

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

func NewPEXDiscoveryNetwork

func NewPEXDiscoveryNetwork(ctx context.Context, pex *PEXDiscovery) *DiscoveryNetworkManager

type Handler

type Handler func(ctx context.Context, peerID peer.ID, msg *PEXMessage) (*PEXMessage, error)

type PEXDiscovery

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

func NewPEXDiscovery

func NewPEXDiscovery(h host.Host, bootstrapNodes []ma.Multiaddr, updateInterval time.Duration) (*PEXDiscovery, error)

func (*PEXDiscovery) Advertise

func (pd *PEXDiscovery) Advertise(ctx context.Context, ns string, opts ...discovery.Option) (time.Duration, error)

func (*PEXDiscovery) FindPeers

func (pd *PEXDiscovery) FindPeers(ctx context.Context, ns string, opts ...discovery.Option) (<-chan peer.AddrInfo, error)

type PEXMessage

type PEXMessage struct {
	Type          uint8       `json:"type"`
	PeerInfo      *peerInfo   `json:"peerInfo"`
	Peers         []*peerInfo `json:"peers"`
	GetPeersCount uint        `json:"getPeersCount"`
	NetworkID     string      `json:"networkID"`
}

type StreamWrapper

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

func (*StreamWrapper) SendMessage

func (sw *StreamWrapper) SendMessage(ctx context.Context, msg *PEXMessage) error

func (*StreamWrapper) SendRequest

func (sw *StreamWrapper) SendRequest(ctx context.Context, msg *PEXMessage) (*PEXMessage, error)