-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschema.graphql
4658 lines (3632 loc) · 106 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
type Query {
invitesLeft: Int!
alreadyInvited(request: AlreadyInvitedCheckRequest!): Boolean!
invited: [InvitedResult!]!
rel(request: RelRequest!): Void
cur(request: CurRequest!): [String!]!
gdm(request: GdmRequest!): [Url!]!
gct(request: GctRequest!): [String!]!
iss(request: PriRequest!): PrfResponse!
intotal(request: InTotalRequest!): Int!
challenge(request: ChallengeRequest!): AuthChallengeResult!
verify(request: VerifyRequest!): Boolean!
txIdToTxHash(txId: TxId!): TxHash!
claimableHandles: ClaimableHandles!
claimableStatus: ClaimStatus!
isIDKitPhoneVerified: Boolean!
dataAvailabilitySubmitters: DataAvailabilitySubmittersResult!
dataAvailabilitySummary: DataAvailabilitySummaryResult!
dataAvailabilityTransactions(
request: DataAvailabilityTransactionsRequest
): DataAvailabilityTransactionsResult!
dataAvailabilityTransaction(
request: DataAvailabilityTransactionRequest!
): DataAvailabilityTransactionUnion
explorePublications(
request: ExplorePublicationRequest!
): ExplorePublicationResult!
exploreProfiles(request: ExploreProfilesRequest!): ExploreProfileResult!
feed(request: FeedRequest!): PaginatedFeedResult!
feedHighlights(request: FeedHighlightsRequest!): PaginatedTimelineResult!
pendingApprovalFollows(
request: PendingApprovalFollowsRequest!
): PendingApproveFollowsResult!
doesFollow(request: DoesFollowRequest!): [DoesFollowResponse!]!
following(request: FollowingRequest!): PaginatedFollowingResult!
followers(request: FollowersRequest!): PaginatedFollowersResult!
followerNftOwnedTokenIds(
request: FollowerNftOwnedTokenIdsRequest!
): FollowerNftOwnedTokenIds
mutualFollowersProfiles(
request: MutualFollowersProfilesQueryRequest!
): PaginatedProfileResult!
ping: String!
hasTxHashBeenIndexed(
request: HasTxHashBeenIndexedRequest!
): TransactionResult!
internalPin(request: InternalPinRequest!): [InternalPinResult!]!
enabledModuleCurrencies: [Erc20!]!
approvedModuleAllowanceAmount(
request: ApprovedModuleAllowanceAmountRequest!
): [ApprovedAllowanceAmount!]!
generateModuleCurrencyApprovalData(
request: GenerateModuleCurrencyApprovalDataRequest!
): GenerateModuleCurrencyApproval!
profileFollowModuleBeenRedeemed(
request: ProfileFollowModuleBeenRedeemedRequest!
): Boolean!
enabledModules: EnabledModules!
unknownEnabledModules: EnabledModules!
# Get all NFT galleries for a profile
nftGalleries(request: NftGalleriesRequest!): [NftGallery!]!
# Get the NFTs that the given wallet or profileId owns. Only supports Ethereum and Polygon NFTs. Note excludeFollowers is set to true by default, so the result will not include Lens Follower NFTs unless explicitly requested.
nfts(request: NFTsRequest!): NFTsResult!
# Search for NFTs in a wallet by collection name. Supports Polygon and Ethereum and searches in both by default.
searchNfts(request: NFTSearchRequest!): NFTsResult!
nftOwnershipChallenge(
request: NftOwnershipChallengeRequest!
): NftOwnershipChallengeResult!
notifications(request: NotificationRequest!): PaginatedNotificationResult!
profileOnChainIdentity(
request: ProfileOnChainIdentityRequest!
): [OnChainIdentity!]!
# Get the list of profile interests
profileInterests: [ProfileInterest!]!
profiles(request: ProfileQueryRequest!): PaginatedProfileResult!
profile(request: SingleProfileQueryRequest!): Profile
recommendedProfiles(options: RecommendedProfileOptions): [Profile!]!
defaultProfile(request: DefaultProfileRequest!): Profile
profileGuardianInformation(
request: ProfileGuardianRequest!
): ProfileGuardianResult!
globalProtocolStats(request: GlobalProtocolStatsRequest): GlobalProtocolStats!
proxyActionStatus(
proxyActionId: ProxyActionId!
): ProxyActionStatusResultUnion!
validatePublicationMetadata(
request: ValidatePublicationMetadataRequest!
): PublicationValidateMetadataResult!
publicationMetadataStatus(
request: GetPublicationMetadataStatusRequest!
): PublicationMetadataStatus!
publications(request: PublicationsQueryRequest!): PaginatedPublicationResult!
publication(request: PublicationQueryRequest!): Publication
whoCollectedPublication(
request: WhoCollectedPublicationRequest!
): PaginatedWhoCollectedResult!
profilePublicationsForSale(
request: ProfilePublicationsForSaleRequest!
): PaginatedProfilePublicationsForSaleResult!
allPublicationsTags(
request: AllPublicationsTagsRequest!
): PaginatedAllPublicationsTagsResult!
publicationsProfileBookmarks(
request: PublicationsProfileBookmarkedQueryRequest!
): PaginatedPublicationResult!
# Get publications recommended for you - will only return posts for now
forYou(request: PublicationForYouRequest!): PaginatedForYouResult!
whoReactedPublication(
request: WhoReactedPublicationRequest!
): PaginatedWhoReactedResult!
relayQueues: [RelayQueueResult!]!
profilePublicationRevenue(
request: ProfilePublicationRevenueQueryRequest!
): ProfilePublicationRevenueResult!
publicationRevenue(
request: PublicationRevenueQueryRequest!
): PublicationRevenue
profileFollowRevenue(
request: ProfileFollowRevenueQueryRequest!
): FollowRevenueResult!
search(request: SearchQueryRequest!): SearchResult!
userSigNonces: UserSigNonces!
}
input AlreadyInvitedCheckRequest {
address: EthereumAddress!
}
# Ethereum address custom scalar type
scalar EthereumAddress
type InvitedResult {
address: EthereumAddress!
when: DateTime
}
# The javascript `Date` as string. Type represents date and time as the ISO Date string.
scalar DateTime
# Represents NULL values
scalar Void
input RelRequest {
secret: String!
ethereumAddress: EthereumAddress!
}
input CurRequest {
secret: String!
}
# Url scalar type
scalar Url
input GdmRequest {
secret: String!
}
input GctRequest {
secret: String!
hhh: String!
}
type PrfResponse {
ss: Boolean!
dd: Boolean!
}
input PriRequest {
secret: String!
hhh: String!
}
input InTotalRequest {
secret: String!
ethereumAddress: EthereumAddress!
}
# The auth challenge result
type AuthChallengeResult {
# The text to sign
text: String!
}
# The challenge request
input ChallengeRequest {
# The ethereum address you want to login with
address: EthereumAddress!
}
# The access request
input VerifyRequest {
# The access token
accessToken: Jwt!
}
# jwt custom scalar type
scalar Jwt
# The tx hash
scalar TxHash
# The tx id
scalar TxId
type ClaimableHandles {
reservedHandles: [ReservedClaimableHandle!]!
canClaimFreeTextHandle: Boolean!
}
type ReservedClaimableHandle {
id: HandleClaimIdScalar!
handle: Handle!
source: String!
expiry: DateTime!
}
# handle claim id custom scalar type
scalar HandleClaimIdScalar
# handle custom scalar type
scalar Handle
# The claim status
enum ClaimStatus {
ALREADY_CLAIMED
CLAIM_FAILED
NOT_CLAIMED
}
# The paginated submitter results
type DataAvailabilitySubmittersResult {
items: [DataAvailabilitySubmitterResult!]!
pageInfo: PaginatedResultInfo!
}
type DataAvailabilitySubmitterResult {
address: EthereumAddress!
name: String!
totalTransactions: Int!
}
# The paginated result info
type PaginatedResultInfo {
# Cursor to query the actual results
prev: Cursor
# Cursor to query next results
next: Cursor
# The total number of entities the pagination iterates over. If its null then its not been worked out due to it being an expensive query and not really needed for the client. All main counters are in counter tables to allow them to be faster fetching.
totalCount: Int
@deprecated(
reason: "Total counts is expensive and in dynamic nature of queries it slows stuff down. Most the time you do not need this you can just use the `next` property to see if there is more data. This will be removed soon. The only use case anyone is using this right now is on notification query, this should be changed to query the notifications and cache the last notification id. You can then keep checking if the id changes you know more notifications."
)
}
# Cursor custom scalar type
scalar Cursor
type DataAvailabilitySummaryResult {
totalTransactions: Int!
}
type DataAvailabilityTransactionsResult {
items: [DataAvailabilityTransactionUnion!]!
pageInfo: PaginatedResultInfo!
}
union DataAvailabilityTransactionUnion =
DataAvailabilityPost
| DataAvailabilityComment
| DataAvailabilityMirror
type DataAvailabilityPost {
transactionId: String!
submitter: EthereumAddress!
createdAt: DateTime!
appId: Sources
verificationStatus: DataAvailabilityVerificationStatusUnion!
profile: Profile!
publicationId: InternalPublicationId!
}
# Sources custom scalar type
scalar Sources
union DataAvailabilityVerificationStatusUnion =
DataAvailabilityVerificationStatusSuccess
| DataAvailabilityVerificationStatusFailure
type DataAvailabilityVerificationStatusSuccess {
verified: Boolean!
}
type DataAvailabilityVerificationStatusFailure {
status: MomokaValidatorError
}
# The momka validator error
enum MomokaValidatorError {
NO_SIGNATURE_SUBMITTER
INVALID_SIGNATURE_SUBMITTER
TIMESTAMP_PROOF_INVALID_SIGNATURE
TIMESTAMP_PROOF_INVALID_TYPE
TIMESTAMP_PROOF_INVALID_DA_ID
TIMESTAMP_PROOF_NOT_SUBMITTER
CAN_NOT_CONNECT_TO_BUNDLR
INVALID_TX_ID
INVALID_FORMATTED_TYPED_DATA
BLOCK_CANT_BE_READ_FROM_NODE
DATA_CANT_BE_READ_FROM_NODE
SIMULATION_NODE_COULD_NOT_RUN
SIMULATION_FAILED
EVENT_MISMATCH
INVALID_EVENT_TIMESTAMP
INVALID_TYPED_DATA_DEADLINE_TIMESTAMP
GENERATED_PUBLICATION_ID_MISMATCH
INVALID_POINTER_SET_NOT_NEEDED
POINTER_FAILED_VERIFICATION
NOT_CLOSEST_BLOCK
BLOCK_TOO_FAR
PUBLICATION_NO_POINTER
PUBLICATION_NONE_DA
PUBLICATION_NONCE_INVALID
PUBLICATION_SIGNER_NOT_ALLOWED
CHAIN_SIGNATURE_ALREADY_USED
POTENTIAL_REORG
UNKNOWN
}
# The Profile
type Profile {
# The profile id
id: ProfileId!
# Name of the profile
name: String
# Bio of the profile
bio: String
# Follow nft address
followNftAddress: ContractAddress
# Metadata url
metadata: Url
# The profile handle
handle: Handle!
# The picture for the profile
picture: ProfileMedia
# The cover picture for the profile
coverPicture: ProfileMedia
# Who owns the profile
ownedBy: EthereumAddress!
# The dispatcher
dispatcher: Dispatcher
# Profile stats
stats: ProfileStats!
# The follow module
followModule: FollowModule
# Is the profile default
isDefault: Boolean!
# Optionals param to add extra attributes on the metadata
attributes: [Attribute!]
# The on chain identity
onChainIdentity: OnChainIdentity!
# The profile interests
interests: [ProfileInterest!]
isFollowedByMe(isFinalisedOnChain: Boolean): Boolean!
isFollowing(who: ProfileId): Boolean!
invitedBy: Profile
}
# ProfileId custom scalar type
scalar ProfileId
# Contract address custom scalar type
scalar ContractAddress
union ProfileMedia = NftImage | MediaSet
# The NFT image
type NftImage {
# The contract address
contractAddress: ContractAddress!
# The token id of the nft
tokenId: String!
# The token image nft
uri: Url!
# The token image nft
chainId: Int!
# If the NFT is verified
verified: Boolean!
}
# The Media Set
type MediaSet {
# Original media as found on the publication metadata
onChain: Media!
# On-chain or snapshotted media on a CDN
original: Media!
# Optimized media, snapshotted and served from a CDN
optimized: Media
# Small media - will always be null on the public API
small: Media
@deprecated(
reason: "should not be used will always be null - use transform function to get small media"
)
# Medium media - will always be null on the public API
medium: Media
@deprecated(
reason: "should not be used will always be null - use transform function to get small media"
)
transformed(params: MediaTransformParams!): Media
}
# The Media url
type Media {
# The token image nft
url: Url!
# Width - will always be null on the public API
width: Int
# Height - will always be null on the public API
height: Int
# Size - will always be null on the public API
size: Int
# The image/audio/video mime type for the publication
mimeType: MimeType
# The alt tags for accessibility
altTag: String
# The cover for any video or audio you attached
cover: Url
}
# mimetype custom scalar type
scalar MimeType
input MediaTransformParams {
# Set the transformed image's width. You can use specific size in pixels eg. 100px, a percentage eg. 50% or set as 'auto' to be set automatically. Default value is 'auto'.
width: ImageSizeTransform = "auto"
# Set the transformed image's height. You can use specific size in pixels eg. 100px, a percentage eg. 50% or set as 'auto' to be set automatically. Default value is 'auto'.
height: ImageSizeTransform = "auto"
# Set if you want to keep the image's original aspect ratio. True by default. If explicitly set to false, the image will stretch based on the width and height values.
keepAspectRatio: Boolean = true
}
# image size transform custom scalar type
scalar ImageSizeTransform
# The dispatcher
type Dispatcher {
# The dispatcher address
address: EthereumAddress!
# If the dispatcher can use the relay
canUseRelay: Boolean!
# If the dispatcher transactions will be sponsored by lens aka cover the gas costs
sponsor: Boolean!
}
# The Profile Stats
type ProfileStats {
id: ProfileId!
# Total follower count
totalFollowers: Int!
# Total following count (remember the wallet follows not profile so will be same for every profile they own)
totalFollowing: Int!
# Total post count
totalPosts: Int!
# Total comment count
totalComments: Int!
# Total mirror count
totalMirrors: Int!
# Total publication count
totalPublications: Int!
# Total collects count
totalCollects: Int!
commentsTotal(forSources: [Sources!]!): Int!
postsTotal(forSources: [Sources!]!): Int!
mirrorsTotal(forSources: [Sources!]!): Int!
publicationsTotal(forSources: [Sources!]!): Int!
}
union FollowModule =
FeeFollowModuleSettings
| ProfileFollowModuleSettings
| RevertFollowModuleSettings
| UnknownFollowModuleSettings
type FeeFollowModuleSettings {
# The follow modules enum
type: FollowModules!
contractAddress: ContractAddress!
# The collect module amount info
amount: ModuleFeeAmount!
# The collect module recipient address
recipient: EthereumAddress!
}
# The follow module types
enum FollowModules {
FeeFollowModule
RevertFollowModule
ProfileFollowModule
UnknownFollowModule
}
type ModuleFeeAmount {
# The erc20 token info
asset: Erc20!
# Floating point number as string (e.g. 42.009837). It could have the entire precision of the Asset or be truncated to the last significant decimal.
value: String!
}
# The erc20 type
type Erc20 {
# Name of the symbol
name: String!
# Symbol for the token
symbol: String!
# Decimal places for the token
decimals: Int!
# The erc20 address
address: ContractAddress!
}
type ProfileFollowModuleSettings {
# The follow module enum
type: FollowModules!
contractAddress: ContractAddress!
}
type RevertFollowModuleSettings {
# The follow module enum
type: FollowModules!
contractAddress: ContractAddress!
}
type UnknownFollowModuleSettings {
# The follow modules enum
type: FollowModules!
contractAddress: ContractAddress!
# The data used to setup the module which you can decode with your known ABI
followModuleReturnData: FollowModuleData!
}
# follow module data scalar type
scalar FollowModuleData
# The Profile
type Attribute {
# The display type
displayType: String
# The trait type - can be anything its the name it will render so include spaces
traitType: String
# identifier of this attribute, we will update by this id
key: String!
# Value attribute
value: String!
}
type OnChainIdentity {
# The POH status
proofOfHumanity: Boolean!
# The ens information
ens: EnsOnChainIdentity
# The sybil dot org information
sybilDotOrg: SybilDotOrgIdentity!
# The worldcoin identity
worldcoin: WorldcoinIdentity!
}
type EnsOnChainIdentity {
# The default ens mapped to this address
name: Ens
}
# Ens custom scalar type
scalar Ens
type SybilDotOrgIdentity {
# The sybil dot org status
verified: Boolean!
source: SybilDotOrgIdentitySource!
}
type SybilDotOrgIdentitySource {
twitter: SybilDotOrgTwitterIdentity!
}
type SybilDotOrgTwitterIdentity {
handle: String
}
type WorldcoinIdentity {
# If the profile has verified as a user
isHuman: Boolean!
}
# ProfileInterest custom scalar type
scalar ProfileInterest
# Internal publication id custom scalar type
scalar InternalPublicationId
type DataAvailabilityComment {
transactionId: String!
submitter: EthereumAddress!
createdAt: DateTime!
appId: Sources
verificationStatus: DataAvailabilityVerificationStatusUnion!
profile: Profile!
publicationId: InternalPublicationId!
commentedOnProfile: Profile!
commentedOnPublicationId: InternalPublicationId!
}
type DataAvailabilityMirror {
transactionId: String!
submitter: EthereumAddress!
createdAt: DateTime!
appId: Sources
verificationStatus: DataAvailabilityVerificationStatusUnion!
profile: Profile!
publicationId: InternalPublicationId!
mirrorOfProfile: Profile!
mirrorOfPublicationId: InternalPublicationId!
}
input DataAvailabilityTransactionsRequest {
limit: LimitScalar
cursor: Cursor
profileId: ProfileId
}
# limit custom scalar type
scalar LimitScalar
input DataAvailabilityTransactionRequest {
# The DA transaction id or internal publiation id
id: String!
}
# The paginated publication result
type ExplorePublicationResult {
items: [Publication!]!
pageInfo: PaginatedResultInfo!
}
union Publication = Post | Comment | Mirror
# The social post
type Post {
# The internal publication id
id: InternalPublicationId!
# The profile ref
profile: Profile!
# The publication stats
stats: PublicationStats!
# The metadata for the post
metadata: MetadataOutput!
# The on chain content uri could be `ipfs://` or `https`
onChainContentURI: String!
# The date the post was created on
createdAt: DateTime!
# The collect module
collectModule: CollectModule!
# The reference module
referenceModule: ReferenceModule
# ID of the source
appId: Sources
# If the publication has been hidden if it has then the content and media is not available
hidden: Boolean!
# The contract address for the collect nft.. if its null it means nobody collected yet as it lazy deployed
collectNftAddress: ContractAddress
# Indicates if the publication is gated behind some access criteria
isGated: Boolean!
# Indicates if the publication is data availability post
isDataAvailability: Boolean!
# The data availability proofs you can fetch from
dataAvailabilityProofs: String
# Who collected it, this is used for timeline results and like this for better caching for the client
collectedBy: Wallet
@deprecated(
reason: "use `feed` query, timeline query will be killed on the 15th November. This includes this field."
)
reaction(request: ReactionFieldResolverRequest): ReactionTypes
notInterested(by: ProfileId): Boolean!
bookmarked(by: ProfileId): Boolean!
hasCollectedByMe(isFinalisedOnChain: Boolean): Boolean!
canComment(profileId: ProfileId): CanCommentResponse!
canMirror(profileId: ProfileId): CanMirrorResponse!
canDecrypt(
profileId: ProfileId
address: EthereumAddress
): CanDecryptResponse!
mirrors(by: ProfileId): [InternalPublicationId!]!
}
# The publication stats
type PublicationStats {
# The publication id
id: InternalPublicationId!
# The total amount of mirrors
totalAmountOfMirrors: Int!
# The total amount of collects
totalAmountOfCollects: Int!
# The total amount of comments
totalAmountOfComments: Int!
# The total amount of downvotes
totalUpvotes: Int!
# The total amount of upvotes
totalDownvotes: Int!
# The total amount of bookmarks
totalBookmarks: Int!
commentsTotal(
# The apps to filter on
forSources: [Sources!] = []
# The custom filters
customFilters: [CustomFiltersTypes!] = []
): Int!
}
# The custom filters types
enum CustomFiltersTypes {
GARDENERS
}
# The metadata output
type MetadataOutput {
# The metadata name
name: String
# This is the metadata description
description: Markdown
# This is the metadata content for the publication, should be markdown
content: Markdown
# This is the image attached to the metadata and the property used to show the NFT!
image: Url
# The image cover for video/music publications
cover: MediaSet
# The images/audios/videos for the publication
media: [MediaSet!]!
# The attributes
attributes: [MetadataAttributeOutput!]!
# The locale of the publication,
locale: Locale
# The tags for the publication
tags: [String!]!
# The content warning for the publication
contentWarning: PublicationContentWarning
# The main focus of the publication
mainContentFocus: PublicationMainFocus!
# The main focus of the publication
animatedUrl: Url
# The publication's encryption params in case it's encrypted
encryptionParams: EncryptionParamsOutput
}
# Markdown scalar type
scalar Markdown
# The metadata attribute output
type MetadataAttributeOutput {
# The display type
displayType: PublicationMetadataDisplayTypes
# The trait type - can be anything its the name it will render so include spaces
traitType: String
# The value
value: String
}
# The publication metadata display types
enum PublicationMetadataDisplayTypes {
number
string
date
}
# Locale scalar type
scalar Locale
# The publication content warning
enum PublicationContentWarning {
NSFW
SENSITIVE
SPOILER
}
# The publication main focus
enum PublicationMainFocus {
VIDEO
IMAGE
ARTICLE
TEXT_ONLY
AUDIO
LINK
EMBED
}
# The metadata encryption params
type EncryptionParamsOutput {
# The provider-specific encryption params
providerSpecificParams: ProviderSpecificParamsOutput!
# The encryption provider
encryptionProvider: EncryptionProvider!
# The access conditions
accessCondition: AccessConditionOutput!
# The encrypted fields
encryptedFields: EncryptedFieldsOutput!
}
# The provider-specific encryption params
type ProviderSpecificParamsOutput {
# The encryption key
encryptionKey: ContentEncryptionKey!
}
# ContentEncryptionKey scalar type
scalar ContentEncryptionKey
# The gated publication encryption provider
enum EncryptionProvider {
LIT_PROTOCOL
}
# The access conditions for the publication
type AccessConditionOutput {
# NFT ownership condition
nft: NftOwnershipOutput
# ERC20 token ownership condition
token: Erc20OwnershipOutput
# EOA ownership condition
eoa: EoaOwnershipOutput
# Profile ownership condition
profile: ProfileOwnershipOutput
# Profile follow condition
follow: FollowConditionOutput
# Profile follow condition
collect: CollectConditionOutput
# AND condition
and: AndConditionOutput
# OR condition
or: OrConditionOutput
}
type NftOwnershipOutput {
# The NFT collection's ethereum address
contractAddress: ContractAddress!
# The NFT chain id
chainID: ChainId!
# The unlocker contract type
contractType: ContractType!
# The optional token ID(s) to check for ownership
tokenIds: [TokenId!]
}
# ChainId custom scalar type
scalar ChainId
# The gated publication access criteria contract types
enum ContractType {
ERC721
ERC1155
ERC20
}
# The NFT token id
scalar TokenId
type Erc20OwnershipOutput {
# The ERC20 token ethereum address
contractAddress: ContractAddress!
# The amount of tokens required to access the content
chainID: ChainId!
# The amount of tokens required to access the content
amount: String!
# The amount of decimals of the ERC20 contract
decimals: Float!
# The operator to use when comparing the amount of tokens
condition: ScalarOperator!
# The name of the ERC20 token
name: String!
# The symbol of the ERC20 token
symbol: String!
}
# The gated publication access criteria scalar operators
enum ScalarOperator {
EQUAL
NOT_EQUAL
GREATER_THAN
GREATER_THAN_OR_EQUAL