-
Notifications
You must be signed in to change notification settings - Fork 55
/
proposal.go
252 lines (226 loc) · 7.36 KB
/
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
package types
import (
"fmt"
"time"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
gov "github.com/cosmos/cosmos-sdk/x/gov/types"
)
const (
ProposalTypePublicPlan string = "PublicPlan"
)
// Implements Proposal Interface
var _ gov.Content = &PublicPlanProposal{}
func init() {
gov.RegisterProposalType(ProposalTypePublicPlan)
gov.RegisterProposalTypeCodec(&PublicPlanProposal{}, "cosmos-sdk/PublicPlanProposal") // TODO: change prefix
}
// NewPublicPlanProposal creates a new PublicPlanProposal object.
func NewPublicPlanProposal(
title string,
description string,
addReqs []AddPlanRequest,
modifyReqs []ModifyPlanRequest,
deleteReqs []DeletePlanRequest,
) *PublicPlanProposal {
return &PublicPlanProposal{
Title: title,
Description: description,
AddPlanRequests: addReqs,
ModifyPlanRequests: modifyReqs,
DeletePlanRequests: deleteReqs,
}
}
func (p *PublicPlanProposal) GetTitle() string { return p.Title }
func (p *PublicPlanProposal) GetDescription() string { return p.Description }
func (p *PublicPlanProposal) ProposalRoute() string { return RouterKey }
func (p *PublicPlanProposal) ProposalType() string { return ProposalTypePublicPlan }
func (p *PublicPlanProposal) ValidateBasic() error {
if len(p.AddPlanRequests) == 0 && len(p.ModifyPlanRequests) == 0 && len(p.DeletePlanRequests) == 0 {
return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "proposal request must not be empty")
}
for _, ap := range p.AddPlanRequests {
if err := ap.Validate(); err != nil {
return err
}
}
for _, up := range p.ModifyPlanRequests {
if err := up.Validate(); err != nil {
return err
}
}
for _, dp := range p.DeletePlanRequests {
if err := dp.Validate(); err != nil {
return err
}
}
return gov.ValidateAbstract(p)
}
func (p PublicPlanProposal) String() string {
return fmt.Sprintf(`Public Plan Proposal:
Title: %s
Description: %s
AddPlanRequests: %v
UpdatePlanRequests: %v
DeletePlanRequests: %v
`, p.Title, p.Description, p.AddPlanRequests, p.ModifyPlanRequests, p.DeletePlanRequests)
}
// NewAddPlanRequest creates a new AddPlanRequest object
func NewAddPlanRequest(
name string,
farmingPoolAddr string,
terminationAddr string,
stakingCoinWeights sdk.DecCoins,
startTime time.Time,
endTime time.Time,
epochAmount sdk.Coins,
epochRatio sdk.Dec,
) AddPlanRequest {
return AddPlanRequest{
Name: name,
FarmingPoolAddress: farmingPoolAddr,
TerminationAddress: terminationAddr,
StakingCoinWeights: stakingCoinWeights,
StartTime: startTime,
EndTime: endTime,
EpochAmount: epochAmount,
EpochRatio: epochRatio,
}
}
// IsForFixedAmountPlan returns true if the request is for
// fixed amount plan.
// It checks if EpochAmount is not zero.
func (p *AddPlanRequest) IsForFixedAmountPlan() bool {
return !p.EpochAmount.Empty()
}
// IsForRatioPlan returns true if the request is for
// ratio plan.
// It checks if EpochRatio is not zero.
func (p *AddPlanRequest) IsForRatioPlan() bool {
return !p.EpochRatio.IsNil() && !p.EpochRatio.IsZero()
}
// Validate validates AddPlanRequest.
func (p *AddPlanRequest) Validate() error {
// farmingPoolAddr is used as an arbitrary creator address in msg validation below.
farmingPoolAddr, err := sdk.AccAddressFromBech32(p.FarmingPoolAddress)
if err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid farming pool address %q: %v", p.FarmingPoolAddress, err)
}
if _, err := sdk.AccAddressFromBech32(p.TerminationAddress); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid termination address %q: %v", p.TerminationAddress, err)
}
isForFixedAmountPlan := p.IsForFixedAmountPlan()
isForRatioPlan := p.IsForRatioPlan()
switch {
case isForFixedAmountPlan == isForRatioPlan:
return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "exactly one of epoch amount or epoch ratio must be provided")
case isForFixedAmountPlan:
if err := NewMsgCreateFixedAmountPlan(
p.Name, farmingPoolAddr, p.StakingCoinWeights, p.StartTime, p.EndTime, p.EpochAmount,
).ValidateBasic(); err != nil {
return err
}
case isForRatioPlan:
if err := NewMsgCreateRatioPlan(
p.Name, farmingPoolAddr, p.StakingCoinWeights, p.StartTime, p.EndTime, p.EpochRatio,
).ValidateBasic(); err != nil {
return err
}
}
return nil
}
// NewModifyPlanRequest creates a new ModifyPlanRequest object.
func NewModifyPlanRequest(
id uint64,
name string,
farmingPoolAddr string,
terminationAddr string,
stakingCoinWeights sdk.DecCoins,
startTime time.Time,
endTime time.Time,
epochAmount sdk.Coins,
epochRatio sdk.Dec,
) ModifyPlanRequest {
return ModifyPlanRequest{
PlanId: id,
Name: name,
FarmingPoolAddress: farmingPoolAddr,
TerminationAddress: terminationAddr,
StakingCoinWeights: stakingCoinWeights,
StartTime: &startTime,
EndTime: &endTime,
EpochAmount: epochAmount,
EpochRatio: epochRatio,
}
}
// IsForFixedAmountPlan returns true if the request is for
// fixed amount plan.
// It checks if EpochAmount is not zero.
func (p *ModifyPlanRequest) IsForFixedAmountPlan() bool {
return !p.EpochAmount.Empty()
}
// IsForRatioPlan returns true if the request is for
// ratio plan.
// It checks if EpochRatio is not zero.
func (p *ModifyPlanRequest) IsForRatioPlan() bool {
return !p.EpochRatio.IsNil() && !p.EpochRatio.IsZero()
}
// Validate validates ModifyPlanRequest.
func (p *ModifyPlanRequest) Validate() error {
if p.PlanId == 0 {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "invalid plan id: %d", p.PlanId)
}
if p.Name != "" {
if err := ValidatePlanName(p.Name); err != nil {
return sdkerrors.Wrap(ErrInvalidPlanName, err.Error())
}
}
if p.FarmingPoolAddress != "" {
if _, err := sdk.AccAddressFromBech32(p.FarmingPoolAddress); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid farming pool address %q: %v", p.FarmingPoolAddress, err)
}
}
if p.TerminationAddress != "" {
if _, err := sdk.AccAddressFromBech32(p.TerminationAddress); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid termination address %q: %v", p.TerminationAddress, err)
}
}
if p.StakingCoinWeights != nil {
if err := ValidateStakingCoinTotalWeights(p.StakingCoinWeights); err != nil {
return err
}
}
if p.StartTime != nil && p.EndTime != nil {
if !p.EndTime.After(*p.StartTime) {
return sdkerrors.Wrapf(ErrInvalidPlanEndTime, "end time %s must be greater than start time %s", p.EndTime, p.StartTime)
}
}
isForFixedAmountPlan := p.IsForFixedAmountPlan()
isForRatioPlan := p.IsForRatioPlan()
switch {
case isForFixedAmountPlan && isForRatioPlan:
return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "at most one of epoch amount or epoch ratio must be provided")
case isForFixedAmountPlan:
if err := ValidateEpochAmount(p.EpochAmount); err != nil {
return err
}
case isForRatioPlan:
if err := ValidateEpochRatio(p.EpochRatio); err != nil {
return err
}
}
return nil
}
// NewDeletePlanRequest creates a new DeletePlanRequest object.
func NewDeletePlanRequest(id uint64) DeletePlanRequest {
return DeletePlanRequest{
PlanId: id,
}
}
// Validate validates DeletePlanRequest.
func (p *DeletePlanRequest) Validate() error {
if p.PlanId == 0 {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "invalid plan id: %d", p.PlanId)
}
return nil
}