@hashgraphonline/standards-sdk/dist/cjs/hcs-10/types.d.ts

The Hashgraph Online Standards SDK provides a complete implementation of the Hashgraph Consensus Standards (HCS), giving developers all the tools needed to build applications on Hedera.

import { PrivateKey } from '@hashgraph/sdk';
import { LogLevel } from '../utils/logger';
import { AIAgentCapability, AIAgentProfile } from '../hcs-11';
import { NetworkType } from '../utils/types';
import { MirrorNodeConfig } from '../services';
export interface ValidationError {
    validation: string;
    code: string;
    message: string;
    path: string[];
}
export interface RegistrationProgressData {
    stage: 'preparing' | 'submitting' | 'confirming' | 'completed' | 'verifying' | 'failed';
    message: string;
    progressPercent?: number;
    details?: Record<string, any>;
}
export type RegistrationProgressCallback = (data: RegistrationProgressData) => void;
export interface AgentConfig<T> {
    accountId: string;
    privateKey: string;
    operatorId: string;
    inboundTopicId: string;
    outboundTopicId: string;
    profileTopicId: string;
    pfpTopicId: string;
    client: T;
}
/**
 * Configuration for HCS-10 SDK client.
 *
 * @example
 * // Using default Hedera mirror nodes
 * const config = {
 *   network: 'testnet',
 *   operatorId: '0.0.123',
 *   operatorPrivateKey: 'your-private-key'
 * };
 *
 * @example
 * // Using HGraph custom mirror node provider
 * const config = {
 *   network: 'mainnet',
 *   operatorId: '0.0.123',
 *   operatorPrivateKey: 'your-private-key',
 *   mirrorNode: {
 *     customUrl: 'https://mainnet.hedera.api.hgraph.dev/v1/<API-KEY>',
 *     apiKey: 'your-hgraph-api-key'
 *   }
 * };
 */
export interface HCSClientConfig {
    /** The Hedera network to connect to */
    network: NetworkType;
    /** The operator account ID */
    operatorId: string;
    /** The operator private key */
    operatorPrivateKey: string;
    /** The operator public key (optional) */
    operatorPublicKey?: string;
    /** Log level for the client */
    logLevel?: LogLevel;
    /** Whether to pretty print logs */
    prettyPrint?: boolean;
    /** Base URL for the guarded registry */
    guardedRegistryBaseUrl?: string;
    /** Default fee amount for HIP-991 fee payments */
    feeAmount?: number;
    /** Custom mirror node configuration */
    mirrorNode?: MirrorNodeConfig;
    /** Whether to run logger in silent mode */
    silent?: boolean;
    /** The key type to use for the operator */
    keyType?: 'ed25519' | 'ecdsa';
}
export interface Message {
    message: string;
    sequence_number?: number;
}
export interface ApiResponse {
    messages?: any[];
    links?: {
        next?: string;
    };
}
export interface RegistrationResponse {
    transaction: string;
    transaction_id: string;
}
export interface Topic {
    topicId: string;
    memo: string;
    adminKey: boolean;
    submitKey: boolean;
}
export interface CreateAgentResponse {
    inboundTopicId: string;
    outboundTopicId: string;
    pfpTopicId: string;
    profileTopicId: string;
}
export interface CreateMCPServerResponse {
    inboundTopicId: string;
    outboundTopicId: string;
    pfpTopicId: string;
    profileTopicId: string;
}
export interface CreateAccountResponse {
    accountId: string;
    privateKey: string;
}
export interface InscribePfpResponse {
    pfpTopicId: string;
    transactionId: string;
    success: boolean;
    error?: string;
}
export interface TransactMessage {
    operator_id: string;
    schedule_id: string;
    tx_id: string;
    data?: string;
    timestamp: number;
    memo?: string;
    sequence_number: number;
}
export interface StoreHCS11ProfileResponse {
    profileTopicId: string;
    pfpTopicId?: string;
    transactionId: string;
    success: boolean;
    error?: string;
}
export interface GetTopicsResponse {
    inboundTopic: string;
    outboundTopic: string;
}
export interface HandleConnectionRequestResponse {
    connectionTopicId: string;
    confirmedConnectionSequenceNumber: number;
    operatorId: string;
}
export interface WaitForConnectionConfirmationResponse {
    connectionTopicId: string;
    sequence_number: number;
    confirmedBy: string;
    memo: string;
}
export interface GetAccountAndSignerResponse {
    accountId: string;
    signer: PrivateKey;
}
export interface AgentRegistrationResult {
    success: boolean;
    error?: string;
    transactionId?: string;
    transaction?: string;
    confirmed?: boolean;
    state?: AgentCreationState;
    metadata?: {
        capabilities?: AIAgentCapability[];
        [key: string]: any;
    };
}
export interface AgentCreationState {
    pfpTopicId?: string;
    inboundTopicId?: string;
    outboundTopicId?: string;
    profileTopicId?: string;
    currentStage: 'init' | 'pfp' | 'topics' | 'profile' | 'registration' | 'complete';
    completedPercentage: number;
    error?: string;
    createdResources?: string[];
    agentMetadata?: Record<string, any>;
}
export interface MCPServerCreationState {
    pfpTopicId?: string;
    inboundTopicId?: string;
    outboundTopicId?: string;
    profileTopicId?: string;
    currentStage: 'init' | 'pfp' | 'topics' | 'profile' | 'registration' | 'complete';
    completedPercentage: number;
    error?: string;
    createdResources?: string[];
    serverMetadata?: Record<string, any>;
}
export type RegistrationResult = {
    transaction?: any;
    transactionId?: string;
    success: boolean;
    error?: string;
    validationErrors?: ValidationError[];
};
export interface RegistrationSearchOptions {
    tags?: AIAgentCapability[];
    accountId?: string;
    network?: string;
}
interface Registration {
    id: string;
    transactionId: string;
    status: 'pending' | 'success' | 'failed';
    network: string;
    accountId: string;
    inboundTopicId: string;
    outboundTopicId: string;
    operatorId: string;
    metadata: AIAgentProfile;
    registryTopicId: string;
    createdAt: string;
    updatedAt: string;
}
export interface RegistrationSearchResult {
    registrations: Registration[];
    error?: string;
    success: boolean;
}
export interface RegistrationsApiResponse {
    registrations: Registration[];
    transaction_id?: string;
    transaction?: string;
    error?: string;
    details?: ValidationError[];
}
export interface HCSMessage {
    p: 'hcs-10';
    op: 'connection_request' | 'connection_created' | 'message' | 'close_connection' | 'transaction' | 'register' | 'delete' | 'migrate' | 'connection_closed';
    data?: string;
    created?: Date;
    consensus_timestamp?: string;
    m?: string;
    payer: string;
    outbound_topic_id?: string;
    connection_request_id?: number;
    confirmed_request_id?: number;
    connection_topic_id?: string;
    connected_account_id?: string;
    requesting_account_id?: string;
    connection_id?: number;
    sequence_number: number;
    operator_id?: string;
    reason?: string;
    close_method?: string;
    schedule_id?: string;
    account_id?: string;
    uid?: string;
    t_id?: string;
}
export {};
//# sourceMappingURL=types.d.ts.map