github.com/lukso-network/go-ethereum@v1.8.22/les/commons.go (about)

     1  // Copyright 2018 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 les
    18  
    19  import (
    20  	"fmt"
    21  	"math/big"
    22  
    23  	"github.com/ethereum/go-ethereum/common"
    24  	"github.com/ethereum/go-ethereum/core"
    25  	"github.com/ethereum/go-ethereum/eth"
    26  	"github.com/ethereum/go-ethereum/ethdb"
    27  	"github.com/ethereum/go-ethereum/light"
    28  	"github.com/ethereum/go-ethereum/p2p"
    29  	"github.com/ethereum/go-ethereum/p2p/enode"
    30  	"github.com/ethereum/go-ethereum/params"
    31  )
    32  
    33  // lesCommons contains fields needed by both server and client.
    34  type lesCommons struct {
    35  	config                       *eth.Config
    36  	iConfig                      *light.IndexerConfig
    37  	chainDb                      ethdb.Database
    38  	protocolManager              *ProtocolManager
    39  	chtIndexer, bloomTrieIndexer *core.ChainIndexer
    40  }
    41  
    42  // NodeInfo represents a short summary of the Ethereum sub-protocol metadata
    43  // known about the host peer.
    44  type NodeInfo struct {
    45  	Network    uint64                   `json:"network"`    // Ethereum network ID (1=Frontier, 2=Morden, Ropsten=3, Rinkeby=4)
    46  	Difficulty *big.Int                 `json:"difficulty"` // Total difficulty of the host's blockchain
    47  	Genesis    common.Hash              `json:"genesis"`    // SHA3 hash of the host's genesis block
    48  	Config     *params.ChainConfig      `json:"config"`     // Chain configuration for the fork rules
    49  	Head       common.Hash              `json:"head"`       // SHA3 hash of the host's best owned block
    50  	CHT        params.TrustedCheckpoint `json:"cht"`        // Trused CHT checkpoint for fast catchup
    51  }
    52  
    53  // makeProtocols creates protocol descriptors for the given LES versions.
    54  func (c *lesCommons) makeProtocols(versions []uint) []p2p.Protocol {
    55  	protos := make([]p2p.Protocol, len(versions))
    56  	for i, version := range versions {
    57  		version := version
    58  		protos[i] = p2p.Protocol{
    59  			Name:     "les",
    60  			Version:  version,
    61  			Length:   ProtocolLengths[version],
    62  			NodeInfo: c.nodeInfo,
    63  			Run: func(p *p2p.Peer, rw p2p.MsgReadWriter) error {
    64  				return c.protocolManager.runPeer(version, p, rw)
    65  			},
    66  			PeerInfo: func(id enode.ID) interface{} {
    67  				if p := c.protocolManager.peers.Peer(fmt.Sprintf("%x", id[:8])); p != nil {
    68  					return p.Info()
    69  				}
    70  				return nil
    71  			},
    72  		}
    73  	}
    74  	return protos
    75  }
    76  
    77  // nodeInfo retrieves some protocol metadata about the running host node.
    78  func (c *lesCommons) nodeInfo() interface{} {
    79  	var cht params.TrustedCheckpoint
    80  	sections, _, _ := c.chtIndexer.Sections()
    81  	sections2, _, _ := c.bloomTrieIndexer.Sections()
    82  
    83  	if !c.protocolManager.lightSync {
    84  		// convert to client section size if running in server mode
    85  		sections /= c.iConfig.PairChtSize / c.iConfig.ChtSize
    86  	}
    87  
    88  	if sections2 < sections {
    89  		sections = sections2
    90  	}
    91  	if sections > 0 {
    92  		sectionIndex := sections - 1
    93  		sectionHead := c.bloomTrieIndexer.SectionHead(sectionIndex)
    94  		var chtRoot common.Hash
    95  		if c.protocolManager.lightSync {
    96  			chtRoot = light.GetChtRoot(c.chainDb, sectionIndex, sectionHead)
    97  		} else {
    98  			idxV2 := (sectionIndex+1)*c.iConfig.PairChtSize/c.iConfig.ChtSize - 1
    99  			chtRoot = light.GetChtRoot(c.chainDb, idxV2, sectionHead)
   100  		}
   101  		cht = params.TrustedCheckpoint{
   102  			SectionIndex: sectionIndex,
   103  			SectionHead:  sectionHead,
   104  			CHTRoot:      chtRoot,
   105  			BloomRoot:    light.GetBloomTrieRoot(c.chainDb, sectionIndex, sectionHead),
   106  		}
   107  	}
   108  
   109  	chain := c.protocolManager.blockchain
   110  	head := chain.CurrentHeader()
   111  	hash := head.Hash()
   112  	return &NodeInfo{
   113  		Network:    c.config.NetworkId,
   114  		Difficulty: chain.GetTd(hash, head.Number.Uint64()),
   115  		Genesis:    chain.Genesis().Hash(),
   116  		Config:     chain.Config(),
   117  		Head:       chain.CurrentHeader().Hash(),
   118  		CHT:        cht,
   119  	}
   120  }