@circle-fin/app-kit 1.15.2 → 1.15.3

package/estimateSwap.d.ts

@@ -7431,6 +7431,26 @@ interface VaultQuery {
     /** On-chain vault contract address. */
     readonly vaultAddress: string;
 }
+/**
+ * Fields shared by both {@link EarnGasFeeEstimate} variants.
+ *
+ * @example
+ * ```typescript
+ * const base: EarnGasFeeEstimateBase = {
+ *   name: 'Deposit',
+ *   token: 'ETH',
+ *   blockchain: 'Arc_Testnet',
+ * }
+ * ```
+ */
+interface EarnGasFeeEstimateBase {
+    /** The earn step being estimated, e.g. "Approve", "Deposit", "Withdraw". */
+    readonly name: string;
+    /** Native token used to pay gas fees, e.g. "ETH". */
+    readonly token: string;
+    /** Blockchain where this gas fee applies. */
+    readonly blockchain: ChainDefinition['chain'];
+}
 /**
  * Sort order for a vault discovery query.
  *
@@ -7445,6 +7465,51 @@ interface VaultQuery {
  */
 type ExploreVaultsSortBy = 'apy' | 'tvl' | 'name';
 
+/**
+ * Estimated gas details for one transaction in a kit-level Earn quote, with
+ * every amount as a decimal string so quote results stay JSON-serializable.
+ *
+ * @example
+ * ```typescript
+ * const gas: EarnEstimatedGas = { gas: '73567', gasPrice: '20003763738', fee: '1471616886913446' }
+ * ```
+ */
+interface EarnEstimatedGas {
+    /** Estimated gas units as a decimal string, e.g. '73567'. */
+    readonly gas: string;
+    /** Estimated price per gas unit as a decimal string in wei. */
+    readonly gasPrice: string;
+    /** Total estimated fee as a decimal string in wei. */
+    readonly fee: string;
+}
+/**
+ * Estimated native gas fee for one transaction in an Earn quote.
+ *
+ * A discriminated union on `fees`: a successful estimate carries
+ * {@link EarnEstimatedGas} details and no `error`; a failed estimate carries
+ * `fees: null` and a sanitized `error` message.
+ *
+ * @example
+ * ```typescript
+ * function describe(entry: EarnGasFeeEstimate): string {
+ *   if (entry.fees === null) {
+ *     return `${entry.name}: estimation failed (${entry.error})`
+ *   }
+ *   return `${entry.name}: ${entry.fees.fee} wei`
+ * }
+ * ```
+ */
+type EarnGasFeeEstimate = (EarnGasFeeEstimateBase & {
+    /** Estimated gas details with amounts formatted as decimal strings. */
+    readonly fees: EarnEstimatedGas;
+    /** Never present on a successful estimate. */
+    readonly error?: never;
+}) | (EarnGasFeeEstimateBase & {
+    /** Null because estimation failed. */
+    readonly fees: null;
+    /** Sanitized estimation error message. */
+    readonly error: string;
+});
 /**
  * Adapter context for earn operations, constrained to earn-supported chains.
  *
@@ -7628,6 +7693,12 @@ interface SameChainDepositParams<TFromAdapterCapabilities extends AdapterCapabil
      * @example '100.50' for 100.50 USDC
      */
     readonly amount: string;
+    /**
+     * Gas fee estimates from a prior {@link getDepositQuote} call. When provided,
+     * the pre-broadcast gas reserve check uses the actual estimated cost instead
+     * of the conservative fallback reserve.
+     */
+    readonly gasFees?: readonly EarnGasFeeEstimate[] | undefined;
     /** Optional earn configuration. */
     readonly config?: EarnConfig | undefined;
 }

package/estimateSwap.mjs

@@ -22569,7 +22569,7 @@ registerKit(`${pkg$1.name}/${pkg$1.version}`);
 };
 
 var name = "@circle-fin/earn-kit";
-var version = "1.7.0";
+var version = "1.8.0";
 var pkg = {
 	name: name,
 	version: version};
@@ -22711,10 +22711,8 @@ const bridgeFeeTokenSchema = hexAddressSchema;
     assetAddress: z.string(),
     lltv: z.number(),
     supplyUsd: z.number(),
-    // Optional during the expand/contract window (a backend that predates the
-    // field omits the key), mirroring the `.optional()` facets on the base
-    // schema; `null` when the product exposes no per-market allocation (V2).
-    allocationPct: z.number().nullable().optional()
+    // `null` when the product exposes no per-market allocation (V2).
+    allocationPct: z.number().nullable()
 });
 /**
  * Zod schema for a Morpho vault warning in the API response.
@@ -22821,19 +22819,20 @@ const bridgeFeeTokenSchema = hexAddressSchema;
     earnKitWarnings: z.array(z.string()).optional()
 });
 /**
- * Shared base schema: existing flat fields (kept) plus the new nested
- * facets and neutral identity. Facets are `.optional()` during the
- * transition; flip to required once the backend is confirmed emitting.
+ * Shared base schema: existing flat fields (kept as deprecated aliases) plus
+ * the nested facets. Zenith emits all facets on every response; required here
+ * so a partial emission is caught at parse time rather than surfacing as a
+ * runtime `undefined` access.
  *
  * @internal
  */ const earnBaseSchema = vaultInfoResponseSchema.extend({
-    address: z.string().optional(),
-    asOf: z.string().optional(),
-    manager: managerSchema.nullable().optional(),
-    apyProfile: apyProfileSchema.optional(),
-    fee: feeInfoSchema.optional(),
-    liquidityProfile: liquidityProfileSchema.optional(),
-    riskSignals: riskSignalsSchema.optional()
+    address: z.string(),
+    asOf: z.string(),
+    manager: managerSchema.nullable(),
+    apyProfile: apyProfileSchema,
+    fee: feeInfoSchema,
+    liquidityProfile: liquidityProfileSchema,
+    riskSignals: riskSignalsSchema
 });
 /**
  * Zod schema for the `vault` opportunity variant.
@@ -23803,6 +23802,49 @@ const sourceAdapterContextSchema = z.object({
     vaultAddress: vaultAddressSchema,
     config: earnConfigSchema.optional()
 });
+/**
+ * Schema for a successful gas fee entry (fees is non-null).
+ *
+ * Validates the kit shape — {@link EarnEstimatedGas} uses decimal strings for
+ * `gas`, `gasPrice`, and `fee`. Only digits are accepted so that the deposit
+ * operation can safely convert them to `bigint` before passing them to the
+ * provider's `computeGasReserve`.
+ *
+ * @internal
+ */ const earnGasFeeEstimateSuccessSchema = z.object({
+    name: z.string(),
+    token: z.string(),
+    blockchain: z.string(),
+    fees: z.object({
+        gas: z.string().regex(/^\d+$/, 'gas must be a non-negative integer string'),
+        gasPrice: z.string().regex(/^\d+$/, 'gasPrice must be a non-negative integer string'),
+        fee: z.string().regex(/^\d+$/, 'fee must be a non-negative integer string')
+    }),
+    error: z.undefined().optional()
+}).strict();
+/**
+ * Schema for a failed gas fee entry (fees is null, error is a string).
+ *
+ * @internal
+ */ const earnGasFeeEstimateFailureSchema = z.object({
+    name: z.string(),
+    token: z.string(),
+    blockchain: z.string(),
+    fees: z.null(),
+    error: z.string()
+}).strict();
+/**
+ * Schema for a single kit-level gas fee estimate entry.
+ *
+ * Rejects arbitrary inputs (null, numbers, empty objects, non-numeric fee
+ * strings) so callers receive a descriptive validation error instead of a
+ * raw `BigInt` conversion error inside `computeGasReserve`.
+ *
+ * @internal
+ */ const earnGasFeeEstimateSchema = z.union([
+    earnGasFeeEstimateSuccessSchema,
+    earnGasFeeEstimateFailureSchema
+]);
 /**
  * Validation schema for the same-chain variant of DepositParams.
  *
@@ -23815,6 +23857,7 @@ const sourceAdapterContextSchema = z.object({
     to: z.undefined().optional(),
     vaultAddress: vaultAddressSchema,
     amount: amountSchema,
+    gasFees: z.array(earnGasFeeEstimateSchema).optional(),
     config: earnConfigSchema.optional()
 }).strict();
 const crossChainDepositDestinationSchema = z.object({