/
grpc_query.go
569 lines (481 loc) · 16.3 KB
/
grpc_query.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
package keeper
import (
"context"
"fmt"
"strings"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/percosis-labs/fury/x/earn/types"
)
type queryServer struct {
keeper Keeper
}
// NewQueryServerImpl creates a new server for handling gRPC queries.
func NewQueryServerImpl(k Keeper) types.QueryServer {
return &queryServer{keeper: k}
}
var _ types.QueryServer = queryServer{}
// Params implements the gRPC service handler for querying x/earn parameters.
func (s queryServer) Params(
ctx context.Context,
req *types.QueryParamsRequest,
) (*types.QueryParamsResponse, error) {
if req == nil {
return nil, status.Errorf(codes.InvalidArgument, "empty request")
}
sdkCtx := sdk.UnwrapSDKContext(ctx)
params := s.keeper.GetParams(sdkCtx)
return &types.QueryParamsResponse{Params: params}, nil
}
// Vaults implements the gRPC service handler for querying x/earn vaults.
func (s queryServer) Vaults(
ctx context.Context,
req *types.QueryVaultsRequest,
) (*types.QueryVaultsResponse, error) {
if req == nil {
return nil, status.Errorf(codes.InvalidArgument, "empty request")
}
sdkCtx := sdk.UnwrapSDKContext(ctx)
allowedVaults := s.keeper.GetAllowedVaults(sdkCtx)
allowedVaultsMap := make(map[string]types.AllowedVault)
visitedMap := make(map[string]bool)
for _, av := range allowedVaults {
allowedVaultsMap[av.Denom] = av
visitedMap[av.Denom] = false
}
vaults := []types.VaultResponse{}
var vaultRecordsErr error
// Iterate over vault records instead of AllowedVaults to get all bfury-*
// vaults
s.keeper.IterateVaultRecords(sdkCtx, func(record types.VaultRecord) bool {
// Check if bfury, use allowed vault
allowedVaultDenom := record.TotalShares.Denom
if strings.HasPrefix(record.TotalShares.Denom, bfuryPrefix) {
allowedVaultDenom = bfuryDenom
}
allowedVault, found := allowedVaultsMap[allowedVaultDenom]
if !found {
vaultRecordsErr = fmt.Errorf("vault record not found for vault record denom %s", record.TotalShares.Denom)
return true
}
totalValue, err := s.keeper.GetVaultTotalValue(sdkCtx, record.TotalShares.Denom)
if err != nil {
vaultRecordsErr = err
// Stop iterating if error
return true
}
vaults = append(vaults, types.VaultResponse{
Denom: record.TotalShares.Denom,
Strategies: allowedVault.Strategies,
IsPrivateVault: allowedVault.IsPrivateVault,
AllowedDepositors: addressSliceToStringSlice(allowedVault.AllowedDepositors),
TotalShares: record.TotalShares.Amount.String(),
TotalValue: totalValue.Amount,
})
// Mark this allowed vault as visited
visitedMap[allowedVaultDenom] = true
return false
})
if vaultRecordsErr != nil {
return nil, vaultRecordsErr
}
// Add the allowed vaults that have not been visited yet
// These are always empty vaults, as the vault would have been visited
// earlier if there are any deposits
for denom, visited := range visitedMap {
if visited {
continue
}
allowedVault, found := allowedVaultsMap[denom]
if !found {
return nil, fmt.Errorf("vault record not found for vault record denom %s", denom)
}
vaults = append(vaults, types.VaultResponse{
Denom: denom,
Strategies: allowedVault.Strategies,
IsPrivateVault: allowedVault.IsPrivateVault,
AllowedDepositors: addressSliceToStringSlice(allowedVault.AllowedDepositors),
// No shares, no value
TotalShares: sdk.ZeroDec().String(),
TotalValue: sdk.ZeroInt(),
})
}
// Does not include vaults that have no deposits, only iterates over vault
// records which exists only for those with deposits.
return &types.QueryVaultsResponse{
Vaults: vaults,
}, nil
}
// Vaults implements the gRPC service handler for querying x/earn vaults.
func (s queryServer) Vault(
ctx context.Context,
req *types.QueryVaultRequest,
) (*types.QueryVaultResponse, error) {
if req == nil {
return nil, status.Errorf(codes.InvalidArgument, "empty request")
}
sdkCtx := sdk.UnwrapSDKContext(ctx)
if req.Denom == "" {
return nil, status.Errorf(codes.InvalidArgument, "empty denom")
}
// Only 1 vault
allowedVault, found := s.keeper.GetAllowedVault(sdkCtx, req.Denom)
if !found {
return nil, status.Errorf(codes.NotFound, "vault not found with specified denom")
}
// Handle bfury separately to get total of **all** bfury vaults
if req.Denom == bfuryDenom {
return s.getAggregateBfuryVault(sdkCtx, allowedVault)
}
// Must be req.Denom and not allowedVault.Denom to get full "bfury" denom
vaultRecord, found := s.keeper.GetVaultRecord(sdkCtx, req.Denom)
if !found {
// No supply yet, no error just set it to zero
vaultRecord.TotalShares = types.NewVaultShare(req.Denom, sdk.ZeroDec())
}
totalValue, err := s.keeper.GetVaultTotalValue(sdkCtx, req.Denom)
if err != nil {
return nil, err
}
vault := types.VaultResponse{
// VaultRecord denom instead of AllowedVault.Denom for full bfury denom
Denom: vaultRecord.TotalShares.Denom,
Strategies: allowedVault.Strategies,
IsPrivateVault: allowedVault.IsPrivateVault,
AllowedDepositors: addressSliceToStringSlice(allowedVault.AllowedDepositors),
TotalShares: vaultRecord.TotalShares.Amount.String(),
TotalValue: totalValue.Amount,
}
return &types.QueryVaultResponse{
Vault: vault,
}, nil
}
// getAggregateBfuryVault returns a VaultResponse of the total of all bfury
// vaults.
func (s queryServer) getAggregateBfuryVault(
ctx sdk.Context,
allowedVault types.AllowedVault,
) (*types.QueryVaultResponse, error) {
allBfury := sdk.NewCoins()
var iterErr error
s.keeper.IterateVaultRecords(ctx, func(record types.VaultRecord) (stop bool) {
// Skip non bfury vaults
if !strings.HasPrefix(record.TotalShares.Denom, bfuryPrefix) {
return false
}
vaultValue, err := s.keeper.GetVaultTotalValue(ctx, record.TotalShares.Denom)
if err != nil {
iterErr = err
return false
}
allBfury = allBfury.Add(vaultValue)
return false
})
if iterErr != nil {
return nil, iterErr
}
vaultValue, err := s.keeper.liquidKeeper.GetStakedTokensForDerivatives(ctx, allBfury)
if err != nil {
return nil, err
}
return &types.QueryVaultResponse{
Vault: types.VaultResponse{
Denom: bfuryDenom,
Strategies: allowedVault.Strategies,
IsPrivateVault: allowedVault.IsPrivateVault,
AllowedDepositors: addressSliceToStringSlice(allowedVault.AllowedDepositors),
// Empty for shares, as adding up all shares is not useful information
TotalShares: "0",
TotalValue: vaultValue.Amount,
},
}, nil
}
// Deposits implements the gRPC service handler for querying x/earn deposits.
func (s queryServer) Deposits(
ctx context.Context,
req *types.QueryDepositsRequest,
) (*types.QueryDepositsResponse, error) {
if req == nil {
return nil, status.Errorf(codes.InvalidArgument, "empty request")
}
if req.Depositor == "" {
return nil, status.Errorf(codes.InvalidArgument, "depositor is required")
}
sdkCtx := sdk.UnwrapSDKContext(ctx)
// bfury aggregate total
if req.Denom == bfuryDenom {
return s.getOneAccountBfuryVaultDeposit(sdkCtx, req)
}
// specific vault
if req.Denom != "" {
return s.getOneAccountOneVaultDeposit(sdkCtx, req)
}
// all vaults
return s.getOneAccountAllDeposits(sdkCtx, req)
}
// TotalSupply implements the gRPC service handler for querying x/earn total supply (TVL)
func (s queryServer) TotalSupply(
ctx context.Context,
req *types.QueryTotalSupplyRequest,
) (*types.QueryTotalSupplyResponse, error) {
sdkCtx := sdk.UnwrapSDKContext(ctx)
totalSupply := sdk.NewCoins()
liquidStakedDerivatives := sdk.NewCoins()
// allowed vaults param contains info on allowed strategies, but bfury is aggregated
allowedVaults := s.keeper.GetAllowedVaults(sdkCtx)
allowedVaultByDenom := make(map[string]types.AllowedVault)
for _, av := range allowedVaults {
allowedVaultByDenom[av.Denom] = av
}
var vaultRecordErr error
// iterate actual records to properly enumerate all denoms
s.keeper.IterateVaultRecords(sdkCtx, func(vault types.VaultRecord) (stop bool) {
isLiquidStakingDenom := false
// find allowed vault to get parameters. handle translating bfury denoms to allowed vault denom
allowedVaultDenom := vault.TotalShares.Denom
if strings.HasPrefix(vault.TotalShares.Denom, bfuryPrefix) {
isLiquidStakingDenom = true
allowedVaultDenom = bfuryDenom
}
allowedVault, found := allowedVaultByDenom[allowedVaultDenom]
if !found {
vaultRecordErr = fmt.Errorf("vault record not found for vault record denom %s", vault.TotalShares.Denom)
return true
}
// only consider savings strategy vaults when determining supply
if !allowedVault.IsStrategyAllowed(types.STRATEGY_TYPE_SAVINGS) {
return false
}
// vault has savings strategy! determine total value of vault and add to sum
vaultSupply, err := s.keeper.GetVaultTotalValue(sdkCtx, vault.TotalShares.Denom)
if err != nil {
vaultRecordErr = err
return true
}
// liquid staked tokens must be converted to their underlying value
// aggregate them here and then we can convert to underlying values all at once at the end
if isLiquidStakingDenom {
liquidStakedDerivatives = liquidStakedDerivatives.Add(vaultSupply)
} else {
totalSupply = totalSupply.Add(vaultSupply)
}
return false
})
// determine underlying value of bfury denoms
if len(liquidStakedDerivatives) > 0 {
underlyingValue, err := s.keeper.liquidKeeper.GetStakedTokensForDerivatives(
sdkCtx,
liquidStakedDerivatives,
)
if err != nil {
return nil, err
}
totalSupply = totalSupply.Add(sdk.NewCoin(bfuryDenom, underlyingValue.Amount))
}
return &types.QueryTotalSupplyResponse{
Height: sdkCtx.BlockHeight(),
Result: totalSupply,
}, vaultRecordErr
}
// getOneAccountOneVaultDeposit returns deposits for a specific vault and a specific
// account
func (s queryServer) getOneAccountOneVaultDeposit(
ctx sdk.Context,
req *types.QueryDepositsRequest,
) (*types.QueryDepositsResponse, error) {
depositor, err := sdk.AccAddressFromBech32(req.Depositor)
if err != nil {
return nil, status.Error(codes.InvalidArgument, "Invalid address")
}
shareRecord, found := s.keeper.GetVaultShareRecord(ctx, depositor)
if !found {
return &types.QueryDepositsResponse{
Deposits: []types.DepositResponse{
{
Depositor: depositor.String(),
// Zero shares and zero value for no deposits
Shares: types.NewVaultShares(types.NewVaultShare(req.Denom, sdk.ZeroDec())),
Value: sdk.NewCoins(sdk.NewCoin(req.Denom, sdk.ZeroInt())),
},
},
Pagination: nil,
}, nil
}
// Only requesting the value of the specified denom
value, err := s.keeper.GetVaultAccountValue(ctx, req.Denom, depositor)
if err != nil {
return nil, status.Error(codes.NotFound, err.Error())
}
if req.ValueInStakedTokens {
// Get underlying ufury amount if denom is a derivative
if !s.keeper.liquidKeeper.IsDerivativeDenom(ctx, req.Denom) {
return nil, status.Errorf(
codes.InvalidArgument,
"denom %s is not a derivative, ValueInStakedTokens can only be used with liquid derivatives",
req.Denom,
)
}
ufuryValue, err := s.keeper.liquidKeeper.GetStakedTokensForDerivatives(ctx, sdk.NewCoins(value))
if err != nil {
// This should "never" happen if IsDerivativeDenom is true
panic("Error getting ufury value for " + req.Denom)
}
value = ufuryValue
}
return &types.QueryDepositsResponse{
Deposits: []types.DepositResponse{
{
Depositor: depositor.String(),
// Only respond with requested denom shares
Shares: types.NewVaultShares(
types.NewVaultShare(req.Denom, shareRecord.Shares.AmountOf(req.Denom)),
),
Value: sdk.NewCoins(value),
},
},
Pagination: nil,
}, nil
}
// getOneAccountBfuryVaultDeposit returns deposits for the aggregated bfury vault
// and a specific account
func (s queryServer) getOneAccountBfuryVaultDeposit(
ctx sdk.Context,
req *types.QueryDepositsRequest,
) (*types.QueryDepositsResponse, error) {
depositor, err := sdk.AccAddressFromBech32(req.Depositor)
if err != nil {
return nil, status.Error(codes.InvalidArgument, "Invalid address")
}
shareRecord, found := s.keeper.GetVaultShareRecord(ctx, depositor)
if !found {
return &types.QueryDepositsResponse{
Deposits: []types.DepositResponse{
{
Depositor: depositor.String(),
// Zero shares and zero value for no deposits
Shares: types.NewVaultShares(types.NewVaultShare(req.Denom, sdk.ZeroDec())),
Value: sdk.NewCoins(sdk.NewCoin(req.Denom, sdk.ZeroInt())),
},
},
Pagination: nil,
}, nil
}
// Get all account deposit values to add up bfury
totalAccountValue, err := getAccountTotalValue(ctx, s.keeper, depositor, shareRecord.Shares)
if err != nil {
return nil, err
}
// Remove non-bfury coins, GetStakedTokensForDerivatives expects only bfury
totalBfuryValue := sdk.NewCoins()
for _, coin := range totalAccountValue {
if s.keeper.liquidKeeper.IsDerivativeDenom(ctx, coin.Denom) {
totalBfuryValue = totalBfuryValue.Add(coin)
}
}
// Use account value with only the aggregate bfury converted to underlying staked tokens
stakedValue, err := s.keeper.liquidKeeper.GetStakedTokensForDerivatives(ctx, totalBfuryValue)
if err != nil {
return nil, err
}
return &types.QueryDepositsResponse{
Deposits: []types.DepositResponse{
{
Depositor: depositor.String(),
// Only respond with requested denom shares
Shares: types.NewVaultShares(
types.NewVaultShare(req.Denom, shareRecord.Shares.AmountOf(req.Denom)),
),
Value: sdk.NewCoins(stakedValue),
},
},
Pagination: nil,
}, nil
}
// getOneAccountAllDeposits returns deposits for all vaults for a specific account
func (s queryServer) getOneAccountAllDeposits(
ctx sdk.Context,
req *types.QueryDepositsRequest,
) (*types.QueryDepositsResponse, error) {
depositor, err := sdk.AccAddressFromBech32(req.Depositor)
if err != nil {
return nil, status.Error(codes.InvalidArgument, "Invalid address")
}
deposits := []types.DepositResponse{}
accountShare, found := s.keeper.GetVaultShareRecord(ctx, depositor)
if !found {
return &types.QueryDepositsResponse{
Deposits: []types.DepositResponse{},
Pagination: nil,
}, nil
}
value, err := getAccountTotalValue(ctx, s.keeper, depositor, accountShare.Shares)
if err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error())
}
if req.ValueInStakedTokens {
// Plain slice to not sum ufury amounts together. This is not a valid
// sdk.Coin due to multiple coins of the same denom, but we need them to
// be separate in the response to not be an aggregate amount.
var valueInStakedTokens []sdk.Coin
for _, coin := range value {
// Skip non-bfury coins
if !s.keeper.liquidKeeper.IsDerivativeDenom(ctx, coin.Denom) {
continue
}
// Derivative coins are converted to underlying staked tokens
ufuryValue, err := s.keeper.liquidKeeper.GetStakedTokensForDerivatives(ctx, sdk.NewCoins(coin))
if err != nil {
// This should "never" happen if IsDerivativeDenom is true
panic("Error getting ufury value for " + coin.Denom)
}
valueInStakedTokens = append(valueInStakedTokens, ufuryValue)
}
var filteredShares types.VaultShares
for _, share := range accountShare.Shares {
// Remove non-bfury coins from shares as they are used to
// determine which value is mapped to which denom
// These should be in the same order as valueInStakedTokens
if !s.keeper.liquidKeeper.IsDerivativeDenom(ctx, share.Denom) {
continue
}
filteredShares = append(filteredShares, share)
}
value = valueInStakedTokens
accountShare.Shares = filteredShares
}
deposits = append(deposits, types.DepositResponse{
Depositor: depositor.String(),
Shares: accountShare.Shares,
Value: value,
})
return &types.QueryDepositsResponse{
Deposits: deposits,
Pagination: nil,
}, nil
}
// getAccountTotalValue returns the total value for all vaults for a specific
// account based on their shares.
func getAccountTotalValue(
ctx sdk.Context,
keeper Keeper,
account sdk.AccAddress,
shares types.VaultShares,
) (sdk.Coins, error) {
value := sdk.NewCoins()
for _, share := range shares {
accValue, err := keeper.GetVaultAccountValue(ctx, share.Denom, account)
if err != nil {
return nil, err
}
value = value.Add(sdk.NewCoin(share.Denom, accValue.Amount))
}
return value, nil
}
func addressSliceToStringSlice(addresses []sdk.AccAddress) []string {
var strings []string
for _, address := range addresses {
strings = append(strings, address.String())
}
return strings
}