@hashgraphonline/standards-agent-kit/src/tools/hcs2/UpdateEntryTool.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 updating an entry in HCS-2
 */
const updateEntrySchema = z.object({
  registryTopicId: z
    .string()
    .regex(/^\d+\.\d+\.\d+$/)
    .describe('The HCS-2 registry topic ID (must be indexed)'),
  targetTopicId: z
    .string()
    .regex(/^\d+\.\d+\.\d+$/)
    .describe('The new topic ID to point to'),
  uid: z
    .string()
    .describe('The unique ID of the entry to update'),
  metadata: z
    .string()
    .optional()
    .describe('Optional metadata URI (HIP-412 format)'),
  memo: z
    .string()
    .max(500)
    .optional()
    .describe('Optional memo (max 500 characters)'),
});


/**
 * Tool for updating entries in HCS-2 registries
 */
export class UpdateEntryTool extends BaseHCS2QueryTool<typeof updateEntrySchema> {
  name = 'updateHCS2Entry';
  description = 'Update an existing entry in an indexed HCS-2 registry';

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

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

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

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

      return `Successfully updated entry in HCS-2 registry!\n\nRegistry Topic: ${params.registryTopicId}\nUID: ${params.uid}\nNew Target Topic ID: ${params.targetTopicId}${params.metadata ? `\nMetadata: ${params.metadata}` : ''}${params.memo ? `\nMemo: ${params.memo}` : ''}\n\nThe entry has been updated in the registry.`;
    } catch (error) {
      const errorMessage = error instanceof Error ? error.message : 'Failed to update entry';
      throw new Error(`Entry update failed: ${errorMessage}`);
    }
  }
}