-
Notifications
You must be signed in to change notification settings - Fork 11
/
governance_proposal.go
393 lines (336 loc) · 12.2 KB
/
governance_proposal.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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
package types
import (
"fmt"
"strings"
sdktypes "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
)
const (
ProposalTypeRegisterHostChain = "RegisterHostChain"
ProposalTypeMinDepositAndFeeChange = "MinDepositAndFeeChange"
ProposalPstakeFeeAddressChange = "PstakeFeeAddressChange"
ProposalAllowListedValidatorSetChange = "AllowListedValidatorSetChange"
)
var (
_ govtypes.Content = &RegisterHostChainProposal{}
_ govtypes.Content = &MinDepositAndFeeChangeProposal{}
_ govtypes.Content = &PstakeFeeAddressChangeProposal{}
_ govtypes.Content = &AllowListedValidatorSetChangeProposal{}
)
func init() {
govtypes.RegisterProposalType(ProposalTypeRegisterHostChain)
govtypes.RegisterProposalTypeCodec(&RegisterHostChainProposal{}, "pstake/RegisterHostChain")
govtypes.RegisterProposalType(ProposalTypeMinDepositAndFeeChange)
govtypes.RegisterProposalTypeCodec(&MinDepositAndFeeChangeProposal{}, "pstake/MinDepositAndFeeChange")
govtypes.RegisterProposalType(ProposalPstakeFeeAddressChange)
govtypes.RegisterProposalTypeCodec(&PstakeFeeAddressChangeProposal{}, "pstake/PstakeFeeAddressChange")
govtypes.RegisterProposalType(ProposalAllowListedValidatorSetChange)
govtypes.RegisterProposalTypeCodec(&AllowListedValidatorSetChangeProposal{}, "pstake/AllowListedValidatorSetChange")
}
// NewRegisterHostChainProposal creates a new host chain register proposal.
func NewRegisterHostChainProposal(title, description string, moduleEnabled bool, chainID, connectionID, transferChannel,
transferPort, baseDenom, mintDenom, pstakeFeeAddress string, minDeposit sdktypes.Int, allowListedValidators AllowListedValidators,
pstakeDepositFee, pstakeRestakeFee, pstakeUnstakeFee, pstakeRedemptionFee sdktypes.Dec) *RegisterHostChainProposal {
return &RegisterHostChainProposal{
Title: title,
Description: description,
ModuleEnabled: moduleEnabled,
ChainID: chainID,
ConnectionID: connectionID,
TransferChannel: transferChannel,
TransferPort: transferPort,
BaseDenom: baseDenom,
MintDenom: mintDenom,
MinDeposit: minDeposit,
AllowListedValidators: allowListedValidators,
PstakeParams: PstakeParams{
PstakeDepositFee: pstakeDepositFee,
PstakeRestakeFee: pstakeRestakeFee,
PstakeUnstakeFee: pstakeUnstakeFee,
PstakeRedemptionFee: pstakeRedemptionFee,
PstakeFeeAddress: pstakeFeeAddress,
},
}
}
// GetTitle returns the title of the host chain register proposal.
func (m *RegisterHostChainProposal) GetTitle() string {
return m.Title
}
// GetDescription returns the description of host chain register proposal.
func (m *RegisterHostChainProposal) GetDescription() string {
return m.Description
}
// ProposalRoute returns the proposal route of host chain register proposal.
func (m *RegisterHostChainProposal) ProposalRoute() string {
return RouterKey
}
// ProposalType returns the proposal type of host chain register proposal.
func (m *RegisterHostChainProposal) ProposalType() string {
return ProposalTypeRegisterHostChain
}
// ValidateBasic runs basic stateless validity checks
func (m *RegisterHostChainProposal) ValidateBasic() error {
err := govtypes.ValidateAbstract(m)
if err != nil {
return err
}
if !m.AllowListedValidators.Valid() {
return sdkerrors.Wrapf(ErrInValidAllowListedValidators, "allow listed validators is not valid")
}
if m.BaseDenom == m.MintDenom {
//TODO enforce mintdenom => stk/basedenom it in future versions
return ErrEqualBaseAndMintDenom
}
err = m.PstakeParams.Validate()
if err != nil {
return err
}
if m.MinDeposit.LTE(sdktypes.ZeroInt()) {
return sdkerrors.Wrapf(ErrInvalidDeposit, "min deposit must be positive")
}
return nil
}
// String returns the string of proposal details
func (m *RegisterHostChainProposal) String() string {
var b strings.Builder
b.WriteString(fmt.Sprintf(`Register host chain:
Title: %s
Description: %s
ModuleEnabled: %v
ConnectionID: %s
TransferChannel: %s
TransferPort: %s
BaseDenom: %s
MintDenom: %s
AllowlistedValidators: %s
PstakeDepositFee: %s
PstakeRestakeFee: %s
PstakeUnstakeFee: %s
PstakeRedemptionFee: %s
`,
m.Title,
m.Description,
m.ModuleEnabled,
m.ConnectionID,
m.TransferChannel,
m.TransferPort,
m.BaseDenom,
m.MintDenom,
m.AllowListedValidators,
m.PstakeParams.PstakeDepositFee,
m.PstakeParams.PstakeRestakeFee,
m.PstakeParams.PstakeUnstakeFee,
m.PstakeParams.PstakeRedemptionFee),
)
return b.String()
}
// NewHostChainParams returns HostChainParams with the input provided
func NewHostChainParams(chainID, connectionID, channel, port, baseDenom, mintDenom, pstakefeeAddress string, minDeposit sdktypes.Int, pstakeDepositFee, pstakeRestakeFee, pstakeUnstakeFee, pstakeRedemptionFee sdktypes.Dec) HostChainParams {
return HostChainParams{
ChainID: chainID,
ConnectionID: connectionID,
TransferChannel: channel,
TransferPort: port,
BaseDenom: baseDenom,
MintDenom: mintDenom,
MinDeposit: minDeposit,
PstakeParams: PstakeParams{
PstakeDepositFee: pstakeDepositFee,
PstakeRestakeFee: pstakeRestakeFee,
PstakeUnstakeFee: pstakeUnstakeFee,
PstakeRedemptionFee: pstakeRedemptionFee,
PstakeFeeAddress: pstakefeeAddress,
},
}
}
// IsEmpty Checks if HostChainParams were initialised
func (c *HostChainParams) IsEmpty() bool {
if c.TransferChannel == "" ||
c.TransferPort == "" ||
c.ConnectionID == "" ||
c.ChainID == "" ||
c.BaseDenom == "" ||
c.MintDenom == "" ||
c.PstakeParams.PstakeFeeAddress == "" {
return true
}
// can add more, but this should be good enough
return false
}
// NewMinDepositAndFeeChangeProposal creates a protocol fee and min deposit change proposal.
func NewMinDepositAndFeeChangeProposal(title, description string, minDeposit sdktypes.Int, pstakeDepositFee,
pstakeRestakeFee, pstakeUnstakeFee, pstakeRedemptionFee sdktypes.Dec) *MinDepositAndFeeChangeProposal {
return &MinDepositAndFeeChangeProposal{
Title: title,
Description: description,
MinDeposit: minDeposit,
PstakeDepositFee: pstakeDepositFee,
PstakeRestakeFee: pstakeRestakeFee,
PstakeUnstakeFee: pstakeUnstakeFee,
PstakeRedemptionFee: pstakeRedemptionFee,
}
}
// GetTitle returns the title of the min-deposit and fee change proposal.
func (m *MinDepositAndFeeChangeProposal) GetTitle() string {
return m.Title
}
// GetDescription returns the description of the min-deposit and fee change proposal.
func (m *MinDepositAndFeeChangeProposal) GetDescription() string {
return m.Description
}
// ProposalRoute returns the proposal-route of the min-deposit and fee change proposal.
func (m *MinDepositAndFeeChangeProposal) ProposalRoute() string {
return RouterKey
}
// ProposalType returns the proposal-type of the min-deposit and fee change proposal.
func (m *MinDepositAndFeeChangeProposal) ProposalType() string {
return ProposalTypeMinDepositAndFeeChange
}
// ValidateBasic runs basic stateless validity checks
func (m *MinDepositAndFeeChangeProposal) ValidateBasic() error {
err := govtypes.ValidateAbstract(m)
if err != nil {
return err
}
if m.PstakeDepositFee.IsNegative() || m.PstakeDepositFee.GTE(MaxPstakeDepositFee) {
return sdkerrors.Wrapf(ErrInvalidFee, "pstake deposit fee must be between %s and %s", sdktypes.ZeroDec(), MaxPstakeDepositFee)
}
if m.PstakeRestakeFee.IsNegative() || m.PstakeRestakeFee.GTE(MaxPstakeRestakeFee) {
return sdkerrors.Wrapf(ErrInvalidFee, "pstake restake fee must be between %s and %s", sdktypes.ZeroDec(), MaxPstakeRestakeFee)
}
if m.PstakeUnstakeFee.IsNegative() || m.PstakeUnstakeFee.GTE(MaxPstakeUnstakeFee) {
return sdkerrors.Wrapf(ErrInvalidFee, "pstake unstake fee must be between %s and %s", sdktypes.ZeroDec(), MaxPstakeUnstakeFee)
}
if m.PstakeRedemptionFee.IsNegative() || m.PstakeRedemptionFee.GTE(MaxPstakeRedemptionFee) {
return sdkerrors.Wrapf(ErrInvalidFee, "pstake redemption fee must be between %s and %s", sdktypes.ZeroDec(), MaxPstakeRedemptionFee)
}
if m.MinDeposit.LTE(sdktypes.ZeroInt()) {
return sdkerrors.Wrapf(ErrInvalidDeposit, "min deposit must be positive")
}
return nil
}
// String returns the string of proposal details
func (m *MinDepositAndFeeChangeProposal) String() string {
var b strings.Builder
b.WriteString(fmt.Sprintf(`MinDepositAndFeeChange:
Title: %s
Description: %s
MinDeposit: %s
PstakeDepositFee: %s
PstakeRestakeFee: %s
PstakeUnstakeFee: %s
PstakeRedemptionFee: %s
`,
m.Title,
m.Description,
m.MinDeposit,
m.PstakeDepositFee,
m.PstakeRestakeFee,
m.PstakeUnstakeFee,
m.PstakeRedemptionFee),
)
return b.String()
}
// NewPstakeFeeAddressChangeProposal creates a pstake fee address change proposal.
func NewPstakeFeeAddressChangeProposal(title, description,
pstakeFeeAddress string) *PstakeFeeAddressChangeProposal {
return &PstakeFeeAddressChangeProposal{
Title: title,
Description: description,
PstakeFeeAddress: pstakeFeeAddress,
}
}
// GetTitle returns the title of fee collector pstake fee address change proposal.
func (m *PstakeFeeAddressChangeProposal) GetTitle() string {
return m.Title
}
// GetDescription returns the description of the pstake fee address proposal.
func (m *PstakeFeeAddressChangeProposal) GetDescription() string {
return m.Description
}
// ProposalRoute returns the proposal-route of pstake fee address proposal.
func (m *PstakeFeeAddressChangeProposal) ProposalRoute() string {
return RouterKey
}
// ProposalType returns the proposal-type of pstake fee address change proposal.
func (m *PstakeFeeAddressChangeProposal) ProposalType() string {
return ProposalPstakeFeeAddressChange
}
// ValidateBasic runs basic stateless validity checks
func (m *PstakeFeeAddressChangeProposal) ValidateBasic() error {
err := govtypes.ValidateAbstract(m)
if err != nil {
return err
}
_, err = sdktypes.AccAddressFromBech32(m.PstakeFeeAddress)
if err != nil {
return err
}
return nil
}
// String returns the string of proposal details
func (m *PstakeFeeAddressChangeProposal) String() string {
var b strings.Builder
b.WriteString(fmt.Sprintf(`PstakeFeeAddressChange:
Title: %s
Description: %s
PstakeFeeAddress: %s
`,
m.Title,
m.Description,
m.PstakeFeeAddress,
),
)
return b.String()
}
// NewAllowListedValidatorSetChangeProposal creates a allowListed validator set change proposal.
func NewAllowListedValidatorSetChangeProposal(title, description string, allowListedValidators AllowListedValidators) *AllowListedValidatorSetChangeProposal {
return &AllowListedValidatorSetChangeProposal{
Title: title,
Description: description,
AllowListedValidators: allowListedValidators,
}
}
// GetTitle returns the title of allowListed validator set change proposal.
func (m *AllowListedValidatorSetChangeProposal) GetTitle() string {
return m.Title
}
// GetDescription returns the description of allowListed validator set change proposal.
func (m *AllowListedValidatorSetChangeProposal) GetDescription() string {
return m.Description
}
// ProposalRoute returns the proposal-route of allowListed validator set change proposal.
func (m *AllowListedValidatorSetChangeProposal) ProposalRoute() string {
return RouterKey
}
// ProposalType returns the proposal-type of allowListed validator set change proposal.
func (m *AllowListedValidatorSetChangeProposal) ProposalType() string {
return ProposalAllowListedValidatorSetChange
}
// ValidateBasic runs basic stateless validity checks
func (m *AllowListedValidatorSetChangeProposal) ValidateBasic() error {
err := govtypes.ValidateAbstract(m)
if err != nil {
return err
}
if !m.AllowListedValidators.Valid() {
return sdkerrors.Wrapf(ErrInValidAllowListedValidators, "allow listed validators is not valid")
}
return nil
}
// String returns the string of proposal details
func (m *AllowListedValidatorSetChangeProposal) String() string {
var b strings.Builder
b.WriteString(fmt.Sprintf(`AllowListedValidatorSetChange:
Title: %s
Description: %s
AllowListedValidators: %s
`,
m.Title,
m.Description,
m.AllowListedValidators,
),
)
return b.String()
}