@hashgraphonline/standards-sdk 0.0.41 → 0.0.43

package/dist/es/hcs-10/base-client.d.ts

@@ -1,9 +1,11 @@
-import { AccountResponse, HederaMirrorNode, TopicInfo } from '../services/mirror-node';
+import { HederaMirrorNode } from '../services/mirror-node';
 import { Logger, LogLevel } from '../utils/logger';
 import { Registration } from './registrations';
+import { AccountResponse, TopicInfo } from '../services/types';
 export interface HCS10Config {
     network: 'mainnet' | 'testnet';
     logLevel?: LogLevel;
+    prettyPrint?: boolean;
 }
 export interface HCSMessage {
     p: 'hcs-10';
@@ -26,7 +28,6 @@ export interface HCSMessage {
 export interface ProfileResponse {
     profile: any;
     topicInfo?: TopicInfo;
-    profileTopicId?: string;
     success: boolean;
     error?: string;
 }
@@ -47,8 +48,6 @@ export declare abstract class HCS10BaseClient extends Registration {
     }>;
     requestAccount(account: string): Promise<AccountResponse>;
     getAccountMemo(accountId: string): Promise<string | null>;
-    protected getTopicInfoFromMemo(memo: string): Promise<TopicInfo | null>;
-    getTopicInfo(accountId: string): Promise<TopicInfo | null>;
     retrieveProfile(accountId: string): Promise<ProfileResponse>;
     retrieveOutboundConnectTopic(accountId: string): Promise<TopicInfo>;
     retrieveOutboundMessages(agentAccountId: string): Promise<HCSMessage[]>;

package/dist/es/hcs-10/browser.d.ts

@@ -3,12 +3,13 @@ import { HashinalsWalletConnectSDK } from '@hashgraphonline/hashinal-wc';
 import { Logger, LogLevel } from '../utils/logger';
 import { RetrievedInscriptionResult } from '@kiloscribe/inscription-sdk';
 import { HCS10BaseClient } from './base-client';
-import { AgentConfig, RegistrationProgressCallback, AgentCreationState } from './types.d';
+import { AgentConfig, RegistrationProgressCallback, AgentCreationState, HandleConnectionRequestResponse, AgentRegistrationResult, StoreHCS11ProfileResponse, InscribePfpResponse, GetAccountAndSignerResponse } from './types.d';
 import { AgentBuilder } from './agent-builder';
 export type BrowserHCSClientConfig = {
     network: 'mainnet' | 'testnet';
     hwc: HashinalsWalletConnectSDK;
     logLevel?: LogLevel;
+    prettyPrint?: boolean;
     guardedRegistryTopicId?: string;
     guardedRegistryBaseUrl?: string;
 };
@@ -29,6 +30,15 @@ interface SocialLinks {
 export type BrowserAgentConfig = Omit<AgentConfig<BrowserHCSClient>, 'privateKey'> & {
     client: BrowserHCSClient;
 };
+export type RegisteredAgent = {
+    outboundTopicId: string;
+    inboundTopicId: string;
+    pfpTopicId: string;
+    profileTopicId: string;
+    error?: string;
+    success: boolean;
+    state: AgentCreationState;
+};
 export declare class BrowserHCSClient extends HCS10BaseClient {
     private hwc;
     protected logger: Logger;
@@ -49,28 +59,30 @@ export declare class BrowserHCSClient extends HCS10BaseClient {
         error?: string;
     }>;
     getPublicKey(accountId: string): Promise<PublicKey>;
-    handleConnectionRequest(inboundTopicId: string, requestingAccountId: string, connectionId: number, connectionMemo?: string): Promise<{
-        connectionTopicId: string;
-        confirmedConnectionSequenceNumber: number;
-        operatorId: string;
-    }>;
+    handleConnectionRequest(inboundTopicId: string, requestingAccountId: string, connectionId: number, connectionMemo?: string): Promise<HandleConnectionRequestResponse>;
     confirmConnection(inboundTopicId: string, connectionTopicId: string, connectedAccountId: string, connectionId: number, operatorId: string, memo: string): Promise<number>;
     submitMessage(topicId: string, content: string, metadata?: object, memo?: string): Promise<{
         result?: TransactionReceipt;
         error?: string;
     }>;
+    /**
+     * Creates an agent directly, but does not register.
+     * We highly recommend calling createAndRegisterAgent instead.
+     *
+     * @param pfpBuffer - The buffer containing the PFP image.
+     * @param pfpFileName - The name of the file containing the PFP image.
+     * @param agentName - The name of the agent.
+     * @param agentDescription - The description of the agent.
+     * @param capabilities - The capabilities of the agent.
+     * @param metadata - The metadata of the agent.
+     * @param existingPfpTopicId - The topic ID of the existing PFP.
+     * @param options - Optional configuration options.
+     * @returns A promise that resolves to the agent creation state.
+     */
     createAgent(pfpBuffer: Buffer, pfpFileName: string, agentName: string, agentDescription: string, capabilities: number[], metadata: AgentMetadata, existingPfpTopicId?: string, options?: {
         progressCallback?: RegistrationProgressCallback;
         existingState?: AgentCreationState;
-    }): Promise<{
-        outboundTopicId: string;
-        inboundTopicId: string;
-        pfpTopicId: string;
-        profileTopicId: string;
-        error?: string;
-        success: boolean;
-        state: AgentCreationState;
-    }>;
+    }): Promise<RegisteredAgent>;
     private initializeRegistrationState;
     private updateStateForCompletedRegistration;
     registerAgentWithGuardedRegistry(accountId: string, network?: string, options?: {
@@ -78,31 +90,17 @@ export declare class BrowserHCSClient extends HCS10BaseClient {
         maxAttempts?: number;
         delayMs?: number;
         existingState?: AgentCreationState;
-    }): Promise<{
-        error?: string;
-        success: boolean;
-        transaction?: any;
-        transactionId?: string;
-        confirmed?: boolean;
-        validationErrors?: any[];
-        state: AgentCreationState;
-    }>;
+    }): Promise<AgentRegistrationResult>;
     createAndRegisterAgent(builder: AgentBuilder, options?: {
         progressCallback?: RegistrationProgressCallback;
         maxAttempts?: number;
         delayMs?: number;
         existingState?: AgentCreationState;
-    }): Promise<BrowserAgentConfig & {
-        state: AgentCreationState;
-    }>;
+        baseUrl?: string;
+    }): Promise<AgentRegistrationResult>;
     storeHCS11Profile(agentName: string, agentDescription: string, inboundTopicId: string, outboundTopicId: string, capabilities?: number[], metadata?: Record<string, any>, pfpBuffer?: Buffer, pfpFileName?: string, existingPfpTopicId?: string, options?: {
         progressCallback?: RegistrationProgressCallback;
-    }): Promise<{
-        profileTopicId: string;
-        pfpTopicId?: string;
-        error?: string;
-        success: boolean;
-    }>;
+    }): Promise<StoreHCS11ProfileResponse>;
     createTopic(memo: string, adminKey?: boolean, submitKey?: boolean): Promise<{
         success: boolean;
         topicId?: string;
@@ -110,16 +108,17 @@ export declare class BrowserHCSClient extends HCS10BaseClient {
     }>;
     private submitPayload;
     inscribeFile(buffer: Buffer, fileName: string): Promise<RetrievedInscriptionResult>;
-    getAccountAndSigner(): {
-        accountId: string;
-        signer: any;
-    };
+    getAccountAndSigner(): GetAccountAndSignerResponse;
+    /**
+     * Inscribes a profile picture (PFP) on HCS-11.
+     *
+     * @param buffer - The buffer containing the PFP image.
+     * @param fileName - The name of the file containing the PFP image.
+     * @param options - Optional configuration options.
+     * @returns A promise that resolves to the topic ID of the inscribed PFP.
+     */
     inscribePfp(buffer: Buffer, fileName: string, options?: {
         progressCallback?: RegistrationProgressCallback;
-    }): Promise<{
-        pfpTopicId: string;
-        success: boolean;
-        error?: string;
-    }>;
+    }): Promise<InscribePfpResponse>;
 }
 export {};

package/dist/es/hcs-10/registrations.d.ts

@@ -64,8 +64,44 @@ export interface RegistrationStatusResponse {
     error?: string;
 }
 export declare abstract class Registration {
+    /**
+     * Checks the status of a registration request.
+     *
+     * @param transactionId - The transaction ID of the registration.
+     * @param network - The network to use for the registration.
+     * @param baseUrl - The base URL of the guarded registry.
+     * @param logger - The logger to use for logging.
+     * @returns A promise that resolves to the registration status response.
+     */
     protected checkRegistrationStatus(transactionId: string, network: string, baseUrl: string, logger?: Logger): Promise<RegistrationStatusResponse>;
+    /**
+     * Waits for a registration to be confirmed.
+     *
+     * @param transactionId - The transaction ID of the registration.
+     * @param network - The network to use for the registration.
+     * @param baseUrl - The base URL of the guarded registry.
+     * @param maxAttempts - The maximum number of attempts to check the registration status.
+     * @param delayMs - The delay in milliseconds between attempts.
+     * @param logger - The logger to use for logging.
+     * @returns A promise that resolves to true if the registration is confirmed, false otherwise.
+     */
     waitForRegistrationConfirmation(transactionId: string, network: string, baseUrl: string, maxAttempts?: number, delayMs?: number, logger?: Logger): Promise<boolean>;
+    /**
+     * Executes a registration request for an agent.
+     *
+     * @param accountId - The account ID of the agent to register.
+     * @param network - The network to use for the registration.
+     * @param baseUrl - The base URL of the guarded registry.
+     * @param logger - The logger to use for logging.
+     * @returns A promise that resolves to the registration result.
+     */
     executeRegistration(accountId: string, network?: string, baseUrl?: string, logger?: Logger): Promise<RegistrationResult>;
+    /**
+     * Finds registrations based on the provided options.
+     *
+     * @param options - The options for searching registrations.
+     * @param baseUrl - The base URL of the guarded registry.
+     * @returns A promise that resolves to the registration search result.
+     */
     findRegistrations(options?: RegistrationSearchOptions, baseUrl?: string): Promise<RegistrationSearchResult>;
 }

package/dist/es/hcs-10/sdk.d.ts

@@ -83,7 +83,7 @@ export declare class HCS10Client extends HCS10BaseClient {
      * @param pfpFileName Optional profile picture filename
      * @returns Response with topic IDs and transaction ID
      */
-    storeHCS11Profile(agentName: string, agentDescription: string, inboundTopicId: string, outboundTopicId: string, capabilities: number[], metadata: AgentMetadata, pfpBuffer?: Buffer, pfpFileName?: string): Promise<StoreHCS11ProfileResponse>;
+    storeHCS11Profile(agentName: string, agentDescription: string, inboundTopicId: string, outboundTopicId: string, capabilities: number[], metadata: AgentMetadata, pfpBuffer?: Buffer, pfpFileName?: string, existingPfpTopicId?: string): Promise<StoreHCS11ProfileResponse>;
     private setupFees;
     /**
      * Handles a connection request from another account

package/dist/es/hcs-11/index.d.ts

@@ -2,6 +2,7 @@ import { AccountId, Client, Signer } from '@hashgraph/sdk';
 import { LogLevel } from '../utils/logger';
 import { DAppSigner } from '@hashgraph/hedera-wallet-connect';
 import { RegistrationProgressCallback } from '../hcs-10/types.d';
+import { TopicInfo } from '../services/types';
 export declare enum ProfileType {
     PERSONAL = 0,
     AI_AGENT = 1
@@ -114,6 +115,7 @@ export declare class HCS11Client {
     private auth;
     private network;
     private logger;
+    private mirrorNode;
     constructor(config: HCS11ClientConfig);
     getClient(): Client;
     getOperatorId(): string;
@@ -149,16 +151,40 @@ export declare class HCS11Client {
     inscribeImage(buffer: Buffer, fileName: string, options?: InscribeImageOptions): Promise<InscribeImageResponse>;
     inscribeProfile(profile: HCS11Profile, options?: InscribeProfileOptions): Promise<InscribeProfileResponse>;
     updateAccountMemoWithProfile(accountId: string | AccountId, profileTopicId: string): Promise<TransactionResult>;
+    /**
+     * Creates and inscribes a profile.
+     *
+     * @param profile - The profile to create and inscribe.
+     * @param updateAccountMemo - Whether to update the account memo with the profile.
+     * @param options - Optional configuration options.
+     * @returns A promise that resolves to the inscription result.
+     */
     createAndInscribeProfile(profile: HCS11Profile, updateAccountMemo?: boolean, options?: InscribeProfileOptions): Promise<InscribeProfileResponse>;
+    /**
+     * Gets the capabilities from the capability names.
+     *
+     * @param capabilityNames - The capability names to get the capabilities for.
+     * @returns The capabilities.
+     */
     getCapabilitiesFromTags(capabilityNames: string[]): Promise<number[]>;
+    /**
+     * Gets the agent type from the metadata.
+     *
+     * @param metadata - The metadata of the agent.
+     * @returns The agent type.
+     */
     getAgentTypeFromMetadata(metadata: AIAgentMetadata): AIAgentType;
+    /**
+     * Fetches a profile from the account memo.
+     *
+     * @param accountId - The account ID of the agent to fetch the profile for.
+     * @param network - The network to use for the fetch.
+     * @returns A promise that resolves to the profile.
+     */
     fetchProfileByAccountId(accountId: string | AccountId, network?: string): Promise<{
         success: boolean;
         profile?: HCS11Profile;
         error?: string;
-        topicInfo?: {
-            inboundTopicId?: string;
-            outboundTopicId?: string;
-        };
+        topicInfo?: TopicInfo;
     }>;
 }

package/dist/es/index.d.ts

@@ -5,5 +5,3 @@ export * from './hcs-11';
 export * from './utils';
 export * from './inscribe';
 export * from './services';
-export declare const isBrowser: boolean;
-export declare const isServer: boolean;

package/dist/es/inscribe/types.d.ts

@@ -7,8 +7,6 @@ export interface RetrievedInscriptionResult extends SDKRetrievedInscriptionResul
     url?: string;
     metadata?: Record<string, unknown>;
     message?: string;
-    messages_processed?: number;
-    total_messages?: number;
 }
 export type { HederaClientConfig };
 export interface AuthConfig {

package/dist/es/services/mirror-node.d.ts

@@ -1,146 +1,20 @@
 import { PublicKey } from '@hashgraph/sdk';
 import { Logger } from '../utils/logger';
 import { HCSMessage } from '../hcs-10/base-client';
-export interface Balance {
-    balance: number;
-    timestamp: string;
-    tokens: TokenBalance[];
-}
-export interface TokenBalance {
-    token_id: string;
-    balance: number;
-}
-export interface Key {
-    _type: string;
-    key: string;
-}
-export interface AccountResponse {
-    account: string;
-    alias: string;
-    auto_renew_period: number;
-    balance: Balance;
-    created_timestamp: string;
-    decline_reward: boolean;
-    deleted: boolean;
-    ethereum_nonce: number;
-    evm_address: string;
-    expiry_timestamp: string;
-    key: Key;
-    max_automatic_token_associations: number;
-    memo: string;
-    pending_reward: number;
-    receiver_sig_required: boolean;
-    staked_account_id: string | null;
-    staked_node_id: string | null;
-    stake_period_start: string | null;
-    transactions: Transaction[];
-    links: Links;
-}
-export interface Transaction {
-    bytes: string | null;
-    charged_tx_fee: number;
-    consensus_timestamp: string;
-    entity_id: string | null;
-    max_fee: string;
-    memo_base64: string;
-    name: string;
-    nft_transfers: NftTransfer[];
-    node: string;
-    nonce: number;
-    parent_consensus_timestamp: string | null;
-    result: string;
-    scheduled: boolean;
-    staking_reward_transfers: Transfer[];
-    token_transfers: TokenTransfer[];
-    transaction_hash: string;
-    transaction_id: string;
-    transfers: Transfer[];
-    valid_duration_seconds: string;
-    valid_start_timestamp: string;
-}
-export interface Transfer {
-    account: string;
-    amount: number;
-    is_approval: boolean;
-}
-export interface TokenTransfer {
-    token_id: string;
-    account: string;
-    amount: string;
-    is_approval: boolean;
-}
-export interface NftTransfer {
-    receiver_account_id: string;
-    sender_account_id: string;
-    serial_number: number;
-    is_approval: boolean;
-}
-export interface Links {
-    next: string;
-}
-export type NetworkType = 'mainnet' | 'testnet';
-export interface TopicInfo {
-    inboundTopic: string;
-    outboundTopic: string;
-}
-export interface TopicMessage {
-    consensus_timestamp: string;
-    topic_id: string;
-    message: string;
-    sequence_number: number;
-    running_hash: string;
-    running_hash_version: number;
-    payer_account_id: string;
-}
-export interface TopicMessagesResponse {
-    messages: TopicMessage[];
-    links: {
-        next?: string;
-    };
-}
-export interface TopicResponse {
-    admin_key: Key;
-    auto_renew_account: string;
-    auto_renew_period: number;
-    created_timestamp: string;
-    custom_fees: CustomFees;
-    deleted: boolean;
-    fee_exempt_key_list: Key[];
-    fee_schedule_key: Key;
-    memo: string;
-    submit_key: Key;
-    timestamp: Timestamp;
-    topic_id: string;
-}
-export interface Key {
-    _type: string;
-    key: string;
-}
-export interface CustomFees {
-    created_timestamp: string;
-    fixed_fees: FixedFee[];
-}
-export interface FixedFee {
-    amount: number;
-    collector_account_id: string;
-    denominating_token_id: string;
-}
-export interface Timestamp {
-    from: string;
-    to: string;
-}
+import { AccountResponse, CustomFees, NetworkType, TopicResponse } from './types';
 export declare class HederaMirrorNode {
     private network;
     private baseUrl;
-    private logger?;
+    private logger;
     private isServerEnvironment;
-    constructor(network: NetworkType, logger?: Logger);
+    constructor(network: NetworkType, logger: Logger);
     private getMirrorNodeUrl;
     getBaseUrl(): string;
     getPublicKey(accountId: string): Promise<PublicKey>;
     getAccountMemo(accountId: string): Promise<string | null>;
     getTopicInfo(topicId: string): Promise<TopicResponse>;
     getTopicFees(topicId: string): Promise<CustomFees | null>;
+    getHBARPrice(date: Date): Promise<number | null>;
     getTopicMessages(topicId: string): Promise<HCSMessage[]>;
     requestAccount(accountId: string): Promise<AccountResponse>;
     checkKeyListAccess(keyBytes: Buffer, userPublicKey: PublicKey): Promise<boolean>;

package/dist/es/services/types.d.ts

@@ -0,0 +1,139 @@
+export interface Balance {
+    balance: number;
+    timestamp: string;
+    tokens: TokenBalance[];
+}
+export interface TokenBalance {
+    token_id: string;
+    balance: number;
+}
+export interface Key {
+    _type: string;
+    key: string;
+}
+export interface AccountResponse {
+    account: string;
+    alias: string;
+    auto_renew_period: number;
+    balance: Balance;
+    created_timestamp: string;
+    decline_reward: boolean;
+    deleted: boolean;
+    ethereum_nonce: number;
+    evm_address: string;
+    expiry_timestamp: string;
+    key: Key;
+    max_automatic_token_associations: number;
+    memo: string;
+    pending_reward: number;
+    receiver_sig_required: boolean;
+    staked_account_id: string | null;
+    staked_node_id: string | null;
+    stake_period_start: string | null;
+    transactions: Transaction[];
+    links: Links;
+}
+export interface Transaction {
+    bytes: string | null;
+    charged_tx_fee: number;
+    consensus_timestamp: string;
+    entity_id: string | null;
+    max_fee: string;
+    memo_base64: string;
+    name: string;
+    nft_transfers: NftTransfer[];
+    node: string;
+    nonce: number;
+    parent_consensus_timestamp: string | null;
+    result: string;
+    scheduled: boolean;
+    staking_reward_transfers: Transfer[];
+    token_transfers: TokenTransfer[];
+    transaction_hash: string;
+    transaction_id: string;
+    transfers: Transfer[];
+    valid_duration_seconds: string;
+    valid_start_timestamp: string;
+}
+export interface Transfer {
+    account: string;
+    amount: number;
+    is_approval: boolean;
+}
+export interface TokenTransfer {
+    token_id: string;
+    account: string;
+    amount: string;
+    is_approval: boolean;
+}
+export interface NftTransfer {
+    receiver_account_id: string;
+    sender_account_id: string;
+    serial_number: number;
+    is_approval: boolean;
+}
+export interface Links {
+    next: string;
+}
+export type NetworkType = 'mainnet' | 'testnet';
+export interface TopicInfo {
+    inboundTopic: string;
+    outboundTopic: string;
+    profileTopicId: string;
+}
+export interface TopicMessage {
+    consensus_timestamp: string;
+    topic_id: string;
+    message: string;
+    sequence_number: number;
+    running_hash: string;
+    running_hash_version: number;
+    payer_account_id: string;
+}
+export interface TopicMessagesResponse {
+    messages: TopicMessage[];
+    links: {
+        next?: string;
+    };
+}
+export interface TopicResponse {
+    admin_key: Key;
+    auto_renew_account: string;
+    auto_renew_period: number;
+    created_timestamp: string;
+    custom_fees: CustomFees;
+    deleted: boolean;
+    fee_exempt_key_list: Key[];
+    fee_schedule_key: Key;
+    memo: string;
+    submit_key: Key;
+    timestamp: Timestamp;
+    topic_id: string;
+}
+export interface Key {
+    _type: string;
+    key: string;
+}
+export interface CustomFees {
+    created_timestamp: string;
+    fixed_fees: FixedFee[];
+}
+export interface FixedFee {
+    amount: number;
+    collector_account_id: string;
+    denominating_token_id: string;
+}
+export interface Timestamp {
+    from: string;
+    to: string;
+}
+export interface TRate {
+    cent_equivalent: number;
+    expiration_time: number;
+    hbar_equivalent: number;
+}
+export interface HBARPrice {
+    current_rate: TRate;
+    next_rate: TRate;
+    timestamp: string;
+}