@hashgraph/hedera-agent-kit 3.8.2-rc.1

package/dist/cjs/elizaos/index.d.ts

@@ -0,0 +1,354 @@
+import { Client } from '@hashgraph/sdk';
+import BigNumber from 'bignumber.js';
+import { z } from 'zod';
+import { Action, Handler, ActionExample, Validator } from '@elizaos/core';
+
+type TopicMessagesQueryParams = {
+    topicId: string;
+    lowerTimestamp: string;
+    upperTimestamp: string;
+    limit: number;
+};
+type TopicMessage = {
+    topicId: string;
+    message: string;
+    consensus_timestamp: string;
+};
+type TopicMessagesResponse = {
+    topicId: string;
+    messages: TopicMessage[];
+};
+type TopicInfo = {
+    topic_id?: string;
+    memo?: string | null;
+    admin_key?: {
+        _type?: string;
+        key?: string;
+    } | null;
+    submit_key?: {
+        _type?: string;
+        key?: string;
+    } | null;
+    auto_renew_account?: string | null;
+    auto_renew_period?: number | null;
+    created_timestamp?: string | null;
+    deleted?: boolean;
+    sequence_number?: number | null;
+    running_hash?: string | null;
+    running_hash_version?: number | null;
+};
+type TokenBalance = {
+    automatic_association: boolean;
+    created_timestamp: string;
+    token_id: string;
+    freeze_status: string;
+    kyc_status: string;
+    balance: number;
+    decimals: number;
+    symbol: string;
+};
+type TokenBalancesResponse = {
+    tokens: TokenBalance[];
+};
+type NftBalance = {
+    account_id: string;
+    created_timestamp: string;
+    delegating_spender: string | null;
+    deleted: boolean;
+    metadata: string;
+    modified_timestamp: string;
+    serial_number: number;
+    spender: string | null;
+    token_id: string;
+};
+type NftBalanceResponse = {
+    nfts: NftBalance[];
+    links: {
+        next: string | null;
+    };
+};
+type AccountResponse = {
+    accountId: string;
+    accountPublicKey: string;
+    balance: AccountBalanceResponse;
+    evmAddress: string;
+};
+type AccountBalanceResponse = {
+    balance: BigNumber;
+    timestamp: string;
+    tokens: TokenBalance[];
+};
+/**
+ * This type matches responses from Hedera Mirror Node API
+ */
+type TokenInfo = {
+    token_id?: string;
+    name: string;
+    symbol: string;
+    type?: string;
+    memo?: string;
+    decimals: string;
+    initial_supply?: string;
+    total_supply?: string;
+    max_supply?: string;
+    supply_type?: string;
+    treasury_account_id?: string;
+    auto_renew_account?: string;
+    auto_renew_period?: number;
+    deleted: boolean;
+    freeze_default?: boolean;
+    pause_status?: string;
+    created_timestamp?: string;
+    modified_timestamp?: string;
+    expiry_timestamp?: number;
+    admin_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    supply_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    kyc_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    freeze_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    wipe_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    pause_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    fee_schedule_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    metadata_key?: {
+        _type: string;
+        key: string;
+    } | null;
+    metadata?: string;
+    custom_fees?: {
+        created_timestamp: string;
+        fixed_fees: any[];
+        fractional_fees: any[];
+    };
+};
+type TransferData = {
+    account: string;
+    amount: number;
+    is_approval: boolean;
+};
+type TransactionData = {
+    batch_key: string | null;
+    bytes: string | null;
+    charged_tx_fee: number;
+    consensus_timestamp: string;
+    entity_id: string;
+    max_fee: string;
+    max_custom_fees: any[];
+    memo_base64: string;
+    name: string;
+    nft_transfers: any[];
+    node: string;
+    nonce: number;
+    parent_consensus_timestamp: string | null;
+    result: string;
+    scheduled: boolean;
+    staking_reward_transfers: any[];
+    token_transfers: any[];
+    transaction_hash: string;
+    transaction_id: string;
+    transfers: TransferData[];
+    valid_duration_seconds: string;
+    valid_start_timestamp: string;
+};
+type TransactionDetailsResponse = {
+    transactions: TransactionData[];
+};
+interface ContractInfo {
+    admin_key?: {
+        description?: string;
+        _type?: string;
+        example?: string;
+        key?: string;
+    } | null;
+    auto_renew_account?: string | null;
+    auto_renew_period?: number | null;
+    contract_id?: string | null;
+    created_timestamp?: string | null;
+    deleted?: boolean;
+    evm_address?: string;
+    expiration_timestamp?: string | null;
+    file_id?: string | null;
+    max_automatic_token_associations?: number | null;
+    memo?: string;
+    nonce?: number | null;
+    obtainer_id?: string | null;
+    permanent_removal?: boolean | null;
+    proxy_account_id?: string | null;
+    timestamp?: {
+        description?: string;
+        from: string;
+        to?: string | null;
+    };
+}
+type ExchangeRate = {
+    hbar_equivalent: number;
+    cent_equivalent: number;
+    expiration_time: number;
+};
+type ExchangeRateResponse = {
+    current_rate: ExchangeRate;
+    next_rate: ExchangeRate;
+    timestamp: string;
+};
+interface TokenAirdropsResponse {
+    airdrops: TokenAirdrop[];
+    links: Links;
+}
+interface TokenAirdrop {
+    amount: number;
+    receiver_id: string | null;
+    sender_id: string | null;
+    serial_number: number | null;
+    timestamp: TimestampRange;
+    token_id: string | null;
+}
+interface TimestampRange {
+    from: string;
+    to: string | null;
+}
+interface Links {
+    next: string | null;
+}
+interface TokenAllowanceResponse {
+    allowances: TokenAllowance[];
+    links: {
+        next: string | null;
+    };
+}
+interface TokenAllowance {
+    amount: number;
+    amount_granted: number;
+    owner: string;
+    spender: string;
+    timestamp: {
+        from: string;
+        to: string | null;
+    };
+    token_id: string;
+}
+interface ScheduledTransactionDetailsResponse {
+    admin_key?: {
+        _type?: string;
+        key?: string;
+    } | null;
+    deleted: boolean;
+    consensus_timestamp: string;
+    creator_account_id: string;
+    executed_timestamp: string | null;
+    expiration_time: string | null;
+    memo: string;
+    payer_account_id: string;
+    schedule_id: string;
+    signatures: Array<{
+        consensus_timestamp: string;
+        public_key_prefix: string;
+        signature: string;
+        type: string;
+    }>;
+    transaction_body: string;
+    wait_for_expiry: boolean;
+}
+
+interface IHederaMirrornodeService {
+    getAccount(accountId: string): Promise<AccountResponse>;
+    getAccountHbarBalance(accountId: string): Promise<BigNumber>;
+    getAccountTokenBalances(accountId: string, tokenId?: string): Promise<TokenBalancesResponse>;
+    getTopicMessages(queryParams: TopicMessagesQueryParams): Promise<TopicMessagesResponse>;
+    getTopicInfo(topicId: string): Promise<TopicInfo>;
+    getTokenInfo(tokenId: string): Promise<TokenInfo>;
+    getContractInfo(contractId: string): Promise<ContractInfo>;
+    getTransactionRecord(transactionId: string, nonce?: number): Promise<TransactionDetailsResponse>;
+    getExchangeRate(timestamp?: string): Promise<ExchangeRateResponse>;
+    getPendingAirdrops(accountId: string): Promise<TokenAirdropsResponse>;
+    getOutstandingAirdrops(accountId: string): Promise<TokenAirdropsResponse>;
+    getTokenAllowances(ownerAccountId: string, spenderAccountId: string): Promise<TokenAllowanceResponse>;
+    getAccountNfts(accountId: string): Promise<NftBalanceResponse>;
+    getScheduledTransactionDetails(scheduleId: string): Promise<ScheduledTransactionDetailsResponse>;
+    getBaseUrl(): string;
+}
+
+type Tool = {
+    method: string;
+    name: string;
+    description: string;
+    parameters: z.ZodObject<any, any>;
+    execute: (client: Client, context: Context, params: any) => Promise<any>;
+    outputParser?: (rawOutput: string) => {
+        raw: any;
+        humanMessage: string;
+    };
+};
+
+interface Plugin {
+    name: string;
+    version?: string;
+    description?: string;
+    tools: (context: Context) => Tool[];
+}
+
+declare enum AgentMode {
+    AUTONOMOUS = "autonomous",
+    RETURN_BYTES = "returnBytes"
+}
+type Context = {
+    accountId?: string;
+    accountPublicKey?: string;
+    mode?: AgentMode;
+    mirrornodeService?: IHederaMirrornodeService;
+};
+type Configuration = {
+    tools?: string[];
+    plugins?: Plugin[];
+    context?: Context;
+    mcpServers?: HederaMCPServer[];
+};
+declare enum HederaMCPServer {
+    HEDERION_MCP_MAINNET = "hederion-mcp-mainnet",
+    HGRAPH_MCP_MAINNET = "hgraph-mcp-mainnet"
+}
+
+declare class HederaAgentKitTool implements Action {
+    description: string;
+    handler: Handler;
+    similes?: string[] | undefined;
+    examples?: ActionExample[][] | undefined;
+    name: string;
+    validate: Validator;
+    constructor(client: Client, context: Context, tool: Tool);
+    [key: string]: unknown;
+}
+
+declare class HederaElizaOSToolkit {
+    private readonly tools;
+    private readonly client;
+    private readonly context;
+    constructor({ client, configuration }: {
+        client: Client;
+        configuration: Configuration;
+    });
+    /**
+     * Maps hedera-agent-kit tools and returns ElizaOS compatible actions
+     */
+    getTools(): HederaAgentKitTool[];
+}
+
+export { type Configuration, type Context, HederaElizaOSToolkit };