aboutsummaryrefslogtreecommitdiffstats
path: root/les/odr.go
blob: daf2ea19ed45d57be205186a33f4a41e428ee81d (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
// Copyright 2016 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 (
    "context"

    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/light"
    "github.com/ethereum/go-ethereum/log"
)

// LesOdr implements light.OdrBackend
type LesOdr struct {
    db                                         ethdb.Database
    indexerConfig                              *light.IndexerConfig
    chtIndexer, bloomTrieIndexer, bloomIndexer *core.ChainIndexer
    retriever                                  *retrieveManager
    stop                                       chan struct{}
}

func NewLesOdr(db ethdb.Database, config *light.IndexerConfig, retriever *retrieveManager) *LesOdr {
    return &LesOdr{
        db:            db,
        indexerConfig: config,
        retriever:     retriever,
        stop:          make(chan struct{}),
    }
}

// Stop cancels all pending retrievals
func (odr *LesOdr) Stop() {
    close(odr.stop)
}

// Database returns the backing database
func (odr *LesOdr) Database() ethdb.Database {
    return odr.db
}

// SetIndexers adds the necessary chain indexers to the ODR backend
func (odr *LesOdr) SetIndexers(chtIndexer, bloomTrieIndexer, bloomIndexer *core.ChainIndexer) {
    odr.chtIndexer = chtIndexer
    odr.bloomTrieIndexer = bloomTrieIndexer
    odr.bloomIndexer = bloomIndexer
}

// ChtIndexer returns the CHT chain indexer
func (odr *LesOdr) ChtIndexer() *core.ChainIndexer {
    return odr.chtIndexer
}

// BloomTrieIndexer returns the bloom trie chain indexer
func (odr *LesOdr) BloomTrieIndexer() *core.ChainIndexer {
    return odr.bloomTrieIndexer
}

// BloomIndexer returns the bloombits chain indexer
func (odr *LesOdr) BloomIndexer() *core.ChainIndexer {
    return odr.bloomIndexer
}

// IndexerConfig returns the indexer config.
func (odr *LesOdr) IndexerConfig() *light.IndexerConfig {
    return odr.indexerConfig
}

const (
    MsgBlockBodies = iota
    MsgCode
    MsgReceipts
    MsgProofsV2
    MsgHelperTrieProofs
)

// Msg encodes a LES message that delivers reply data for a request
type Msg struct {
    MsgType int
    ReqID   uint64
    Obj     interface{}
}

// Retrieve tries to fetch an object from the LES network.
// If the network retrieval was successful, it stores the object in local db.
func (odr *LesOdr) Retrieve(ctx context.Context, req light.OdrRequest) (err error) {
    lreq := LesRequest(req)

    reqID := genReqID()
    rq := &distReq{
        getCost: func(dp distPeer) uint64 {
            return lreq.GetCost(dp.(*peer))
        },
        canSend: func(dp distPeer) bool {
            p := dp.(*peer)
            if !p.isOnlyAnnounce {
                return lreq.CanSend(p)
            }
            return false
        },
        request: func(dp distPeer) func() {
            p := dp.(*peer)
            cost := lreq.GetCost(p)
            p.fcServer.QueuedRequest(reqID, cost)
            return func() { lreq.Request(reqID, p) }
        },
    }

    if err = odr.retriever.retrieve(ctx, reqID, rq, func(p distPeer, msg *Msg) error { return lreq.Validate(odr.db, msg) }, odr.stop); err == nil {
        // retrieved from network, store in db
        req.StoreResult(odr.db)
    } else {
        log.Debug("Failed to retrieve data from network", "err", err)
    }
    return
}