@ghostspeak/sdk 1.7.1 → 2.0.0

package/dist/minimal/core-minimal.d.ts

@@ -0,0 +1,444 @@
+import { Address } from '@solana/addresses';
+import { Rpc, GetLatestBlockhashApi, SendTransactionApi, GetAccountInfoApi, SimulateTransactionApi, GetFeeForMessageApi, GetProgramAccountsApi, GetEpochInfoApi, GetSignatureStatusesApi, GetMultipleAccountsApi, RpcSubscriptions, SignatureNotificationsApi, SlotNotificationsApi } from '@solana/kit';
+
+/**
+ * IPFS configuration and types for GhostSpeak SDK
+ */
+/**
+ * IPFS provider configuration
+ */
+interface IPFSProviderConfig {
+    /** Provider name */
+    name: 'pinata' | 'infura' | 'ipfs-http-client' | 'web3-storage' | 'custom' | 'test';
+    /** API endpoint URL */
+    endpoint?: string;
+    /** API key for authentication */
+    apiKey?: string;
+    /** API secret for authentication */
+    apiSecret?: string;
+    /** JWT token for authentication */
+    jwt?: string;
+    /** Custom headers */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+}
+/**
+ * IPFS client configuration
+ */
+interface IPFSConfig {
+    /** Primary provider */
+    provider: IPFSProviderConfig;
+    /** Fallback providers */
+    fallbackProviders?: IPFSProviderConfig[];
+    /** Default IPFS gateway for retrieving content */
+    gateway?: string;
+    /** Additional gateways for redundancy */
+    gateways?: string[];
+    /** Whether to automatically pin uploaded content */
+    autoPinning?: boolean;
+    /** Content size threshold for IPFS (bytes) - content above this will use IPFS */
+    sizeThreshold?: number;
+    /** Maximum retry attempts for failed operations */
+    maxRetries?: number;
+    /** Retry delay in milliseconds */
+    retryDelay?: number;
+    /** Enable caching of IPFS content */
+    enableCache?: boolean;
+    /** Cache TTL in milliseconds */
+    cacheTTL?: number;
+}
+
+type RpcApi = Rpc<GetLatestBlockhashApi & SendTransactionApi & GetAccountInfoApi & SimulateTransactionApi & GetFeeForMessageApi & GetProgramAccountsApi>;
+type ExtendedRpcApi = RpcApi & Rpc<GetEpochInfoApi & GetSignatureStatusesApi & GetMultipleAccountsApi>;
+type RpcSubscriptionApi = RpcSubscriptions<SignatureNotificationsApi & SlotNotificationsApi>;
+type Commitment = 'processed' | 'confirmed' | 'finalized';
+
+interface GhostSpeakConfig {
+    programId?: Address;
+    rpc: ExtendedRpcApi;
+    rpcSubscriptions?: RpcSubscriptionApi;
+    commitment?: Commitment;
+    transactionTimeout?: number;
+    defaultFeePayer?: Address;
+    retryConfig?: RetryConfig;
+    cluster?: 'mainnet-beta' | 'devnet' | 'testnet' | 'localnet';
+    rpcEndpoint?: string;
+    wsEndpoint?: string;
+    /** Token 2022 configuration options */
+    token2022?: Token2022Config;
+    /** IPFS configuration for large content storage */
+    ipfsConfig?: IPFSConfig;
+}
+interface Token2022Config {
+    /** Enable Token 2022 features by default */
+    enabled?: boolean;
+    /** Default behavior for transfer fees */
+    defaultExpectTransferFees?: boolean;
+    /** Maximum transfer fee slippage (basis points) */
+    maxFeeSlippageBasisPoints?: number;
+    /** Enable confidential transfers by default */
+    enableConfidentialTransfers?: boolean;
+    /** Default Token 2022 program address (for custom deployments) */
+    programAddress?: Address;
+    /** Cache token program detection results for this many seconds */
+    tokenProgramCacheTtl?: number;
+}
+interface RetryConfig {
+    maxRetries?: number;
+    baseDelay?: number;
+    maxDelay?: number;
+    backoffMultiplier?: number;
+    retryableErrors?: string[];
+}
+
+/**
+ * Main GhostSpeak client with fluent API design
+ *
+ * Example usage:
+ * ```typescript
+ * const ghostspeak = new GhostSpeak()
+ *
+ * // Create an agent
+ * const agent = await ghostspeak
+ *   .agent()
+ *   .create({ name: "My Agent", capabilities: ["coding"] })
+ *   .compressed()
+ *   .execute()
+ *
+ * // Create an escrow
+ * const escrow = await ghostspeak
+ *   .escrow()
+ *   .between(buyer, seller)
+ *   .amount(sol(10))
+ *   .withMilestones([...])
+ *   .execute()
+ * ```
+ */
+declare class GhostSpeak {
+    private config;
+    constructor(config?: Partial<GhostSpeakConfig>);
+    /**
+     * Agent operations
+     */
+    agent(): AgentBuilder;
+    /**
+     * Escrow operations
+     */
+    escrow(): EscrowBuilder;
+    /**
+     * Channel operations
+     */
+    channel(): ChannelBuilder;
+    /**
+     * Marketplace operations
+     */
+    marketplace(): MarketplaceBuilder;
+    /**
+     * Governance operations
+     */
+    governance(): GovernanceBuilder;
+    /**
+     * Token-2022 operations
+     */
+    token2022(): Token2022Builder;
+    /**
+     * Enable development mode features
+     */
+    enableDevMode(): this;
+    /**
+     * Configure network
+     */
+    useNetwork(cluster: 'mainnet-beta' | 'devnet' | 'testnet' | 'localnet'): this;
+    /**
+     * Configure custom RPC
+     */
+    useRpc(endpoint: string, wsEndpoint?: string): this;
+    /**
+     * Get default RPC endpoint for cluster
+     */
+    private getDefaultRpcEndpoint;
+}
+/**
+ * Agent builder for fluent API
+ */
+declare class AgentBuilder {
+    private module;
+    private params;
+    constructor(config: GhostSpeakConfig);
+    create(params: {
+        name: string;
+        capabilities: string[];
+    }): this;
+    withType(agentType: number): this;
+    withIPFS(): this;
+    compressed(): this;
+    debug(): this;
+    private validateParams;
+    getCost(): Promise<bigint>;
+    simulate(): Promise<unknown>;
+    explain(): Promise<string>;
+    execute(): Promise<{
+        address: Address;
+        signature: string;
+    }>;
+    private deriveAgentAddress;
+}
+/**
+ * Escrow builder for fluent API
+ */
+declare class EscrowBuilder {
+    private module;
+    private params;
+    constructor(config: GhostSpeakConfig);
+    between(buyer: Address, seller: Address): this;
+    amount(lamports: bigint): this;
+    description(desc: string): this;
+    withMilestones(milestones: Array<{
+        amount: bigint;
+        description: string;
+    }>): this;
+    debug(): this;
+    private validateParams;
+    getCost(): Promise<bigint>;
+    explain(): Promise<string>;
+    execute(): Promise<{
+        address: Address;
+        signature: string;
+    }>;
+    private deriveEscrowAddress;
+}
+/**
+ * Channel builder for fluent API
+ */
+declare class ChannelBuilder {
+    private module;
+    private params;
+    constructor(config: GhostSpeakConfig);
+    create(name: string): this;
+    description(desc: string): this;
+    private(): this;
+    maxMembers(max: number): this;
+    debug(): this;
+    private validateParams;
+    getCost(): Promise<bigint>;
+    explain(): Promise<string>;
+    execute(): Promise<{
+        address: Address;
+        signature: string;
+    }>;
+    private deriveChannelAddress;
+}
+declare class MarketplaceBuilder {
+    private config;
+    constructor(config: GhostSpeakConfig);
+}
+declare class GovernanceBuilder {
+    private config;
+    constructor(config: GhostSpeakConfig);
+}
+declare class Token2022Builder {
+    private config;
+    constructor(config: GhostSpeakConfig);
+}
+
+/**
+ * Comprehensive Type System for GhostSpeak SDK
+ *
+ * All types are exported as individual named exports using ES2015 module syntax
+ * for better tree-shaking and compatibility with ESLint rules.
+ */
+
+/**
+ * Agent entity
+ */
+interface Agent {
+    address: Address;
+    type: AgentType;
+    owner: Address;
+    metadata: AgentMetadata;
+    reputation: Reputation;
+    isActive: boolean;
+    isVerified: boolean;
+    createdAt: Date;
+}
+/**
+ * Agent types
+ */
+declare enum AgentType {
+    General = 0,
+    Specialized = 1,
+    Oracle = 2,
+    Validator = 3
+}
+/**
+ * Agent metadata
+ */
+interface AgentMetadata {
+    name: string;
+    description: string;
+    capabilities: string[];
+    avatar?: string;
+    website?: string;
+    socialLinks?: Record<string, string>;
+}
+/**
+ * Reputation data
+ */
+interface Reputation {
+    score: number;
+    jobsCompleted: number;
+    successRate: number;
+    totalEarnings: bigint;
+    ratings: Rating[];
+}
+/**
+ * Rating entry
+ */
+interface Rating {
+    from: Address;
+    score: number;
+    comment?: string;
+    timestamp: Date;
+}
+/**
+ * Escrow entity
+ */
+interface Escrow {
+    address: Address;
+    buyer: Address;
+    seller: Address;
+    amount: bigint;
+    status: EscrowStatus;
+    description: string;
+    milestones?: Milestone[];
+    createdAt: Date;
+    completedAt?: Date;
+}
+/**
+ * Escrow status
+ */
+declare enum EscrowStatus {
+    Active = "active",
+    Completed = "completed",
+    Cancelled = "cancelled",
+    Disputed = "disputed",
+    Refunded = "refunded"
+}
+/**
+ * Milestone for escrow
+ */
+interface Milestone {
+    amount: bigint;
+    description: string;
+    completed: boolean;
+    completedAt?: Date;
+}
+/**
+ * Channel entity
+ */
+interface Channel {
+    address: Address;
+    name: string;
+    description: string;
+    type: ChannelType;
+    creator: Address;
+    members: Address[];
+    isPrivate: boolean;
+    maxMembers: number;
+    messageCount: number;
+    createdAt: Date;
+}
+/**
+ * Channel types
+ */
+declare enum ChannelType {
+    Public = "public",
+    Private = "private",
+    Direct = "direct",
+    Group = "group"
+}
+/**
+ * SDK error with context
+ */
+interface SDKError {
+    code: ErrorCode;
+    message: string;
+    context?: Record<string, unknown>;
+    solution?: string;
+    instruction?: string;
+}
+/**
+ * Error codes
+ */
+declare enum ErrorCode {
+    NETWORK_ERROR = "NETWORK_ERROR",
+    RPC_ERROR = "RPC_ERROR",
+    TIMEOUT = "TIMEOUT",
+    INSUFFICIENT_BALANCE = "INSUFFICIENT_BALANCE",
+    TRANSACTION_FAILED = "TRANSACTION_FAILED",
+    SIMULATION_FAILED = "SIMULATION_FAILED",
+    ACCOUNT_NOT_FOUND = "ACCOUNT_NOT_FOUND",
+    INVALID_ACCOUNT = "INVALID_ACCOUNT",
+    UNAUTHORIZED = "UNAUTHORIZED",
+    INVALID_INPUT = "INVALID_INPUT",
+    INVALID_ADDRESS = "INVALID_ADDRESS",
+    INVALID_AMOUNT = "INVALID_AMOUNT",
+    PROGRAM_ERROR = "PROGRAM_ERROR",
+    INSTRUCTION_ERROR = "INSTRUCTION_ERROR",
+    UNKNOWN_ERROR = "UNKNOWN_ERROR"
+}
+
+/**
+ * Common utility functions for GhostSpeak SDK
+ */
+/**
+ * Convert SOL to lamports
+ */
+declare function sol(amount: number): bigint;
+
+/**
+ * Smart Error System with Actionable Solutions
+ *
+ * Every error includes context and suggested solutions to help developers
+ * quickly resolve issues.
+ */
+
+/**
+ * Base GhostSpeak error class
+ */
+declare class GhostSpeakError extends Error {
+    readonly code: ErrorCode;
+    readonly context: Record<string, unknown>;
+    readonly solution?: string;
+    readonly instruction?: string;
+    constructor(code: ErrorCode, message: string, context?: Record<string, unknown>, solution?: string, instruction?: string);
+    /**
+     * Format error for display
+     */
+    toString(): string;
+    /**
+     * Convert to SDK error type
+     */
+    toSDKError(): SDKError;
+}
+/**
+ * Network-related errors
+ */
+declare class NetworkError extends GhostSpeakError {
+    constructor(endpoint: string, originalError?: Error);
+}
+/**
+ * Insufficient balance error
+ */
+declare class InsufficientBalanceError extends GhostSpeakError {
+    constructor(required: bigint, available: bigint, address: Address);
+}
+/**
+ * Validation error for invalid inputs
+ */
+declare class ValidationError extends GhostSpeakError {
+    constructor(message: string, context?: Record<string, unknown>);
+}
+
+export { type Agent, AgentType, type Channel, ChannelType, type Escrow, EscrowStatus, type GhostSpeakConfig, GhostSpeakError, InsufficientBalanceError, NetworkError, type SDKError, ValidationError, GhostSpeak as default, sol };