@blockrun/llm 3.20.1 → 3.22.0

package/dist/index.d.ts

@@ -184,6 +184,53 @@ interface Tool {
     type: "function";
     function: FunctionDefinition;
 }
+/**
+ * xAI's server-side X search, for xai/* models. The gateway runs it on xAI's
+ * Responses API; billed per X post fetched. https://docs.x.ai/developers/tools/x-search
+ */
+interface XSearchTool {
+    type: "x_search";
+    /** Only these handles (≤20, without "@"). Not together with excludedXHandles. */
+    allowedXHandles?: string[];
+    /** Never these handles (≤20). Not together with allowedXHandles. */
+    excludedXHandles?: string[];
+    /** YYYY-MM-DD, inclusive. */
+    fromDate?: string;
+    /** YYYY-MM-DD, inclusive. */
+    toDate?: string;
+    enableImageUnderstanding?: boolean;
+    enableVideoUnderstanding?: boolean;
+}
+/** xAI's server-side web search, for xai/* models. */
+interface WebSearchTool {
+    type: "web_search";
+    /** ≤5 domains. */
+    allowedDomains?: string[];
+    excludedDomains?: string[];
+    enableImageUnderstanding?: boolean;
+}
+/** Anything `tools` accepts: function tools, plus xAI's search tools on xai/* models. */
+type AnyTool = Tool | XSearchTool | WebSearchTool;
+/** A URL citation with its position in the answer text (xAI search). */
+interface UrlCitation {
+    type: "url_citation";
+    url: string;
+    title?: string;
+    start_index?: number;
+    end_index?: number;
+}
+/** How a paid call settled — see `ChatResponse.settlement`. */
+interface Settlement {
+    /** `exact`: one transfer at the quote. `batch`: metered from a payment channel. */
+    scheme: "exact" | "batch" | "free" | "api-key";
+    /** What was signed or authorised for this call, in USD. */
+    quotedUsd: number;
+    /** On-chain transaction (signature / hash), when the gateway reported one. */
+    transaction?: string;
+    network?: string;
+    /** Present and false only when the gateway reported a failed settlement. */
+    success?: false;
+}
 interface FunctionCall {
     name: string;
     arguments: string;
@@ -207,6 +254,8 @@ interface ChatMessage {
     tool_calls?: ToolCall[];
     reasoning_content?: string;
     thinking?: string;
+    /** URL citations with positions (xAI search answers). */
+    annotations?: UrlCitation[];
 }
 interface ChatChoice {
     index: number;
@@ -220,6 +269,11 @@ interface ChatUsage {
     num_sources_used?: number;
     cache_read_input_tokens?: number;
     cache_creation_input_tokens?: number;
+    /**
+     * xAI search usage counts: x_search_calls, x_posts_fetched, x_users_fetched,
+     * web_search_calls … (what xAI bills the search by).
+     */
+    server_side_tool_usage?: Record<string, number | undefined>;
 }
 interface ChatResponse {
     id: string;
@@ -229,6 +283,20 @@ interface ChatResponse {
     choices: ChatChoice[];
     usage?: ChatUsage;
     citations?: string[];
+    /** xAI search: the searches the model ran (`{type, query, status}`). */
+    search_calls?: Array<{
+        type: string;
+        query?: string;
+        status?: string;
+    }>;
+    /**
+     * What this call cost you, in USD: the metered charge under batch
+     * settlement, the signed price under exact, 0 for a free call. Undefined in
+     * API-key mode (billed to the account, see the dashboard).
+     */
+    costUsd?: number;
+    /** How the call was paid, with the on-chain transaction when reported. */
+    settlement?: Settlement;
     /**
      * Populated when the gateway transparently substituted a different
      * model for the one the caller asked for — typically because the
@@ -320,13 +388,19 @@ interface WebSearchSource {
     excludedWebsites?: string[];
     allowedWebsites?: string[];
     safeSearch?: boolean;
+    enableImageUnderstanding?: boolean;
 }
 interface XSearchSource {
     type: "x";
+    /** ≤20 handles. Not together with excludedXHandles. */
     includedXHandles?: string[];
     excludedXHandles?: string[];
+    /** Accepted for compatibility; xAI's x_search has no such filter. */
     postFavoriteCount?: number;
+    /** Accepted for compatibility; xAI's x_search has no such filter. */
     postViewCount?: number;
+    enableImageUnderstanding?: boolean;
+    enableVideoUnderstanding?: boolean;
 }
 interface NewsSearchSource {
     type: "news";
@@ -347,6 +421,8 @@ interface SearchParameters {
     fromDate?: string;
     toDate?: string;
     maxSearchResults?: number;
+    /** Agentic search rounds xAI may run (1–10; gateway default 4). Bounds the per-post bill. */
+    maxTurns?: number;
 }
 /** Usage info for Live Search sources */
 interface SearchUsage {
@@ -412,6 +488,8 @@ interface PaymentRequired {
     x402Version: number;
     accepts: PaymentRequirement[];
     resource?: ResourceInfo;
+    /** x402 v2 extensions the gateway declares, keyed by extension name. */
+    extensions?: Record<string, unknown>;
 }
 interface LLMClientOptions extends ApiKeyOptions {
     /** EVM wallet private key (hex string starting with 0x). Optional if BASE_CHAIN_WALLET_KEY env var is set. */
@@ -470,8 +548,8 @@ interface ChatCompletionOptions {
     search?: boolean;
     /** Full Live Search configuration (for search-enabled models) */
     searchParameters?: SearchParameters;
-    /** Tool definitions for function calling */
-    tools?: Tool[];
+    /** Tool definitions: function tools, plus x_search / web_search on xai/* models */
+    tools?: AnyTool[];
     /** Tool selection strategy */
     toolChoice?: ToolChoice;
     /** Response format, e.g. { type: "json_object" } for JSON mode */
@@ -484,6 +562,12 @@ interface ChatCompletionOptions {
      * immediately.
      */
     fallbackModels?: string[];
+    /**
+     * Per-call timeout in ms, overriding the client's `timeout` for every request
+     * of this call (both `LLMClient` and `SolanaLLMClient`). Search and long
+     * reasoning calls can need more than the 60 s default.
+     */
+    timeout?: number;
 }
 type RoutingProfile = "eco" | "auto" | "premium";
 type RoutingTier = Tier;
@@ -1379,6 +1463,9 @@ declare class LLMClient {
     /**
      * Parse a response to a request that carried no payment: the free tier,
      * or, with an API key, the billed request itself.
+     *
+     * With a wallet nothing was paid, so `costUsd` is 0 (a free model). With an
+     * API key the call is billed to the account and `costUsd` stays undefined.
      */
     private parseUnpaidChatResponse;
     /**
@@ -1426,7 +1513,7 @@ declare class LLMClient {
      */
     private handleGetPaymentAndRetryRaw;
     /**
-     * Fetch with timeout.
+     * Fetch with timeout: `timeoutMs` (a per-call override), else the client's `timeout`.
      */
     private fetchWithTimeout;
     /**
@@ -2808,7 +2895,8 @@ interface SolanaBatchOptions {
      * payment, one that proves nothing was broadcast with a new payment. Other
      * calls for the same wallet wait out the same cooldown instead of sending
      * new channel opens; that shared cooldown never lasts longer than
-     * `maxWaitMs`.
+     * `maxWaitMs`. A payment carrying a payment identifier is replayed within
+     * {@link inDoubt} instead.
      */
     rateLimit?: {
         /** Batch payment attempts per call, the first one included. Default 3. */
@@ -2816,6 +2904,29 @@ interface SolanaBatchOptions {
         /** Most time, in ms, one call spends waiting on 429s before it pays `exact`. Default 60000. */
         maxWaitMs?: number;
     };
+    /**
+     * How long a call keeps replaying a batch payment in doubt that carries a
+     * payment identifier (the gateway's 402 declares the x402
+     * `payment-identifier` extension) before it raises
+     * {@link BatchPaymentUnresolvedError}. The identical payment is replayed
+     * while the gateway's answer says a later replay can succeed: no answer
+     * (a timeout, an abort, a network error), a 5xx, a 429, or a 409 with a
+     * `Retry-After` (the request is still running). Each wait is
+     * `Retry-After`, else 1s, 2s, 4s... with jitter, and never under 1 s nor
+     * over 30 s. Replays do not count against {@link rateLimit}.
+     */
+    inDoubt?: {
+        /**
+         * Most time, in ms, one call spends replaying a payment in doubt,
+         * counted from the first answer that left it in doubt: every wait and
+         * every replay's own round trip. It decides whether another replay
+         * starts: a wait that would end past it is not started, and the call
+         * raises. A replay already sent runs until its answer or the client's
+         * `timeout`, so a call can end up to one `timeout` past it. `0` never
+         * replays. Default 300000 (5 min).
+         */
+        maxWaitMs?: number;
+    };
     /**
      * Called for every batch fallback, 429 backoff, recovery and channel
      * re-read, in addition to the one-line log the SDK writes to stderr for each.
@@ -2829,15 +2940,27 @@ declare const DEFAULT_BATCH_RATE_LIMIT: {
     readonly maxAttempts: 3;
     readonly maxWaitMs: 60000;
 };
+/** Default {@link SolanaBatchOptions.inDoubt}. */
+declare const DEFAULT_BATCH_IN_DOUBT: {
+    readonly maxWaitMs: 300000;
+};
 /**
  * One observable batch-settlement event.
  *
  * - `fallback`: this call pays with `exact`. `reason` says why. Only ever
- *   when no batch payment of this call can have been charged.
+ *   when no batch payment of this call can have been charged. After the
+ *   facilitator refuses a deposit before broadcasting it (`payment_required`
+ *   with one of PayAI's `batch_*` admission codes as `errorReason`), the
+ *   wallet's calls skip batch for `retryAfterMs` (`Retry-After`, else 60s,
+ *   or 10 min for a refusal of the deposit's own terms) and report
+ *   `admission_refused`, naming the same code, without sending a payment.
  * - `backoff`: this call is waiting before it retries batch, after a 429
  *   (`reason: "rate_limited"`) or because another call for the wallet hit one
- *   (`reason: "cooldown"`).
- * - `recovered`: a call that backed off was then paid with batch, or its
+ *   (`reason: "cooldown"`), or before each replay of a payment in doubt that
+ *   carries a payment identifier (`reason: "in_doubt"`, or `rate_limited`
+ *   after a 429), with the answer's `status` and the wait in `retryAfterMs`.
+ * - `recovered`: a call that backed off was then paid with batch (`reason:
+ *   "in_doubt"` when the replay of a payment in doubt resolved it), or its
  *   fresh challenge after the wait was served without a payment (`reason:
  *   "served_unpaid_on_rechallenge"`: that response is the call's result, and
  *   nothing was paid).
@@ -2857,10 +2980,11 @@ interface SolanaBatchEvent {
      * A short, stable code: `rate_limited`, `cooldown`, `not_offered`,
      * `client_signed_not_supported`, `channel_busy`, `untrusted_operator`, `deposit_over_cap`,
      * `channel_pending`, `closed_during_call`, `peer_dependency_missing`, `payment_creation_failed`,
-     * `wallet_config_conflict`, `channel_store_locked`, `payment_required`,
+     * `wallet_config_conflict`, `channel_store_locked`, `payment_required`, `admission_refused`,
      * `channel_resync_pending`, `channel_resync_failed`, `channel_unreadable`,
      * `deposit_journal_unreadable`, `deposit_journal_failed`,
-     * `served_unpaid_on_rechallenge` or `batch_cancelled` (`recovered` events), or one of the gateway's refusal codes the
+     * `served_unpaid_on_rechallenge` or `batch_cancelled` (`recovered` events), `in_doubt` (`backoff` and `recovered`
+     * events), or one of the gateway's refusal codes the
      * SDK recognises (`batch_payer_not_allowed`, `batch_payer_not_admitted`,
      * `batch_admission_paused`, `batch_server_signed_only`, `batch_unavailable`,
      * `batch_channel_limit`, `PAYMENT_VERIFICATION_UNAVAILABLE`). An `unresolved` event's reason is a
@@ -2893,7 +3017,7 @@ interface SolanaBatchStats {
     fallbacksByReason: Record<string, number>;
     /** Waits before a batch retry (own 429s and shared cooldowns). */
     backoffs: number;
-    /** Batch payments sent again after a 429: a new payment, or the one replay of a receipt-less 429. */
+    /** Batch payments sent again: a new payment after a 429, or each replay of a payment in doubt. */
     retries: number;
     /**
      * Calls paid with batch after at least one backoff, or served without a
@@ -2913,10 +3037,15 @@ interface SolanaBatchStats {
 /**
  * Why a batch payment is left in doubt; see {@link BatchPaymentUnresolvedError}.
  *
- * - `replay_unresolved`: a 429 without a receipt. Its one byte-identical
- *   replay got no definitive success receipt (a 402, `duplicate_settlement`,
- *   another 429, a 5xx, a timeout...), or `batch.rateLimit` left no room to
- *   replay it.
+ * - `replay_unresolved`: a 429 without a receipt, whose one byte-identical
+ *   replay got no definitive success receipt (a 402,
+ *   `duplicate_settlement`, another 429, a 5xx, a timeout...), or a payment
+ *   carrying a payment identifier whose replays got none: the last one was
+ *   answered with something no later replay can change (a 409 without
+ *   `Retry-After`, a 402, a 2xx without a receipt the SDK can verify...),
+ *   or `batch.inDoubt.maxWaitMs` ran out. A 429 without a receipt keeps
+ *   this reason when there is no room to replay it; any other doubt keeps
+ *   its own reason.
  * - `ambiguous_rate_limit`: a 429 whose receipt does not prove nothing was
  *   broadcast (one that says it was charged, `settlement_pending`, or one
  *   naming a transaction).
@@ -2978,7 +3107,8 @@ declare class BatchPaymentUnresolvedError extends PaymentError {
  * `closeBatchChannel()` did not close anything, and should be called again
  * later:
  * - `call_in_flight`: a batch call for the wallet is still running (it may
- *   be waiting out a 429 before its retry or replay);
+ *   be waiting out a 429 before its retry or replay, or between the replays
+ *   of a payment in doubt);
  * - `deposit_in_doubt`: a deposit the wallet sent (an open or top-up) has
  *   not been settled yet. It settles once a `finalized` chain read shows it
  *   landed, or once the finalized chain is past its last valid block,
@@ -3158,7 +3288,9 @@ declare class SolanaLLMClient {
      *
      * @returns USDC balance as a float
      */
-    getBalance(): Promise<number>;
+    getBalance(options?: {
+        strict?: boolean;
+    }): Promise<number>;
     /** Edit an image using img2img (Solana payment). */
     /**
      * Generate an image on Solana.
@@ -3173,6 +3305,40 @@ declare class SolanaLLMClient {
         n?: number;
     } & Record<string, unknown>): Promise<ImageResponse>;
     imageEdit(prompt: string, image: string | string[], options?: ImageEditOptions): Promise<ImageResponse>;
+    /**
+     * Generate a short video on Solana.
+     *
+     * The POST is verified, not charged. The job is then polled with a wallet
+     * signature (no payment) until it finishes, and ONE payment is signed for
+     * the finished video; a failed job is never charged. If the gateway does not
+     * accept poll signatures for the job, it is polled with a payment per poll
+     * instead, which is likewise only charged on completion.
+     *
+     * @param prompt - text description of the video.
+     * @param options - `model` (default `xai/grok-imagine-video`), `budgetMs`
+     *   (total wait, default 15 min); any other keys are sent verbatim, so use
+     *   the gateway's snake_case names (`duration_seconds`, `image_url`,
+     *   `aspect_ratio`, `resolution`, …).
+     */
+    video(prompt: string, options?: {
+        model?: string;
+        budgetMs?: number;
+    } & Record<string, unknown>): Promise<VideoResponse>;
+    /**
+     * Generate a music track on Solana. Paid at the POST; a slow track is then
+     * polled with a wallet signature, never another payment.
+     *
+     * @param prompt - music style, mood, or description.
+     * @param options - `model` (default `minimax/music-2.5+`), `instrumental`
+     *   (default true), `lyrics` (requires `instrumental: false`), `budgetMs`
+     *   (total wait, default 5 min); other keys are sent verbatim.
+     */
+    music(prompt: string, options?: {
+        model?: string;
+        instrumental?: boolean;
+        lyrics?: string;
+        budgetMs?: number;
+    } & Record<string, unknown>): Promise<MusicResponse>;
     /** Standalone search (Solana payment). */
     search(query: string, options?: SearchOptions): Promise<SearchResult>;
     pm(path: string, params?: Record<string, string>): Promise<Record<string, unknown>>;
@@ -3293,6 +3459,12 @@ declare class SolanaLLMClient {
      * request was sent, except the account API's explicit 4xx refusal.
      */
     private requestWithPayment;
+    /**
+     * Cost of a chat response served without a payment: 0 with a wallet (a free
+     * model). With an API key the call is billed to the account, so costUsd stays
+     * undefined (see the dashboard).
+     */
+    private withUnpaidCost;
     /**
      * Read the JSON body of a 2xx served without a payment: the free tier, or
      * with an API key, where this very request was the billed one.
@@ -3306,6 +3478,47 @@ declare class SolanaLLMClient {
     private sendUnpaid;
     /** Read a paid 2xx response's JSON body. The call was charged, so a failure here is never retried. */
     private readPaidJson;
+    /**
+     * Follow a 202 `{ id, poll_url }` to completion on a Solana media route
+     * (image, music, video).
+     *
+     * **Polls prove ownership, they do not pay.** A Solana payment is a
+     * transaction pinned to a recent blockhash (~60s), so paying every poll of a
+     * multi-minute job meant signing a fresh transaction every few seconds. Each
+     * poll here instead carries the `x-poll-*` headers: the submitting wallet's
+     * ed25519 signature over `blockrun-poll:v1:<kind>:<job id>:<unix seconds>`
+     * (see `poll-ownership.ts`). That proof never charges.
+     *
+     * **Who pays when:**
+     * - image / music: the POST already settled (sol settles at submit because the
+     *   signed transaction would be dead by completion). The caller recorded the
+     *   cost at POST; this loop only fetches the result and never signs a payment.
+     *   A batch-billed image job still answers its proof poll with 402: that job
+     *   falls back to the per-poll payment below.
+     * - video: settles on completion, and a failed job is never charged. A
+     *   finished, unpaid job answers the proof poll with 402 `{status:"completed"}`
+     *   and a normal x402 challenge; ONE payment is signed from that challenge and
+     *   the same poll is re-sent with it. The cost is recorded here, on delivery.
+     *   A paid poll the gateway answers 402 (settlement in progress on another
+     *   poll, outcome unknown, stale blockhash) is re-polled after its
+     *   Retry-After — the gateway's per-job settlement claim makes a later fresh
+     *   payment safe — up to `MAX_PAID_POLL_REFUSALS` times.
+     *
+     * **Fallback, once per job:** if the gateway refuses the proof with its "no
+     * such job" answer (video 400, image/music 404) or answers it with a plain
+     * payment challenge (a gateway or job that predates poll proofs), the rest of
+     * this job is polled the old way — an x-payment signed per poll, which the
+     * gateway verifies against the job's payer and does not charge until a video
+     * completes. Logged to stderr; never switches back.
+     */
+    private followSolanaJob;
+    /**
+     * Absolute URL for a job's `poll_url`. The gateway returns `/api/v1/...`;
+     * {@link buildUrl} drops the `/api` that `apiUrl` already ends with. An
+     * absolute poll_url must be on the gateway's own origin: the poll carries a
+     * wallet signature (and, for a finished video, a payment).
+     */
+    private resolvePollUrl;
     /**
      * Turn a `402` into a signed Solana payment payload.
      *
@@ -3324,27 +3537,6 @@ declare class SolanaLLMClient {
      * @returns the header value to replay with, and what it will settle for.
      * @throws PaymentError when the 402 carries no usable Solana requirements.
      */
-    /**
-     * Follow a 202 `{ id, poll_url }` to completion, on Solana **image** routes.
-     *
-     * Two things differ from Base and both come from the same constraint — a
-     * Solana payment is a transaction pinned to a recent blockhash, valid for
-     * ~150 blocks (~60s), and a long render outlives it:
-     *
-     * 1. **The POST already settled.** Base settles on the completed poll; Solana
-     *    cannot, because by then the signed transaction has expired. So sol
-     *    settles optimistically at submit, and this loop only fetches the result.
-     *    The cost is recorded by the caller at POST, never here — recording it on
-     *    completion would lose the charge whenever a paid job then fails.
-     *    Solana VIDEO is the exception: it settles on the completed poll and a
-     *    failed job is not charged. Do not route video through this loop as-is —
-     *    it would book spend for jobs that were never charged.
-     * 2. **Every poll re-signs.** One authorization cannot be replayed across a
-     *    long render. The gateway binds the job to the payer address rather than
-     *    to the signature, so a fresh signature from the same wallet is accepted
-     *    and is never charged again.
-     */
-    private followSolanaJob;
     private signPaymentFrom402;
     /** Read a `402`'s payment requirements from its header, or its JSON body. */
     private readPaymentRequired;
@@ -3733,4 +3925,50 @@ declare function validateTemperature(temperature?: number): void;
  */
 declare function validateTopP(topP?: number): void;
 
-export { APIError, API_KEY_URL, ARC_CHAIN_ID, AnthropicClient, type ApiKeyOptions, type AudioModel, type AudioTrack, BASE_CHAIN_ID, BLOCKRUN_SOL_OPERATOR, type BarResolution, BatchCloseDeferredError, type BatchPayloadKind, BatchPaymentUnresolvedError, type BatchUnresolvedReason, type BlockRunAnthropicOptions, BlockrunClient, type BlockrunClientOptions, BlockrunError, type CallInitiatedResponse, type CallModel, type CallOptions, type CallStatusResponse, type ChatChoice, type ChatCompletionOptions, type ChatMessage, type ChatOptions, type ChatResponse, type ChatResponseWithCost, type ChatUsage, type CostEntry, type CostEstimate, type CreatePaymentOptions, DEFAULT_BATCH_RATE_LIMIT, EVM_NETWORKS, type EvmNetwork, type FunctionCall, type FunctionDefinition, type HistoryOptions, ImageClient, type ImageClientOptions, type ImageData, type ImageEditOptions, type ImageGenerateOptions, type ImageModel, type ImageResponse, KNOWN_PROVIDERS, LLMClient, type LLMClientOptions, type ListOptions, type MarketSession, type Model, MusicClient, type MusicClientOptions, type MusicGenerateOptions, type MusicResponse, NETWORK_ALIASES, type NewsSearchSource, OpenAI, type OpenAIChatCompletionChoice, type OpenAIChatCompletionChunk, type OpenAIChatCompletionParams, type OpenAIChatCompletionResponse, type OpenAIClientOptions, PHONE_PRICES, PORTAL_URL, PORTRAIT_ENROLLMENT_PRICE_USD, PaymentError, type PaymentLinks, type PhoneBuyOptions, type PhoneBuyResponse, PhoneClient, type PhoneClientOptions, type PhoneListResponse, type PhoneLookupResponse, type PhoneNumberRecord, type PhoneReleaseResponse, type PhoneRenewResponse, type PollOptions, PortraitClient, type PortraitClientOptions, type PortraitEnrollOptions, type PortraitEnrollResponse, type PriceBar, type PriceCategory, PriceClient, type PriceClientOptions, type PriceHistoryResponse, type PriceOptions, type PricePoint, RPC_PRICE_USD, type ResponseFormat, RetiredEndpointError, type RetryDisposition, type RoutingDecision, type RoutingProfile, type RoutingTaskType, type RoutingTier, type RoutingTierConfig, type RpcBatchRequest, RpcClient, type RpcClientOptions, type RpcError, type RpcNetwork, type RpcResponse, type RssSearchSource, SOLANA_NETWORK, SOLANA_WALLET_FILE as SOLANA_WALLET_FILE_PATH, SUPPORTED_NETWORKS, SearchClient, type SearchClientOptions, type SearchOptions, type SearchParameters, type SearchResult, type SearchSource, type SearchUsage, type SmartChatCompletionOptions, type SmartChatCompletionResponse, type SmartChatOptions, type SmartChatResponse, type SolanaBatchEvent, type SolanaBatchOptions, type SolanaBatchStats, SolanaLLMClient, type SolanaLLMClientOptions, type SolanaWalletInfo, type SoundEffectOptions, type SpeechAudio, SpeechClient, type SpeechClientOptions, type SpeechGenerateOptions, type SpeechModel, type SpeechResponse, type SpeechVoice, type Spending, type SpendingReport, type StockMarket, SurfClient, type SurfClientOptions, type SymbolListResponse, type Tool, type ToolCall, type ToolChoice, USDC_ARC, USDC_BASE, USDC_BASE_CONTRACT, USDC_SOLANA, VideoClient, type VideoClientOptions, type VideoClip, type VideoGenerateOptions, type VideoModel, type VideoResponse, VoiceClient, type VoiceClientOptions, type VoiceInfo, type VoicePreset, WALLET_DIR_PATH, WALLET_FILE_PATH, type WalletInfo, type WebSearchSource, type XSearchSource, clearCache, createPaymentPayload, createSolanaPaymentPayload, createSolanaWallet, createWallet, LLMClient as default, evmNetwork, extractPaymentDetails, formatFundingMessageCompact, formatNeedsFundingMessage, formatSolanaWalletMigrationNotice, formatWalletCreatedMessage, formatWalletMigrationNotice, getCached, getCachedByRequest, getCostLogSummary, getCostSummary, getEip681Uri, getOrCreateSolanaWallet, getOrCreateWallet, getPaymentLinks, getWalletAddress, importSolanaWallet, importWallet, listDiscoveredSolanaWallets, listDiscoveredWallets, loadSolanaWallet, loadWallet, logCost, parsePaymentRequired, retryDisposition, saveSolanaWallet, saveToCache, saveWallet, scanSolanaWallets, scanWallets, setCache, setupAgentClient, setupAgentSolanaWallet, setupAgentWallet, solanaClient, solanaKeyToBytes, solanaPublicKey, status, validateMaxTokens, validateModel, validateTemperature, validateTopP };
+/**
+ * Wire format for xAI search on the BlockRun gateways.
+ *
+ * The SDK's `SearchParameters` / `SearchSource` types are camelCase, but the
+ * gateways validate the OpenAI-style snake_case body (`included_x_handles`,
+ * `from_date`, …) with a non-strict schema that silently strips unknown keys.
+ * Sending the camelCase object verbatim therefore dropped every filter: an
+ * "only these X handles since yesterday" search ran over all of X, all time.
+ * Everything that leaves the SDK goes through {@link toWireSearchParameters}.
+ *
+ * Native xAI search tools (`{ type: "x_search" }` / `{ type: "web_search" }`)
+ * are accepted in `tools` for xai/* models and converted by {@link toWireTools}.
+ * https://docs.x.ai/developers/tools/x-search
+ */
+
+type Wire = Record<string, unknown>;
+/** camelCase `SearchParameters` → the gateway's snake_case `search_parameters`. */
+declare function toWireSearchParameters(sp: SearchParameters): Wire;
+/** Function tools pass through; x_search / web_search tools get xAI's field names. */
+declare function toWireTools(tools: AnyTool[]): Wire[];
+
+/**
+ * What one paid call actually cost, read from the gateway's PAYMENT-RESPONSE.
+ *
+ * The x402 receipt header is base64 JSON: `{ success, transaction, network,
+ * payer, amount?, extra?: { chargedAmount? } }`. Under batch / metered schemes
+ * the real charge is `extra.chargedAmount` (atomic USDC), else `amount`; under
+ * `exact` neither is set and the signed quote is the charge. The receipt is
+ * decoded best-effort: a missing or malformed header never fails the call.
+ *
+ * Some gateway routes also (or only) set `X-Payment-Receipt`, whose value is
+ * the raw settlement transaction hash, not base64 JSON.
+ */
+
+/**
+ * The cost and settlement for one response.
+ *
+ * `costUsd` is the charge the receipt states, else `quotedUsd`.
+ * @param quotedUsd - what was signed (the exact price, or the batch charge the payer reported).
+ * @param scheme - how it was paid.
+ */
+declare function readSettlement(response: Response, quotedUsd: number, scheme: Settlement["scheme"]): {
+    costUsd: number;
+    settlement: Settlement;
+};
+
+export { APIError, API_KEY_URL, ARC_CHAIN_ID, AnthropicClient, type AnyTool, type ApiKeyOptions, type AudioModel, type AudioTrack, BASE_CHAIN_ID, BLOCKRUN_SOL_OPERATOR, type BarResolution, BatchCloseDeferredError, type BatchPayloadKind, BatchPaymentUnresolvedError, type BatchUnresolvedReason, type BlockRunAnthropicOptions, BlockrunClient, type BlockrunClientOptions, BlockrunError, type CallInitiatedResponse, type CallModel, type CallOptions, type CallStatusResponse, type ChatChoice, type ChatCompletionOptions, type ChatMessage, type ChatOptions, type ChatResponse, type ChatResponseWithCost, type ChatUsage, type CostEntry, type CostEstimate, type CreatePaymentOptions, DEFAULT_BATCH_IN_DOUBT, DEFAULT_BATCH_RATE_LIMIT, EVM_NETWORKS, type EvmNetwork, type FunctionCall, type FunctionDefinition, type HistoryOptions, ImageClient, type ImageClientOptions, type ImageData, type ImageEditOptions, type ImageGenerateOptions, type ImageModel, type ImageResponse, KNOWN_PROVIDERS, LLMClient, type LLMClientOptions, type ListOptions, type MarketSession, type Model, MusicClient, type MusicClientOptions, type MusicGenerateOptions, type MusicResponse, NETWORK_ALIASES, type NewsSearchSource, OpenAI, type OpenAIChatCompletionChoice, type OpenAIChatCompletionChunk, type OpenAIChatCompletionParams, type OpenAIChatCompletionResponse, type OpenAIClientOptions, PHONE_PRICES, PORTAL_URL, PORTRAIT_ENROLLMENT_PRICE_USD, PaymentError, type PaymentLinks, type PhoneBuyOptions, type PhoneBuyResponse, PhoneClient, type PhoneClientOptions, type PhoneListResponse, type PhoneLookupResponse, type PhoneNumberRecord, type PhoneReleaseResponse, type PhoneRenewResponse, type PollOptions, PortraitClient, type PortraitClientOptions, type PortraitEnrollOptions, type PortraitEnrollResponse, type PriceBar, type PriceCategory, PriceClient, type PriceClientOptions, type PriceHistoryResponse, type PriceOptions, type PricePoint, RPC_PRICE_USD, type ResponseFormat, RetiredEndpointError, type RetryDisposition, type RoutingDecision, type RoutingProfile, type RoutingTaskType, type RoutingTier, type RoutingTierConfig, type RpcBatchRequest, RpcClient, type RpcClientOptions, type RpcError, type RpcNetwork, type RpcResponse, type RssSearchSource, SOLANA_NETWORK, SOLANA_WALLET_FILE as SOLANA_WALLET_FILE_PATH, SUPPORTED_NETWORKS, SearchClient, type SearchClientOptions, type SearchOptions, type SearchParameters, type SearchResult, type SearchSource, type SearchUsage, type Settlement, type SmartChatCompletionOptions, type SmartChatCompletionResponse, type SmartChatOptions, type SmartChatResponse, type SolanaBatchEvent, type SolanaBatchOptions, type SolanaBatchStats, SolanaLLMClient, type SolanaLLMClientOptions, type SolanaWalletInfo, type SoundEffectOptions, type SpeechAudio, SpeechClient, type SpeechClientOptions, type SpeechGenerateOptions, type SpeechModel, type SpeechResponse, type SpeechVoice, type Spending, type SpendingReport, type StockMarket, SurfClient, type SurfClientOptions, type SymbolListResponse, type Tool, type ToolCall, type ToolChoice, USDC_ARC, USDC_BASE, USDC_BASE_CONTRACT, USDC_SOLANA, type UrlCitation, VideoClient, type VideoClientOptions, type VideoClip, type VideoGenerateOptions, type VideoModel, type VideoResponse, VoiceClient, type VoiceClientOptions, type VoiceInfo, type VoicePreset, WALLET_DIR_PATH, WALLET_FILE_PATH, type WalletInfo, type WebSearchSource, type WebSearchTool, type XSearchSource, type XSearchTool, clearCache, createPaymentPayload, createSolanaPaymentPayload, createSolanaWallet, createWallet, LLMClient as default, evmNetwork, extractPaymentDetails, formatFundingMessageCompact, formatNeedsFundingMessage, formatSolanaWalletMigrationNotice, formatWalletCreatedMessage, formatWalletMigrationNotice, getCached, getCachedByRequest, getCostLogSummary, getCostSummary, getEip681Uri, getOrCreateSolanaWallet, getOrCreateWallet, getPaymentLinks, getWalletAddress, importSolanaWallet, importWallet, listDiscoveredSolanaWallets, listDiscoveredWallets, loadSolanaWallet, loadWallet, logCost, parsePaymentRequired, readSettlement, retryDisposition, saveSolanaWallet, saveToCache, saveWallet, scanSolanaWallets, scanWallets, setCache, setupAgentClient, setupAgentSolanaWallet, setupAgentWallet, solanaClient, solanaKeyToBytes, solanaPublicKey, status, toWireSearchParameters, toWireTools, validateMaxTokens, validateModel, validateTemperature, validateTopP };