github.com/frankli-dev/go-ethereum@v1.1.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  	"math/big"
    21  	"sync"
    22  	"time"
    23  
    24  	"github.com/frankli-dev/go-ethereum/eth/protocols/eth"
    25  	"github.com/frankli-dev/go-ethereum/eth/protocols/snap"
    26  )
    27  
    28  // ethPeerInfo represents a short summary of the `eth` sub-protocol metadata known
    29  // about a connected peer.
    30  type ethPeerInfo struct {
    31  	Version    uint     `json:"version"`    // Ethereum protocol version negotiated
    32  	Difficulty *big.Int `json:"difficulty"` // Total difficulty of the peer's blockchain
    33  	Head       string   `json:"head"`       // Hex hash of the peer's best owned block
    34  }
    35  
    36  // ethPeer is a wrapper around eth.Peer to maintain a few extra metadata.
    37  type ethPeer struct {
    38  	*eth.Peer
    39  	snapExt *snapPeer // Satellite `snap` connection
    40  
    41  	syncDrop *time.Timer   // Connection dropper if `eth` sync progress isn't validated in time
    42  	snapWait chan struct{} // Notification channel for snap connections
    43  	lock     sync.RWMutex  // Mutex protecting the internal fields
    44  }
    45  
    46  // info gathers and returns some `eth` protocol metadata known about a peer.
    47  func (p *ethPeer) info() *ethPeerInfo {
    48  	hash, td := p.Head()
    49  
    50  	return &ethPeerInfo{
    51  		Version:    p.Version(),
    52  		Difficulty: td,
    53  		Head:       hash.Hex(),
    54  	}
    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  }