indexer

Ethereum Comments Protocol SDK Indexer Functionality for indexing and querying comments data

Classes

Class	Description
ResponseError	An error thrown when a response from the indexer is not successful.

Type Aliases

Type Alias	Description
FetchAuthorDataOptions	The options for `fetchAuthorData()`
FetchAutocompleteOptions	The options for `fetchAutocomplete()`
FetchChannelOptions	The options for `fetchChannel()`
FetchChannelsOptions	The options for `fetchChannels()`
FetchCommentOptions	-
FetchCommentRepliesOptions	The options for `fetchCommentReplies()`
FetchCommentsOptions	The options for `fetchComments()`
FetchGroupedNotificationsOptions	The options for `fetchGroupedNotifications()`
FetchNotificationsOptions	The options for `fetchNotifications()`
IndexerAPIAuthorDataSchemaType	-
IndexerAPIAuthorEnsDataSchemaType	-
IndexerAPIAutocompleteENSSchemaType	-
IndexerAPIAutocompleteERC20SchemaType	-
IndexerAPIAutocompleteFarcasterSchemaType	-
IndexerAPIAutocompleteSchemaType	-
IndexerAPIChannelOutputSchemaType	-
IndexerAPIChannelSchemaType	-
IndexerAPICommentListModeSchemaType	-
IndexerAPICommentModerationStatusSchemaType	-
IndexerAPICommentOutputSchemaType	-
IndexerAPICommentReactionSchemaType	-
IndexerAPICommentReferenceENSSchemaType	-
IndexerAPICommentReferenceERC20SchemaType	-
IndexerAPICommentReferenceFarcasterSchemaType	-
IndexerAPICommentReferenceQuotedCommentSchemaType	Handles caip373 quoted comment
IndexerAPICommentReferenceSchemaType	-
IndexerAPICommentReferencesSchemaInputType	-
IndexerAPICommentReferencesSchemaType	-
IndexerAPICommentReferenceURLFileSchemaType	-
IndexerAPICommentReferenceURLImageSchemaType	-
IndexerAPICommentReferenceURLVideoSchemaType	-
IndexerAPICommentReferenceURLWebPageSchemaType	-
IndexerAPICommentSchemaType	-
IndexerAPICommentWithRepliesOutputSchemaType	-
IndexerAPICommentWithRepliesSchemaType	-
IndexerAPICommentZeroExSwapSchemaType	-
IndexerAPICursorPaginationSchemaType	-
IndexerAPIExtraSchemaType	-
IndexerAPIFarcasterDataSchemaType	-
IndexerAPIGetAutocompleteOutputSchemaType	-
IndexerAPIListChannelsOutputSchemaType	-
IndexerAPIListChannelsSchemaType	-
IndexerAPIListCommentRepliesOutputSchemaType	-
~~IndexerAPIListCommentRepliesSchemaType~~	-
IndexerAPIListCommentsOutputSchemaType	-
IndexerAPIListCommentsSchemaType	-
IndexerAPIListGroupedNotificationsSchemaType	The list grouped notifications schema returned by fetchGroupedNotifications()
IndexerAPIListNotificationsSchemaType	The list notifications schema returned by fetchNotifications()
IndexerAPIMarkNotificationsAsSeenSchemaType	-
IndexerAPIMetadataEntrySchemaType	-
IndexerAPIMetadataSchemaType	-
IndexerAPIModerationChangeModerationStatusOnCommentOutputSchemaType	-
IndexerAPIModerationChangeModerationStatusOnCommentSchemaType	-
IndexerAPIModerationClassificationLabelSchemaType	-
IndexerAPIModerationGetPendingCommentsOutputSchemaType	-
IndexerAPIModerationGetPendingCommentsSchemaType	-
IndexerAPINotificationMentionSchemaType	-
IndexerAPINotificationQuoteSchemaType	-
IndexerAPINotificationReactionSchemaType	-
IndexerAPINotificationReplySchemaType	-
IndexerAPINotificationSchemaType	The notification schema
IndexerAPINotificationTypeSchemaType	-
IndexerAPIPaginationSchemaType	-
IndexerAPIReportOutputSchemaType	-
IndexerAPIReportSchemaType	-
IndexerAPIReportsListPendingOutputSchemaType	-
IndexerAPIReportsListPendingSchemaType	-
IndexerAPISortSchemaType	-
IsMutedOptions	The options for `isMuted()`
MarkNotificationsAsSeenOptions	-
ReportCommentOptions	The options for `reportComment()`

Variables

Variable	Description
IndexerAPIAuthorDataSchema	-
IndexerAPIAuthorEnsDataSchema	-
IndexerAPIAutocompleteENSSchema	-
IndexerAPIAutocompleteERC20Schema	-
IndexerAPIAutocompleteFarcasterSchema	-
IndexerAPIAutocompleteSchema	-
IndexerAPIChannelOutputSchema	-
IndexerAPIChannelSchema	-
IndexerAPICommentListModeSchema	-
IndexerAPICommentModerationStatusSchema	-
IndexerAPICommentOutputSchema	-
IndexerAPICommentReactionOutputSchema	-
IndexerAPICommentReactionSchema	-
IndexerAPICommentReferenceENSSchema	-
IndexerAPICommentReferenceERC20Schema	-
IndexerAPICommentReferenceFarcasterSchema	-
IndexerAPICommentReferencePositionSchema	-
IndexerAPICommentReferenceQuotedCommentSchema	Handles caip373 quoted comment
IndexerAPICommentReferenceSchema	-
IndexerAPICommentReferencesSchema	-
IndexerAPICommentReferenceURLFileSchema	-
IndexerAPICommentReferenceURLImageSchema	-
IndexerAPICommentReferenceURLVideoSchema	-
IndexerAPICommentReferenceURLWebPageSchema	-
IndexerAPICommentSchema	-
IndexerAPICommentWithRepliesOutputSchema	-
IndexerAPICommentWithRepliesSchema	-
IndexerAPICommentZeroExSwapSchema	-
IndexerAPICursorPaginationSchema	-
IndexerAPICursorRepliesPaginationSchema	-
IndexerAPIExtraSchema	-
IndexerAPIFarcasterDataSchema	-
IndexerAPIGetAutocompleteOutputSchema	-
IndexerAPIListChannelsOutputSchema	-
IndexerAPIListChannelsSchema	-
IndexerAPIListCommentRepliesOutputSchema	-
~~IndexerAPIListCommentRepliesSchema~~	-
IndexerAPIListCommentsOutputSchema	-
IndexerAPIListCommentsSchema	-
IndexerAPIListGroupedNotificationsSchema	The list grouped notifications schema returned by fetchGroupedNotifications()
IndexerAPIListNotificationsSchema	The list notifications schema returned by fetchNotifications()
IndexerAPIMarkNotificationsAsSeenSchema	-
IndexerAPIMetadataEntrySchema	-
IndexerAPIMetadataSchema	-
IndexerAPIModerationChangeModerationStatusOnCommentOutputSchema	-
IndexerAPIModerationChangeModerationStatusOnCommentSchema	-
IndexerAPIModerationClassificationLabelSchema	-
IndexerAPIModerationGetPendingCommentsOutputSchema	-
IndexerAPIModerationGetPendingCommentsSchema	-
IndexerAPINotificationBaseSchema	-
IndexerAPINotificationMentionSchema	-
IndexerAPINotificationQuoteSchema	-
IndexerAPINotificationReactionSchema	-
IndexerAPINotificationReplySchema	-
IndexerAPINotificationSchema	The notification schema
IndexerAPINotificationTypeSchema	-
IndexerAPIPaginationSchema	-
IndexerAPIReportOutputSchema	-
IndexerAPIReportSchema	-
IndexerAPIReportsListPendingOutputSchema	-
IndexerAPIReportsListPendingSchema	-
IndexerAPIReportStatusSchema	-
IndexerAPISortSchema	-
IndexerAPIZeroExSwapPossibleEmptyAddressSchema	-
IndexerAPIZeroExSwapPossiblyEmptyTokenAmountSchema	-
IndexerAPIZeroExTokenAmountSchema	-

Functions

Function	Description
convertIndexerMetadataToRecord	Converts IndexerAPI MetadataEntry array to Record format for easier manipulation
convertRecordToIndexerMetadata	Converts Record format metadata to IndexerAPI MetadataEntry array format
fetchAuthorData	Fetch author data from the Indexer API
fetchAutocomplete	Fetch autocomplete suggestions from the Indexer API
fetchChannel	Fetch a single channel by ID from the Indexer API
fetchChannels	Fetch channels from the Indexer API
fetchComment	Fetch one single comment from the Indexer API
fetchCommentReplies	Fetch replies for a comment from the Indexer API
fetchComments	Fetch comments from the Indexer API
fetchGroupedNotifications	Fetch grouped notifications from the Indexer API
fetchNotifications	Fetch notifications from the Indexer API
getChannelCursor	Get the cursor for a channel
getCommentCursor	Get the cursor for a comment
getReportsCursor	Get the cursor for a report
indexerApiRetryCondition	Determine if a fetch error from the indexer API should be retried
isMuted	Checks if an address is marked as muted on the indexer of your choice.
isRetryableHttpResponse	Check if a response is retryable
markNotificationsAsSeen	Mark notifications as seen
reportComment	Report a comment to the Indexer API

References

Classes

Type Aliases

Variables

Functions

References

convertContractToRecordFormat

convertRecordToContractFormat

createKeyTypeMap

MetadataRecord

MetadataType

parseMetadataFromContract

prepareMetadataForContract