@spicenet-io/spiceflow-ui 4.18.0 → 4.18.1-cash.0

package/README.md

@@ -341,6 +341,24 @@ a failed application callback after the external action has confirmed.
 - `onSubmit` on `SpiceSupply`, `SpiceLock`, `SpiceDeposit` and the shared controller fires once when the user submits and the SDK accepts it, before any wallet prompt. Use it for "transaction in progress" feedback instead of listening for clicks on SDK buttons.
 - `max()` on the shared controller (`useSpiceSupply`, `useSpiceLock`) resolves the fee-aware Max for the selected source, or `null` when there is none or the action fixes its output. The host sets the result as the amount.
 
+### Combined Cash balance
+
+Set `combineSourceBalances: true` on `SpiceSupply`, `SpiceLock`, `useSpiceSupply`,
+`useSpiceLock` or `useSpiceAction` to show a token in the embedded wallet and its
+mapped escrow balance on the same chain as one row, and to fund an action from
+both. It is off by default; without it, wallet and escrow balances stay separate
+rows and each action spends only the selected row.
+
+Routed actions use escrow first and deposit only the wallet shortfall. Actions
+paid in place keep wallet funds where they are and withdraw only the escrow
+shortfall. The reviewed quote fixes the amount taken from each balance, and both
+are checked again before signing.
+
+Custom presentations read `assets.selectable` and
+`assets.getAvailableBalance(asset)`, which returns the combined amount in the
+asset's raw units, or `undefined` while a balance cannot be verified. Pass the
+same getter to `AssetSelector`. Each physical `Asset.balance` is unchanged.
+
 ### Native action review
 
 `SpiceSupply` displays the actual fee total for `feeOnlyAction` even when no

package/dist/auth-privy.js

@@ -1,3 +1,3 @@
 "use client";
 (function(){if(typeof document==="undefined"||document.getElementById("spiceflow-styles"))return;var s=document.createElement("style");s.id="spiceflow-styles";s.textContent="@keyframes spiceflow-spin{0%{transform:rotate(0deg)}to{transform:rotate(1turn)}}@keyframes spin{0%{transform:rotate(0deg)}to{transform:rotate(1turn)}}@media (prefers-reduced-motion:reduce){*,:after,:before{animation-duration:.001ms!important;animation-iteration-count:1!important;scroll-behavior:auto!important;transition-duration:.001ms!important}}.spiceflow-focus-ring:focus-visible,[data-spiceflow-focus]:focus-visible{border-radius:4px;outline:2px solid currentColor;outline-offset:2px}@media (forced-colors:active){.spiceflow-focus-ring:focus-visible,[data-spiceflow-focus]:focus-visible{outline:2px solid Highlight}}.ibm-plex-mono-thin{font-weight:100}.ibm-plex-mono-extralight,.ibm-plex-mono-thin{font-family:IBM Plex Mono,monospace!important;font-style:normal}.ibm-plex-mono-extralight{font-weight:200}.ibm-plex-mono-light{font-weight:300}.ibm-plex-mono-light,.ibm-plex-mono-regular{font-family:IBM Plex Mono,monospace!important;font-style:normal}.ibm-plex-mono-regular{font-weight:400}.ibm-plex-mono-medium{font-weight:500}.ibm-plex-mono-medium,.ibm-plex-mono-semibold{font-family:IBM Plex Mono,monospace!important;font-style:normal}.ibm-plex-mono-semibold{font-weight:600}.ibm-plex-mono-bold{font-family:IBM Plex Mono,monospace!important;font-style:normal;font-weight:700}#privy-modal-content button{border-radius:6px;font-family:IBM Plex Mono,monospace!important;font-size:small;letter-spacing:-.5px;text-transform:uppercase}#privy-modal-content input{background:#fff;border-radius:6px;padding-top:5px!important}#privy-dialog-title{display:none!important;font-size:18px;padding-bottom:10px;padding-top:10px}.AppLogoContainer-sc-a206bd44-0{display:none}#privy-modal-content{background:var(--Neutral-0,#fafafa);border:6px solid var(--Neutral-1,#e9e9e9);box-shadow:inset 0 0 0 1px rgba(0,0,0,.15),0 330px 92px transparent,0 211px 84px rgba(0,0,0,.01),0 119px 71px rgba(0,0,0,.05),0 53px 53px rgba(0,0,0,.09),0 13px 29px rgba(0,0,0,.1);height:auto!important;padding-bottom:10px}.Subtitle-sc-ddbf22b4-4{font-size:12px;margin-top:-14px;opacity:.5}.StyledLink-sc-1c6127e5-0{background:none!important}.StyledLink-sc-c8577138-0,.login-method-button{font-family:IBM Plex Mono,monospace!important}.StyledLink-sc-c8577138-0{font-style:uppercase}#protected-by-privy{color:#000!important}";document.head.appendChild(s)})();
-import{P as g}from"./privy-CFh4iPTQ.js";import"react/jsx-runtime";import"react";import"@spicenet-io/spiceflow-core";import"@tanstack/react-query";import"viem";import"@privy-io/react-auth";import"wagmi";import"viem/actions";export{g as PrivyLogin};
+import{P as g}from"./privy-CU-4x5mW.js";import"react/jsx-runtime";import"react";import"@spicenet-io/spiceflow-core";import"@tanstack/react-query";import"viem";import"@privy-io/react-auth";import"wagmi";import"viem/actions";export{g as PrivyLogin};

package/dist/components/SpiceDeposit/lib/depositBatches.d.ts

@@ -1,6 +1,14 @@
+import { type Address } from "viem";
 import type { ChainBatch } from "../../../types/authorization";
 import type { SelectedAsset } from "../../../types/assets";
 import type { DepositModalProps, PostDepositContext } from "../../../types/deposit";
+export declare function buildEscrowDepositCalls({ escrowAddress, tokenAddress, isNative, amount, gasFeeAmount, }: {
+    escrowAddress: Address;
+    tokenAddress: Address;
+    isNative: boolean;
+    amount: bigint;
+    gasFeeAmount: bigint;
+}): ChainBatch["calls"];
 export declare function buildPostDepositContext({ sourceChainId, selectedAsset, destinationChainId, destinationTokenAddress, isCrossDenomination, convertedUsdAmount, }: {
     sourceChainId: number;
     selectedAsset: SelectedAsset;

package/dist/components/SpiceSupply/lib/buildBatches.d.ts

@@ -5,11 +5,13 @@ import type { SelectedAsset } from "../../../types/assets";
 import type { ChainBatch } from "../../../types/authorization";
 import type { DestinationTokenConfig, PivotRoute, SpiceSupplyProps, SupplyBatchBuildOptions } from "../../../types/supply";
 import type { ResolvedExactOutputSwap } from "../../../utils/swapQuotes";
+import { type CombinedSourceGroup } from "../../../utils/combinedSourceBalances";
 type EstimateFn = (chainBatches: ChainBatch[], tokenAddress: string, tokenTransferAmount: bigint, options?: ExecutionOptions) => Promise<FeeEstimateSummary>;
 export declare function getPivotEscrowAmount(sourceSwap: Pick<ResolvedSwap, "amountOutMinimum">, gasSkim: bigint): bigint;
 export declare function stripSpicenetFundingBatches(batches: ChainBatch[]): ChainBatch[];
 export declare function scaleTokenAmount(amount: bigint, fromDecimals: number, toDecimals: number): bigint;
 export interface BatchBuilderContext {
+    combinedSourceGroup?: CombinedSourceGroup;
     currentPaymentAmount: string;
     isFeeInclusiveInput?: boolean;
     feeOnlyAction?: boolean;

package/dist/components/SpiceSupply/lib/feeFunding.d.ts

@@ -18,6 +18,7 @@ export declare function rankFeeFundingCandidates(args: {
     balances: Asset[];
     order?: FeeFundingLevel[];
     reserve?: FeePreviewContext["feeFundingReserve"];
+    reserves?: FeePreviewContext["feeFundingReserves"];
 }): Candidate[];
 export declare function quoteFeeFunding(ctx: FeePreviewContext, estimateFeePreview: (ctx: FeePreviewContext) => Promise<SupplyFeeQuote | null>): Promise<SupplyFeeQuote | null>;
 export declare function quoteFundedAction(ctx: FeePreviewContext, batch: BatchBuilderContext, estimate: (ctx: FeePreviewContext) => Promise<SupplyFeeQuote | null>, outputProceeds?: boolean): Promise<SupplyFeeQuote | null>;

package/dist/components/SpiceSupply/lib/feePreview.d.ts

@@ -13,6 +13,8 @@ type EstimateFn = (chainBatches: ChainBatch[], tokenAddress: string, tokenTransf
 type BuildPayBatchesFn = (options?: SupplyBatchBuildOptions) => Promise<ChainBatch[]>;
 type BuildSupplyBatchesFn = (options?: SupplyBatchBuildOptions) => Promise<ChainBatch[]>;
 export type SupplyFeeQuote = {
+    sourceAllocation?: import("../../../utils/combinedSourceBalances").CombinedSourceAllocation;
+    feeSourceAllocation?: import("../../../utils/combinedSourceBalances").CombinedSourceAllocation;
     externalGasReserve?: ExternalGasReserve;
     fundedFeeToken?: DestinationTokenConfig;
     actionDefinition?: Parameters<NonNullable<SupplyBatchBuildOptions["onActionCalls"]>>[0];
@@ -97,6 +99,18 @@ export declare function estimateSupplyMaxAmount(ctx: {
     feeExecutionMode: SpiceSupplyProps["feeExecutionMode"];
 }): Promise<string | null>;
 export interface FeePreviewContext {
+    combinedSourceGroup?: import("../../../utils/combinedSourceBalances").CombinedSourceGroup;
+    getCombinedSourceGroup?: (asset: Asset, reserve?: {
+        asset: Asset;
+        amount: bigint;
+    } | {
+        asset: Asset;
+        amount: bigint;
+    }[]) => import("../../../utils/combinedSourceBalances").CombinedSourceGroup | undefined;
+    feeFundingReserves?: {
+        asset: Asset;
+        amount: bigint;
+    }[];
     externalGasRecipient?: Address;
     externalGasCalls?: (plan: SupplyFeeQuote) => Promise<ChainBatch["calls"]>;
     externalGasReserve?: ExternalGasReserve;

package/dist/components/SpiceWithdraw/lib/useEmbeddedWithdraw.d.ts

@@ -27,6 +27,7 @@ export declare function useSpiceEmbeddedWithdraw(params: {
             policyExcluded?: boolean;
         } | null;
         assets: {
+            getAvailableBalance: (asset: Asset) => bigint | undefined;
             selectable: Asset[];
             displayAssets: Asset[];
             filteredSpiceAssets: Asset[];
@@ -88,6 +89,7 @@ export declare function useSpiceEmbeddedWithdraw(params: {
             error: string | null;
         };
         amount: {
+            availableBalance: bigint | undefined;
             sourceRequiredAmount: bigint | null;
             parsed: number;
             isInsufficientBalance: boolean;

package/dist/hooks/useSpiceAction.d.ts

@@ -2,7 +2,7 @@ import { type Address } from "viem";
 import type { Asset, SelectedAsset } from "../types/assets";
 import type { DestinationTokenConfig, SpiceSupplyProps } from "../types/supply";
 export type SpiceActionSource = Asset;
-export interface UseSpiceActionOptions extends Pick<SpiceSupplyProps, "amountDirection" | "actionProceeds" | "feeFunding"> {
+export interface UseSpiceActionOptions extends Pick<SpiceSupplyProps, "amountDirection" | "actionProceeds" | "feeFunding" | "combineSourceBalances"> {
     destinationToken: DestinationTokenConfig | undefined;
     recipient?: Address;
     buildActionCalls: SpiceSupplyProps["buildActionCalls"];
@@ -17,6 +17,8 @@ export interface UseSpiceActionOptions extends Pick<SpiceSupplyProps, "amountDir
 }
 export declare function useSpiceAction({ amount, enabled, ...options }: UseSpiceActionOptions): {
     sources: Asset[];
+    getAvailableBalance: (asset: Asset) => bigint | undefined;
+    availableBalance: bigint | undefined;
     selectedAsset: SelectedAsset | null;
     setSelectedAsset: import("react").Dispatch<import("react").SetStateAction<SelectedAsset | null>>;
     selectAsset: (asset: Asset) => void;

package/dist/hooks/useSpiceLimitOrders.d.ts

@@ -1,6 +1,8 @@
 import { type CreateActionRequest } from "@spicenet-io/spiceflow-core";
 import type { LimitOrderInput, PreparedLimitOrder } from "../types/limitOrders";
-export declare function useSpiceLimitOrders(): {
+export declare function useSpiceLimitOrders(options?: {
+    combineSourceBalances?: boolean;
+}): {
     prepareOrder: (input: LimitOrderInput) => Promise<PreparedLimitOrder>;
     signOrder: (prepared: PreparedLimitOrder) => Promise<CreateActionRequest>;
     placeOrder: (request: CreateActionRequest) => Promise<import("..").LimitOrder>;

package/dist/hooks/useSpiceLock.d.ts

@@ -1,6 +1,6 @@
 import type { Asset, SelectedAsset } from "../types/assets";
 import type { SpiceLockModalProps } from "../types/lock";
-export interface UseSpiceLockParams extends Pick<SpiceLockModalProps, "lockBatches" | "lockChainId" | "lockTokenSymbol" | "lockTokenLogoURI" | "destinationTokenAddress" | "destinationTokenDecimals" | "beneficiary" | "onSubmit" | "onLockSuccess" | "onLockError" | "buildSpicenetBatch" | "feeFunding"> {
+export interface UseSpiceLockParams extends Pick<SpiceLockModalProps, "lockBatches" | "lockChainId" | "lockTokenSymbol" | "lockTokenLogoURI" | "destinationTokenAddress" | "destinationTokenDecimals" | "beneficiary" | "onSubmit" | "onLockSuccess" | "onLockError" | "buildSpicenetBatch" | "feeFunding" | "combineSourceBalances"> {
     enabled: boolean;
     selectedAsset: SelectedAsset | null;
     recoveryKey?: string;
@@ -52,6 +52,7 @@ export declare function useSpiceLock(params: UseSpiceLockParams): {
         policyExcluded?: boolean;
     } | null;
     assets: {
+        getAvailableBalance: (asset: Asset) => bigint | undefined;
         selectable: Asset[];
         displayAssets: Asset[];
         filteredSpiceAssets: Asset[];
@@ -85,6 +86,7 @@ export declare function useSpiceLock(params: UseSpiceLockParams): {
         error: string | null;
     };
     amount: {
+        availableBalance: bigint | undefined;
         sourceRequiredAmount: bigint | null;
         parsed: number;
         isInsufficientBalance: boolean;

package/dist/hooks/useSpiceSupply.d.ts

@@ -5,7 +5,7 @@ import { type SupplyFeeQuote } from "../components/SpiceSupply/lib/feePreview";
 import type { Asset, SelectedAsset } from "../types/assets";
 import type { DestinationTokenDeclaration, SpiceSupplyProps } from "../types/supply";
 import type { FeePreview } from "../types/ui";
-export interface UseSpiceSupplyParams extends Pick<SpiceSupplyProps, "sourceChains" | "supportedSourceAssets" | "buildActionCalls" | "feeExecutionMode" | "buildSpicenetBatch" | "onPayExecute" | "resolveExactOutputSwap" | "amountDirection" | "onSubmit" | "onSuccess" | "onError" | "additionalSourceTokens" | "includeExternalWalletAssets" | "includeCrossChainEmbeddedAssets" | "feeOnlyAction" | "actionInput" | "actionProceeds" | "feeFunding" | "maxSlippage" | "resolveInputSwap" | "feeFundingReserve" | "beforeSubmit" | "submitDisabled"> {
+export interface UseSpiceSupplyParams extends Pick<SpiceSupplyProps, "sourceChains" | "supportedSourceAssets" | "buildActionCalls" | "feeExecutionMode" | "buildSpicenetBatch" | "onPayExecute" | "resolveExactOutputSwap" | "amountDirection" | "onSubmit" | "onSuccess" | "onError" | "additionalSourceTokens" | "includeExternalWalletAssets" | "includeCrossChainEmbeddedAssets" | "combineSourceBalances" | "feeOnlyAction" | "actionInput" | "actionProceeds" | "feeFunding" | "maxSlippage" | "resolveInputSwap" | "feeFundingReserve" | "beforeSubmit" | "submitDisabled"> {
     quotedInclusivePlatformFee?: boolean;
     enabled?: boolean;
     destinationToken: DestinationTokenDeclaration | undefined;
@@ -29,6 +29,7 @@ export declare function useSpiceSupply(params: UseSpiceSupplyParams): {
         policyExcluded?: boolean;
     } | null;
     assets: {
+        getAvailableBalance: (asset: Asset) => bigint | undefined;
         selectable: Asset[];
         displayAssets: Asset[];
         filteredSpiceAssets: Asset[];
@@ -90,6 +91,7 @@ export declare function useSpiceSupply(params: UseSpiceSupplyParams): {
         error: string | null;
     };
     amount: {
+        availableBalance: bigint | undefined;
         sourceRequiredAmount: bigint | null;
         parsed: number;
         isInsufficientBalance: boolean;