forked from messari/subgraphs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema-dex-amm-extended.graphql
1000 lines (694 loc) · 30.9 KB
/
schema-dex-amm-extended.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
# Subgraph Schema: DEX AMM (Extended)
# Version: 2.0.0
# See https://github.com/messari/subgraphs/blob/master/docs/Schema.md for details
enum Network {
ARBITRUM_ONE
ARWEAVE_MAINNET
AURORA
AVALANCHE
BOBA
BSC # aka BNB Chain
CELO
COSMOS
CRONOS
MAINNET # Ethereum Mainnet
FANTOM
FUSE
HARMONY
JUNO
MOONBEAM
MOONRIVER
NEAR_MAINNET
OPTIMISM
OSMOSIS
MATIC # aka Polygon
XDAI # aka Gnosis Chain
}
enum ProtocolType {
EXCHANGE
LENDING
YIELD
BRIDGE
GENERIC
# Will add more
}
type Token @entity {
" Smart contract address of the token "
id: ID!
" Name of the token, mirrored from the smart contract "
name: String!
" Symbol of the token, mirrored from the smart contract "
symbol: String!
" The number of decimal places this token uses, default to 18 "
decimals: Int!
" Optional field to track the price of a token, mostly for caching purposes "
lastPriceUSD: BigDecimal
" Optional field to track the block number of the last token price "
lastPriceBlockNumber: BigInt
}
enum RewardTokenType {
" For reward tokens awarded to LPs/lenders "
DEPOSIT
" For reward tokens awarded to borrowers "
BORROW
}
type RewardToken @entity {
" { Reward token type }-{ Smart contract address of the reward token } "
id: ID!
" Reference to the actual token "
token: Token!
" The type of the reward token "
type: RewardTokenType!
}
# Note that trading fee is the fee paid *by* the users, whereas LP fee and
# protocol fee are fees paid *to* the corresponding parties.
# Most of the time, trading fee = liquidity provider fee + protocol fee,
# but not always. Thus we explicitly specify all different fee types.
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 LP, as a percentage of the traded amount. e.g. 0.25% for Sushiswap, 0.02% for Curve v1. "
FIXED_LP_FEE
" Some protocols use dynamic LP fees (e.g., Bancor v2). Set `feePercentage` as 0 but handle the dynamic fees in the mapping code. "
DYNAMIC_LP_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
" One-time fee charged by the protocol during deposit, in percentages of the deposit token "
DEPOSIT_FEE
" One-time fee charged by the protocol (e.g. Bancor v3) during withdrawal, in percentages of the withdrawal token "
WITHDRAWAL_FEE
}
type LiquidityPoolFee @entity {
" { Fee type }-{ Pool address } "
id: ID!
" Fee as a percentage of the trade (swap) amount. Does not always apply "
feePercentage: BigDecimal
" Type of fee this pool uses "
feeType: LiquidityPoolFeeType!
}
#############################
##### 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!
" Version of the methodology used to compute metrics, loosely based on SemVer format (e.g. 1.0.0) "
methodologyVersion: String!
" The blockchain network this subgraph is indexing on "
network: Network!
" The type of protocol (e.g. DEX, Lending, Yield, etc) "
type: ProtocolType!
##### Quantitative Data #####
" Current TVL (Total Value Locked) of the entire protocol "
totalValueLockedUSD: BigDecimal!
" Current PCV (Protocol Controlled Value). Only relevant for protocols with PCV. "
protocolControlledValueUSD: 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. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Gross revenue for the protocol (revenue claimed by protocol). Examples: AMM protocol fee (Sushi’s 0.05%). OpenSea 10% sell fee. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the protocol. e.g. 0.30% of swap fee in Sushiswap, all yield generated by Yearn. "
cumulativeTotalRevenueUSD: BigDecimal!
" Number of cumulative unique users "
cumulativeUniqueUsers: Int!
" Total number of pools "
totalPoolCount: Int!
##### Snapshots #####
" Daily usage metrics for this protocol "
dailyUsageMetrics: [UsageMetricsDailySnapshot!]! @derivedFrom(field: "protocol")
" Hourly usage metrics for this protocol "
hourlyUsageMetrics: [UsageMetricsHourlySnapshot!]! @derivedFrom(field: "protocol")
" Daily financial metrics for this protocol "
financialMetrics: [FinancialsDailySnapshot!]! @derivedFrom(field: "protocol")
}
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!
" Version of the methodology used to compute metrics, loosely based on SemVer format (e.g. 1.0.0) "
methodologyVersion: String!
" The blockchain network this subgraph is indexing on "
network: Network!
" The type of protocol (e.g. DEX, Lending, Yield, etc) "
type: ProtocolType!
##### Quantitative Data #####
" Current TVL (Total Value Locked) of the entire protocol "
totalValueLockedUSD: BigDecimal!
" Current PCV (Protocol Controlled Value). Only relevant for protocols with PCV. "
protocolControlledValueUSD: BigDecimal
" All historical volume in USD "
cumulativeVolumeUSD: 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. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Gross revenue for the protocol (revenue claimed by protocol). Examples: AMM protocol fee (Sushi’s 0.05%). OpenSea 10% sell fee. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the protocol. e.g. 0.30% of swap fee in Sushiswap, all yield generated by Yearn. "
cumulativeTotalRevenueUSD: BigDecimal!
" Number of cumulative unique users "
cumulativeUniqueUsers: Int!
" Number of cumulative liquidity providers "
cumulativeUniqueLPs: Int!
" Number of cumulative traders "
cumulativeUniqueTraders: Int!
" Total number of pools "
totalPoolCount: Int!
" Total number of open positions "
openPositionCount: Int!
" Total number of positions (open and closed) "
cumulativePositionCount: Int!
##### Snapshots #####
" Daily usage metrics for this protocol "
dailyUsageMetrics: [UsageMetricsDailySnapshot!]! @derivedFrom(field: "protocol")
" Hourly usage metrics for this protocol "
hourlyUsageMetrics: [UsageMetricsHourlySnapshot!]! @derivedFrom(field: "protocol")
" Daily financial metrics for this protocol "
financialMetrics: [FinancialsDailySnapshot!]! @derivedFrom(field: "protocol")
##### Pools #####
" All pools that belong to this protocol "
pools: [LiquidityPool!]! @derivedFrom(field: "protocol")
}
###############################
##### Protocol Timeseries #####
###############################
type UsageMetricsDailySnapshot @entity {
" ID is # of days since Unix epoch time "
id: ID!
" Protocol this snapshot is associated with "
protocol: DexAmmProtocol!
" Number of unique daily active users "
dailyActiveUsers: Int!
" Number of cumulative unique users "
cumulativeUniqueUsers: Int!
" Total number of transactions occurred in a day. Transactions include all entities that implement the Event interface. "
dailyTransactionCount: Int!
" Total number of pools "
totalPoolCount: Int!
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
#### Statistics #####
" Statistics around swap events "
swapStats: Stat!
" Statistics around deposit events "
depositStats: Stat!
" Statistics around withdraw events "
withdrawStats: Stat!
}
type UsageMetricsHourlySnapshot @entity {
" { # of hours since Unix epoch time } "
id: ID!
" Protocol this snapshot is associated with "
protocol: DexAmmProtocol!
" Number of unique hourly active users "
hourlyActiveUsers: Int!
" Number of cumulative unique users "
cumulativeUniqueUsers: Int!
" Total number of transactions occurred in an hour. Transactions include all entities that implement the Event interface. "
hourlyTransactionCount: Int!
" Total number of deposits (add liquidity) in an hour "
hourlyDepositCount: Int!
" Total number of withdrawals (remove liquidity) in an hour "
hourlyWithdrawCount: Int!
" Total number of trades (swaps) in an hour "
hourlySwapCount: 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 this snapshot is associated with "
protocol: DexAmmProtocol!
" Current TVL (Total Value Locked) of the entire protocol "
totalValueLockedUSD: BigDecimal!
" Current PCV (Protocol Controlled Value). Only relevant for protocols with PCV. "
protocolControlledValueUSD: BigDecimal
" All trade volume occurred in a given day, in USD "
dailyVolumeUSD: BigDecimal!
" All historical trade volume in USD "
cumulativeVolumeUSD: 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. "
dailySupplySideRevenueUSD: 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. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Gross revenue for the protocol (revenue claimed by protocol). Examples: AMM protocol fee (Sushi’s 0.05%). OpenSea 10% sell fee. "
dailyProtocolSideRevenueUSD: BigDecimal!
" Gross revenue for the protocol (revenue claimed by protocol). Examples: AMM protocol fee (Sushi’s 0.05%). OpenSea 10% sell fee. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the protocol. e.g. 0.30% of swap fee in Sushiswap, all yield generated by Yearn. "
dailyTotalRevenueUSD: BigDecimal!
" All revenue generated by the protocol. e.g. 0.30% of swap fee in Sushiswap, all yield generated by Yearn. "
cumulativeTotalRevenueUSD: BigDecimal!
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
}
###############################
##### Pool-Level Metadata #####
###############################
type LiquidityPool @entity {
" Smart contract address of the pool "
id: ID!
" The protocol this pool belongs to "
protocol: DexAmmProtocol!
" Name of liquidity pool (e.g. Curve.fi DAI/USDC/USDT) "
name: String
" Symbol of liquidity pool (e.g. 3CRV) "
symbol: String
" 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, usually in liquidity mining programs. e.g. SUSHI in the Onsen program, MATIC for Aave Polygon "
rewardTokens: [RewardToken!]
" 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!]!
" Whether this pool is single-sided (e.g. Bancor, Platypus's Alternative Pool). The specifics of the implementation depends on the protocol. "
isSingleSided: Boolean!
" Creation timestamp "
createdTimestamp: BigInt!
" Creation block number "
createdBlockNumber: BigInt!
##### Quantitative Data #####
" Current TVL (Total Value Locked) of this pool in USD "
totalValueLockedUSD: BigDecimal!
" All revenue generated by the liquidity pool, accrued to the supply side. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" All revenue generated by the liquidity pool, accrued to the protocol. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the liquidity pool. "
cumulativeTotalRevenueUSD: BigDecimal!
" All historical trade volume occurred in this pool, in USD "
cumulativeVolumeUSD: BigDecimal!
" Amount of input tokens in the pool. The ordering should be the same as the pool's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Weights of input tokens in the liquidity pool in percentage values. For example, 50/50 for Uniswap pools, 48.2/51.8 for a Curve pool, 10/10/80 for a Balancer pool "
inputTokenWeights: [BigDecimal!]!
" Total supply of output token. Note that certain DEXes don't have an output token (e.g. Bancor) "
outputTokenSupply: BigInt
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal
" Total supply of output tokens that are staked (usually in the MasterChef contract). Used to calculate reward APY. "
stakedOutputTokenAmount: BigInt
" Per-block reward token emission as of the current block normalized to a day, in token's native amount. This should be ideally calculated as the theoretical rate instead of the realized amount. "
rewardTokenEmissionsAmount: [BigInt!]
" Per-block reward token emission as of the current block normalized to a day, in USD value. This should be ideally calculated as the theoretical rate instead of the realized amount. "
rewardTokenEmissionsUSD: [BigDecimal!]
##### Account/Position Data #####
" All positions in this market "
positions: [Position!]! @derivedFrom(field: "pool")
" Number of positions in this market "
positionCount: Int!
" Number of open positions in this market "
openPositionCount: Int!
" Number of closed positions in this market "
closedPositionCount: Int!
##### Snapshots #####
" Liquidity pool daily snapshots "
dailySnapshots: [LiquidityPoolDailySnapshot!]! @derivedFrom(field: "pool")
" Liquidity pool hourly snapshots "
hourlySnapshots: [LiquidityPoolHourlySnapshot!]! @derivedFrom(field: "pool")
##### Events #####
" All deposit (add liquidity) events occurred in this pool "
deposits: [Deposit!]! @derivedFrom(field: "pool")
" All withdraw (remove liquidity) events occurred in this pool "
withdraws: [Withdraw!]! @derivedFrom(field: "pool")
" All trade (swap) events occurred in this pool "
swaps: [Swap!]! @derivedFrom(field: "pool")
}
#################################
##### Pool-Level Timeseries #####
#################################
type LiquidityPoolDailySnapshot @entity {
" { Smart contract address of the pool }-{ # of days since Unix epoch time } "
id: ID!
" The protocol this snapshot belongs to "
protocol: DexAmmProtocol!
" The pool this snapshot belongs to "
pool: LiquidityPool!
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
##### Quantitative Data #####
" Current TVL (Total Value Locked) of this pool "
totalValueLockedUSD: BigDecimal!
" All revenue generated by the liquidity pool, accrued to the supply side. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Daily revenue generated by the liquidity pool, accrued to the supply side. "
dailySupplySideRevenueUSD: BigDecimal!
" All revenue generated by the liquidity pool, accrued to the protocol. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" Daily revenue generated by the liquidity pool, accrued to the protocol. "
dailyProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the liquidity pool. "
cumulativeTotalRevenueUSD: BigDecimal!
" Daily revenue generated by the liquidity pool. "
dailyTotalRevenueUSD: BigDecimal!
" All trade volume occurred in a given day, in USD "
dailyVolumeUSD: BigDecimal!
" All trade volume occurred in a given day for a specific input token, in native amount. The ordering should be the same as the pool's `inputTokens` field. "
dailyVolumeByTokenAmount: [BigInt!]!
" All trade volume occurred in a given day for a specific input token, in USD. The ordering should be the same as the pool's `inputTokens` field. "
dailyVolumeByTokenUSD: [BigDecimal!]!
" All historical trade volume occurred in this pool, in USD "
cumulativeVolumeUSD: BigDecimal!
" Amount of input tokens in the pool. The ordering should be the same as the pool's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Weights of input tokens in the liquidity pool in percentage values. For example, 50/50 for Uniswap pools, 48.2/51.8 for a Curve pool, 10/10/80 for a Balancer pool "
inputTokenWeights: [BigDecimal!]!
" Total supply of output token. Note that certain DEXes don't have an output token (e.g. Bancor) "
outputTokenSupply: BigInt
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal
" Total supply of output tokens that are staked (usually in the MasterChef contract). Used to calculate reward APY. "
stakedOutputTokenAmount: BigInt
" Per-block reward token emission as of the current block normalized to a day, in token's native amount. This should be ideally calculated as the theoretical rate instead of the realized amount. "
rewardTokenEmissionsAmount: [BigInt!]
" Per-block reward token emission as of the current block normalized to a day, in USD value. This should be ideally calculated as the theoretical rate instead of the realized amount. "
rewardTokenEmissionsUSD: [BigDecimal!]
#### Statistics #####
" Statistics around swap events "
swapStats: Stat!
" Statistics around deposit events "
depositStats: Stat!
" Statistics around withdraw events "
withdrawStats: Stat!
}
type LiquidityPoolHourlySnapshot @entity {
" { Smart contract address of the pool }-{ # of hours since Unix epoch time } "
id: ID!
" The protocol this snapshot belongs to "
protocol: DexAmmProtocol!
" The pool this snapshot belongs to "
pool: LiquidityPool!
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
##### Quantitative Data #####
" Current TVL (Total Value Locked) of this pool "
totalValueLockedUSD: BigDecimal!
" All revenue generated by the liquidity pool, accrued to the supply side. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Hourly revenue generated by the liquidity pool, accrued to the supply side. "
hourlySupplySideRevenueUSD: BigDecimal!
" All revenue generated by the liquidity pool, accrued to the protocol. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" Hourly revenue generated by the liquidity pool, accrued to the protocol. "
hourlyProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the liquidity pool. "
cumulativeTotalRevenueUSD: BigDecimal!
" Hourly revenue generated by the liquidity pool. "
hourlyTotalRevenueUSD: BigDecimal!
" All trade volume occurred in a given hour, in USD "
hourlyVolumeUSD: BigDecimal!
" All trade volume occurred in a given hour for a specific input token, in native amount. The ordering should be the same as the pool's `inputTokens` field. "
hourlyVolumeByTokenAmount: [BigInt!]!
" All trade volume occurred in a given hour for a specific input token, in USD. The ordering should be the same as the pool's `inputTokens` field. "
hourlyVolumeByTokenUSD: [BigDecimal!]!
" All historical trade volume occurred in this pool, in USD "
cumulativeVolumeUSD: BigDecimal!
" Amount of input tokens in the pool. The ordering should be the same as the pool's `inputTokens` field. "
inputTokenBalances: [BigInt!]!
" Weights of input tokens in the liquidity pool in percentage values. For example, 50/50 for Uniswap pools, 48.2/51.8 for a Curve pool, 10/10/80 for a Balancer pool "
inputTokenWeights: [BigDecimal!]!
" Total supply of output token. Note that certain DEXes don't have an output token (e.g. Bancor) "
outputTokenSupply: BigInt
" Price per share of output token in USD "
outputTokenPriceUSD: BigDecimal
" Total supply of output tokens that are staked (usually in the MasterChef contract). Used to calculate reward APY. "
stakedOutputTokenAmount: BigInt
" Per-block reward token emission as of the current block normalized to a day (not hour), in token's native amount. This should be ideally calculated as the theoretical rate instead of the realized amount. "
rewardTokenEmissionsAmount: [BigInt!]
" Per-block reward token emission as of the current block normalized to a day (not hour), in USD value. This should be ideally calculated as the theoretical rate instead of the realized amount. "
rewardTokenEmissionsUSD: [BigDecimal!]
}
##############################
##### Account-Level Data #####
##############################
type Account @entity {
" { Account address } "
id: ID!
" Number of positions this account has "
positionCount: Int!
" All positions that belong to this account "
positions: [Position!]! @derivedFrom(field: "account")
" Number of open positions this account has "
openPositionCount: Int!
" Number of closed positions this account has "
closedPositionCount: Int!
" Number of deposits this account made "
depositCount: Int!
" All deposit events of this account "
deposits: [Deposit!]! @derivedFrom(field: "account")
" Number of withdrawals this account made "
withdrawCount: Int!
" All withdraw events of this account "
withdraws: [Withdraw!]! @derivedFrom(field: "account")
" Number of times this account has traded/swapped"
swapCount: Int!
" All swap events of this account "
swaps: [Swap!]! @derivedFrom(field: "account")
}
type Position @entity {
" { Account address }-{ Market address }-{ Count } "
id: ID!
" Account that owns this position "
account: Account!
" The liquidity pool in which this position was opened "
pool: LiquidityPool!
" The hash of the transaction that opened this position "
hashOpened: String!
" The hash of the transaction that closed this position "
hashClosed: String
" Block number of when the position was opened "
blockNumberOpened: BigInt!
" Timestamp when the position was opened "
timestampOpened: BigInt!
" Block number of when the position was closed (0 if still open) "
blockNumberClosed: BigInt
" Timestamp when the position was closed (0 if still open) "
timestampClosed: BigInt
" Input token balances in this position, in native amounts "
inputTokenBalances: [BigInt!]!
" Output token balance in this position, in native amounts "
outputTokenBalance: BigInt
" Total reward token accumulated under this position, in native amounts "
cumulativeRewardTokenAmounts: [BigInt!]
" Number of deposits related to this position "
depositCount: Int!
" All deposit events of this position "
deposits: [Deposit!]! @derivedFrom(field: "position")
" Number of withdrawals related to this position "
withdrawCount: Int!
" All withdraw events of this position "
withdraws: [Withdraw!]! @derivedFrom(field: "position")
" Position daily snapshots for open positions "
snapshots: [PositionSnapshot!]! @derivedFrom(field: "position")
}
# Unlike other snapshots that are taken at a fixed time interval. Position
# snapshots should be taken after every event, including the opening and
# closing events. This will prevent an ever growing number of snapshots
# for positions that are not moving. As we are only recording the balance
# in token amounts instead of in USD, this will work well.
# Note that we only take snapshot for open positions
type PositionSnapshot @entity {
" { Position ID }-{ Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that triggered this snapshot "
hash: String!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" Nonce of the transaction that triggered this snapshot "
nonce: BigInt!
" Position of this snapshot "
position: Position!
" Input token balances in this position, in native amounts "
inputTokenBalances: [BigInt!]!
" Output token balance in this position, in native amounts "
outputTokenBalance: BigInt
" Total reward token accumulated under this position, in native amounts "
cumulativeRewardTokenAmounts: [BigInt!]
" Block number of this snapshot "
blockNumber: BigInt!
" Timestamp of this snapshot "
timestamp: BigInt!
}
##################################
##### Event-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.
"""
type Deposit @entity {
" deposit-{ Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Nonce of the transaction that emitted this event "
nonce: BigInt!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" Gas limit of the transaction that emitted this event "
gasLimit: BigInt!
" Gas price of the transaction that emitted this event "
gasPrice: BigInt!
" The protocol this transaction belongs to "
protocol: DexAmmProtocol!
" Account that emitted this event "
account: Account!
" The user position changed by this event "
position: Position!
" The pool involving this event "
pool: LiquidityPool!
" Block number of this event "
blockNumber: BigInt!
" Timestamp of this event "
timestamp: BigInt!
" Input tokens of the pool. E.g. WETH and USDC to a WETH-USDC pool "
inputTokens: [Token!]!
" Output token of the pool. E.g. the UNI-LP token "
outputToken: Token
" Amount of input tokens in the token's native unit "
inputTokenAmounts: [BigInt!]!
" Amount of output tokens in the token's native unit "
outputTokenAmount: BigInt
" USD-normalized value of the transaction of the underlying (e.g. sum of tokens deposited into a pool) "
amountUSD: BigDecimal!
}
type Withdraw @entity {
" withdraw-{ Transaction hash }-{ Log index }"
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Nonce of the transaction that emitted this event "
nonce: BigInt!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" Gas limit of the transaction that emitted this event "
gasLimit: BigInt!
" Gas price of the transaction that emitted this event "
gasPrice: BigInt!
" The protocol this transaction belongs to "
protocol: DexAmmProtocol!
" Account that emitted this event "
account: Account!
" The user position changed by this event "
position: Position!
" The pool involving this event "
pool: LiquidityPool!
" Block number of this event "
blockNumber: BigInt!
" Timestamp of this event "
timestamp: BigInt!
" Input tokens of the pool (not input tokens of the event/transaction). E.g. WETH and USDC from a WETH-USDC pool "
inputTokens: [Token!]!
" Output token of the pool (not output token of the event/transaction). E.g. the UNI-LP token "
outputToken: Token
" Amount of input tokens in the token's native unit "
inputTokenAmounts: [BigInt!]!
" Amount of output tokens in the token's native unit "
outputTokenAmount: BigInt
" USD-normalized value of the transaction of the underlying (e.g. sum of tokens withdrawn from a pool) "
amountUSD: BigDecimal!
}
type Swap @entity {
" swap-{ Transaction hash }-{ Log index } "
id: ID!
" Transaction hash of the transaction that emitted this event "
hash: String!
" Nonce of the transaction that emitted this event "
nonce: BigInt!
" Event log index. For transactions that don't emit event, create arbitrary index starting from 0 "
logIndex: Int!
" Gas limit of the transaction that emitted this event "
gasLimit: BigInt!
" Gas price of the transaction that emitted this event "
gasPrice: BigInt!
" The protocol this transaction belongs to "
protocol: DexAmmProtocol!
" Account that emitted this event "
account: Account!
" The user position changed by this event "
position: Position!
" The pool involving this event "
pool: LiquidityPool!
" Block number of this event "
blockNumber: BigInt!
" Timestamp of this event "
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!
}
type Stat @entity {
" { protocol/pool }-{ [Optional] Pool ID }-{ deposit/withdraw/swap }-{ Days/hours since Unix epoch } "
id: ID!
" Total count of event (e.g. total number of swaps) "
count: BigInt!
" Average in native token amount (rounded down) "
meanAmount: BigInt!
" Average in USD "
meanUSD: BigDecimal!
" Median in native token amount"
medianAmount: BigInt!
" Median in USD "
medianUSD: BigDecimal!
" Maximum in native token amount "
maxAmount: BigInt!
" Maximum in USD "
maxUSD: BigDecimal!
" Minimum in native token amount "
minAmount: BigInt!
" Minimum in USD "
minUSD: BigDecimal!
" Variance for native token amount "
varAmount: BigDecimal!
" Variance for USD "
varUSD: BigDecimal!
}
# Helper entity for calculating daily/hourly active users
type ActiveAccount @entity {
" { daily/hourly }-{ Address of the account }-{ Days/hours since Unix epoch } "
id: ID!
}