aboutsummaryrefslogtreecommitdiffstats
path: root/miner/worker.go
blob: ae6782aca0766a5774d0ca482543bf6299c680b2 (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
package miner

import (
    "fmt"
    "math/big"
    "sort"
    "sync"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/event"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/pow"
    "github.com/ethereum/go-ethereum/state"
    "gopkg.in/fatih/set.v0"
)

var jsonlogger = logger.NewJsonLogger()

type environment struct {
    totalUsedGas *big.Int
    state        *state.StateDB
    coinbase     *state.StateObject
    block        *types.Block
    ancestors    *set.Set
    uncles       *set.Set
}

func env(block *types.Block, eth core.Backend) *environment {
    state := state.New(block.Root(), eth.StateDb())
    env := &environment{
        totalUsedGas: new(big.Int),
        state:        state,
        block:        block,
        ancestors:    set.New(),
        uncles:       set.New(),
        coinbase:     state.GetOrNewStateObject(block.Coinbase()),
    }
    for _, ancestor := range eth.ChainManager().GetAncestors(block, 7) {
        env.ancestors.Add(ancestor.Hash())
    }

    return env
}

type Work struct {
    Number    uint64
    Nonce     uint64
    MixDigest []byte
    SeedHash  []byte
}

type Agent interface {
    Work() chan<- *types.Block
    SetWorkCh(chan<- Work)
    Stop()
    Start()
    GetHashRate() int64
}

type worker struct {
    mu     sync.Mutex
    agents []Agent
    recv   chan Work
    mux    *event.TypeMux
    quit   chan struct{}
    pow    pow.PoW

    eth      core.Backend
    chain    *core.ChainManager
    proc     *core.BlockProcessor
    coinbase common.Address

    current *environment

    mining bool
}

func newWorker(coinbase common.Address, eth core.Backend) *worker {
    return &worker{
        eth:      eth,
        mux:      eth.EventMux(),
        recv:     make(chan Work),
        chain:    eth.ChainManager(),
        proc:     eth.BlockProcessor(),
        coinbase: coinbase,
    }
}

func (self *worker) start() {
    self.mining = true

    self.quit = make(chan struct{})

    // spin up agents
    for _, agent := range self.agents {
        agent.Start()
    }

    go self.update()
    go self.wait()
}

func (self *worker) stop() {
    self.mining = false

    close(self.quit)
}

func (self *worker) register(agent Agent) {
    self.agents = append(self.agents, agent)
    agent.SetWorkCh(self.recv)
}

func (self *worker) update() {
    events := self.mux.Subscribe(core.ChainHeadEvent{}, core.NewMinedBlockEvent{})

    timer := time.NewTicker(2 * time.Second)

out:
    for {
        select {
        case event := <-events.Chan():
            switch ev := event.(type) {
            case core.ChainHeadEvent:
                if self.current.block != ev.Block {
                    self.commitNewWork()
                }
            case core.NewMinedBlockEvent:
                self.commitNewWork()
            }
        case <-self.quit:
            // stop all agents
            for _, agent := range self.agents {
                agent.Stop()
            }
            break out
        case <-timer.C:
            minerlogger.Infoln("Hash rate:", self.HashRate(), "Khash")
        }
    }

    events.Unsubscribe()
}

func (self *worker) wait() {
    for {
        for work := range self.recv {
            // Someone Successfully Mined!
            block := self.current.block
            if block.Number().Uint64() == work.Number && block.Nonce() == 0 {
                self.current.block.SetNonce(work.Nonce)
                self.current.block.Header().MixDigest = common.BytesToHash(work.MixDigest)

                jsonlogger.LogJson(&logger.EthMinerNewBlock{
                    BlockHash:     block.Hash().Hex(),
                    BlockNumber:   block.Number(),
                    ChainHeadHash: block.ParentHeaderHash.Hex(),
                    BlockPrevHash: block.ParentHeaderHash.Hex(),
                })

                if err := self.chain.InsertChain(types.Blocks{self.current.block}); err == nil {
                    self.mux.Post(core.NewMinedBlockEvent{self.current.block})
                } else {
                    self.commitNewWork()
                }
            }
            break
        }
    }
}

func (self *worker) push() {
    if self.mining {
        self.current.block.Header().GasUsed = self.current.totalUsedGas
        self.current.block.SetRoot(self.current.state.Root())

        // push new work to agents
        for _, agent := range self.agents {
            agent.Work() <- self.current.block
        }
    }
}

func (self *worker) commitNewWork() {
    self.mu.Lock()
    defer self.mu.Unlock()

    block := self.chain.NewBlock(self.coinbase)

    self.current = env(block, self.eth)
    parent := self.chain.GetBlock(self.current.block.ParentHash())
    self.current.coinbase.SetGasPool(core.CalcGasLimit(parent, self.current.block))

    transactions := self.eth.TxPool().GetTransactions()
    sort.Sort(types.TxByNonce{transactions})

    minerlogger.Infof("committing new work with %d txs\n", len(transactions))
    // Keep track of transactions which return errors so they can be removed
    var remove types.Transactions
gasLimit:
    for i, tx := range transactions {
        err := self.commitTransaction(tx)
        switch {
        case core.IsNonceErr(err):
            fallthrough
        case core.IsInvalidTxErr(err):
            // Remove invalid transactions
            from, _ := tx.From()
            self.chain.TxState().RemoveNonce(from, tx.Nonce())
            remove = append(remove, tx)
            minerlogger.Infof("TX (%x) failed. Transaction will be removed\n", tx.Hash().Bytes()[:4])
        case state.IsGasLimitErr(err):
            minerlogger.Infof("Gas limit reached for block. %d TXs included in this block\n", i)
            // Break on gas limit
            break gasLimit
        }
    }
    self.eth.TxPool().RemoveSet(remove)

    self.current.state.AddBalance(self.coinbase, core.BlockReward)

    self.current.state.Update(common.Big0)
    self.push()
}

var (
    inclusionReward = new(big.Int).Div(core.BlockReward, big.NewInt(32))
    _uncleReward    = new(big.Int).Mul(core.BlockReward, big.NewInt(15))
    uncleReward     = new(big.Int).Div(_uncleReward, big.NewInt(16))
)

func (self *worker) commitUncle(uncle *types.Header) error {
    if self.current.uncles.Has(uncle.Hash()) {
        // Error not unique
        return core.UncleError("Uncle not unique")
    }
    self.current.uncles.Add(uncle.Hash())

    if !self.current.ancestors.Has(uncle.ParentHash) {
        return core.UncleError(fmt.Sprintf("Uncle's parent unknown (%x)", uncle.ParentHash[0:4]))
    }

    if !self.pow.Verify(types.NewBlockWithHeader(uncle)) {
        return core.ValidationError("Uncle's nonce is invalid (= %x)", uncle.Nonce)
    }

    uncleAccount := self.current.state.GetAccount(uncle.Coinbase)
    uncleAccount.AddBalance(uncleReward)

    self.current.coinbase.AddBalance(uncleReward)

    return nil
}

func (self *worker) commitTransaction(tx *types.Transaction) error {
    snap := self.current.state.Copy()
    receipt, _, err := self.proc.ApplyTransaction(self.current.coinbase, self.current.state, self.current.block, tx, self.current.totalUsedGas, true)
    if err != nil && (core.IsNonceErr(err) || state.IsGasLimitErr(err) || core.IsInvalidTxErr(err)) {
        self.current.state.Set(snap)
        return err
    }

    self.current.block.AddTransaction(tx)
    self.current.block.AddReceipt(receipt)

    return nil
}

func (self *worker) HashRate() int64 {
    var tot int64
    for _, agent := range self.agents {
        tot += agent.GetHashRate()
    }

    return tot
}