/
params.go
345 lines (290 loc) · 9.17 KB
/
params.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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
package types
import (
"fmt"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
"github.com/cosmos/cosmos-sdk/x/gov/types"
params "github.com/cosmos/cosmos-sdk/x/params/types"
gethParams "github.com/ethereum/go-ethereum/params"
"github.com/axelarnetwork/axelar-core/utils"
"github.com/axelarnetwork/axelar-core/x/evm/exported"
nexus "github.com/axelarnetwork/axelar-core/x/nexus/exported"
)
// Parameter keys
var (
KeyChain = []byte("chain")
KeyConfirmationHeight = []byte("confirmationHeight")
KeyNetwork = []byte("network")
KeyRevoteLockingPeriod = []byte("revoteLockingPeriod")
KeyNetworks = []byte("networks")
KeyVotingThreshold = []byte("votingThreshold")
KeyToken = []byte("token")
KeyBurnable = []byte("burnable")
KeyMinVoterCount = []byte("minVoterCount")
KeyCommandsGasLimit = []byte("commandsGasLimit")
KeyVotingGracePeriod = []byte("votingGracePeriod")
KeyEndBlockerLimit = []byte("endBlockerLimit")
KeyTransferLimit = []byte("transferLimit")
)
// KeyTable returns a subspace.KeyTable that has registered all parameter types in this module's parameter set
func KeyTable() params.KeyTable {
return params.NewKeyTable().RegisterParamSet(&Params{})
}
// DefaultParams returns the module's parameter set initialized with default values
func DefaultParams() []Params {
bzToken, err := utils.HexDecode(Token)
if err != nil {
panic(err)
}
bzBurnable, err := utils.HexDecode(Burnable)
if err != nil {
panic(err)
}
return []Params{{
Chain: exported.Ethereum.Name,
ConfirmationHeight: 1,
Network: Ganache,
TokenCode: bzToken,
Burnable: bzBurnable,
RevoteLockingPeriod: 50,
Networks: []NetworkInfo{
{
Name: Mainnet,
Id: sdk.NewIntFromBigInt(gethParams.MainnetChainConfig.ChainID),
},
{
Name: Ropsten,
Id: sdk.NewIntFromBigInt(gethParams.RopstenChainConfig.ChainID),
},
{
Name: Rinkeby,
Id: sdk.NewIntFromBigInt(gethParams.RinkebyChainConfig.ChainID),
},
{
Name: Goerli,
Id: sdk.NewIntFromBigInt(gethParams.GoerliChainConfig.ChainID),
},
{
Name: Ganache,
Id: sdk.NewIntFromBigInt(gethParams.AllCliqueProtocolChanges.ChainID),
},
},
VotingThreshold: utils.Threshold{Numerator: 51, Denominator: 100},
VotingGracePeriod: 3,
MinVoterCount: 1,
CommandsGasLimit: 5000000,
EndBlockerLimit: 50,
TransferLimit: 50,
}}
}
// ParamSetPairs implements the ParamSet interface and returns all the key/value pairs
// pairs of evm module's parameters.
func (m *Params) ParamSetPairs() params.ParamSetPairs {
/*
because the subspace package makes liberal use of pointers to set and get values from the store,
this method needs to have a pointer receiver AND NewParamSetPair needs to receive the
parameter values as pointer arguments, otherwise either the internal type reflection panics or the value will not be
set on the correct Params data struct
*/
return params.ParamSetPairs{
params.NewParamSetPair(KeyChain, &m.Chain, validateChain),
params.NewParamSetPair(KeyConfirmationHeight, &m.ConfirmationHeight, validateConfirmationHeight),
params.NewParamSetPair(KeyNetwork, &m.Network, validateNetwork),
params.NewParamSetPair(KeyToken, &m.TokenCode, validateBytes),
params.NewParamSetPair(KeyBurnable, &m.Burnable, validateBurnable),
params.NewParamSetPair(KeyRevoteLockingPeriod, &m.RevoteLockingPeriod, validateRevoteLockingPeriod),
params.NewParamSetPair(KeyNetworks, &m.Networks, validateNetworks),
params.NewParamSetPair(KeyVotingThreshold, &m.VotingThreshold, validateVotingThreshold),
params.NewParamSetPair(KeyMinVoterCount, &m.MinVoterCount, validateMinVoterCount),
params.NewParamSetPair(KeyCommandsGasLimit, &m.CommandsGasLimit, validateCommandsGasLimit),
params.NewParamSetPair(KeyVotingGracePeriod, &m.VotingGracePeriod, validateVotingGracePeriod),
params.NewParamSetPair(KeyEndBlockerLimit, &m.EndBlockerLimit, validateEndBlockerLimit),
params.NewParamSetPair(KeyTransferLimit, &m.TransferLimit, validateTransferLimit),
}
}
func validateChain(chain interface{}) error {
c, ok := chain.(nexus.ChainName)
if !ok {
return fmt.Errorf("invalid parameter type for chain: %T", chain)
}
err := c.Validate()
if err != nil {
return sdkerrors.Wrap(types.ErrInvalidGenesis, "invalid chain name")
}
return nil
}
func validateNetwork(network interface{}) error {
n, ok := network.(string)
if !ok {
return fmt.Errorf("invalid parameter type for network: %T", network)
}
if n == "" {
return sdkerrors.Wrap(types.ErrInvalidGenesis, "network name cannot be an empty string")
}
return nil
}
func validateConfirmationHeight(height interface{}) error {
h, ok := height.(uint64)
if !ok {
return fmt.Errorf("invalid parameter type for confirmation height: %T", height)
}
if h < 1 {
return sdkerrors.Wrap(types.ErrInvalidGenesis, "transaction confirmation height must be greater than 0")
}
return nil
}
func validateBytes(bytes interface{}) error {
b, ok := bytes.([]byte)
if !ok {
return fmt.Errorf("invalid parameter type for byte slice: %T", bytes)
}
if len(b) == 0 {
return fmt.Errorf("byte slice cannot be empty")
}
return nil
}
func validateRevoteLockingPeriod(revoteLockingPeriod interface{}) error {
r, ok := revoteLockingPeriod.(int64)
if !ok {
return fmt.Errorf("invalid parameter type for revote lock period: %T", r)
}
if r <= 0 {
return sdkerrors.Wrap(types.ErrInvalidGenesis, "revote lock period must be >0")
}
return nil
}
func validateVotingGracePeriod(votingGracePeriod interface{}) error {
r, ok := votingGracePeriod.(int64)
if !ok {
return fmt.Errorf("invalid parameter type for voting grace period: %T", r)
}
if r < 0 {
return sdkerrors.Wrap(types.ErrInvalidGenesis, "voting grace period must be >=0")
}
return nil
}
func validateNetworks(network interface{}) error {
networks, ok := network.([]NetworkInfo)
if !ok {
return fmt.Errorf("invalid parameter type for networks: %T", network)
}
for _, n := range networks {
if n.Name == "" {
return sdkerrors.Wrap(types.ErrInvalidGenesis, "network name cannot be an empty string")
}
if !n.Id.IsPositive() {
return fmt.Errorf("network chain id must be positive")
}
}
return nil
}
func validateVotingThreshold(votingThreshold interface{}) error {
val, ok := votingThreshold.(utils.Threshold)
if !ok {
return fmt.Errorf("invalid parameter type for VotingThreshold: %T", votingThreshold)
}
if err := val.Validate(); err != nil {
return sdkerrors.Wrap(err, "invalid VotingThreshold")
}
return nil
}
func validateMinVoterCount(minVoterCount interface{}) error {
val, ok := minVoterCount.(int64)
if !ok {
return fmt.Errorf("invalid parameter type for MinVoterCount: %T", minVoterCount)
}
if val < 1 {
return fmt.Errorf("min voter count must be >=1")
}
return nil
}
func validateCommandsGasLimit(commandsGasLimit interface{}) error {
val, ok := commandsGasLimit.(uint32)
if !ok {
return fmt.Errorf("invalid parameter type for commands gas limit: %T", commandsGasLimit)
}
if val <= 0 {
return fmt.Errorf("commands gas limit must be >0")
}
return nil
}
func validateBurnable(i interface{}) error {
if err := validateBytes(i); err != nil {
return err
}
if err := validateBurnerCode(i.([]byte)); err != nil {
return err
}
return nil
}
func validateEndBlockerLimit(limit interface{}) error {
h, ok := limit.(int64)
if !ok {
return fmt.Errorf("invalid parameter type for end blocker limit: %T", limit)
}
if h <= 0 {
return fmt.Errorf("end blocker limit must be >0")
}
return nil
}
func validateTransferLimit(limit interface{}) error {
h, ok := limit.(uint64)
if !ok {
return fmt.Errorf("invalid parameter type for transfer limit: %T", limit)
}
if h == 0 {
return fmt.Errorf("transfer limit must be >0")
}
return nil
}
// Validate checks the validity of the values of the parameter set
func (m Params) Validate() error {
if err := validateConfirmationHeight(m.ConfirmationHeight); err != nil {
return err
}
if err := validateNetwork(m.Network); err != nil {
return err
}
if err := validateRevoteLockingPeriod(m.RevoteLockingPeriod); err != nil {
return err
}
if err := validateVotingGracePeriod(m.VotingGracePeriod); err != nil {
return err
}
if m.VotingGracePeriod >= m.RevoteLockingPeriod {
return fmt.Errorf("voting grace period must be < revote locking period")
}
if err := validateVotingThreshold(m.VotingThreshold); err != nil {
return err
}
if err := validateMinVoterCount(m.MinVoterCount); err != nil {
return err
}
if err := validateCommandsGasLimit(m.CommandsGasLimit); err != nil {
return err
}
// ensure that the network is one of the supported ones
found := false
for _, n := range m.Networks {
if n.Name == m.Network {
found = true
break
}
}
if !found {
return fmt.Errorf("'%s' not part of the network list", m.Network)
}
if err := validateBytes(m.TokenCode); err != nil {
return err
}
if err := validateBurnable(m.Burnable); err != nil {
return err
}
if err := validateEndBlockerLimit(m.EndBlockerLimit); err != nil {
return err
}
if err := validateTransferLimit(m.TransferLimit); err != nil {
return err
}
return nil
}