aboutsummaryrefslogtreecommitdiffstats
path: root/eth/backend.go
blob: 2b21a7c9604af588fa1112411ecf4fad5c13d41d (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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
// Copyright 2014 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 eth implements the Ethereum protocol.
package eth

import (
    "crypto/ecdsa"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "math/big"
    "os"
    "path/filepath"
    "strings"
    "time"

    "github.com/ethereum/ethash"
    "github.com/ethereum/go-ethereum/accounts"
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/compiler"
    "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"
)

const (
    epochLength    = 30000
    ethashRevision = 23

    autoDAGcheckInterval = 10 * time.Hour
    autoDAGepochHeight   = epochLength / 2
)

var (
    jsonlogger = logger.NewJsonLogger()

    defaultBootNodes = []*discover.Node{
        // ETH/DEV Go Bootnodes
        discover.MustParseNode("enode://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@52.16.188.185:30303"), // IE
        discover.MustParseNode("enode://de471bccee3d042261d52e9bff31458daecc406142b401d4cd848f677479f73104b9fdeb090af9583d3391b7f10cb2ba9e26865dd5fca4fcdc0fb1e3b723c786@54.94.239.50:30303"),  // BR
        discover.MustParseNode("enode://1118980bf48b0a3640bdba04e0fe78b1add18e1cd99bf22d53daac1fd9972ad650df52176e7c7d89d1114cfef2bc23a2959aa54998a46afcf7d91809f0855082@52.74.57.123:30303"),  // SG
        // ETH/DEV cpp-ethereum (poc-9.ethdev.com)
        discover.MustParseNode("enode://979b7fa28feeb35a4741660a16076f1943202cb72b6af70d327f053e248bab9ba81760f39d0701ef1d8f89cc1fbd2cacba0710a12cd5314d5e0c9021aa3637f9@5.1.83.226:30303"),
    }

    staticNodes  = "static-nodes.json"  // Path within <datadir> to search for the static node list
    trustedNodes = "trusted-nodes.json" // Path within <datadir> to search for the trusted node list
)

type Config struct {
    Name         string
    NetworkId    int
    GenesisNonce int
    GenesisFile  string
    GenesisBlock *types.Block // used by block tests
    Olympic      bool

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

    DataDir   string
    LogFile   string
    Verbosity int
    LogJSON   string
    VmDebug   bool
    NatSpec   bool
    AutoDAG   bool
    PowTest   bool
    ExtraData []byte

    MaxPeers        int
    MaxPendingPeers int
    Discovery       bool
    Port            string

    // 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      common.Address
    GasPrice       *big.Int
    MinerThreads   int
    AccountManager *accounts.Manager
    SolcPath       string

    GpoMinGasPrice          *big.Int
    GpoMaxGasPrice          *big.Int
    GpoFullBlockRatio       int
    GpobaseStepDown         int
    GpobaseStepUp           int
    GpobaseCorrectionFactor int

    // 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
}

// parseNodes parses a list of discovery node URLs loaded from a .json file.
func (cfg *Config) parseNodes(file string) []*discover.Node {
    // Short circuit if no node config is present
    path := filepath.Join(cfg.DataDir, file)
    if _, err := os.Stat(path); err != nil {
        return nil
    }
    // Load the nodes from the config file
    blob, err := ioutil.ReadFile(path)
    if err != nil {
        glog.V(logger.Error).Infof("Failed to access nodes: %v", err)
        return nil
    }
    nodelist := []string{}
    if err := json.Unmarshal(blob, &nodelist); err != nil {
        glog.V(logger.Error).Infof("Failed to load nodes: %v", err)
        return nil
    }
    // Interpret the list as a discovery node array
    var nodes []*discover.Node
    for _, url := range nodelist {
        if url == "" {
            continue
        }
        node, err := discover.ParseNode(url)
        if err != nil {
            glog.V(logger.Error).Infof("Node URL %s: %v\n", url, err)
            continue
        }
        nodes = append(nodes, node)
    }
    return nodes
}

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 := filepath.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 := crypto.SaveECDSA(keyfile, key); 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
    chainDb common.Database // Block chain databe
    dappDb  common.Database // Dapp database

    // Closed when databases are flushed and closed
    databasesClosed chan bool

    //*** SERVICES ***
    // State manager for processing new blocks and managing the over all states
    blockProcessor  *core.BlockProcessor
    txPool          *core.TxPool
    chainManager    *core.ChainManager
    accountManager  *accounts.Manager
    whisper         *whisper.Whisper
    pow             *ethash.Ethash
    protocolManager *ProtocolManager
    SolcPath        string
    solc            *compiler.Solidity

    GpoMinGasPrice          *big.Int
    GpoMaxGasPrice          *big.Int
    GpoFullBlockRatio       int
    GpobaseStepDown         int
    GpobaseStepUp           int
    GpobaseCorrectionFactor int

    net      *p2p.Server
    eventMux *event.TypeMux
    miner    *miner.Miner

    // logger logger.LogSystem

    Mining        bool
    MinerThreads  int
    NatSpec       bool
    DataDir       string
    AutoDAG       bool
    PowTest       bool
    autodagquit   chan bool
    etherbase     common.Address
    clientVersion string
    netVersionId  int
    shhVersionId  int
}

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

    // Let the database take 3/4 of the max open files (TODO figure out a way to get the actual limit of the open files)
    const dbCount = 3
    ethdb.OpenFileLimit = 128 / (dbCount + 1)

    newdb := config.NewDB
    if newdb == nil {
        newdb = func(path string) (common.Database, error) { return ethdb.NewLDBDatabase(path, config.DatabaseCache) }
    }

    // attempt to merge database together, upgrading from an old version
    if err := mergeDatabases(config.DataDir, newdb); err != nil {
        return nil, err
    }

    chainDb, err := newdb(filepath.Join(config.DataDir, "chaindata"))
    if err != nil {
        return nil, fmt.Errorf("blockchain db err: %v", err)
    }
    if db, ok := chainDb.(*ethdb.LDBDatabase); ok {
        db.Meter("eth/db/chaindata/")
    }
    dappDb, err := newdb(filepath.Join(config.DataDir, "dapp"))
    if err != nil {
        return nil, fmt.Errorf("dapp db err: %v", err)
    }
    if db, ok := dappDb.(*ethdb.LDBDatabase); ok {
        db.Meter("eth/db/dapp/")
    }

    nodeDb := filepath.Join(config.DataDir, "nodes")
    glog.V(logger.Info).Infof("Protocol Versions: %v, Network Id: %v", ProtocolVersions, config.NetworkId)

    if len(config.GenesisFile) > 0 {
        fr, err := os.Open(config.GenesisFile)
        if err != nil {
            return nil, err
        }

        block, err := core.WriteGenesisBlock(chainDb, fr)
        if err != nil {
            return nil, err
        }
        glog.V(logger.Info).Infof("Successfully wrote genesis block. New genesis hash = %x\n", block.Hash())
    }

    if config.Olympic {
        _, err := core.WriteTestNetGenesisBlock(chainDb, 42)
        if err != nil {
            return nil, err
        }
        glog.V(logger.Error).Infoln("Starting Olympic network")
    }

    // This is for testing only.
    if config.GenesisBlock != nil {
        core.WriteBlock(chainDb, config.GenesisBlock)
        core.WriteHead(chainDb, config.GenesisBlock)
    }

    if !config.SkipBcVersionCheck {
        b, _ := chainDb.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(chainDb, config.BlockChainVersion)
    }
    glog.V(logger.Info).Infof("Blockchain DB Version: %d", config.BlockChainVersion)

    eth := &Ethereum{
        shutdownChan:            make(chan bool),
        databasesClosed:         make(chan bool),
        chainDb:                 chainDb,
        dappDb:                  dappDb,
        eventMux:                &event.TypeMux{},
        accountManager:          config.AccountManager,
        DataDir:                 config.DataDir,
        etherbase:               config.Etherbase,
        clientVersion:           config.Name, // TODO should separate from Name
        netVersionId:            config.NetworkId,
        NatSpec:                 config.NatSpec,
        MinerThreads:            config.MinerThreads,
        SolcPath:                config.SolcPath,
        AutoDAG:                 config.AutoDAG,
        PowTest:                 config.PowTest,
        GpoMinGasPrice:          config.GpoMinGasPrice,
        GpoMaxGasPrice:          config.GpoMaxGasPrice,
        GpoFullBlockRatio:       config.GpoFullBlockRatio,
        GpobaseStepDown:         config.GpobaseStepDown,
        GpobaseStepUp:           config.GpobaseStepUp,
        GpobaseCorrectionFactor: config.GpobaseCorrectionFactor,
    }

    if config.PowTest {
        glog.V(logger.Info).Infof("ethash used in test mode")
        eth.pow, err = ethash.NewForTesting()
        if err != nil {
            return nil, err
        }
    } else {
        eth.pow = ethash.New()
    }
    //genesis := core.GenesisBlock(uint64(config.GenesisNonce), stateDb)
    eth.chainManager, err = core.NewChainManager(chainDb, eth.pow, eth.EventMux())
    if err != nil {
        if err == core.ErrNoGenesis {
            return nil, fmt.Errorf(`Genesis block not found. Please supply a genesis block with the "--genesis /path/to/file" argument`)
        }

        return nil, err
    }
    eth.txPool = core.NewTxPool(eth.EventMux(), eth.chainManager.State, eth.chainManager.GasLimit)

    eth.blockProcessor = core.NewBlockProcessor(chainDb, eth.pow, eth.chainManager, eth.EventMux())
    eth.chainManager.SetProcessor(eth.blockProcessor)
    eth.protocolManager = NewProtocolManager(config.NetworkId, eth.eventMux, eth.txPool, eth.pow, eth.chainManager)

    eth.miner = miner.New(eth, eth.EventMux(), eth.pow)
    eth.miner.SetGasPrice(config.GasPrice)
    eth.miner.SetExtra(config.ExtraData)

    if config.Shh {
        eth.whisper = whisper.New()
        eth.shhVersionId = int(eth.whisper.Version())
    }

    netprv, err := config.nodeKey()
    if err != nil {
        return nil, err
    }
    protocols := append([]p2p.Protocol{}, eth.protocolManager.SubProtocols...)
    if config.Shh {
        protocols = append(protocols, eth.whisper.Protocol())
    }
    eth.net = &p2p.Server{
        PrivateKey:      netprv,
        Name:            config.Name,
        MaxPeers:        config.MaxPeers,
        MaxPendingPeers: config.MaxPendingPeers,
        Discovery:       config.Discovery,
        Protocols:       protocols,
        NAT:             config.NAT,
        NoDial:          !config.Dial,
        BootstrapNodes:  config.parseBootNodes(),
        StaticNodes:     config.parseNodes(staticNodes),
        TrustedNodes:    config.parseNodes(trustedNodes),
        NodeDatabase:    nodeDb,
    }
    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:   int(node.UDP),
        TCPPort:    int(node.TCP),
        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)
}

func (s *Ethereum) StartMining(threads int) 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
    }

    go s.miner.Start(eb, threads)
    return nil
}

func (s *Ethereum) Etherbase() (eb common.Address, err error) {
    eb = s.etherbase
    if (eb == common.Address{}) {
        addr, e := s.AccountManager().AddressByIndex(0)
        if e != nil {
            err = fmt.Errorf("etherbase address must be explicitly specified")
        }
        eb = common.HexToAddress(addr)
    }
    return
}

// set in js console via admin interface or wrapper from cli flags
func (self *Ethereum) SetEtherbase(etherbase common.Address) {
    self.etherbase = etherbase
    self.miner.SetEtherbase(etherbase)
}

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) Whisper() *whisper.Whisper            { return s.whisper }
func (s *Ethereum) EventMux() *event.TypeMux             { return s.eventMux }
func (s *Ethereum) ChainDb() common.Database             { return s.chainDb }
func (s *Ethereum) DappDb() common.Database              { return s.dappDb }
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 int(s.protocolManager.SubProtocols[0].Version) }
func (s *Ethereum) NetVersion() int                      { return s.netVersionId }
func (s *Ethereum) ShhVersion() int                      { return s.shhVersionId }
func (s *Ethereum) Downloader() *downloader.Downloader   { return s.protocolManager.downloader }

// Start the ethereum
func (s *Ethereum) Start() error {
    jsonlogger.LogJson(&logger.LogStarting{
        ClientString:    s.net.Name,
        ProtocolVersion: s.EthVersion(),
    })
    err := s.net.Start()
    if err != nil {
        return err
    }
    // periodically flush databases
    go s.syncDatabases()

    if s.AutoDAG {
        s.StartAutoDAG()
    }

    s.protocolManager.Start()

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

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

// sync databases every minute. If flushing fails we exit immediatly. The system
// may not continue under any circumstances.
func (s *Ethereum) syncDatabases() {
    ticker := time.NewTicker(1 * time.Minute)
done:
    for {
        select {
        case <-ticker.C:
            // don't change the order of database flushes
            if err := s.dappDb.Flush(); err != nil {
                glog.Fatalf("fatal error: flush dappDb: %v (Restart your node. We are aware of this issue)\n", err)
            }
            if err := s.chainDb.Flush(); err != nil {
                glog.Fatalf("fatal error: flush chainDb: %v (Restart your node. We are aware of this issue)\n", err)
            }
        case <-s.shutdownChan:
            break done
        }
    }

    s.chainDb.Close()
    s.dappDb.Close()

    close(s.databasesClosed)
}

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

// AddPeer connects to the given node and maintains the connection until the
// server is shut down. If the connection fails for any reason, the server will
// attempt to reconnect the peer.
func (self *Ethereum) AddPeer(nodeURL string) error {
    n, err := discover.ParseNode(nodeURL)
    if err != nil {
        return fmt.Errorf("invalid node URL: %v", err)
    }
    self.net.AddPeer(n)
    return nil
}

func (s *Ethereum) Stop() {
    s.net.Stop()
    s.chainManager.Stop()
    s.protocolManager.Stop()
    s.txPool.Stop()
    s.eventMux.Stop()
    if s.whisper != nil {
        s.whisper.Stop()
    }
    s.StopAutoDAG()

    close(s.shutdownChan)
}

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

// StartAutoDAG() spawns a go routine that checks the DAG every autoDAGcheckInterval
// by default that is 10 times per epoch
// in epoch n, if we past autoDAGepochHeight within-epoch blocks,
// it calls ethash.MakeDAG  to pregenerate the DAG for the next epoch n+1
// if it does not exist yet as well as remove the DAG for epoch n-1
// the loop quits if autodagquit channel is closed, it can safely restart and
// stop any number of times.
// For any more sophisticated pattern of DAG generation, use CLI subcommand
// makedag
func (self *Ethereum) StartAutoDAG() {
    if self.autodagquit != nil {
        return // already started
    }
    go func() {
        glog.V(logger.Info).Infof("Automatic pregeneration of ethash DAG ON (ethash dir: %s)", ethash.DefaultDir)
        var nextEpoch uint64
        timer := time.After(0)
        self.autodagquit = make(chan bool)
        for {
            select {
            case <-timer:
                glog.V(logger.Info).Infof("checking DAG (ethash dir: %s)", ethash.DefaultDir)
                currentBlock := self.ChainManager().CurrentBlock().NumberU64()
                thisEpoch := currentBlock / epochLength
                if nextEpoch <= thisEpoch {
                    if currentBlock%epochLength > autoDAGepochHeight {
                        if thisEpoch > 0 {
                            previousDag, previousDagFull := dagFiles(thisEpoch - 1)
                            os.Remove(filepath.Join(ethash.DefaultDir, previousDag))
                            os.Remove(filepath.Join(ethash.DefaultDir, previousDagFull))
                            glog.V(logger.Info).Infof("removed DAG for epoch %d (%s)", thisEpoch-1, previousDag)
                        }
                        nextEpoch = thisEpoch + 1
                        dag, _ := dagFiles(nextEpoch)
                        if _, err := os.Stat(dag); os.IsNotExist(err) {
                            glog.V(logger.Info).Infof("Pregenerating DAG for epoch %d (%s)", nextEpoch, dag)
                            err := ethash.MakeDAG(nextEpoch*epochLength, "") // "" -> ethash.DefaultDir
                            if err != nil {
                                glog.V(logger.Error).Infof("Error generating DAG for epoch %d (%s)", nextEpoch, dag)
                                return
                            }
                        } else {
                            glog.V(logger.Error).Infof("DAG for epoch %d (%s)", nextEpoch, dag)
                        }
                    }
                }
                timer = time.After(autoDAGcheckInterval)
            case <-self.autodagquit:
                return
            }
        }
    }()
}

// stopAutoDAG stops automatic DAG pregeneration by quitting the loop
func (self *Ethereum) StopAutoDAG() {
    if self.autodagquit != nil {
        close(self.autodagquit)
        self.autodagquit = nil
    }
    glog.V(logger.Info).Infof("Automatic pregeneration of ethash DAG OFF (ethash dir: %s)", ethash.DefaultDir)
}

func (self *Ethereum) Solc() (*compiler.Solidity, error) {
    var err error
    if self.solc == nil {
        self.solc, err = compiler.New(self.SolcPath)
    }
    return self.solc, err
}

// set in js console via admin interface or wrapper from cli flags
func (self *Ethereum) SetSolc(solcPath string) (*compiler.Solidity, error) {
    self.SolcPath = solcPath
    self.solc = nil
    return self.Solc()
}

// dagFiles(epoch) returns the two alternative DAG filenames (not a path)
// 1) <revision>-<hex(seedhash[8])> 2) full-R<revision>-<hex(seedhash[8])>
func dagFiles(epoch uint64) (string, string) {
    seedHash, _ := ethash.GetSeedHash(epoch * epochLength)
    dag := fmt.Sprintf("full-R%d-%x", ethashRevision, seedHash[:8])
    return dag, "full-R" + dag
}

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())
    }
}

// mergeDatabases when required merge old database layout to one single database
func mergeDatabases(datadir string, newdb func(path string) (common.Database, error)) error {
    // Check if already upgraded
    data := filepath.Join(datadir, "chaindata")
    if _, err := os.Stat(data); !os.IsNotExist(err) {
        return nil
    }
    // make sure it's not just a clean path
    chainPath := filepath.Join(datadir, "blockchain")
    if _, err := os.Stat(chainPath); os.IsNotExist(err) {
        return nil
    }
    glog.Infoln("Database upgrade required. Upgrading...")

    database, err := newdb(data)
    if err != nil {
        return fmt.Errorf("creating data db err: %v", err)
    }
    defer database.Close()

    // Migrate blocks
    chainDb, err := newdb(chainPath)
    if err != nil {
        return fmt.Errorf("state db err: %v", err)
    }
    defer chainDb.Close()

    if chain, ok := chainDb.(*ethdb.LDBDatabase); ok {
        glog.Infoln("Merging blockchain database...")
        it := chain.NewIterator()
        for it.Next() {
            database.Put(it.Key(), it.Value())
        }
        it.Release()
    }

    // Migrate state
    stateDb, err := newdb(filepath.Join(datadir, "state"))
    if err != nil {
        return fmt.Errorf("state db err: %v", err)
    }
    defer stateDb.Close()

    if state, ok := stateDb.(*ethdb.LDBDatabase); ok {
        glog.Infoln("Merging state database...")
        it := state.NewIterator()
        for it.Next() {
            database.Put(it.Key(), it.Value())
        }
        it.Release()
    }

    // Migrate transaction / receipts
    extraDb, err := newdb(filepath.Join(datadir, "extra"))
    if err != nil {
        return fmt.Errorf("state db err: %v", err)
    }
    defer extraDb.Close()

    if extra, ok := extraDb.(*ethdb.LDBDatabase); ok {
        glog.Infoln("Merging transaction database...")

        it := extra.NewIterator()
        for it.Next() {
            database.Put(it.Key(), it.Value())
        }
        it.Release()
    }

    return nil
}