@spicenet-io/spiceflow-ui 4.8.0-rc.0 → 4.8.0

package/README.md

@@ -35,6 +35,67 @@ function App() {
 }
 ```
 
+## Liquidity venues
+
+When a flow has to swap on the destination chain, the SDK quotes every liquidity
+venue that covers that chain and takes the best fill: the most output on a
+supply, the least input on a pay. Routing is decided here, on your RPC. The
+solver only executes the calls the winning quote produced.
+
+Leave `liquidityVenues` off and you get the built-in venues. Declare it once on
+the provider to add your own, and every component picks them up.
+
+```tsx
+<SpiceFlowProvider
+  network="mainnet"
+  nativeChainId={4663}
+  rpcOverrides={{ 4663: ROBINHOOD_RPC }}
+  liquidityVenues={{
+    venues: [
+      {
+        protocol: "uniswap-v3",
+        chainId: 4663,
+        swapRouter: "0x1e406484F1F204b23cE84B9901C0171a738fd406",
+        quoterV2: "0x3E290e5E01818002A0b672148BdC7514D861C7B3",
+        hubCurrencies: ["0x0bd7d308f8e1639fab988df18a8011f41eacad73"],
+      },
+    ],
+  }}
+>
+```
+
+Your venues race the built-ins on price; they do not override them. Set
+`includeDefaults: false` to drop the built-ins and route only through what you
+declared. On a chain with no venue at all, quoting fails with that chain named
+rather than falling back to something you did not configure.
+
+Every entry names one chain and one protocol family, and serves both swap
+directions. Supply the **deployment's** addresses, not a pool address: a
+v3-style pool calls back into `msg.sender`, so swaps go through the router and
+quotes through the quoter. The SDK finds the pools from the fee tiers (or tick
+spacings) and hub currencies.
+
+| `protocol`             | Required                                          | Optional                                                 |
+| ---------------------- | ------------------------------------------------- | -------------------------------------------------------- |
+| `uniswap-v3`           | `chainId`, `swapRouter`, `quoterV2`               | `name`, `feeTiers`, `hubCurrencies`, `routerHasDeadline` |
+| `uniswap-v4`           | `chainId`, `quoter`, `universalRouter`, `permit2` | `name`, `hubCurrencies`                                  |
+| `aerodrome-slipstream` | `chainId`, `swapRouter`, `quoterV2`               | `name`, `tickSpacings`, `hubCurrencies`                  |
+
+`name` is the label shown to the user as "via <name>" once a swap is quoted, so
+give it the name people know the venue by. It defaults to the protocol, which
+means a swap always names something real rather than a family it does not belong
+to.
+
+`hubCurrencies` are the intermediate tokens tried for two-hop routes, usually
+wrapped native and the chain's main stablecoin. Set `routerHasDeadline` when the
+deployment forked the original Uniswap `SwapRouter`, whose exact-output structs
+carry a deadline; SwapRouter02 forks do not.
+
+Most DEXs are forks of one of these families, so adding one is addresses only.
+A venue from a different family (a Uniswap v2 pair, Curve, Balancer) needs an
+adapter in the SDK — send us the chain, router, quoter and one funded pool and
+it becomes a `protocol` everyone can name.
+
 ## Components
 
 - **SwapWidget** - Main swap interface component
@@ -66,13 +127,17 @@ bun run build
 bun run typecheck
 ```
 
-### Linting
+CI runs this on every pull request, so a type error fails the build.
+
+### Formatting
 
 ```bash
-bun run lint
-bun run lint:fix
+bun run format
 ```
 
+Prettier runs over staged files on commit via lint-staged. There is no ESLint
+setup in this repository.
+
 ## Component Playground
 
 This repository includes a lightweight React playground app for viewing and testing all components without the complexity of Storybook.

package/dist/auth-privy.cjs.js

@@ -1,2 +1,2 @@
 "use client";
-"use strict";const r=require("./privy-DB3mdjuj.js");require("react/jsx-runtime"),require("react"),require("@spicenet-io/spiceflow-core"),require("viem"),require("viem/actions"),require("@privy-io/react-auth"),require("wagmi"),require("@tanstack/react-query"),exports.PrivyLogin=r.PrivyLogin;
+"use strict";const r=require("./privy-ROtJpoJf.js");require("react/jsx-runtime"),require("react"),require("@spicenet-io/spiceflow-core"),require("viem"),require("viem/actions"),require("@privy-io/react-auth"),require("wagmi"),require("@tanstack/react-query"),exports.PrivyLogin=r.PrivyLogin;

package/dist/auth-privy.js

@@ -1,2 +1,2 @@
 "use client";
-import{P as g}from"./privy-CRGZIHW9.js";import"react/jsx-runtime";import"react";import"@spicenet-io/spiceflow-core";import"viem";import"viem/actions";import"@privy-io/react-auth";import"wagmi";import"@tanstack/react-query";export{g as PrivyLogin};
+import{P as g}from"./privy-CKRpUHB_.js";import"react/jsx-runtime";import"react";import"@spicenet-io/spiceflow-core";import"viem";import"viem/actions";import"@privy-io/react-auth";import"wagmi";import"@tanstack/react-query";export{g as PrivyLogin};

package/dist/components/AccountDisplay/parts/AccountActions.d.ts

@@ -2,7 +2,6 @@ import React from "react";
 interface AccountActionsProps {
     onDepositClick?: () => void;
     onWithdrawClick?: () => void;
-    onDisconnectClick: () => void;
     depositDisabled?: boolean;
     withdrawDisabled?: boolean;
     primaryColor?: string;

package/dist/components/AccountDisplay/parts/AccountPanel.d.ts

@@ -18,7 +18,6 @@ interface AccountPanelProps {
     notice?: AccountNotice | null;
     onDepositClick?: () => void;
     onWithdrawClick?: () => void;
-    onDisconnectClick: () => void;
     depositDisabled?: boolean;
     onCompleteDeposit?: (deposit: VerifiedPendingDeposit) => void;
     primaryColor?: string;

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

@@ -0,0 +1,35 @@
+import { type Address } from "viem";
+import type { SupportedDepositOption, SwapperEmbedOptions, SwapperStyles } from "@swapper-finance/deposit-sdk";
+import { type Token } from "@spicenet-io/spiceflow-core";
+import type { DepositSource, SpiceSwapperConfig, SwapperEmbedFactory } from "../../../types/deposit";
+import type { ResolvedDarkPalette } from "../../../utils/theme";
+export declare const DEFAULT_SWAPPER_INTEGRATOR_ID = "692fb8af264069ca12a9";
+export declare const SWAPPER_FALLBACK_DESTINATION_CHAIN_ID = 42161;
+export declare const SWAPPER_SUPPORTED_DESTINATION_CHAIN_IDS: readonly number[];
+export declare function resolveSwapperDestinationChainId(params: {
+    targetKind: "external" | "embedded";
+    appChainId?: number;
+}): number;
+export declare function getSwapperDestinationToken(chainId?: number): Token | undefined;
+export declare function resolveSwapperConfig(config?: SpiceSwapperConfig): {
+    integratorId: string;
+    enabled: boolean;
+    embedFactory?: SwapperEmbedFactory;
+};
+export declare const defaultSwapperEmbedFactory: SwapperEmbedFactory;
+export declare function buildSwapperStyles(dk: ResolvedDarkPalette, dark: boolean, primaryColor: string): SwapperStyles;
+export declare function getSupportedDepositOptions(source: Exclude<DepositSource, "wallet"> | null): SupportedDepositOption[];
+export declare function buildSwapperOptions(params: {
+    integratorId: string;
+    depositWalletAddress: Address;
+    source: Exclude<DepositSource, "wallet"> | null;
+    styles: SwapperStyles;
+    destinationChainId?: number;
+}): SwapperEmbedOptions;
+export declare function readSwapperUsdcBalance(targetAddress: Address, chainId?: number): Promise<bigint>;
+export declare function waitForUsdcArrival(targetAddress: Address, baseline: bigint, options?: {
+    timeoutMs?: number;
+    intervalMs?: number;
+    signal?: AbortSignal;
+    chainId?: number;
+}): Promise<bigint | null>;

package/dist/components/SpiceDeposit/steps/SelectSourceModal.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { SelectSourceModalProps } from "../../../types/deposit";
+export declare const SelectSourceModal: React.FC<SelectSourceModalProps>;

package/dist/components/SpiceDeposit/steps/SwapperDepositModal.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { SwapperDepositModalProps } from "../../../types/deposit";
+export declare const SwapperDepositModal: React.FC<SwapperDepositModalProps>;

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

@@ -7,7 +7,6 @@ import type { ResolvedExactOutputSwap } from "../../../utils/swapQuotes";
 import type { ExecutionOptions } from "../../../hooks/useSpiceExecution";
 import type { FeeEstimateSummary } from "@spicenet-io/spiceflow-core";
 type EstimateFn = (chainBatches: ChainBatch[], tokenAddress: string, tokenTransferAmount: bigint, options?: ExecutionOptions) => Promise<FeeEstimateSummary>;
-export declare function buildEmbeddedEscrowDepositBatch(token: Address, amount: bigint, chainId: number): ChainBatch;
 export declare function stripSpicenetFundingBatches(batches: ChainBatch[]): ChainBatch[];
 export declare function scaleTokenAmount(amount: bigint, fromDecimals: number, toDecimals: number): bigint;
 export interface BatchBuilderContext {

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

@@ -12,14 +12,12 @@ export type PaymentResult = {
     txHash?: string;
     error?: string;
 };
-export declare function isExternalSource(asset: SelectedAsset["asset"] | null | undefined, isNon7702: boolean): boolean;
 export type ExecutorContext = {
     selectedAsset: SelectedAsset | null;
     parsedAmount: number;
     currentPaymentAmount: string;
     isInsufficientBalance: boolean;
     isPayMode: boolean;
-    isFeeInclusiveInput: boolean;
     isNon7702: boolean;
     isSourceDestToken: boolean;
     needsSwap: boolean;

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

@@ -36,7 +36,6 @@ export declare function estimatePayFunding(args: {
 export declare function estimateSupplyMaxAmount(ctx: {
     asset: Asset;
     isPayMode: boolean;
-    isFeeInclusiveInput?: boolean;
     isNon7702: boolean;
     needsSwap: boolean;
     isQuoting: boolean;
@@ -50,7 +49,6 @@ export interface FeePreviewContext {
     signal?: AbortSignal;
     selectedAsset: SelectedAsset | null;
     isPayMode: boolean;
-    isFeeInclusiveInput?: boolean;
     parsedAmount: number;
     needsSwap: boolean;
     exactOutputSwap: ResolvedExactOutputSwap | null;

package/dist/execution/fundEmbeddedWallet.d.ts

@@ -6,13 +6,6 @@ export declare function sendTokenTransferTx(extWc: any, params: {
     amount: bigint;
     viemChain?: unknown;
 }): Promise<`0x${string}`>;
-export declare function readEmbeddedShortfall(params: {
-    sourceClient: any;
-    holder: Address;
-    tokenAddr: Address;
-    isNative: boolean;
-    amount: bigint;
-}): Promise<bigint>;
 export declare function fundEmbeddedWallet(params: {
     extWc: any;
     sourceClient: any;

package/dist/hooks/index.d.ts

@@ -19,5 +19,3 @@ export type { PartnerWhitelistCheckResponse, UseIsUserWhitelistedOptions, } from
 export { useSupplyAssets, isSupportedSupplyAsset } from "./useSupplyAssets";
 export { useSupplyQuote, resolveInputSupplySwapQuote } from "./useSupplyQuote";
 export type { UseSupplyQuoteOpts, SupplyQuoteResult } from "./useSupplyQuote";
-export { useSpiceSupply } from "./useSpiceSupply";
-export type { UseSpiceSupplyParams, UseSpiceSupplyResult, } from "./useSpiceSupply";

package/dist/hooks/useSupplyAssets.d.ts

@@ -1,6 +1,6 @@
 import { type Address } from "viem";
 import type { Asset } from "../types/assets";
-export declare function isSupportedSupplyAsset(asset: Pick<Asset, "address" | "chainTokens" | "isNative">, supportedSourceAssets?: string[]): boolean;
+export declare function isSupportedSupplyAsset(asset: Pick<Asset, "address" | "chainTokens">, supportedSourceAssets?: string[]): boolean;
 type DestinationToken = {
     address: Address;
     decimals: number;
@@ -14,11 +14,9 @@ export declare function useSupplyAssets(opts: {
     supportedSourceAssets?: string[];
     sourceChains?: number[];
     enabled: boolean;
-    includeExternalWalletAssets?: boolean;
 }): {
     displayAssets: (Asset & {
         _source: "wallet" | "spice";
-        _fundingWallet?: "embedded" | "external";
     })[];
     filteredSpiceAssets: Asset[];
     walletAssets: Asset[];

package/dist/hooks/useSupplyQuote.d.ts

@@ -1,5 +1,6 @@
 import { type Address } from "viem";
-import type { LiquidityVenue, ResolvedSwap } from "../utils/crossChainRouter/liquidityVenues";
+import { type LiquidityVenuesConfig } from "../utils/crossChainRouter/venueConfig";
+import type { ResolvedSwap } from "../utils/crossChainRouter/liquidityVenues";
 import { type ExactOutputSwapIntent, type ResolvedExactOutputSwap } from "../utils/swapQuotes";
 import type { SelectedAsset } from "../types/assets";
 export interface UseSupplyQuoteOpts {
@@ -14,8 +15,6 @@ export interface UseSupplyQuoteOpts {
     chainId: number;
     recipient: Address | undefined;
     paymentAmount?: string;
-    maxSlippage?: number;
-    resolveInputSwap?: LiquidityVenue["resolve"];
     resolveExactOutputSwap?: (intent: ExactOutputSwapIntent, chainId: number, recipient: Address) => Promise<ResolvedExactOutputSwap | null>;
 }
 export interface SupplyQuoteResult {
@@ -37,6 +36,6 @@ export declare function resolveInputSupplySwapQuote(params: {
     tokenIn: Address;
     tokenOut: Address;
     amountIn: bigint;
-    maxSlippage?: number;
+    liquidityVenues?: LiquidityVenuesConfig;
 }): Promise<ResolvedSwap>;
 export declare function useSupplyQuote(opts: UseSupplyQuoteOpts): SupplyQuoteResult;

package/dist/hooks/useSwapperEmbed.d.ts

@@ -0,0 +1,23 @@
+import type { Address } from "viem";
+import type { DepositSource, SwapperEmbedFactory, SwapperTransactionSuccessEvent } from "../types/deposit";
+import type { ResolvedDarkPalette } from "../utils/theme";
+type WidgetSource = Exclude<DepositSource, "wallet">;
+interface UseSwapperEmbedParams {
+    enabled: boolean;
+    integratorId: string;
+    depositWalletAddress?: Address;
+    destinationChainId?: number;
+    brand: {
+        dk: ResolvedDarkPalette;
+        dark: boolean;
+        primaryColor: string;
+    };
+    embedFactory?: SwapperEmbedFactory;
+    onTransactionSuccess: (event?: SwapperTransactionSuccessEvent) => void;
+    onCloseRequest: () => void;
+}
+export declare function useSwapperEmbed({ enabled, integratorId, depositWalletAddress, destinationChainId, brand, embedFactory, onTransactionSuccess, onCloseRequest, }: UseSwapperEmbedParams): {
+    showWidget: (placeholder: HTMLElement, source: WidgetSource) => void;
+    hideWidget: () => void;
+};
+export {};