@circle-fin/app-kit 1.12.0 → 1.13.0

package/unifiedBalance.d.ts

@@ -717,6 +717,8 @@ declare enum Blockchain {
     Optimism_Sepolia = "Optimism_Sepolia",
     Pharos = "Pharos",
     Pharos_Testnet = "Pharos_Testnet",
+    Plasma = "Plasma",
+    Plasma_Testnet = "Plasma_Testnet",
     Polkadot_Asset_Hub = "Polkadot_Asset_Hub",
     Polkadot_Westmint = "Polkadot_Westmint",
     Plume = "Plume",
@@ -2299,7 +2301,7 @@ interface ExecuteParams {
  *   fromAddress: '0x...',
  *   toAddress: '0x...',
  *   amount: '1000000',
- *   apiKey: 'KIT_KEY:...',
+ *   apiKey: 'TEST_API_KEY:...',
  * })
  *
  * // Build token inputs with permit
@@ -2443,7 +2445,7 @@ interface ExecuteSwapEVMParams extends ActionParameters {
  *   fromAddress: 'YubQzu18FDqJRyNfG8JqHmsdbxhnoQqcKUHBdUkN6tP',
  *   toAddress: 'YubQzu18FDqJRyNfG8JqHmsdbxhnoQqcKUHBdUkN6tP',
  *   amount: '1000000',
- *   apiKey: 'KIT_KEY:...',
+ *   apiKey: 'TEST_API_KEY:...',
  * })
  *
  * // Prepare action parameters
@@ -2604,6 +2606,18 @@ interface TokenActionMap {
          */
         walletAddress?: string | undefined;
     };
+    /**
+     * Get the on-chain name of the token contract.
+     *
+     * This is a read-only operation. For USDC the value is also the EIP-712
+     * domain name, which permit and authorize signing flows need.
+     */
+    name: ActionParameters & {
+        /**
+         * The contract address of the token.
+         */
+        tokenAddress: string;
+    };
 }
 
 /**
@@ -3433,6 +3447,30 @@ declare class ActionRegistry {
     executeAction<TActionKey extends ActionKeys>(action: TActionKey, params: ActionPayload<TActionKey>, context: ResolvedOperationContext): Promise<PreparedChainRequest>;
 }
 
+/**
+ * Canonical list of actions that do not prepare or submit transactions.
+ *
+ * @internal
+ */
+declare const READ_ACTION_KEYS: readonly ["token.allowance", "token.balanceOf", "token.name", "native.balanceOf", "usdc.allowance", "usdc.balanceOf", "usdc.name", "gateway.v1.isDelegate", "gateway.v1.withdrawingBalance", "gateway.v1.withdrawalBlock", "gateway.v1.signBurnIntents"];
+/**
+ * Action keys that execute without preparing or submitting a transaction.
+ *
+ * @remarks
+ * Derive this type from the canonical runtime list so compile-time and runtime
+ * classification cannot drift. `gateway.v1.signBurnIntents` is included
+ * because the action system models off-chain signing as a read action: it does
+ * not prepare a chain request.
+ *
+ * @example
+ * ```typescript
+ * import type { ReadActionKey } from '@core/adapter'
+ *
+ * const action: ReadActionKey = 'token.allowance'
+ * ```
+ */
+type ReadActionKey = (typeof READ_ACTION_KEYS)[number];
+
 /**
  * Defines the capabilities of an adapter, including address handling patterns and supported chains.
  *
@@ -3601,6 +3639,69 @@ declare abstract class Adapter<TAdapterCapabilities extends AdapterCapabilities
      * ```
      */
     prepareAction<TActionKey extends ActionKeys>(action: TActionKey, params: ActionPayload<TActionKey>, ctx: OperationContext<TAdapterCapabilities>): Promise<PreparedChainRequest>;
+    /**
+     * Execute a non-transaction action without routing through transaction preparation.
+     *
+     * @remarks
+     * Use this seam for balance, allowance, contract-state, and other actions
+     * classified as reads. It never calls {@link Adapter.prepareAction}, so
+     * transaction authorization wrappers only observe actions that can produce a
+     * signable chain request.
+     *
+     * @typeParam TActionKey - The read action key.
+     * @param action - The read action to execute.
+     * @param params - The parameters for the read action.
+     * @param ctx - The operation context.
+     * @returns The raw action response.
+     * @throws {KitError} When the key is not a read action or no handler is registered.
+     * @throws Error When the operation context or action handler fails.
+     *
+     * @example
+     * ```typescript
+     * import { Ethereum } from '@core/chains'
+     *
+     * const balance = await adapter.readAction(
+     *   'token.balanceOf',
+     *   { tokenAddress, walletAddress },
+     *   { chain: Ethereum },
+     * )
+     * ```
+     *
+     * @internal
+     */
+    readAction<TActionKey extends ReadActionKey>(action: TActionKey, params: ActionPayload<TActionKey>, ctx: OperationContext<TAdapterCapabilities>): Promise<unknown>;
+    /**
+     * Read the current token allowance a delegate holds over an owner's tokens.
+     *
+     * @remarks
+     * Perform a network read through {@link Adapter.readAction}. This method
+     * never routes through {@link Adapter.prepareAction}. On chains without an
+     * allowance model, such as Solana, return the maximum uint256 value.
+     *
+     * @param params - The token to query and the delegate whose allowance is being read.
+     * @param ctx - Operation context with compile-time validated address requirements.
+     * @returns A promise resolving to the current allowance in the token's base units.
+     * @throws {KitError} When the adapter does not register a `token.allowance` handler.
+     * @throws Error When the operation context or action handler fails.
+     *
+     * @example
+     * ```typescript
+     * import type { Adapter } from '@core/adapter'
+     * import { Ethereum } from '@core/chains'
+     *
+     * declare const adapter: Adapter
+     *
+     * const allowance = await adapter.getTokenAllowance(
+     *   {
+     *     tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+     *     delegate: '0x1111111111111111111111111111111111111111',
+     *   },
+     *   { chain: Ethereum },
+     * )
+     * console.log(allowance) // 1000000n
+     * ```
+     */
+    getTokenAllowance(params: ActionPayload<'token.allowance'>, ctx: OperationContext<TAdapterCapabilities>): Promise<bigint>;
     /**
      * Prepares a transaction for future gas estimation and execution.
      *
@@ -3787,6 +3888,80 @@ declare abstract class Adapter<TAdapterCapabilities extends AdapterCapabilities
     abstract getTokenDecimals(tokenAddress: string, chain: ChainDefinition): Promise<number>;
 }
 
+/**
+ * Simplified error information structure for logging and events.
+ *
+ * @remarks
+ * This lightweight type is used for error reporting in events, logs, and
+ * observability systems. It provides essential error context without the
+ * full ErrorDetails structure. Used across retry mechanisms, adapters,
+ * and other subsystems that need to record error information.
+ *
+ * @example
+ * ```typescript
+ * import { ErrorInfo } from '@core/errors'
+ *
+ * const info: ErrorInfo = {
+ *   name: 'NETWORK_TIMEOUT',
+ *   message: 'Request timed out after 5000ms',
+ *   code: 3002
+ * }
+ * ```
+ */
+interface ErrorInfo {
+    /** Error name (e.g., 'TypeError', 'KitError', 'NETWORK_TIMEOUT'). */
+    name: string;
+    /** Error message describing what went wrong. */
+    message: string;
+    /** Optional error code if the error has one (e.g., KitError codes). */
+    code?: number;
+    /** Error category (e.g., INPUT, RPC, ONCHAIN, BALANCE, NETWORK, UNKNOWN). Only set for KitError instances. */
+    type?: string;
+}
+
+/**
+ * Configuration options for the API polling utility.
+ *
+ * @remarks
+ * These settings control the behavior of the API polling process:
+ * - timeout: Maximum time (ms) to wait for each request before aborting
+ * - maxRetries: Maximum number of retry attempts for failed requests
+ * - retryDelay: Base delay (ms); constant wait for `'fixed'` or exponential seed for `'exponential'`
+ * - backoff: Retry-delay strategy, `'fixed'` (default) or `'exponential'`
+ * - maxRetryDelayMs: Optional ceiling (ms) for a single backoff wait
+ * - headers: Optional HTTP headers to include with each request
+ */
+interface ApiPollingConfig {
+    /** Maximum time in milliseconds to wait for each request */
+    timeout: number;
+    /** Maximum number of retry attempts for failed requests */
+    maxRetries: number;
+    /**
+     * Delay in milliseconds between retry attempts. With the default
+     * `backoff: 'fixed'` strategy this is the constant wait; with
+     * `backoff: 'exponential'` it is the base the exponential backoff grows
+     * from (see {@link pollApiWithValidation}).
+     */
+    retryDelay: number;
+    /**
+     * Retry-delay strategy. `'fixed'` (the default when omitted) waits a
+     * constant `retryDelay` between attempts; `'exponential'` grows the wait
+     * exponentially off `retryDelay` and randomizes it with full jitter, which
+     * spreads out retries so rate-limited (429) bursts do not retry in
+     * lockstep. Opt in per caller; existing callers keep the fixed delay.
+     */
+    backoff?: 'fixed' | 'exponential' | undefined;
+    /**
+     * Optional ceiling, in milliseconds, for a single backoff wait. Only
+     * applies when `backoff` is `'exponential'`: the exponential delay is
+     * capped at this value before jitter is applied. Defaults to
+     * {@link DEFAULT_MAX_RETRY_DELAY_MS} when omitted.
+     */
+    maxRetryDelayMs?: number | undefined;
+    /** Optional HTTP headers to include with requests */
+    headers?: Record<string, string> | undefined;
+}
+
 /**
  * A type-safe event emitter for managing action-based event subscriptions.
  *
@@ -4027,37 +4202,6 @@ declare module './types' {
     }
 }
 
-/**
- * Simplified error information structure for logging and events.
- *
- * @remarks
- * This lightweight type is used for error reporting in events, logs, and
- * observability systems. It provides essential error context without the
- * full ErrorDetails structure. Used across retry mechanisms, adapters,
- * and other subsystems that need to record error information.
- *
- * @example
- * ```typescript
- * import { ErrorInfo } from '@core/errors'
- *
- * const info: ErrorInfo = {
- *   name: 'NETWORK_TIMEOUT',
- *   message: 'Request timed out after 5000ms',
- *   code: 3002
- * }
- * ```
- */
-interface ErrorInfo {
-    /** Error name (e.g., 'TypeError', 'KitError', 'NETWORK_TIMEOUT'). */
-    name: string;
-    /** Error message describing what went wrong. */
-    message: string;
-    /** Optional error code if the error has one (e.g., KitError codes). */
-    code?: number;
-    /** Error category (e.g., INPUT, RPC, ONCHAIN, BALANCE, NETWORK, UNKNOWN). Only set for KitError instances. */
-    type?: string;
-}
-
 /**
  * Runtime array of token identifiers supported by the Gateway v1 provider.
  *
@@ -4564,6 +4708,15 @@ interface SpendOptions {
      * @internal
      */
     onBroadcast?: (txHash: string) => void;
+    /**
+     * Partial polling config forwarded to every Gateway API request the spend
+     * makes (estimate, transfer, forwarder status, and the balance lookups on
+     * the auto-allocation path). The provider factory populates this from its
+     * `headers` config so a configured header reaches all spend-path calls.
+     *
+     * @internal
+     */
+    requestConfig?: Partial<ApiPollingConfig>;
 }
 /**
  * Result returned after a successful spend (mint) operation.
@@ -6395,6 +6548,26 @@ interface UnifiedBalanceKitConfig<TExtraProviders extends FlexibleGatewayProvide
      * @defaultValue false
      */
     excludeDefaultProviders?: boolean;
+    /**
+     * Custom HTTP headers forwarded with every Circle Gateway API request the
+     * default Gateway v1 provider makes (balances, deposits, spend estimate,
+     * transfer, forwarder status, and `/v1/info`).
+     *
+     * @remarks
+     * Headers are merged on top of the SDK defaults (such as `Content-Type`)
+     * rather than replacing them. Each header is forwarded as-is to Circle's
+     * API; the SDK does not interpret it. Only applies to the default provider —
+     * has no effect when `excludeDefaultProviders` is `true` or on custom
+     * providers supplied via `providers`.
+     *
+     * @example
+     * ```typescript
+     * const kit = new UnifiedBalanceKit({
+     *   headers: { 'X-Access-Key': process.env.GATEWAY_ACCESS_KEY! },
+     * })
+     * ```
+     */
+    headers?: Record<string, string>;
 }
 
 /**