/
params.go
117 lines (100 loc) · 3.04 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
// Copyright 2022 Hekas Foundation
// This file is part of the Hekas Network packages.
//
// Hekas 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 Hekas packages are 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 Hekas packages. If not, see https://github.com/hekas-network/hekas/blob/main/LICENSE
package types
import (
"errors"
"fmt"
sdk "github.com/cosmos/cosmos-sdk/types"
epochstypes "github.com/hekas-network/hekas/x/epochs/types"
)
// ParamsKey params store key
var ParamsKey = []byte("Params")
var (
DefaultEnableIncentives = true
DefaultAllocationLimit = sdk.NewDecWithPrec(625, 5)
DefaultIncentivesEpochIdentifier = epochstypes.WeekEpochID
DefaultRewardScalar = sdk.NewDecWithPrec(15, 2)
)
// NewParams creates a new Params object
func NewParams(
enableIncentives bool,
allocationLimit sdk.Dec,
epochIdentifier string,
rewardScaler sdk.Dec,
) Params {
return Params{
EnableIncentives: enableIncentives,
AllocationLimit: allocationLimit,
IncentivesEpochIdentifier: epochIdentifier,
RewardScaler: rewardScaler,
}
}
func DefaultParams() Params {
return Params{
EnableIncentives: DefaultEnableIncentives,
AllocationLimit: DefaultAllocationLimit,
IncentivesEpochIdentifier: DefaultIncentivesEpochIdentifier,
RewardScaler: DefaultRewardScalar,
}
}
func validateBool(i interface{}) error {
_, ok := i.(bool)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
return nil
}
func validatePercentage(i interface{}) error {
dec, ok := i.(sdk.Dec)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if dec.IsNil() {
return errors.New("allocation limit cannot be nil")
}
if dec.IsNegative() {
return fmt.Errorf("allocation limit must be positive: %s", dec)
}
if dec.GT(sdk.OneDec()) {
return fmt.Errorf("allocation limit must <= 100: %s", dec)
}
return nil
}
func validateUncappedPercentage(i interface{}) error {
dec, ok := i.(sdk.Dec)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if dec.IsNil() {
return errors.New("allocation limit cannot be nil")
}
if dec.IsNegative() {
return fmt.Errorf("allocation limit must be positive: %s", dec)
}
return nil
}
func (p Params) Validate() error {
if err := validateBool(p.EnableIncentives); err != nil {
return err
}
if err := validatePercentage(p.AllocationLimit); err != nil {
return err
}
if err := validateUncappedPercentage(p.RewardScaler); err != nil {
return err
}
return epochstypes.ValidateEpochIdentifierString(p.IncentivesEpochIdentifier)
}