forked from planetarium/NineChronicles.Bridge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.graphql
2804 lines (2200 loc) · 60.7 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
schema {
query: StandaloneQuery
mutation: StandaloneMutation
subscription: StandaloneSubscription
}
type StandaloneQuery {
stateQuery(
# Offset block hash for query.
hash: ByteString
): StateQuery!
state(
# The hash of the block used to fetch state from chain.
hash: ByteString
# The address of account to fetch from the chain.
accountAddress: Address!
# The address of state to fetch from the account.
address: Address!
): ByteString
transferNCGHistories(
blockHash: ByteString!
recipient: Address
): [TransferNCGHistoryType!]!
keyStore: KeyStoreType
@deprecated(
reason: "Use `planet key` command instead. https://www.npmjs.com/package/@planetarium/cli"
)
nodeStatus: NodeStatusType!
chainQuery: ExplorerQuery! @deprecated(reason: "Use /graphql/explorer")
# The validation method provider for Libplanet types.
validation: ValidationQuery!
# Check if the provided address is activated.
activationStatus: ActivationStatusQuery!
@deprecated(reason: "Since NCIP-15, it doesn't care account activation.")
# Get the peer's block chain state
peerChainState: PeerChainStateQuery!
goldBalance(
# Target address to query
address: Address!
# Offset block hash for query.
hash: ByteString
): String!
nextTxNonce(
# Target address to query
address: Address!
): Long!
@deprecated(
reason: "The root query is not the best place for nextTxNonce so it was moved. Use transaction.nextTxNonce()"
)
getTx(
# transaction id.
txId: TxId!
): TransactionType
@deprecated(
reason: "The root query is not the best place for getTx so it was moved. Use transaction.getTx()"
)
# Address of current node.
minerAddress: Address
# Get monster collection status by address.
monsterCollectionStatus(
# agent address.
address: Address
): MonsterCollectionStatusType
# Query for transaction.
transaction: TransactionHeadlessQuery!
activated(invitationCode: String!): Boolean!
@deprecated(reason: "Since NCIP-15, it doesn't care account activation.")
activationKeyNonce(invitationCode: String!): String!
@deprecated(reason: "Since NCIP-15, it doesn't care account activation.")
# Query for rpc mode information.
rpcInformation: RpcInformationQuery!
# Query to create action transaction.
actionQuery: ActionQuery!
actionTxQuery(
# The hexadecimal string of public key for Transaction.
publicKey: String!
# The nonce for Transaction.
nonce: Long
# The time this transaction is created.
timestamp: DateTimeOffset
maxGasPrice: FungibleAssetValueInputType = {
quantity: 1000000000000000000
ticker: "Mead"
decimalPlaces: 18
minters: null
}
): ActionTxQuery!
# Query to get derived address.
addressQuery: AddressQuery!
}
type StateQuery {
# State for avatar.
avatar(
# Address of avatar.
avatarAddress: Address!
): AvatarStateType
# Avatar states having some order as addresses
avatars(
# Addresses of avatars to query.
addresses: [Address!]!
): [AvatarStateType]!
# State for avatar EXP record.
rankingMap(
# RankingMapState index. 0 ~ 99
index: Int!
): RankingMapStateType
# State for shop.
shop: ShopStateType
@deprecated(
reason: "Shop is migrated to ShardedShop and not using now. Use shardedShop() instead."
)
# State for sharded shop.
shardedShop(
# ItemSubType for shard. see from https://github.com/planetarium/lib9c/blob/main/Lib9c/Model/Item/ItemType.cs#L13
itemSubType: ItemSubType!
# Nonce for shard. It's not considered if itemSubtype is kind of costume or title. 0 ~ 15
nonce: Int!
): ShardedShopStateV2Type
# State for weekly arena.
weeklyArena(
# WeeklyArenaState index. It increases every 56,000 blocks.
index: Int!
): WeeklyArenaStateType
# List of arena information of requested arena and avatar list
arenaInformation(
# Championship ID to get arena information
championshipId: Int!
# Round of championship to get arena information
round: Int!
# List of avatar address to get arena information
avatarAddresses: [Address!]!
): [ArenaInformationType!]!
# State for agent.
agent(
# Address of agent.
address: Address!
): AgentStateType
# State for staking.
stakeState(
# Address of agent who staked.
address: Address!
): StakeStateType
# Staking states having same order as addresses
stakeStates(
# Addresses of agent who staked.
addresses: [Address]!
): [StakeStateType]!
# State for monster collection.
monsterCollectionState(
# Address of agent.
agentAddress: Address!
): MonsterCollectionStateType
monsterCollectionSheet: MonsterCollectionSheetType
# The latest stake rewards based on StakePolicySheet.
latestStakeRewards: StakeRewardsType
stakeRewards: StakeRewardsType
@deprecated(
reason: "Since stake3, claim_stake_reward9 actions, each stakers have their own contracts."
)
crystalMonsterCollectionMultiplierSheet: CrystalMonsterCollectionMultiplierSheetType
# List of unlocked equipment recipe sheet row ids.
unlockedRecipeIds(
# Address of avatar.
avatarAddress: Address!
): [Int]
# List of unlocked world sheet row ids.
unlockedWorldIds(
# Address of avatar.
avatarAddress: Address!
): [Int]
# world boss season user information.
raiderState(
# address of world boss season.
raiderAddress: Address!
): RaiderStateType
# world boss season id by block index.
raidId(
blockIndex: Long!
# find previous raid id.
prev: Boolean = false
): Int!
# world boss season boss information.
worldBossState(bossAddress: Address!): WorldBossStateType
# user boss kill reward record by world boss season.
worldBossKillRewardRecord(
worldBossKillRewardRecordAddress: Address!
): WorldBossKillRewardRecordType
# asset balance by currency.
balance(
address: Address!
currency: CurrencyInput!
): FungibleAssetValueWithCurrencyType!
# raider address list by world boss season.
raiderList(raiderListAddress: Address!): [Address!]
orderDigestList(avatarAddress: Address!): OrderDigestListStateType
pledge(agentAddress: Address!): MeadPledgeType!
# Get balances and fungible items in garages.
# Use either `currencyEnums` or `currencyTickers` to get balances.
garages(
# Agent address to get balances and fungible items in garages
agentAddr: Address!
# List of currency enums to get balances in garages
currencyEnums: [CurrencyEnum!]
# List of currency tickers to get balances in garages
currencyTickers: [String!]
# List of fungible item IDs to get fungible item in garages
fungibleItemIds: [String!]
): GaragesType
arenaParticipants(
avatarAddress: Address!
filterBounds: Boolean! = true
): [ArenaParticipantType]!
cachedSheet(tableName: String!): String
}
type AvatarStateType {
# Address of avatar.
address: Address!
# Block index at the latest executed action.
blockIndex: Int!
# Character ID from CharacterSheet.
characterId: Int!
# Block index at the DailyReward execution.
dailyRewardReceivedIndex: Long!
# Address of agent.
agentAddress: Address!
# The index of this avatar state among its agent's avatar addresses.
index: Int!
# Block index at the latest executed action.
updatedAt: Long!
# Avatar name.
name: String!
# Avatar total EXP.
exp: Int!
# Avatar Level.
level: Int!
# Current ActionPoint.
actionPoint: Int!
# Index of ear color.
ear: Int!
# Index of hair color.
hair: Int!
# Index of eye color.
lens: Int!
# Index of tail color.
tail: Int!
# Avatar inventory.
inventory: InventoryType!
# Avatar inventory address.
inventoryAddress: Address!
# Rune list of avatar
runes: [RuneStateType!]!
# Address list of combination slot.
combinationSlotAddresses: [Address!]!
# Combination slots.
combinationSlots: [CombinationSlotStateType!]!
# List of acquired item ID.
itemMap: CollectionMapType!
# List of quest event ID.
eventMap: CollectionMapType!
# List of defeated monster ID.
monsterMap: CollectionMapType!
# List of cleared stage ID.
stageMap: CollectionMapType!
# List of quest.
questList: QuestListType!
# List of mail.
mailBox: MailBoxType!
# World & Stage information.
worldInformation: WorldInformationType!
}
scalar Address
scalar Long
type InventoryType {
# List of Consumables.
consumables: [ConsumableType!]!
# List of Materials.
materials: [MaterialType!]!
# List of Equipments.
equipments(
# filter equipped inventory item
equipped: Boolean
# An item subtype for fetching only equipment where its subtype is the same. If it wasn't given, you'll get all equipment without relationship to the subtype.
itemSubType: ItemSubType
# ItemIds for fetching only equipment where itemId (Guid) is in the given argument.
itemIds: [Guid!]
# Ids for fetching only equipment where id (number) is in the given argument.
ids: [Int!]
): [EquipmentType!]!
# List of Costumes.
costumes: [CostumeType!]!
# List of Inventory Item.
items(
# An Id to find Inventory Item
inventoryItemId: Int
# filter locked Inventory Item
locked: Boolean
): [InventoryItemType!]!
}
type ConsumableType {
# Grade from ItemSheet.
grade: Int!
# ID from ItemSheet.
id: Int!
# Item category.
itemType: ItemType!
# Item subcategory.
itemSubType: ItemSubType!
# Item elemental.
elementalType: ElementalType!
requiredBlockIndex: Long
itemId: Guid!
mainStat: StatType!
}
enum ItemType {
CONSUMABLE
COSTUME
EQUIPMENT
MATERIAL
}
enum ItemSubType {
FOOD
FULL_COSTUME
HAIR_COSTUME
EAR_COSTUME
EYE_COSTUME
TAIL_COSTUME
WEAPON
ARMOR
BELT
NECKLACE
RING
EQUIPMENT_MATERIAL
FOOD_MATERIAL
MONSTER_PART
NORMAL_MATERIAL
HOURGLASS
AP_STONE
CHEST
@deprecated(
reason: "ItemSubType.Chest has never been used outside the MaterialItemSheet. And we won't use it in the future until we have a specific reason."
)
TITLE
AURA
}
enum ElementalType {
NORMAL
FIRE
WATER
LAND
WIND
}
scalar Guid
enum StatType {
NONE
HP
ATK
DEF
CRI
HIT
SPD
DRV
DRR
CDMG
ARMOR_PENETRATION
THORN
}
type MaterialType {
# Grade from ItemSheet.
grade: Int!
# ID from ItemSheet.
id: Int!
# Item category.
itemType: ItemType!
# Item subcategory.
itemSubType: ItemSubType!
# Item elemental.
elementalType: ElementalType!
requiredBlockIndex: Long
itemId: ByteString!
}
scalar ByteString
type EquipmentType {
# Grade from ItemSheet.
grade: Int!
# ID from ItemSheet.
id: Int!
# Item category.
itemType: ItemType!
# Item subcategory.
itemSubType: ItemSubType!
# Item elemental.
elementalType: ElementalType!
requiredBlockIndex: Long
setId: Int!
stat: DecimalStatType!
equipped: Boolean!
itemId: Guid!
level: Int!
exp: Int!
skills: [SkillType]
buffSkills: [SkillType]
statsMap: StatsMapType!
}
type DecimalStatType {
statType: StatType!
baseValue: Decimal!
additionalValue: Decimal!
totalValue: Decimal!
}
scalar Decimal
type SkillType {
id: Int!
elementalType: ElementalType!
power: Int!
chance: Int!
statPowerRatio: Int!
referencedStatType: StatType!
}
type StatsMapType {
hP: Int!
aTK: Int!
dEF: Int!
cRI: Int!
hIT: Int!
sPD: Int!
}
type CostumeType {
# Grade from ItemSheet.
grade: Int!
# ID from ItemSheet.
id: Int!
# Item category.
itemType: ItemType!
# Item subcategory.
itemSubType: ItemSubType!
# Item elemental.
elementalType: ElementalType!
requiredBlockIndex: Long
# Guid of costume.
itemId: Guid!
# Status of Avatar equipped.
equipped: Boolean!
}
type InventoryItemType {
# A count of item
count: Int!
# An Id of item
id: Int!
# An ItemType of item
itemType: ItemType!
locked: Boolean!
lockId: Guid
tradableId: Guid
fungibleItemId: String
}
type RuneStateType {
# ID of rune.
runeId: Int!
# Level of this rune.
level: Int!
}
type CombinationSlotStateType {
# Address of combination slot.
address: Address!
# Block index at the combination slot can be usable.
unlockBlockIndex: Long!
# Stage id at the combination slot unlock.
unlockStage: Int!
# Block index at the combination started.
startBlockIndex: Long!
# Pet id used in equipment
petId: Int
}
type CollectionMapType {
count: Int!
pairs: [[Int]!]!
}
type QuestListType {
completedQuestIds: [Int!]!
}
type MailBoxType {
count: Int!
mails: [MailType!]!
}
type MailType {
id: Guid!
requiredBlockIndex: Long!
blockIndex: Long!
}
type WorldInformationType {
isStageCleared(stageId: Int!): Boolean!
isWorldUnlocked(worldId: Int!): Boolean!
world(worldId: Int!): WorldType!
}
type WorldType {
id: Int!
name: String!
isUnlocked: Boolean!
isStageCleared: Boolean!
unlockedBlockIndex: Long!
stageClearedBlockIndex: Long!
stageBegin: Int!
stageEnd: Int!
stageClearedId: Int!
}
type RankingMapStateType {
# Address of RankingMapState.
address: Address!
# RankingMapState Capacity.
capacity: Int!
# List of RankingInfo.
rankingInfos: [RankingInfoType!]!
}
type RankingInfoType {
# Avatar total EXP.
exp: Long!
# Avatar Level.
level: Int!
# Equipped Armor ID from EquipmentItemSheet.
armorId: Int!
# Block index at RankingInfo update.
updatedAt: Long!
# Block index at Latest stage cleared.
stageClearedBlockIndex: Long!
# Address of agent.
agentAddress: Address!
# Address of avatar.
avatarAddress: Address!
# Avatar name.
avatarName: String!
}
type ShopStateType {
# Address of shop.
address: Address!
# List of ShopItem.
products(
# Filter for item id.
id: Int
# Filter for ItemSubType. see from https://github.com/planetarium/lib9c/blob/main/Lib9c/Model/Item/ItemType.cs#L13
itemSubType: ItemSubType
# Filter for item maximum price.
maximumPrice: Int
): [ShopItemType]!
}
type ShopItemType {
# Address of seller agent.
sellerAgentAddress: Address!
# Address of seller avatar.
sellerAvatarAddress: Address!
# Guid of product registered.
productId: Guid!
# Item price.
price: String!
# Equipment / Consumable information.
itemUsable: ItemUsableType
# Costume information.
costume: CostumeType
}
type ItemUsableType {
# Grade from ItemSheet.
grade: Int!
# ID from ItemSheet.
id: Int!
# Item category.
itemType: ItemType!
# Item subcategory.
itemSubType: ItemSubType!
# Item elemental.
elementalType: ElementalType!
requiredBlockIndex: Long
# Guid of item.
itemId: Guid!
}
type ShardedShopStateV2Type {
# Address of sharded shop.
address: Address!
# List of OrderDigest.
orderDigestList(
# Filter for item id.
id: Int
# Filter for item maximum price.
maximumPrice: Int
): [OrderDigestType]!
}
type OrderDigestType {
# Guid of order.
orderId: Guid!
# Tradable guid of order.
tradableId: Guid!
# Block index order started.
startedBlockIndex: Int!
# Block index order expired.
expiredBlockIndex: Int!
# Address of seller agent.
sellerAgentAddress: Address!
# Order price.
price: String!
combatPoint: Int!
level: Int!
# Id of item.
itemId: Int!
# Count of item.
itemCount: Int!
}
type WeeklyArenaStateType {
address: Address!
ended: Boolean!
orderedArenaInfos: [ArenaInfoType]!
}
type ArenaInfoType {
agentAddress: Address!
avatarAddress: Address!
avatarName: String!
arenaRecord: ArenaRecordType!
active: Boolean!
dailyChallengeCount: Int!
score: Int!
}
type ArenaRecordType {
win: Int
lose: Int
draw: Int
}
type ArenaInformationType {
avatarAddress: Address!
address: Address!
win: Int!
lose: Int!
ticket: Int!
ticketResetCount: Int!
purchasedTicketCount: Int!
score: Int!
}
type AgentStateType {
# Address of agent.
address: Address!
# List of avatar.
avatarStates: [AvatarStateType!]
# Current NCG.
gold: String!
# Monster collection round of agent.
monsterCollectionRound: Long!
# Current monster collection level.
monsterCollectionLevel: Long!
hasTradedItem: Boolean!
# Current CRYSTAL.
crystal: String!
# mead pledge information.
pledge: MeadPledgeType!
}
type MeadPledgeType {
patronAddress: Address
approved: Boolean!
mead: Int!
}
type StakeStateType {
# The address of current state.
address: Address!
# The staked amount.
deposit: String!
# The block index the user started to stake.
startedBlockIndex: Long!
# The block index the user received rewards.
receivedBlockIndex: Long!
# The block index the user can cancel the staking.
cancellableBlockIndex: Long!
# The block index the user can claim rewards.
claimableBlockIndex: Long!
# The staking achievements.
achievements: StakeAchievementsType
@deprecated(reason: "Since StakeStateV2, the achievement became removed.")
stakeRewards: StakeRewardsType!
}
type StakeAchievementsType {
# The address of current state.
achievementsByLevel(level: Int!): Int!
}
type StakeRewardsType {
orderedList: [StakeRegularRewardsType!]!
}
type StakeRegularRewardsType {
level: Int!
requiredGold: Long!
rewards: [StakeRegularRewardInfoType!]!
bonusRewards: [StakeRegularFixedRewardInfoType!]!
}
type StakeRegularRewardInfoType {
itemId: Int!
rate: Int!
type: StakeRewardType!
currencyTicker: String
currencyDecimalPlaces: Int
decimalRate: Decimal!
}
enum StakeRewardType {
ITEM
RUNE
CURRENCY
}
type StakeRegularFixedRewardInfoType {
itemId: Int!
count: Int!
}
type MonsterCollectionStateType {
address: Address!
level: Long!
expiredBlockIndex: Long!
startedBlockIndex: Long!
receivedBlockIndex: Long!
rewardLevel: Long!
claimableBlockIndex: Long!
}
type MonsterCollectionSheetType {
orderedList: [MonsterCollectionRowType]
}
type MonsterCollectionRowType {
level: Int!
requiredGold: Int!
rewards: [MonsterCollectionRewardInfoType]!
}
type MonsterCollectionRewardInfoType {
itemId: Int!
quantity: Int!
}
type CrystalMonsterCollectionMultiplierSheetType {
orderedList: [CrystalMonsterCollectionMultiplierRowType!]!
}
type CrystalMonsterCollectionMultiplierRowType {
level: Int!
multiplier: Int!
}
type RaiderStateType {
# season total score.
totalScore: Int!
# season high score.
highScore: Int!
# season total challenge count.
totalChallengeCount: Int!
# remain challenge count before refill.
remainChallengeCount: Int!
# latest reward claimed season rank.
latestRewardRank: Int!
# challenge ticket purchase count.
purchaseCount: Int!
# combat point of avatar state.
cp: Int!
# level of avatar state.
level: Int!
# icon id for ranking portrait.
iconId: Int!
# latest challenge boss level.
latestBossLevel: Int!
# rank reward claimed block index.
claimedBlockIndex: Long!
# ticket refilled block index.
refillBlockIndex: Long!
# address of avatar state.
avatarAddress: Address!
# name of avatar state.
avatarName: String!
}
type WorldBossStateType {
# world boss season id.
id: Int!
# world boss current level.
level: Int!
# world boss current hp.
currentHp: BigInt!
# world boss season started block index.
startedBlockIndex: Long!
# world boss season ended block index.
endedBlockIndex: Long!
}
scalar BigInt
type WorldBossKillRewardRecordType {
map: [WorldBossKillRewardRecordMapType!]!
}
type WorldBossKillRewardRecordMapType {
bossLevel: Int!
# check reward already claimed. if already claimed return true.