Skip to content

@ecp.eth/sdk

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

Type Alias: CommentHookMetadataSetEvent

type CommentHookMetadataSetEvent = {
  blockNumber: bigint;
  chainId: number;
  data: {
     comment: {
        hookMetadata: {
           key: `0x${string}`;
           value: `0x${string}`;
        }[];
        id: `0x${string}`;
        updatedAt: Date;
     };
     hookMetadataOperation:   | {
        key: `0x${string}`;
        type: "delete";
      }
        | {
        key: `0x${string}`;
        type: "create";
        value: `0x${string}`;
      }
        | {
        key: `0x${string}`;
        type: "update";
        value: `0x${string}`;
      };
  };
  event: "comment:hook:metadata:set";
  logIndex: number;
  txHash: `0x${string}`;
  uid: string;
  version: 1;
};

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

An event sent to webhook when a comment hook metadata is set.

Type declaration

blockNumber

blockNumber: bigint = StringBigintSchema;

Block number. On wire it is a stringified bigint.

chainId

chainId: number;

Chain ID

data

data: {
  comment: {
     hookMetadata: {
        key: `0x${string}`;
        value: `0x${string}`;
     }[];
     id: `0x${string}`;
     updatedAt: Date;
  };
  hookMetadataOperation:   | {
     key: `0x${string}`;
     type: "delete";
   }
     | {
     key: `0x${string}`;
     type: "create";
     value: `0x${string}`;
   }
     | {
     key: `0x${string}`;
     type: "update";
     value: `0x${string}`;
   };
};

Data of the event

data.comment

comment: {
  hookMetadata: {
     key: `0x${string}`;
     value: `0x${string}`;
  }[];
  id: `0x${string}`;
  updatedAt: Date;
};

Updated comment data

data.comment.hookMetadata

hookMetadata: {
  key: `0x${string}`;
  value: `0x${string}`;
}[] = MetadataArraySchema;

Hook metadata. On wire it is a ISO 8601 date and time string.

data.comment.id

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

ID of the comment

data.comment.updatedAt

updatedAt: Date = ISO8601DateSchema;

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

data.hookMetadataOperation

hookMetadataOperation: 
  | {
  key: `0x${string}`;
  type: "delete";
}
  | {
  key: `0x${string}`;
  type: "create";
  value: `0x${string}`;
}
  | {
  key: `0x${string}`;
  type: "update";
  value: `0x${string}`;
} = MetadataSetOperationSchema;

Hook metadata operation

event

event: "comment:hook:metadata:set";

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