Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / indexer / ReportCommentOptions

Type Alias: ReportCommentOptions

type ReportCommentOptions = {
  apiUrl?: string;
  chainId: number;
  commentId: Hex;
  message?: string;
  reportee: Hex;
  retries?: number;
  signal?: AbortSignal;
  signature: Hex;
};

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

The options for reportComment()

Properties

apiUrl?

optional apiUrl: string;

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

URL on which /api/comments/$commentId/reports endpoint will be called

Default

"https://api.ethcomments.xyz"

chainId

chainId: number;

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

The chain ID where the comment was posted


commentId

commentId: Hex;

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

The ID of the comment to report


message?

optional message: string;

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

Optional message explaining the reason for the report


reportee

reportee: Hex;

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

The address of the user reporting the comment


retries?

optional retries: number;

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

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

Default

3

signal?

optional signal: AbortSignal;

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


signature

signature: Hex;

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

The signature of the report typed data