-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathschema.graphql
1400 lines (1026 loc) · 44.4 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
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
"""
Graph Network global parameters and contract addresses
"""
type GraphNetwork @entity {
"ID is set to 1"
id: Bytes!
"Ratio of max staked delegation tokens to indexers stake that earns rewards"
delegationRatio: Int!
# Staking global aggregate values
"The total amount of GRT staked in the staking contract"
totalTokensStaked: BigInt!
"NOT IMPLEMENTED - Total tokens that are settled and waiting to be claimed"
totalTokensClaimable: BigInt! # TODO - see https://github.com/graphprotocol/graph-network-subgraph/issues/89
"Total tokens that are currently locked or withdrawable in the network from unstaking"
totalUnstakedTokensLocked: BigInt!
"Total GRT currently in allocation"
totalTokensAllocated: BigInt!
"Total delegated tokens in the protocol"
totalDelegatedTokens: BigInt!
# Query fees globals
"Total query fees generated in the network"
totalQueryFees: BigInt!
"Total query fees collected by indexers"
totalIndexerQueryFeesCollected: BigInt!
"Total query fees rebates claimed by indexers"
totalIndexerQueryFeeRebates: BigInt!
"Total query fees rebates claimed by delegators"
totalDelegatorQueryFeeRebates: BigInt!
"Total query fees payed to curators"
totalCuratorQueryFees: BigInt!
"Total protocol taxes applied to the query fees"
totalTaxedQueryFees: BigInt!
# It is hard to separate the unclaimed and rebates lost
"Total unclaimed rebates. Includes unclaimed rebates and rebates lost in rebate mechanism "
totalUnclaimedQueryFeeRebates: BigInt!
# Indexing rewards globals
"Total indexing rewards minted"
totalIndexingRewards: BigInt!
"Total indexing rewards minted to Delegators"
totalIndexingDelegatorRewards: BigInt!
"Total indexing rewards minted to Indexers"
totalIndexingIndexerRewards: BigInt!
# Curation global aggregate values
"The total amount of GRT signalled in the Curation contract"
totalTokensSignalled: BigInt!
"Default reserve ratio for all subgraphs. In parts per million"
defaultReserveRatio: Int!
# Count aggregate values. Note, deprecated subgraphs or inactive users not removed from counts
"Total indexers"
indexerCount: Int!
"Number of indexers that currently have some stake in the protocol"
stakedIndexersCount: Int!
"Total delegators"
delegatorCount: Int!
"Total curators"
curatorCount: Int!
"Total subgraphs"
subgraphCount: Int!
"Total subgraphs"
subgraphDeploymentCount: Int!
}
"""
An account within the graph network. Contains metadata and all relevant data for this accounts
delegating, curating, and indexing.
"""
type GraphAccount @entity {
"Graph account ID"
id: Bytes!
"All names this graph account has claimed from all name systems"
names: [GraphAccountName!]! @derivedFrom(field: "graphAccount")
"Default name the graph account has chosen"
defaultName: GraphAccountName # Can optimize in future by checking ENS & others to make sure they still own the name
"Time the account was created"
createdAt: Int!
"Default display name is the current default name. Used for filtered queries in the explorer"
defaultDisplayName: String
# IPFS Metadata.
metadata: GraphAccountMetadata
# Operator info
"Operator of other Graph Accounts"
operatorOf: [GraphAccount!]! @derivedFrom(field: "operators")
"Operators of this Graph Accounts"
operators: [GraphAccount!]!
# GRT info
"Graph token balance"
balance: BigInt!
"Balance received due to failed signal transfer from L1"
balanceReceivedFromL1Signalling: BigInt!
"Balance received due to failed delegation transfer from L1"
balanceReceivedFromL1Delegation: BigInt!
"Amount this account has approved staking to transfer their GRT"
curationApproval: BigInt!
"Amount this account has approved curation to transfer their GRT"
stakingApproval: BigInt!
"Amount this account has approved the GNS to transfer their GRT"
gnsApproval: BigInt!
# Subgraphs
"Subgraphs the graph account owns"
subgraphs: [Subgraph!]! @derivedFrom(field: "owner")
"Time that this graph account became a developer"
developerCreatedAt: Int
# Staking and Curating and Delegating
"Curator fields for this GraphAccount. Null if never curated"
curator: Curator
"Indexer fields for this GraphAccount. Null if never indexed"
indexer: Indexer
"Delegator fields for this GraphAccount. Null if never delegated"
delegator: Delegator
# Transactions / activity feed
"Name signal transactions created by this GraphAccount"
nameSignalTransactions: [NameSignalTransaction!]! @derivedFrom(field: "signer")
}
type GraphAccountMetadata @entity(immutable:true) {
"IPFS hash with account metadata details"
id: Bytes!
"Account that reference this metadata file. For compatibility purposes. For the full list use graphAccounts"
graphAccount: GraphAccount @derivedFrom(field:"metadata")
"Accounts that reference this metadata file"
graphAccounts: [GraphAccount!]! @derivedFrom(field:"metadata")
"True if it is an organization. False if it is an individual"
isOrganization: Boolean
"Main repository of code for the graph account"
codeRepository: String
"Description of the graph account"
description: String
"Image URL"
image: String
"Website URL"
website: String
"Display name. Not unique"
displayName: String
}
"""
A name chosen by a Graph Account from a Name System such as ENS. This allows Graph Accounts to be
recognized by name, rather than just an Ethereum address
"""
type GraphAccountName @entity {
"Name system concatenated with the unique ID of the name system"
id: ID!
"Name system for this name"
nameSystem: NameSystem!
"Name from the system"
name: String!
"The graph account that owned the name when it was linked in the graph network"
graphAccount: GraphAccount # May not match if the graph account proceeded to transfer away their name on that system
}
enum NameSystem {
ENS
}
"""
The Subgraph entity represents a permanent, unique endpoint. This unique endpoint can resolve to
many different SubgraphVersions over it's lifetime. The Subgraph can also have a name attributed
to it. The owner of the Subgraph can only use a name once, thus making the owner account and the
name chosen a unique combination. When a Curator singals on a Subgraph, they receive "Name Signal".
"Name Signal" resolves into the underlying "Signal" of the SubgraphDeployment. The metadata of the
subgraph is stored on IPFS.
"""
type Subgraph @entity {
"Subgraph ID - which is derived from the Organization/Individual graph accountID"
id: Bytes!
"Graph account that owns this subgraph"
owner: GraphAccount!
"Current version"
currentVersion: SubgraphVersion
"[DEPRECATED] Past versions. Has the same data as 'versions' but keeps the old naming for backwards compatibility"
pastVersions: [SubgraphVersion!]! @derivedFrom(field: "subgraph")
"List of all the subgraph versions included the current one"
versions: [SubgraphVersion!]! @derivedFrom(field: "subgraph")
"Version counter"
versionCount: BigInt!
"Creation timestamp"
createdAt: Int!
"Updated timestamp"
updatedAt: Int!
"Whether the subgraph is active or deprecated"
active: Boolean!
"Whether the subgraph has been migrated to the NFT implementation"
migrated: Boolean!
"Auxiliary field to denote whether the subgraph is handling the initialization order on V2 events. Doesn't matter for V1 events."
initializing: Boolean!
"The actual ID of the subgraph on the contracts subgraph NFT implementation. BigInt represented as a String. It's only actually valid once the subgraph is migrated (migrated == true)"
nftID: String!
"ID of the subgraph that was used on the old version of this The Graph Network Subgraph. Null for Subgraphs created with the new GNS implementation"
oldID: String
"Address used to create the ID. Only available for Subgraphs created pre-migration"
creatorAddress: Bytes
"Subgraph number used to create the ID. Only available for Subgraphs created pre-migration"
subgraphNumber: BigInt
"[DEPRECATED] Version of the entity. Subgraph entities are changing the way their ID is generated when the new GNS v2 rolls out so we need to differnetiate them"
entityVersion: Int!
# Name curation data for bonding curve
# Note that the Subgraphs V signal is actually stored in a Signal entity, which
# considers the GNS as a Curator
"CUMULATIVE signaled tokens on this subgraph all time"
signalledTokens: BigInt!
"CUMULATIVE unsignalled tokens on this subgraph all time"
unsignalledTokens: BigInt!
"The CURRENT name signal amount for this subgraph"
nameSignalAmount: BigInt!
"Reserve ratio of the name curation curve. In parts per million"
reserveRatio: Int!
"Tokens that can be withdrawn once the Subgraph is deprecated"
withdrawableTokens: BigInt!
"Tokens the curators have withdrawn from the deprecated Subgraph"
withdrawnTokens: BigInt!
"Curators of this subgraph deployment"
nameSignals: [NameSignal!]! @derivedFrom(field: "subgraph")
# # Metadata from IPFS linked in GNS
"Subgraph metadata"
metadataHash: Bytes
"Whether the subgraph has been transferred from L1 to L2. Subgraphs published on L2 will have this as false unless they were published through a transfer"
startedTransferToL2: Boolean!
"Timestamp for the L1 -> L2 Transfer. Null if the transfer hasn't started yet"
startedTransferToL2At: BigInt
"Block number for the L1 -> L2 Transfer. Null if the transfer hasn't started yet"
startedTransferToL2AtBlockNumber: BigInt
"Transaction hash for the L1 -> L2 Transfer. Null if the transfer hasn't started yet"
startedTransferToL2AtTx: Bytes
"Whether the subgraph has been fully transferred from L1 to L2. Subgraphs published on L2 will have this as false unless they were published through a transfer"
transferredToL2: Boolean!
"Timestamp for the L1 -> L2 Transfer. Null if it's not fully transferred or if it's an L1 deployment"
transferredToL2At: BigInt
"Block number for the L1 -> L2 Transfer. Null if it's not fully transferred or if it's an L1 deployment"
transferredToL2AtBlockNumber: BigInt
"Transaction hash for the L1 -> L2 Transfer. Null if it's not fully transferred or if it's an L1 deployment"
transferredToL2AtTx: Bytes
"Amount of GRT transferred to L2"
signalledTokensSentToL2: BigInt!
"Amount of GRT received on L2"
signalledTokensReceivedOnL2: BigInt!
"ID of the subgraph on L2. Null if it's not transferred"
idOnL2: Bytes
"ID of the subgraph on L1. Null if it's not transferred"
idOnL1: Bytes
}
"""
The SubgraphVersion entity represents a version of the Subgraph. A new SubgraphVersion is created
whenever there is an update to the Subgraph triggered by the owner. The new SubgraphVersion can
then point to a new SubgraphDeployment, thus allowing the Subgraph to resolve to a different
deployment, while keeping the same endpoint. The metadata and label are stored on IPFS. The label
is for the developer to provide a semantic version. This is different from the version, which is
just a counter than increases each time a new SubgraphVersion is created for a Subgraph.
"""
type SubgraphVersion @entity {
"Concatenation of subgraph, subgraph deployment, and version ID"
id: Bytes!
"Subgraph of this version"
subgraph: Subgraph!
"Subgraph deployment of this version"
subgraphDeployment: SubgraphDeployment!
"Version number"
version: Int!
"Creation timestamp"
createdAt: Int!
# Metadata from IPFS linked in GNS
"Subgraph version metadata content address"
metadataHash: Bytes
# "Short description of the version"
# description: String!
# "Semantic versioning label"
# label: String!
entityVersion: Int!
}
"""
The SubgraphDeployment is represented by the immutable subgraph code that is uploaded, and posted
to IPFS. A SubgraphDeployment has a manifest which gives the instructions to the Graph Network on
what to index. The entity stores relevant data for the SubgraphDeployment on how much it is being
staked on and signaled on in the contracts, as well as how it is performing in query fees. It is
related to a SubgraphVersion.
"""
type SubgraphDeployment @entity {
"Subgraph Deployment ID. The IPFS hash with Qm removed to fit into 32 bytes"
id: Bytes!
"The versions this subgraph deployment relates to"
versions: [SubgraphVersion!]! @derivedFrom(field: "subgraphDeployment")
"Creation timestamp"
createdAt: Int!
"The block at which this deployment was denied for rewards. Null if not denied"
deniedAt: Int!
# "The original Subgraph that was deployed through GNS. Can be null if never created through GNS. Used for filtering in the Explorer"
# originalName: String
# From Staking
"CURRENT total stake of all indexers on this Subgraph Deployment"
stakedTokens: BigInt!
"Allocations created by indexers for this Subgraph"
indexerAllocations: [Allocation!]! @derivedFrom(field: "subgraphDeployment")
"Total rewards accrued all time by this Subgraph Deployment. Includes delegator and indexer rewards"
indexingRewardAmount: BigInt!
"Total rewards accrued all time by indexers"
indexingIndexerRewardAmount: BigInt!
"Total rewards accrued all time by delegators"
indexingDelegatorRewardAmount: BigInt!
"Total query fees earned by this Subgraph Deployment, without curator query fees"
queryFeesAmount: BigInt!
"Total query fee rebates for indexers earned from the protocol, through the rebate mechanism formula."
queryFeeRebates: BigInt!
"Total query fee rebates for delegators earned from the protocol, through the rebate mechanism formula."
delegatorQueryFees: BigInt!
"Total curator rewards from fees"
curatorFeeRewards: BigInt!
# TODO - We can add a field here for delegation fees earned when calling claim()
# Subgraph deployment curation bonding curve
"CURRENT signalled tokens in the bonding curve"
signalledTokens: BigInt!
"NOT IMPLEMENTED - CURRENT signalled tokens in the bonding curve"
unsignalledTokens: BigInt! # Will be used for rewards
"CURRENT curation signal for this subgraph deployment"
signalAmount: BigInt!
"signalledTokens / signalAmount"
pricePerShare: BigDecimal!
"Curators of this subgraph deployment"
curatorSignals: [Signal!]! @derivedFrom(field: "subgraphDeployment")
"Bonding curve reserve ratio. In parts per million"
reserveRatio: Int!
# From Subgraph Manifest
# dataSources: [DataSource!]
dailyData: [SubgraphDeploymentDailyData!]! @derivedFrom(field: "subgraphDeployment")
"Whether the deployment has been transferred from L1 to L2. Subgraphs published on L2 will have this as false unless they were published through a transfer"
transferredToL2: Boolean!
"Timestamp for the L1 -> L2 Transfer. Null if it's not fully transferred or if it's an L1 deployment"
transferredToL2At: BigInt
"Block number for the L1 -> L2 Transfer. Null if it's not fully transferred or if it's an L1 deployment"
transferredToL2AtBlockNumber: BigInt
"Transaction hash for the L1 -> L2 Transfer. Null if it's not fully transferred or if it's an L1 deployment"
transferredToL2AtTx: Bytes
"Amount of GRT transferred to L2"
signalledTokensSentToL2: BigInt!
"Amount of GRT received on L2"
signalledTokensReceivedOnL2: BigInt!
}
"""
Metadata for the Indexer along with parameters and staking data
"""
type Indexer @entity {
"Eth address of Indexer"
id: Bytes!
"Time this indexer was created"
createdAt: Int!
"Service registry URL for the indexer"
url: String
"Geohash of the indexer. Shows where their indexer is located in the world"
geoHash: String
account: GraphAccount!
defaultDisplayName: String
# Staking data
"CURRENT tokens staked in the protocol. Decreases on withdraw, not on lock"
stakedTokens: BigInt!
"CURRENT tokens allocated on all subgraphs"
allocatedTokens: BigInt!
"NOT IMPLEMENTED - Tokens that have been unstaked and withdrawn"
unstakedTokens: BigInt! # will be used for return % calcs
"CURRENT tokens locked"
lockedTokens: BigInt!
"The block when the Indexers tokens unlock"
tokensLockedUntil: Int!
"Active allocations of stake for this Indexer"
allocations: [Allocation!]! @derivedFrom(field: "activeForIndexer")
"All allocations of stake for this Indexer (i.e. closed and active)"
totalAllocations: [Allocation!]! @derivedFrom(field: "indexer")
"Number of active allocations of stake for this Indexer"
allocationCount: Int!
"All allocations for this Indexer (i.e. closed and active)"
totalAllocationCount: BigInt!
"Total query fees collected. Includes the portion given to delegators"
queryFeesCollected: BigInt!
"Query fee rebate amount claimed from the protocol through rebate mechanism. Does not include portion given to delegators"
queryFeeRebates: BigInt!
"Total indexing rewards earned by this indexer from inflation. Including delegation rewards"
rewardsEarned: BigInt!
"The total amount of indexing rewards the indexer kept"
indexerIndexingRewards: BigInt!
"The total amount of indexing rewards given to delegators"
delegatorIndexingRewards: BigInt!
"Percentage of indexers' own rewards received in relation to its own stake. 1 (100%) means that the indexer is receiving the exact amount that is generated by his own stake"
indexerRewardsOwnGenerationRatio: BigDecimal!
# Capacity Data
"Amount of delegated tokens that can be eligible for rewards"
delegatedCapacity: BigInt!
"Total token capacity = delegatedCapacity + stakedTokens"
tokenCapacity: BigInt!
"Stake available to earn rewards. tokenCapacity - allocationTokens - lockedTokens"
availableStake: BigInt!
# Delegation Pool
"Delegators to this Indexer"
delegators: [DelegatedStake!]! @derivedFrom(field: "indexer")
"Delegator relation entities. For internal usage for performance reasons"
relations: [IndexerDelegatedStakeRelation!]! @derivedFrom(field: "indexer")
"CURRENT tokens delegated to the indexer"
delegatedTokens: BigInt!
"Ratio between the amount of the indexers own stake over the total usable stake."
ownStakeRatio: BigDecimal!
"Ratio between the amount of delegated stake over the total usable stake."
delegatedStakeRatio: BigDecimal!
"Total shares of the delegator pool"
delegatorShares: BigInt!
"Exchange rate of of tokens received for each share"
delegationExchangeRate: BigDecimal!
"The percent of indexing rewards generated by the total stake that the Indexer keeps for itself. In parts per million"
indexingRewardCut: Int!
"The percent of indexing rewards generated by the delegated stake that the Indexer keeps for itself"
indexingRewardEffectiveCut: BigDecimal!
"The percent of reward dilution delegators experience because of overdelegation. Overdelegated stake can't be used to generate rewards but still gets accounted while distributing the generated rewards. This causes dilution of the rewards for the rest of the pool."
overDelegationDilution: BigDecimal!
"The total amount of query fees given to delegators"
delegatorQueryFees: BigInt!
"The percent of query rebate rewards the Indexer keeps for itself. In parts per million"
queryFeeCut: Int!
"The percent of query rebate rewards generated by the delegated stake that the Indexer keeps for itself"
queryFeeEffectiveCut: BigDecimal!
"Amount of blocks a delegator chooses for the waiting period for changing their params"
delegatorParameterCooldown: Int!
"Block number for the last time the delegator updated their parameters"
lastDelegationParameterUpdate: Int!
"Count of how many times this indexer has been forced to close an allocation"
forcedClosures: Int!
delegatorsCount: BigInt!
dailyData: [IndexerDailyData!]! @derivedFrom(field: "indexer")
"Whether the indexer has been transferred from L1 to L2 partially or fully"
transferredToL2: Boolean!
"Timestamp for the FIRST L1 -> L2 Transfer"
firstTransferredToL2At: BigInt
"Block number for the FIRST L1 -> L2 Transfer"
firstTransferredToL2AtBlockNumber: BigInt
"Transaction hash for the FIRST L1 -> L2 Transfer"
firstTransferredToL2AtTx: Bytes
"Timestamp for the latest L1 -> L2 Transfer"
lastTransferredToL2At: BigInt
"Block number for the latest L1 -> L2 Transfer"
lastTransferredToL2AtBlockNumber: BigInt
"Transaction hash for the latest L1 -> L2 Transfer"
lastTransferredToL2AtTx: Bytes
"Amount of GRT transferred to L2. Only visible from L1, as there's no events for it on L2"
stakedTokensTransferredToL2: BigInt!
"ID of the indexer on L2. Null if it's not transferred"
idOnL2: Bytes
"ID of the indexer on L1. Null if it's not transferred"
idOnL1: Bytes
}
"""
A state channel Allocation representing a single Indexer-SubgraphDeployment stake
"""
type Allocation @entity {
"Channel Address"
id: Bytes!
"Indexer of this allocation"
indexer: Indexer!
"Creator of the allocation - can be the operator or the indexer"
creator: Bytes!
"If the Allocation is active it shows the indexer. If closed, it is null"
activeForIndexer: Indexer
"Subgraph deployment that is being allocated to"
subgraphDeployment: SubgraphDeployment!
"Tokens allocation in this allocation"
allocatedTokens: BigInt!
"Effective allocation that is realized upon closing"
effectiveAllocation: BigInt!
"Epoch this allocation was created"
createdAtEpoch: Int!
"Block at which this allocation was created"
createdAtBlockHash: Bytes!
"Epoch this allocation was closed in"
closedAtEpoch: Int!
"Block hash at which this allocation was closed"
closedAtBlockHash: Bytes
"Block number at which this allocation was closed"
closedAtBlockNumber: Int
"Fees this allocation collected from query fees upon closing. Excludes curator reward and protocol tax"
queryFeesCollected: BigInt!
"Query fee rebate amount claimed from the protocol through rebates mechanism. Does not include portion given to delegators"
queryFeeRebates: BigInt!
"Query fee rebates collected from the protocol. Can differ from queryFeeRebates if multiple vouchers per allocation are allowed."
distributedRebates: BigInt!
"Curator rewards deposited to the curating bonding curve"
curatorRewards: BigInt!
"Indexing rewards earned by this allocation. Includes delegator and indexer rewards"
indexingRewards: BigInt!
"Indexing rewards earned by this allocation by indexers"
indexingIndexerRewards: BigInt!
"Indexing rewards earned by this allocation by delegators"
indexingDelegatorRewards: BigInt!
"Pool in which this allocation was closed"
poolClosedIn: Pool
"Fees paid out to delegators"
delegationFees: BigInt!
"Status of the allocation"
status: AllocationStatus!
"Timestamp this allocation was created at"
createdAt: Int!
"POI submitted with a closed allocation"
poi: Bytes
# Metrics NOT IMPLEMENTED YET
"NOT IMPLEMENTED - Return for this allocation"
totalReturn: BigDecimal!
"NOT IMPLEMENTED - Yearly annualzied return"
annualizedReturn: BigDecimal!
}
enum AllocationStatus {
Null # == indexer == address(0)
Active # == not Null && tokens > 0 #
Closed # == Active && closedAtEpoch != 0. Still can collect, while you are waiting to be finalized. a.k.a settling
Finalized # == [DEPRECATED] Closing && closedAtEpoch + channelDisputeEpochs > now(). Note, the subgraph has no way to return this value. it is implied
Claimed # == [DEPRECATED] not Null && tokens == 0 - i.e. finalized, and all tokens withdrawn
}
"""
Global pool of query fees for closed state channels. Each Epoch has a single pool,
hence why they share the same IDs.
"""
type Pool @entity {
"Epoch number of the pool"
id: Bytes!
"Total effective allocation tokens from all allocations closed in this epoch"
allocation: BigInt!
"Total query fees collected in this epoch"
totalQueryFees: BigInt!
"Total query fees claimed in this epoch. Can be smaller than totalFees because of rebate mechanism function "
claimedFees: BigInt!
"Total rewards from query fees deposited to all curator bonding curves during the epoch"
curatorRewards: BigInt!
"Allocations that were closed during this epoch"
closedAllocations: [Allocation!]! @derivedFrom(field: "poolClosedIn")
}
"""
Delegator with all their delegated stakes towards Indexers
"""
type Delegator @entity {
"Delegator address"
id: Bytes!
account: GraphAccount!
defaultDisplayName: String
"Stakes of this delegator"
stakes: [DelegatedStake!]! @derivedFrom(field: "delegator")
"Time created at"
createdAt: Int!
"[POSSIBLE DEPRECATION] Current amount of staked tokens across all DelegatedStakes"
stakedTokens: BigInt!
"Current amount of locked tokens (undelegating) across all DelegatedStakes"
lockedTokens: BigInt!
"[CURRENT] Total realized rewards across all delegated stakes. Realized rewards are added when undelegating and realizing a profit"
totalRealizedRewards: BigDecimal!
"[CURRENT] Total unrealized rewards across all delegated stakes."
totalUnrealizedRewards: BigDecimal!
"[CURRENT] Original amount delegated across all delegated stakes."
originalDelegation: BigDecimal!
"[CURRENT] Current delegation amount across all delegated stakes. This is updated based on the continuous restake from delegation"
currentDelegation: BigDecimal!
"List of all the daily data entities that exists for this delegator"
dailyData: [DelegatorDailyData!]! @derivedFrom(field: "delegator")
# Old probably not very useful metrics
"CUMULATIVE staked tokens in DelegatorStakes of this Delegator"
totalStakedTokens: BigInt!
"CUMULATIVE unstaked tokens in DelegatorStakes of this Delegator"
totalUnstakedTokens: BigInt!
"Total DelegatedStake entity count (Active and inactive)"
stakesCount: Int!
"Active DelegatedStake entity count. Active means it still has GRT delegated"
activeStakesCount: Int!
"Last time this delegator delegated towards any indexer"
lastDelegatedAt: Int
"Last time this delegator undelegated from any indexer"
lastUndelegatedAt: Int
"DelegatedStake entity related to the lastDelegatedAt field"
lastDelegation: DelegatedStake
"DelegatedStake entity related to the lastUndelegatedAt field"
lastUndelegation: DelegatedStake
}
"""
Delegator stake for a single Indexer
"""
type DelegatedStake @entity {
"Concatenation of Delegator address and Indexer address"
id: Bytes!
"Index the stake is delegated to"
indexer: Indexer!
"Delegator"
delegator: Delegator!
"[POSSIBLE DEPRECATION] CURRENT tokens staked. Old stakedTokens implementation renamed to totalStakedTokens (19/03/21)"
stakedTokens: BigInt!
"CURRENT tokens locked"
lockedTokens: BigInt!
"Epoch the locked tokens get unlocked"
lockedUntil: Int!
"Shares owned in the delegator pool. Used to calculate total amount delegated"
shareAmount: BigInt!
"The rate this delegator paid for their shares (calculated using average cost basis). Used for rewards calculations"
personalExchangeRate: BigDecimal!
"Realized rewards from undelegating and realizing a reward"
realizedRewards: BigDecimal!
# Pre-calculated data
"[CURRENT] Latest known value for share exchange rate. Should reflect the same value as 'delegationExchangeRate' on the related Indexer"
latestIndexerExchangeRate: BigDecimal!
"[CURRENT] Rewards not yet withdrawn, but already distributed."
unrealizedRewards: BigDecimal!
"[CURRENT] Original value of the delegation shares. Should be sharesAmount * personalExchangeRate"
originalDelegation: BigDecimal!
"[CURRENT] Current value of the delegation shares. Should be sharesAmount * latestIndexerExchangeRate"
currentDelegation: BigDecimal!
"CUMULATIVE tokens delegated"
totalStakedTokens: BigInt!
"CUMULATIVE tokens undelegated"
totalUnstakedTokens: BigInt!
"Time this delegator first delegated to an indexer"
createdAt: Int!
"Last time this delegator delegated towards this indexer"
lastDelegatedAt: Int
"Last time this delegator undelegated from this indexer"
lastUndelegatedAt: Int
"Auxiliary entity used for batch updates"
relation: IndexerDelegatedStakeRelation!
"Whether the delegation has been transferred from L1 to L2"
transferredToL2: Boolean!
"Timestamp for the L1 -> L2 Transfer"
transferredToL2At: BigInt
"Block number for the L1 -> L2 Transfer"
transferredToL2AtBlockNumber: BigInt
"Transaction hash for the L1 -> L2 Transfer"
transferredToL2AtTx: Bytes
"Amount of GRT transferred to L2. Only visible from L1, as there's no events for it on L2"
stakedTokensTransferredToL2: BigInt!
"ID of the delegation on L2. Null if it's not transferred"
idOnL2: Bytes
"ID of the delegation on L1. Null if it's not transferred"
idOnL1: Bytes
}
"""
Curator with all Signals and metrics
"""
type Curator @entity {
"Eth address of the Curator"
id: Bytes!
"Time this curator was created"
createdAt: Int!
"CUMULATIVE tokens signalled on all the subgraphs"
totalSignalledTokens: BigInt!
"CUMULATIVE tokens unsignalled on all the subgraphs"
totalUnsignalledTokens: BigInt!
"Subgraphs the curator is curating"
signals: [Signal!]! @derivedFrom(field: "curator")
"CUMULATIVE tokens signalled on all names"
totalNameSignalledTokens: BigInt!
"CUMULATIVE tokens unsignalled on all names"
totalNameUnsignalledTokens: BigInt!
"CUMULATIVE withdrawn tokens from deprecated subgraphs"
totalWithdrawnTokens: BigInt!
"Subgraphs the curator is curating"
nameSignals: [NameSignal!]! @derivedFrom(field: "curator")
# Metrics NOTE - will be hard to calculate these with the two types of signal
"NOT IMPLEMENTED - Summation of realized rewards from all Signals"
realizedRewards: BigInt!
"NOT IMPLEMENTED - Annualized rate of return on curator signal"
annualizedReturn: BigDecimal!
"NOT IMPLEMENTED - Total return of the curator"
totalReturn: BigDecimal!
"NOT IMPLEMENTED - Signaling efficiency of the curator"
signalingEfficiency: BigDecimal!
"CURRENT summed name signal for all bonding curves"
totalNameSignal: BigDecimal!
"Total curator cost basis of all shares purchased on all bonding curves"
totalNameSignalAverageCostBasis: BigDecimal!
"totalNameSignalCostBasis / totalNameSignal"
totalAverageCostBasisPerNameSignal: BigDecimal!
}
"""
Curator Signal for a single SubgraphDeployment
"""
type Signal @entity {
"Eth address + subgraph deployment ID"
id: Bytes!
"Eth address of the curator"
curator: Curator!
"Subgraph being signalled"
subgraphDeployment: SubgraphDeployment!
"CUMULATIVE number of tokens the curator has signalled"
signalledTokens: BigInt!
"CUMULATIVE number of tokens the curator has unsignalled"
unsignalledTokens: BigInt!
"Signal that the curator has from signaling their GRT"
signal: BigInt!
# Metrics
"Block for which the curator last entered or exited the curve"
lastSignalChange: Int!
# These are summed up and added whenever curator enters or exists the curve. Then we must calculate
# unrealized gains for their current balance, based on the time since the last exit/entry of the curve
"Summation of realized rewards from before the last time the curator entered the curation curve"
realizedRewards: BigInt!
}
"""
Curator Name Signal for a single Subgraph
"""
type NameSignal @entity {
"Eth address + subgraph ID"
id: Bytes!
"Eth address of the curator"
curator: Curator!
"Subgraph being signalled"
subgraph: Subgraph!
"CUMULATIVE number of tokens the curator has signalled"
signalledTokens: BigInt!
"CUMULATIVE number of tokens the curator has unsignalled"
unsignalledTokens: BigInt!
"Tokens the curator has withdrawn from a deprecated name curve"
withdrawnTokens: BigInt!
"Signal that the curator has from signaling their GRT"
nameSignal: BigInt!
# Note , we don't show vSignal here. We could, but it has almost no value to display it.
# We can get away with using curator nameSignal, total n and v signal on the subgraph.
# Metrics
"Block for which the curator last entered or exited the curve"
lastNameSignalChange: Int!
# These are summed up and added whenever curator enters or exists the curve. Then we must calculate
# unrealized gains for their current balance, based on the time since the last exit/entry of the curve
"Summation of realized rewards from before the last time the curator entered the curation curve"
realizedRewards: BigInt!
"Curator average cost basis for this name signal on this subgraph"
averageCostBasis: BigDecimal! # note this is ONLY name signal. This is okay for the protocol for now
"averageCostBasis / nameSignal"
averageCostBasisPerSignal: BigDecimal!
entityVersion: Int!
"Amount of GRT transferred to L2"
signalledTokensSentToL2: BigInt!
"Amount of GRT received on L2"
signalledTokensReceivedOnL2: BigInt!
"Whether the name signal has been transferred from L1 to L2. Only applies to NameSignals that have been transferred, native L2 NameSignal entities will return false"
transferredToL2: Boolean!
"Timestamp for the L1 -> L2 Transfer."
transferredToL2At: BigInt
"Block number for the L1 -> L2 Transfer."
transferredToL2AtBlockNumber: BigInt
"Transaction hash for the L1 -> L2 Transfer."
transferredToL2AtTx: Bytes
"ID of the NameSignal entity on L2. Null if it's not transferred"
idOnL2: Bytes
"ID of the NameSignal entity on L1. Null if it's not transferred"
idOnL1: Bytes
}
"""
A generic transaction in The Graph Network
"""
interface Transaction {
"Transaction hash concatenated with event log index"
id: Bytes!
"Block number for the transaction"
blockNumber: Int!
"Timestamp for the transaction"
timestamp: Int!
"Signer of the transaction"
signer: GraphAccount!
"Type of Graph Network transaction"