@spicenet-io/spiceflow-ui 4.7.11 → 4.8.0-venues.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

package/dist/auth-privy.cjs.js

@@ -1,2 +1,2 @@
 "use client";
-"use strict";const r=require("./privy-BXdQgePJ.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-DinsCCJf.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/hooks/useSupplyQuote.d.ts

@@ -1,4 +1,5 @@
 import { type Address } from "viem";
+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";
@@ -35,5 +36,6 @@ export declare function resolveInputSupplySwapQuote(params: {
     tokenIn: Address;
     tokenOut: Address;
     amountIn: bigint;
+    liquidityVenues?: LiquidityVenuesConfig;
 }): Promise<ResolvedSwap>;
 export declare function useSupplyQuote(opts: UseSupplyQuoteOpts): SupplyQuoteResult;