-
Notifications
You must be signed in to change notification settings - Fork 22
/
engine.go
215 lines (182 loc) · 9.04 KB
/
engine.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
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
// Copyright (c) 2022 Gobalsky Labs Limited
//
// Use of this software is governed by the Business Source License included
// in the LICENSE.VEGA file and at https://www.mariadb.com/bsl11.
//
// Change Date: 18 months from the later of the date of the first publicly
// available Distribution of this version of the repository, and 25 June 2022.
//
// On the date above, in accordance with the Business Source License, use
// of this software will be governed by version 3 or later of the GNU General
// Public License.
package spam
import (
"context"
"encoding/hex"
"sync"
"code.vegaprotocol.io/vega/core/netparams"
"code.vegaprotocol.io/vega/core/blockchain/abci"
"code.vegaprotocol.io/vega/core/txn"
"code.vegaprotocol.io/vega/core/types"
"code.vegaprotocol.io/vega/libs/num"
"code.vegaprotocol.io/vega/logging"
)
var increaseFactor = num.NewUint(2)
const (
rejectRatioForIncrease float64 = 0.3
numberOfEpochsBan uint64 = 4
numberOfBlocksForIncreaseCheck uint64 = 10
banFactor = 0.5
)
type StakingAccounts interface {
GetAvailableBalance(party string) (*num.Uint, error)
}
type EpochEngine interface {
NotifyOnEpoch(f func(context.Context, types.Epoch), r func(context.Context, types.Epoch))
}
type Engine struct {
log *logging.Logger
config Config
accounting StakingAccounts
cfgMu sync.Mutex
transactionTypeToPolicy map[txn.Command]Policy
currentEpoch *types.Epoch
policyNameToPolicy map[string]Policy
hashKeys []string
}
type Policy interface {
Reset(epoch types.Epoch)
EndOfBlock(blockHeight uint64)
PreBlockAccept(tx abci.Tx) (bool, error)
PostBlockAccept(tx abci.Tx) (bool, error)
UpdateUintParam(name string, value *num.Uint) error
UpdateIntParam(name string, value int64) error
Serialise() ([]byte, error)
Deserialise(payload *types.Payload) error
}
// ReloadConf updates the internal configuration of the spam engine.
func (e *Engine) ReloadConf(cfg Config) {
e.log.Info("reloading configuration")
if e.log.GetLevel() != cfg.Level.Get() {
e.log.Info("updating log level",
logging.String("old", e.log.GetLevel().String()),
logging.String("new", cfg.Level.String()),
)
e.log.SetLevel(cfg.Level.Get())
}
e.cfgMu.Lock()
e.config = cfg
e.cfgMu.Unlock()
}
// New instantiates a new spam engine.
func New(log *logging.Logger, config Config, epochEngine EpochEngine, accounting StakingAccounts) *Engine {
log = log.Named(namedLogger)
log.SetLevel(config.Level.Get())
e := &Engine{
config: config,
log: log,
accounting: accounting,
transactionTypeToPolicy: map[txn.Command]Policy{},
}
proposalPolicy := NewSimpleSpamPolicy("proposal", netparams.SpamProtectionMinTokensForProposal, netparams.SpamProtectionMaxProposals, log, accounting)
valJoinPolicy := NewSimpleSpamPolicy("validatorJoin", netparams.StakingAndDelegationRewardMinimumValidatorStake, "", log, accounting)
delegationPolicy := NewSimpleSpamPolicy("delegation", netparams.SpamProtectionMinTokensForDelegation, netparams.SpamProtectionMaxDelegations, log, accounting)
votePolicy := NewVoteSpamPolicy(netparams.SpamProtectionMinTokensForVoting, netparams.SpamProtectionMaxVotes, log, accounting)
transferPolicy := NewSimpleSpamPolicy("transfer", "", netparams.TransferMaxCommandsPerEpoch, log, accounting)
voteKey := (&types.PayloadVoteSpamPolicy{}).Key()
e.policyNameToPolicy = map[string]Policy{voteKey: votePolicy, proposalPolicy.policyName: proposalPolicy, delegationPolicy.policyName: delegationPolicy}
e.hashKeys = []string{voteKey, proposalPolicy.policyName, delegationPolicy.policyName}
e.transactionTypeToPolicy[txn.ProposeCommand] = proposalPolicy
e.transactionTypeToPolicy[txn.VoteCommand] = votePolicy
e.transactionTypeToPolicy[txn.DelegateCommand] = delegationPolicy
e.transactionTypeToPolicy[txn.UndelegateCommand] = delegationPolicy
e.transactionTypeToPolicy[txn.TransferFundsCommand] = transferPolicy
e.transactionTypeToPolicy[txn.CancelTransferFundsCommand] = transferPolicy
e.transactionTypeToPolicy[txn.AnnounceNodeCommand] = valJoinPolicy
// register for epoch end notifications
epochEngine.NotifyOnEpoch(e.OnEpochEvent, e.OnEpochRestore)
e.log.Info("Spam protection started")
return e
}
// OnMaxDelegationsChanged is called when the net param for max delegations per epoch has changed.
func (e *Engine) OnMaxDelegationsChanged(ctx context.Context, maxDelegations int64) error {
return e.transactionTypeToPolicy[txn.DelegateCommand].UpdateIntParam(netparams.SpamProtectionMaxDelegations, maxDelegations)
}
// OnMinTokensForDelegationChanged is called when the net param for min tokens requirement for voting has changed.
func (e *Engine) OnMinTokensForDelegationChanged(ctx context.Context, minTokens num.Decimal) error {
minTokensFoDelegation, _ := num.UintFromDecimal(minTokens)
return e.transactionTypeToPolicy[txn.DelegateCommand].UpdateUintParam(netparams.SpamProtectionMinTokensForDelegation, minTokensFoDelegation)
}
// OnMaxVotesChanged is called when the net param for max votes per epoch has changed.
func (e *Engine) OnMaxVotesChanged(ctx context.Context, maxVotes int64) error {
return e.transactionTypeToPolicy[txn.VoteCommand].UpdateIntParam(netparams.SpamProtectionMaxVotes, maxVotes)
}
// OnMinTokensForVotingChanged is called when the net param for min tokens requirement for voting has changed.
func (e *Engine) OnMinTokensForVotingChanged(ctx context.Context, minTokens num.Decimal) error {
minTokensForVoting, _ := num.UintFromDecimal(minTokens)
return e.transactionTypeToPolicy[txn.VoteCommand].UpdateUintParam(netparams.SpamProtectionMinTokensForVoting, minTokensForVoting)
}
// OnMaxProposalsChanged is called when the net param for max proposals per epoch has changed.
func (e *Engine) OnMaxProposalsChanged(ctx context.Context, maxProposals int64) error {
return e.transactionTypeToPolicy[txn.ProposeCommand].UpdateIntParam(netparams.SpamProtectionMaxProposals, maxProposals)
}
// OnMinTokensForProposalChanged is called when the net param for min tokens requirement for submitting a proposal has changed.
func (e *Engine) OnMinTokensForProposalChanged(ctx context.Context, minTokens num.Decimal) error {
minTokensForProposal, _ := num.UintFromDecimal(minTokens)
return e.transactionTypeToPolicy[txn.ProposeCommand].UpdateUintParam(netparams.SpamProtectionMinTokensForProposal, minTokensForProposal)
}
// OnMaxTransfersChanged is called when the net param for max transfers per epoch changes.
func (e *Engine) OnMaxTransfersChanged(_ context.Context, maxTransfers int64) error {
return e.transactionTypeToPolicy[txn.TransferFundsCommand].UpdateIntParam(netparams.TransferMaxCommandsPerEpoch, maxTransfers)
}
// OnMinValidatorTokensChanged is called when the net param for min tokens for joining validator changes.
func (e *Engine) OnMinValidatorTokensChanged(_ context.Context, minTokens num.Decimal) error {
minTokensForJoiningValidator, _ := num.UintFromDecimal(minTokens)
return e.transactionTypeToPolicy[txn.AnnounceNodeCommand].UpdateUintParam(netparams.StakingAndDelegationRewardMinimumValidatorStake, minTokensForJoiningValidator)
}
// OnEpochEvent is a callback for epoch events.
func (e *Engine) OnEpochEvent(ctx context.Context, epoch types.Epoch) {
e.log.Info("Spam protection OnEpochEvent called", logging.Uint64("epoch", epoch.Seq))
if e.currentEpoch == nil || e.currentEpoch.Seq != epoch.Seq {
if e.log.GetLevel() <= logging.DebugLevel {
e.log.Debug("Spam protection new epoch started", logging.Uint64("epochSeq", epoch.Seq))
}
e.currentEpoch = &epoch
for _, policy := range e.transactionTypeToPolicy {
policy.Reset(epoch)
}
}
}
// EndOfBlock is called when the block is finished.
func (e *Engine) EndOfBlock(blockHeight uint64) {
if e.log.GetLevel() <= logging.DebugLevel {
e.log.Debug("Spam protection EndOfBlock called", logging.Uint64("blockHeight", blockHeight))
}
for _, policy := range e.transactionTypeToPolicy {
policy.EndOfBlock(blockHeight)
}
}
// PreBlockAccept is called from onCheckTx before a tx is added to mempool
// returns false is rejected by spam engine with a corresponding error.
func (e *Engine) PreBlockAccept(tx abci.Tx) (bool, error) {
command := tx.Command()
if _, ok := e.transactionTypeToPolicy[command]; !ok {
return true, nil
}
if e.log.GetLevel() <= logging.DebugLevel {
e.log.Debug("Spam protection PreBlockAccept called for policy", logging.String("txHash", hex.EncodeToString(tx.Hash())), logging.String("command", command.String()))
}
return e.transactionTypeToPolicy[command].PreBlockAccept(tx)
}
// PostBlockAccept is called from onDeliverTx before the block is processed
// returns false is rejected by spam engine with a corresponding error.
func (e *Engine) PostBlockAccept(tx abci.Tx) (bool, error) {
command := tx.Command()
if _, ok := e.transactionTypeToPolicy[command]; !ok {
return true, nil
}
if e.log.GetLevel() <= logging.DebugLevel {
e.log.Debug("Spam protection PostBlockAccept called for policy", logging.String("txHash", hex.EncodeToString(tx.Hash())), logging.String("command", command.String()))
}
return e.transactionTypeToPolicy[command].PostBlockAccept(tx)
}