-
Notifications
You must be signed in to change notification settings - Fork 0
/
localcoin.go
72 lines (56 loc) · 2.75 KB
/
localcoin.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
/*
github.com/tcrain/cons - Experimental project for testing and scaling consensus algorithms.
Copyright (C) 2020 The project authors - tcrain
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package localcoin
import (
"github.com/tcrain/cons/consensus/auth/sig"
"github.com/tcrain/cons/consensus/consinterface"
"github.com/tcrain/cons/consensus/deserialized"
"github.com/tcrain/cons/consensus/generalconfig"
"github.com/tcrain/cons/consensus/messages"
"github.com/tcrain/cons/consensus/types"
)
// LocalCoin represents a local random coin.
type LocalCoin struct {
}
func NewLocalCoin() consinterface.CoinItemInterface {
return &LocalCoin{}
}
func (sc1 *LocalCoin) GenerateCoinMessage(types.ConsensusRound, bool, consinterface.ConsItem,
consinterface.CoinMessageStateInterface, consinterface.MessageState) (ret messages.MsgHeader) {
return
}
// CheckCoinMessage should be called from within ProcessMessage of the ConsensusItem that is using this coin.
// It returns the round the coin corresponds to and true in first boolean position if made progress towards decision,
// or false if already decided, and return true in second position if the message should be forwarded.
// If the message is invalid an error is returned.
func (*LocalCoin) CheckCoinMessage(*deserialized.DeserializedItem,
bool, bool, consinterface.ConsItem, consinterface.CoinMessageStateInterface,
consinterface.MessageState) (round types.ConsensusRound, ret messages.MsgHeader,
progress, shouldForward bool, err error) {
err = types.ErrInvalidHeader
return
}
// GetHeader should a blank message header for the HeaderID, this object will be used to deserialize a message into itself (see consinterface.DeserializeMessage).
func (LocalCoin) GetHeader(sig.Pub, *generalconfig.GeneralConfig,
messages.HeaderID) (messages.MsgHeader, error) {
return nil, types.ErrInvalidHeader
}
// GetBufferCount returns the thresholds for messages of type coin.
// The thresholds are n-t.
func (LocalCoin) GetBufferCount(messages.MsgIDHeader, *generalconfig.GeneralConfig,
*consinterface.MemCheckers) (endThreshold int,
maxPossible int, msgid messages.MsgID, err error) { // How many of the same msg to buff before forwarding
return 0, 0, nil, types.ErrInvalidHeader
}