-
Notifications
You must be signed in to change notification settings - Fork 46
/
models.go
281 lines (228 loc) · 7.52 KB
/
models.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
package types
import (
"fmt"
"regexp"
"strconv"
"strings"
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/gogo/protobuf/proto"
)
// ParseReactionID parses the given value as a reaction id, returning an error if it's invalid
func ParseReactionID(value string) (uint32, error) {
if value == "" {
return 0, nil
}
reactionID, err := strconv.ParseUint(value, 10, 32)
if err != nil {
return 0, fmt.Errorf("invalid reaction id: %s", err)
}
return uint32(reactionID), nil
}
// NewReaction returns a new Reaction instance
func NewReaction(subspaceID uint64, postID uint64, id uint32, value ReactionValue, author string) Reaction {
valueAny, err := codectypes.NewAnyWithValue(value)
if err != nil {
panic("failed to pack value to any type")
}
return Reaction{
SubspaceID: subspaceID,
ID: id,
PostID: postID,
Value: valueAny,
Author: author,
}
}
// Validate implements fmt.Validator
func (r Reaction) Validate() error {
if r.SubspaceID == 0 {
return fmt.Errorf("invalid subspace id: %d", r.SubspaceID)
}
if r.ID == 0 {
return fmt.Errorf("invalid id: %d", r.ID)
}
if r.PostID == 0 {
return fmt.Errorf("invalid post id: %d", r.PostID)
}
err := r.Value.GetCachedValue().(ReactionValue).Validate()
if err != nil {
return err
}
_, err = sdk.AccAddressFromBech32(r.Author)
if err != nil {
return fmt.Errorf("invalid author address: %s", err)
}
return nil
}
// UnpackInterfaces implements codectypes.UnpackInterfacesMessage
func (r *Reaction) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error {
var target ReactionValue
return unpacker.UnpackAny(r.Value, &target)
}
// --------------------------------------------------------------------------------------------------------------------
// ReactionValue represents a generic reaction value
type ReactionValue interface {
proto.Message
isReactionValue()
Validate() error
}
// --------------------------------------------------------------------------------------------------------------------
var _ ReactionValue = &RegisteredReactionValue{}
// NewRegisteredReactionValue returns a new RegisteredReactionValue instance
func NewRegisteredReactionValue(registeredReactionID uint32) *RegisteredReactionValue {
return &RegisteredReactionValue{
RegisteredReactionID: registeredReactionID,
}
}
// isReactionValue implements ReactionValue
func (v *RegisteredReactionValue) isReactionValue() {}
// Validate implements ReactionValue
func (v *RegisteredReactionValue) Validate() error {
if v.RegisteredReactionID == 0 {
return fmt.Errorf("invalid reaction id: %d", v.RegisteredReactionID)
}
return nil
}
// --------------------------------------------------------------------------------------------------------------------
var _ ReactionValue = &FreeTextValue{}
// NewFreeTextValue returns a new FreeTextValue instance
func NewFreeTextValue(text string) *FreeTextValue {
return &FreeTextValue{
Text: text,
}
}
// isReactionValue implements ReactionValue
func (v *FreeTextValue) isReactionValue() {}
// Validate implements ReactionValue
func (v *FreeTextValue) Validate() error {
if strings.TrimSpace(v.Text) == "" {
return fmt.Errorf("invalid text: %s", v.Text)
}
return nil
}
// --------------------------------------------------------------------------------------------------------------------
// ParseRegisteredReactionID parses the given value as a registered reaction id, returning an error if it's invalid
func ParseRegisteredReactionID(value string) (uint32, error) {
if value == "" {
return 0, nil
}
reactionID, err := strconv.ParseUint(value, 10, 32)
if err != nil {
return 0, fmt.Errorf("invalid registered reaction id: %s", err)
}
return uint32(reactionID), nil
}
// NewRegisteredReaction returns a new RegisteredReaction instance
func NewRegisteredReaction(subspaceID uint64, id uint32, shorthandCode string, displayValue string) RegisteredReaction {
return RegisteredReaction{
SubspaceID: subspaceID,
ID: id,
ShorthandCode: shorthandCode,
DisplayValue: displayValue,
}
}
// Validate implements fmt.Validator
func (r RegisteredReaction) Validate() error {
if r.SubspaceID == 0 {
return fmt.Errorf("invalid subspace id: %d", r.SubspaceID)
}
if r.ID == 0 {
return fmt.Errorf("invalid id: %d", r.ID)
}
if strings.TrimSpace(r.ShorthandCode) == "" {
return fmt.Errorf("invalid shorthand code: %s", r.ShorthandCode)
}
if strings.TrimSpace(r.DisplayValue) == "" {
return fmt.Errorf("invalid display value: %s", r.DisplayValue)
}
return nil
}
// Update updates the fields of a given registered reaction without validating it.
// Before storing the updated reaction, a validation with Validate() should
// be performed.
func (r RegisteredReaction) Update(update RegisteredReactionUpdate) RegisteredReaction {
if update.ShorthandCode == DoNotModify {
update.ShorthandCode = r.ShorthandCode
}
if update.DisplayValue == DoNotModify {
update.DisplayValue = r.DisplayValue
}
return NewRegisteredReaction(
r.SubspaceID,
r.ID,
update.ShorthandCode,
update.DisplayValue,
)
}
// RegisteredReactionUpdate contains all the data that can be updated about a registered reaction.
// When performing an update, if a field should not be edited then it must be set to types.DoNotModify
type RegisteredReactionUpdate struct {
ShorthandCode string
DisplayValue string
}
// NewRegisteredReactionUpdate builds a new RegisteredReactionUpdate instance containing the given data
func NewRegisteredReactionUpdate(shorthandCode, displayValue string) RegisteredReactionUpdate {
return RegisteredReactionUpdate{
ShorthandCode: shorthandCode,
DisplayValue: displayValue,
}
}
// --------------------------------------------------------------------------------------------------------------------
// NewSubspaceReactionsParams returns a new SubspaceReactionsParams instance
func NewSubspaceReactionsParams(
subspaceID uint64,
registeredReactionParams RegisteredReactionValueParams,
freeTextParams FreeTextValueParams,
) SubspaceReactionsParams {
return SubspaceReactionsParams{
SubspaceID: subspaceID,
RegisteredReaction: registeredReactionParams,
FreeText: freeTextParams,
}
}
// DefaultReactionsParams returns the default params for the given subspace
func DefaultReactionsParams(subspaceID uint64) SubspaceReactionsParams {
return NewSubspaceReactionsParams(
subspaceID,
NewRegisteredReactionValueParams(true),
NewFreeTextValueParams(true, 5, ""),
)
}
// Validate implements fmt.Validator
func (p SubspaceReactionsParams) Validate() error {
if p.SubspaceID == 0 {
return fmt.Errorf("invalid subspace id: %d", p.SubspaceID)
}
err := p.FreeText.Validate()
if err != nil {
return fmt.Errorf("invalid free text value params: %s", err)
}
return nil
}
// NewRegisteredReactionValueParams returns a new RegisteredReactionValueParams instance
func NewRegisteredReactionValueParams(enabled bool) RegisteredReactionValueParams {
return RegisteredReactionValueParams{
Enabled: enabled,
}
}
// NewFreeTextValueParams returns a new FreeTextValueParams instance
func NewFreeTextValueParams(enabled bool, maxLength uint32, regEx string) FreeTextValueParams {
return FreeTextValueParams{
Enabled: enabled,
MaxLength: maxLength,
RegEx: regEx,
}
}
// Validate implements fmt.Validator
func (p FreeTextValueParams) Validate() error {
if p.MaxLength == 0 {
return fmt.Errorf("invalid max length: %d", p.MaxLength)
}
if p.RegEx != "" {
_, err := regexp.Compile(p.RegEx)
if err != nil {
return fmt.Errorf("invalid regex: %s", err)
}
}
return nil
}