forked from messari/subgraphs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
reference.graphql
1153 lines (788 loc) · 32 KB
/
reference.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
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
##### SCHEMA GUIDELINES
### Version: 1.0.2
#
### Usage
# - This schema is intended to be a "master" document for standardization work. It includes all possible protocol
# categories and entities. To implement a specific protocol, you should only include entities that are relevant
# to that particular protocol. For example, to implement Aave, you should only include the lending protocol
# entities and leave out the rest.
#
### Naming Conventions
# - Enum values should be in all caps
# - Common types
# - hash/address: String
# - block height: BigInt
# - timestamp: unix timestamp in BigInt
# - token amount: All token amounts should be BigInt to preserve precision (i.e. in wei)
# - dollar amount: All USD amounts (including prices) should be BigDecimal
# - Certain prefixes may be used to indicate a particular type of value.
# * total - indicates this is a cumulative value (e.g. totalSharesMinted, totalGrossReturns)
# * balance - indicates this is a spot balance (e.g. balanceTokensInvested, balanceTokensIdle)
# * delta - indicates this value is the difference between the prior state and the current state (e.g. deltaPricePerShare)
# * current - used exclusively in Update entities. Similar to balance, current indicates the state of a field or value at the
# time of the update. These values are populated in every update whether they changed or not.
# * new - used exclusively in Update entities. Fields with this prefix will only be populated if they have changed since the
# last Update. If there has been no change, the value will be null.
# - Use plurals when referring to Tokens or Shares (e.g. totalShares, balanceTokens)
#
### Quantitative Data
# - There are 3 ways in which quantitative data are stored and fetched:
# 1. Real-time: you can get real-time data by querying on specific entities. For example, get `totalValueLockedUSD`
# from a `Pool`.
# 2. Point-in-time: you can get point-in-time (including historical) data on specific entities using time-travel queries.
# 3. Time-series: the best way to get time-series data is by querying snapshots. For example, get `totalValueLockedUSD` from
# `PoolDailySnapshot`.
#
enum Network {
ARBITRUM
AURORA
AVALANCHE
BSC
CELO
CRONOS
ETHEREUM
FANTOM
HARMONY
MOONBEAM
MOONRIVER
OPTIMISM
POLYGON
XDAI
}
enum ProtocolType {
EXCHANGE
LENDING
YIELD
BRIDGE
GENERIC
# Will add more
}
type Token @entity {
" Smart contract address of the market "
id: ID!
" Mirrored from the smart contract "
name: String!
symbol: String!
decimals: Int!
}
enum RewardTokenType {
DEPOSIT
BORROW
}
type RewardToken @entity {
" Smart contract address of the market "
id: ID!
" Mirrored from the smart contract "
name: String!
symbol: String!
decimals: Int!
type: RewardTokenType!
}
#############################
##### Protocol Metadata #####
#############################
interface Protocol {
" Smart contract address of the protocol's main contract (Factory, Registry, etc) "
id: ID!
" Name of the protocol, including version. e.g. Uniswap v3 "
name: String!
" Slug of protocol, including version. e.g. uniswap-v3 "
slug: String!
" Version of the subgraph schema, in SemVer format (e.g. 1.0.0) "
schemaVersion: String!
" Version of the subgraph implementation, in SemVer format (e.g. 1.0.0) "
subgraphVersion: String!
network: Network!
type: ProtocolType!
" # of total/cumulative unique users "
totalUniqueUsers: Int!
totalValueLockedUSD: BigDecimal!
usageMetrics: [UsageMetricsDailySnapshot!]! @derivedFrom(field: "protocol")
financialMetrics: [FinancialsDailySnapshot!]! @derivedFrom(field: "protocol")
}
###############################
##### Protocol Timeseries #####
###############################
type UsageMetricsDailySnapshot @entity {
" ID is # of days since Unix epoch time "
id: ID!
protocol: Protocol!
" # of unique daily active users "
activeUsers: Int!
" # of total/cumulative unique users "
totalUniqueUsers: Int!
" Total number of transaction occurred in a day. Transactions include all entities that implement the Event interface. "
dailyTransactionCount: Int!
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
}
type FinancialsDailySnapshot @entity {
" ID is # of days since Unix epoch time "
id: ID!
protocol: Protocol!
totalValueLockedUSD: BigDecimal!
" Protocol treasury should be composed of non-productive protocol assets. This may be an insurance fund, operational budget, or any other assets not directly generating revenue "
protocolTreasuryUSD: BigDecimal
" Only relevant for protocols with PCV. "
protocolControlledValueUSD: BigDecimal
" Total volume in USD "
totalVolumeUSD: BigDecimal!
" Revenue claimed by suppliers to the protocol. LPs on DEXs (e.g. 0.25% of the swap fee in Sushiswap). Depositors on Lending Protocols. NFT sellers on OpenSea. "
supplySideRevenueUSD: BigDecimal!
" Gross revenue for the protocol (revenue claimed by protocol). Examples: AMM protocol fee (Sushi’s 0.05%). OpenSea 10% sell fee. "
protocolSideRevenueUSD: BigDecimal!
" Fees paid by the users. e.g. 0.30% of swap fee in Sushiswap "
feesUSD: BigDecimal!
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
}
###############################
##### Pool-Level Metadata #####
###############################
# A pool can be:
# - A liquidity pool in the case of a DEX AMM
# - A market in the case of a lending protocol
# - A vault in the case of a yield aggregator
interface Pool {
" Smart contract address of the pool "
id: ID!
" The protocol this pool belongs to "
protocol: Protocol!
# Generally protocols accept one or multiple tokens and mint tokens to the depositor to track ownership
# Some protocols reward DAO tokens or other incentivisation tokens to holders of LP tokens
# Some protocols don't mint any tokens to track ownership, in that case outputToken is null
# and inputToken balances are used to calculate returns
" Tokens that need to be deposited to take a position in protocol. e.g. WETH and USDC to deposit into the WETH-USDC pool. Array to account for multi-asset pools like Curve and Balancer "
inputTokens: [Token!]!
" Token that is minted to track ownership of position in protocol "
outputToken: Token
" Aditional tokens that are given as reward for position in a protocol, usually in liquidity mining programs. e.g. SUSHI in the Onsen program, MATIC for Aave Polygon "
rewardTokens: [RewardToken!]
##### Quantitative Data #####
totalValueLockedUSD: BigDecimal!
" Total volume in USD (volume is defined differently according to the protocol category) "
totalVolumeUSD: BigDecimal!
" Amount of input tokens in the pool. The ordering should be the same as the pool's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Total supply of output token "
outputTokenSupply: BigInt!
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal!
" Total amount of reward token emissions in a day, in token's native amount "
rewardTokenEmissionsAmount: [BigInt!]
" Total amount of reward token emissions in a day, normalized to USD "
rewardTokenEmissionsUSD: [BigDecimal!]
" Creation timestamp "
createdTimestamp: BigInt!
" Creation block number "
createdBlockNumber: BigInt!
" Pool snapshots "
snapshots: [PoolDailySnapshot!]! @derivedFrom(field: "pool")
}
#################################
##### Pool-Level Timeseries #####
#################################
interface PoolDailySnapshot {
" { Smart contract address of the pool }-{ # of days since Unix epoch time } "
id: ID!
" The protocol this snapshot belongs to "
protocol: Protocol!
" The pool this snapshot belongs to "
pool: Pool!
totalValueLockedUSD: BigDecimal!
" Total volume in USD "
totalVolumeUSD: BigDecimal!
" Amount of input tokens in the pool. The ordering should be the same as the pool's `inputTokens` field. "
inputTokenBalances: BigInt!
" Total supply of output token "
outputTokenSupply: BigInt!
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal!
" Total amount of reward token emissions in a day, in token's native amount "
rewardTokenEmissionsAmount: [BigInt!]
" Total amount of reward token emissions in a day, normalized to USD "
rewardTokenEmissionsUSD: [BigDecimal!]
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
}
##################################
##### Transaction-Level Data #####
##################################
"""
An event is any user action that occurs in a protocol. Generally, they are Ethereum events
emitted by a function in the smart contracts, stored in transaction receipts as event logs.
However, some user actions of interest are function calls that don't emit events. For example,
the deposit and withdraw functions in Yearn do not emit any events. In our subgraphs, we still
store them as events, although they are not technically Ethereum events emitted by smart
contracts.
"""
interface Event {
" { Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Address that received tokens "
to: String!
" Address that sent tokens "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
}
type Deposit implements Event @entity {
" { Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Market that tokens are deposited into "
to: String!
" Address that deposited tokens "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
" Token deposited "
asset: Token!
" Amount of token deposited in native units "
amount: BigInt!
" Amount of token deposited in USD "
amountUSD: BigDecimal!
" The pool involving this transaction "
pool: Pool!
}
type Withdraw implements Event @entity {
" { Transaction hash }-{ Log index }"
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Address that received tokens "
to: String!
" Market that tokens are withdrawn from "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
" Token withdrawn "
asset: Token!
" Amount of token withdrawn in native units "
amount: BigInt!
" Amount of token withdrawn in USD "
amountUSD: BigDecimal!
" The pool involving this transaction "
pool: Pool!
}
###############################################################################
################################# DEX AMM #####################################
###############################################################################
type DexAmmProtocol implements Protocol @entity {
" Smart contract address of the protocol's main contract (Factory, Registry, etc) "
id: ID!
" Name of the protocol, including version. e.g. Uniswap v3 "
name: String!
" Slug of protocol, including version. e.g. uniswap-v3 "
slug: String!
" Version of the subgraph schema, in SemVer format (e.g. 1.0.0) "
schemaVersion: String!
" Version of the subgraph implementation, in SemVer format (e.g. 1.0.0) "
subgraphVersion: String!
network: Network!
type: ProtocolType!
" # of total/cumulative unique users "
totalUniqueUsers: Int!
totalValueLockedUSD: BigDecimal!
usageMetrics: [UsageMetricsDailySnapshot!]! @derivedFrom(field: "protocol")
financialMetrics: [FinancialsDailySnapshot!]! @derivedFrom(field: "protocol")
##### DexAmm-Specific #####
" All pools that belong to this protocol "
pools: [Pool!]! @derivedFrom(field: "protocol")
}
enum LiquidityPoolFeeType {
" Total fixed fee paid by the user per trade, as a percentage of the traded amount. e.g. 0.3% for Uniswap v2, 0.3% for Sushiswap, 0.04% for Curve v1. "
FIXED_TRADING_FEE
" Some protocols use tiered fees instead of fixed fee (e.g. DYDX, DODO). Set `feePercentage` as 0 but handle the tiered fees in the mapping code. "
TIERED_TRADING_FEE
" Some protocols use dynamic fees instead of fixed fee (e.g. Balancer v2). Set `feePercentage` as 0 but handle the dynamic fees in the mapping code. "
DYNAMIC_TRADING_FEE
" Fixed fee that's paid to the protocol, as a percentage of the traded amount. e.g. 0.05% for Sushiswap, 0.02% for Curve v1. "
FIXED_PROTOCOL_FEE
" Some protocols use dynamic protocol fees (e.g., Bancor v2). Set `feePercentage` as 0 but handle the dynamic fees in the mapping code. "
DYNAMIC_PROTOCOL_FEE
}
type LiquidityPoolFee @entity {
id: ID!
feePercentage: BigDecimal!
feeType: LiquidityPoolFeeType!
}
type LiquidityPool implements Pool @entity {
" Smart contract address of the pool "
id: ID!
" The protocol this pool belongs to "
protocol: Protocol!
" Tokens that need to be deposited to take a position in protocol. e.g. WETH and USDC to deposit into the WETH-USDC pool. Array to account for multi-asset pools like Curve and Balancer "
inputTokens: [Token!]!
" Token that is minted to track ownership of position in protocol "
outputToken: Token
" Aditional tokens that are given as reward for position in a protocol, usually in liquidity mining programs. e.g. SUSHI in the Onsen program, MATIC for Aave Polygon "
rewardTokens: [RewardToken!]
##### Quantitative Data #####
totalValueLockedUSD: BigDecimal!
" Total swap volume in USD "
totalVolumeUSD: BigDecimal!
" Amount of input tokens in the pool. The ordering should be the same as the pool's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Total supply of output token "
outputTokenSupply: BigInt!
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal!
" Total amount of reward token emissions in a day, in token's native amount "
rewardTokenEmissionsAmount: [BigInt!]
" Total amount of reward token emissions in a day, normalized to USD "
rewardTokenEmissionsUSD: [BigDecimal!]
" Creation timestamp "
createdTimestamp: BigInt!
" Creation block number "
createdBlockNumber: BigInt!
" Pool snapshots "
snapshots: [PoolDailySnapshot!]! @derivedFrom(field: "pool")
##### DexAmm-Specific #####
" Name of liquidity pool (e.g. Curve.fi DAI/USDC/USDT) "
name: String
" Symbol of liquidity pool (e.g. 3CRV) "
symbol: String
" Fees per trade incurred to the user. Should include all fees that apply to a pool (e.g. Curve has a trading fee AND an admin fee, which is a portion of the trading fee. Uniswap only has a trading fee and no protocol fee. ) "
fees: [LiquidityPoolFee!]!
deposits: [Deposit!]! @derivedFrom(field: "pool")
withdraws: [Withdraw!]! @derivedFrom(field: "pool")
swaps: [Swap!]! @derivedFrom(field: "pool")
}
type Swap implements Event @entity {
" { Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Address that received tokens "
to: String!
" Market that tokens are withdrawn from "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
" Token deposited into pool "
tokenIn: Token!
" Amount of token deposited into pool in native units "
amountIn: BigInt!
" Amount of token deposited into pool in USD "
amountInUSD: BigDecimal!
" Token withdrawn from pool "
tokenOut: Token!
" Amount of token withdrawn from pool in native units "
amountOut: BigInt!
" Amount of token withdrawn from pool in USD "
amountOutUSD: BigDecimal!
##### DexAmm-Specific #####
" The pool involving this transaction "
pool: LiquidityPool!
}
###############################################################################
################################# Lending #####################################
###############################################################################
enum LendingType {
" Collateralized Debt Position (CDP) protocols have singular isolated positions created by users. We aggregate them to give a single view of a market "
CDP
" Pooled protocols pool all users assets into a single market "
POOLED
}
enum RiskType {
" Global risk means each users position in a market is combined for one score to determine if they can be liquidated "
GLOBAL
" Isolated risk means each users position in a market or CDP is isolated for risk of liquidation "
ISOLATED
}
type LendingProtocol implements Protocol @entity {
" Smart contract address of the protocol's main contract (Factory, Registry, etc) "
id: ID!
" Name of the protocol, including version. e.g. Aave v2 "
name: String!
" Slug of protocol, including version. e.g. aave-v2 "
slug: String!
" Version of the subgraph schema, in SemVer format (e.g. 1.0.0) "
schemaVersion: String!
" Version of the subgraph implementation, in SemVer format (e.g. 1.0.0) "
subgraphVersion: String!
network: Network!
type: ProtocolType!
" # of total/cumulative unique users "
totalUniqueUsers: Int!
totalValueLockedUSD: BigDecimal!
usageMetrics: [UsageMetricsDailySnapshot!]! @derivedFrom(field: "protocol")
financialMetrics: [FinancialsDailySnapshot!]! @derivedFrom(field: "protocol")
##### Lending-Specific #####
" All markets that belong to this protocol "
markets: [Market!]! @derivedFrom(field: "protocol")
lendingType: LendingType
riskType: RiskType
}
type Market implements Pool @entity {
" Smart contract address of the market "
id: ID!
" The protocol this pool belongs to "
protocol: Protocol!
# Generally protocols accept one or multiple tokens and mint tokens to the depositor to track ownership
# Some protocols reward DAO tokens or other incentivisation tokens to holders of LP tokens
# Some protocols don't mint any tokens to track ownership, in that case outputToken is null
# and inputToken balances are used to calculate returns
" Tokens that need to be deposited to take a position in protocol. e.g. WETH and USDC to deposit into the WETH-USDC pool "
inputTokens: [Token!]!
" Token that is minted to track ownership of position in protocol "
outputToken: Token
" Aditional tokens that are given as reward for position in a protocol, usually in liquidity mining programs. e.g. SUSHI in the Onsen program, MATIC for Aave Polygon "
rewardTokens: [RewardToken!]
##### Quantitative Data #####
totalValueLockedUSD: BigDecimal!
" Total borrow volume in USD (i.e. total loan origination ) "
totalVolumeUSD: BigDecimal!
" Amount of input tokens in the market. The ordering should be the same as the market's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Total supply of output token "
outputTokenSupply: BigInt!
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal!
" Total amount of reward token emissions in a day, in token's native amount "
rewardTokenEmissionsAmount: [BigInt!]
" Total amount of reward token emissions in a day, normalized to USD "
rewardTokenEmissionsUSD: [BigDecimal!]
" Creation timestamp "
createdTimestamp: BigInt!
" Creation block number "
createdBlockNumber: BigInt!
" Pool snapshots "
snapshots: [MarketDailySnapshot!]! @derivedFrom(field: "market")
##### Lending-Specific #####
" Name of market "
name: String
isActive: Boolean!
canUseAsCollateral: Boolean!
canBorrowFrom: Boolean!
" Maximum loan-to-value ratio as a percentage value "
maximumLTV: BigDecimal!
" Liquidation threshold as a percentage value "
liquidationThreshold: BigDecimal!
" Liquidation penalty as a percentage value "
liquidationPenalty: BigDecimal!
" Deposit interest rate in percentage "
depositRate: BigDecimal!
" Borrow interest rate in percentage "
stableBorrowRate: BigDecimal!
" Borrow interest rate in percentage "
variableBorrowRate: BigDecimal!
deposits: [Deposit!]! @derivedFrom(field: "market")
withdraws: [Withdraw!]! @derivedFrom(field: "market")
borrows: [Borrow!]! @derivedFrom(field: "market")
repays: [Repay!]! @derivedFrom(field: "market")
liquidations: [Liquidation!]! @derivedFrom(field: "market")
}
type MarketDailySnapshot implements PoolDailySnapshot @entity {
" { Smart contract address of the market }-{ # of days since Unix epoch time } "
id: ID!
" The protocol this snapshot belongs to "
protocol: Protocol!
" The market this snapshot belongs to "
market: Market!
totalValueLockedUSD: BigDecimal!
" Amount of input tokens in the market. The ordering should be the same as the market's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Price per share of input token in USD "
inputTokenPricesUSD: [BigDecimal!]!
" Total supply of output token "
outputTokenSupply: BigInt!
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal!
" Total amount of reward token emissions in a day, in token's native amount "
rewardTokenEmissionsAmount: [BigInt!]
" Total amount of reward token emissions in a day, normalized to USD "
rewardTokenEmissionsUSD: [BigDecimal!]
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
##### Lending-Specific #####
" Deposit interest rate in percentage "
depositRate: BigDecimal!
" Borrow interest rate in percentage "
stableBorrowRate: BigDecimal!
" Borrow interest rate in percentage "
variableBorrowRate: BigDecimal!
}
type Borrow implements Event @entity {
" { Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Address that received tokens "
to: String!
" Market that tokens are borrowed from "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
##### Lending-Specific #####
" The market involving this transaction "
market: Market!
" Token borrowed "
asset: Token!
" Amount of token borrowed in native units "
amount: BigInt!
" Amount of token borrowed in USD "
amountUSD: BigDecimal
}
type Repay implements Event @entity {
" { Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Market that tokens are repaid to "
to: String!
" Address that sent tokens "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
##### Lending-Specific #####
" The market involving this transaction "
market: Market!
" Token repaid "
asset: Token!
" Amount of token repaid in native units "
amount: BigInt!
" Amount of token repaid in USD "
amountUSD: BigDecimal
}
type Liquidation implements Event @entity {
" { Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" The protocol this transaction belongs to "
protocol: Protocol!
" Market that tokens are repaid to "
to: String!
" Address that carried out the liquidation "
from: String!
blockNumber: BigInt!
timestamp: BigInt!
##### Lending-Specific #####
" The market involving this transaction "
market: Market!
" Token liquidated "
asset: Token!
" Amount of token liquidated in native units "
amount: BigInt!
" Amount of token liquidated in USD "
amountUSD: BigDecimal
" Amount of profit from liquidation in USD "
profitUSD: BigDecimal
}
###############################################################################
################################## Yield ######################################
###############################################################################
type YieldAggregator implements Protocol @entity {
" Smart contract address of the protocol's main contract (Factory, Registry, etc) "
id: ID!
" Name of the protocol, including version. e.g. Yearn v3 "
name: String!
" Slug of protocol, including version. e.g. yearn-v3 "
slug: String!
" Version of the subgraph schema, in SemVer format (e.g. 1.0.0) "
schemaVersion: String!
" Version of the subgraph implementation, in SemVer format (e.g. 1.0.0) "
subgraphVersion: String!
network: Network!
type: ProtocolType!
" # of total/cumulative unique users "
totalUniqueUsers: Int!
totalValueLockedUSD: BigDecimal!
usageMetrics: [UsageMetricsDailySnapshot!]! @derivedFrom(field: "protocol")
financialMetrics: [FinancialsDailySnapshot!]! @derivedFrom(field: "protocol")
##### Yield-Specific #####
" All vaults that belong to this protocol "
vaults: [Vault!]! @derivedFrom(field: "protocol")
}
enum VaultFeeType {
" One-time fee charged by the protocol during deposit, in percentages of the deposit token "
DEPOSIT_FEE
" One-time fee charged by the protocol during withdrawal, in percentages of the withdrawal token "
WITHDRAWAL_FEE
" Fees charged by the protocol during harvest, in percentages of the interest accrued "
PERFORMANCE_FEE
" Fees charged by the protocol on a periodic basis, in percentages of the total principal "
MANAGEMENT_FEE
}
type VaultFee @entity {
id: ID!
feePercentage: BigDecimal!
feeType: VaultFeeType!
}
type Vault implements Pool @entity {
" Smart contract address of the vault "
id: ID!
protocol: YieldAggregator!
# Generally protocols accept one or multiple tokens and mint tokens to the depositor to track ownership
# Some protocols reward DAO tokens or other incentivisation tokens to holders of LP tokens
# Some protocols don't mint any tokens to track ownership, in that case outputToken is null
# and inputToken balances are used to calculate returns
" Tokens that need to be deposited to take a position in protocol. e.g. WETH and USDC to deposit into the WETH-USDC pool "
inputTokens: [Token!]!
" Token that is minted to track ownership of position in protocol "
outputToken: Token
" Aditional tokens that are given as reward for position in a protocol, usually in liquidity mining programs. e.g. SUSHI in the Onsen program, MATIC for Aave Polygon "
rewardTokens: [RewardToken!]
##### Quantitative Data #####
totalValueLockedUSD: BigDecimal!
" Total deposit volume in USD "
totalVolumeUSD: BigDecimal!
" Amount of input tokens in the vault. The ordering should be the same as the vault's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Total supply of output token "
outputTokenSupply: BigInt!
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal!
" Total amount of reward token emissions in a day, in token's native amount "
rewardTokenEmissionsAmount: [BigInt!]
" Total amount of reward token emissions in a day, normalized to USD "
rewardTokenEmissionsUSD: [BigDecimal!]
" Creation timestamp "
createdTimestamp: BigInt!
" Creation block number "
createdBlockNumber: BigInt!
" Vault snapshots "
snapshots: [VaultDailySnapshot!]! @derivedFrom(field: "vault")
##### Yield-Specific #####
name: String