blob: aa4756eb733367c8da2499757660f553b3f652d1 (
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
|
// Copyright 2018 The dexon-consensus-core Authors
// This file is part of the dexon-consensus-core library.
//
// The dexon-consensus-core 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 dexon-consensus-core 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 dexon-consensus-core library. If not, see
// <http://www.gnu.org/licenses/>.
package core
import (
"time"
"github.com/shopspring/decimal"
"github.com/dexon-foundation/dexon-consensus-core/common"
"github.com/dexon-foundation/dexon-consensus-core/core/types"
)
// Application describes the application interface that interacts with DEXON
// consensus core.
type Application interface {
// PreparePayload is called when consensus core is preparing a block.
PreparePayload(position types.Position) []byte
// VerifyPayloads verifies if the payloads are valid.
VerifyPayloads(payloads []byte) bool
// BlockConfirmed is called when a block is confirmed and added to lattice.
BlockConfirmed(block *types.Block)
// StronglyAcked is called when a block is strongly acked.
StronglyAcked(blockHash common.Hash)
// TotalOrderingDeliver is called when the total ordering algorithm deliver
// a set of block.
TotalOrderingDeliver(blockHashes common.Hashes, early bool)
// DeliverBlock is called when a block is add to the compaction chain.
DeliverBlock(blockHash common.Hash, timestamp time.Time)
// NotaryAckDeliver is called when a notary ack is created.
NotaryAckDeliver(notaryAck *types.NotaryAck)
}
// Network describs the network interface that interacts with DEXON consensus
// core.
type Network interface {
// BroadcastVote broadcasts vote to all nodes in DEXON network.
BroadcastVote(vote *types.Vote)
// BroadcastBlock broadcasts block to all nodes in DEXON network.
BroadcastBlock(block *types.Block)
// BroadcastNotaryAck broadcasts notaryAck to all nodes in DEXON network.
BroadcastNotaryAck(notaryAck *types.NotaryAck)
// SendDKGPrivateShare sends PrivateShare to a DKG participant.
SendDKGPrivateShare(recv types.ValidatorID, prvShare *types.DKGPrivateShare)
// ReceiveChan returns a channel to receive messages from DEXON network.
ReceiveChan() <-chan interface{}
}
// Governance interface specifies interface to control the governance contract.
// Note that there are a lot more methods in the governance contract, that this
// interface only define those that are required to run the consensus algorithm.
type Governance interface {
// Get the current validator set and it's corresponding stake.
GetValidatorSet() map[types.ValidatorID]decimal.Decimal
// Get K.
GetTotalOrderingK() int
// Get PhiRatio.
GetPhiRatio() float32
// Get block proposing interval (in milliseconds).
GetBlockProposingInterval() int
// Get Number of Chains.
GetChainNumber() uint32
// Get Genesis CRS.
GetGenesisCRS() string
// Get configuration change events after an epoch.
GetConfigurationChangeEvent(epoch int) []types.ConfigurationChangeEvent
// AddDKGComplaint adds a DKGComplaint.
AddDKGComplaint(complaint *types.DKGComplaint)
// GetDKGComplaints gets all the DKGComplaints of round.
DKGComplaints(round uint64) []*types.DKGComplaint
// AddDKGMasterPublicKey adds a DKGMasterPublicKey.
AddDKGMasterPublicKey(masterPublicKey *types.DKGMasterPublicKey)
// DKGMasterPublicKeys gets all the DKGMasterPublicKey of round.
DKGMasterPublicKeys(round uint64) []*types.DKGMasterPublicKey
}
|
