@circle-fin/app-kit 1.15.3 → 1.17.0

package/context.d.mts

@@ -551,8 +551,23 @@ interface CCTPXChainConfig {
  * const contractType: KitContractType = 'bridge' // Valid
  * const invalidType: KitContractType = 'invalid' // TypeScript error
  * ```
- */
-type KitContractType = 'bridge' | 'adapter';
+ *
+ * @remarks
+ * `'senderPreservingBatcher'` carries a stricter requirement than the others,
+ * because setting it wrong fails silently rather than loudly. It must name a
+ * batching contract that preserves the calling EOA as `msg.sender` in every
+ * subcall — on Arc, the `Multicall3From` predeploy, which achieves that
+ * through the `CallFrom` precompile. The name is deliberately more specific
+ * than "batcher": the ubiquitous Multicall3 at
+ * `0xcA11bde05977b3631167028862bE2a173976CA11` has the same ABI and the same
+ * selectors but does **not** qualify, since each subcall would arrive as the
+ * Multicall3 contract, so a batched `approve` would grant an allowance from
+ * the batcher's own balance rather than from the user's — a field named just
+ * `batcher` would make that misconfiguration look valid. Leave
+ * `senderPreservingBatcher` unset on any chain lacking one; an unset field
+ * simply means callers fall back to submitting calls one at a time.
+ */
+type KitContractType = 'bridge' | 'adapter' | 'senderPreservingBatcher';
 /**
  * Configuration for Gateway v1 contracts.
  *
@@ -884,10 +899,10 @@ declare enum Blockchain {
  *
  * Unlike the full {@link Blockchain} enum, SwapChain includes mainnet
  * networks and explicitly whitelisted testnets (e.g., {@link Arc_Testnet})
- * where adapter contracts are deployed (CCTPv2 support).
+ * where Adapter contracts are deployed.
  *
  * Dynamic validation via {@link isSwapSupportedChain} ensures chains
- * automatically work when adapter contracts and supported tokens are deployed.
+ * automatically work when Adapter contracts and supported tokens are deployed.
  *
  * @example
  * ```typescript
@@ -927,20 +942,22 @@ declare enum SwapChain {
     HyperEVM = "HyperEVM",
     Monad = "Monad",
     Arc = "Arc",
+    Cronos = "Cronos",
+    Morph = "Morph",
     Arc_Testnet = "Arc_Testnet"
 }
 /**
  * Chain definition that supports swap operations.
  *
  * @remarks
- * Expanded from 4 to ~18 supported chains based on:
- * - CCTPv2 support (adapter contract deployed)
+ * Expanded from 4 to supported mainnets and whitelisted testnets based on:
+ * - A deployed Adapter contract, configured directly or through CCTP v2
  * - Mainnet chains plus whitelisted testnets (e.g., Arc Testnet)
  *
  * Use `isSwapSupportedChain()` for runtime validation.
  */
 type SwapChainDefinition = ChainDefinition & {
-    chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Arc_Testnet;
+    chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Cronos | Blockchain.Morph | Blockchain.Arc_Testnet;
 };
 /**
  * Chain identifier accepted by swap operations.
@@ -1436,8 +1453,13 @@ type PreparedChainRequest = EvmPreparedChainRequest | SolanaPreparedChainRequest
  * Parameters for preparing an EVM contract execution.
  */
 type EvmPreparedChainRequestParams = {
-    /** The type of the prepared execution. */
-    type: 'evm';
+    /**
+     * The type of the prepared execution. Optional here because EVM is the
+     * only chain type `Adapter.prepare()` implementations narrow their param
+     * type to in practice — callers that only ever prepare EVM requests can
+     * omit it rather than repeat a discriminator that never varies for them.
+     */
+    type?: 'evm';
     /** The ABI of the contract. */
     abi: Abi | string[];
     /** The address of the contract. */
@@ -2716,6 +2738,57 @@ interface EarnActionMap {
     readonly claimRewards: ExecuteEarnParams;
 }
 
+/** Permit standards accepted by Borrow Adapter executions. */
+declare enum BorrowPermitType {
+    /** Tokens must be approved separately. */
+    NONE = 0,
+    /** EIP-2612 permit calldata accompanies the token input. */
+    EIP2612 = 1
+}
+/** Token input forwarded by Borrow Kit to the Adapter Contract. */
+interface BorrowTokenInput {
+    readonly permitType: BorrowPermitType;
+    readonly token: `0x${string}`;
+    readonly amount: bigint;
+    readonly permitCalldata: `0x${string}`;
+}
+/** A single instruction in a Circle-signed Borrow execution. */
+interface BorrowInstruction {
+    readonly target: `0x${string}`;
+    readonly data: `0x${string}`;
+    readonly value: string | bigint;
+    readonly tokenIn: `0x${string}`;
+    readonly amountToApprove: string | bigint;
+    readonly tokenOut: `0x${string}`;
+    readonly minTokenOut: string | bigint;
+}
+/** A token recipient in a Circle-signed Borrow execution. */
+interface BorrowTokenRecipient {
+    readonly token: `0x${string}`;
+    readonly beneficiary: `0x${string}`;
+}
+/** Circle-signed Borrow parameters forwarded to the Adapter Contract. */
+interface BorrowExecutionParams {
+    readonly instructions: readonly BorrowInstruction[];
+    readonly tokens: readonly BorrowTokenRecipient[];
+    readonly execId: string | bigint;
+    readonly deadline: string | bigint;
+    readonly metadata: `0x${string}`;
+}
+/** Parameters for a service-signed Borrow Adapter execution. */
+interface ExecuteBorrowParams extends ActionParameters {
+    readonly executeParams: BorrowExecutionParams;
+    readonly tokenInputs: BorrowTokenInput[];
+    readonly signature: `0x${string}`;
+}
+/** Borrow actions supported by EVM adapters. */
+interface BorrowActionMap {
+    /** Execute a Circle-signed partial loan repayment. */
+    readonly repay: ExecuteBorrowParams;
+    /** Execute a Circle-signed borrow. */
+    readonly execute: ExecuteBorrowParams;
+}
+
 /**
  * Single instruction to execute within the Adapter Contract.
  *
@@ -3672,6 +3745,8 @@ interface NativeActionMap {
  * @see {@link ActionPayload} for extracting payload types
  */
 interface ActionMap {
+    /** Borrow operations that execute service-signed payloads. */
+    readonly borrow: BorrowActionMap;
     /** CCTP-specific operations with automatic address resolution. */
     readonly cctp: CCTPActionMap;
     /** CCTPx operations (CrossChainTokenService) for cross-chain transfers of registered tokens (Circle-issued or otherwise). */
@@ -3691,6 +3766,7 @@ interface ActionMap {
     /** Earn operations that execute service-signed payloads via the adapter contract. */
     readonly earn: EarnActionMap;
 }
+
 /**
  * Determine if a type represents an action parameter object (leaf node).
  *
@@ -6659,7 +6735,7 @@ interface ServiceSwapConfig {
      *
      * @defaultValue true
      */
-    batchTransactions?: boolean;
+    batchTransactions?: boolean | undefined;
 }
 /**
  * Parameters for initiating a swap operation through the Stablecoin Service.
@@ -7123,6 +7199,33 @@ interface SwapConfig {
      * `apiKey` is omitted, and `apiKey` takes precedence when both are set.
      */
     kitKey?: string;
+    /**
+     * Enable or disable atomic batched execution of the approval and swap.
+     *
+     * When `true` (or omitted), an EVM swap that needs an on-chain ERC-20
+     * approval submits the approval and the swap as one atomic batch if the
+     * connected wallet supports it (EIP-5792, or a signing strategy that
+     * declares atomic batching). Set to `false` to force the sequential
+     * approve-then-swap flow.
+     *
+     * @remarks
+     * Has no effect on the gasless permit path, native-token swaps, or Solana,
+     * which already execute as a single transaction. USDT input always uses the
+     * sequential path because its allowance must be reset to zero first. The
+     * batched path relies on the wallet's own gas estimation for the swap call;
+     * set `false` if your wallet under-estimates gas for complex routes or
+     * rejects batched calls.
+     *
+     * @defaultValue `undefined` (batching attempted when the wallet supports it)
+     *
+     * @example
+     * ```typescript
+     * const config: SwapConfig = {
+     *   batchTransactions: false, // force sequential approve → swap
+     * }
+     * ```
+     */
+    batchTransactions?: boolean | undefined;
 }
 /**
  * Resolved parameters for swap operations after validation and normalization.
@@ -8087,8 +8190,8 @@ interface AppKitContext {
      *
      * This property stores event handlers that are registered via the AppKit's
      * `on()` method. Handlers are grouped by operation type. The runtime buckets
-     * are `bridge` and `earn`; the context can add more operation buckets as
-     * AppKit wires action handlers for additional kits.
+     * are `bridge`, `earn`, and `borrow`; the context can add more operation
+     * buckets as AppKit wires action handlers for additional kits.
      *
      * Within each operation bucket, handlers are keyed by action name (for
      * example, `bridge.approve` or `earn.deposit`) or `*` for wildcard handlers.
@@ -8107,13 +8210,13 @@ interface AppKitContext {
      * // Earn handlers are registered with EarnKit when earn operations run
      * ```
      */
-    actions: Record<'bridge' | 'earn', Record<string, ((payload: unknown) => void)[]>>;
+    actions: Record<'bridge' | 'earn' | 'borrow', Record<string, ((payload: unknown) => void)[]>>;
     /**
-     * Disable success analytics for the underlying EarnKit, SwapKit, and
-     * UnifiedBalanceKit.
+     * Disable success analytics for the underlying EarnKit, SwapKit,
+     * BorrowKit, and UnifiedBalanceKit.
      *
-     * When `true`, completed earn, swap, and unified balance operations will not
-     * POST analytics events. This does not disable error reporting; use
+     * When `true`, completed earn, swap, borrow, and unified balance operations
+     * will not POST analytics events. This does not disable error reporting; use
      * {@link AppKitContext.disableErrorReporting} for that. Defaults to `false`.
      *
      * @defaultValue false
@@ -8123,7 +8226,7 @@ interface AppKitContext {
      * Disable error telemetry for all sub-kits.
      *
      * When `true`, none of the underlying kits (BridgeKit, SwapKit, EarnKit,
-     * UnifiedBalanceKit) will POST error details to the telemetry
+     * BorrowKit, UnifiedBalanceKit) will POST error details to the telemetry
      * endpoint when operations throw. Defaults to `false` (enabled).
      *
      * @defaultValue false

package/context.d.ts

@@ -551,8 +551,23 @@ interface CCTPXChainConfig {
  * const contractType: KitContractType = 'bridge' // Valid
  * const invalidType: KitContractType = 'invalid' // TypeScript error
  * ```
- */
-type KitContractType = 'bridge' | 'adapter';
+ *
+ * @remarks
+ * `'senderPreservingBatcher'` carries a stricter requirement than the others,
+ * because setting it wrong fails silently rather than loudly. It must name a
+ * batching contract that preserves the calling EOA as `msg.sender` in every
+ * subcall — on Arc, the `Multicall3From` predeploy, which achieves that
+ * through the `CallFrom` precompile. The name is deliberately more specific
+ * than "batcher": the ubiquitous Multicall3 at
+ * `0xcA11bde05977b3631167028862bE2a173976CA11` has the same ABI and the same
+ * selectors but does **not** qualify, since each subcall would arrive as the
+ * Multicall3 contract, so a batched `approve` would grant an allowance from
+ * the batcher's own balance rather than from the user's — a field named just
+ * `batcher` would make that misconfiguration look valid. Leave
+ * `senderPreservingBatcher` unset on any chain lacking one; an unset field
+ * simply means callers fall back to submitting calls one at a time.
+ */
+type KitContractType = 'bridge' | 'adapter' | 'senderPreservingBatcher';
 /**
  * Configuration for Gateway v1 contracts.
  *
@@ -884,10 +899,10 @@ declare enum Blockchain {
  *
  * Unlike the full {@link Blockchain} enum, SwapChain includes mainnet
  * networks and explicitly whitelisted testnets (e.g., {@link Arc_Testnet})
- * where adapter contracts are deployed (CCTPv2 support).
+ * where Adapter contracts are deployed.
  *
  * Dynamic validation via {@link isSwapSupportedChain} ensures chains
- * automatically work when adapter contracts and supported tokens are deployed.
+ * automatically work when Adapter contracts and supported tokens are deployed.
  *
  * @example
  * ```typescript
@@ -927,20 +942,22 @@ declare enum SwapChain {
     HyperEVM = "HyperEVM",
     Monad = "Monad",
     Arc = "Arc",
+    Cronos = "Cronos",
+    Morph = "Morph",
     Arc_Testnet = "Arc_Testnet"
 }
 /**
  * Chain definition that supports swap operations.
  *
  * @remarks
- * Expanded from 4 to ~18 supported chains based on:
- * - CCTPv2 support (adapter contract deployed)
+ * Expanded from 4 to supported mainnets and whitelisted testnets based on:
+ * - A deployed Adapter contract, configured directly or through CCTP v2
  * - Mainnet chains plus whitelisted testnets (e.g., Arc Testnet)
  *
  * Use `isSwapSupportedChain()` for runtime validation.
  */
 type SwapChainDefinition = ChainDefinition & {
-    chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Arc_Testnet;
+    chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Cronos | Blockchain.Morph | Blockchain.Arc_Testnet;
 };
 /**
  * Chain identifier accepted by swap operations.
@@ -1436,8 +1453,13 @@ type PreparedChainRequest = EvmPreparedChainRequest | SolanaPreparedChainRequest
  * Parameters for preparing an EVM contract execution.
  */
 type EvmPreparedChainRequestParams = {
-    /** The type of the prepared execution. */
-    type: 'evm';
+    /**
+     * The type of the prepared execution. Optional here because EVM is the
+     * only chain type `Adapter.prepare()` implementations narrow their param
+     * type to in practice — callers that only ever prepare EVM requests can
+     * omit it rather than repeat a discriminator that never varies for them.
+     */
+    type?: 'evm';
     /** The ABI of the contract. */
     abi: Abi | string[];
     /** The address of the contract. */
@@ -2716,6 +2738,57 @@ interface EarnActionMap {
     readonly claimRewards: ExecuteEarnParams;
 }
 
+/** Permit standards accepted by Borrow Adapter executions. */
+declare enum BorrowPermitType {
+    /** Tokens must be approved separately. */
+    NONE = 0,
+    /** EIP-2612 permit calldata accompanies the token input. */
+    EIP2612 = 1
+}
+/** Token input forwarded by Borrow Kit to the Adapter Contract. */
+interface BorrowTokenInput {
+    readonly permitType: BorrowPermitType;
+    readonly token: `0x${string}`;
+    readonly amount: bigint;
+    readonly permitCalldata: `0x${string}`;
+}
+/** A single instruction in a Circle-signed Borrow execution. */
+interface BorrowInstruction {
+    readonly target: `0x${string}`;
+    readonly data: `0x${string}`;
+    readonly value: string | bigint;
+    readonly tokenIn: `0x${string}`;
+    readonly amountToApprove: string | bigint;
+    readonly tokenOut: `0x${string}`;
+    readonly minTokenOut: string | bigint;
+}
+/** A token recipient in a Circle-signed Borrow execution. */
+interface BorrowTokenRecipient {
+    readonly token: `0x${string}`;
+    readonly beneficiary: `0x${string}`;
+}
+/** Circle-signed Borrow parameters forwarded to the Adapter Contract. */
+interface BorrowExecutionParams {
+    readonly instructions: readonly BorrowInstruction[];
+    readonly tokens: readonly BorrowTokenRecipient[];
+    readonly execId: string | bigint;
+    readonly deadline: string | bigint;
+    readonly metadata: `0x${string}`;
+}
+/** Parameters for a service-signed Borrow Adapter execution. */
+interface ExecuteBorrowParams extends ActionParameters {
+    readonly executeParams: BorrowExecutionParams;
+    readonly tokenInputs: BorrowTokenInput[];
+    readonly signature: `0x${string}`;
+}
+/** Borrow actions supported by EVM adapters. */
+interface BorrowActionMap {
+    /** Execute a Circle-signed partial loan repayment. */
+    readonly repay: ExecuteBorrowParams;
+    /** Execute a Circle-signed borrow. */
+    readonly execute: ExecuteBorrowParams;
+}
+
 /**
  * Single instruction to execute within the Adapter Contract.
  *
@@ -3672,6 +3745,8 @@ interface NativeActionMap {
  * @see {@link ActionPayload} for extracting payload types
  */
 interface ActionMap {
+    /** Borrow operations that execute service-signed payloads. */
+    readonly borrow: BorrowActionMap;
     /** CCTP-specific operations with automatic address resolution. */
     readonly cctp: CCTPActionMap;
     /** CCTPx operations (CrossChainTokenService) for cross-chain transfers of registered tokens (Circle-issued or otherwise). */
@@ -3691,6 +3766,7 @@ interface ActionMap {
     /** Earn operations that execute service-signed payloads via the adapter contract. */
     readonly earn: EarnActionMap;
 }
+
 /**
  * Determine if a type represents an action parameter object (leaf node).
  *
@@ -6659,7 +6735,7 @@ interface ServiceSwapConfig {
      *
      * @defaultValue true
      */
-    batchTransactions?: boolean;
+    batchTransactions?: boolean | undefined;
 }
 /**
  * Parameters for initiating a swap operation through the Stablecoin Service.
@@ -7123,6 +7199,33 @@ interface SwapConfig {
      * `apiKey` is omitted, and `apiKey` takes precedence when both are set.
      */
     kitKey?: string;
+    /**
+     * Enable or disable atomic batched execution of the approval and swap.
+     *
+     * When `true` (or omitted), an EVM swap that needs an on-chain ERC-20
+     * approval submits the approval and the swap as one atomic batch if the
+     * connected wallet supports it (EIP-5792, or a signing strategy that
+     * declares atomic batching). Set to `false` to force the sequential
+     * approve-then-swap flow.
+     *
+     * @remarks
+     * Has no effect on the gasless permit path, native-token swaps, or Solana,
+     * which already execute as a single transaction. USDT input always uses the
+     * sequential path because its allowance must be reset to zero first. The
+     * batched path relies on the wallet's own gas estimation for the swap call;
+     * set `false` if your wallet under-estimates gas for complex routes or
+     * rejects batched calls.
+     *
+     * @defaultValue `undefined` (batching attempted when the wallet supports it)
+     *
+     * @example
+     * ```typescript
+     * const config: SwapConfig = {
+     *   batchTransactions: false, // force sequential approve → swap
+     * }
+     * ```
+     */
+    batchTransactions?: boolean | undefined;
 }
 /**
  * Resolved parameters for swap operations after validation and normalization.
@@ -8087,8 +8190,8 @@ interface AppKitContext {
      *
      * This property stores event handlers that are registered via the AppKit's
      * `on()` method. Handlers are grouped by operation type. The runtime buckets
-     * are `bridge` and `earn`; the context can add more operation buckets as
-     * AppKit wires action handlers for additional kits.
+     * are `bridge`, `earn`, and `borrow`; the context can add more operation
+     * buckets as AppKit wires action handlers for additional kits.
      *
      * Within each operation bucket, handlers are keyed by action name (for
      * example, `bridge.approve` or `earn.deposit`) or `*` for wildcard handlers.
@@ -8107,13 +8210,13 @@ interface AppKitContext {
      * // Earn handlers are registered with EarnKit when earn operations run
      * ```
      */
-    actions: Record<'bridge' | 'earn', Record<string, ((payload: unknown) => void)[]>>;
+    actions: Record<'bridge' | 'earn' | 'borrow', Record<string, ((payload: unknown) => void)[]>>;
     /**
-     * Disable success analytics for the underlying EarnKit, SwapKit, and
-     * UnifiedBalanceKit.
+     * Disable success analytics for the underlying EarnKit, SwapKit,
+     * BorrowKit, and UnifiedBalanceKit.
      *
-     * When `true`, completed earn, swap, and unified balance operations will not
-     * POST analytics events. This does not disable error reporting; use
+     * When `true`, completed earn, swap, borrow, and unified balance operations
+     * will not POST analytics events. This does not disable error reporting; use
      * {@link AppKitContext.disableErrorReporting} for that. Defaults to `false`.
      *
      * @defaultValue false
@@ -8123,7 +8226,7 @@ interface AppKitContext {
      * Disable error telemetry for all sub-kits.
      *
      * When `true`, none of the underlying kits (BridgeKit, SwapKit, EarnKit,
-     * UnifiedBalanceKit) will POST error details to the telemetry
+     * BorrowKit, UnifiedBalanceKit) will POST error details to the telemetry
      * endpoint when operations throw. Defaults to `false` (enabled).
      *
      * @defaultValue false

package/context.mjs

@@ -60,6 +60,7 @@ if (typeof window !== 'undefined' && typeof window.Buffer === 'undefined') {
         actions: {
             bridge: {},
             earn: {},
+            borrow: {},
             ...params.actions
         }
     };