-
Notifications
You must be signed in to change notification settings - Fork 19
/
banking.go
467 lines (414 loc) · 13.1 KB
/
banking.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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package types
import (
"errors"
"time"
vgcrypto "code.vegaprotocol.io/vega/libs/crypto"
"code.vegaprotocol.io/vega/libs/num"
vegapb "code.vegaprotocol.io/vega/protos/vega"
checkpointpb "code.vegaprotocol.io/vega/protos/vega/checkpoint/v1"
commandspb "code.vegaprotocol.io/vega/protos/vega/commands/v1"
eventspb "code.vegaprotocol.io/vega/protos/vega/events/v1"
)
type TransferStatus = eventspb.Transfer_Status
const (
// Default value.
TransferStatsUnspecified TransferStatus = eventspb.Transfer_STATUS_UNSPECIFIED
// A pending transfer.
TransferStatusPending TransferStatus = eventspb.Transfer_STATUS_PENDING
// A finished transfer.
TransferStatusDone TransferStatus = eventspb.Transfer_STATUS_DONE
// A rejected transfer.
TransferStatusRejected TransferStatus = eventspb.Transfer_STATUS_REJECTED
// A stopped transfer.
TransferStatusStopped TransferStatus = eventspb.Transfer_STATUS_STOPPED
// A cancelled transfer.
TransferStatusCancelled TransferStatus = eventspb.Transfer_STATUS_CANCELLED
)
var (
ErrMissingTransferKind = errors.New("missing transfer kind")
ErrCannotTransferZeroFunds = errors.New("cannot transfer zero funds")
ErrInvalidFromAccount = errors.New("invalid from account")
ErrInvalidToAccount = errors.New("invalid to account")
ErrUnsupportedFromAccountType = errors.New("unsupported from account type")
ErrUnsupportedToAccountType = errors.New("unsupported to account type")
ErrEndEpochIsZero = errors.New("end epoch is zero")
ErrStartEpochIsZero = errors.New("start epoch is zero")
ErrInvalidFactor = errors.New("invalid factor")
ErrStartEpochAfterEndEpoch = errors.New("start epoch after end epoch")
ErrInvalidToForRewardAccountType = errors.New("to party is invalid for reward account type")
)
type TransferCommandKind int
const (
TransferCommandKindOneOff TransferCommandKind = iota
TransferCommandKindRecurring
)
type TransferBase struct {
ID string
From string
FromAccountType AccountType
To string
ToAccountType AccountType
Asset string
Amount *num.Uint
Reference string
Status TransferStatus
Timestamp time.Time
}
func (t *TransferBase) IsValid() error {
if !vgcrypto.IsValidVegaPubKey(t.From) {
return ErrInvalidFromAccount
}
if !vgcrypto.IsValidVegaPubKey(t.To) {
return ErrInvalidToAccount
}
// ensure amount makes senses
if t.Amount.IsZero() {
return ErrCannotTransferZeroFunds
}
switch t.FromAccountType {
case AccountTypeGeneral, AccountTypeVestedRewards /*, AccountTypeLockedForStaking*/ :
break
default:
return ErrUnsupportedFromAccountType
}
switch t.ToAccountType {
case AccountTypeGlobalReward, AccountTypeNetworkTreasury:
if t.To != "0000000000000000000000000000000000000000000000000000000000000000" {
return ErrInvalidToForRewardAccountType
}
case AccountTypeGeneral, AccountTypeLPFeeReward, AccountTypeMakerReceivedFeeReward, AccountTypeMakerPaidFeeReward, AccountTypeMarketProposerReward,
AccountTypeAveragePositionReward, AccountTypeRelativeReturnReward, AccountTypeValidatorRankingReward, AccountTypeReturnVolatilityReward: /*, AccountTypeLockedForStaking*/
break
default:
return ErrUnsupportedToAccountType
}
return nil
}
type GovernanceTransfer struct {
ID string // NB: this is the ID of the proposal
Reference string
Config *NewTransferConfiguration
Status TransferStatus
Timestamp time.Time
}
func (g *GovernanceTransfer) IntoProto() *checkpointpb.GovernanceTransfer {
return &checkpointpb.GovernanceTransfer{
Id: g.ID,
Reference: g.Reference,
Timestamp: g.Timestamp.UnixNano(),
Status: g.Status,
Config: g.Config.IntoProto(),
}
}
func GovernanceTransferFromProto(g *checkpointpb.GovernanceTransfer) *GovernanceTransfer {
c, _ := NewTransferConfigurationFromProto(g.Config)
return &GovernanceTransfer{
ID: g.Id,
Reference: g.Reference,
Timestamp: time.Unix(0, g.Timestamp),
Status: g.Status,
Config: c,
}
}
func (g *GovernanceTransfer) IntoEvent(amount *num.Uint, reason, gameID *string) *eventspb.Transfer {
// Not sure if this symbology gonna work for datanode
from := "0000000000000000000000000000000000000000000000000000000000000000"
if len(g.Config.Source) > 0 {
from = g.Config.Source
}
to := g.Config.Destination
if g.Config.DestinationType == AccountTypeGlobalReward || g.Config.DestinationType == AccountTypeNetworkTreasury || g.Config.DestinationType == AccountTypeGlobalInsurance {
to = "0000000000000000000000000000000000000000000000000000000000000000"
}
out := &eventspb.Transfer{
Id: g.ID,
From: from,
FromAccountType: g.Config.SourceType,
To: to,
ToAccountType: g.Config.DestinationType,
Asset: g.Config.Asset,
Amount: amount.String(),
Reference: g.Reference,
Status: g.Status,
Timestamp: g.Timestamp.UnixNano(),
Reason: reason,
GameId: gameID,
}
if g.Config.OneOffTransferConfig != nil {
out.Kind = &eventspb.Transfer_OneOffGovernance{}
if g.Config.OneOffTransferConfig.DeliverOn > 0 {
out.Kind = &eventspb.Transfer_OneOffGovernance{
OneOffGovernance: &eventspb.OneOffGovernanceTransfer{
DeliverOn: g.Config.OneOffTransferConfig.DeliverOn,
},
}
}
} else {
out.Kind = &eventspb.Transfer_RecurringGovernance{
RecurringGovernance: &eventspb.RecurringGovernanceTransfer{
StartEpoch: g.Config.RecurringTransferConfig.StartEpoch,
EndEpoch: g.Config.RecurringTransferConfig.EndEpoch,
},
}
}
return out
}
type OneOffTransfer struct {
*TransferBase
DeliverOn *time.Time
}
func (o *OneOffTransfer) IsValid() error {
if err := o.TransferBase.IsValid(); err != nil {
return err
}
return nil
}
func OneOffTransferFromEvent(p *eventspb.Transfer) *OneOffTransfer {
var deliverOn *time.Time
if t := p.GetOneOff().GetDeliverOn(); t > 0 {
d := time.Unix(0, t)
deliverOn = &d
}
amount, overflow := num.UintFromString(p.Amount, 10)
if overflow {
// panic is alright here, this should come only from
// a checkpoint, and it would mean the checkpoint is fucked
// so executions is not possible.
panic("invalid transfer amount")
}
return &OneOffTransfer{
TransferBase: &TransferBase{
ID: p.Id,
From: p.From,
FromAccountType: p.FromAccountType,
To: p.To,
ToAccountType: p.ToAccountType,
Asset: p.Asset,
Amount: amount,
Reference: p.Reference,
Status: p.Status,
Timestamp: time.Unix(0, p.Timestamp),
},
DeliverOn: deliverOn,
}
}
func (o *OneOffTransfer) IntoEvent(reason *string) *eventspb.Transfer {
out := &eventspb.Transfer{
Id: o.ID,
From: o.From,
FromAccountType: o.FromAccountType,
To: o.To,
ToAccountType: o.ToAccountType,
Asset: o.Asset,
Amount: o.Amount.String(),
Reference: o.Reference,
Status: o.Status,
Timestamp: o.Timestamp.UnixNano(),
Reason: reason,
}
out.Kind = &eventspb.Transfer_OneOff{}
if o.DeliverOn != nil {
out.Kind = &eventspb.Transfer_OneOff{
OneOff: &eventspb.OneOffTransfer{
DeliverOn: o.DeliverOn.UnixNano(),
},
}
}
return out
}
type RecurringTransfer struct {
*TransferBase
StartEpoch uint64
EndEpoch *uint64
Factor num.Decimal
DispatchStrategy *vegapb.DispatchStrategy
}
func (r *RecurringTransfer) IsValid() error {
if err := r.TransferBase.IsValid(); err != nil {
return err
}
if r.EndEpoch != nil && *r.EndEpoch == 0 {
return ErrEndEpochIsZero
}
if r.StartEpoch == 0 {
return ErrStartEpochIsZero
}
if r.EndEpoch != nil && r.StartEpoch > *r.EndEpoch {
return ErrStartEpochAfterEndEpoch
}
if r.Factor.Cmp(num.DecimalFromFloat(0)) <= 0 {
return ErrInvalidFactor
}
return nil
}
func (r *RecurringTransfer) IntoEvent(reason *string, gameID *string) *eventspb.Transfer {
var endEpoch *uint64
if r.EndEpoch != nil {
endEpoch = toPtr(*r.EndEpoch)
}
return &eventspb.Transfer{
Id: r.ID,
From: r.From,
FromAccountType: r.FromAccountType,
To: r.To,
ToAccountType: r.ToAccountType,
Asset: r.Asset,
Amount: r.Amount.String(),
Reference: r.Reference,
Status: r.Status,
Timestamp: r.Timestamp.UnixNano(),
Reason: reason,
GameId: gameID,
Kind: &eventspb.Transfer_Recurring{
Recurring: &eventspb.RecurringTransfer{
StartEpoch: r.StartEpoch,
EndEpoch: endEpoch,
Factor: r.Factor.String(),
DispatchStrategy: r.DispatchStrategy,
},
},
}
}
// Just a wrapper, use the Kind on a
// switch to access the proper value.
type TransferFunds struct {
Kind TransferCommandKind
OneOff *OneOffTransfer
Recurring *RecurringTransfer
}
func NewTransferFromProto(id, from string, tf *commandspb.Transfer) (*TransferFunds, error) {
base, err := newTransferBase(id, from, tf)
if err != nil {
return nil, err
}
switch tf.Kind.(type) {
case *commandspb.Transfer_OneOff:
return newOneOffTransfer(base, tf)
case *commandspb.Transfer_Recurring:
return newRecurringTransfer(base, tf)
default:
return nil, ErrMissingTransferKind
}
}
func (t *TransferFunds) IntoEvent(reason, gameID *string) *eventspb.Transfer {
switch t.Kind {
case TransferCommandKindOneOff:
return t.OneOff.IntoEvent(reason)
case TransferCommandKindRecurring:
return t.Recurring.IntoEvent(reason, gameID)
default:
panic("invalid transfer kind")
}
}
func newTransferBase(id, from string, tf *commandspb.Transfer) (*TransferBase, error) {
amount, overflowed := num.UintFromString(tf.Amount, 10)
if overflowed {
return nil, errors.New("invalid transfer amount")
}
return &TransferBase{
ID: id,
From: from,
FromAccountType: tf.FromAccountType,
To: tf.To,
ToAccountType: tf.ToAccountType,
Asset: tf.Asset,
Amount: amount,
Reference: tf.Reference,
Status: TransferStatusPending,
}, nil
}
func newOneOffTransfer(base *TransferBase, tf *commandspb.Transfer) (*TransferFunds, error) {
var t *time.Time
if tf.GetOneOff().GetDeliverOn() > 0 {
tmpt := time.Unix(0, tf.GetOneOff().GetDeliverOn())
t = &tmpt
}
return &TransferFunds{
Kind: TransferCommandKindOneOff,
OneOff: &OneOffTransfer{
TransferBase: base,
DeliverOn: t,
},
}, nil
}
func newRecurringTransfer(base *TransferBase, tf *commandspb.Transfer) (*TransferFunds, error) {
factor, err := num.DecimalFromString(tf.GetRecurring().GetFactor())
if err != nil {
return nil, err
}
var endEpoch *uint64
if tf.GetRecurring().EndEpoch != nil {
ee := tf.GetRecurring().GetEndEpoch()
endEpoch = &ee
}
return &TransferFunds{
Kind: TransferCommandKindRecurring,
Recurring: &RecurringTransfer{
TransferBase: base,
StartEpoch: tf.GetRecurring().GetStartEpoch(),
EndEpoch: endEpoch,
Factor: factor,
DispatchStrategy: tf.GetRecurring().DispatchStrategy,
},
}, nil
}
func RecurringTransferFromEvent(p *eventspb.Transfer) *RecurringTransfer {
var endEpoch *uint64
if p.GetRecurring().EndEpoch != nil {
ee := p.GetRecurring().GetEndEpoch()
endEpoch = &ee
}
factor, err := num.DecimalFromString(p.GetRecurring().GetFactor())
if err != nil {
panic("invalid decimal, should never happen")
}
amount, overflow := num.UintFromString(p.Amount, 10)
if overflow {
// panic is alright here, this should come only from
// a checkpoint, and it would mean the checkpoint is fucked
// so executions is not possible.
panic("invalid transfer amount")
}
return &RecurringTransfer{
TransferBase: &TransferBase{
ID: p.Id,
From: p.From,
FromAccountType: p.FromAccountType,
To: p.To,
ToAccountType: p.ToAccountType,
Asset: p.Asset,
Amount: amount,
Reference: p.Reference,
Status: p.Status,
Timestamp: time.Unix(0, p.Timestamp),
},
StartEpoch: p.GetRecurring().GetStartEpoch(),
EndEpoch: endEpoch,
Factor: factor,
DispatchStrategy: p.GetRecurring().DispatchStrategy,
}
}
type CancelTransferFunds struct {
Party string
TransferID string
}
func NewCancelTransferFromProto(party string, p *commandspb.CancelTransfer) *CancelTransferFunds {
return &CancelTransferFunds{
Party: party,
TransferID: p.TransferId,
}
}