p2p

type API struct {
	Info                 func() peer.AddrInfo
	Peers                func() []peer.ID
	PeerInfo             func(id peer.ID) peer.AddrInfo
	Connect              func(ctx context.Context, pi peer.AddrInfo) error
	ClosePeer            func(id peer.ID) error
	Connectedness        func(id peer.ID) network.Connectedness
	NATStatus            func() (network.Reachability, error)
	BlockPeer            func(p peer.ID) error
	UnblockPeer          func(p peer.ID) error
	ListBlockedPeers     func() []peer.ID
	Protect              func(id peer.ID, tag string)
	Unprotect            func(id peer.ID, tag string) bool
	IsProtected          func(id peer.ID, tag string) bool
	BandwidthStats       func() metrics.Stats
	BandwidthForPeer     func(id peer.ID) metrics.Stats
	BandwidthForProtocol func(proto protocol.ID) metrics.Stats
	ResourceState        func() (rcmgr.ResourceManagerStat, error)
	PubSubPeers          func(topic string) []peer.ID
}

type Bootstrappers []peer.AddrInfo

type Config struct {
	// ListenAddresses - Addresses to listen to on local NIC.
	ListenAddresses []string
	// AnnounceAddresses - Addresses to be announced/advertised for peers to connect to
	AnnounceAddresses []string
	// NoAnnounceAddresses - Addresses the P2P subsystem may know about, but that should not be
	// announced/advertised, as undialable from WAN
	NoAnnounceAddresses []string

	// a bootstrapper.
	Bootstrapper bool
	// MutualPeers are peers which have a bidirectional peering agreement with the configured node.
	// Connections with those peers are protected from being trimmed, dropped or negatively scored.
	// NOTE: Any two peers must bidirectionally configure each other on their MutualPeers field.
	MutualPeers []string
	// PeerExchange configures the node, whether it should share some peers to a pruned peer.
	// This is enabled by default for Bootstrappers.
	PeerExchange bool
	// ConnManager is a configuration tuple for ConnectionManager.
	ConnManager               ConnManagerConfig
	RoutingTableRefreshPeriod time.Duration
}

type ConnManagerConfig struct {
	// Low and High are watermarks governing the number of connections that'll be maintained.
	Low, High int
	// GracePeriod is the amount of time a newly opened connection is given before it becomes subject
	// to pruning.
	GracePeriod time.Duration
}

type HostBase host.Host

type Module interface {
	// Info returns address information about the host.
	Info() peer.AddrInfo
	// Peers returns all peer IDs used across all inner stores.
	Peers() []peer.ID
	// PeerInfo returns a small slice of information Peerstore has on the
	// given peer.
	PeerInfo(id peer.ID) peer.AddrInfo

	// Connect ensures there is a connection between this host and the peer with
	// given peer.
	Connect(ctx context.Context, pi peer.AddrInfo) error
	// ClosePeer closes the connection to a given peer.
	ClosePeer(id peer.ID) error
	// Connectedness returns a state signaling connection capabilities.
	Connectedness(id peer.ID) network.Connectedness
	// NATStatus returns the current NAT status.
	NATStatus() (network.Reachability, error)

	// BlockPeer adds a peer to the set of blocked peers.
	BlockPeer(p peer.ID) error
	// UnblockPeer removes a peer from the set of blocked peers.
	UnblockPeer(p peer.ID) error
	// ListBlockedPeers returns a list of blocked peers.
	ListBlockedPeers() []peer.ID
	// Protect adds a peer to the list of peers who have a bidirectional
	// peering agreement that they are protected from being trimmed, dropped
	// or negatively scored.
	Protect(id peer.ID, tag string)
	// Unprotect removes a peer from the list of peers who have a bidirectional
	// peering agreement that they are protected from being trimmed, dropped
	// or negatively scored, returning a bool representing whether the given
	// peer is protected or not.
	Unprotect(id peer.ID, tag string) bool
	// IsProtected returns whether the given peer is protected.
	IsProtected(id peer.ID, tag string) bool

	// BandwidthStats returns a Stats struct with bandwidth metrics for all
	// data sent/received by the local peer, regardless of protocol or remote
	// peer IDs.
	BandwidthStats() metrics.Stats
	// BandwidthForPeer returns a Stats struct with bandwidth metrics associated with the given peer.ID.
	// The metrics returned include all traffic sent / received for the peer, regardless of protocol.
	BandwidthForPeer(id peer.ID) metrics.Stats
	// BandwidthForProtocol returns a Stats struct with bandwidth metrics associated with the given protocol.ID.
	BandwidthForProtocol(proto protocol.ID) metrics.Stats

	// ResourceState returns the state of the resource manager.
	ResourceState() (rcmgr.ResourceManagerStat, error)

	// PubSubPeers returns the peer IDs of the peers joined on
	// the given topic.
	PubSubPeers(topic string) []peer.ID
}

type Network string