@ecp.eth/sdk

@ecp.eth/sdk / indexer / FetchCommentsOptions

type FetchCommentsOptions = {
  apiUrl?: string;
  app?: Hex;
  author?: Hex;
  chainId: number | number[];
  channelId?: bigint;
  commentType?: number;
  cursor?: Hex;
  excludeByModerationLabels?: IndexerAPIModerationClassificationLabelSchemaType[];
  limit?: number;
  mode?: IndexerAPICommentListModeSchemaType;
  moderationScore?: number;
  moderationStatus?:   | IndexerAPICommentModerationStatusSchemaType
     | IndexerAPICommentModerationStatusSchemaType[];
  retries?: number;
  signal?: AbortSignal;
  sort?: IndexerAPISortSchemaType;
  targetUri?: string;
  viewer?: Hex;
};

Defined in: packages/sdk/src/indexer/api.ts:140

The options for fetchComments()

Properties

apiUrl?

optional apiUrl: string;

Defined in: packages/sdk/src/indexer/api.ts:162

URL on which /api/comments endpoint will be called

Default

"https://api.ethcomments.xyz"

app?

optional app: Hex;

Defined in: packages/sdk/src/indexer/api.ts:166

Filter comments sent using this app signer key.

author?

optional author: Hex;

Defined in: packages/sdk/src/indexer/api.ts:148

Filter comments by author

chainId

chainId: number | number[];

Defined in: packages/sdk/src/indexer/api.ts:152

Filter comments by chain ID(s)

channelId?

optional channelId: bigint;

Defined in: packages/sdk/src/indexer/api.ts:170

Filter comments by channel ID

commentType?

optional commentType: number;

Defined in: packages/sdk/src/indexer/api.ts:174

Filter comments by comment type

cursor?

optional cursor: Hex;

Defined in: packages/sdk/src/indexer/api.ts:195

The cursor to fetch comments from

excludeByModerationLabels?

optional excludeByModerationLabels: IndexerAPIModerationClassificationLabelSchemaType[];

Defined in: packages/sdk/src/indexer/api.ts:224

Filter comments by moderation labels.

Only comments with moderation labels not included in the provided array are returned. This can be used to bypass premoderation, make sure to pass all moderation statuses to moderationStatus parameter if the premoderation is enabled.

limit?

optional limit: number;

Defined in: packages/sdk/src/indexer/api.ts:230

The number of comments to fetch

Default

50

mode?

optional mode: IndexerAPICommentListModeSchemaType;

Defined in: packages/sdk/src/indexer/api.ts:208

The mode to fetch comments in by default it returns only the first level of comments. If flat is used it will return all comments sorted by timestamp in descending order.

Default

"nested"

moderationScore?

optional moderationScore: number;

Defined in: packages/sdk/src/indexer/api.ts:216

Filter comments by moderation score.

Only comments with moderation score lower or equal to the provided value are returned. This can be used to bypass premoderation, make sure to pass all moderation statuses to moderationStatus parameter if the premoderation is enabled.

moderationStatus?

optional moderationStatus: 
  | IndexerAPICommentModerationStatusSchemaType
  | IndexerAPICommentModerationStatusSchemaType[];

Defined in: packages/sdk/src/indexer/api.ts:183

Filter comments by moderation status.

By default API returns only approved comments if moderation is enabled for all comments except when the viewer is provided, for viewer it returns all comments regardless of status.

If moderation is disabled, this parameter is ignored.

retries?

optional retries: number;

Defined in: packages/sdk/src/indexer/api.ts:191

Number of times to retry the signing operation in case of failure.

Default

3

signal?

optional signal: AbortSignal;

Defined in: packages/sdk/src/indexer/api.ts:231

sort?

optional sort: IndexerAPISortSchemaType;

Defined in: packages/sdk/src/indexer/api.ts:201

The sort order, either asc or desc

Default

"desc"

targetUri?

optional targetUri: string;

Defined in: packages/sdk/src/indexer/api.ts:144

The target URI to fetch comments for

viewer?

optional viewer: Hex;

Defined in: packages/sdk/src/indexer/api.ts:156

The viewer's address. This is useful when the content moderation is enabled on the indexer.