@ecp.eth/sdk

@ecp.eth/sdk / indexer / 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:1105

The options for reportComment()

Properties

apiUrl?

optional apiUrl: string;

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

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:1125

The chain ID where the comment was posted

commentId

commentId: Hex;

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

The ID of the comment to report

message?

optional message: string;

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

Optional message explaining the reason for the report

reportee

reportee: Hex;

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

The address of the user reporting the comment

retries?

optional retries: number;

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

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:1138

signature

signature: Hex;

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

The signature of the report typed data