Skip to content

@ecp.eth/sdk

@ecp.eth/sdk / indexer/webhooks / CommentEditedEvent

Type Alias: CommentEditedEvent

type CommentEditedEvent = {
  blockNumber: bigint;
  chainId: number;
  data: {
     comment: {
        content: string;
        id: `0x${string}`;
        moderationStatus: "approved" | "pending" | "rejected";
        references: (
           | {
           address: `0x${string}`;
           avatarUrl: null | string;
           name: string;
           position: {
              end: number;
              start: number;
           };
           type: "ens";
           url: string;
         }
           | {
           address: `0x${string}`;
           displayName: null | string;
           fid: number;
           fname: string;
           pfpUrl: null | string;
           position: {
              end: number;
              start: number;
           };
           type: "farcaster";
           url: string;
           username: string;
         }
           | {
           address: `0x${string}`;
           chainId: null | number;
           chains: {
              caip: string;
              chainId: number;
           }[];
           decimals: number;
           logoURI: null | string;
           name: string;
           position: {
              end: number;
              start: number;
           };
           symbol: string;
           type: "erc20";
         }
           | {
           description: null | string;
           favicon: null | string;
           mediaType: string;
           opengraph:   | null
              | {
              description: null | string;
              image: string;
              title: string;
              url: string;
            };
           position: {
              end: number;
              start: number;
           };
           title: string;
           type: "webpage";
           url: string;
         }
           | {
           mediaType: string;
           position: {
              end: number;
              start: number;
           };
           type: "file";
           url: string;
         }
           | {
           dimension?: {
              height: number;
              width: number;
           };
           mediaType: string;
           position: {
              end: number;
              start: number;
           };
           type: "image";
           url: string;
         }
           | {
           mediaType: string;
           position: {
              end: number;
              start: number;
           };
           type: "video";
           url: string;
           videoTracks?: {
              codec?: string;
              dimension: {
                 height: number;
                 width: number;
              };
           }[];
        })[];
        updatedAt: Date;
     };
  };
  event: "comment:edited";
  logIndex: number;
  txHash: `0x${string}`;
  uid: string;
  version: 1;
};

Defined in: packages/sdk/src/indexer/webhooks/schemas/comment.ts:242

An event sent to webhook when a comment is edited.

Type declaration

blockNumber

blockNumber: bigint = StringBigintSchema;

Block number. On wire it is a stringified bigint.

chainId

chainId: number;

Chain ID

data

data: {
  comment: {
     content: string;
     id: `0x${string}`;
     moderationStatus: "approved" | "pending" | "rejected";
     references: (
        | {
        address: `0x${string}`;
        avatarUrl: null | string;
        name: string;
        position: {
           end: number;
           start: number;
        };
        type: "ens";
        url: string;
      }
        | {
        address: `0x${string}`;
        displayName: null | string;
        fid: number;
        fname: string;
        pfpUrl: null | string;
        position: {
           end: number;
           start: number;
        };
        type: "farcaster";
        url: string;
        username: string;
      }
        | {
        address: `0x${string}`;
        chainId: null | number;
        chains: {
           caip: string;
           chainId: number;
        }[];
        decimals: number;
        logoURI: null | string;
        name: string;
        position: {
           end: number;
           start: number;
        };
        symbol: string;
        type: "erc20";
      }
        | {
        description: null | string;
        favicon: null | string;
        mediaType: string;
        opengraph:   | null
           | {
           description: null | string;
           image: string;
           title: string;
           url: string;
         };
        position: {
           end: number;
           start: number;
        };
        title: string;
        type: "webpage";
        url: string;
      }
        | {
        mediaType: string;
        position: {
           end: number;
           start: number;
        };
        type: "file";
        url: string;
      }
        | {
        dimension?: {
           height: number;
           width: number;
        };
        mediaType: string;
        position: {
           end: number;
           start: number;
        };
        type: "image";
        url: string;
      }
        | {
        mediaType: string;
        position: {
           end: number;
           start: number;
        };
        type: "video";
        url: string;
        videoTracks?: {
           codec?: string;
           dimension: {
              height: number;
              width: number;
           };
        }[];
     })[];
     updatedAt: Date;
  };
};

Data of the event

data.comment

comment: {
  content: string;
  id: `0x${string}`;
  moderationStatus: "approved" | "pending" | "rejected";
  references: (
     | {
     address: `0x${string}`;
     avatarUrl: null | string;
     name: string;
     position: {
        end: number;
        start: number;
     };
     type: "ens";
     url: string;
   }
     | {
     address: `0x${string}`;
     displayName: null | string;
     fid: number;
     fname: string;
     pfpUrl: null | string;
     position: {
        end: number;
        start: number;
     };
     type: "farcaster";
     url: string;
     username: string;
   }
     | {
     address: `0x${string}`;
     chainId: null | number;
     chains: {
        caip: string;
        chainId: number;
     }[];
     decimals: number;
     logoURI: null | string;
     name: string;
     position: {
        end: number;
        start: number;
     };
     symbol: string;
     type: "erc20";
   }
     | {
     description: null | string;
     favicon: null | string;
     mediaType: string;
     opengraph:   | null
        | {
        description: null | string;
        image: string;
        title: string;
        url: string;
      };
     position: {
        end: number;
        start: number;
     };
     title: string;
     type: "webpage";
     url: string;
   }
     | {
     mediaType: string;
     position: {
        end: number;
        start: number;
     };
     type: "file";
     url: string;
   }
     | {
     dimension?: {
        height: number;
        width: number;
     };
     mediaType: string;
     position: {
        end: number;
        start: number;
     };
     type: "image";
     url: string;
   }
     | {
     mediaType: string;
     position: {
        end: number;
        start: number;
     };
     type: "video";
     url: string;
     videoTracks?: {
        codec?: string;
        dimension: {
           height: number;
           width: number;
        };
     }[];
  })[];
  updatedAt: Date;
};

Updated comment data

data.comment.content

content: string;

Content of the comment

data.comment.id

id: `0x${string}` = HexSchema;

ID of the comment

data.comment.moderationStatus

moderationStatus: "approved" | "pending" | "rejected" = CommentModerationStatusSchema;

Moderation status of the comment

data.comment.references

references: (
  | {
  address: `0x${string}`;
  avatarUrl: null | string;
  name: string;
  position: {
     end: number;
     start: number;
  };
  type: "ens";
  url: string;
}
  | {
  address: `0x${string}`;
  displayName: null | string;
  fid: number;
  fname: string;
  pfpUrl: null | string;
  position: {
     end: number;
     start: number;
  };
  type: "farcaster";
  url: string;
  username: string;
}
  | {
  address: `0x${string}`;
  chainId: null | number;
  chains: {
     caip: string;
     chainId: number;
  }[];
  decimals: number;
  logoURI: null | string;
  name: string;
  position: {
     end: number;
     start: number;
  };
  symbol: string;
  type: "erc20";
}
  | {
  description: null | string;
  favicon: null | string;
  mediaType: string;
  opengraph:   | null
     | {
     description: null | string;
     image: string;
     title: string;
     url: string;
   };
  position: {
     end: number;
     start: number;
  };
  title: string;
  type: "webpage";
  url: string;
}
  | {
  mediaType: string;
  position: {
     end: number;
     start: number;
  };
  type: "file";
  url: string;
}
  | {
  dimension?: {
     height: number;
     width: number;
  };
  mediaType: string;
  position: {
     end: number;
     start: number;
  };
  type: "image";
  url: string;
}
  | {
  mediaType: string;
  position: {
     end: number;
     start: number;
  };
  type: "video";
  url: string;
  videoTracks?: {
     codec?: string;
     dimension: {
        height: number;
        width: number;
     };
  }[];
})[] = IndexerAPICommentReferencesSchema;

References of the comment

data.comment.updatedAt

updatedAt: Date = ISO8601DateSchema;

Updated at date. On wire it is a ISO 8601 date and time string

event

event: "comment:edited";

Event type

logIndex

logIndex: number;

Log index

txHash

txHash: `0x${string}` = HexSchema;

Transaction hash

uid

uid: string;

Unique identifier for the event. You can use it to deduplicate events. In case of retry attempts the id is the same.

version

version: 1;

Version of the event