npm - @hashgraphonline/standards-agent-kit - Versions diffs - 0.2.121 → 0.2.123 - Mend

@hashgraphonline/standards-agent-kit 0.2.121 → 0.2.123

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/src/tools/inscriber/InscribeFromUrlTool.ts CHANGED Viewed

@@ -40,6 +40,11 @@ const inscribeFromUrlSchema = z.object({
     .string()
     .optional()
     .describe('API key for inscription service'),
+  quoteOnly: z
+    .boolean()
+    .optional()
+    .default(false)
+    .describe('If true, returns a cost quote instead of executing the inscription'),
 });
@@ -48,7 +53,7 @@ const inscribeFromUrlSchema = z.object({
  */
 export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeFromUrlSchema> {
   name = 'inscribeFromUrl';
-  description = 'ONLY for direct FILE DOWNLOAD URLs ending with file extensions (.pdf, .jpg, .png, .json, .zip). NEVER use for web pages, articles, or ANY HTML content - it WILL FAIL. If you have already retrieved content from any source (including MCP tools), you MUST use inscribeFromBuffer instead. This tool downloads files from URLs - it does NOT inscribe content you already have. When asked to "inscribe it" after retrieving content, ALWAYS use inscribeFromBuffer with the actual content.';
+  description = 'ONLY for direct FILE DOWNLOAD URLs ending with file extensions (.pdf, .jpg, .png, .json, .zip). NEVER use for web pages, articles, or ANY HTML content - it WILL FAIL. If you have already retrieved content from any source (including MCP tools), you MUST use inscribeFromBuffer instead. This tool downloads files from URLs - it does NOT inscribe content you already have. When asked to "inscribe it" after retrieving content, ALWAYS use inscribeFromBuffer with the actual content. Set quoteOnly=true to get cost estimates without executing the inscription.';
   get specificInputSchema() {
     return inscribeFromUrlSchema;
@@ -86,7 +91,6 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
       const timeoutId = setTimeout(() => controller.abort(), 10000);
       try {
-        // First try HEAD request
         const headResponse = await fetch(params.url, {
           method: 'HEAD',
           signal: controller.signal,
@@ -101,7 +105,6 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
         const contentType = headResponse.headers.get('content-type') || '';
         const contentLength = headResponse.headers.get('content-length');
-        // Check if content type indicates HTML/web page
         const webPageContentTypes = [
           'text/html',
           'application/xhtml+xml',
@@ -120,7 +123,6 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
           throw new Error(`URL content is too small (${contentLength} bytes). Content must be at least 10 bytes.`);
         }
-        // If HEAD doesn't provide content-type, do a partial GET to check
         if (!contentType || contentType === 'application/octet-stream') {
           console.log(`[InscribeFromUrlTool] Content-Type unclear, fetching first 1KB to verify...`);
@@ -142,7 +144,6 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
               const bytes = new Uint8Array(buffer);
               const text = new TextDecoder('utf-8', { fatal: false }).decode(bytes.slice(0, 512));
-              // Check if it looks like HTML
               if (text.toLowerCase().includes('<!doctype html') ||
                   text.toLowerCase().includes('<html') ||
                   text.match(/<meta\s+[^>]*>/i) ||
@@ -155,7 +156,6 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
             if (getError instanceof Error && getError.message.includes('HTML content')) {
               throw getError;
             }
-            // If partial GET fails, continue anyway
             console.log(`[InscribeFromUrlTool] Could not perform partial GET validation: ${getError instanceof Error ? getError.message : 'Unknown error'}`);
           }
         }
@@ -182,13 +182,40 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
       metadata: params.metadata,
       tags: params.tags,
       chunkSize: params.chunkSize,
-      waitForConfirmation: params.waitForConfirmation ?? true,
+      waitForConfirmation: params.quoteOnly ? false : (params.waitForConfirmation ?? true),
       waitMaxAttempts: 10,
       waitIntervalMs: 3000,
       apiKey: params.apiKey,
       network: this.inscriberBuilder['hederaKit'].client.network.toString().includes('mainnet') ? 'mainnet' : 'testnet',
+      quoteOnly: params.quoteOnly,
     };
+    if (params.quoteOnly) {
+      try {
+        const quote = await this.generateInscriptionQuote(
+          { type: 'url', url: params.url },
+          options
+        );
+        return {
+          success: true,
+          quote: {
+            totalCostHbar: quote.totalCostHbar,
+            validUntil: quote.validUntil,
+            breakdown: quote.breakdown,
+          },
+          contentInfo: {
+            url: params.url,
+          },
+          message: `Quote generated for URL: ${params.url}\nTotal cost: ${quote.totalCostHbar} HBAR\nQuote valid until: ${new Date(quote.validUntil).toLocaleString()}`,
+        };
+      } catch (error) {
+        const errorMessage =
+          error instanceof Error ? error.message : 'Failed to generate inscription quote';
+        throw new Error(`Quote generation failed: ${errorMessage}`);
+      }
+    }
     try {
       let result: Awaited<ReturnType<typeof this.inscriberBuilder.inscribe>>;
@@ -214,13 +241,15 @@ export class InscribeFromUrlTool extends BaseInscriberQueryTool<typeof inscribeF
         );
       }
-      if (result.confirmed) {
-        const topicId = result.inscription?.topic_id || result.result.topicId;
+      if (result.confirmed && !result.quote) {
+        const topicId = result.inscription?.topic_id || (result.result as any).topicId;
         const network = options.network || 'testnet';
         const cdnUrl = topicId ? `https://kiloscribe.com/api/inscription-cdn/${topicId}?network=${network}` : null;
-        return `Successfully inscribed and confirmed content on the Hedera network!\n\nTransaction ID: ${result.result.transactionId}\nTopic ID: ${topicId || 'N/A'}${cdnUrl ? `\nView inscription: ${cdnUrl}` : ''}\n\nThe inscription is now available.`;
+        return `Successfully inscribed and confirmed content on the Hedera network!\n\nTransaction ID: ${(result.result as any).transactionId}\nTopic ID: ${topicId || 'N/A'}${cdnUrl ? `\nView inscription: ${cdnUrl}` : ''}\n\nThe inscription is now available.`;
+      } else if (!result.quote && !result.confirmed) {
+        return `Successfully submitted inscription to the Hedera network!\n\nTransaction ID: ${(result.result as any).transactionId}\n\nThe inscription is processing and will be confirmed shortly.`;
       } else {
-        return `Successfully submitted inscription to the Hedera network!\n\nTransaction ID: ${result.result.transactionId}\n\nThe inscription is processing and will be confirmed shortly.`;
+        return 'Inscription operation completed.';
       }
     } catch (error) {
       const errorMessage = error instanceof Error ? error.message : 'Failed to inscribe from URL';

package/src/tools/inscriber/InscribeHashinalTool.ts CHANGED Viewed

@@ -54,6 +54,11 @@ const inscribeHashinalSchema = z.object({
     .string()
     .optional()
     .describe('API key for inscription service'),
+  quoteOnly: z
+    .boolean()
+    .optional()
+    .default(false)
+    .describe('If true, returns a cost quote instead of executing the inscription'),
 });
@@ -62,7 +67,7 @@ const inscribeHashinalSchema = z.object({
  */
 export class InscribeHashinalTool extends BaseInscriberQueryTool<typeof inscribeHashinalSchema> {
   name = 'inscribeHashinal';
-  description = 'Inscribe content as a Hashinal NFT on the Hedera network';
+  description = 'Inscribe content as a Hashinal NFT on the Hedera network. Set quoteOnly=true to get cost estimates without executing the inscription.';
   get specificInputSchema() {
     return inscribeHashinalSchema;
@@ -87,13 +92,43 @@ export class InscribeHashinalTool extends BaseInscriberQueryTool<typeof inscribe
       jsonFileURL: params.jsonFileURL,
       tags: params.tags,
       chunkSize: params.chunkSize,
-      waitForConfirmation: params.waitForConfirmation ?? true,
+      waitForConfirmation: params.quoteOnly ? false : (params.waitForConfirmation ?? true),
       waitMaxAttempts: 10,
       waitIntervalMs: 3000,
       apiKey: params.apiKey,
       network: this.inscriberBuilder['hederaKit'].client.network.toString().includes('mainnet') ? 'mainnet' : 'testnet',
+      quoteOnly: params.quoteOnly,
     };
+    if (params.quoteOnly) {
+      try {
+        const quote = await this.generateInscriptionQuote(
+          { type: 'url', url: params.url },
+          options
+        );
+        return {
+          success: true,
+          quote: {
+            totalCostHbar: quote.totalCostHbar,
+            validUntil: quote.validUntil,
+            breakdown: quote.breakdown,
+          },
+          contentInfo: {
+            url: params.url,
+            name: params.name,
+            creator: params.creator,
+            type: params.type,
+          },
+          message: `Quote generated for Hashinal NFT: ${params.name}\nCreator: ${params.creator}\nTotal cost: ${quote.totalCostHbar} HBAR\nQuote valid until: ${new Date(quote.validUntil).toLocaleString()}`,
+        };
+      } catch (error) {
+        const errorMessage =
+          error instanceof Error ? error.message : 'Failed to generate inscription quote';
+        throw new Error(`Quote generation failed: ${errorMessage}`);
+      }
+    }
     try {
       let result: Awaited<ReturnType<typeof this.inscriberBuilder.inscribe>>;
@@ -119,13 +154,15 @@ export class InscribeHashinalTool extends BaseInscriberQueryTool<typeof inscribe
         );
       }
-      if (result.confirmed) {
-        const topicId = result.inscription?.topic_id || result.result.topicId;
+      if (result.confirmed && !result.quote) {
+        const topicId = result.inscription?.topic_id || (result.result as any).topicId;
         const network = options.network || 'testnet';
         const cdnUrl = topicId ? `https://kiloscribe.com/api/inscription-cdn/${topicId}?network=${network}` : null;
-        return `Successfully inscribed and confirmed Hashinal NFT on the Hedera network!\n\nTransaction ID: ${result.result.transactionId}\nTopic ID: ${topicId || 'N/A'}${cdnUrl ? `\nView inscription: ${cdnUrl}` : ''}\n\nThe Hashinal NFT is now available.`;
+        return `Successfully inscribed and confirmed Hashinal NFT on the Hedera network!\n\nTransaction ID: ${(result.result as any).transactionId}\nTopic ID: ${topicId || 'N/A'}${cdnUrl ? `\nView inscription: ${cdnUrl}` : ''}\n\nThe Hashinal NFT is now available.`;
+      } else if (!result.quote && !result.confirmed) {
+        return `Successfully submitted Hashinal NFT inscription to the Hedera network!\n\nTransaction ID: ${(result.result as any).transactionId}\n\nThe inscription is processing and will be confirmed shortly.`;
       } else {
-        return `Successfully submitted Hashinal NFT inscription to the Hedera network!\n\nTransaction ID: ${result.result.transactionId}\n\nThe inscription is processing and will be confirmed shortly.`;
+        return 'Inscription operation completed.';
       }
     } catch (error) {
       const errorMessage = error instanceof Error ? error.message : 'Failed to inscribe Hashinal NFT';

package/src/tools/inscriber/base-inscriber-tools.ts CHANGED Viewed

@@ -9,6 +9,11 @@ import {
   InscriberQueryToolParams,
 } from './inscriber-tool-params';
 import type { ContentResolverInterface } from '../../types/content-resolver';
+import {
+  InscriptionInput,
+  InscriptionOptions,
+  QuoteResult,
+} from '@hashgraphonline/standards-sdk';
 import { z } from 'zod';
 /**
@@ -44,6 +49,47 @@ export abstract class BaseInscriberTransactionTool<
   protected getContentResolver(): ContentResolverInterface | null {
     return this.contentResolver;
   }
+  /**
+   * Generate a quote for an inscription without executing it
+   * @param input - The inscription input data
+   * @param options - Inscription options
+   * @returns Promise containing the quote result
+   */
+  protected async generateInscriptionQuote(
+    input: InscriptionInput,
+    options: InscriptionOptions
+  ): Promise<QuoteResult> {
+    const operatorId = this.inscriberBuilder['hederaKit'].signer.getAccountId().toString();
+    const operatorPrivateKey = this.inscriberBuilder['hederaKit'].signer?.getOperatorPrivateKey()
+      ? this.inscriberBuilder['hederaKit'].signer.getOperatorPrivateKey().toStringRaw()
+      : '';
+    const network = this.inscriberBuilder['hederaKit'].client.network;
+    const networkType = network.toString().includes('mainnet')
+      ? 'mainnet'
+      : 'testnet';
+    const clientConfig = {
+      accountId: operatorId,
+      privateKey: operatorPrivateKey,
+      network: networkType as 'mainnet' | 'testnet',
+    };
+    const quoteOptions = {
+      ...options,
+      quoteOnly: true,
+      network: networkType as 'mainnet' | 'testnet',
+    };
+    const result = await this.inscriberBuilder.inscribe(input, quoteOptions);
+    if (!result.quote || result.confirmed) {
+      throw new Error('Failed to generate quote - unexpected response type');
+    }
+    return result.result as QuoteResult;
+  }
 }
 /**
@@ -79,4 +125,45 @@ export abstract class BaseInscriberQueryTool<
   protected getContentResolver(): ContentResolverInterface | null {
     return this.contentResolver;
   }
+  /**
+   * Generate a quote for an inscription without executing it
+   * @param input - The inscription input data
+   * @param options - Inscription options
+   * @returns Promise containing the quote result
+   */
+  protected async generateInscriptionQuote(
+    input: InscriptionInput,
+    options: InscriptionOptions
+  ): Promise<QuoteResult> {
+    const operatorId = this.inscriberBuilder['hederaKit'].signer.getAccountId().toString();
+    const operatorPrivateKey = this.inscriberBuilder['hederaKit'].signer?.getOperatorPrivateKey()
+      ? this.inscriberBuilder['hederaKit'].signer.getOperatorPrivateKey().toStringRaw()
+      : '';
+    const network = this.inscriberBuilder['hederaKit'].client.network;
+    const networkType = network.toString().includes('mainnet')
+      ? 'mainnet'
+      : 'testnet';
+    const clientConfig = {
+      accountId: operatorId,
+      privateKey: operatorPrivateKey,
+      network: networkType as 'mainnet' | 'testnet',
+    };
+    const quoteOptions = {
+      ...options,
+      quoteOnly: true,
+      network: networkType as 'mainnet' | 'testnet',
+    };
+    const result = await this.inscriberBuilder.inscribe(input, quoteOptions);
+    if (!result.quote || result.confirmed) {
+      throw new Error('Failed to generate quote - unexpected response type');
+    }
+    return result.result as QuoteResult;
+  }
 }