-
Notifications
You must be signed in to change notification settings - Fork 7
/
schema.graphql
1064 lines (689 loc) · 21.1 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
# TODO add counters
"""
Entities defined in this file will follow this tempalte:
type ENTITY_NAME @entity {
"internal id used for indexation"
id: ID!
# stored values
... Scalar values stored in this entity
# stored relationships
... Relationships from this entity to others
# derived relationships
... Relationships to this entity from others
# metadata relationships
... Stored of derived relationships involving evm metadata entities
# timeSeries relationships (optional)
... Stored or derived relationships involving time series entities
# volume relationships (optional)
... Stored or derived relationships involving volume entities
}
"""
# TODO global state entitiy: counters and averages
type GlobalState @entity {
"internal id used for indexation"
id: ID!
counters: EntityCounter!
accounts: EntityCounter!
balances: EntityCounter!
erc20tokens: EntityCounter!
erc20transactions: EntityCounter!
nfts: EntityCounter!
nftContracts: EntityCounter!
nftTransactions: EntityCounter!
sales: EntityCounter!
orders: EntityCounter!
blocks: EntityCounter!
transactions: EntityCounter!
minuteVolumes: EntityCounter!
hourVolumes: EntityCounter!
dayVolumes: EntityCounter!
weekVolumes: EntityCounter!
minutes: EntityCounter!
hours: EntityCounter!
days: EntityCounter!
weeks: EntityCounter!
}
type EntityCounter @entity {
"internal id used for indexation"
id: ID!
# stored values
"the name of the entity it's being counted"
name: String
"amount of entities"
amount: BigInt!
}
# "an Account as nft and erc20 holder, buyer, and seller"
type Account @entity {
"internal id used for indexation"
id: ID!
# stored values
"account's address"
address: Bytes
"evm metada transaction where this account was created"
createdAt: Transaction!
"evm metada transaction where this account was updated"
lastUpdatedAt: Transaction!
# derived relationships
"balances in this account scop"
balances: [Balance!]! @derivedFrom(field: "account")
"erc20 deposits"
incomingErc20Transactions: [Erc20Transaction!]! @derivedFrom(field: "to")
"erc20 transfers"
outgoingErc20Transactions: [Erc20Transaction!]! @derivedFrom(field: "from")
"owned nfts"
nfts: [Nft!]! @derivedFrom(field:"owner")
"revcieved"
incomingNftTransactions: [NftTransaction!]! @derivedFrom(field: "to")
"sent nfts"
outgoingNftTransactions: [NftTransaction!]! @derivedFrom(field: "from")
"orders that were made by this account"
makerOrders: [Order!]! @derivedFrom(field: "maker")
"orders that were taken by this account"
takerOrders: [Order!]! @derivedFrom(field: "taker")
}
# "a Balance as a many to many relationship between erc20 tokens and accounts"
type Balance @entity {
"internal id used for indexation"
id: ID!
# stored values
"token's amount"
amount: BigInt!
# stored relationships
"balance's owner"
account: Account!
"related token"
token: Erc20Token!
# derived relationships
"erc20Transactions that increased this balance"
increasingTransactions: [Erc20Transaction!]! @derivedFrom(field: "increasedBalance")
"erc20Transactions that decreased this balance"
decreasingTransactions: [Erc20Transaction!]! @derivedFrom(field: "decreasedBalance")
}
interface SmartContract {
"internal id used for indexation"
id: ID!
# stored values
"asset contract's address"
address: Bytes
# derived relationships
"related transactions"
tokenTransactions: [SmartContractTransaction!]!
"all the orders where this asset was traded"
orders: [Order!]!
# volume relationships
"related list of minuteVolume entities for each contract"
minuteVolumes: [MinuteVolume!]!
"related list of hourVolume entities for each contract"
hourVolumes: [HourVolume!]!
"related list of dayVolume entities for each contract"
dayVolumes: [DayVolume!]!
"related list of dayVolume entities for each contract"
weekVolumes: [WeekVolume!]!
}
# "an Erc20Token as payment token for a sale"
type Erc20Token implements SmartContract @entity {
"internal id used for indexation"
id: ID!
# stored values
"asset contract's address"
address: Bytes
# derived relationships
"related balances"
balances: [Balance!]! @derivedFrom(field: "token")
"related transactions"
tokenTransactions: [SmartContractTransaction!]! @derivedFrom(field: "contract")
"related sales"
sales: [Sale!]! @derivedFrom(field: "token")
"all the orders where this token was used to pay"
orders: [Order!]! @derivedFrom(field: "paymentToken")
# volume relationships
"related list of minuteVolume entities for each nft contract in which this token was paymentToken"
minuteVolumes: [MinuteVolume!]! @derivedFrom(field: "contract")
"related list of hourVolume entities for each nft contract in which this token was paymentToken"
hourVolumes: [HourVolume!]! @derivedFrom(field: "contract")
"related list of dayVolume entities for each nft contract in which this token was paymentToken"
dayVolumes: [DayVolume!]! @derivedFrom(field: "contract")
"related list of dayVolume entities for each nft contract in which this token was paymentToken"
weekVolumes: [WeekVolume!]! @derivedFrom(field: "contract")
}
interface SmartContractTransaction {
"Internal ID used for indexation"
id: ID!
# stored values
"event timestamp"
timestamp: BigInt!
# stored relationships
"Account sending the value"
from: Account!
"Account receiving the value"
to: Account!
"related SmartContract"
contract: SmartContract!
"related sale"
sale: Sale!
# metadata relationships
"related block"
block: Block!
"related transaction"
transaction: Transaction!
# time series relationships
"related minute entity"
minute: Minute!
"related hour entity"
hour: Hour!
"related day entity"
day: Day!
"related week entity"
week: Week!
# volume relationships
"related minuteVolume entity"
minuteVolume: MinuteVolume!
"related hourVolume entity"
hourVolume: HourVolume!
"related dayVolume entity"
dayVolume: DayVolume!
"related weekVolume entity"
weekVolume: WeekVolume!
}
# "A transaction of a erc20Token as payment for a sale"
type Erc20Transaction implements SmartContractTransaction @entity{
"Internal ID used for indexation"
id: ID!
# stored values
"event timestamp"
timestamp: BigInt!
"amount of the transaction"
amount: BigInt!
# stored relationships
"Account sending the value"
from: Account!
"Account receiving the value"
to: Account!
"related SmartContract, a Erc20Token entity in this case"
contract: SmartContract!
"Balance entity that increased it funds"
increasedBalance: Balance!
"Balance entity that decreaced it funds"
decreasedBalance: Balance!
"related sale"
sale: Sale!
# metadata relationships
"related block"
block: Block!
"related transaction"
transaction: Transaction!
# time series relationships
"related minute entity"
minute: Minute!
"related hour entity"
hour: Hour!
"related day entity"
day: Day!
"related week entity"
week: Week!
# volume relationships
"related minuteVolume entity"
minuteVolume: MinuteVolume!
"related hourVolume entity"
hourVolume: HourVolume!
"related dayVolume entity"
dayVolume: DayVolume!
"related weekVolume entity"
weekVolume: WeekVolume!
}
type Nft @entity {
"internal id used for indexation"
id: ID!
# stored values
"token's id inside the token"
tokenId: BigInt
# stored relationships
"related nft contract"
contract: NftContract!
"Account which owns an asset"
owner: Account!
# derived relationships
"related transactions"
nftTransactions: [NftTransaction!]! @derivedFrom(field: "nft")
# TODO "related sales"
# sales: [Sale!]! @derivedFrom(field: "nft")
}
type NftContract implements SmartContract @entity {
"internal id used for indexation"
id: ID!
# stored values
"asset contract's address"
address: Bytes
# derived relationships
"related transactions"
tokenTransactions: [SmartContractTransaction!]! @derivedFrom(field: "contract")
# TODO related sales
# sales: [Sale!]! @derivedFrom(field: "contract")
"all the orders where this asset was traded"
orders: [Order!]! @derivedFrom(field: "target")
# nfts contained in this contract
nfts: [Nft!]! @derivedFrom(field: "contract")
# volume relationships
"related list of minuteVolume entities for each erc20Token that paid for an NFT from this contract"
minuteVolumes: [MinuteVolume!]! @derivedFrom(field: "contract")
"related list of hourVolume entities for each erc20Token that paid for an NFT from this contract"
hourVolumes: [HourVolume!]! @derivedFrom(field: "contract")
"related list of dayVolume entities for each erc20Token that paid for an NFT from this contract"
dayVolumes: [DayVolume!]! @derivedFrom(field: "contract")
"related list of dayVolume entities for each erc20Token that paid for an NFT from this contract"
weekVolumes: [WeekVolume!]! @derivedFrom(field: "contract")
}
type NftTransaction implements SmartContractTransaction @entity {
"Internal ID used for indexation"
id: ID!
# stored values
"event timestamp"
timestamp: BigInt!
# stored relationships
"Account sending the value"
from: Account!
"Account receiving the value"
to: Account!
"related SmartContract, a NftContract entity in this case"
contract: SmartContract!
"related token"
nft: Nft!
"related sale"
sale: Sale!
# metadata relationships
"related evm block"
block: Block!
"related evm transaction"
transaction: Transaction!
# time series relationships
"related minute entity"
minute: Minute!
"related hour entity"
hour: Hour!
"related day entity"
day: Day!
"related week entity"
week: Week!
# volume relationships
"related minuteVolume entity"
minuteVolume: MinuteVolume!
"related hourVolume entity"
hourVolume: HourVolume!
"related dayVolume entity"
dayVolume: DayVolume!
"related weekVolume entity"
weekVolume: WeekVolume!
}
# "A Sale is the relationship between matched orders"
type Sale @entity {
"internal id used for indexation"
id: ID!
# stored relationships
"payment token for this sale"
token: Erc20Token
# derived relationships
"Nft transfers made for this sell"
nftTransactions: [NftTransaction!]! @derivedFrom(field:"sale")
"the payment for this sale"
erc20Transaction: Erc20Transaction @derivedFrom(field:"sale")
"Orders that made this Sale, must be a 2 entries array, one Buy Order and one Sell Order"
orders: [Order!]! @derivedFrom(field: "sale")
# metadata relationships
"related evm block"
block: Block!
"related evm transaction"
transaction: Transaction!
# time series relationships
"related minute entity"
minute: Minute!
"related hour entity"
hour: Hour!
"related day entity"
day: Day!
"related week entity"
week: Week!
# volume relationships
"related minuteVolume entity"
minuteVolume: MinuteVolume!
"related hourVolume entity"
hourVolume: HourVolume!
"related dayVolume entity"
dayVolume: DayVolume!
"related weekVolume entity"
weekVolume: WeekVolume!
}
# enum ContractOrderYieldStatus {
# NONE
# PART_ONE
# PART_TWO
# }
# enum OrderStatus {
# NONE
# OPEN
# FILLED
# }
enum FeeMethod {
ProtocolFee
SplitFee
}
enum Side {
Buy
Sell
}
enum SaleKind {
FixedPrice
DutchAuction
}
enum HowToCall {
Call
DelegateCall
}
type Order @entity {
"internal id used for indexation"
id: ID!
# stored values
# "current data yield status as thrown by contract"
# yieldStatus: ContractOrderYieldStatus!
# status: OrderStatus!
"hased order content"
hash: Bytes
"Current contract exchange (fixed to 0x7be8076f4ea4a4ad08075c2508e481d6c946d12b, opensea wyvern address)"
exchange: Bytes
"maker fee for relayer"
makerRelayerFee: BigInt
"maker fee for protocol"
makerProtocolFee: BigInt
"taker fee for relayer"
takerRelayerFee: BigInt
"taker fee for protocol"
takerProtocolFee: BigInt
"Order fee recipient or zero address for taker order."
feeRecipient: Account
"Fee method (protocolfee or split fee)"
feeMethod: FeeMethod
"side: Is it buy or sell"
side: Side
"salkind: is it FixedPrice or DutchAuction"
saleKind: SaleKind
"Base price of the order (in paymentTokens). "
basePrice: BigInt
"Auction extra parameter - minimum bid increment for English auctions, starting/ending price difference. "
extra: BigInt
"Listing start timestamp"
listingTime: BigInt
"Expiration timestamp - 0 for no expiry"
expirationTIme: BigInt
"Order salt, used to prevent duplicate hashes."
salt: BigInt
"Should be included in order book"
orderbookInclusionDesired: Boolean
"was this order canceled"
cancelled: Boolean
"Which kind of call enum"
howToCall: HowToCall
"additionl order call data"
callData: Bytes
"Calldata replacement pattern, or an empty byte array for no replacement."
replacementPattern: Bytes
"Static call target, zero-address for no static call."
staticTarget: Bytes
"Static call extra data"
staticExtradata: Bytes
"NFT contract address"
target: NftContract!
# stored relationships
"the Sale where this order was involved"
sale: Sale!
"Account who made this order"
maker: Account
"Account who took this order"
taker: Account
"Erc20Token used to pay for the order, or the zero-address as a sentinel value for Ether."
paymentToken: Erc20Token!
# nftTransactions: [NftTransaction!]! @derivedFrom(field: "order")
# "related transaction if closed"
# erc20Transaction: Erc20Transaction @derivedFrom(field: "order")
# metadata relationships
"related block"
block: Block!
"related transaction"
transaction: Transaction!
# time series relationships
"related minute entity"
minute: Minute!
"related hour entity"
hour: Hour!
"related day entity"
day: Day!
"related week entity"
week: Week!
# time series relationships
"related minuteVolume entity"
minuteVolume: MinuteVolume!
"related hourVolume entity"
hourVolume: HourVolume!
"related dayVolume entity"
dayVolume: DayVolume!
"related weekVolume entity"
weekVolume: WeekVolume!
}
##
# events and metadata entities
##
interface Metadata {
"Internal ID used for indexation"
id: ID!
}
type Block implements Metadata @entity {
"Internal ID used for indexation"
id: ID!
"event timestamp"
timestamp: BigInt!
"Block's number"
number: BigInt!
"Chain transactions info"
transactions: [Transaction!] @derivedFrom(field: "block")
"Orders created on this block"
orders: [Order!] @derivedFrom(field: "block")
"related minute entity"
minute: Minute
"related hour entity"
hour: Hour
"related day entity"
day: Day
"related week entity"
week: Week
}
type Transaction implements Metadata @entity {
"Internal ID used for indexation"
id: ID!
"Transaction's Block"
block: Block!
"Transaction's hash"
hash: Bytes
"Sender Address"
from: Bytes
"Transaction's gas price"
gasPrice: BigInt
"Order created on this Transaction"
order: Order
# time series relationships
"related minute entity"
minute: Minute
"related hour entity"
hour: Hour
"related day entity"
day: Day
"related week entity"
week: Week
}
##
# Volumes
##
"""
A volume entity relates to
- one time serie entity
- one erc20Token
- one nftContract
- Many erc20tx
- Many nftTx
"""
# TODO add derived list to sales
interface Volume {
"internal id used for indexation"
id: ID! # Set to `timeUnitName-${smartContract.id}-${epoch}`
# stored values
"amount of some contract's token traded for this nft contract in a given time frame"
amount: BigInt!
"amount of transactions for this contract"
transactionAmount: BigInt!
# stored relationships
"related smartContract"
contract: SmartContract!
"related time serie entitiy, ej dailyVolume for x day is related to x dayCandle"
timeUnit: TimeUnit!
# derived relationships
"a list of smart Contract Transactions"
smartContractTransactions: [SmartContractTransaction!]!
}
type MinuteVolume implements Volume @entity {
"internal id used for indexation"
id: ID! # Set to `timeUnitName-${smartContract.id}-${epoch}`
# stored values
"amount of some contract's token traded for this nft contract in a given time frame"
amount: BigInt!
"amount of transactions for this contract"
transactionAmount: BigInt!
# stored relationships
"related smartContract"
contract: SmartContract!
"related time serie entitiy, ej dailyVolume for x day is related to x dayCandle"
timeUnit: TimeUnit!
# derived relationships
"a list of smart Contract Transactions"
smartContractTransactions: [SmartContractTransaction!]! @derivedFrom(field: "minuteVolume")
}
type HourVolume implements Volume @entity {
"internal id used for indexation"
id: ID! # Set to `timeUnitName-${smartContract.id}-${epoch}`
# stored values
"amount of some contract's token traded for this nft contract in a given time frame"
amount: BigInt!
"amount of transactions for this contract"
transactionAmount: BigInt!
# stored relationships
"related smartContract"
contract: SmartContract!
"related time serie entitiy, ej dailyVolume for x day is related to x dayCandle"
timeUnit: TimeUnit!
# derived relationships
"a list of smart Contract Transactions"
smartContractTransactions: [SmartContractTransaction!]! @derivedFrom(field:"hourVolume")
}
type DayVolume implements Volume @entity {
"internal id used for indexation"
id: ID! # Set to `timeUnitName-${smartContract.id}-${epoch}`
# stored values
"amount of some contract's token traded for this nft contract in a given time frame"
amount: BigInt!
"amount of transactions for this contract"
transactionAmount: BigInt!
# stored relationships
"related smartContract"
contract: SmartContract!
"related time serie entitiy, ej dailyVolume for x day is related to x dayCandle"
timeUnit: TimeUnit!
# derived relationships
"a list of smart Contract Transactions"
smartContractTransactions: [SmartContractTransaction!]! @derivedFrom(field:"dayVolume")
}
type WeekVolume implements Volume @entity {
"internal id used for indexation"
id: ID! # Set to `timeUnitName-${smartContract.id}-${epoch}`
# stored values
"amount of some contract's token traded for this nft contract in a given time frame"
amount: BigInt!
"amount of transactions for this contract"
transactionAmount: BigInt!
# stored relationships
"related smartContract"
contract: SmartContract!
"related time serie entitiy, ej dailyVolume for x day is related to x dayCandle"
timeUnit: TimeUnit!
# derived relationships
"a list of smart Contract Transactions"
smartContractTransactions: [SmartContractTransaction!]! @derivedFrom(field:"weekVolume")
}
##
# Time series
##
interface TimeUnit {
"internal id used for indexation"
id: ID!
"timestamp division of the starting point"
epoch: BigInt!
"orders filled at this time candle"
orders: [Order!]!
"blocks signed at this thime candle"
blocks: [Block!]
"transactions created at this thime candle"
transactions: [Transaction!]!
"related volume entity"
volume: Volume!
}
type Minute implements TimeUnit @entity {
"internal id used for indexation"
id: ID!
"timestamp division of the starting point"
epoch: BigInt!
"orders filled at this time candle"
orders: [Order!]! @derivedFrom(field: "minute")
"blocks signed at this thime candle"
blocks: [Block!] @derivedFrom(field: "minute")
"transactions created at this thime candle"
transactions: [Transaction!]! @derivedFrom(field: "minute")
"related volume entity"