This repository has been archived by the owner on Jan 19, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
/
schema.graphql
687 lines (510 loc) · 10.2 KB
/
schema.graphql
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
enum TransactionType {
MASSET_MINT
MASSET_SWAP
MASSET_REDEEM
MASSET_REDEEM_MASSET
MASSET_PAID_FEE
SAVINGS_CONTRACT_DEPOSIT
SAVINGS_CONTRACT_WITHDRAW
STAKING_REWARDS_CONTRACT_CLAIM_REWARD
STAKING_REWARDS_CONTRACT_EXIT
STAKING_REWARDS_CONTRACT_STAKE
STAKING_REWARDS_CONTRACT_WITHDRAW
}
enum AggregateMetricType {
TOTAL_SUPPLY
TOTAL_SAVINGS
}
enum TimeMetricPeriod {
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
}
enum StakingRewardsContractType {
STAKING_REWARDS
STAKING_REWARDS_WITH_PLATFORM_TOKEN
}
enum StakingRewardType {
REWARD
PLATFORM_REWARD
}
"""
An ERC20-compatible token
"""
type Token @entity {
id: ID!
"""
Token address
"""
address: Bytes!
"""
Token decimals
"""
decimals: Int!
"""
Token name
"""
name: String!
"""
Token symbol
"""
symbol: String!
"""
Total supply of the token
"""
totalSupply: BigDecimal!
"""
Quantity of the token that has been minted
"""
totalMinted: BigDecimal!
"""
Quantity of the token that has been burned
"""
totalBurned: BigDecimal!
}
"""
Basket Asset (e.g. DAI for the mUSD basket)
"""
type Basset @entity {
id: ID!
"""
Basket the Basset is contained in
"""
basket: Basket! @derivedFrom(field: "bassets")
"""
Target weight of the Basset
"""
maxWeight: BigInt!
"""
Basset to Masset ratio for quantity conversion
"""
ratio: BigInt!
# TODO use enum
"""
Status of the Basset, e.g. 'Normal'
"""
status: String!
"""
An ERC20 can charge transfer fee, e.g. USDT or DGX tokens
"""
isTransferFeeCharged: Boolean!
"""
The underlying Token for the Basset
"""
token: Token!
"""
Amount of the Basset that is held in collateral
"""
vaultBalance: BigDecimal!
}
"""
A Basket of Bassets (e.g. for mUSD)
"""
type Basket @entity {
id: ID!
"""
The Bassets in the Basket
"""
bassets: [Basset!]!
"""
The collateralisation ratio of the Basket
"""
collateralisationRatio: BigInt!
"""
Max number of Bassets that can be present in the Basket
"""
maxBassets: Int!
"""
Flag for whether the Basket has failed
"""
undergoingRecol: Boolean!
"""
Flag for whether the Basket has failed
"""
failed: Boolean!
"""
Masset the Basket belongs to
"""
masset: Masset! @derivedFrom(field: "basket")
}
"""
An mStable asset (e.g. mUSD)
"""
type Masset @entity {
id: ID!
# TODO explain that this is the BasketManager
"""
The Basket of Bassets for this Masset
"""
basket: Basket!
"""
The swap fee rate
"""
feeRate: BigInt!
"""
The redemption fee rate
"""
redemptionFeeRate: BigInt!
"""
The underlying Token for this Masset
"""
token: Token!
"""
The token symbol
"""
tokenSymbol: String!
savingsContracts: [SavingsContract!]! @derivedFrom(field: "masset")
}
"""
An Ethereum account with balances/credit balances
"""
type Account @entity {
id: ID!
"""
Address of the account
"""
address: Bytes!
"""
AccountBalances of the account
"""
balances: [AccountBalance!]! @derivedFrom(field: "account")
"""
CreditBalances of the account
"""
creditBalances: [CreditBalance!]! @derivedFrom(field: "account")
}
"""
An account balance for a given token
"""
type AccountBalance @entity {
id: ID!
"""
Account
"""
account: Account!
"""
Amount as a decimal value
"""
amount: BigDecimal!
"""
Token
"""
token: Token!
}
"""
A credit balance for a given savings contract
"""
type CreditBalance @entity {
id: ID!
"""
Account
"""
account: Account!
"""
Amount as a decimal value
"""
amount: BigDecimal!
"""
Savings contract
"""
savingsContract: SavingsContract!
}
type SavingsContract @entity {
id: ID!
masset: Masset!
totalSavings: BigDecimal!
totalCredits: BigDecimal!
exchangeRates: [ExchangeRate!]! @derivedFrom(field: "savingsContract")
# The same for all SavingsContracts; from SavingsManager
savingsRate: BigDecimal!
creditBalances: [CreditBalance!]! @derivedFrom(field: "savingsContract")
automationEnabled: Boolean!
}
type ExchangeRate @entity {
id: ID!
exchangeRate: BigDecimal!
timestamp: Int!
savingsContract: SavingsContract!
}
interface TimeMetric {
id: ID!
value: BigDecimal!
timestamp: Int!
period: TimeMetricPeriod!
}
type VolumeMetric implements TimeMetric @entity {
id: ID!
value: BigDecimal!
timestamp: Int!
period: TimeMetricPeriod!
type: TransactionType!
}
type AggregateMetric implements TimeMetric @entity {
id: ID!
value: BigDecimal!
timestamp: Int!
period: TimeMetricPeriod!
type: AggregateMetricType!
}
"""
A common transaction type
"""
interface Transaction {
id: ID!
tx: Bytes!
type: TransactionType!
timestamp: Int!
sender: Bytes!
}
# """ Any type of mint here """
# type MintTransaction implements Transaction @entity {
# recipient: Bytes!
# }
"""
A bAsset<>bAsset swap
"""
type SwapTransaction implements Transaction @entity {
id: ID!
tx: Bytes!
type: TransactionType!
sender: Bytes!
timestamp: Int!
"""
Which mAsset is this tx in?
"""
mAsset: Masset!
mAssetUnits: BigDecimal!
inputBasset: Basset!
outputBasset: Basset!
recipient: Bytes!
}
# """ Redeeming single/multi """
# type RedeemTransaction implements Transaction @entity {
# recipient: Bytes!
# }
# """ RedeemMasset transaction event """
# type ExitTransaction implements Transaction @entity {
# recipient: Bytes!
# }
"""
Log of the Fee payment
"""
type FeePaidTransaction implements Transaction @entity {
id: ID!
tx: Bytes!
type: TransactionType!
timestamp: Int!
sender: Bytes!
"""
Which mAsset is this tx in?
"""
mAsset: Masset!
mAssetUnits: BigDecimal!
asset: Basset!
}
type StakingRewardsContractTransaction implements Transaction @entity {
id: ID!
tx: Bytes!
type: TransactionType!
sender: Bytes!
timestamp: Int!
stakingRewardsContract: StakingRewardsContract!
}
type StakingRewardsContractClaimRewardTransaction implements Transaction
@entity {
id: ID!
tx: Bytes!
type: TransactionType!
sender: Bytes!
timestamp: Int!
stakingRewardsContract: StakingRewardsContract!
amount: BigInt!
}
type StakingRewardsContractStakeTransaction implements Transaction @entity {
id: ID!
tx: Bytes!
type: TransactionType!
sender: Bytes!
timestamp: Int!
stakingRewardsContract: StakingRewardsContract!
amount: BigInt!
}
type StakingRewardsContractWithdrawTransaction implements Transaction @entity {
id: ID!
tx: Bytes!
type: TransactionType!
sender: Bytes!
timestamp: Int!
stakingRewardsContract: StakingRewardsContract!
amount: BigInt!
}
type RewardsDistributor @entity {
"""
ID of the rewards distributor contract
"""
id: ID!
"""
Whitelisted fund managers
"""
fundManagers: [Bytes!]!
}
type StakingReward @entity {
# contract + account
id: ID!
"""
Reward amount
"""
amount: BigInt!
"""
The reward amount per token paid
"""
amountPerTokenPaid: BigInt!
"""
The staking rewards contract this reward is kept on
"""
stakingRewardsContract: StakingRewardsContract!
"""
The account the reward belongs to
"""
account: Bytes!
"""
The type of staking reward, e.g. "REWARD" or "PLATFORM_REWARD"
"""
type: StakingRewardType!
}
type StakingRewardsContract @entity {
"""
ID of the staking rewards contract
"""
id: ID!
"""
The type of staking rewards contract, e.g. `STAKING_REWARDS` or `STAKING_REWARDS_WITH_PLATFORM_TOKEN`
"""
type: StakingRewardsContractType!
"""
Duration
"""
duration: Int!
"""
Period finish
"""
periodFinish: Int!
"""
Last update time
"""
lastUpdateTime: Int!
"""
Staking token
"""
stakingToken: Token!
"""
Reward per token stored
"""
rewardPerTokenStored: BigInt!
"""
Reward rate
"""
rewardRate: BigInt!
"""
Rewards token
"""
rewardsToken: Token!
"""
Rewards distributor
"""
rewardsDistributor: RewardsDistributor!
"""
Total supply
"""
totalSupply: BigInt!
"""
Total staking rewards
"""
totalStakingRewards: BigInt!
"""
Accessor for staking balances kept on this contract
"""
stakingBalances: [StakingBalance!]!
@derivedFrom(field: "stakingRewardsContract")
"""
Accessor for staking rewards kept on this contract
"""
stakingRewards: [StakingReward!]!
@derivedFrom(field: "stakingRewardsContract")
"""
Accessor for claim reward transactions sent to this contract
"""
claimRewardTransactions: [StakingRewardsContractClaimRewardTransaction!]!
@derivedFrom(field: "stakingRewardsContract")
"""
Accessor for stake transactions sent to this contract
"""
stakeTransactions: [StakingRewardsContractStakeTransaction!]!
@derivedFrom(field: "stakingRewardsContract")
"""
Accessor for withdraw transactions sent to this contract
"""
withdrawTransactions: [StakingRewardsContractWithdrawTransaction!]!
@derivedFrom(field: "stakingRewardsContract")
#######################################################
# For type `STAKING_REWARDS_WITH_PLATFORM_TOKEN` only #
"""
Platform token
"""
platformToken: Token
"""
Platform reward rate
"""
platformRewardRate: BigInt
"""
Platform reward per token stored
"""
platformRewardPerTokenStored: BigInt
"""
Total platform rewards
"""
totalPlatformRewards: BigInt
#######################################################
}
type StakingBalance @entity {
# stakingRewardsContract + account
id: ID!
"""
Account this staking balance belongs to
"""
account: Bytes!
"""
Staking rewards contract this staking balance is kept on
"""
stakingRewardsContract: StakingRewardsContract!
"""
Staking balance amount
"""
amount: BigInt!
}
type MerkleDropClaim @entity {
id: ID!
account: Bytes!
merkleDrop: MerkleDrop!
tranche: MerkleDropTranche!
balance: BigInt!
}
type MerkleDropTranche @entity {
id: ID!
merkleDrop: MerkleDrop!
expired: Boolean!
trancheNumber: Int!
merkleRoot: Bytes!
totalAmount: BigInt!
claims: [MerkleDropClaim!]! @derivedFrom(field: "tranche")
}
type MerkleDrop @entity {
id: ID!
token: Token!
claims: [MerkleDropClaim!]! @derivedFrom(field: "merkleDrop")
tranches: [MerkleDropTranche!]! @derivedFrom(field: "merkleDrop")
funders: [Bytes!]!
}