p2p

type Cap struct {
	Name    string
	Version uint
}

type Config struct {
	// 该字段必须设置为有效的secp256k1私钥。
	PrivateKey *ecdsa.PrivateKey `toml:"-"`

	// MaxPeers是可以连接的最大对等数。它必须大于零。
	MaxPeers int

	// MaxPendingPeers是在握手阶段可以挂起的最大对等点数，对于入站和出站连接分别计算。零默认为预设值。
	MaxPendingPeers int `toml:",omitempty"`

	// DialRatio控制入站连接与已拨连接的比率。
	//示例：2的拨号率允许拨打1/2的连接。将DialRatio设置为零默认为3。
	DialRatio int `toml:",omitempty"`

	// 节点发现可用于禁用对等发现机制。禁用对协议调试（手动拓扑）很有用。
	NoDiscovery bool

	// DiscoveryV5指定是否应启动基于新主题发现的V5发现协议。
	DiscoveryV5 bool `toml:",omitempty"`

	// 名称设置此服务器的节点名称。使用common。MakeName以创建符合现有约定的名称。
	Name string `toml:"-"`

	// 引导节点用于建立与网络其余部分的连接。
	BootstrapNodes []*enode.Node

	// BootstrapNodesV5用于使用V5发现协议建立与网络其余部分的连接。
	BootstrapNodesV5 []*enode.Node `toml:",omitempty"`

	// 静态节点用作预先配置的连接，在断开连接时始终保持并重新连接。
	StaticNodes []*enode.Node

	// 受信任节点用作预先配置的连接，始终允许连接，甚至超过对等限制。
	TrustedNodes []*enode.Node

	// 连接可以限制在某些IP网络上。如果此选项设置为非nil值，则只考虑与列表中包含的一个IP网络匹配的主机。
	NetRestrict *netutil.Netlist `toml:",omitempty"`

	// NodeDatabase是指向数据库的路径，其中包含以前在网络中看到的活动节点。
	NodeDatabase string `toml:",omitempty"`

	// 协议应包含服务器支持的协议。为每个对等点启动匹配协议。
	Protocols []Protocol `toml:"-" json:"-"`

	// 如果ListenAddr设置为非nil地址，服务器将侦听传入的连接。
	//如果端口为零，操作系统将选择一个端口。当服务器启动时，ListenAddr字段将用实际地址更新。
	ListenAddr string

	// 如果discadr设置为非nil值，则服务器将使用ListenAddr作为TCP，使用discadr作为UDP发现协议。
	DiscAddr string

	// 如果设置为非零值，则使用给定的NAT端口映射器使侦听端口可用于Internet。
	NAT nat.Interface `toml:",omitempty"`

	// 如果拨号器设置为非零值，则给定的拨号器用于拨号出站对等连接。
	Dialer NodeDialer `toml:"-"`

	// 如果NoDial为true，服务器将不会拨打任何对等方。
	NoDial bool `toml:",omitempty"`

	// 如果设置了EnableMsgEvents，那么每当向对等方发送消息或从对等方接收消息时，服务器将发出对等事件
	EnableMsgEvents bool

	// Logger是一个用于p2p的自定义记录器。服务器
	Logger log.Logger `toml:",omitempty"`
	// contains filtered or unexported fields
}

type DiscReason uint8

type Msg struct {
	Code       uint64
	Size       uint32 // 原始有效负载的大小
	Payload    io.Reader
	ReceivedAt time.Time
	// contains filtered or unexported fields
}

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

type MsgReadWriter interface {
	MsgReader
	MsgWriter
}

type MsgReader interface {
	ReadMsg() (Msg, error)
}

type MsgWriter interface {
	// WriteMsg发送消息。它将阻塞，直到消息的有效负载被另一端消耗。
	//请注意，消息只能发送一次，因为它们的有效负载读取器已耗尽。
	WriteMsg(Msg) error
}

type NodeDialer interface {
	Dial(context.Context, *enode.Node) (net.Conn, error)
}

type NodeInfo struct {
	ID    string `json:"id"`    // 唯一节点标识符（也是加密密钥）
	Name  string `json:"name"`  // 节点的名称，包括客户端类型、版本、操作系统、自定义数据
	Enode string `json:"enode"` // 用于从远程对等添加此对等的Enode URL
	ONR   string `json:"enr"`   // 辐射章鱼节点记录
	IP    string `json:"ip"`    // 节点的IP地址
	Ports struct {
		Discovery int `json:"discovery"` // 发现协议的UDP侦听端口
		Listener  int `json:"listener"`  // RLPx的TCP侦听端口
	} `json:"ports"`
	ListenAddr string                 `json:"listenAddr"`
	Protocols  map[string]interface{} `json:"protocols"`
}

type P2PStart struct {
}

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

type PeerEvent struct {
	Type          PeerEventType `json:"type"`
	Peer          enode.ID      `json:"peer"`
	Error         string        `json:"error,omitempty"`
	Protocol      string        `json:"protocol,omitempty"`
	MsgCode       *uint64       `json:"msg_code,omitempty"`
	MsgSize       *uint32       `json:"msg_size,omitempty"`
	LocalAddress  string        `json:"local,omitempty"`
	RemoteAddress string        `json:"remote,omitempty"`
}

type PeerEventType string

type PeerInfo struct {
	ENR     string   `json:"enr,omitempty"` // 以太坊节点记录
	Enode   string   `json:"enode"`         // 节点URL
	ID      string   `json:"id"`            // 唯一节点标识符
	Name    string   `json:"name"`          // 节点的名称，包括客户端类型、版本、操作系统、自定义数据
	Caps    []string `json:"caps"`          // 此对等方公布的协议
	Network struct {
		LocalAddress  string `json:"localAddress"`  // TCP数据连接的本地端点
		RemoteAddress string `json:"remoteAddress"` // TCP数据连接的远程端点
		Inbound       bool   `json:"inbound"`
		Trusted       bool   `json:"trusted"`
		Static        bool   `json:"static"`
	} `json:"network"`
	Protocols map[string]interface{} `json:"protocols"` // 子协议特定元数据字段
}

type Protocol struct {
	// 名称应包含正式协议名称，通常为三个字母的单词。
	Name string

	// 版本应包含协议的版本号。
	Version uint

	// 长度应包含协议使用的消息代码数。
	Length uint64

	// 当与对等方协商协议时，在新的goroutine中调用Run。
	//它应该读写来自rw的消息。必须完全消耗每条消息的有效负载。
	//当Start返回时，对等连接关闭。它应该返回遇到的任何协议级错误（例如输入/输出错误）。
	Run func(peer *Peer, rw MsgReadWriter) error

	// NodeInfo是一种可选的辅助方法，用于检索有关主机节点的协议特定元数据。
	NodeInfo func() interface{}

	//PeerInfo是一种可选的辅助方法，用于检索网络中特定对等方的协议特定元数据。
	//如果设置了信息检索函数，但返回nil，则假设协议握手仍在运行。
	PeerInfo func(id enode.ID) interface{}

	// DialCandidates（若非nil）是一种告诉服务器应该拨打的协议特定节点的方法。
	//服务器不断地从迭代器中读取节点，并尝试创建到这些节点的连接。
	DialCandidates enode.Iterator

	// 属性包含节点记录的协议特定信息。
	Attributes []enr.Entry
}

type Server struct {
	// 服务器运行时，不能修改配置字段。
	Config

	DiscV5 *discover.UDPv5
	// contains filtered or unexported fields
}