forked from messari/subgraphs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
schema-generic.graphql
440 lines (311 loc) · 13.7 KB
/
schema-generic.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
# Subgraph Schema: Generic
# Version: 1.3.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!
}
#############################
##### Protocol Metadata #####
#############################
type 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
" 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")
##### Pools #####
" All pools that belong to this protocol "
pools: [Pool!]! @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: Protocol!
" 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!
}
type UsageMetricsHourlySnapshot @entity {
" { # of hours since Unix epoch time } "
id: ID!
" Protocol this snapshot is associated with "
protocol: Protocol!
" 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!
" 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: Protocol!
" 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. "
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 Data #####
###########################
type Pool @entity {
" Smart contract address of the pool "
id: ID!
" The protocol this pool belongs to "
protocol: Protocol!
" Name of the pool (e.g. Curve.fi DAI/USDC/USDT) "
name: String
" Symbol of liquidity pool (e.g. 3CRV) "
symbol: String
# Generally protocols accept one or multiple tokens and mint tokens to the depositor to track ownership
# Some protocols don't mint any tokens to track ownership, in that case outputToken is null.
" 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!]
" 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 pool, accrued to the supply side. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" All revenue generated by the pool, accrued to the protocol. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the pool. "
cumulativeTotalRevenueUSD: 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. 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!]
##### Snapshots #####
" Pool daily snapshots "
dailySnapshots: [PoolDailySnapshot!]! @derivedFrom(field: "pool")
" Pool hourly snapshots "
hourlySnapshots: [PoolHourlySnapshot!]! @derivedFrom(field: "pool")
}
type PoolDailySnapshot @entity {
" { 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!
" 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 pool, accrued to the supply side. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Daily revenue generated by the pool, accrued to the supply side. "
dailySupplySideRevenueUSD: BigDecimal!
" All revenue generated by the pool, accrued to the protocol. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" Daily revenue generated by the pool, accrued to the protocol. "
dailyProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the pool. "
cumulativeTotalRevenueUSD: BigDecimal!
" Daily revenue generated by the pool. "
dailyTotalRevenueUSD: 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. 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!]
}
type PoolHourlySnapshot @entity {
" { Smart contract address of the pool }-{ # of hours since Unix epoch time } "
id: ID!
" The protocol this snapshot belongs to "
protocol: Protocol!
" The pool this snapshot belongs to "
pool: Pool!
" 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 pool, accrued to the supply side. "
cumulativeSupplySideRevenueUSD: BigDecimal!
" Hourly revenue generated by the pool, accrued to the supply side. "
hourlySupplySideRevenueUSD: BigDecimal!
" All revenue generated by the pool, accrued to the protocol. "
cumulativeProtocolSideRevenueUSD: BigDecimal!
" Hourly revenue generated by the pool, accrued to the protocol. "
hourlyProtocolSideRevenueUSD: BigDecimal!
" All revenue generated by the pool. "
cumulativeTotalRevenueUSD: BigDecimal!
" Hourly revenue generated by the pool. "
hourlyTotalRevenueUSD: 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. 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!]
}
# An account is a unique Ethereum address
# Helps to accumulate total unique users
type Account @entity {
" Address of the account "
id: ID!
}
# Helper entity for calculating daily/hourly active users
type ActiveAccount @entity {
" { daily/hourly }-{ Address of the account }-{ Days/hours since Unix epoch } "
id: ID!
}