github.com/ethereum/go-ethereum@v1.16.1/eth/peer.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package eth
    18  
    19  import (
    20  	"github.com/ethereum/go-ethereum/common"
    21  	"github.com/ethereum/go-ethereum/eth/protocols/eth"
    22  	"github.com/ethereum/go-ethereum/eth/protocols/snap"
    23  )
    24  
    25  // ethPeerInfo represents a short summary of the `eth` sub-protocol metadata known
    26  // about a connected peer.
    27  type ethPeerInfo struct {
    28  	Version uint `json:"version"` // Ethereum protocol version negotiated
    29  	*peerBlockRange
    30  }
    31  
    32  type peerBlockRange struct {
    33  	Earliest   uint64      `json:"earliestBlock"`
    34  	Latest     uint64      `json:"latestBlock"`
    35  	LatestHash common.Hash `json:"latestBlockHash"`
    36  }
    37  
    38  // ethPeer is a wrapper around eth.Peer to maintain a few extra metadata.
    39  type ethPeer struct {
    40  	*eth.Peer
    41  	snapExt *snapPeer // Satellite `snap` connection
    42  }
    43  
    44  // info gathers and returns some `eth` protocol metadata known about a peer.
    45  func (p *ethPeer) info() *ethPeerInfo {
    46  	info := &ethPeerInfo{Version: p.Version()}
    47  	if br := p.BlockRange(); br != nil {
    48  		info.peerBlockRange = &peerBlockRange{
    49  			Earliest:   br.EarliestBlock,
    50  			Latest:     br.LatestBlock,
    51  			LatestHash: br.LatestBlockHash,
    52  		}
    53  	}
    54  	return info
    55  }
    56  
    57  // snapPeerInfo represents a short summary of the `snap` sub-protocol metadata known
    58  // about a connected peer.
    59  type snapPeerInfo struct {
    60  	Version uint `json:"version"` // Snapshot protocol version negotiated
    61  }
    62  
    63  // snapPeer is a wrapper around snap.Peer to maintain a few extra metadata.
    64  type snapPeer struct {
    65  	*snap.Peer
    66  }
    67  
    68  // info gathers and returns some `snap` protocol metadata known about a peer.
    69  func (p *snapPeer) info() *snapPeerInfo {
    70  	return &snapPeerInfo{
    71  		Version: p.Version(),
    72  	}
    73  }