-
Notifications
You must be signed in to change notification settings - Fork 22
/
engine.go
2783 lines (2530 loc) · 89.5 KB
/
engine.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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2022 Gobalsky Labs Limited
//
// Use of this software is governed by the Business Source License included
// in the LICENSE.VEGA file and at https://www.mariadb.com/bsl11.
//
// Change Date: 18 months from the later of the date of the first publicly
// available Distribution of this version of the repository, and 25 June 2022.
//
// On the date above, in accordance with the Business Source License, use
// of this software will be governed by version 3 or later of the GNU General
// Public License.
package collateral
import (
"context"
"fmt"
"sort"
"sync"
"time"
"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/logging"
"code.vegaprotocol.io/vega/protos/vega"
"github.com/pkg/errors"
)
const (
initialAccountSize = 4096
// use weird character here, maybe non-displayable ones in the future
// if needed.
systemOwner = "*"
noMarket = "!"
rewardPartyID = "0000000000000000000000000000000000000000000000000000000000000000"
)
var (
// ErrSystemAccountsMissing signals that a system account is missing, which may means that the
// collateral engine have not been initialised properly.
ErrSystemAccountsMissing = errors.New("system accounts missing for collateral engine to work")
// ErrFeeAccountsMissing signals that a fee account is missing, which may means that the
// collateral engine have not been initialised properly.
ErrFeeAccountsMissing = errors.New("fee accounts missing for collateral engine to work")
// ErrPartyAccountsMissing signals that the accounts for this party do not exists.
ErrPartyAccountsMissing = errors.New("party accounts missing, cannot collect")
// ErrAccountDoesNotExist signals that an account par of a transfer do not exists.
ErrAccountDoesNotExist = errors.New("account does not exists")
ErrNoGeneralAccountWhenCreateMarginAccount = errors.New("party general account missing when trying to create a margin account")
ErrNoGeneralAccountWhenCreateBondAccount = errors.New("party general account missing when trying to create a bond account")
ErrMinAmountNotReached = errors.New("unable to reach minimum amount transfer")
ErrPartyHasNoTokenAccount = errors.New("no token account for party")
ErrSettlementBalanceNotZero = errors.New("settlement balance should be zero") // E991 YOU HAVE TOO MUCH ROPE TO HANG YOURSELF
// ErrAssetAlreadyEnabled signals the given asset has already been enabled in this engine.
ErrAssetAlreadyEnabled = errors.New("asset already enabled")
ErrAssetHasNotBeenEnabled = errors.New("asset has not been enabled")
// ErrInvalidAssetID signals that an asset id does not exists.
ErrInvalidAssetID = errors.New("invalid asset ID")
// ErrInsufficientFundsToPayFees the party do not have enough funds to pay the feeds.
ErrInsufficientFundsToPayFees = errors.New("insufficient funds to pay fees")
// ErrInvalidTransferTypeForFeeRequest an invalid transfer type was send to build a fee transfer request.
ErrInvalidTransferTypeForFeeRequest = errors.New("an invalid transfer type was send to build a fee transfer request")
// ErrNotEnoughFundsToWithdraw a party requested to withdraw more than on its general account.
ErrNotEnoughFundsToWithdraw = errors.New("not enough funds to withdraw")
)
// Broker send events
// we no longer need to generate this mock here, we can use the broker/mocks package instead.
type Broker interface {
Send(event events.Event)
SendBatch(events []events.Event)
}
// TimeService provide the time of the vega node.
//
//go:generate go run github.com/golang/mock/mockgen -destination mocks/time_service_mock.go -package mocks code.vegaprotocol.io/vega/core/collateral TimeService
type TimeService interface {
GetTimeNow() time.Time
}
// Engine is handling the power of the collateral.
type Engine struct {
Config
log *logging.Logger
cfgMu sync.Mutex
accs map[string]*types.Account
// map of partyID -> account ID -> account
// this is used to check if a party have any balances in
// any assets at all
partiesAccs map[string]map[string]*types.Account
hashableAccs []*types.Account
timeService TimeService
broker Broker
idbuf []byte
// asset ID to asset
enabledAssets map[string]types.Asset
// snapshot stuff
state *accState
}
// New instantiates a new collateral engine.
func New(log *logging.Logger, conf Config, ts TimeService, broker Broker) *Engine {
// setup logger
log = log.Named(namedLogger)
log.SetLevel(conf.Level.Get())
return &Engine{
log: log,
Config: conf,
accs: make(map[string]*types.Account, initialAccountSize),
partiesAccs: map[string]map[string]*types.Account{},
hashableAccs: []*types.Account{},
timeService: ts,
broker: broker,
idbuf: make([]byte, 256),
enabledAssets: map[string]types.Asset{},
state: newAccState(),
}
}
func (e *Engine) addPartyAccount(party, accid string, acc *types.Account) {
accs, ok := e.partiesAccs[party]
if !ok {
accs = map[string]*types.Account{}
e.partiesAccs[party] = accs
}
// this is called only when an account is created first time
// and never twice
accs[accid] = acc
}
func (e *Engine) rmPartyAccount(party, accid string) {
// this cannot be called for a party which do not have an account already
// so no risk here
accs := e.partiesAccs[party]
delete(accs, accid)
// delete if the number of accounts for the party
// is down to 0
// FIXME(): for now we do not delete the
// party, this means that the numbner of
// party will grow forever if they were to
// get distressed, or people would be adding
// funds the withdrawing them forever on load
// of party, but that is better than having
// transaction stay in the mempool forever.
// if len(accs) <= 0 {
// delete(e.partiesAccs, party)
// }
}
func (e *Engine) removeAccountFromHashableSlice(id string) {
i := sort.Search(len(e.hashableAccs), func(i int) bool {
return e.hashableAccs[i].ID >= id
})
copy(e.hashableAccs[i:], e.hashableAccs[i+1:])
e.hashableAccs = e.hashableAccs[:len(e.hashableAccs)-1]
e.state.updateAccs(e.hashableAccs)
}
func (e *Engine) addAccountToHashableSlice(acc *types.Account) {
// sell side levels should be ordered in ascending
i := sort.Search(len(e.hashableAccs), func(i int) bool {
return e.hashableAccs[i].ID >= acc.ID
})
if i < len(e.hashableAccs) && e.hashableAccs[i].ID == acc.ID {
// for some reason it was already there, return now
return
}
e.hashableAccs = append(e.hashableAccs, nil)
copy(e.hashableAccs[i+1:], e.hashableAccs[i:])
e.hashableAccs[i] = acc
e.state.updateAccs(e.hashableAccs)
}
func (e *Engine) Hash() []byte {
output := make([]byte, len(e.hashableAccs)*32)
var i int
for _, k := range e.hashableAccs {
bal := k.Balance.Bytes()
copy(output[i:], bal[:])
i += 32
}
return crypto.Hash(output)
}
// ReloadConf updates the internal configuration of the collateral engine.
func (e *Engine) ReloadConf(cfg Config) {
e.log.Info("reloading configuration")
if e.log.GetLevel() != cfg.Level.Get() {
e.log.Info("updating log level",
logging.String("old", e.log.GetLevel().String()),
logging.String("new", cfg.Level.String()),
)
e.log.SetLevel(cfg.Level.Get())
}
e.cfgMu.Lock()
e.Config = cfg
e.cfgMu.Unlock()
}
// EnableAsset adds a new asset in the collateral engine
// this enable the asset to be used by new markets or
// parties to deposit funds.
func (e *Engine) EnableAsset(ctx context.Context, asset types.Asset) error {
if e.AssetExists(asset.ID) {
return ErrAssetAlreadyEnabled
}
e.enabledAssets[asset.ID] = asset
// update state
e.state.enableAsset(asset)
// then creat a new infrastructure fee account for the asset
// these are fee related account only
infraFeeID := e.accountID(noMarket, systemOwner, asset.ID, types.AccountTypeFeesInfrastructure)
_, ok := e.accs[infraFeeID]
if !ok {
infraFeeAcc := &types.Account{
ID: infraFeeID,
Asset: asset.ID,
Owner: systemOwner,
Balance: num.UintZero(),
MarketID: noMarket,
Type: types.AccountTypeFeesInfrastructure,
}
e.accs[infraFeeID] = infraFeeAcc
e.addAccountToHashableSlice(infraFeeAcc)
e.broker.Send(events.NewAccountEvent(ctx, *infraFeeAcc))
}
externalID := e.accountID(noMarket, systemOwner, asset.ID, types.AccountTypeExternal)
if _, ok := e.accs[externalID]; !ok {
externalAcc := &types.Account{
ID: externalID,
Asset: asset.ID,
Owner: systemOwner,
Balance: num.UintZero(),
MarketID: noMarket,
Type: types.AccountTypeExternal,
}
e.accs[externalID] = externalAcc
// This account originally wan't added to the app-state hash of accounts because it can always be "reconstructed" from
// the withdrawal/deposits in banking. For snapshotting we we need to restore it and so instead of trying to make
// something thats already complicated more complex. we're just going to include it in the apphash which then gets
// included in the snapshot.
// see https://github.com/vegaprotocol/vega/pull/2745 for more information
e.addAccountToHashableSlice(externalAcc)
e.broker.Send(events.NewAccountEvent(ctx, *externalAcc))
}
// when an asset is enabled a global reward account (aka network treasury) is created for it along with the other 4 types of rewards
rewardAccountTypes := []vega.AccountType{types.AccountTypeGlobalReward}
for _, rewardAccountType := range rewardAccountTypes {
rewardID := e.accountID(noMarket, systemOwner, asset.ID, rewardAccountType)
if _, ok := e.accs[rewardID]; !ok {
rewardAcc := &types.Account{
ID: rewardID,
Asset: asset.ID,
Owner: systemOwner,
Balance: num.UintZero(),
MarketID: noMarket,
Type: rewardAccountType,
}
e.accs[rewardID] = rewardAcc
e.addAccountToHashableSlice(rewardAcc)
e.broker.Send(events.NewAccountEvent(ctx, *rewardAcc))
}
}
// pending transfers account
pendingTransfersID := e.accountID(noMarket, systemOwner, asset.ID, types.AccountTypePendingTransfers)
if _, ok := e.accs[pendingTransfersID]; !ok {
pendingTransfersAcc := &types.Account{
ID: pendingTransfersID,
Asset: asset.ID,
Owner: systemOwner,
Balance: num.UintZero(),
MarketID: noMarket,
Type: types.AccountTypePendingTransfers,
}
e.accs[pendingTransfersID] = pendingTransfersAcc
e.addAccountToHashableSlice(pendingTransfersAcc)
e.broker.Send(events.NewAccountEvent(ctx, *pendingTransfersAcc))
}
e.log.Info("new asset added successfully",
logging.AssetID(asset.ID),
)
return nil
}
func (e *Engine) PropagateAssetUpdate(ctx context.Context, asset types.Asset) error {
if !e.AssetExists(asset.ID) {
return ErrAssetHasNotBeenEnabled
}
e.enabledAssets[asset.ID] = asset
e.state.updateAsset(asset)
// e.broker.Send(events.NewAssetEvent(ctx, asset))
return nil
}
// AssetExists no errors if the asset exists.
func (e *Engine) AssetExists(assetID string) bool {
_, ok := e.enabledAssets[assetID]
return ok
}
// this func uses named returns because it makes body of the func look clearer.
func (e *Engine) getSystemAccounts(marketID, asset string) (settle, insurance *types.Account, err error) {
insID := e.accountID(marketID, systemOwner, asset, types.AccountTypeInsurance)
setID := e.accountID(marketID, systemOwner, asset, types.AccountTypeSettlement)
if insurance, err = e.GetAccountByID(insID); err != nil {
if e.log.GetLevel() == logging.DebugLevel {
e.log.Debug("missing system account",
logging.String("asset", asset),
logging.String("id", insID),
logging.String("market", marketID),
logging.Error(err),
)
}
err = ErrSystemAccountsMissing
return
}
if settle, err = e.GetAccountByID(setID); err != nil {
if e.log.GetLevel() == logging.DebugLevel {
e.log.Debug("missing system account",
logging.String("asset", asset),
logging.String("id", setID),
logging.String("market", marketID),
logging.Error(err),
)
}
err = ErrSystemAccountsMissing
}
return
}
func (e *Engine) TransferFees(ctx context.Context, marketID string, assetID string, ft events.FeesTransfer) ([]*types.LedgerMovement, error) {
return e.transferFees(ctx, marketID, assetID, ft)
}
// returns the corresponding transfer request for the slice of transfers
// if the reward accound doesn't exist return error
// if the party account doesn't exist log the error and continue.
func (e *Engine) getRewardTransferRequests(ctx context.Context, rewardAccountID string, transfers []*types.Transfer) ([]*types.TransferRequest, error) {
rewardAccount, err := e.GetAccountByID(rewardAccountID)
if err != nil {
return nil, err
}
rewardTRs := make([]*types.TransferRequest, 0, len(transfers))
for _, t := range transfers {
general, err := e.GetPartyGeneralAccount(t.Owner, t.Amount.Asset)
if err != nil {
_, err = e.CreatePartyGeneralAccount(ctx, t.Owner, t.Amount.Asset)
if err != nil {
continue
}
general, _ = e.GetPartyGeneralAccount(t.Owner, t.Amount.Asset)
}
rewardTRs = append(rewardTRs, &types.TransferRequest{
Amount: t.Amount.Amount.Clone(),
MinAmount: t.Amount.Amount.Clone(),
Asset: t.Amount.Asset,
Type: types.TransferTypeRewardPayout,
FromAccount: []*types.Account{rewardAccount},
ToAccount: []*types.Account{general},
})
}
return rewardTRs, nil
}
// TransferRewards takes a slice of transfers and serves them to transfer rewards from the reward account to parties general account.
func (e *Engine) TransferRewards(ctx context.Context, rewardAccountID string, transfers []*types.Transfer) ([]*types.LedgerMovement, error) {
responses := make([]*types.LedgerMovement, 0, len(transfers))
if len(transfers) == 0 {
return responses, nil
}
transferReqs, err := e.getRewardTransferRequests(ctx, rewardAccountID, transfers)
if err != nil {
return nil, err
}
for _, req := range transferReqs {
res, err := e.getLedgerEntries(ctx, req)
if err != nil {
e.log.Error("Failed to transfer funds", logging.Error(err))
return nil, err
}
for _, bal := range res.Balances {
if err := e.IncrementBalance(ctx, bal.Account.ID, bal.Balance); err != nil {
e.log.Error("Could not update the target account in transfer",
logging.String("account-id", bal.Account.ID),
logging.Error(err))
return nil, err
}
}
responses = append(responses, res)
}
return responses, nil
}
func (e *Engine) TransferFeesContinuousTrading(ctx context.Context, marketID string, assetID string, ft events.FeesTransfer) ([]*types.LedgerMovement, error) {
if len(ft.Transfers()) <= 0 {
return nil, nil
}
// check quickly that all parties have enough monies in their accounts
// this may be done only in case of continuous trading
for party, amount := range ft.TotalFeesAmountPerParty() {
generalAcc, err := e.GetAccountByID(e.accountID(noMarket, party, assetID, types.AccountTypeGeneral))
if err != nil {
e.log.Error("unable to get party account",
logging.String("account-type", "general"),
logging.String("party-id", party),
logging.String("asset", assetID))
return nil, ErrAccountDoesNotExist
}
marginAcc, err := e.GetAccountByID(e.accountID(marketID, party, assetID, types.AccountTypeMargin))
if err != nil {
e.log.Error("unable to get party account",
logging.String("account-type", "margin"),
logging.String("party-id", party),
logging.String("asset", assetID),
logging.String("market-id", marketID))
return nil, ErrAccountDoesNotExist
}
if num.Sum(marginAcc.Balance, generalAcc.Balance).LT(amount) {
return nil, ErrInsufficientFundsToPayFees
}
}
return e.transferFees(ctx, marketID, assetID, ft)
}
func (e *Engine) transferFees(ctx context.Context, marketID string, assetID string, ft events.FeesTransfer) ([]*types.LedgerMovement, error) {
makerFee, infraFee, liquiFee, err := e.getFeesAccounts(marketID, assetID)
if err != nil {
return nil, err
}
transfers := ft.Transfers()
responses := make([]*types.LedgerMovement, 0, len(transfers))
for _, transfer := range transfers {
req, err := e.getFeeTransferRequest(
transfer, makerFee, infraFee, liquiFee, marketID, assetID)
if err != nil {
e.log.Error("Failed to build transfer request for event",
logging.Error(err))
return nil, err
}
res, err := e.getLedgerEntries(ctx, req)
if err != nil {
e.log.Error("Failed to transfer funds", logging.Error(err))
return nil, err
}
for _, bal := range res.Balances {
if err := e.IncrementBalance(ctx, bal.Account.ID, bal.Balance); err != nil {
e.log.Error("Could not update the target account in transfer",
logging.String("account-id", bal.Account.ID),
logging.Error(err))
return nil, err
}
}
responses = append(responses, res)
}
return responses, nil
}
// GetInfraFeeAccountIDs returns the account IDs of the infrastructure fee accounts for all enabled assets.
func (e *Engine) GetInfraFeeAccountIDs() []string {
accountIDs := []string{}
for asset := range e.enabledAssets {
accountIDs = append(accountIDs, e.accountID(noMarket, systemOwner, asset, types.AccountTypeFeesInfrastructure))
}
sort.Strings(accountIDs)
return accountIDs
}
// GetPendingTransferAccount return the pending transfers account for the asset.
func (e *Engine) GetPendingTransfersAccount(asset string) *types.Account {
acc, err := e.GetAccountByID(e.accountID(noMarket, systemOwner, asset, types.AccountTypePendingTransfers))
if err != nil {
e.log.Panic("no pending transfers account for asset, this should never happen",
logging.AssetID(asset),
)
}
return acc
}
// this func uses named returns because it makes body of the func look clearer.
func (e *Engine) getFeesAccounts(marketID, asset string) (maker, infra, liqui *types.Account, err error) {
makerID := e.accountID(marketID, systemOwner, asset, types.AccountTypeFeesMaker)
infraID := e.accountID(noMarket, systemOwner, asset, types.AccountTypeFeesInfrastructure)
liquiID := e.accountID(marketID, systemOwner, asset, types.AccountTypeFeesLiquidity)
if maker, err = e.GetAccountByID(makerID); err != nil {
if e.log.GetLevel() == logging.DebugLevel {
e.log.Debug("missing fee account",
logging.String("asset", asset),
logging.String("id", makerID),
logging.String("market", marketID),
logging.Error(err),
)
}
err = ErrFeeAccountsMissing
return
}
if infra, err = e.GetAccountByID(infraID); err != nil {
if e.log.GetLevel() == logging.DebugLevel {
e.log.Debug("missing fee account",
logging.String("asset", asset),
logging.String("id", infraID),
logging.Error(err),
)
}
}
if liqui, err = e.GetAccountByID(liquiID); err != nil {
if e.log.GetLevel() == logging.DebugLevel {
e.log.Debug("missing system account",
logging.String("asset", asset),
logging.String("id", liquiID),
logging.String("market", marketID),
logging.Error(err),
)
}
}
if err != nil {
err = ErrFeeAccountsMissing
}
return maker, infra, liqui, err
}
func (e *Engine) CheckLeftOverBalance(ctx context.Context, settle *types.Account, transfers []*types.Transfer, asset string) (*types.LedgerMovement, error) {
if settle.Balance.IsZero() {
return nil, nil
}
e.log.Error("final settlement left asset unit in the settlement, transferring to the asset reward account", logging.String("remaining-settle-balance", settle.Balance.String()))
for _, t := range transfers {
e.log.Error("final settlement transfer", logging.String("amount", t.Amount.String()), logging.Int32("type", int32(t.Type)))
}
// if there's just one asset unit left over from some weird rounding issue, transfer it to the global reward account
if settle.Balance.EQ(num.UintOne()) {
e.log.Warn("final settlement left 1 asset unit in the settlement, transferring to the asset reward account")
req := &types.TransferRequest{
FromAccount: make([]*types.Account, 1),
ToAccount: make([]*types.Account, 1),
Asset: asset,
Type: types.TransferTypeClearAccount,
}
globalRewardPool, _ := e.GetGlobalRewardAccount(asset)
req.FromAccount[0] = settle
req.ToAccount = []*types.Account{globalRewardPool}
req.Amount = num.UintOne()
ledgerEntries, err := e.getLedgerEntries(ctx, req)
if err != nil {
e.log.Panic("unable to redistribute settlement leftover funds", logging.Error(err))
}
for _, bal := range ledgerEntries.Balances {
if err := e.IncrementBalance(ctx, bal.Account.ID, bal.Balance); err != nil {
e.log.Error("Could not update the target account in transfer",
logging.String("account-id", bal.Account.ID),
logging.Error(err))
return nil, err
}
}
return ledgerEntries, nil
}
// if there's more than one, panic
e.log.Panic("settlement balance is not zero", logging.BigUint("balance", settle.Balance))
return nil, nil
}
// FinalSettlement will process the list of transfer instructed by other engines
// This func currently only expects TransferType_{LOSS,WIN} transfers
// other transfer types have dedicated funcs (MartToMarket, MarginUpdate).
func (e *Engine) FinalSettlement(ctx context.Context, marketID string, transfers []*types.Transfer) ([]*types.LedgerMovement, error) {
// stop immediately if there aren't any transfers, channels are closed
if len(transfers) == 0 {
return nil, nil
}
responses := make([]*types.LedgerMovement, 0, len(transfers))
asset := transfers[0].Amount.Asset
var (
winidx int
expectCollected num.Decimal
expCollected = num.UintZero()
totalAmountCollected = num.UintZero()
)
now := e.timeService.GetTimeNow().UnixNano()
brokerEvts := make([]events.Event, 0, len(transfers))
settle, insurance, err := e.getSystemAccounts(marketID, asset)
if err != nil {
e.log.Error(
"Failed to get system accounts required for final settlement",
logging.Error(err),
)
return nil, err
}
// process loses first
for i, transfer := range transfers {
if transfer == nil {
continue
}
if transfer.Type == types.TransferTypeWin {
// we processed all losses break then
winidx = i
break
}
req, err := e.getTransferRequest(transfer, settle, insurance, &marginUpdate{})
if err != nil {
e.log.Error(
"Failed to build transfer request for event",
logging.Error(err),
)
return nil, err
}
// accumulate the expected transfer size
expCollected.AddSum(req.Amount)
expectCollected = expectCollected.Add(num.DecimalFromUint(req.Amount))
// doing a copy of the amount here, as the request is send to listLedgerEntries, which actually
// modifies it
requestAmount := req.Amount.Clone()
// set the amount (this can change the req.Amount value if we entered loss socialisation
res, err := e.getLedgerEntries(ctx, req)
if err != nil {
e.log.Error(
"Failed to transfer funds",
logging.Error(err),
)
return nil, err
}
amountCollected := num.UintZero()
for _, bal := range res.Balances {
amountCollected.AddSum(bal.Balance)
if err := e.IncrementBalance(ctx, bal.Account.ID, bal.Balance); err != nil {
e.log.Error(
"Could not update the target account in transfer",
logging.String("account-id", bal.Account.ID),
logging.Error(err),
)
return nil, err
}
}
totalAmountCollected.AddSum(amountCollected)
responses = append(responses, res)
// Update to see how much we still need
requestAmount = requestAmount.Sub(requestAmount, amountCollected)
if transfer.Owner != types.NetworkParty {
// no error possible here, we're just reloading the accounts to ensure the correct balance
general, margin, _ := e.getMTMPartyAccounts(transfer.Owner, marketID, asset)
if totalInAccount := num.Sum(general.Balance, margin.Balance); totalInAccount.LT(requestAmount) {
delta := req.Amount.Sub(requestAmount, totalInAccount)
e.log.Warn("loss socialization missing amount to be collected or used from insurance pool",
logging.String("party-id", transfer.Owner),
logging.BigUint("amount", delta),
logging.String("market-id", settle.MarketID))
brokerEvts = append(brokerEvts,
events.NewLossSocializationEvent(ctx, transfer.Owner, marketID, delta, false, now))
}
}
}
if len(brokerEvts) > 0 {
e.broker.SendBatch(brokerEvts)
}
// if winidx is 0, this means we had now win and loss, but may have some event which
// needs to be propagated forward so we return now.
if winidx == 0 {
if !settle.Balance.IsZero() {
e.log.Panic("settlement balance is not zero", logging.BigUint("balance", settle.Balance))
}
return responses, nil
}
// now compare what's in the settlement account what we expect initially to redistribute.
// if there's not enough we enter loss socialization
distr := simpleDistributor{
log: e.log,
marketID: marketID,
expectCollected: expCollected,
collected: totalAmountCollected,
requests: make([]request, 0, len(transfers)-winidx),
ts: now,
}
if distr.LossSocializationEnabled() {
e.log.Warn("Entering loss socialization on final settlement",
logging.String("market-id", marketID),
logging.String("asset", asset),
logging.BigUint("expect-collected", expCollected),
logging.BigUint("collected", settle.Balance))
for _, transfer := range transfers[winidx:] {
if transfer != nil && transfer.Type == types.TransferTypeWin {
distr.Add(transfer)
}
}
if evts := distr.Run(ctx); len(evts) != 0 {
e.broker.SendBatch(evts)
}
}
// then we process all the wins
for _, transfer := range transfers[winidx:] {
if transfer == nil {
continue
}
req, err := e.getTransferRequest(transfer, settle, insurance, &marginUpdate{})
if err != nil {
e.log.Error(
"Failed to build transfer request for event",
logging.Error(err),
)
return nil, err
}
// set the amount (this can change the req.Amount value if we entered loss socialisation
res, err := e.getLedgerEntries(ctx, req)
if err != nil {
e.log.Error(
"Failed to transfer funds",
logging.Error(err),
)
return nil, err
}
// update the to accounts now
for _, bal := range res.Balances {
if err := e.IncrementBalance(ctx, bal.Account.ID, bal.Balance); err != nil {
e.log.Error(
"Could not update the target account in transfer",
logging.String("account-id", bal.Account.ID),
logging.Error(err),
)
return nil, err
}
}
responses = append(responses, res)
}
leftoverLedgerEntry, err := e.CheckLeftOverBalance(ctx, settle, transfers, asset)
if err != nil {
return nil, err
}
if leftoverLedgerEntry != nil {
responses = append(responses, leftoverLedgerEntry)
}
return responses, nil
}
func (e *Engine) getMTMPartyAccounts(party, marketID, asset string) (gen, margin *types.Account, err error) {
// no need to look any further
if party == types.NetworkParty {
return nil, nil, nil
}
gen, err = e.GetAccountByID(e.accountID(noMarket, party, asset, types.AccountTypeGeneral))
if err != nil {
return nil, nil, err
}
margin, err = e.GetAccountByID(e.accountID(marketID, party, asset, types.AccountTypeMargin))
return
}
// MarkToMarket will run the mark to market settlement over a given set of positions
// return ledger move stuff here, too (separate return value, because we need to stream those).
func (e *Engine) MarkToMarket(ctx context.Context, marketID string, transfers []events.Transfer, asset string) ([]events.Margin, []*types.LedgerMovement, error) {
// stop immediately if there aren't any transfers, channels are closed
if len(transfers) == 0 {
return nil, nil, nil
}
marginEvts := make([]events.Margin, 0, len(transfers))
responses := make([]*types.LedgerMovement, 0, len(transfers))
// This is where we'll implement everything
settle, insurance, err := e.getSystemAccounts(marketID, asset)
if err != nil {
e.log.Error(
"Failed to get system accounts required for MTM settlement",
logging.Error(err),
)
return nil, nil, err
}
// get the component that calculates the loss socialisation etc... if needed
var (
winidx int
expectCollected num.Decimal
expCollected = num.UintZero()
)
// create batch of events
brokerEvts := make([]events.Event, 0, len(transfers))
now := e.timeService.GetTimeNow().UnixNano()
// iterate over transfer until we get the first win, so we need we accumulated all loss
for i, evt := range transfers {
party := evt.Party()
transfer := evt.Transfer()
marginEvt := &marginUpdate{
MarketPosition: evt,
asset: asset,
marketID: settle.MarketID,
}
if party != types.NetworkParty {
// get the state of the accounts before processing transfers
// so they can be used in the marginEvt, and to calculate the missing funds
marginEvt.general, marginEvt.margin, err = e.getMTMPartyAccounts(party, settle.MarketID, asset)
if err != nil {
e.log.Error("unable to get party account",
logging.String("party-id", party),
logging.String("asset", asset),
logging.String("market-id", settle.MarketID))
}
}
// no transfer needed if transfer is nil, just build the marginUpdate
if transfer == nil {
// no error when getting MTM accounts, and no margin account == network position
// we are not interested in this event, continue here
if party != types.NetworkParty {
marginEvts = append(marginEvts, marginEvt)
}
continue
}
if transfer.Type == types.TransferTypeMTMWin {
// we processed all loss break then
winidx = i
break
}
req, err := e.getTransferRequest(transfer, settle, insurance, marginEvt)
if err != nil {
e.log.Error(
"Failed to build transfer request for event",
logging.Error(err),
)
return nil, nil, err
}
// accumulate the expected transfer size
expCollected.AddSum(req.Amount)
expectCollected = expectCollected.Add(num.DecimalFromUint(req.Amount))
// doing a copy of the amount here, as the request is send to listLedgerEntries, which actually
// modifies it
requestAmount := req.Amount.Clone()
// set the amount (this can change the req.Amount value if we entered loss socialisation
res, err := e.getLedgerEntries(ctx, req)
if err != nil {
e.log.Error(
"Failed to transfer funds",
logging.Error(err),
)
return nil, nil, err
}
amountCollected := num.UintZero()
// // update the to accounts now
for _, bal := range res.Balances {
amountCollected.AddSum(bal.Balance)
if err := e.IncrementBalance(ctx, bal.Account.ID, bal.Balance); err != nil {
e.log.Error(
"Could not update the target account in transfer",
logging.String("account-id", bal.Account.ID),
logging.Error(err),
)
return nil, nil, err
}
}
responses = append(responses, res)
// Update to see how much we still need
requestAmount = requestAmount.Sub(requestAmount, amountCollected)
// here we check if we were able to collect all monies,
// if not send an event to notify the plugins
if party != types.NetworkParty {
// no error possible here, we're just reloading the accounts to ensure the correct balance
marginEvt.general, marginEvt.margin, _ = e.getMTMPartyAccounts(party, settle.MarketID, asset)
if totalInAccount := num.Sum(marginEvt.general.Balance, marginEvt.margin.Balance); totalInAccount.LT(requestAmount) {
delta := req.Amount.Sub(requestAmount, totalInAccount)
e.log.Warn("loss socialization missing amount to be collected or used from insurance pool",
logging.String("party-id", party),
logging.BigUint("amount", delta),
logging.String("market-id", settle.MarketID))
brokerEvts = append(brokerEvts,
events.NewLossSocializationEvent(ctx, party, settle.MarketID, delta, false, now))
}
marginEvts = append(marginEvts, marginEvt)
} else {
// we've used the insurance account as a margin account for the network
// we have to update it to ensure we're aware of its balance
settle, insurance, _ = e.getSystemAccounts(marketID, asset)
}
}
if len(brokerEvts) > 0 {
e.broker.SendBatch(brokerEvts)
}
// we couldn't have reached this point without settlement account
// it's also prudent to reset the insurance account... the network position
// relies on its balance being accurate
settle, insurance, _ = e.getSystemAccounts(marketID, asset)
// if winidx is 0, this means we had now wind and loss, but may have some event which
// needs to be propagated forward so we return now.
if winidx == 0 {
if !settle.Balance.IsZero() {
e.log.Panic("No win transfers, settlement balance non-zero", logging.BigUint("settlement-balance", settle.Balance))
return nil, nil, ErrSettlementBalanceNotZero
}
return marginEvts, responses, nil
}
// now compare what's in the settlement account what we expect initially to redistribute.
// if there's not enough we enter loss socialization
distr := simpleDistributor{
log: e.log,
marketID: settle.MarketID,
expectCollected: expCollected,
collected: settle.Balance,
requests: make([]request, 0, len(transfers)-winidx),
ts: now,
}
if distr.LossSocializationEnabled() {
e.log.Warn("Entering loss socialization",
logging.String("market-id", marketID),
logging.String("asset", asset),
logging.BigUint("expect-collected", expCollected),
logging.BigUint("collected", settle.Balance))
for _, evt := range transfers[winidx:] {
transfer := evt.Transfer()
if transfer != nil && transfer.Type == types.TransferTypeMTMWin {
distr.Add(evt.Transfer())
}
}
if evts := distr.Run(ctx); len(evts) != 0 {
e.broker.SendBatch(evts)
}
}
// then we process all the wins
for _, evt := range transfers[winidx:] {
transfer := evt.Transfer()
party := evt.Party()
marginEvt := &marginUpdate{
MarketPosition: evt,
asset: asset,
marketID: settle.MarketID,
}
// no transfer needed if transfer is nil, just build the marginUpdate
if party != types.NetworkParty {
marginEvt.general, marginEvt.margin, err = e.getMTMPartyAccounts(party, settle.MarketID, asset)
if err != nil {
e.log.Error("unable to get party account",
logging.String("account-type", "margin"),
logging.String("party-id", evt.Party()),
logging.String("asset", asset),
logging.String("market-id", settle.MarketID))