p2p

Documentation

Overview

package p2p is a low-level library responsible for peer discovery and sending/receiving messages.

Index

• Constants
• Variables
• func BootstrapListToAddrInfos(bootstrapList []string) ([]peer.AddrInfo, error)
• func ConnectToBootstrapList(ctx context.Context, host host.Host, bootstrapList []string) error
• func Filters(filters *filter.Filters) libp2p.Option
• func NewDHT(ctx context.Context, storageDir string, host host.Host) (*dht.IpfsDHT, error)
• type Config
• type Message
• type MessageHandler
• type Node
  • func New(ctx context.Context, config Config) (*Node, error)
  • func (n *Node) AddPeerScore(id peer.ID, tag string, diff int)
  • func (n *Node) Connect(peerInfo peer.AddrInfo, timeout time.Duration) error
  • func (n *Node) GetNumPeers() int
  • func (n *Node) ID() peer.ID
  • func (n *Node) Multiaddrs() []ma.Multiaddr
  • func (n *Node) Neighbors() []peer.ID
  • func (n *Node) NewStream(ctx context.Context, p peer.ID, pids ...protocol.ID) (network.Stream, error)
  • func (n *Node) Send(data []byte) error
  • func (n *Node) SetPeerScore(id peer.ID, tag string, val int)
  • func (n *Node) SetStreamHandler(pid protocol.ID, handler network.StreamHandler)
  • func (n *Node) Start() error
  • func (n *Node) UnsetPeerScore(id peer.ID, tag string)

Constants

const DHTProtocolID = protocol.ID("/0x-mesh-dht/klaytn/version/1")

Variables

var DefaultBootstrapList = []string{
	"/dns4/mesh-bootstrap.kompose.app/tcp/40558/ipfs/16Uiu2HAmHdNdpFuUY1SwidGH29YsauLbj7YLVvfEZsShok8rPvZj",
	"/dns4/mesh-bootstrap.kompose.app/tcp/40559/ws/ipfs/16Uiu2HAmHdNdpFuUY1SwidGH29YsauLbj7YLVvfEZsShok8rPvZj",

	"/ip4/34.201.54.78/tcp/4001/ipfs/12D3KooWHwJDdbx73qiBpSCJfg4RuYyzqnLUwfLBqzn77TSy7kRX",
	"/ip4/18.204.221.103/tcp/4001/ipfs/12D3KooWQS6Gsr2kLZvF7DVtoRFtj24aar5jvz88LvJePrawM3EM",
}

DefaultBootstrapList is a list of addresses to use by default for bootstrapping the DHT.

Functions

func BootstrapListToAddrInfos

func BootstrapListToAddrInfos(bootstrapList []string) ([]peer.AddrInfo, error)

func ConnectToBootstrapList

func ConnectToBootstrapList(ctx context.Context, host host.Host, bootstrapList []string) error

func Filters

func Filters(filters *filter.Filters) libp2p.Option

func NewDHT

func NewDHT(ctx context.Context, storageDir string, host host.Host) (*dht.IpfsDHT, error)

NewDHT returns a new Kademlia DHT instance configured to work with 0x Mesh in native (pure Go) environments. storageDir is the directory to use for persisting the data with LevelDB.

Types

type Config

type Config struct {
	// SubscribeTopic is the topic to subscribe to for new messages. Only messages
	// that are published on this topic will be received and processed.
	SubscribeTopic string
	// PublishTopics are the topics to publish messages to. Messages may be
	// published to more than one topic (e.g. a topic for all orders and a topic
	// for orders with a specific asset).
	PublishTopics []string
	// TCPPort is the port on which to listen for incoming TCP connections.
	TCPPort int
	// WebSocketsPort is the port on which to listen for incoming WebSockets
	// connections.
	WebSocketsPort int
	// Insecure controls whether or not messages should be encrypted. It should
	// always be set to false in production.
	Insecure bool
	// PrivateKey is the private key which will be used for signing messages and
	// generating a peer ID.
	PrivateKey p2pcrypto.PrivKey
	// MessageHandler is an interface responsible for validating, storing, and
	// finding new messages to share.
	MessageHandler MessageHandler
	// RendezvousString is a unique identifier for the rendezvous point. This node
	// will attempt to find peers with the same Rendezvous string.
	RendezvousString string
	// UseBootstrapList determines whether or not to use the list of hard-coded
	// peers to bootstrap the DHT for peer discovery.
	UseBootstrapList bool
	// BootstrapList is a list of multiaddress strings to use for bootstrapping
	// the DHT. If empty, the default list will be used.
	BootstrapList []string
	// DataDir is the directory to use for storing data.
	DataDir string
	// GlobalPubSubMessageLimit is the maximum number of messages per second that
	// will be forwarded through GossipSub on behalf of other peers. It is an
	// important mechanism for limiting our own upload bandwidth. Without a global
	// limit, we could use an unbounded amount of upload bandwidth on propagating
	// GossipSub messages sent by other peers. The global limit is required
	// because we can receive GossipSub messages from peers that we are not
	// connected to (so the per peer limit combined with a maximum number of peers
	// is not, by itself, sufficient).
	GlobalPubSubMessageLimit rate.Limit
	// GlobalPubSubMessageBurst is the maximum number of messages that will be
	// forwarded through GossipSub at once.
	GlobalPubSubMessageBurst int
	// PerPeerPubSubMessageLimit is the maximum number of messages per second that
	// each peer is allowed to send through the GossipSub network. Any additional
	// messages will be dropped.
	PerPeerPubSubMessageLimit rate.Limit
	// PerPeerPubSubMessageBurst is the maximum number of messages that each peer
	// is allowed to send at once through the GossipSub network. Any additional
	// messages will be dropped.
	PerPeerPubSubMessageBurst int
	// CustomMessageValidator is a custom validator for GossipSub messages. All
	// incoming and outgoing messages will be dropped unless they are valid
	// according to this custom validator, which will be run in addition to the
	// default validators.
	CustomMessageValidator pubsub.Validator
}

Config contains configuration options for a Node.

type Message

type Message struct {
	// From is the peer ID of the peer who sent the message.
	From peer.ID
	// Data is the underlying data for the message.
	Data []byte
}

type MessageHandler

type MessageHandler interface {
	// HandleMessages is called whenever new messages are received. It should only
	// return an error if there was a problem handling the messages. It should not
	// return an error for invalid or duplicate messages.
	HandleMessages(context.Context, []*Message) error
}

MessageHandler is an interface responsible for validating and storing messages as well as selecting messages which are ready to be shared.

type Node

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

Node is the main type for the p2p package. It represents a particpant in the 0x Mesh network who is capable of sending, receiving, validating, and storing messages.

func New

func New(ctx context.Context, config Config) (*Node, error)

New creates a new Node with the given context and config. The Node will stop all background operations if the context is canceled.

func (*Node) AddPeerScore

func (n *Node) AddPeerScore(id peer.ID, tag string, diff int)

AddPeerScore adds diff to the current score for a given peer. Tag is a unique identifier for the score. A peer's total score is the sum of the scores associated with each tag. Peers that end up with a low total score will eventually be disconnected.

func (*Node) Connect

func (n *Node) Connect(peerInfo peer.AddrInfo, timeout time.Duration) error

Connect ensures there is a connection between this host and the peer with given peerInfo. If there is not an active connection, Connect will dial the peer, and block until a connection is open, timeout is exceeded, or an error is returned.

func (*Node) GetNumPeers

func (n *Node) GetNumPeers() int

GetNumPeers returns the number of peers the node is connected to

func (*Node) ID

func (n *Node) ID() peer.ID

ID returns the peer id of the node.

func (*Node) Multiaddrs

func (n *Node) Multiaddrs() []ma.Multiaddr

Multiaddrs returns all multi addresses at which the node is dialable.

func (*Node) Neighbors

func (n *Node) Neighbors() []peer.ID

Neighbors returns a list of peer IDs that this node is currently connected to.

func (*Node) NewStream

func (n *Node) NewStream(ctx context.Context, p peer.ID, pids ...protocol.ID) (network.Stream, error)

func (*Node) Send

func (n *Node) Send(data []byte) error

Send sends a message continaing the given data to all connected peers.

func (*Node) SetPeerScore

func (n *Node) SetPeerScore(id peer.ID, tag string, val int)

SetPeerScore sets the current score for a given peer (overwriting any previous value with the same tag). Tag is a unique identifier for the score. A peer's total score is the sum of the scores associated with each tag. Peers that end up with a low total score will eventually be disconnected.

func (*Node) SetStreamHandler

func (n *Node) SetStreamHandler(pid protocol.ID, handler network.StreamHandler)

SetStreamHandler registers a handler for a custom protocol.

func (*Node) Start

func (n *Node) Start() error

Start causes the Node to continuously send messages to and receive messages from its peers. It blocks until an error is encountered or `Stop` is called.

func (*Node) UnsetPeerScore

func (n *Node) UnsetPeerScore(id peer.ID, tag string)

UnsetPeerScore removes any scores associated with the given tag for a peer (i.e., they will no longer be counted toward the peers total score).