aboutsummaryrefslogtreecommitdiffstats
path: root/les/commons.go
blob: ad3c5aef3d750f784d3242b242c4480158e179be (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
// Copyright 2018 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package les

import (
    "fmt"
    "math/big"
    "sync"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/rawdb"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/eth"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/light"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/discv5"
    "github.com/ethereum/go-ethereum/p2p/enode"
    "github.com/ethereum/go-ethereum/params"
)

func errResp(code errCode, format string, v ...interface{}) error {
    return fmt.Errorf("%v - %v", code, fmt.Sprintf(format, v...))
}

func lesTopic(genesisHash common.Hash, protocolVersion uint) discv5.Topic {
    var name string
    switch protocolVersion {
    case lpv2:
        name = "LES2"
    default:
        panic(nil)
    }
    return discv5.Topic(name + "@" + common.Bytes2Hex(genesisHash.Bytes()[0:8]))
}

type chainReader interface {
    CurrentHeader() *types.Header
}

// lesCommons contains fields needed by both server and client.
type lesCommons struct {
    genesis                      common.Hash
    config                       *eth.Config
    chainConfig                  *params.ChainConfig
    iConfig                      *light.IndexerConfig
    chainDb                      ethdb.Database
    peers                        *peerSet
    chainReader                  chainReader
    chtIndexer, bloomTrieIndexer *core.ChainIndexer
    oracle                       *checkpointOracle

    closeCh chan struct{}
    wg      sync.WaitGroup
}

// NodeInfo represents a short summary of the Ethereum sub-protocol metadata
// known about the host peer.
type NodeInfo struct {
    Network    uint64                   `json:"network"`    // Ethereum network ID (1=Frontier, 2=Morden, Ropsten=3, Rinkeby=4)
    Difficulty *big.Int                 `json:"difficulty"` // Total difficulty of the host's blockchain
    Genesis    common.Hash              `json:"genesis"`    // SHA3 hash of the host's genesis block
    Config     *params.ChainConfig      `json:"config"`     // Chain configuration for the fork rules
    Head       common.Hash              `json:"head"`       // SHA3 hash of the host's best owned block
    CHT        params.TrustedCheckpoint `json:"cht"`        // Trused CHT checkpoint for fast catchup
}

// makeProtocols creates protocol descriptors for the given LES versions.
func (c *lesCommons) makeProtocols(versions []uint, runPeer func(version uint, p *p2p.Peer, rw p2p.MsgReadWriter) error, peerInfo func(id enode.ID) interface{}) []p2p.Protocol {
    protos := make([]p2p.Protocol, len(versions))
    for i, version := range versions {
        version := version
        protos[i] = p2p.Protocol{
            Name:     "les",
            Version:  version,
            Length:   ProtocolLengths[version],
            NodeInfo: c.nodeInfo,
            Run: func(peer *p2p.Peer, rw p2p.MsgReadWriter) error {
                return runPeer(version, peer, rw)
            },
            PeerInfo: peerInfo,
        }
    }
    return protos
}

// nodeInfo retrieves some protocol metadata about the running host node.
func (c *lesCommons) nodeInfo() interface{} {
    head := c.chainReader.CurrentHeader()
    hash := head.Hash()
    return &NodeInfo{
        Network:    c.config.NetworkId,
        Difficulty: rawdb.ReadTd(c.chainDb, hash, head.Number.Uint64()),
        Genesis:    c.genesis,
        Config:     c.chainConfig,
        Head:       hash,
        CHT:        c.latestLocalCheckpoint(),
    }
}

// latestLocalCheckpoint finds the common stored section index and returns a set
// of post-processed trie roots (CHT and BloomTrie) associated with the appropriate
// section index and head hash as a local checkpoint package.
func (c *lesCommons) latestLocalCheckpoint() params.TrustedCheckpoint {
    sections, _, _ := c.chtIndexer.Sections()
    sections2, _, _ := c.bloomTrieIndexer.Sections()
    // Cap the section index if the two sections are not consistent.
    if sections > sections2 {
        sections = sections2
    }
    if sections == 0 {
        // No checkpoint information can be provided.
        return params.TrustedCheckpoint{}
    }
    return c.localCheckpoint(sections - 1)
}

// localCheckpoint returns a set of post-processed trie roots (CHT and BloomTrie)
// associated with the appropriate head hash by specific section index.
//
// The returned checkpoint is only the checkpoint generated by the local indexers,
// not the stable checkpoint registered in the registrar contract.
func (c *lesCommons) localCheckpoint(index uint64) params.TrustedCheckpoint {
    sectionHead := c.chtIndexer.SectionHead(index)
    return params.TrustedCheckpoint{
        SectionIndex: index,
        SectionHead:  sectionHead,
        CHTRoot:      light.GetChtRoot(c.chainDb, index, sectionHead),
        BloomRoot:    light.GetBloomTrieRoot(c.chainDb, index, sectionHead),
    }
}