@gibs/bridge-sdk 1.17.0 → 1.18.0

package/dist/routing/search/plan-route-data.js

@@ -1,6 +1,7 @@
 import * as imageLinks from '../../image-links.js';
 import { chainDisplayName } from '../../chain-names.js';
 import { findProviderById } from '../../providers.js';
+import { WRAP_CARRIER_ID, carrierProviderKey, carrierStepKind } from '../carrier-provider-key.js';
 import { describeDeferredCrossing } from '../../near-intents-route.js';
 import { candidateDeliveredUsd, candidateOutsideFeesUsd, candidatePaidUsd, pulsechainChainId, providerDisplayName, } from '../producers.js';
 import { assetNodeKey, planComposedBasis, } from './graph.js';
@@ -229,6 +230,8 @@ const hopProviderName = (carrier) => {
         return providerDisplayName(carrier);
     if (carrier === 'PulseX')
         return 'PulseX';
+    if (carrierStepKind(carrier) === 'wrap')
+        return 'Wrap';
     // TOTAL OVER EVERY CARRIER. The engine plans hops for carriers the provider
     // registry does not hold (a local wrap, a host's own plug-in). Casting such
     // an id to a provider id and asking the throwing lookup crashed the whole
@@ -350,11 +353,13 @@ const hopIsAutomatic = (hopIndex, plan) => {
  * @param plan - the plan the hop belongs to
  * @param resolveToken - resolves a graph node to its full display token
  * @param feeUsdValue - the hop's own share of its section's cost, or null
+ * @param gas - the hop's gas split, or null when the producer states none
  * @returns the raw hop data
  */
-const toRouteHopData = (hop, hopIndex, plan, resolveToken, feeUsdValue) => ({
+const toRouteHopData = (hop, hopIndex, plan, resolveToken, feeUsdValue, gas) => ({
     providerName: hopProviderName(hop.edge.carrier),
-    providerKey: hop.edge.carrier,
+    providerKey: carrierProviderKey(hop.edge.carrier),
+    stepKind: carrierStepKind(hop.edge.carrier),
     title: hopTitle(hop, hopIndex, plan, resolveToken),
     conversion: hopConversion(hop, hopIndex, plan, resolveToken),
     fromToken: toRouteTokenRef(hop.edge.from, resolveToken),
@@ -362,6 +367,7 @@ const toRouteHopData = (hop, hopIndex, plan, resolveToken, feeUsdValue) => ({
     // The per-hop dollar figure is a caller-supplied input (see this module's
     // head doc); the caller passes it in, never derived here.
     feeUsdValue,
+    ...(gas === null ? {} : gas),
     automatic: hopIsAutomatic(hopIndex, plan),
 });
 /**
@@ -502,8 +508,6 @@ export const derivePlanKind = (plan) => {
  * @param carrier - the plan's headline carrier
  * @returns the same value, typed as `ProviderKey`
  */
-/** The carrier id of the native-coin wrap step (`routing/carriers/wrap.ts`). */
-const WRAP_CARRIER = 'wrap';
 const toHeadlineProviderKey = (carrier) => {
     if (isBridgeCarrier(carrier))
         return carrier;
@@ -535,7 +539,7 @@ export const deriveHeadlineProviderKeyFromPlan = (plan) => toHeadlineProviderKey
  * @param plan - the plan to read
  * @returns the carrier to headline
  */
-const firstHeadlineCarrier = (plan) => plan.hops.find((hop) => hop.edge.carrier !== WRAP_CARRIER)?.edge.carrier ?? 'PulseX';
+const firstHeadlineCarrier = (plan) => plan.hops.find((hop) => hop.edge.carrier !== WRAP_CARRIER_ID)?.edge.carrier ?? 'PulseX';
 /**
  * The anchor a two-signature plan leaves the reader holding between its
  * first and second groups — `RouteCandidate.plan`'s own TSDoc: "the anchor
@@ -654,10 +658,13 @@ export const buildRouteDataFromPlan = (inputs) => {
         const landing = resolveNodeWithAssertedDecimals(lastHop.edge.to, resolveToken);
         const landingIsUnpriced = hopOutcomeIsUnpriced(lastHop);
         const hopFeeUsdValues = groupHopFeeUsdValues(pricing, group, groupIndex);
+        const statesGasSplit = pricing.feeExcludingGasUsdValue !== undefined;
+        const hopFeeExcludingGasUsdValues = pricing.hopFeeExcludingGasUsdValues;
         return {
             id: `${routeId}-signature-${groupIndex + 1}`,
             label: sectionLabel(group, groupIndex, plan),
-            providerKey: hops[0].edge.carrier,
+            providerKey: carrierProviderKey(hops[0].edge.carrier),
+            stepKind: carrierStepKind(hops[0].edge.carrier),
             tokenFlow: buildGroupTokenFlow(hops, resolveToken),
             landing: {
                 amount: sectionLandingAmount(pricing, lastHop),
@@ -667,10 +674,19 @@ export const buildRouteDataFromPlan = (inputs) => {
                 estimateBasis: hopEstimateBasis(lastHop),
             },
             feeUsdValue: pricing.feeUsdValue,
+            ...(statesGasSplit
+                ? { feeExcludingGasUsdValue: pricing.feeExcludingGasUsdValue, gasUsdValue: pricing.gasUsdValue ?? null }
+                : {}),
             fees: pricing.fees ? [...pricing.fees] : undefined,
             etaMinutes: pricing.etaMinutes,
             etaSeconds: pricing.etaSeconds,
-            hops: group.map((hopIndex, positionInGroup) => toRouteHopData(plan.hops[hopIndex], hopIndex, plan, resolveToken, hopFeeUsdValues[positionInGroup] ?? null)),
+            hops: group.map((hopIndex, positionInGroup) => toRouteHopData(plan.hops[hopIndex], hopIndex, plan, resolveToken, hopFeeUsdValues[positionInGroup] ?? null, statesGasSplit
+                ? {
+                    feeExcludingGasUsdValue: hopFeeExcludingGasUsdValues?.[positionInGroup] ??
+                        (group.length === 1 ? (pricing.feeExcludingGasUsdValue ?? null) : null),
+                    gasUsdValue: positionInGroup === 0 ? (pricing.gasUsdValue ?? null) : null,
+                }
+                : null)),
             deferred: groupIndex > 0 ? true : undefined,
             deferredNote: pricing.deferredNote,
         };
@@ -689,6 +705,13 @@ export const buildRouteDataFromPlan = (inputs) => {
             estimateBasis: lastSection.landing?.estimateBasis ?? null,
         },
         totalCostUsdValue,
+        ...(inputs.costExcludingGasUsdValue === undefined
+            ? {}
+            : {
+                costExcludingGasUsdValue: inputs.costExcludingGasUsdValue,
+                gasCostUsdValue: inputs.gasCostUsdValue ?? null,
+                gasByChain: [...(inputs.gasByChain ?? [])],
+            }),
         netValueUsd,
         etaMinutes,
         // The single legacy `viaChainId` a not-yet-migrated consumer may still

package/dist/routing/swap-transactions.d.ts

@@ -1,5 +1,6 @@
 import { type Hex } from 'viem';
 import { type SignedLeg } from '../settings.js';
+import type { SwapVenues } from '../swap-venues.js';
 import type { HopEdge, PlannedHop } from './search/graph.js';
 /**
  * The same-chain, one-signature transaction shape every sender in this file
@@ -27,7 +28,7 @@ export type SwapCallInputs = {
  * looking at) and the native-in/native-out/token-token branching.
  *
  * SIGNS ON THE EDGE'S OWN ROUTER. A PulseX edge names the deployment it was
- * quoted on (`pulseXRouterForEdge`: V1 or V2, each with its own pools). The
+ * quoted on (`venueForEdge`: V1 or V2, each with its own pools). The
  * caller's `routerAddress` must be that same router — it is also the router
  * the caller approved to spend the input token — or nothing is built. A V2
  * quote signed on V1 would trade against a different pool than the one the
@@ -35,8 +36,9 @@ export type SwapCallInputs = {
  *
  * @param options - the hop to swap, the amount and slippage-adjusted
  *   minimum, who receives the output, the signing deadline, what the caller
- *   believes this signature does (`signedLeg`), the chain it executes on, and
- *   the resolved router address
+ *   believes this signature does (`signedLeg`), the chain it executes on, the
+ *   resolved router address, and the swap venues the router must belong to
+ *   (the defaults when omitted)
  * @returns the swap transaction inputs, or null when the hop records no
  *   PulseX swap path, names no known router, `routerAddress` is not the
  *   edge's own router, the leg on screen disagrees, or any of
@@ -51,6 +53,8 @@ export declare const buildPulseXSwapTransaction: (options: {
     readonly signedLeg: SignedLeg | null;
     readonly chainId: number | null;
     readonly routerAddress: Hex | null;
+    /** The venues the edge's router must belong to. Omitted means the defaults. */
+    readonly venues?: SwapVenues;
 }) => SwapCallInputs | null;
 /**
  * Builds a native-coin wrap/unwrap transaction for one route-search graph

package/dist/routing/swap-transactions.js

@@ -1,6 +1,7 @@
 import { encodeFunctionData, isAddressEqual, parseAbi, zeroAddress } from 'viem';
 import { pulseXSwapTransactionInputs } from '../settings.js';
-import { pulseXRouterForEdge, pulseXSwapPathForHop } from './carriers/pulsex.js';
+import { defaultSwapVenues } from '../config.js';
+import { pulseXSwapPathForHop, venueForEdge } from './carriers/pulsex.js';
 /**
  * The minimal WETH9-style wrap/unwrap interface: `deposit()` mints the
  * wrapped token for the native coin sent with the call, `withdraw(uint256)`
@@ -29,7 +30,7 @@ const wrapAbi = parseAbi(['function deposit() payable', 'function withdraw(uint2
  * looking at) and the native-in/native-out/token-token branching.
  *
  * SIGNS ON THE EDGE'S OWN ROUTER. A PulseX edge names the deployment it was
- * quoted on (`pulseXRouterForEdge`: V1 or V2, each with its own pools). The
+ * quoted on (`venueForEdge`: V1 or V2, each with its own pools). The
  * caller's `routerAddress` must be that same router — it is also the router
  * the caller approved to spend the input token — or nothing is built. A V2
  * quote signed on V1 would trade against a different pool than the one the
@@ -37,8 +38,9 @@ const wrapAbi = parseAbi(['function deposit() payable', 'function withdraw(uint2
  *
  * @param options - the hop to swap, the amount and slippage-adjusted
  *   minimum, who receives the output, the signing deadline, what the caller
- *   believes this signature does (`signedLeg`), the chain it executes on, and
- *   the resolved router address
+ *   believes this signature does (`signedLeg`), the chain it executes on, the
+ *   resolved router address, and the swap venues the router must belong to
+ *   (the defaults when omitted)
  * @returns the swap transaction inputs, or null when the hop records no
  *   PulseX swap path, names no known router, `routerAddress` is not the
  *   edge's own router, the leg on screen disagrees, or any of
@@ -51,7 +53,7 @@ export const buildPulseXSwapTransaction = (options) => {
     if (swapPath === null) {
         return null;
     }
-    const quotedRouter = pulseXRouterForEdge(edge);
+    const quotedRouter = venueForEdge(options.venues ?? defaultSwapVenues, edge)?.router ?? null;
     if (quotedRouter === null || routerAddress === null || !isAddressEqual(quotedRouter, routerAddress)) {
         return null;
     }

package/dist/swap-venues.d.ts

@@ -0,0 +1,43 @@
+import type { Hex } from 'viem';
+/**
+ * A place a same-chain token swap can execute. Today only Uniswap-V2-shaped
+ * routers exist: `getAmountsOut`, `swapExactTokensForTokens`,
+ * `swapExactETHForTokens`, `swapExactTokensForETH`, a factory with
+ * `getPair`, and pairs with `getReserves`. The `kind` field leaves room for
+ * other shapes (for example `'uniswap-v3'`) without breaking callers.
+ */
+export type SwapVenue = {
+    /** The router shape. Only `'uniswap-v2'` is supported. */
+    readonly kind: 'uniswap-v2';
+    /** The numeric chain id the router lives on. */
+    readonly chainId: number;
+    /** The router a swap is signed on. It is also the token approval spender. */
+    readonly router: Hex;
+    /** The factory whose pools the router trades against. */
+    readonly factory: Hex;
+    /** The swap fee in basis points: 29 for PulseX, 30 for Uniswap V2 forks. */
+    readonly feeBasisPoints: number;
+    /** A name for logs and displays. */
+    readonly label?: string;
+};
+/** The venues on each chain, keyed by numeric chain id. The first venue of a chain is its default. */
+export type SwapVenues = Readonly<Record<number, readonly SwapVenue[]>>;
+/**
+ * Merges caller venues over {@link defaultSwapVenues}. A chain present in
+ * `overrides` replaces the default list for that chain. A chain absent from
+ * `overrides` keeps its default list. An empty list switches swaps off on
+ * that chain. Neither input is changed; the result is frozen.
+ *
+ * @param overrides - the caller's venues, or undefined for the defaults
+ * @returns the venues to use
+ */
+export declare const resolveSwapVenues: (overrides?: SwapVenues) => SwapVenues;
+/**
+ * Finds the venue on a chain that has the given router.
+ *
+ * @param venues - the venues to search
+ * @param chainId - the numeric chain id
+ * @param router - the router address, in any letter case
+ * @returns the venue, or null when the chain has no venue with that router
+ */
+export declare const findSwapVenue: (venues: SwapVenues, chainId: number, router: Hex) => SwapVenue | null;

package/dist/swap-venues.js

@@ -0,0 +1,24 @@
+import { defaultSwapVenues } from './config.js';
+/**
+ * Merges caller venues over {@link defaultSwapVenues}. A chain present in
+ * `overrides` replaces the default list for that chain. A chain absent from
+ * `overrides` keeps its default list. An empty list switches swaps off on
+ * that chain. Neither input is changed; the result is frozen.
+ *
+ * @param overrides - the caller's venues, or undefined for the defaults
+ * @returns the venues to use
+ */
+export const resolveSwapVenues = (overrides) => {
+    if (overrides === undefined)
+        return defaultSwapVenues;
+    return Object.freeze({ ...defaultSwapVenues, ...overrides });
+};
+/**
+ * Finds the venue on a chain that has the given router.
+ *
+ * @param venues - the venues to search
+ * @param chainId - the numeric chain id
+ * @param router - the router address, in any letter case
+ * @returns the venue, or null when the chain has no venue with that router
+ */
+export const findSwapVenue = (venues, chainId, router) => venues[chainId]?.find((venue) => venue.router.toLowerCase() === router.toLowerCase()) ?? null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibs/bridge-sdk",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "Build and price cross-chain transfers between PulseChain, Ethereum, and Binance Smart Chain.",
   "keywords": [
     "ethereum",
@@ -1007,8 +1007,8 @@
     "test:live:near-intents": "../../scripts/near-intents-live.sh"
   },
   "dependencies": {
-    "@gibs/abis": "^1.17.0",
-    "@gibs/common": "^1.17.0",
+    "@gibs/abis": "^1.18.0",
+    "@gibs/common": "^1.18.0",
     "@ton/core": "^0.63.1",
     "@ton/crypto": "^3.3.0"
   },