aboutsummaryrefslogtreecommitdiffstats
path: root/eth/backend.go
blob: 9e365161dda3f89ca3b5e6137d8b73ca7f4d1504 (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
package eth

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

    "github.com/ethereum/ethash"
    "github.com/ethereum/go-ethereum/accounts"
    "github.com/ethereum/go-ethereum/blockpool"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/ethutil"
    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/logger"
    "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/vm"
    "github.com/ethereum/go-ethereum/whisper"
)

var (
    servlogger = logger.NewLogger("SERV")
    jsonlogger = logger.NewJsonLogger()

    defaultBootNodes = []*discover.Node{
        // ETH/DEV cmd/bootnode
        discover.MustParseNode("enode://6cdd090303f394a1cac34ecc9f7cda18127eafa2a3a06de39f6d920b0e583e062a7362097c7c65ee490a758b442acd5c80c6fce4b148c6a391e946b45131365b@54.169.166.226:30303"),
        // ETH/DEV cpp-ethereum (poc-8.ethdev.com)
        discover.MustParseNode("enode://4a44599974518ea5b0f14c31c4463692ac0329cb84851f3435e6d1b18ee4eae4aa495f846a0fa1219bd58035671881d44423876e57db2abd57254d0197da0ebe@5.1.83.226:30303"),
    }
)

type Config struct {
    Name      string
    DataDir   string
    LogFile   string
    LogLevel  int
    LogFormat 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

    MinerThreads   int
    AccountManager *accounts.Manager
}

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 {
            servlogger.Errorf("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 {
        servlogger.Errorln("could not persist nodekey: ", err)
    }
    return key, nil
}

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

    // DB interface
    blockDb ethutil.Database
    stateDb ethutil.Database

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

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

    logger logger.LogSystem

    Mining  bool
    DataDir string
}

func New(config *Config) (*Ethereum, error) {
    // Boostrap database
    servlogger := logger.New(config.DataDir, config.LogFile, config.LogLevel, config.LogFormat)

    blockDb, err := ethdb.NewLDBDatabase(path.Join(config.DataDir, "blockchain"))
    if err != nil {
        return nil, err
    }
    stateDb, err := ethdb.NewLDBDatabase(path.Join(config.DataDir, "state"))
    if err != nil {
        return nil, err
    }

    // Perform database sanity checks
    d, _ := blockDb.Get([]byte("ProtocolVersion"))
    protov := ethutil.NewValue(d).Uint()
    if protov != ProtocolVersion && protov != 0 {
        path := path.Join(config.DataDir, "blockchain")
        return nil, fmt.Errorf("Database version mismatch. Protocol(%d / %d). `rm -rf %s`", protov, ProtocolVersion, path)
    }

    saveProtocolVersion(blockDb)
    //ethutil.Config.Db = db

    eth := &Ethereum{
        shutdownChan:   make(chan bool),
        blockDb:        blockDb,
        stateDb:        stateDb,
        eventMux:       &event.TypeMux{},
        logger:         servlogger,
        accountManager: config.AccountManager,
        DataDir:        config.DataDir,
    }

    cb, err := eth.accountManager.Coinbase()
    if err != nil {
        return nil, err
    }

    eth.chainManager = core.NewChainManager(blockDb, stateDb, eth.EventMux())
    pow := ethash.New(eth.chainManager)
    eth.txPool = core.NewTxPool(eth.EventMux())
    eth.blockProcessor = core.NewBlockProcessor(stateDb, pow, eth.txPool, eth.chainManager, eth.EventMux())
    eth.chainManager.SetProcessor(eth.blockProcessor)
    eth.whisper = whisper.New()
    eth.miner = miner.New(cb, eth, pow, config.MinerThreads)

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

    netprv, err := config.nodeKey()
    if err != nil {
        return nil, err
    }
    ethProto := EthProtocol(eth.txPool, eth.chainManager, eth.blockPool)
    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
}

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() ethutil.Database            { return s.blockDb }
func (s *Ethereum) StateDb() ethutil.Database            { return s.stateDb }
func (s *Ethereum) Miner() *miner.Miner                  { return s.miner }
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 }

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

    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.NewMinedBlockEvent{})
    go s.blockBroadcastLoop()

    servlogger.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()

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

    servlogger.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.Broadcast("eth", TxMsg, event.Tx.RlpData())
    }
}

func (self *Ethereum) blockBroadcastLoop() {
    // automatically stops if unsubscribe
    for obj := range self.blockSub.Chan() {
        switch ev := obj.(type) {
        case core.NewMinedBlockEvent:
            self.net.Broadcast("eth", NewBlockMsg, ev.Block.RlpData(), ev.Block.Td)
        }
    }
}

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

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