@circle-fin/app-kit 1.8.1 → 1.10.0

package/context.d.mts

@@ -374,6 +374,14 @@ interface CCTPSplitConfig {
     type: 'split';
     tokenMessenger: string;
     messageTransmitter: string;
+    /**
+     * Address of the `TokenMessengerWithFees` wrapper, when deployed on this chain.
+     *
+     * Optional. Present only on chains that support the prepaid FORWARD path
+     * (source-chain fee collection via `depositForBurnWithHookAndFees`). Resolve
+     * it with `resolveCCTPV2ContractAddress(chain, 'tokenMessengerWithFees')`.
+     */
+    tokenMessengerWithFees?: string;
     confirmations: number;
 }
 /**
@@ -394,6 +402,14 @@ interface CCTPSplitConfig {
 interface CCTPMergedConfig {
     type: 'merged';
     contract: string;
+    /**
+     * Address of the `TokenMessengerWithFees` wrapper, when deployed on this chain.
+     *
+     * Optional. Present only on chains that support the prepaid FORWARD path
+     * (source-chain fee collection via `depositForBurnWithHookAndFees`). Resolve
+     * it with `resolveCCTPV2ContractAddress(chain, 'tokenMessengerWithFees')`.
+     */
+    tokenMessengerWithFees?: string;
     confirmations: number;
 }
 /**
@@ -528,6 +544,21 @@ interface GatewayV1Contracts {
      * @example "0xabcdef1234567890abcdef1234567890abcdef12"
      */
     minter: string;
+    /**
+     * The address of the `DepositForHandler` contract.
+     *
+     * @description Optional. The handler the GenericExecutor calls on this chain
+     * to run a fast cross-chain deposit into the {@link GatewayV1Contracts.wallet}.
+     * Present only on chains that are fast-deposit destinations; other Gateway
+     * chains omit it.
+     *
+     * Address format varies by blockchain:
+     * - EVM chains: 40-character hexadecimal with 0x prefix (e.g., "0x1234...")
+     * - Solana: Base58-encoded 32-byte address (e.g., "9WzDX...")
+     *
+     * @example "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48"
+     */
+    depositForHandler?: string;
 }
 /**
  * Versioned map of Gateway contract configurations.
@@ -659,6 +690,8 @@ declare enum Blockchain {
     Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
     Codex = "Codex",
     Codex_Testnet = "Codex_Testnet",
+    Cronos = "Cronos",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge = "Edge",
     Edge_Testnet = "Edge_Testnet",
     Ethereum = "Ethereum",
@@ -900,6 +933,7 @@ declare enum BridgeChain {
     Avalanche = "Avalanche",
     Base = "Base",
     Codex = "Codex",
+    Cronos = "Cronos",
     Edge = "Edge",
     Ethereum = "Ethereum",
     HyperEVM = "HyperEVM",
@@ -923,6 +957,7 @@ declare enum BridgeChain {
     Avalanche_Fuji = "Avalanche_Fuji",
     Base_Sepolia = "Base_Sepolia",
     Codex_Testnet = "Codex_Testnet",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge_Testnet = "Edge_Testnet",
     Ethereum_Sepolia = "Ethereum_Sepolia",
     HyperEVM_Testnet = "HyperEVM_Testnet",
@@ -2173,6 +2208,110 @@ interface CCTPv2ActionMap {
          */
         hookData: string;
     };
+    /**
+     * Initiate a prepaid cross-chain USDC transfer through the `TokenMessengerWithFees` wrapper.
+     *
+     * Burn USDC on the source chain while collecting all fees up front against a
+     * signed quote. The wrapper collects the fee via `FeeManager`, then delegates
+     * to the unmodified `TokenMessengerV2`. When `hookData` is provided (the
+     * GenericExecutor FORWARD path) the wrapper's `depositForBurnWithHookAndFees`
+     * contract method is used; otherwise `depositForBurnWithFees` is used.
+     *
+     * @remarks
+     * SDK/contract naming: this SDK action is `depositForBurnWithFees` but, when a
+     * `hookData` is present, it dispatches to the `depositForBurnWithHookAndFees`
+     * contract method on `TokenMessengerWithFees` (NOT on `TokenMessengerV2`).
+     *
+     * Fee payment channel (must match the quote's `feeToken`):
+     * - Native fee (`feeToken` is the zero address): exactly `feeTotalAmount` is
+     *   attached as `msg.value`.
+     * - ERC-20 fee (e.g. USDC): no value is attached; the caller must first approve
+     *   the wrapper for `feeTotalAmount` (see the provider's fee approval helper).
+     *
+     * @remarks
+     * Unlike `depositForBurn`, the `TokenMessengerWithFees` contract methods do NOT
+     * take `maxFee` or `minFinalityThreshold` — fee and finality behavior are
+     * derived from the signed quote — so those fields are omitted from this action.
+     *
+     * @example
+     * ```typescript
+     * await adapter.action('cctp.v2.depositForBurnWithFees', {
+     *   amount: BigInt('1000000'),
+     *   mintRecipient: executorAddress,     // GenericExecutor (bytes32)
+     *   destinationCaller: executorAddress, // GenericExecutor (bytes32)
+     *   fromChain: ethereum,
+     *   toChain: arc,
+     *   hookData: geForwardHookData,        // cctp-forward-wrapped GenericExecutor blob
+     *   claim: { signedQuote: '0x...', refundAddress: '0x...' },
+     *   feeToken: '0x0000000000000000000000000000000000000000', // native
+     *   feeTotalAmount: 3500000n,
+     * })
+     * ```
+     */
+    depositForBurnWithFees: Omit<CCTPv2ActionMap['depositForBurn'], 'maxFee' | 'minFinalityThreshold'> & {
+        /**
+         * Optional hex-encoded hook data for the GenericExecutor FORWARD path.
+         *
+         * When present, the `depositForBurnWithHookAndFees` contract method is used
+         * and the blob must be wrapped in the `cctp-forward` envelope (the wrapper
+         * rejects a FORWARD fee quote whose hook lacks it). When omitted, the plain
+         * `depositForBurnWithFees` contract method is used.
+         */
+        hookData?: string;
+        /**
+         * Signed fee quote claim passed to the `TokenMessengerWithFees` wrapper.
+         *
+         * `signedQuote` is the `[uint8 0x01][abi.encode(Quote)]` blob returned by the
+         * Fee Quote service; `refundAddress` receives any fee overpayment refund.
+         */
+        claim: QuoteClaim;
+        /**
+         * Fee token from the signed quote.
+         *
+         * The zero address (`0x000…0`) means the fee is paid in native currency and
+         * is attached as `msg.value`. Any other address (e.g. USDC) means an ERC-20
+         * fee that must be approved to the wrapper beforehand. This is independent of
+         * `burnToken`, which is always USDC.
+         */
+        feeToken: string;
+        /**
+         * Total fee amount from the signed quote, in `feeToken` minor units.
+         *
+         * Firm only until the quote's `expiresAt`. For a native fee this is the exact
+         * `msg.value`; for an ERC-20 fee this is the amount approved to the wrapper.
+         */
+        feeTotalAmount: bigint;
+    };
+}
+/**
+ * Signed fee quote claim consumed by the `TokenMessengerWithFees` wrapper.
+ *
+ * Mirrors the on-chain `IFeeManager.QuoteClaim` struct.
+ *
+ * @example
+ * ```typescript
+ * const claim: QuoteClaim = {
+ *   signedQuote: '0x01...', // [uint8 0x01][abi.encode(Quote)]
+ *   refundAddress: '0xUserWallet...',
+ * }
+ * ```
+ */
+interface QuoteClaim {
+    /**
+     * Opaque signed quote bytes (`0x` hex) from the fee-quote service
+     * (`SignedFeeQuote.signedQuote` returned by `fetchFeeQuote`). Pass verbatim;
+     * do not decode.
+     *
+     * The quote binds the FORWARD fee item to the on-chain call via `argsHash`;
+     * passing a quote that does not match the burn args reverts `QuoteArgsMismatch`.
+     */
+    signedQuote: string;
+    /**
+     * Address that receives any refund of overpaid fees.
+     *
+     * Typically the user wallet that authorized the burn.
+     */
+    refundAddress: string;
 }
 
 /**
@@ -6344,26 +6483,28 @@ interface AppKitContext {
      * Event handlers registered for AppKit operations.
      *
      * This property stores event handlers that are registered via the AppKit's
-     * `on()` method. Handlers are grouped by operation type. The current runtime
-     * bucket is `bridge`, and the context can add more operation buckets as AppKit
-     * wires action handlers for additional kits.
+     * `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.
      *
-     * Within each operation bucket, handlers are keyed by action name (for example,
-     * `bridge.approve`) or `*` for wildcard handlers. Each action can have multiple
-     * handlers registered, allowing multiple subscribers to listen to the same event.
+     * Within each operation bucket, handlers are keyed by action name (for
+     * example, `bridge.approve` or `earn.deposit`) or `*` for wildcard handlers.
+     * Each action can have multiple handlers registered, allowing multiple
+     * subscribers to listen to the same event.
      *
      * The handlers are stored in the context to allow deferred registration with
-     * underlying operation kits, enabling a clean separation between event registration
-     * and operation execution.
+     * underlying operation kits, enabling a clean separation between event
+     * registration and operation execution.
      *
      * @example
      * ```typescript
      * const context = createContext()
      * // Handlers registered via kit.on() are stored by operation type
-     * // Bridge handlers are registered with BridgeKit when bridge() is executed
+     * // Bridge handlers are registered with BridgeKit when bridge() runs
+     * // Earn handlers are registered with EarnKit when earn operations run
      * ```
      */
-    actions: Record<'bridge', Record<string, ((payload: unknown) => void)[]>>;
+    actions: Record<'bridge' | 'earn', Record<string, ((payload: unknown) => void)[]>>;
     /**
      * Disable error telemetry for all sub-kits.
      *
@@ -6374,6 +6515,16 @@ interface AppKitContext {
      * @defaultValue false
      */
     disableErrorReporting?: boolean;
+    /**
+     * Custom HTTP headers forwarded with the underlying CCTP provider's
+     * attestation (Iris) API requests made by bridge operations.
+     *
+     * @remarks
+     * Headers are merged on top of the SDK defaults (such as `Content-Type`)
+     * rather than replacing them. The header is forwarded as-is to Circle's API;
+     * the SDK does not interpret it.
+     */
+    headers?: Record<string, string>;
 }
 
 /**
@@ -6381,7 +6532,8 @@ interface AppKitContext {
  *
  * This type allows partial customization of the context while ensuring
  * that all required properties have sensible defaults. Users can override
- * specific methods while keeping the rest intact.
+ * specific methods while keeping the rest intact. Action handler buckets
+ * may also be supplied partially; missing buckets default to empty maps.
  *
  * @example
  * ```typescript
@@ -6393,7 +6545,9 @@ interface AppKitContext {
  * })
  * ```
  */
-type CreateContextParams = Partial<AppKitContext>;
+type CreateContextParams = Omit<Partial<AppKitContext>, 'actions'> & {
+    actions?: Partial<AppKitContext['actions']>;
+};
 /**
  * Creates a AppKit context.
  *

package/context.d.ts

@@ -374,6 +374,14 @@ interface CCTPSplitConfig {
     type: 'split';
     tokenMessenger: string;
     messageTransmitter: string;
+    /**
+     * Address of the `TokenMessengerWithFees` wrapper, when deployed on this chain.
+     *
+     * Optional. Present only on chains that support the prepaid FORWARD path
+     * (source-chain fee collection via `depositForBurnWithHookAndFees`). Resolve
+     * it with `resolveCCTPV2ContractAddress(chain, 'tokenMessengerWithFees')`.
+     */
+    tokenMessengerWithFees?: string;
     confirmations: number;
 }
 /**
@@ -394,6 +402,14 @@ interface CCTPSplitConfig {
 interface CCTPMergedConfig {
     type: 'merged';
     contract: string;
+    /**
+     * Address of the `TokenMessengerWithFees` wrapper, when deployed on this chain.
+     *
+     * Optional. Present only on chains that support the prepaid FORWARD path
+     * (source-chain fee collection via `depositForBurnWithHookAndFees`). Resolve
+     * it with `resolveCCTPV2ContractAddress(chain, 'tokenMessengerWithFees')`.
+     */
+    tokenMessengerWithFees?: string;
     confirmations: number;
 }
 /**
@@ -528,6 +544,21 @@ interface GatewayV1Contracts {
      * @example "0xabcdef1234567890abcdef1234567890abcdef12"
      */
     minter: string;
+    /**
+     * The address of the `DepositForHandler` contract.
+     *
+     * @description Optional. The handler the GenericExecutor calls on this chain
+     * to run a fast cross-chain deposit into the {@link GatewayV1Contracts.wallet}.
+     * Present only on chains that are fast-deposit destinations; other Gateway
+     * chains omit it.
+     *
+     * Address format varies by blockchain:
+     * - EVM chains: 40-character hexadecimal with 0x prefix (e.g., "0x1234...")
+     * - Solana: Base58-encoded 32-byte address (e.g., "9WzDX...")
+     *
+     * @example "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48"
+     */
+    depositForHandler?: string;
 }
 /**
  * Versioned map of Gateway contract configurations.
@@ -659,6 +690,8 @@ declare enum Blockchain {
     Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
     Codex = "Codex",
     Codex_Testnet = "Codex_Testnet",
+    Cronos = "Cronos",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge = "Edge",
     Edge_Testnet = "Edge_Testnet",
     Ethereum = "Ethereum",
@@ -900,6 +933,7 @@ declare enum BridgeChain {
     Avalanche = "Avalanche",
     Base = "Base",
     Codex = "Codex",
+    Cronos = "Cronos",
     Edge = "Edge",
     Ethereum = "Ethereum",
     HyperEVM = "HyperEVM",
@@ -923,6 +957,7 @@ declare enum BridgeChain {
     Avalanche_Fuji = "Avalanche_Fuji",
     Base_Sepolia = "Base_Sepolia",
     Codex_Testnet = "Codex_Testnet",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge_Testnet = "Edge_Testnet",
     Ethereum_Sepolia = "Ethereum_Sepolia",
     HyperEVM_Testnet = "HyperEVM_Testnet",
@@ -2173,6 +2208,110 @@ interface CCTPv2ActionMap {
          */
         hookData: string;
     };
+    /**
+     * Initiate a prepaid cross-chain USDC transfer through the `TokenMessengerWithFees` wrapper.
+     *
+     * Burn USDC on the source chain while collecting all fees up front against a
+     * signed quote. The wrapper collects the fee via `FeeManager`, then delegates
+     * to the unmodified `TokenMessengerV2`. When `hookData` is provided (the
+     * GenericExecutor FORWARD path) the wrapper's `depositForBurnWithHookAndFees`
+     * contract method is used; otherwise `depositForBurnWithFees` is used.
+     *
+     * @remarks
+     * SDK/contract naming: this SDK action is `depositForBurnWithFees` but, when a
+     * `hookData` is present, it dispatches to the `depositForBurnWithHookAndFees`
+     * contract method on `TokenMessengerWithFees` (NOT on `TokenMessengerV2`).
+     *
+     * Fee payment channel (must match the quote's `feeToken`):
+     * - Native fee (`feeToken` is the zero address): exactly `feeTotalAmount` is
+     *   attached as `msg.value`.
+     * - ERC-20 fee (e.g. USDC): no value is attached; the caller must first approve
+     *   the wrapper for `feeTotalAmount` (see the provider's fee approval helper).
+     *
+     * @remarks
+     * Unlike `depositForBurn`, the `TokenMessengerWithFees` contract methods do NOT
+     * take `maxFee` or `minFinalityThreshold` — fee and finality behavior are
+     * derived from the signed quote — so those fields are omitted from this action.
+     *
+     * @example
+     * ```typescript
+     * await adapter.action('cctp.v2.depositForBurnWithFees', {
+     *   amount: BigInt('1000000'),
+     *   mintRecipient: executorAddress,     // GenericExecutor (bytes32)
+     *   destinationCaller: executorAddress, // GenericExecutor (bytes32)
+     *   fromChain: ethereum,
+     *   toChain: arc,
+     *   hookData: geForwardHookData,        // cctp-forward-wrapped GenericExecutor blob
+     *   claim: { signedQuote: '0x...', refundAddress: '0x...' },
+     *   feeToken: '0x0000000000000000000000000000000000000000', // native
+     *   feeTotalAmount: 3500000n,
+     * })
+     * ```
+     */
+    depositForBurnWithFees: Omit<CCTPv2ActionMap['depositForBurn'], 'maxFee' | 'minFinalityThreshold'> & {
+        /**
+         * Optional hex-encoded hook data for the GenericExecutor FORWARD path.
+         *
+         * When present, the `depositForBurnWithHookAndFees` contract method is used
+         * and the blob must be wrapped in the `cctp-forward` envelope (the wrapper
+         * rejects a FORWARD fee quote whose hook lacks it). When omitted, the plain
+         * `depositForBurnWithFees` contract method is used.
+         */
+        hookData?: string;
+        /**
+         * Signed fee quote claim passed to the `TokenMessengerWithFees` wrapper.
+         *
+         * `signedQuote` is the `[uint8 0x01][abi.encode(Quote)]` blob returned by the
+         * Fee Quote service; `refundAddress` receives any fee overpayment refund.
+         */
+        claim: QuoteClaim;
+        /**
+         * Fee token from the signed quote.
+         *
+         * The zero address (`0x000…0`) means the fee is paid in native currency and
+         * is attached as `msg.value`. Any other address (e.g. USDC) means an ERC-20
+         * fee that must be approved to the wrapper beforehand. This is independent of
+         * `burnToken`, which is always USDC.
+         */
+        feeToken: string;
+        /**
+         * Total fee amount from the signed quote, in `feeToken` minor units.
+         *
+         * Firm only until the quote's `expiresAt`. For a native fee this is the exact
+         * `msg.value`; for an ERC-20 fee this is the amount approved to the wrapper.
+         */
+        feeTotalAmount: bigint;
+    };
+}
+/**
+ * Signed fee quote claim consumed by the `TokenMessengerWithFees` wrapper.
+ *
+ * Mirrors the on-chain `IFeeManager.QuoteClaim` struct.
+ *
+ * @example
+ * ```typescript
+ * const claim: QuoteClaim = {
+ *   signedQuote: '0x01...', // [uint8 0x01][abi.encode(Quote)]
+ *   refundAddress: '0xUserWallet...',
+ * }
+ * ```
+ */
+interface QuoteClaim {
+    /**
+     * Opaque signed quote bytes (`0x` hex) from the fee-quote service
+     * (`SignedFeeQuote.signedQuote` returned by `fetchFeeQuote`). Pass verbatim;
+     * do not decode.
+     *
+     * The quote binds the FORWARD fee item to the on-chain call via `argsHash`;
+     * passing a quote that does not match the burn args reverts `QuoteArgsMismatch`.
+     */
+    signedQuote: string;
+    /**
+     * Address that receives any refund of overpaid fees.
+     *
+     * Typically the user wallet that authorized the burn.
+     */
+    refundAddress: string;
 }
 
 /**
@@ -6344,26 +6483,28 @@ interface AppKitContext {
      * Event handlers registered for AppKit operations.
      *
      * This property stores event handlers that are registered via the AppKit's
-     * `on()` method. Handlers are grouped by operation type. The current runtime
-     * bucket is `bridge`, and the context can add more operation buckets as AppKit
-     * wires action handlers for additional kits.
+     * `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.
      *
-     * Within each operation bucket, handlers are keyed by action name (for example,
-     * `bridge.approve`) or `*` for wildcard handlers. Each action can have multiple
-     * handlers registered, allowing multiple subscribers to listen to the same event.
+     * Within each operation bucket, handlers are keyed by action name (for
+     * example, `bridge.approve` or `earn.deposit`) or `*` for wildcard handlers.
+     * Each action can have multiple handlers registered, allowing multiple
+     * subscribers to listen to the same event.
      *
      * The handlers are stored in the context to allow deferred registration with
-     * underlying operation kits, enabling a clean separation between event registration
-     * and operation execution.
+     * underlying operation kits, enabling a clean separation between event
+     * registration and operation execution.
      *
      * @example
      * ```typescript
      * const context = createContext()
      * // Handlers registered via kit.on() are stored by operation type
-     * // Bridge handlers are registered with BridgeKit when bridge() is executed
+     * // Bridge handlers are registered with BridgeKit when bridge() runs
+     * // Earn handlers are registered with EarnKit when earn operations run
      * ```
      */
-    actions: Record<'bridge', Record<string, ((payload: unknown) => void)[]>>;
+    actions: Record<'bridge' | 'earn', Record<string, ((payload: unknown) => void)[]>>;
     /**
      * Disable error telemetry for all sub-kits.
      *
@@ -6374,6 +6515,16 @@ interface AppKitContext {
      * @defaultValue false
      */
     disableErrorReporting?: boolean;
+    /**
+     * Custom HTTP headers forwarded with the underlying CCTP provider's
+     * attestation (Iris) API requests made by bridge operations.
+     *
+     * @remarks
+     * Headers are merged on top of the SDK defaults (such as `Content-Type`)
+     * rather than replacing them. The header is forwarded as-is to Circle's API;
+     * the SDK does not interpret it.
+     */
+    headers?: Record<string, string>;
 }
 
 /**
@@ -6381,7 +6532,8 @@ interface AppKitContext {
  *
  * This type allows partial customization of the context while ensuring
  * that all required properties have sensible defaults. Users can override
- * specific methods while keeping the rest intact.
+ * specific methods while keeping the rest intact. Action handler buckets
+ * may also be supplied partially; missing buckets default to empty maps.
  *
  * @example
  * ```typescript
@@ -6393,7 +6545,9 @@ interface AppKitContext {
  * })
  * ```
  */
-type CreateContextParams = Partial<AppKitContext>;
+type CreateContextParams = Omit<Partial<AppKitContext>, 'actions'> & {
+    actions?: Partial<AppKitContext['actions']>;
+};
 /**
  * Creates a AppKit context.
  *

package/context.mjs

@@ -48,6 +48,7 @@
         ...params,
         actions: {
             bridge: {},
+            earn: {},
             ...params.actions
         }
     };