ca376ead88
This PR implements the new LES protocol version extensions: * new and more efficient Merkle proofs reply format (when replying to a multiple Merkle proofs request, we just send a single set of trie nodes containing all necessary nodes) * BBT (BloomBitsTrie) works similarly to the existing CHT and contains the bloombits search data to speed up log searches * GetTxStatusMsg returns the inclusion position or the pending/queued/unknown state of a transaction referenced by hash * an optional signature of new block data (number/hash/td) can be included in AnnounceMsg to provide an option for "very light clients" (mobile/embedded devices) to skip expensive Ethash check and accept multiple signatures of somewhat trusted servers (still a lot better than trusting a single server completely and retrieving everything through RPC). The new client mode is not implemented in this PR, just the protocol extension.
257 lines
8.7 KiB
Go
257 lines
8.7 KiB
Go
// 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 implements the Light Ethereum Subprotocol.
|
|
package les
|
|
|
|
import (
|
|
"fmt"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/accounts"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/consensus"
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/core/bloombits"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/eth"
|
|
"github.com/ethereum/go-ethereum/eth/downloader"
|
|
"github.com/ethereum/go-ethereum/eth/filters"
|
|
"github.com/ethereum/go-ethereum/eth/gasprice"
|
|
"github.com/ethereum/go-ethereum/ethdb"
|
|
"github.com/ethereum/go-ethereum/event"
|
|
"github.com/ethereum/go-ethereum/internal/ethapi"
|
|
"github.com/ethereum/go-ethereum/light"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/p2p"
|
|
"github.com/ethereum/go-ethereum/p2p/discv5"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
rpc "github.com/ethereum/go-ethereum/rpc"
|
|
)
|
|
|
|
type LightEthereum struct {
|
|
odr *LesOdr
|
|
relay *LesTxRelay
|
|
chainConfig *params.ChainConfig
|
|
// Channel for shutting down the service
|
|
shutdownChan chan bool
|
|
// Handlers
|
|
peers *peerSet
|
|
txPool *light.TxPool
|
|
blockchain *light.LightChain
|
|
protocolManager *ProtocolManager
|
|
serverPool *serverPool
|
|
reqDist *requestDistributor
|
|
retriever *retrieveManager
|
|
// DB interfaces
|
|
chainDb ethdb.Database // Block chain database
|
|
|
|
bloomRequests chan chan *bloombits.Retrieval // Channel receiving bloom data retrieval requests
|
|
bloomIndexer, chtIndexer, bloomTrieIndexer *core.ChainIndexer
|
|
|
|
ApiBackend *LesApiBackend
|
|
|
|
eventMux *event.TypeMux
|
|
engine consensus.Engine
|
|
accountManager *accounts.Manager
|
|
|
|
networkId uint64
|
|
netRPCService *ethapi.PublicNetAPI
|
|
|
|
wg sync.WaitGroup
|
|
}
|
|
|
|
func New(ctx *node.ServiceContext, config *eth.Config) (*LightEthereum, error) {
|
|
chainDb, err := eth.CreateDB(ctx, config, "lightchaindata")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
chainConfig, genesisHash, genesisErr := core.SetupGenesisBlock(chainDb, config.Genesis)
|
|
if _, isCompat := genesisErr.(*params.ConfigCompatError); genesisErr != nil && !isCompat {
|
|
return nil, genesisErr
|
|
}
|
|
log.Info("Initialised chain configuration", "config", chainConfig)
|
|
|
|
peers := newPeerSet()
|
|
quitSync := make(chan struct{})
|
|
|
|
leth := &LightEthereum{
|
|
chainConfig: chainConfig,
|
|
chainDb: chainDb,
|
|
eventMux: ctx.EventMux,
|
|
peers: peers,
|
|
reqDist: newRequestDistributor(peers, quitSync),
|
|
accountManager: ctx.AccountManager,
|
|
engine: eth.CreateConsensusEngine(ctx, config, chainConfig, chainDb),
|
|
shutdownChan: make(chan bool),
|
|
networkId: config.NetworkId,
|
|
bloomRequests: make(chan chan *bloombits.Retrieval),
|
|
bloomIndexer: eth.NewBloomIndexer(chainDb, light.BloomTrieFrequency),
|
|
chtIndexer: light.NewChtIndexer(chainDb, true),
|
|
bloomTrieIndexer: light.NewBloomTrieIndexer(chainDb, true),
|
|
}
|
|
|
|
leth.relay = NewLesTxRelay(peers, leth.reqDist)
|
|
leth.serverPool = newServerPool(chainDb, quitSync, &leth.wg)
|
|
leth.retriever = newRetrieveManager(peers, leth.reqDist, leth.serverPool)
|
|
leth.odr = NewLesOdr(chainDb, leth.chtIndexer, leth.bloomTrieIndexer, leth.bloomIndexer, leth.retriever)
|
|
if leth.blockchain, err = light.NewLightChain(leth.odr, leth.chainConfig, leth.engine); err != nil {
|
|
return nil, err
|
|
}
|
|
leth.bloomIndexer.Start(leth.blockchain)
|
|
// Rewind the chain in case of an incompatible config upgrade.
|
|
if compat, ok := genesisErr.(*params.ConfigCompatError); ok {
|
|
log.Warn("Rewinding chain to upgrade configuration", "err", compat)
|
|
leth.blockchain.SetHead(compat.RewindTo)
|
|
core.WriteChainConfig(chainDb, genesisHash, chainConfig)
|
|
}
|
|
|
|
leth.txPool = light.NewTxPool(leth.chainConfig, leth.blockchain, leth.relay)
|
|
if leth.protocolManager, err = NewProtocolManager(leth.chainConfig, true, ClientProtocolVersions, config.NetworkId, leth.eventMux, leth.engine, leth.peers, leth.blockchain, nil, chainDb, leth.odr, leth.relay, quitSync, &leth.wg); err != nil {
|
|
return nil, err
|
|
}
|
|
leth.ApiBackend = &LesApiBackend{leth, nil}
|
|
gpoParams := config.GPO
|
|
if gpoParams.Default == nil {
|
|
gpoParams.Default = config.GasPrice
|
|
}
|
|
leth.ApiBackend.gpo = gasprice.NewOracle(leth.ApiBackend, gpoParams)
|
|
return leth, nil
|
|
}
|
|
|
|
func lesTopic(genesisHash common.Hash, protocolVersion uint) discv5.Topic {
|
|
var name string
|
|
switch protocolVersion {
|
|
case lpv1:
|
|
name = "LES"
|
|
case lpv2:
|
|
name = "LES2"
|
|
default:
|
|
panic(nil)
|
|
}
|
|
return discv5.Topic(name + common.Bytes2Hex(genesisHash.Bytes()[0:8]))
|
|
}
|
|
|
|
type LightDummyAPI struct{}
|
|
|
|
// Etherbase is the address that mining rewards will be send to
|
|
func (s *LightDummyAPI) Etherbase() (common.Address, error) {
|
|
return common.Address{}, fmt.Errorf("not supported")
|
|
}
|
|
|
|
// Coinbase is the address that mining rewards will be send to (alias for Etherbase)
|
|
func (s *LightDummyAPI) Coinbase() (common.Address, error) {
|
|
return common.Address{}, fmt.Errorf("not supported")
|
|
}
|
|
|
|
// Hashrate returns the POW hashrate
|
|
func (s *LightDummyAPI) Hashrate() hexutil.Uint {
|
|
return 0
|
|
}
|
|
|
|
// Mining returns an indication if this node is currently mining.
|
|
func (s *LightDummyAPI) Mining() bool {
|
|
return false
|
|
}
|
|
|
|
// APIs returns the collection of RPC services the ethereum package offers.
|
|
// NOTE, some of these services probably need to be moved to somewhere else.
|
|
func (s *LightEthereum) APIs() []rpc.API {
|
|
return append(ethapi.GetAPIs(s.ApiBackend), []rpc.API{
|
|
{
|
|
Namespace: "eth",
|
|
Version: "1.0",
|
|
Service: &LightDummyAPI{},
|
|
Public: true,
|
|
}, {
|
|
Namespace: "eth",
|
|
Version: "1.0",
|
|
Service: downloader.NewPublicDownloaderAPI(s.protocolManager.downloader, s.eventMux),
|
|
Public: true,
|
|
}, {
|
|
Namespace: "eth",
|
|
Version: "1.0",
|
|
Service: filters.NewPublicFilterAPI(s.ApiBackend, true),
|
|
Public: true,
|
|
}, {
|
|
Namespace: "net",
|
|
Version: "1.0",
|
|
Service: s.netRPCService,
|
|
Public: true,
|
|
},
|
|
}...)
|
|
}
|
|
|
|
func (s *LightEthereum) ResetWithGenesisBlock(gb *types.Block) {
|
|
s.blockchain.ResetWithGenesisBlock(gb)
|
|
}
|
|
|
|
func (s *LightEthereum) BlockChain() *light.LightChain { return s.blockchain }
|
|
func (s *LightEthereum) TxPool() *light.TxPool { return s.txPool }
|
|
func (s *LightEthereum) Engine() consensus.Engine { return s.engine }
|
|
func (s *LightEthereum) LesVersion() int { return int(s.protocolManager.SubProtocols[0].Version) }
|
|
func (s *LightEthereum) Downloader() *downloader.Downloader { return s.protocolManager.downloader }
|
|
func (s *LightEthereum) EventMux() *event.TypeMux { return s.eventMux }
|
|
|
|
// Protocols implements node.Service, returning all the currently configured
|
|
// network protocols to start.
|
|
func (s *LightEthereum) Protocols() []p2p.Protocol {
|
|
return s.protocolManager.SubProtocols
|
|
}
|
|
|
|
// Start implements node.Service, starting all internal goroutines needed by the
|
|
// Ethereum protocol implementation.
|
|
func (s *LightEthereum) Start(srvr *p2p.Server) error {
|
|
s.startBloomHandlers()
|
|
log.Warn("Light client mode is an experimental feature")
|
|
s.netRPCService = ethapi.NewPublicNetAPI(srvr, s.networkId)
|
|
// search the topic belonging to the oldest supported protocol because
|
|
// servers always advertise all supported protocols
|
|
protocolVersion := ClientProtocolVersions[len(ClientProtocolVersions)-1]
|
|
s.serverPool.start(srvr, lesTopic(s.blockchain.Genesis().Hash(), protocolVersion))
|
|
s.protocolManager.Start()
|
|
return nil
|
|
}
|
|
|
|
// Stop implements node.Service, terminating all internal goroutines used by the
|
|
// Ethereum protocol.
|
|
func (s *LightEthereum) Stop() error {
|
|
s.odr.Stop()
|
|
if s.bloomIndexer != nil {
|
|
s.bloomIndexer.Close()
|
|
}
|
|
if s.chtIndexer != nil {
|
|
s.chtIndexer.Close()
|
|
}
|
|
if s.bloomTrieIndexer != nil {
|
|
s.bloomTrieIndexer.Close()
|
|
}
|
|
s.blockchain.Stop()
|
|
s.protocolManager.Stop()
|
|
s.txPool.Stop()
|
|
|
|
s.eventMux.Stop()
|
|
|
|
time.Sleep(time.Millisecond * 200)
|
|
s.chainDb.Close()
|
|
close(s.shutdownChan)
|
|
|
|
return nil
|
|
}
|