-
Notifications
You must be signed in to change notification settings - Fork 91
/
transfer.go
411 lines (363 loc) · 10.9 KB
/
transfer.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
package keeper
import (
"fmt"
"math/big"
errorsmod "cosmossdk.io/errors"
sdk "github.com/cosmos/cosmos-sdk/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
"github.com/dydxprotocol/v4-chain/protocol/lib"
assettypes "github.com/dydxprotocol/v4-chain/protocol/x/assets/types"
clobtypes "github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
"github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
)
// getValidSubaccountUpdatesForTransfer generates subaccount updates and check
// for validity with `CanUpdateSubaccount()`
// Returns the subaccount updates if check is successful.
func (k Keeper) getValidSubaccountUpdatesForTransfer(
ctx sdk.Context,
subaccountId types.SubaccountId,
assetId uint32,
quantums *big.Int,
isToSubaccount bool,
) (
updates []types.Update,
err error,
) {
bigBalanceDelta := new(big.Int).Set(quantums)
if !isToSubaccount {
bigBalanceDelta.Neg(bigBalanceDelta)
}
if assetId == 0 {
updates = []types.Update{
{
SubaccountId: subaccountId,
AssetUpdates: []types.AssetUpdate{
{
AssetId: assettypes.AssetUsdc.Id,
BigQuantumsDelta: bigBalanceDelta,
},
},
},
}
} else {
// TODO(DEC-715): Support non-USDC assets.
return nil, types.ErrAssetTransferThroughBankNotImplemented
}
success, successPerUpdate, err := k.CanUpdateSubaccounts(ctx, updates)
if err != nil {
return nil, err
}
// If not successful, return error indicating why.
if err := types.GetErrorFromUpdateResults(success, successPerUpdate, updates); err != nil {
return nil, err
}
return updates, nil
}
// applyValidSubaccountUpdatesForTransfer updates the subaccount by either
// debiting or crediting the subaccount balance.
// Panics if the update fails, as this function assumes the corresponding
// bankKeeper update was successful.
func (k Keeper) applyValidSubaccountUpdateForTransfer(
ctx sdk.Context,
updates []types.Update,
) error {
// Update subaccount to reflect the transfer.
success, successPerUpdate, err := k.UpdateSubaccounts(ctx, updates)
// Neither of the two conditions below should be true, since `k.CanUpdateSubaccount()`
// already succeeded.
if err != nil {
return err
}
return types.GetErrorFromUpdateResults(success, successPerUpdate, updates)
}
// TransferFundsFromSubaccountToModule returns an error if the call to `k.CanUpdateSubaccounts()`
// fails. Otherwise, deducts the asset quantums from the subaccount, translates the
// `assetId` and `quantums` into a `sdk.Coin`, and calls
// `bankKeeper.SendCoinsFromModuleToModule()`.
func (k Keeper) TransferFundsFromSubaccountToModule(
ctx sdk.Context,
fromSubaccountId types.SubaccountId,
toModule string,
assetId uint32,
quantums *big.Int,
) error {
// TODO(DEC-715): Support non-USDC assets.
if assetId != assettypes.AssetUsdc.Id {
return types.ErrAssetTransferThroughBankNotImplemented
}
if quantums.Sign() <= 0 {
return errorsmod.Wrap(types.ErrAssetTransferQuantumsNotPositive, lib.UintToString(assetId))
}
convertedQuantums, coinToTransfer, err := k.assetsKeeper.ConvertAssetToCoin(
ctx,
assetId,
quantums,
)
if err != nil {
return err
}
// Generate subaccount updates and check whether updates can be applied.
updates, err := k.getValidSubaccountUpdatesForTransfer(
ctx,
fromSubaccountId,
assetId,
convertedQuantums,
false, // isToSubaccount
)
if err != nil {
return err
}
// Send coins from the `subaccounts` module account to `toModule`.
if err := k.bankKeeper.SendCoinsFromModuleToModule(
ctx,
types.ModuleName, // senderModule
toModule, // recipientModule
[]sdk.Coin{coinToTransfer},
); err != nil {
return err
}
// Apply subaccount updates.
if err := k.applyValidSubaccountUpdateForTransfer(
ctx,
updates,
); err != nil {
panic(fmt.Sprintf("SendCoinsFromModuleToModule() succeeded but UpdateSubaccounts() failed: %v", err))
}
return nil
}
// TransferFundsFromModuleToSubaccount returns an error if the call to `k.CanUpdateSubaccounts()`
// fails. Otherwise, increases the asset quantums in the subaccount, translates the
// `assetId` and `quantums` into a `sdk.Coin`, and calls `bankKeeper.SendCoinsFromModuleToModule()`.
func (k Keeper) TransferFundsFromModuleToSubaccount(
ctx sdk.Context,
fromModule string,
toSubaccountId types.SubaccountId,
assetId uint32,
quantums *big.Int,
) error {
// TODO(DEC-715): Support non-USDC assets.
if assetId != assettypes.AssetUsdc.Id {
return types.ErrAssetTransferThroughBankNotImplemented
}
if quantums.Sign() <= 0 {
return errorsmod.Wrap(types.ErrAssetTransferQuantumsNotPositive, lib.UintToString(assetId))
}
convertedQuantums, coinToTransfer, err := k.assetsKeeper.ConvertAssetToCoin(
ctx,
assetId,
quantums,
)
if err != nil {
return err
}
// Generate subaccount updates and check whether updates can be applied.
updates, err := k.getValidSubaccountUpdatesForTransfer(
ctx,
toSubaccountId,
assetId,
convertedQuantums,
true, // isToSubaccount
)
if err != nil {
return err
}
// Send coins from `fromModule` to the `subaccounts` module account.
if err := k.bankKeeper.SendCoinsFromModuleToModule(
ctx,
fromModule, // senderModule
types.ModuleName, // recipientModule
[]sdk.Coin{coinToTransfer},
); err != nil {
return err
}
// Apply subaccount updates.
return k.applyValidSubaccountUpdateForTransfer(
ctx,
updates,
)
}
// DepositFundsFromAccountToSubaccount returns an error if the call to `k.CanUpdateSubaccounts()`
// fails. Otherwise, increases the asset quantums in the subaccount, translates the
// `assetId` and `quantums` into a `sdk.Coin`, and calls
// `bankKeeper.SendCoinsFromAccountToModule()`.
// TODO(CORE-168): Change function interface to accept `denom` and `amount` instead of `assetId` and `quantums`.
func (k Keeper) DepositFundsFromAccountToSubaccount(
ctx sdk.Context,
fromAccount sdk.AccAddress,
toSubaccountId types.SubaccountId,
assetId uint32,
quantums *big.Int,
) error {
// TODO(DEC-715): Support non-USDC assets.
if assetId != assettypes.AssetUsdc.Id {
return types.ErrAssetTransferThroughBankNotImplemented
}
if quantums.Sign() <= 0 {
return errorsmod.Wrap(types.ErrAssetTransferQuantumsNotPositive, lib.UintToString(assetId))
}
convertedQuantums, coinToTransfer, err := k.assetsKeeper.ConvertAssetToCoin(
ctx,
assetId,
quantums,
)
if err != nil {
return err
}
// Generate subaccount updates and check whether updates can be applied.
updates, err := k.getValidSubaccountUpdatesForTransfer(
ctx,
toSubaccountId,
assetId,
convertedQuantums,
true, // isToSubaccount
)
if err != nil {
return err
}
// Send coins from `fromModule` to the `subaccounts` module account.
if err := k.bankKeeper.SendCoinsFromAccountToModule(
ctx,
fromAccount,
types.ModuleName,
[]sdk.Coin{coinToTransfer},
); err != nil {
return err
}
// Apply subaccount updates.
return k.applyValidSubaccountUpdateForTransfer(
ctx,
updates,
)
}
// WithdrawFundsFromSubaccountToAccount returns an error if the call to `k.CanUpdateSubaccounts()`
// fails. Otherwise, deducts the asset quantums from the subaccount, translates the
// `assetId` and `quantums` into a `sdk.Coin`, and calls `bankKeeper.SendCoinsFromModuleToAccount()`.
func (k Keeper) WithdrawFundsFromSubaccountToAccount(
ctx sdk.Context,
fromSubaccountId types.SubaccountId,
toAccount sdk.AccAddress,
assetId uint32,
quantums *big.Int,
) error {
// TODO(DEC-715): Support non-USDC assets.
if assetId != assettypes.AssetUsdc.Id {
return types.ErrAssetTransferThroughBankNotImplemented
}
if quantums.Sign() <= 0 {
return errorsmod.Wrap(types.ErrAssetTransferQuantumsNotPositive, lib.UintToString(assetId))
}
convertedQuantums, coinToTransfer, err := k.assetsKeeper.ConvertAssetToCoin(
ctx,
assetId,
quantums,
)
if err != nil {
return err
}
// Generate subaccount updates and check whether updates can be applied.
updates, err := k.getValidSubaccountUpdatesForTransfer(
ctx,
fromSubaccountId,
assetId,
convertedQuantums,
false, // isToSubaccount
)
if err != nil {
return err
}
// Send coins from `fromModule` to the `subaccounts` module account.
if err := k.bankKeeper.SendCoinsFromModuleToAccount(
ctx,
types.ModuleName,
toAccount,
[]sdk.Coin{coinToTransfer},
); err != nil {
return err
}
// Apply subaccount updates.
return k.applyValidSubaccountUpdateForTransfer(
ctx,
updates,
)
}
// TransferFeesToFeeCollectorModule translates the assetId and quantums into a sdk.Coin,
// and moves the funds from subaccounts module to the `fee_collector` module account by calling
// bankKeeper.SendCoinsFromModuleToModule(). Does not change any individual subaccount state.
func (k Keeper) TransferFeesToFeeCollectorModule(
ctx sdk.Context,
assetId uint32,
quantums *big.Int,
) error {
// TODO(DEC-715): Support non-USDC assets.
if assetId != assettypes.AssetUsdc.Id {
return types.ErrAssetTransferThroughBankNotImplemented
}
if quantums.Sign() == 0 {
return nil
}
_, coinToTransfer, err := k.assetsKeeper.ConvertAssetToCoin(
ctx,
assetId,
new(big.Int).Abs(quantums),
)
if err != nil {
return err
}
// Send coins from `subaccounts` to the `auth` module fee collector account.
fromModule := types.ModuleName
toModule := authtypes.FeeCollectorName
if quantums.Sign() < 0 {
// In the case of a liquidation, net fees can be negative if the maker gets a rebate.
fromModule, toModule = toModule, fromModule
}
if err := k.bankKeeper.SendCoinsFromModuleToModule(
ctx,
fromModule,
toModule,
[]sdk.Coin{coinToTransfer},
); err != nil {
return err
}
return nil
}
// TransferInsuranceFundPayments transfers funds in and out of the insurance fund to the subaccounts
// module by calling `bankKeeper.SendCoinsFromModuleToModule`.
// This function transfers funds
// - from the insurance fund to the subaccounts module when `insuranceFundDelta` is negative.
// - from the subaccounts module to the insurance fund when `insuranceFundDelta` is positive.
// - does nothing if `insuranceFundDelta` is zero.
//
// If the sender account does not have enough balance for the transfer, an error is returned.
// Note this function does not change any individual subaccount state.
func (k Keeper) TransferInsuranceFundPayments(
ctx sdk.Context,
insuranceFundDelta *big.Int,
) error {
if insuranceFundDelta.Sign() == 0 {
return nil
}
_, coinToTransfer, err := k.assetsKeeper.ConvertAssetToCoin(
ctx,
assettypes.AssetUsdc.Id,
new(big.Int).Abs(insuranceFundDelta),
)
if err != nil {
// Panic if USDC does not exist.
panic(err)
}
// Determine the sender and receiver.
// Send coins from `subaccounts` to the `insurance_fund` module account by default.
fromModule := types.ModuleName
toModule := clobtypes.InsuranceFundName
if insuranceFundDelta.Sign() < 0 {
// Insurance fund needs to cover losses from liquidations.
// Send coins from the insurance fund to the `subaccounts` module account.
fromModule, toModule = toModule, fromModule
}
return k.bankKeeper.SendCoinsFromModuleToModule(
ctx,
fromModule,
toModule,
[]sdk.Coin{coinToTransfer},
)
}