github.com/jimmyx0x/go-ethereum@v1.10.28/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  	"math/big"
    21  
    22  	"github.com/ethereum/go-ethereum/eth/protocols/eth"
    23  	"github.com/ethereum/go-ethereum/eth/protocols/snap"
    24  )
    25  
    26  // ethPeerInfo represents a short summary of the `eth` sub-protocol metadata known
    27  // about a connected peer.
    28  type ethPeerInfo struct {
    29  	Version    uint     `json:"version"`    // Ethereum protocol version negotiated
    30  	Difficulty *big.Int `json:"difficulty"` // Total difficulty of the peer's blockchain
    31  	Head       string   `json:"head"`       // Hex hash of the peer's best owned block
    32  }
    33  
    34  // ethPeer is a wrapper around eth.Peer to maintain a few extra metadata.
    35  type ethPeer struct {
    36  	*eth.Peer
    37  	snapExt *snapPeer // Satellite `snap` connection
    38  }
    39  
    40  // info gathers and returns some `eth` protocol metadata known about a peer.
    41  func (p *ethPeer) info() *ethPeerInfo {
    42  	hash, td := p.Head()
    43  
    44  	return &ethPeerInfo{
    45  		Version:    p.Version(),
    46  		Difficulty: td,
    47  		Head:       hash.Hex(),
    48  	}
    49  }
    50  
    51  // snapPeerInfo represents a short summary of the `snap` sub-protocol metadata known
    52  // about a connected peer.
    53  type snapPeerInfo struct {
    54  	Version uint `json:"version"` // Snapshot protocol version negotiated
    55  }
    56  
    57  // snapPeer is a wrapper around snap.Peer to maintain a few extra metadata.
    58  type snapPeer struct {
    59  	*snap.Peer
    60  }
    61  
    62  // info gathers and returns some `snap` protocol metadata known about a peer.
    63  func (p *snapPeer) info() *snapPeerInfo {
    64  	return &snapPeerInfo{
    65  		Version: p.Version(),
    66  	}
    67  }