-
Notifications
You must be signed in to change notification settings - Fork 19
/
params.go
200 lines (166 loc) · 5.2 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
package types
import (
bytes "bytes"
"encoding/hex"
"errors"
"fmt"
"math"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
"github.com/ethereum/go-ethereum/common"
)
// Parameter keys and default values
var (
KeyBridgeEnabled = []byte("BridgeEnabled")
KeyEnabledERC20Tokens = []byte("EnabledERC20Tokens")
KeyRelayer = []byte("Relayer")
KeyEnabledConversionPairs = []byte("EnabledConversionPairs")
DefaultBridgeEnabled = false
DefaultEnabledERC20Tokens = EnabledERC20Tokens{}
DefaultRelayer = sdk.AccAddress{}
DefaultConversionPairs = ConversionPairs{}
)
// ParamKeyTable for bridge module.
func ParamKeyTable() paramtypes.KeyTable {
return paramtypes.NewKeyTable().RegisterParamSet(&Params{})
}
// ParamSetPairs implements the ParamSet interface and returns all the key/value
// pairs pairs of the bridge module's parameters.
func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs {
return paramtypes.ParamSetPairs{
paramtypes.NewParamSetPair(KeyBridgeEnabled, &p.BridgeEnabled, validateBool),
paramtypes.NewParamSetPair(KeyEnabledERC20Tokens, &p.EnabledERC20Tokens, validateEnabledERC20Tokens),
paramtypes.NewParamSetPair(KeyRelayer, &p.Relayer, validateRelayer),
paramtypes.NewParamSetPair(KeyEnabledConversionPairs, &p.EnabledConversionPairs, validateConversionPairs),
}
}
// NewParams returns new bridge module Params.
func NewParams(
bridgeEnabled bool,
enabledERC20Tokens EnabledERC20Tokens,
relayer sdk.AccAddress,
conversionPairs ConversionPairs,
) Params {
return Params{
BridgeEnabled: bridgeEnabled,
EnabledERC20Tokens: enabledERC20Tokens,
Relayer: relayer,
EnabledConversionPairs: conversionPairs,
}
}
// DefaultParams returns the default parameters for bridge.
func DefaultParams() Params {
return NewParams(
DefaultBridgeEnabled,
DefaultEnabledERC20Tokens,
DefaultRelayer,
DefaultConversionPairs,
)
}
func (p *Params) Validate() error {
if err := p.EnabledERC20Tokens.Validate(); err != nil {
return err
}
if p.Relayer == nil {
return errors.New("relayer cannot be nil")
}
if err := p.EnabledConversionPairs.Validate(); err != nil {
return err
}
return nil
}
func validateBool(i interface{}) error {
_, ok := i.(bool)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
return nil
}
// validateEnabledERC20Tokens validates an interface as EnabledERC20Tokens
func validateEnabledERC20Tokens(i interface{}) error {
enabledERC20Tokens, ok := i.(EnabledERC20Tokens)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
return enabledERC20Tokens.Validate()
}
// EnabledERC20Tokens defines a slice of EnabledERC20Token
type EnabledERC20Tokens []EnabledERC20Token
// NewEnabledERC20Tokens returns EnabledERC20Tokens from the provided values
func NewEnabledERC20Tokens(enabledERC20Tokens ...EnabledERC20Token) EnabledERC20Tokens {
return EnabledERC20Tokens(enabledERC20Tokens)
}
// Validate returns an error if any token in a slice of EnabledERC20Tokens is
// invalid.
func (tokens EnabledERC20Tokens) Validate() error {
// Check for duplicates
addrs := map[string]bool{}
for _, token := range tokens {
if addrs[hex.EncodeToString(token.Address)] {
return fmt.Errorf(
"found duplicate enabled ERC20 token address %s",
hex.EncodeToString(token.Address),
)
}
if err := token.Validate(); err != nil {
return err
}
addrs[hex.EncodeToString(token.Address)] = true
}
return nil
}
// NewEnabledERC20Token returns a new EnabledERC20Token.
func NewEnabledERC20Token(
address ExternalEVMAddress,
name string,
symbol string,
decimals uint32,
minimum_withdraw_amount sdk.Int,
) EnabledERC20Token {
return EnabledERC20Token{
Address: address.Bytes(),
Name: name,
Symbol: symbol,
Decimals: decimals,
MinimumWithdrawAmount: minimum_withdraw_amount,
}
}
// Validate returns an error if the EnabledERC20Token is invalid.
func (e EnabledERC20Token) Validate() error {
if len(e.Address) != common.AddressLength {
return fmt.Errorf("address length is %v but expected %v", len(e.Address), common.AddressLength)
}
if bytes.Equal(e.Address, common.Address{}.Bytes()) {
return fmt.Errorf("address cannot be zero value %v", hex.EncodeToString(e.Address))
}
if e.Name == "" {
return fmt.Errorf("name cannot be empty")
}
if e.Symbol == "" {
return fmt.Errorf("symbol cannot be empty")
}
// Decimals being 0 is technically allowed in ERC20, but unlikely
if e.Decimals == 0 {
return fmt.Errorf("decimals cannot be 0")
}
// Check size since the go type is uint32 from proto int, but the actual
// size of erc20 decimals should be an uint8
if e.Decimals > math.MaxUint8 {
return fmt.Errorf("decimals is too large, max %v", math.MaxUint8)
}
if e.MinimumWithdrawAmount.LTE(sdk.ZeroInt()) {
return fmt.Errorf("minimum withdraw amount must be positive")
}
return nil
}
// validateRelayer validates a relayer address
func validateRelayer(i interface{}) error {
relayerAddr, ok := i.(sdk.AccAddress)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if relayerAddr == nil {
return errors.New("relayer address cannot be nil")
}
return nil
}