Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / indexer

indexer

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

Type Aliases

Type AliasDescription
FetchAuthorDataOptionsThe options for fetchAuthorData()
FetchAutocompleteOptionsThe options for fetchAutocomplete()
FetchChannelOptionsThe options for fetchChannel()
FetchChannelsOptionsThe options for fetchChannels()
FetchCommentOptions-
FetchCommentRepliesOptionsThe options for fetchCommentReplies()
FetchCommentsOptionsThe options for fetchComments()
IndexerAPIAuthorDataSchemaType-
IndexerAPIAuthorEnsDataSchemaType-
IndexerAPIAutocompleteENSSchemaType-
IndexerAPIAutocompleteERC20SchemaType-
IndexerAPIAutocompleteFarcasterSchemaType-
IndexerAPIAutocompleteSchemaType-
IndexerAPIChannelOutputSchemaType-
IndexerAPIChannelSchemaType-
IndexerAPICommentListModeSchemaType-
IndexerAPICommentModerationStatusSchemaType-
IndexerAPICommentOutputSchemaType-
IndexerAPICommentReferenceENSSchemaType-
IndexerAPICommentReferenceERC20SchemaType-
IndexerAPICommentReferenceFarcasterSchemaType-
IndexerAPICommentReferenceSchemaType-
IndexerAPICommentReferencesSchemaType-
IndexerAPICommentReferenceURLFileSchemaType-
IndexerAPICommentReferenceURLImageSchemaType-
IndexerAPICommentReferenceURLVideoSchemaType-
IndexerAPICommentReferenceURLWebPageSchemaType-
IndexerAPICommentSchemaType-
IndexerAPICommentWithRepliesOutputSchemaType-
IndexerAPICommentWithRepliesSchemaType-
IndexerAPICommentZeroExSwapSchemaType-
IndexerAPICursorPaginationSchemaType-
IndexerAPIExtraSchemaType-
IndexerAPIFarcasterDataSchemaType-
IndexerAPIGetAutocompleteOutputSchemaType-
IndexerAPIListChannelsOutputSchemaType-
IndexerAPIListChannelsSchemaType-
IndexerAPIListCommentRepliesOutputSchemaType-
IndexerAPIListCommentRepliesSchemaType-
IndexerAPIListCommentsOutputSchemaType-
IndexerAPIListCommentsSchemaType-
IndexerAPIMetadataEntrySchemaType-
IndexerAPIMetadataSchemaType-
IndexerAPIModerationChangeModerationStatusOnCommentOutputSchemaType-
IndexerAPIModerationChangeModerationStatusOnCommentSchemaType-
IndexerAPIModerationClassificationLabelSchemaType-
IndexerAPIModerationGetPendingCommentsOutputSchemaType-
IndexerAPIModerationGetPendingCommentsSchemaType-
IndexerAPIPaginationSchemaType-
IndexerAPIReportOutputSchemaType-
IndexerAPIReportSchemaType-
IndexerAPIReportsListPendingOutputSchemaType-
IndexerAPIReportsListPendingSchemaType-
IndexerAPISortSchemaType-
IsMutedOptionsThe options for isMuted()
ReportCommentOptionsThe options for reportComment()

Variables

VariableDescription
IndexerAPIAuthorDataSchema-
IndexerAPIAuthorEnsDataSchema-
IndexerAPIAutocompleteENSSchema-
IndexerAPIAutocompleteERC20Schema-
IndexerAPIAutocompleteFarcasterSchema-
IndexerAPIAutocompleteSchema-
IndexerAPIChannelOutputSchema-
IndexerAPIChannelSchema-
IndexerAPICommentListModeSchema-
IndexerAPICommentModerationStatusSchema-
IndexerAPICommentOutputSchema-
IndexerAPICommentReactionOutputSchema-
IndexerAPICommentReactionSchema-
IndexerAPICommentReferenceENSSchema-
IndexerAPICommentReferenceERC20Schema-
IndexerAPICommentReferenceFarcasterSchema-
IndexerAPICommentReferencePositionSchema-
IndexerAPICommentReferenceSchema-
IndexerAPICommentReferencesSchema-
IndexerAPICommentReferenceURLFileSchema-
IndexerAPICommentReferenceURLImageSchema-
IndexerAPICommentReferenceURLVideoSchema-
IndexerAPICommentReferenceURLWebPageSchema-
IndexerAPICommentSchema-
IndexerAPICommentWithRepliesOutputSchema-
IndexerAPICommentWithRepliesSchema-
IndexerAPICommentZeroExSwapSchema-
IndexerAPICursorPaginationSchema-
IndexerAPIExtraSchema-
IndexerAPIFarcasterDataSchema-
IndexerAPIGetAutocompleteOutputSchema-
IndexerAPIListChannelsOutputSchema-
IndexerAPIListChannelsSchema-
IndexerAPIListCommentRepliesOutputSchema-
IndexerAPIListCommentRepliesSchema-
IndexerAPIListCommentsOutputSchema-
IndexerAPIListCommentsSchema-
IndexerAPIMetadataEntrySchema-
IndexerAPIMetadataSchema-
IndexerAPIModerationChangeModerationStatusOnCommentOutputSchema-
IndexerAPIModerationChangeModerationStatusOnCommentSchema-
IndexerAPIModerationClassificationLabelSchema-
IndexerAPIModerationGetPendingCommentsOutputSchema-
IndexerAPIModerationGetPendingCommentsSchema-
IndexerAPIPaginationSchema-
IndexerAPIReportOutputSchema-
IndexerAPIReportSchema-
IndexerAPIReportsListPendingOutputSchema-
IndexerAPIReportsListPendingSchema-
IndexerAPIReportStatusSchema-
IndexerAPISortSchema-
IndexerAPIZeroExSwapPossibleEmptyAddressSchema-
IndexerAPIZeroExSwapPossiblyEmptyTokenAmountSchema-
IndexerAPIZeroExTokenAmountSchema-

Functions

FunctionDescription
convertIndexerMetadataToRecordConverts IndexerAPI MetadataEntry array to Record format for easier manipulation
convertRecordToIndexerMetadataConverts Record format metadata to IndexerAPI MetadataEntry array format
fetchAuthorDataFetch author data from the Indexer API
fetchAutocompleteFetch autocomplete suggestions from the Indexer API
fetchChannelFetch a single channel by ID from the Indexer API
fetchChannelsFetch channels from the Indexer API
fetchCommentFetch one single comment from the Indexer API
fetchCommentRepliesFetch replies for a comment from the Indexer API
fetchCommentsFetch comments from the Indexer API
getChannelCursorGet the cursor for a channel
getCommentCursorGet the cursor for a comment
getReportsCursorGet the cursor for a report
isMutedChecks if an address is marked as a muted on the indexer of your choice.
reportCommentReport a comment to the Indexer API

References

convertContractToRecordFormat

Re-exports convertContractToRecordFormat


convertRecordToContractFormat

Re-exports convertRecordToContractFormat


createKeyTypeMap

Re-exports createKeyTypeMap


MetadataRecord

Re-exports MetadataRecord


MetadataType

Re-exports MetadataType


parseMetadataFromContract

Re-exports parseMetadataFromContract


prepareMetadataForContract

Re-exports prepareMetadataForContract