-
Notifications
You must be signed in to change notification settings - Fork 22
/
recurring_transfers.go
354 lines (321 loc) · 12.6 KB
/
recurring_transfers.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
// 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 banking
import (
"context"
"encoding/hex"
"errors"
"fmt"
"code.vegaprotocol.io/vega/core/events"
"code.vegaprotocol.io/vega/core/types"
"code.vegaprotocol.io/vega/libs/crypto"
"code.vegaprotocol.io/vega/libs/num"
"code.vegaprotocol.io/vega/libs/proto"
"code.vegaprotocol.io/vega/logging"
vegapb "code.vegaprotocol.io/vega/protos/vega"
)
var (
ErrStartEpochInThePast = errors.New("start epoch in the past")
ErrCannotSubmitDuplicateRecurringTransferWithSameFromAndTo = errors.New("cannot submit duplicate recurring transfer with same from and to")
)
func (e *Engine) recurringTransfer(
ctx context.Context,
transfer *types.RecurringTransfer,
) (err error) {
defer func() {
if err != nil {
e.broker.Send(events.NewRecurringTransferFundsEventWithReason(ctx, transfer, err.Error()))
} else {
e.broker.Send(events.NewRecurringTransferFundsEvent(ctx, transfer))
}
}()
// ensure asset exists
a, err := e.assets.Get(transfer.Asset)
if err != nil {
transfer.Status = types.TransferStatusRejected
e.log.Debug("cannot transfer funds, invalid asset", logging.Error(err))
return fmt.Errorf("could not transfer funds: %w", err)
}
if transfer.DispatchStrategy != nil {
hasAsset := len(transfer.DispatchStrategy.AssetForMetric) > 0
// ensure the asset transfer is correct
if hasAsset {
_, err := e.assets.Get(transfer.DispatchStrategy.AssetForMetric)
if err != nil {
transfer.Status = types.TransferStatusRejected
e.log.Debug("cannot transfer funds, invalid asset for metric", logging.Error(err))
return fmt.Errorf("could not transfer funds, invalid asset for metric: %w", err)
}
}
if hasAsset && len(transfer.DispatchStrategy.Markets) > 0 {
asset := transfer.DispatchStrategy.AssetForMetric
for _, mid := range transfer.DispatchStrategy.Markets {
if !e.marketActivityTracker.MarketTrackedForAsset(mid, asset) {
transfer.Status = types.TransferStatusRejected
e.log.Debug("cannot transfer funds, invalid market for dispatch asset",
logging.String("mid", mid),
logging.String("asset", asset),
)
return errors.New("could not transfer funds, invalid market for dispatch asset")
}
}
}
}
if err := transfer.IsValid(); err != nil {
transfer.Status = types.TransferStatusRejected
return err
}
if err := e.ensureMinimalTransferAmount(a, transfer.Amount); err != nil {
transfer.Status = types.TransferStatusRejected
return err
}
if err := e.ensureNoRecurringTransferDuplicates(transfer); err != nil {
transfer.Status = types.TransferStatusRejected
return err
}
// can't create transfer with start epoch in the past
if transfer.StartEpoch < e.currentEpoch {
transfer.Status = types.TransferStatusRejected
return ErrStartEpochInThePast
}
// from here all sounds OK, we can add the transfer
// in the recurringTransfer map/slice
e.recurringTransfers = append(e.recurringTransfers, transfer)
e.recurringTransfersMap[transfer.ID] = transfer
e.registerDispatchStrategy(transfer.DispatchStrategy)
return nil
}
func (e *Engine) hashDispatchStrategy(ds *vegapb.DispatchStrategy) string {
p, err := proto.Marshal(ds)
if err != nil {
e.log.Panic("failed to marshal dispatch strategy", logging.String("dispatch-strategy", ds.String()))
}
return hex.EncodeToString(crypto.Hash(p))
}
func (e *Engine) registerDispatchStrategy(ds *vegapb.DispatchStrategy) {
if ds == nil {
return
}
hash := e.hashDispatchStrategy(ds)
if _, ok := e.hashToStrategy[hash]; !ok {
e.hashToStrategy[hash] = &dispatchStrategyCacheEntry{ds: ds, refCount: 1}
} else {
e.hashToStrategy[hash].refCount++
}
}
func (e *Engine) unregisterDispatchStrategy(ds *vegapb.DispatchStrategy) {
if ds == nil {
return
}
hash := e.hashDispatchStrategy(ds)
e.hashToStrategy[hash].refCount--
}
func (e *Engine) cleanupStaleDispatchStrategies() {
for hash, dsc := range e.hashToStrategy {
if dsc.refCount == 0 {
delete(e.hashToStrategy, hash)
}
}
}
func compareStringSlices(a, b []string) bool {
if len(a) != len(b) {
return false
}
for i, v := range a {
if v != b[i] {
return false
}
}
return true
}
func isSimilar(dispatchStrategy1, dispatchStrategy2 *vegapb.DispatchStrategy) bool {
return (dispatchStrategy1 == nil && dispatchStrategy2 == nil) ||
(dispatchStrategy1 != nil && dispatchStrategy2 != nil && dispatchStrategy1.AssetForMetric == dispatchStrategy2.AssetForMetric && dispatchStrategy1.Metric == dispatchStrategy2.Metric && compareStringSlices(dispatchStrategy1.Markets, dispatchStrategy2.Markets))
}
func (e *Engine) ensureNoRecurringTransferDuplicates(
transfer *types.RecurringTransfer,
) error {
for _, v := range e.recurringTransfers {
// NB: 2 transfers are identical and not allowed if they have the same from, to, type AND the same dispatch strategy.
// This is needed so that we can for example setup transfer of USDT from one PK to the reward account with type maker fees received with dispatch based on the asset ETH -
// and then a similar transfer of USDT from the same PK to the same reward type but with different dispatch strategy - one tracking markets for the asset DAI.
if v.From == transfer.From && v.To == transfer.To && v.Asset == transfer.Asset && v.FromAccountType == transfer.FromAccountType && v.ToAccountType == transfer.ToAccountType && isSimilar(v.DispatchStrategy, transfer.DispatchStrategy) {
return ErrCannotSubmitDuplicateRecurringTransferWithSameFromAndTo
}
}
return nil
}
// dispatchRequired returns true if the metric for any qualifying entity in scope none zero.
// NB1: the check for market value metric should be done separately
// NB2: for validator ranking this will always return true as it is assumed that for the network to resume there must always be
// a validator with non zero ranking.
func (e *Engine) dispatchRequired(ds *vegapb.DispatchStrategy) bool {
switch ds.Metric {
case vegapb.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_PAID,
vegapb.DispatchMetric_DISPATCH_METRIC_MAKER_FEES_RECEIVED,
vegapb.DispatchMetric_DISPATCH_METRIC_LP_FEES_RECEIVED,
vegapb.DispatchMetric_DISPATCH_METRIC_AVERAGE_POSITION,
vegapb.DispatchMetric_DISPATCH_METRIC_RELATIVE_RETURN,
vegapb.DispatchMetric_DISPATCH_METRIC_RETURN_VOLATILITY:
if ds.EntityScope == vegapb.EntityScope_ENTITY_SCOPE_INDIVIDUALS {
return len(e.marketActivityTracker.CalculateMetricForIndividuals(ds)) > 0
} else {
tcs, _ := e.marketActivityTracker.CalculateMetricForTeams(ds)
return len(tcs) > 0
}
case vegapb.DispatchMetric_DISPATCH_METRIC_VALIDATOR_RANKING:
return true
}
return false
}
func (e *Engine) distributeRecurringTransfers(ctx context.Context, newEpoch uint64) {
var (
transfersDone = []events.Event{}
doneIDs = []string{}
tresps = []*types.LedgerMovement{}
currentEpoch = num.NewUint(newEpoch).ToDecimal()
)
// iterate over all transfers
for _, v := range e.recurringTransfers {
if v.StartEpoch > newEpoch {
// not started
continue
}
var (
startEpoch = num.NewUint(v.StartEpoch).ToDecimal()
startAmount = v.Amount.ToDecimal()
amount, _ = num.UintFromDecimal(
startAmount.Mul(
v.Factor.Pow(currentEpoch.Sub(startEpoch)),
),
)
)
// check if the amount is still enough
// ensure asset exists
a, err := e.assets.Get(v.Asset)
if err != nil {
// this should not be possible, asset was validated at first when
// accepting the transfer
e.log.Panic("this should never happen", logging.Error(err))
}
if err = e.ensureMinimalTransferAmount(a, amount); err != nil {
v.Status = types.TransferStatusStopped
transfersDone = append(transfersDone,
events.NewRecurringTransferFundsEventWithReason(ctx, v, err.Error()))
doneIDs = append(doneIDs, v.ID)
continue
}
// NB: if no dispatch strategy is defined - the transfer is made to the account as defined in the transfer.
// If a dispatch strategy is defined but there are no relevant markets in scope or no fees in scope then no transfer is made!
var resps []*types.LedgerMovement
var r []*types.LedgerMovement
if v.DispatchStrategy == nil {
resps, err = e.processTransfer(
ctx, v.From, v.To, v.Asset, "", v.FromAccountType, v.ToAccountType, amount, v.Reference, nil, // last is eventual oneoff, which this is not
)
} else {
// check if the amount + fees can be covered by the party issuing the transfer
if _, err = e.ensureFeeForTransferFunds(amount, v.From, v.Asset, v.FromAccountType); err == nil {
// NB: if the metric is market value we're going to transfer the bonus if any directly
// to the market account of the asset/reward type - this is similar to previous behaviour and
// different to how all other metric based rewards behave. The reason is that we need the context of the funder
// and this context is lost when the transfer has already gone through
if v.DispatchStrategy.Metric == vegapb.DispatchMetric_DISPATCH_METRIC_MARKET_VALUE {
marketProposersScore := e.marketActivityTracker.GetMarketsWithEligibleProposer(v.DispatchStrategy.AssetForMetric, v.DispatchStrategy.Markets, v.Asset, v.From)
for _, fms := range marketProposersScore {
amt, _ := num.UintFromDecimal(amount.ToDecimal().Mul(fms.Score))
if amt.IsZero() {
continue
}
r, err = e.processTransfer(
ctx, v.From, v.To, v.Asset, fms.Market, v.FromAccountType, v.ToAccountType, amt, v.Reference, nil, // last is eventual oneoff, which this is not
)
if err != nil {
e.log.Error("failed to process transfer",
logging.String("from", v.From),
logging.String("to", v.To),
logging.String("asset", v.Asset),
logging.String("market", fms.Market),
logging.String("from-account-type", v.FromAccountType.String()),
logging.String("to-account-type", v.ToAccountType.String()),
logging.String("amount", amt.String()),
logging.String("reference", v.Reference),
logging.Error(err))
break
}
if fms.Score.IsPositive() {
e.marketActivityTracker.MarkPaidProposer(v.DispatchStrategy.AssetForMetric, fms.Market, v.Asset, v.DispatchStrategy.Markets, v.From)
}
resps = append(resps, r...)
}
}
// for any other metric, we transfer the funds (full amount) to the reward account of the asset/reward_type/market=hash(dispatch_strategy)
if e.dispatchRequired(v.DispatchStrategy) {
p, _ := proto.Marshal(v.DispatchStrategy)
hash := hex.EncodeToString(crypto.Hash(p))
r, err = e.processTransfer(
ctx, v.From, v.To, v.Asset, hash, v.FromAccountType, v.ToAccountType, amount, v.Reference, nil, // last is eventual oneoff, which this is not
)
if err != nil {
e.log.Error("failed to process transfer", logging.Error(err))
}
resps = append(resps, r...)
}
} else {
err = fmt.Errorf("could not pay the fee for transfer: %w", err)
}
}
if err != nil {
e.log.Info("transferred stopped", logging.Error(err))
v.Status = types.TransferStatusStopped
transfersDone = append(transfersDone,
events.NewRecurringTransferFundsEventWithReason(ctx, v, err.Error()))
doneIDs = append(doneIDs, v.ID)
continue
}
tresps = append(tresps, resps...)
// if we don't have anymore
if v.EndEpoch != nil && *v.EndEpoch == e.currentEpoch {
v.Status = types.TransferStatusDone
transfersDone = append(transfersDone, events.NewRecurringTransferFundsEvent(ctx, v))
doneIDs = append(doneIDs, v.ID)
}
}
// send events
if len(tresps) > 0 {
e.broker.Send(events.NewLedgerMovements(ctx, tresps))
}
if len(transfersDone) > 0 {
for _, id := range doneIDs {
e.deleteTransfer(id)
}
// also set the state change
e.broker.SendBatch(transfersDone)
}
}
func (e *Engine) deleteTransfer(ID string) {
index := -1
for i, rt := range e.recurringTransfers {
if rt.ID == ID {
index = i
e.unregisterDispatchStrategy(rt.DispatchStrategy)
break
}
}
if index >= 0 {
e.recurringTransfers = append(e.recurringTransfers[:index], e.recurringTransfers[index+1:]...)
delete(e.recurringTransfersMap, ID)
}
}