/
params.go
155 lines (130 loc) · 3.87 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
package types
import (
"errors"
"fmt"
"strings"
time "time"
yaml "gopkg.in/yaml.v2"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
)
// Parameter store keys
var (
KeyMintDenom = []byte("MintDenom")
KeyStartTime = []byte("StartTime")
KeyInitialAnnualProvisions = []byte("InitialAnnualProvisions")
KeyReductionFactor = []byte("ReductionFactor")
KeyBlocksPerYear = []byte("BlocksPerYear")
)
// ParamTable for minting module.
func ParamKeyTable() paramtypes.KeyTable {
return paramtypes.NewKeyTable().RegisterParamSet(&Params{})
}
func NewParams(
mintDenom string, startTime time.Time, initialAnnualProvisions, reductionFactor sdk.Dec, blocksPerYear uint64,
) Params {
return Params{
MintDenom: mintDenom,
StartTime: startTime,
InitialAnnualProvisions: initialAnnualProvisions,
ReductionFactor: reductionFactor,
BlocksPerYear: blocksPerYear,
}
}
// default minting module parameters
func DefaultParams() Params {
return Params{
MintDenom: sdk.DefaultBondDenom,
StartTime: time.Now().AddDate(1, 0, 0), // 1 year from now
InitialAnnualProvisions: sdk.NewDec(1_000_000_000_000_000), // 1B
ReductionFactor: sdk.NewDec(2).QuoInt64(3), // 2/3
BlocksPerYear: uint64(6311520), // 60 * 60 * 8766 / 5 = 6,311,520
// assuming 5 second block times
}
}
// validate params
func (p Params) Validate() error {
if err := validateMintDenom(p.MintDenom); err != nil {
return err
}
if err := validateStartTime(p.StartTime); err != nil {
return err
}
if err := validateStartProvisions(p.InitialAnnualProvisions); err != nil {
return err
}
if err := validateReductionFactor(p.ReductionFactor); err != nil {
return err
}
err := validateBlocksPerYear(p.BlocksPerYear)
return err
}
// String implements the Stringer interface.
func (p Params) String() string {
out, _ := yaml.Marshal(p)
return string(out)
}
// Implements params.ParamSet
func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs {
return paramtypes.ParamSetPairs{
paramtypes.NewParamSetPair(KeyMintDenom, &p.MintDenom, validateMintDenom),
paramtypes.NewParamSetPair(KeyStartTime, &p.StartTime, validateStartTime),
paramtypes.NewParamSetPair(KeyInitialAnnualProvisions, &p.InitialAnnualProvisions, validateStartProvisions),
paramtypes.NewParamSetPair(KeyReductionFactor, &p.ReductionFactor, validateReductionFactor),
paramtypes.NewParamSetPair(KeyBlocksPerYear, &p.BlocksPerYear, validateBlocksPerYear),
}
}
func validateMintDenom(i interface{}) error {
v, ok := i.(string)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if strings.TrimSpace(v) == "" {
return errors.New("mint denom cannot be blank")
}
err := sdk.ValidateDenom(v)
return err
}
func validateStartTime(i interface{}) error {
v, ok := i.(time.Time)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if v.IsZero() {
return fmt.Errorf("start time cannot be zero value: %s", v)
}
return nil
}
func validateStartProvisions(i interface{}) error {
v, ok := i.(sdk.Dec)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if v.IsNegative() {
return fmt.Errorf("start provisions cannot be negative")
}
return nil
}
func validateReductionFactor(i interface{}) error {
v, ok := i.(sdk.Dec)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if v.GT(sdk.NewDec(1)) {
return fmt.Errorf("reduction factor cannot be greater than 1")
}
if v.IsNegative() {
return fmt.Errorf("reduction factor cannot be negative")
}
return nil
}
func validateBlocksPerYear(i interface{}) error {
v, ok := i.(uint64)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if v == 0 {
return fmt.Errorf("blocks per year must be positive: %d", v)
}
return nil
}