@circle-fin/app-kit 1.10.0 → 1.12.0

package/unifiedBalance.d.cts

@@ -739,6 +739,8 @@ declare enum Blockchain {
     World_Chain_Sepolia = "World_Chain_Sepolia",
     XDC = "XDC",
     XDC_Apothem = "XDC_Apothem",
+    X_Layer = "X_Layer",
+    X_Layer_Testnet = "X_Layer_Testnet",
     ZKSync_Era = "ZKSync_Era",
     ZKSync_Sepolia = "ZKSync_Sepolia"
 }
@@ -6977,10 +6979,13 @@ interface GetDelegateStatusParams<TAdapterCapabilities extends AdapterCapabiliti
 }
 
 /**
- * Parameters for initiating a delayed fund removal from a Gateway
+ * Parameters for initiating a delayed recovery fund removal from a Gateway
  * account.
  *
  * @remarks
+ * Use fund removal only as a trustless fallback when the normal spend flow is
+ * unavailable. For day-to-day movement out of a Unified Balance, use `spend`.
+ *
  * Fund removals have a mandatory 7-day delay before they can be
  * completed.  Only one removal may be pending per chain at a
  * time.  Initiating a second removal on the same chain adds the
@@ -7063,7 +7068,12 @@ interface InitiateRemoveFundResult {
     explorerUrl?: string;
 }
 /**
- * Parameters for completing a fund removal after the activation period.
+ * Parameters for completing a recovery fund removal after the withdrawal
+ * delay.
+ *
+ * @remarks
+ * Use fund removal only as a trustless fallback when the normal spend flow is
+ * unavailable. For day-to-day movement out of a Unified Balance, use `spend`.
  *
  * @typeParam TAdapterCapabilities - Adapter capability constraints.
  * @typeParam TChainIdentifier - Accepted chain identifier type.
@@ -7160,6 +7170,11 @@ interface GetSupportedChainsOptions {
  * Internally holds a persistent {@link UnifiedBalanceKit} instance so that
  * event dispatchers and custom fee policies are preserved across calls.
  *
+ * Use {@link AppKitUnifiedBalance.spend} for normal movement out of a Unified
+ * Balance. {@link AppKitUnifiedBalance.removeFund} is a trustless recovery path
+ * for situations where the normal spend flow is unavailable, and it requires a
+ * 7-day withdrawal delay after {@link AppKitUnifiedBalance.initiateRemoveFund}.
+ *
  * @example
  * ```typescript
  * import { AppKit } from '@circle-fin/app-kit'
@@ -7361,7 +7376,12 @@ declare class AppKitUnifiedBalance {
      */
     removeDelegate(params: UpdateDelegateParams): Promise<UpdateDelegateResult>;
     /**
-     * Kick off a delayed fund removal from an account.
+     * Initiate a trustless recovery removal from an account.
+     *
+     * Use `spend` for normal movement out of a Unified Balance. `removeFund` is a
+     * recovery path for situations where the normal spend flow is unavailable.
+     * Calling this method starts the 7-day withdrawal delay before the removal can
+     * be completed.
      *
      * @param params - The account owner's adapter context, amount, and token.
      * @returns Promise resolving to the initiation details.
@@ -7379,11 +7399,16 @@ declare class AppKitUnifiedBalance {
      */
     initiateRemoveFund(params: InitiateRemoveFundParams): Promise<InitiateRemoveFundResult>;
     /**
-     * Complete a fund removal once the activation period has passed.
+     * Complete a trustless recovery removal after the withdrawal delay.
+     *
+     * Use `spend` for normal movement out of a Unified Balance. `removeFund` is a
+     * recovery path for situations where the normal spend flow is unavailable.
+     * Both EVM and Solana removals require a 7-day withdrawal delay after
+     * `initiateRemoveFund` before funds can be removed.
      *
      * @param params - The account owner context matching the original initiation.
      * @returns Promise resolving to the fund removal details.
-     * @throws {KitError} If the activation period has not elapsed or the
+     * @throws {KitError} If the withdrawal delay has not elapsed or the
      *   on-chain transaction fails.
      *
      * @example

package/unifiedBalance.d.mts

@@ -739,6 +739,8 @@ declare enum Blockchain {
     World_Chain_Sepolia = "World_Chain_Sepolia",
     XDC = "XDC",
     XDC_Apothem = "XDC_Apothem",
+    X_Layer = "X_Layer",
+    X_Layer_Testnet = "X_Layer_Testnet",
     ZKSync_Era = "ZKSync_Era",
     ZKSync_Sepolia = "ZKSync_Sepolia"
 }
@@ -6977,10 +6979,13 @@ interface GetDelegateStatusParams<TAdapterCapabilities extends AdapterCapabiliti
 }
 
 /**
- * Parameters for initiating a delayed fund removal from a Gateway
+ * Parameters for initiating a delayed recovery fund removal from a Gateway
  * account.
  *
  * @remarks
+ * Use fund removal only as a trustless fallback when the normal spend flow is
+ * unavailable. For day-to-day movement out of a Unified Balance, use `spend`.
+ *
  * Fund removals have a mandatory 7-day delay before they can be
  * completed.  Only one removal may be pending per chain at a
  * time.  Initiating a second removal on the same chain adds the
@@ -7063,7 +7068,12 @@ interface InitiateRemoveFundResult {
     explorerUrl?: string;
 }
 /**
- * Parameters for completing a fund removal after the activation period.
+ * Parameters for completing a recovery fund removal after the withdrawal
+ * delay.
+ *
+ * @remarks
+ * Use fund removal only as a trustless fallback when the normal spend flow is
+ * unavailable. For day-to-day movement out of a Unified Balance, use `spend`.
  *
  * @typeParam TAdapterCapabilities - Adapter capability constraints.
  * @typeParam TChainIdentifier - Accepted chain identifier type.
@@ -7160,6 +7170,11 @@ interface GetSupportedChainsOptions {
  * Internally holds a persistent {@link UnifiedBalanceKit} instance so that
  * event dispatchers and custom fee policies are preserved across calls.
  *
+ * Use {@link AppKitUnifiedBalance.spend} for normal movement out of a Unified
+ * Balance. {@link AppKitUnifiedBalance.removeFund} is a trustless recovery path
+ * for situations where the normal spend flow is unavailable, and it requires a
+ * 7-day withdrawal delay after {@link AppKitUnifiedBalance.initiateRemoveFund}.
+ *
  * @example
  * ```typescript
  * import { AppKit } from '@circle-fin/app-kit'
@@ -7361,7 +7376,12 @@ declare class AppKitUnifiedBalance {
      */
     removeDelegate(params: UpdateDelegateParams): Promise<UpdateDelegateResult>;
     /**
-     * Kick off a delayed fund removal from an account.
+     * Initiate a trustless recovery removal from an account.
+     *
+     * Use `spend` for normal movement out of a Unified Balance. `removeFund` is a
+     * recovery path for situations where the normal spend flow is unavailable.
+     * Calling this method starts the 7-day withdrawal delay before the removal can
+     * be completed.
      *
      * @param params - The account owner's adapter context, amount, and token.
      * @returns Promise resolving to the initiation details.
@@ -7379,11 +7399,16 @@ declare class AppKitUnifiedBalance {
      */
     initiateRemoveFund(params: InitiateRemoveFundParams): Promise<InitiateRemoveFundResult>;
     /**
-     * Complete a fund removal once the activation period has passed.
+     * Complete a trustless recovery removal after the withdrawal delay.
+     *
+     * Use `spend` for normal movement out of a Unified Balance. `removeFund` is a
+     * recovery path for situations where the normal spend flow is unavailable.
+     * Both EVM and Solana removals require a 7-day withdrawal delay after
+     * `initiateRemoveFund` before funds can be removed.
      *
      * @param params - The account owner context matching the original initiation.
      * @returns Promise resolving to the fund removal details.
-     * @throws {KitError} If the activation period has not elapsed or the
+     * @throws {KitError} If the withdrawal delay has not elapsed or the
      *   on-chain transaction fails.
      *
      * @example

package/unifiedBalance.d.ts

@@ -739,6 +739,8 @@ declare enum Blockchain {
     World_Chain_Sepolia = "World_Chain_Sepolia",
     XDC = "XDC",
     XDC_Apothem = "XDC_Apothem",
+    X_Layer = "X_Layer",
+    X_Layer_Testnet = "X_Layer_Testnet",
     ZKSync_Era = "ZKSync_Era",
     ZKSync_Sepolia = "ZKSync_Sepolia"
 }
@@ -6977,10 +6979,13 @@ interface GetDelegateStatusParams<TAdapterCapabilities extends AdapterCapabiliti
 }
 
 /**
- * Parameters for initiating a delayed fund removal from a Gateway
+ * Parameters for initiating a delayed recovery fund removal from a Gateway
  * account.
  *
  * @remarks
+ * Use fund removal only as a trustless fallback when the normal spend flow is
+ * unavailable. For day-to-day movement out of a Unified Balance, use `spend`.
+ *
  * Fund removals have a mandatory 7-day delay before they can be
  * completed.  Only one removal may be pending per chain at a
  * time.  Initiating a second removal on the same chain adds the
@@ -7063,7 +7068,12 @@ interface InitiateRemoveFundResult {
     explorerUrl?: string;
 }
 /**
- * Parameters for completing a fund removal after the activation period.
+ * Parameters for completing a recovery fund removal after the withdrawal
+ * delay.
+ *
+ * @remarks
+ * Use fund removal only as a trustless fallback when the normal spend flow is
+ * unavailable. For day-to-day movement out of a Unified Balance, use `spend`.
  *
  * @typeParam TAdapterCapabilities - Adapter capability constraints.
  * @typeParam TChainIdentifier - Accepted chain identifier type.
@@ -7160,6 +7170,11 @@ interface GetSupportedChainsOptions {
  * Internally holds a persistent {@link UnifiedBalanceKit} instance so that
  * event dispatchers and custom fee policies are preserved across calls.
  *
+ * Use {@link AppKitUnifiedBalance.spend} for normal movement out of a Unified
+ * Balance. {@link AppKitUnifiedBalance.removeFund} is a trustless recovery path
+ * for situations where the normal spend flow is unavailable, and it requires a
+ * 7-day withdrawal delay after {@link AppKitUnifiedBalance.initiateRemoveFund}.
+ *
  * @example
  * ```typescript
  * import { AppKit } from '@circle-fin/app-kit'
@@ -7361,7 +7376,12 @@ declare class AppKitUnifiedBalance {
      */
     removeDelegate(params: UpdateDelegateParams): Promise<UpdateDelegateResult>;
     /**
-     * Kick off a delayed fund removal from an account.
+     * Initiate a trustless recovery removal from an account.
+     *
+     * Use `spend` for normal movement out of a Unified Balance. `removeFund` is a
+     * recovery path for situations where the normal spend flow is unavailable.
+     * Calling this method starts the 7-day withdrawal delay before the removal can
+     * be completed.
      *
      * @param params - The account owner's adapter context, amount, and token.
      * @returns Promise resolving to the initiation details.
@@ -7379,11 +7399,16 @@ declare class AppKitUnifiedBalance {
      */
     initiateRemoveFund(params: InitiateRemoveFundParams): Promise<InitiateRemoveFundResult>;
     /**
-     * Complete a fund removal once the activation period has passed.
+     * Complete a trustless recovery removal after the withdrawal delay.
+     *
+     * Use `spend` for normal movement out of a Unified Balance. `removeFund` is a
+     * recovery path for situations where the normal spend flow is unavailable.
+     * Both EVM and Solana removals require a 7-day withdrawal delay after
+     * `initiateRemoveFund` before funds can be removed.
      *
      * @param params - The account owner context matching the original initiation.
      * @returns Promise resolving to the fund removal details.
-     * @throws {KitError} If the activation period has not elapsed or the
+     * @throws {KitError} If the withdrawal delay has not elapsed or the
      *   on-chain transaction fails.
      *
      * @example