@hashgraphonline/standards-agent-kit 0.0.18 → 0.0.19

package/README.md

@@ -82,6 +82,9 @@ The Agent Kit includes demo implementations that showcase various features. Foll
 
    # Run the LangChain interactive demo
    npm run langchain-demo
+   
+   # Run the Standards Expert Agent
+   npm run standards-expert
    ```
 
 ### Demo Descriptions
@@ -102,6 +105,14 @@ The LangChain demo demonstrates how to:
 - Process natural language requests into agent actions
 - Handle the full lifecycle of agent-to-agent communication
 
+#### Standards Expert Agent
+
+A specialized agent that runs on a small local LLM to provide expertise about Hedera Standards:
+- Uses Llama 3 8B or similar for inference
+- Answers questions about standards implementation
+- Provides guidance on Standards SDK and Agent Kit usage
+- See [Standards Expert README](examples/standards-expert/README.md) for details
+
 ## Basic Usage
 
 ```typescript
@@ -147,3 +158,75 @@ Contributions are welcome! Please open an issue or submit a pull request.
 ## License
 
 Apache-2.0
+
+## Standards Expert Agent
+
+The Standards Expert Agent is a specialized AI agent that runs on a small local LLM and can answer questions about the Hedera Standards SDK. It uses the HCS-10 protocol to communicate with clients and provides information about how to use the Standards SDK and Standards Agent Kit.
+
+### Features
+
+- Runs on a small local LLM (Llama 3 8B or similar)
+- Focused knowledge on Hedera Standards SDK
+- Answers questions about HCS-1, HCS-2, HCS-3, etc.
+- Provides implementation guidance for standards
+- Self-contained with minimal external dependencies
+
+### Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/hashgraph/standards-agent-kit.git
+cd standards-agent-kit
+
+# Install dependencies
+npm install
+
+# Set up the environment
+npx ts-node src/agents/standards-expert/cli.ts setup
+
+# Download a Llama 3 model in GGUF format
+mkdir -p models
+# Download the model from https://huggingface.co/TheBloke/Llama-3-8B-Instruct-GGUF
+# and place it in the models directory
+
+# Process documentation (optional)
+npx ts-node src/agents/standards-expert/cli.ts process-docs -d /path/to/docs
+
+# Start the agent
+npx ts-node src/agents/standards-expert/cli.ts start
+```
+
+### Using with PM2
+
+For production deployment, you can use PM2 to keep the agent running:
+
+```bash
+# Generate PM2 ecosystem file
+npx ts-node src/agents/standards-expert/cli.ts generate-pm2
+
+# Install PM2 globally
+npm install -g pm2
+
+# Start with PM2
+pm2 start ecosystem.config.js
+```
+
+### Environment Variables
+
+Create a `.env` file with the following variables:
+
+```
+# Hedera Account Information
+HEDERA_ACCOUNT_ID=0.0.123456
+HEDERA_PRIVATE_KEY=302e...
+
+# Agent HCS Topics
+AGENT_INBOUND_TOPIC_ID=0.0.123456
+AGENT_OUTBOUND_TOPIC_ID=0.0.123457
+
+# Vector Store Configuration
+OPENAI_API_KEY=sk-...
+
+# Model Configuration
+LLAMA_MODEL_PATH=./models/llama-3-8b-instruct.Q4_K_M.gguf
+```

package/dist/_virtual/_commonjsHelpers.js

@@ -0,0 +1,7 @@
+function e(t) {
+  return t && t.__esModule && Object.prototype.hasOwnProperty.call(t, "default") ? t.default : t;
+}
+export {
+  e as getDefaultExportFromCjs
+};
+//# sourceMappingURL=_commonjsHelpers.js.map

package/dist/_virtual/_commonjsHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_commonjsHelpers.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/_virtual/index.js

@@ -0,0 +1,8 @@
+import { getDefaultExportFromCjs as e } from "./_commonjsHelpers.js";
+import { __require as r } from "../node_modules/decamelize/index.js";
+var a = r();
+const m = /* @__PURE__ */ e(a);
+export {
+  m as default
+};
+//# sourceMappingURL=index.js.map

package/dist/_virtual/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/_virtual/index10.js

@@ -0,0 +1,5 @@
+var e = { exports: {} };
+export {
+  e as __module
+};
+//# sourceMappingURL=index10.js.map

package/dist/_virtual/index10.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index10.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index11.js

@@ -0,0 +1,5 @@
+var e = { exports: {} };
+export {
+  e as __module
+};
+//# sourceMappingURL=index11.js.map

package/dist/_virtual/index11.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index11.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index12.js

@@ -0,0 +1,8 @@
+import { getDefaultExportFromCjs as r } from "./_commonjsHelpers.js";
+import { __require as e } from "../node_modules/base64-js/index.js";
+var s = e();
+const a = /* @__PURE__ */ r(s);
+export {
+  a as default
+};
+//# sourceMappingURL=index12.js.map

package/dist/_virtual/index12.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index12.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/_virtual/index13.js

@@ -0,0 +1,5 @@
+var e = { exports: {} };
+export {
+  e as __module
+};
+//# sourceMappingURL=index13.js.map

package/dist/_virtual/index13.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index13.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index14.js

@@ -0,0 +1,5 @@
+var s = {};
+export {
+  s as __exports
+};
+//# sourceMappingURL=index14.js.map

package/dist/_virtual/index14.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index14.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index2.js

@@ -0,0 +1,3 @@
+import { __require as e } from "../node_modules/@langchain/core/node_modules/camelcase/index.js";
+e();
+//# sourceMappingURL=index2.js.map

package/dist/_virtual/index2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index2.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/_virtual/index3.js

@@ -0,0 +1,8 @@
+import { getDefaultExportFromCjs as r } from "./_commonjsHelpers.js";
+import { __require as t } from "../node_modules/p-retry/index.js";
+var e = t();
+const a = /* @__PURE__ */ r(e);
+export {
+  a as default
+};
+//# sourceMappingURL=index3.js.map

package/dist/_virtual/index3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index3.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/_virtual/index4.js

@@ -0,0 +1,8 @@
+import { getDefaultExportFromCjs as r } from "./_commonjsHelpers.js";
+import { __require as t } from "../node_modules/p-queue/dist/index.js";
+var e = t();
+const i = /* @__PURE__ */ r(e);
+export {
+  i as default
+};
+//# sourceMappingURL=index4.js.map

package/dist/_virtual/index4.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index4.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/_virtual/index5.js

@@ -0,0 +1,6 @@
+import { __require as r } from "../node_modules/semver/index.js";
+var s = r();
+export {
+  s
+};
+//# sourceMappingURL=index5.js.map

package/dist/_virtual/index5.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index5.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/_virtual/index6.js

@@ -0,0 +1,8 @@
+import { getDefaultExportFromCjs as r } from "./_commonjsHelpers.js";
+import { __require as t } from "../node_modules/@langchain/core/node_modules/ansi-styles/index.js";
+var e = t();
+const a = /* @__PURE__ */ r(e);
+export {
+  a as default
+};
+//# sourceMappingURL=index6.js.map

package/dist/_virtual/index6.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index6.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/_virtual/index7.js

@@ -0,0 +1,5 @@
+var r = {};
+export {
+  r as __exports
+};
+//# sourceMappingURL=index7.js.map

package/dist/_virtual/index7.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index7.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index8.js

@@ -0,0 +1,5 @@
+var e = { exports: {} };
+export {
+  e as __module
+};
+//# sourceMappingURL=index8.js.map

package/dist/_virtual/index8.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index8.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/index9.js

@@ -0,0 +1,5 @@
+var e = { exports: {} };
+export {
+  e as __module
+};
+//# sourceMappingURL=index9.js.map

package/dist/_virtual/index9.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index9.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/lower-bound.js

@@ -0,0 +1,5 @@
+var o = {};
+export {
+  o as __exports
+};
+//# sourceMappingURL=lower-bound.js.map

package/dist/_virtual/lower-bound.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lower-bound.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/priority-queue.js

@@ -0,0 +1,5 @@
+var r = {};
+export {
+  r as __exports
+};
+//# sourceMappingURL=priority-queue.js.map

package/dist/_virtual/priority-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"priority-queue.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/re.js

@@ -0,0 +1,5 @@
+var e = { exports: {} };
+export {
+  e as __module
+};
+//# sourceMappingURL=re.js.map

package/dist/_virtual/re.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"re.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/_virtual/retry.js

@@ -0,0 +1,5 @@
+var r = {};
+export {
+  r as __exports
+};
+//# sourceMappingURL=retry.js.map

package/dist/_virtual/retry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/hcs10/HCS10Client.d.ts

@@ -0,0 +1,117 @@
+import { TransactionReceipt, PrivateKey } from '@hashgraph/sdk';
+import { HCS10Client as StandardSDKClient, AgentRegistrationResult, WaitForConnectionConfirmationResponse, ProfileResponse as SDKProfileResponse, HCSMessage, LogLevel, Logger, FeeConfigBuilderInterface } from '@hashgraphonline/standards-sdk';
+import { AgentMetadata, AgentChannels } from './types';
+type StandardHandleConnectionRequest = InstanceType<typeof StandardSDKClient>['handleConnectionRequest'];
+type HandleConnectionRequestResponse = Awaited<ReturnType<StandardHandleConnectionRequest>>;
+export type StandardNetworkType = 'mainnet' | 'testnet';
+export interface HCSMessageWithTimestamp extends HCSMessage {
+    timestamp: number;
+    data: string;
+    sequence_number: number;
+}
+export interface ExtendedAgentMetadata extends AgentMetadata {
+    pfpBuffer?: Buffer;
+    pfpFileName?: string;
+    feeConfig?: FeeConfigBuilderInterface;
+}
+/**
+ * HCS10Client wraps the HCS-10 functionalities using the @hashgraphonline/standards-sdk.
+ * - Creates and registers agents using the standard SDK flow.
+ * - Manages agent communication channels (handled by standard SDK).
+ * - Sends messages on Hedera topics (currently manual, potential for standard SDK integration).
+ */
+export declare class HCS10Client {
+    standardClient: StandardSDKClient;
+    private useEncryption;
+    agentChannels?: AgentChannels;
+    guardedRegistryBaseUrl: string;
+    logger: Logger;
+    constructor(operatorId: string, operatorPrivateKey: string, network: StandardNetworkType, options?: {
+        useEncryption?: boolean;
+        registryUrl?: string;
+        logLevel?: LogLevel;
+    });
+    getOperatorId(): string;
+    getNetwork(): StandardNetworkType;
+    handleConnectionRequest(inboundTopicId: string, requestingAccountId: string, connectionRequestId: number, feeConfig?: FeeConfigBuilderInterface): Promise<HandleConnectionRequestResponse>;
+    /**
+     * Retrieves the profile for a given account ID using the standard SDK.
+     */
+    getAgentProfile(accountId: string): Promise<SDKProfileResponse>;
+    /**
+     * Exposes the standard SDK's submitConnectionRequest method.
+     */
+    submitConnectionRequest(inboundTopicId: string, memo: string): Promise<TransactionReceipt>;
+    /**
+     * Exposes the standard SDK's waitForConnectionConfirmation method.
+     */
+    waitForConnectionConfirmation(outboundTopicId: string, connectionRequestId: number, maxAttempts?: number, delayMs?: number): Promise<WaitForConnectionConfirmationResponse>;
+    /**
+     * Creates and registers an agent using the standard SDK's HCS10Client.
+     * This handles account creation, key generation, topic setup, and registration.
+     *
+     * When metadata includes fee configuration:
+     * 1. The properties.feeConfig will be passed to the AgentBuilder
+     * 2. The properties.inboundTopicType will be set to FEE_BASED
+     * 3. The SDK's createAndRegisterAgent will apply the fees to the agent's inbound topic
+     *
+     * @param metadata - The agent's metadata, potentially including pfpBuffer, pfpFileName,
+     *                   and fee configuration in properties.feeConfig
+     * @returns The registration result from the standard SDK, containing accountId, keys, topics etc.
+     */
+    createAndRegisterAgent(metadata: ExtendedAgentMetadata): Promise<AgentRegistrationResult>;
+    /**
+     * Sends a structured HCS-10 message to the specified topic using the standard SDK client.
+     * Handles potential inscription for large messages.
+     *
+     * @param topicId - The target topic ID (likely a connection topic).
+     * @param operatorId - The operator ID string (e.g., "inboundTopic@accountId").
+     * @param data - The actual message content/data.
+     * @param memo - Optional memo for the message.
+     * @param submitKey - Optional private key for topics requiring specific submit keys.
+     * @returns A confirmation status string from the transaction receipt.
+     */
+    sendMessage(topicId: string, data: string, memo?: string, submitKey?: any): Promise<number | undefined>;
+    /**
+     * Retrieves messages from a topic using the standard SDK client.
+     *
+     * @param topicId - The topic ID to get messages from.
+     * @returns Messages from the topic, mapped to the expected format.
+     */
+    getMessages(topicId: string): Promise<{
+        messages: HCSMessageWithTimestamp[];
+    }>;
+    getMessageStream(topicId: string): Promise<{
+        messages: HCSMessage[];
+    }>;
+    /**
+     * Retrieves content from an inscribed message using the standard SDK client.
+     * @param inscriptionIdOrData - The inscription ID (hcs://...) or potentially raw data string.
+     * @returns The resolved message content.
+     */
+    getMessageContent(inscriptionIdOrData: string): Promise<string>;
+    /**
+     * Retrieves the inbound topic ID associated with the current operator.
+     * This typically involves fetching the operator's own HCS-10 profile.
+     * @returns A promise that resolves to the operator's inbound topic ID.
+     * @throws {Error} If the operator ID cannot be determined or the profile/topic cannot be retrieved.
+     */
+    getInboundTopicId(): Promise<string>;
+    /**
+     * Retrieves the configured operator account ID and private key.
+     * Required by tools needing to identify the current agent instance.
+     */
+    getAccountAndSigner(): {
+        accountId: string;
+        signer: PrivateKey;
+    };
+    /**
+     * Retrieves the outbound topic ID for the current operator.
+     * Fetches the operator's profile if necessary.
+     * @returns The outbound topic ID string.
+     * @throws If the outbound topic cannot be determined.
+     */
+    getOutboundTopicId(): Promise<string>;
+    setClient(accountId: string, privateKey: string): StandardSDKClient;
+}
+export {};