peers

type ConnManager interface {
	// TagBestPeers tags the best n peers from the given list, based on subnets distribution scores.
	TagBestPeers(logger *zap.Logger, n int, mySubnets records.Subnets, allPeers []peer.ID, topicMaxPeers int)
	// TrimPeers will trim unprotected peers.
	TrimPeers(ctx context.Context, logger *zap.Logger, net libp2pnetwork.Network)
}

type ConnectionIndex interface {
	// Connectedness returns the connection state of the given peer
	Connectedness(id peer.ID) libp2pnetwork.Connectedness

	// CanConnect returns whether we can connect to the given peer,
	// by checking if it is already connected or if we tried to connect to it recently and failed
	CanConnect(id peer.ID) bool

	// AtLimit checks if the node has reached peers limit
	AtLimit(dir libp2pnetwork.Direction) bool

	// IsBad returns whether the given peer is bad
	IsBad(logger *zap.Logger, id peer.ID) bool
}

type Index interface {
	ConnectionIndex
	NodeInfoIndex
	PeerInfoIndex
	ScoreIndex
	SubnetsIndex
	io.Closer
}

type MaxPeersProvider func(topic string) int

type NetworkKeyProvider func() libp2pcrypto.PrivKey

type NodeInfoIndex interface {
	// SelfSealed returns a sealed, encoded of self node info
	SelfSealed(sender, recipient peer.ID, permissioned bool, operatorSigner keys.OperatorSigner) ([]byte, error)

	// Self returns the current node info
	Self() *records.NodeInfo

	// UpdateSelfRecord updating current self with new one
	UpdateSelfRecord(newInfo *records.NodeInfo)

	// SetNodeInfo updates the given peer with the NodeInfo.
	SetNodeInfo(id peer.ID, node *records.NodeInfo)

	// NodeInfo returns the NodeInfo of the given peers, or nil if not found.
	NodeInfo(id peer.ID) *records.NodeInfo
}

type NodeScore struct {
	Name  string
	Value float64
}

type PeerInfo struct {
	ID                 peer.ID
	State              PeerState
	Address            ma.Multiaddr
	Direction          network.Direction
	NodeInfo           *records.NodeInfo
	LastHandshake      time.Time
	LastHandshakeError error
}

type PeerInfoIndex interface {
	// PeerInfo returns the PeerInfo of the given peer, or nil if not found.
	PeerInfo(peer.ID) *PeerInfo

	// AddPeerInfo adds/updates the record for the given peer.
	AddPeerInfo(id peer.ID, address ma.Multiaddr, direction network.Direction)

	// UpdatePeerInfo calls the given function to update the PeerInfo of the given peer.
	UpdatePeerInfo(id peer.ID, update func(*PeerInfo))

	// State returns the state of the peer.
	State(id peer.ID) PeerState

	// SetState sets the state of the peer.
	SetState(id peer.ID, state PeerState)
}

type PeerScore float64

type PeerState int32

type ScoreIndex interface {
	// Score adds score to the given peer
	Score(id peer.ID, scores ...*NodeScore) error
	// GetScore returns the desired score for the given peer
	GetScore(id peer.ID, names ...string) ([]NodeScore, error)
}

type SubnetsIndex interface {
	// UpdatePeerSubnets updates the given peer's subnets
	UpdatePeerSubnets(id peer.ID, s records.Subnets) bool

	// GetSubnetPeers returns peers that are interested in the given subnet
	GetSubnetPeers(s int) []peer.ID

	// GetPeerSubnets returns subnets of the given peer
	GetPeerSubnets(id peer.ID) records.Subnets

	// GetSubnetsStats collects and returns subnets stats
	GetSubnetsStats() *SubnetsStats
}

type SubnetsStats struct {
	AvgConnected int
	PeersCount   []int
	Connected    []int
}