aboutsummaryrefslogtreecommitdiffstats
path: root/eth/backend.go
blob: 3d5c4ba09544ae9ecf96f4fece5ded5955f37009 (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
package eth

import (
    "crypto/ecdsa"
    "fmt"
    "io/ioutil"
    "math"
    "path"
    "strings"

    "github.com/ethereum/ethash"
    "github.com/ethereum/go-ethereum/accounts"
    "github.com/ethereum/go-ethereum/blockpool"
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/core/vm"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/eth/downloader"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "github.com/ethereum/go-ethereum/miner"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/discover"
    "github.com/ethereum/go-ethereum/p2p/nat"
    "github.com/ethereum/go-ethereum/whisper"
)

var (
    jsonlogger = logger.NewJsonLogger()

    defaultBootNodes = []*discover.Node{
        // ETH/DEV cmd/bootnode
        discover.MustParseNode("enode://09fbeec0d047e9a37e63f60f8618aa9df0e49271f3fadb2c070dc09e2099b95827b63a8b837c6fd01d0802d457dd83e3bd48bd3e6509f8209ed90dabbc30e3d3@52.16.188.185:30303"),
        // ETH/DEV cpp-ethereum (poc-9.ethdev.com)
        discover.MustParseNode("enode://487611428e6c99a11a9795a6abe7b529e81315ca6aad66e2a2fc76e3adf263faba0d35466c2f8f68d561dbefa8878d4df5f1f2ddb1fbeab7f42ffb8cd328bd4a@5.1.83.226:30303"),
    }
)

type Config struct {
    Name            string
    ProtocolVersion int
    NetworkId       int

    BlockChainVersion  int
    SkipBcVersionCheck bool // e.g. blockchain export

    DataDir  string
    LogFile  string
    LogLevel int
    LogJSON  string
    VmDebug  bool

    MaxPeers int
    Port     string

    // This should be a space-separated list of
    // discovery node URLs.
    BootNodes string

    // This key is used to identify the node on the network.
    // If nil, an ephemeral key is used.
    NodeKey *ecdsa.PrivateKey

    NAT  nat.Interface
    Shh  bool
    Dial bool

    Etherbase      string
    MinerThreads   int
    AccountManager *accounts.Manager

    // NewDB is used to create databases.
    // If nil, the default is to create leveldb databases on disk.
    NewDB func(path string) (common.Database, error)
}

func (cfg *Config) parseBootNodes() []*discover.Node {
    if cfg.BootNodes == "" {
        return defaultBootNodes
    }
    var ns []*discover.Node
    for _, url := range strings.Split(cfg.BootNodes, " ") {
        if url == "" {
            continue
        }
        n, err := discover.ParseNode(url)
        if err != nil {
            glog.V(logger.Error).Infof("Bootstrap URL %s: %v\n", url, err)
            continue
        }
        ns = append(ns, n)
    }
    return ns
}

func (cfg *Config) nodeKey() (*ecdsa.PrivateKey, error) {
    // use explicit key from command line args if set
    if cfg.NodeKey != nil {
        return cfg.NodeKey, nil
    }
    // use persistent key if present
    keyfile := path.Join(cfg.DataDir, "nodekey")
    key, err := crypto.LoadECDSA(keyfile)
    if err == nil {
        return key, nil
    }
    // no persistent key, generate and store a new one
    if key, err = crypto.GenerateKey(); err != nil {
        return nil, fmt.Errorf("could not generate server key: %v", err)
    }
    if err := ioutil.WriteFile(keyfile, crypto.FromECDSA(key), 0600); err != nil {
        glog.V(logger.Error).Infoln("could not persist nodekey: ", err)
    }
    return key, nil
}

type Ethereum struct {
    // Channel for shutting down the ethereum
    shutdownChan chan bool

    // DB interfaces
    blockDb common.Database // Block chain database
    stateDb common.Database // State changes database
    extraDb common.Database // Extra database (txs, etc)

    //*** SERVICES ***
    // State manager for processing new blocks and managing the over all states
    blockProcessor *core.BlockProcessor
    txPool         *core.TxPool
    chainManager   *core.ChainManager
    blockPool      *blockpool.BlockPool
    accountManager *accounts.Manager
    whisper        *whisper.Whisper
    pow            *ethash.Ethash
    downloader     *downloader.Downloader

    net      *p2p.Server
    eventMux *event.TypeMux
    txSub    event.Subscription
    blockSub event.Subscription
    miner    *miner.Miner

    // logger logger.LogSystem

    Mining        bool
    DataDir       string
    etherbase     common.Address
    clientVersion string
    ethVersionId  int
    netVersionId  int
    shhVersionId  int
}

func New(config *Config) (*Ethereum, error) {
    // Bootstrap database
    logger.New(config.DataDir, config.LogFile, config.LogLevel)
    if len(config.LogJSON) > 0 {
        logger.NewJSONsystem(config.DataDir, config.LogJSON)
    }

    newdb := config.NewDB
    if newdb == nil {
        newdb = func(path string) (common.Database, error) { return ethdb.NewLDBDatabase(path) }
    }
    blockDb, err := newdb(path.Join(config.DataDir, "blockchain"))
    if err != nil {
        return nil, err
    }
    stateDb, err := newdb(path.Join(config.DataDir, "state"))
    if err != nil {
        return nil, err
    }
    extraDb, err := ethdb.NewLDBDatabase(path.Join(config.DataDir, "extra"))

    // Perform database sanity checks
    d, _ := blockDb.Get([]byte("ProtocolVersion"))
    protov := int(common.NewValue(d).Uint())
    if protov != config.ProtocolVersion && protov != 0 {
        path := path.Join(config.DataDir, "blockchain")
        return nil, fmt.Errorf("Database version mismatch. Protocol(%d / %d). `rm -rf %s`", protov, config.ProtocolVersion, path)
    }
    saveProtocolVersion(blockDb, config.ProtocolVersion)
    glog.V(logger.Info).Infof("Protocol Version: %v, Network Id: %v", config.ProtocolVersion, config.NetworkId)

    if !config.SkipBcVersionCheck {
        b, _ := blockDb.Get([]byte("BlockchainVersion"))
        bcVersion := int(common.NewValue(b).Uint())
        if bcVersion != config.BlockChainVersion && bcVersion != 0 {
            return nil, fmt.Errorf("Blockchain DB version mismatch (%d / %d). Run geth upgradedb.\n", bcVersion, config.BlockChainVersion)
        }
        saveBlockchainVersion(blockDb, config.BlockChainVersion)
    }
    glog.V(logger.Info).Infof("Blockchain DB Version: %d", config.BlockChainVersion)

    eth := &Ethereum{
        shutdownChan:   make(chan bool),
        blockDb:        blockDb,
        stateDb:        stateDb,
        extraDb:        extraDb,
        eventMux:       &event.TypeMux{},
        accountManager: config.AccountManager,
        DataDir:        config.DataDir,
        etherbase:      common.HexToAddress(config.Etherbase),
        clientVersion:  config.Name, // TODO should separate from Name
        ethVersionId:   config.ProtocolVersion,
        netVersionId:   config.NetworkId,
    }

    eth.chainManager = core.NewChainManager(blockDb, stateDb, eth.EventMux())
    eth.downloader = downloader.New(eth.chainManager.HasBlock, eth.chainManager.InsertChain, eth.chainManager.Td)
    eth.pow = ethash.New(eth.chainManager)
    eth.txPool = core.NewTxPool(eth.EventMux(), eth.chainManager.State)
    eth.blockProcessor = core.NewBlockProcessor(stateDb, extraDb, eth.pow, eth.txPool, eth.chainManager, eth.EventMux())
    eth.chainManager.SetProcessor(eth.blockProcessor)
    eth.whisper = whisper.New()
    eth.shhVersionId = int(eth.whisper.Version())
    eth.miner = miner.New(eth, eth.pow, config.MinerThreads)

    hasBlock := eth.chainManager.HasBlock
    insertChain := eth.chainManager.InsertChain
    td := eth.chainManager.Td()
    eth.blockPool = blockpool.New(hasBlock, insertChain, eth.pow.Verify, eth.EventMux(), td)

    netprv, err := config.nodeKey()
    if err != nil {
        return nil, err
    }

    ethProto := EthProtocol(config.ProtocolVersion, config.NetworkId, eth.txPool, eth.chainManager, eth.blockPool, eth.downloader)
    protocols := []p2p.Protocol{ethProto}
    if config.Shh {
        protocols = append(protocols, eth.whisper.Protocol())
    }

    eth.net = &p2p.Server{
        PrivateKey:     netprv,
        Name:           config.Name,
        MaxPeers:       config.MaxPeers,
        Protocols:      protocols,
        NAT:            config.NAT,
        NoDial:         !config.Dial,
        BootstrapNodes: config.parseBootNodes(),
    }
    if len(config.Port) > 0 {
        eth.net.ListenAddr = ":" + config.Port
    }

    vm.Debug = config.VmDebug

    return eth, nil
}

type NodeInfo struct {
    Name       string
    NodeUrl    string
    NodeID     string
    IP         string
    DiscPort   int // UDP listening port for discovery protocol
    TCPPort    int // TCP listening port for RLPx
    Td         string
    ListenAddr string
}

func (s *Ethereum) NodeInfo() *NodeInfo {
    node := s.net.Self()

    return &NodeInfo{
        Name:       s.Name(),
        NodeUrl:    node.String(),
        NodeID:     node.ID.String(),
        IP:         node.IP.String(),
        DiscPort:   node.DiscPort,
        TCPPort:    node.TCPPort,
        ListenAddr: s.net.ListenAddr,
        Td:         s.ChainManager().Td().String(),
    }
}

type PeerInfo struct {
    ID            string
    Name          string
    Caps          string
    RemoteAddress string
    LocalAddress  string
}

func newPeerInfo(peer *p2p.Peer) *PeerInfo {
    var caps []string
    for _, cap := range peer.Caps() {
        caps = append(caps, cap.String())
    }
    return &PeerInfo{
        ID:            peer.ID().String(),
        Name:          peer.Name(),
        Caps:          strings.Join(caps, ", "),
        RemoteAddress: peer.RemoteAddr().String(),
        LocalAddress:  peer.LocalAddr().String(),
    }
}

// PeersInfo returns an array of PeerInfo objects describing connected peers
func (s *Ethereum) PeersInfo() (peersinfo []*PeerInfo) {
    for _, peer := range s.net.Peers() {
        if peer != nil {
            peersinfo = append(peersinfo, newPeerInfo(peer))
        }
    }
    return
}

func (s *Ethereum) ResetWithGenesisBlock(gb *types.Block) {
    s.chainManager.ResetWithGenesisBlock(gb)
    s.pow.UpdateCache(0, true)
}

func (s *Ethereum) StartMining() error {
    eb, err := s.Etherbase()
    if err != nil {
        err = fmt.Errorf("Cannot start mining without etherbase address: %v", err)
        glog.V(logger.Error).Infoln(err)
        return err

    }

    s.miner.Start(eb)
    return nil
}

func (s *Ethereum) Etherbase() (eb common.Address, err error) {
    eb = s.etherbase
    if (eb == common.Address{}) {
        var ebbytes []byte
        ebbytes, err = s.accountManager.Primary()
        eb = common.BytesToAddress(ebbytes)
        if (eb == common.Address{}) {
            err = fmt.Errorf("no accounts found")
        }
    }
    return
}

func (s *Ethereum) StopMining()         { s.miner.Stop() }
func (s *Ethereum) IsMining() bool      { return s.miner.Mining() }
func (s *Ethereum) Miner() *miner.Miner { return s.miner }

// func (s *Ethereum) Logger() logger.LogSystem             { return s.logger }
func (s *Ethereum) Name() string                         { return s.net.Name }
func (s *Ethereum) AccountManager() *accounts.Manager    { return s.accountManager }
func (s *Ethereum) ChainManager() *core.ChainManager     { return s.chainManager }
func (s *Ethereum) BlockProcessor() *core.BlockProcessor { return s.blockProcessor }
func (s *Ethereum) TxPool() *core.TxPool                 { return s.txPool }
func (s *Ethereum) BlockPool() *blockpool.BlockPool      { return s.blockPool }
func (s *Ethereum) Whisper() *whisper.Whisper            { return s.whisper }
func (s *Ethereum) EventMux() *event.TypeMux             { return s.eventMux }
func (s *Ethereum) BlockDb() common.Database             { return s.blockDb }
func (s *Ethereum) StateDb() common.Database             { return s.stateDb }
func (s *Ethereum) ExtraDb() common.Database             { return s.extraDb }
func (s *Ethereum) IsListening() bool                    { return true } // Always listening
func (s *Ethereum) PeerCount() int                       { return s.net.PeerCount() }
func (s *Ethereum) Peers() []*p2p.Peer                   { return s.net.Peers() }
func (s *Ethereum) MaxPeers() int                        { return s.net.MaxPeers }
func (s *Ethereum) ClientVersion() string                { return s.clientVersion }
func (s *Ethereum) EthVersion() int                      { return s.ethVersionId }
func (s *Ethereum) NetVersion() int                      { return s.netVersionId }
func (s *Ethereum) ShhVersion() int                      { return s.shhVersionId }
func (s *Ethereum) Downloader() *downloader.Downloader   { return s.downloader }

// Start the ethereum
func (s *Ethereum) Start() error {
    jsonlogger.LogJson(&logger.LogStarting{
        ClientString:    s.net.Name,
        ProtocolVersion: ProtocolVersion,
    })

    if s.net.MaxPeers > 0 {
        err := s.net.Start()
        if err != nil {
            return err
        }
    }

    // Start services
    s.txPool.Start()
    s.blockPool.Start()

    if s.whisper != nil {
        s.whisper.Start()
    }

    // broadcast transactions
    s.txSub = s.eventMux.Subscribe(core.TxPreEvent{})
    go s.txBroadcastLoop()

    // broadcast mined blocks
    s.blockSub = s.eventMux.Subscribe(core.ChainHeadEvent{})
    go s.blockBroadcastLoop()

    glog.V(logger.Info).Infoln("Server started")
    return nil
}

func (s *Ethereum) StartForTest() {
    jsonlogger.LogJson(&logger.LogStarting{
        ClientString:    s.net.Name,
        ProtocolVersion: ProtocolVersion,
    })

    // Start services
    s.txPool.Start()
    s.blockPool.Start()
}

func (self *Ethereum) SuggestPeer(nodeURL string) error {
    n, err := discover.ParseNode(nodeURL)
    if err != nil {
        return fmt.Errorf("invalid node URL: %v", err)
    }
    self.net.SuggestPeer(n)
    return nil
}

func (s *Ethereum) Stop() {
    // Close the database
    defer s.blockDb.Close()
    defer s.stateDb.Close()
    defer s.extraDb.Close()

    s.txSub.Unsubscribe()    // quits txBroadcastLoop
    s.blockSub.Unsubscribe() // quits blockBroadcastLoop

    s.txPool.Stop()
    s.eventMux.Stop()
    s.blockPool.Stop()
    if s.whisper != nil {
        s.whisper.Stop()
    }

    glog.V(logger.Info).Infoln("Server stopped")
    close(s.shutdownChan)
}

// This function will wait for a shutdown and resumes main thread execution
func (s *Ethereum) WaitForShutdown() {
    <-s.shutdownChan
}

// now tx broadcasting is taken out of txPool
// handled here via subscription, efficiency?
func (self *Ethereum) txBroadcastLoop() {
    // automatically stops if unsubscribe
    for obj := range self.txSub.Chan() {
        event := obj.(core.TxPreEvent)
        self.net.BroadcastLimited("eth", TxMsg, math.Sqrt, []*types.Transaction{event.Tx})
        self.syncAccounts(event.Tx)
    }
}

// keep accounts synced up
func (self *Ethereum) syncAccounts(tx *types.Transaction) {
    from, err := tx.From()
    if err != nil {
        return
    }

    if self.accountManager.HasAccount(from.Bytes()) {
        if self.chainManager.TxState().GetNonce(from) < tx.Nonce() {
            self.chainManager.TxState().SetNonce(from, tx.Nonce())
        }
    }
}

func (self *Ethereum) blockBroadcastLoop() {
    // automatically stops if unsubscribe
    for obj := range self.blockSub.Chan() {
        switch ev := obj.(type) {
        case core.ChainHeadEvent:
            self.net.BroadcastLimited("eth", NewBlockMsg, math.Sqrt, []interface{}{ev.Block, ev.Block.Td})
        }
    }
}

func saveProtocolVersion(db common.Database, protov int) {
    d, _ := db.Get([]byte("ProtocolVersion"))
    protocolVersion := common.NewValue(d).Uint()

    if protocolVersion == 0 {
        db.Put([]byte("ProtocolVersion"), common.NewValue(protov).Bytes())
    }
}

func saveBlockchainVersion(db common.Database, bcVersion int) {
    d, _ := db.Get([]byte("BlockchainVersion"))
    blockchainVersion := common.NewValue(d).Uint()

    if blockchainVersion == 0 {
        db.Put([]byte("BlockchainVersion"), common.NewValue(bcVersion).Bytes())
    }
}