@hashgraphonline/standards-agent-kit/src/tools/hcs2/DeleteEntryTool.ts

A modular SDK for building on-chain autonomous agents using Hashgraph Online Standards, including HCS-10 for agent discovery and communication. https://hol.org

import { z } from 'zod';
import { BaseHCS2QueryTool } from './base-hcs2-tools';
import { CallbackManagerForToolRun } from '@langchain/core/callbacks/manager';
import { isWalletBytesResponse, type RegistryOperationResult } from '../../types/tx-results';

/**
 * Schema for deleting an entry from HCS-2
 */
const deleteEntrySchema = z.object({
  registryTopicId: z
    .string()
    .regex(/^\d+\.\d+\.\d+$/)
    .describe('The HCS-2 registry topic ID (must be indexed)'),
  uid: z
    .string()
    .describe('The unique ID of the entry to delete'),
  memo: z
    .string()
    .max(500)
    .optional()
    .describe('Optional memo (max 500 characters)'),
});


/**
 * Tool for deleting entries from HCS-2 registries
 */
export class DeleteEntryTool extends BaseHCS2QueryTool<typeof deleteEntrySchema> {
  name = 'deleteHCS2Entry';
  description = 'Delete an entry from an indexed HCS-2 registry';

  get specificInputSchema(): typeof deleteEntrySchema {
    return deleteEntrySchema;
  }

  protected async executeQuery(
    params: z.infer<typeof deleteEntrySchema>,
    _runManager?: CallbackManagerForToolRun
  ): Promise<unknown> {
    try {
      const result: RegistryOperationResult = await this.hcs2Builder.deleteEntry(
        params.registryTopicId,
        {
          uid: params.uid,
          memo: params.memo,
        }
      );

      if (!('success' in result) || !result.success) {
        throw new Error(result.error || 'Failed to delete entry');
      }

      if (isWalletBytesResponse(result)) {
        const txBytes = result.transactionBytes;
        return {
          message: 'I prepared an unsigned transaction to delete the HCS-2 registry entry. Please review and approve to submit.',
          transactionBytes: txBytes,
          metadata: {
            transactionBytes: txBytes,
            pendingApproval: true,
            description: `Delete HCS-2 entry (registry ${params.registryTopicId}, uid ${params.uid})`,
          },
        };
      }

      return `Successfully deleted entry from HCS-2 registry!\n\nRegistry Topic: ${params.registryTopicId}\nUID: ${params.uid}${params.memo ? `\nMemo: ${params.memo}` : ''}\n\nThe entry has been removed from the registry.`;
    } catch (error) {
      const errorMessage = error instanceof Error ? error.message : 'Failed to delete entry';
      throw new Error(`Entry deletion failed: ${errorMessage}`);
    }
  }
}