/
backend.go
87 lines (66 loc) · 3.18 KB
/
backend.go
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
// Modifications Copyright 2018 The klaytn Authors
// Copyright 2017 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/>.
//
// This file is derived from quorum/consensus/istanbul/backend.go (2018/06/04).
// Modified and improved for the klaytn development.
package istanbul
import (
"github.com/klaytn/klaytn/common"
"github.com/klaytn/klaytn/event"
"math/big"
"time"
)
//go:generate mockgen -destination=consensus/istanbul/mocks/backend_mock.go github.com/klaytn/klaytn/consensus/istanbul Backend
// Backend provides application specific functions for Istanbul core
type Backend interface {
// Address returns the owner's address
Address() common.Address
// Validators returns the validator set
Validators(proposal Proposal) ValidatorSet
// EventMux returns the event mux in backend
EventMux() *event.TypeMux
// Broadcast sends a message to all validators (include self)
Broadcast(prevHash common.Hash, valSet ValidatorSet, payload []byte) error
// Gossip sends a message to all validators (exclude self)
Gossip(valSet ValidatorSet, payload []byte) error
GossipSubPeer(prevHash common.Hash, valSet ValidatorSet, payload []byte) map[common.Address]bool
// Commit delivers an approved proposal to backend.
// The delivered proposal will be put into blockchain.
Commit(proposal Proposal, seals [][]byte) error
// Verify verifies the proposal. If a consensus.ErrFutureBlock error is returned,
// the time difference of the proposal and current time is also returned.
Verify(Proposal) (time.Duration, error)
// Sign signs input data with the backend's private key
Sign([]byte) ([]byte, error)
// CheckSignature verifies the signature by checking if it's signed by
// the given validator
CheckSignature(data []byte, addr common.Address, sig []byte) error
// LastProposal retrieves latest committed proposal and the address of proposer
LastProposal() (Proposal, common.Address)
// HasPropsal checks if the combination of the given hash and height matches any existing blocks
HasPropsal(hash common.Hash, number *big.Int) bool
// GetProposer returns the proposer of the given block height
GetProposer(number uint64) common.Address
// ParentValidators returns the validator set of the given proposal's parent block
ParentValidators(proposal Proposal) ValidatorSet
// HasBadBlock returns whether the block with the hash is a bad block
HasBadProposal(hash common.Hash) bool
GetRewardBase() common.Address
GetSubGroupSize() uint64
SetCurrentView(view *View)
NodeType() common.ConnType
}