aboutsummaryrefslogtreecommitdiffstats
path: root/consensus/ethash/api.go
blob: 05255e8d254a81ede294340b583c338284972c8f (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
// Copyright 2018 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 ethash

import (
    "errors"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/common/hexutil"
    "github.com/dexon-foundation/dexon/core/types"
)

var errEthashStopped = errors.New("ethash stopped")

// API exposes ethash related methods for the RPC interface.
type API struct {
    ethash *Ethash // Make sure the mode of ethash is normal.
}

// GetWork returns a work package for external miner.
//
// The work package consists of 3 strings:
//   result[0] - 32 bytes hex encoded current block header pow-hash
//   result[1] - 32 bytes hex encoded seed hash used for DAG
//   result[2] - 32 bytes hex encoded boundary condition ("target"), 2^256/difficulty
//   result[3] - hex encoded block number
func (api *API) GetWork() ([4]string, error) {
    if api.ethash.config.PowMode != ModeNormal && api.ethash.config.PowMode != ModeTest {
        return [4]string{}, errors.New("not supported")
    }

    var (
        workCh = make(chan [4]string, 1)
        errc   = make(chan error, 1)
    )

    select {
    case api.ethash.fetchWorkCh <- &sealWork{errc: errc, res: workCh}:
    case <-api.ethash.exitCh:
        return [4]string{}, errEthashStopped
    }

    select {
    case work := <-workCh:
        return work, nil
    case err := <-errc:
        return [4]string{}, err
    }
}

// SubmitWork can be used by external miner to submit their POW solution.
// It returns an indication if the work was accepted.
// Note either an invalid solution, a stale work a non-existent work will return false.
func (api *API) SubmitWork(nonce types.BlockNonce, hash, digest common.Hash) bool {
    if api.ethash.config.PowMode != ModeNormal && api.ethash.config.PowMode != ModeTest {
        return false
    }

    var errc = make(chan error, 1)

    select {
    case api.ethash.submitWorkCh <- &mineResult{
        nonce:     nonce,
        mixDigest: digest,
        hash:      hash,
        errc:      errc,
    }:
    case <-api.ethash.exitCh:
        return false
    }

    err := <-errc
    return err == nil
}

// SubmitHashrate can be used for remote miners to submit their hash rate.
// This enables the node to report the combined hash rate of all miners
// which submit work through this node.
//
// It accepts the miner hash rate and an identifier which must be unique
// between nodes.
func (api *API) SubmitHashRate(rate hexutil.Uint64, id common.Hash) bool {
    if api.ethash.config.PowMode != ModeNormal && api.ethash.config.PowMode != ModeTest {
        return false
    }

    var done = make(chan struct{}, 1)

    select {
    case api.ethash.submitRateCh <- &hashrate{done: done, rate: uint64(rate), id: id}:
    case <-api.ethash.exitCh:
        return false
    }

    // Block until hash rate submitted successfully.
    <-done

    return true
}

// GetHashrate returns the current hashrate for local CPU miner and remote miner.
func (api *API) GetHashrate() uint64 {
    return uint64(api.ethash.Hashrate())
}