Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / indexer / fetchComments

Function: fetchComments()

function fetchComments(options): Promise<{
  extra: {
     moderationEnabled: boolean;
  };
  pagination: {
     endCursor?: `0x${string}`;
     hasNext: boolean;
     hasPrevious: boolean;
     limit: number;
     startCursor?: `0x${string}`;
  };
  results: {
     app: `0x${string}`;
     author: {
        address: `0x${string}`;
        ens?: {
           avatarUrl: null | string;
           name: string;
        };
        farcaster?: {
           displayName?: string;
           fid: number;
           pfpUrl?: string;
           username?: string;
        };
     };
     chainId: number;
     channelId: bigint;
     commentType: string;
     content: string;
     createdAt: Date;
     cursor: `0x${string}`;
     deletedAt: null | Date;
     id: `0x${string}`;
     logIndex: null | number;
     metadata: string;
     moderationStatus: "approved" | "pending" | "rejected";
     moderationStatusChangedAt: Date;
     parentId: null | `0x${string}`;
     replies: {
        extra: {
           moderationEnabled: boolean;
        };
        pagination: {
           endCursor?: `0x${string}`;
           hasNext: boolean;
           hasPrevious: boolean;
           limit: number;
           startCursor?: `0x${string}`;
        };
        results: {
           app: `0x${string}`;
           author: {
              address: `0x${string}`;
              ens?: {
                 avatarUrl: ... | ...;
                 name: string;
              };
              farcaster?: {
                 displayName?: ... | ...;
                 fid: number;
                 pfpUrl?: ... | ...;
                 username?: ... | ...;
              };
           };
           chainId: number;
           channelId: bigint;
           commentType: string;
           content: string;
           createdAt: Date;
           cursor: `0x${string}`;
           deletedAt: null | Date;
           id: `0x${string}`;
           logIndex: null | number;
           metadata: string;
           moderationStatus: "approved" | "pending" | "rejected";
           moderationStatusChangedAt: Date;
           parentId: null | `0x${string}`;
           revision: number;
           targetUri: string;
           txHash: `0x${string}`;
           updatedAt: Date;
           zeroExSwap:   | null
              | {
              from: {
                 address: `0x${(...)}`;
                 amount: string;
                 symbol: string;
              };
              to: {
                 address: `0x${(...)}`;
                 amount: string;
                 symbol: string;
              };
            };
        }[];
     };
     revision: number;
     targetUri: string;
     txHash: `0x${string}`;
     updatedAt: Date;
     zeroExSwap:   | null
        | {
        from: {
           address: `0x${string}`;
           amount: string;
           symbol: string;
        };
        to: {
           address: `0x${string}`;
           amount: string;
           symbol: string;
        };
      };
  }[];
}>;

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

Fetch comments from the Indexer API

Parameters

options

FetchCommentsOptions

Returns

Promise<{ extra: { moderationEnabled: boolean; }; pagination: { endCursor?: `0x${string}`; hasNext: boolean; hasPrevious: boolean; limit: number; startCursor?: `0x${string}`; }; results: { app: `0x${string}`; author: { address: `0x${string}`; ens?: { avatarUrl: null | string; name: string; }; farcaster?: { displayName?: string; fid: number; pfpUrl?: string; username?: string; }; }; chainId: number; channelId: bigint; commentType: string; content: string; createdAt: Date; cursor: `0x${string}`; deletedAt: null | Date; id: `0x${string}`; logIndex: null | number; metadata: string; moderationStatus: "approved" | "pending" | "rejected"; moderationStatusChangedAt: Date; parentId: null | `0x${string}`; replies: { extra: { moderationEnabled: boolean; }; pagination: { endCursor?: `0x${string}`; hasNext: boolean; hasPrevious: boolean; limit: number; startCursor?: `0x${string}`; }; results: { app: `0x${string}`; author: { address: `0x${string}`; ens?: { avatarUrl: ... | ...; name: string; }; farcaster?: { displayName?: ... | ...; fid: number; pfpUrl?: ... | ...; username?: ... | ...; }; }; chainId: number; channelId: bigint; commentType: string; content: string; createdAt: Date; cursor: `0x${string}`; deletedAt: null | Date; id: `0x${string}`; logIndex: null | number; metadata: string; moderationStatus: "approved" | "pending" | "rejected"; moderationStatusChangedAt: Date; parentId: null | `0x${string}`; revision: number; targetUri: string; txHash: `0x${string}`; updatedAt: Date; zeroExSwap: | null | { from: { address: `0x${(...)}`; amount: string; symbol: string; }; to: { address: `0x${(...)}`; amount: string; symbol: string; }; }; }[]; }; revision: number; targetUri: string; txHash: `0x${string}`; updatedAt: Date; zeroExSwap: | null | { from: { address: `0x${string}`; amount: string; symbol: string; }; to: { address: `0x${string}`; amount: string; symbol: string; }; }; }[]; }>

A promise that resolves comments fetched from the Indexer API