@gibs/bridge-sdk 1.19.0 → 1.20.0

package/dist/cjs/routing/entry-chain-anchor.js

@@ -4,27 +4,6 @@ exports.entryChainAnchorsForPair = void 0;
 const viem_1 = require("viem");
 const config_js_1 = require("../config.js");
 const ecosystems_js_1 = require("../ecosystems.js");
-/**
- * Builds the ordered anchor list for one destination pair, cheapest and
- * shortest first.
- *
- * The list is ordered, not ranked: a caller asks the aggregator for the first
- * entry and moves to the next only on a refusal. That keeps the cost at ONE
- * vendor request in the ordinary case, which matters against a limit of
- * twelve hundred requests per sixty seconds.
- *
- * The substitution is narrow ON PURPOSE. Only the chain's wrapped native
- * asset gains a second anchor, because only the native coin mints the same
- * PulseChain token. A USD Coin pair does not gain an ether anchor here —
- * ether would land as bridged ether, a different token, needing a different
- * swap path. That is a different DESTINATION PAIR, and choosing between pairs
- * is made by the route engine, which holds every destination pair.
- *
- * @param options.entryChainToken - the destination pair's entry-chain side
- * @param options.pulsechainToken - the destination pair's PulseChain side
- * @param options.entryChainId - the omnibridge entry chain's decimal id
- * @returns the anchors to try, in order; never empty
- */
 const entryChainAnchorsForPair = ({ entryChainToken, pulsechainToken, entryChainId, }) => {
     const pairAnchor = {
         token: entryChainToken,
@@ -33,9 +12,6 @@ const entryChainAnchorsForPair = ({ entryChainToken, pulsechainToken, entryChain
         landsAs: pulsechainToken,
     };
     const entryChain = (0, config_js_1.toChain)(entryChainId);
-    // `nativeAssetOut` is typed as a total record and is not one — `toChain` is a
-    // cast, so an unmapped chain id yields a key that indexes to undefined. The
-    // runtime check outlives the static type on purpose.
     const wrappedNativeAddress = config_js_1.nativeAssetOut[entryChain];
     if (wrappedNativeAddress === undefined ||
         !(0, ecosystems_js_1.sameAddress)(entryChainToken.address, wrappedNativeAddress, 'evm')) {
@@ -43,9 +19,6 @@ const entryChainAnchorsForPair = ({ entryChainToken, pulsechainToken, entryChain
     }
     const nativeAnchor = {
         token: {
-            // Decimals and name come from the WRAPPED token rather than from a
-            // constant, because the wrapped asset mirrors its coin exactly and a
-            // hard-coded eighteen would be a second source of the same fact.
             ...entryChainToken,
             address: viem_1.zeroAddress,
             symbol: config_js_1.nativeTokenSymbol[entryChain] ?? entryChainToken.symbol,

package/dist/cjs/routing/format.js

@@ -1,60 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.roundUsdToCents = exports.formatUsdNullable = exports.formatUsd = void 0;
-/**
- * Formats a United States dollar number to a cent-precise string ("1,234.50",
- * or "1.234,50" in German). No leading currency symbol — callers prepend it
- * where the design needs one. The single source of truth shared by the raw
- * producers (cent-rounding) and the display adapter (final formatting).
- *
- * `locale` defaults to `'en-US'` so every caller that does not read the
- * reader's own language — the raw producers, and every existing test —
- * keeps today's exact string. THE DISPLAY ADAPTER (`toRouteView.ts`) is the
- * one caller that should pass the reader's own Lingui locale (`i18n.locale`):
- * without it, the route strip's dollar figures stayed English-formatted
- * inside every other translated screen, the one number on the page that
- * never adopted the reader's language. The digit count never moves — only
- * `toLocaleString`'s grouping and decimal separators do, per
- * `minimumFractionDigits`/`maximumFractionDigits` staying pinned at 2.
- *
- * @param value - the United States dollar amount as a number
- * @param locale - a BCP 47 locale tag to format with; defaults to `'en-US'`
- * @returns the formatted two-decimal string, without a leading `$`
- */
 const formatUsd = (value, locale = 'en-US') => value.toLocaleString(locale, { minimumFractionDigits: 2, maximumFractionDigits: 2 });
 exports.formatUsd = formatUsd;
-/**
- * Nullable {@link formatUsd}: null/undefined pass through as null so an unpriced
- * value renders as absent rather than "0.00".
- *
- * @param value - the United States dollar amount, or null/undefined when unknown
- * @param locale - a BCP 47 locale tag to format with; defaults to `'en-US'`
- * @returns the formatted string, or null when the value is absent
- */
 const formatUsdNullable = (value, locale) => value === null || value === undefined ? null : (0, exports.formatUsd)(value, locale);
 exports.formatUsdNullable = formatUsdNullable;
-/**
- * Rounds a United States dollar amount to whole cents.
- *
- * This replaces cent-rounding that went through the DISPLAY formatter and parsed
- * the result back — `Number(formatUsd(value).replace(/,/g, ''))`. That works
- * only while the display is pinned to a locale which groups with commas and
- * decimalises with a dot. The moment money follows the reader's language, a
- * German build formats 1234.56 as "1.234,56", and stripping the commas from THAT
- * yields 1.23456: a fee understated by a factor of a thousand, silently, with no
- * NaN anywhere to make it visible.
- *
- * It keeps its OWN formatter rather than borrowing the display one, pinned to a
- * fixed locale and with grouping switched off, so the string it parses has no
- * separators to strip and no locale to disagree with. That also makes it exact
- * rather than merely close: `Math.round(value * 100) / 100` looks equivalent and
- * is not, because it rounds the binary double while the formatter rounds the
- * decimal the reader typed — they disagree on 1.005, giving 1.00 against 1.01.
- * Matching the old behaviour to the cent is the point, so the old engine stays.
- *
- * @param value - the United States dollar amount
- * @returns the amount rounded to two decimal places
- */
 const centRounder = new Intl.NumberFormat('en-US', {
     minimumFractionDigits: 2,
     maximumFractionDigits: 2,

package/dist/cjs/routing/index.js

@@ -2,12 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.composableHopBasis = exports.routePlanPathKey = exports.planIsRankable = exports.planIsConfirmed = exports.planComposedBasis = exports.isRateLimitedCarrier = exports.isRankableBasis = exports.isConfirmedBasis = exports.hopEdgeKey = exports.hopComposedBasis = exports.groupHopsBySignature = exports.compareRoutePlansByDeliveredAmount = exports.combineComposedPathBasis = exports.assetNodeKey = exports.RANKABLE_ESTIMATE_BASES = exports.candidatePaidUsd = exports.candidateOutsideFeesUsd = exports.candidateNetValueUsd = exports.candidateDeliveredUsd = exports.buildSameChainSwapRouteData = exports.buildOutboundRouteData = exports.buildPulseXSwapSectionData = exports.buildPulseXSwapEstimateData = exports.buildDirectRouteData = exports.buildConversionRouteData = exports.buildCandidateRouteData = exports.resolveEntryChainName = exports.providerDisplayName = exports.addUsdValues = exports.pulsechainChainId = exports.PULSEX_MARGINAL_REFERENCE_DIVISOR = exports.BRIDGE_SETTLEMENT_ETA_MINUTES = exports.formatUsdNullable = exports.formatUsd = exports.usdValueOfAmount = exports.entryChainAnchorsForPair = exports.composedRouteMayBeOffered = exports.assessComposedRoute = exports.COMPOSED_ROUTE_MAX_VALUE_LOSS_PERCENT = exports.COMPOSED_ROUTE_MAX_VALUE_GAIN_PERCENT = exports.COMPOSED_ROUTE_MAX_PRICE_IMPACT_PERCENT = exports.routeSignatureCountForAccount = exports.routeSignatureCount = exports.buildRouteDataForCandidate = exports.buildDirectCrossingCandidate = exports.pulseXConversionSwapPath = exports.omnibridgeProviderForEntryChain = exports.valueEquivalentAmount = exports.restateInDecimals = exports.netDeliveredAmount = void 0;
 exports.swapMinimumOut = exports.buildWrapTransaction = exports.buildPulseXSwapTransaction = exports.createWrapCarrier = exports.resolveSwapVenues = exports.findSwapVenue = exports.pulseXHubTokens = exports.candidatePulseXPaths = exports.bestPulseXPathQuote = exports.pulseXWrappedNativePath = exports.pulseXVenues = exports.pulseXSwapPathForHop = exports.venueForEdge = exports.pulseXRouterForEdge = exports.createPulseXCarrier = exports.withOmnibridgeEntryFusing = exports.createOmnibridgeCarrier = exports.derivePlanKind = exports.deriveViaChainIdsFromPlan = exports.deriveOmnibridgeProviderFromPlan = exports.deriveEntryChainIdFromPlan = exports.deriveDeferredCrossingFromPlan = exports.buildRouteScoreInputsFromPlan = exports.buildRouteDataFromPlan = exports.buildRouteCandidateFromPlan = exports.carrierStepKind = exports.carrierProviderKey = exports.WRAP_CARRIER_ID = exports.zeroGasCostFor = exports.waitPenaltyPpm = exports.sectionIsFundedByLanding = exports.scoreRoutePlan = exports.gasAdjustedDeliveredAmount = exports.compareRoutePlansByScoreAdjustedDeliveredAmount = exports.compareRoutePlansByGasAdjustedDeliveredAmount = exports.SIGNATURE_PENALTY_PPM = exports.SIGNATURE_PENALTY_FLOOR_USD = exports.GAS_TOPUP_PENALTY_PPM = exports.GAS_TOPUP_PENALTY_FLOOR_USD = exports.hopOutputAmount = exports.composeRouteDelivery = void 0;
-/**
- * Framework-agnostic routing core for the Gibs bridge. Holds the raw numeric
- * primitives, the candidate shape, and candidate construction — none of which
- * depend on React or any display formatting. Display-coupled route builders
- * remain in the user interface until the raw-versus-view RouteOption split.
- */
 var amounts_js_1 = require("./amounts.js");
 Object.defineProperty(exports, "netDeliveredAmount", { enumerable: true, get: function () { return amounts_js_1.netDeliveredAmount; } });
 Object.defineProperty(exports, "restateInDecimals", { enumerable: true, get: function () { return amounts_js_1.restateInDecimals; } });
@@ -52,16 +46,6 @@ Object.defineProperty(exports, "candidateDeliveredUsd", { enumerable: true, get:
 Object.defineProperty(exports, "candidateNetValueUsd", { enumerable: true, get: function () { return producers_js_1.candidateNetValueUsd; } });
 Object.defineProperty(exports, "candidateOutsideFeesUsd", { enumerable: true, get: function () { return producers_js_1.candidateOutsideFeesUsd; } });
 Object.defineProperty(exports, "candidatePaidUsd", { enumerable: true, get: function () { return producers_js_1.candidatePaidUsd; } });
-// The route-search engine's pure data model: node/edge shapes, path keying,
-// signature grouping, and the basis/rankability rules. The SEARCH ORCHESTRATION
-// built on top of this (`capabilities.ts`, `enumerate.ts`, `waves.ts`) now
-// lives in `@gibs/quotes`'s `search/` directory, carrier-agnostic — see
-// `docs/quote-service.md`'s "Carriers" section. This module stays here
-// because `search/plan-route-data.ts` (gibs's presentation layer, below)
-// calls its functions directly and `bridge-sdk` cannot depend on `@gibs/quotes`
-// (which already depends on `bridge-sdk`) without a circular package
-// dependency; `@gibs/quotes`'s `types.ts` re-exports the same declarations
-// under its `Carrier*` names.
 var graph_js_1 = require("./search/graph.js");
 Object.defineProperty(exports, "RANKABLE_ESTIMATE_BASES", { enumerable: true, get: function () { return graph_js_1.RANKABLE_ESTIMATE_BASES; } });
 Object.defineProperty(exports, "assetNodeKey", { enumerable: true, get: function () { return graph_js_1.assetNodeKey; } });
@@ -97,9 +81,6 @@ var carrier_provider_key_js_1 = require("./carrier-provider-key.js");
 Object.defineProperty(exports, "WRAP_CARRIER_ID", { enumerable: true, get: function () { return carrier_provider_key_js_1.WRAP_CARRIER_ID; } });
 Object.defineProperty(exports, "carrierProviderKey", { enumerable: true, get: function () { return carrier_provider_key_js_1.carrierProviderKey; } });
 Object.defineProperty(exports, "carrierStepKind", { enumerable: true, get: function () { return carrier_provider_key_js_1.carrierStepKind; } });
-// General route search — Phase 1: plan-route-data.ts. Turns a priced
-// RoutePlan into the same RouteData/RouteCandidate/RouteScoreInputs shapes
-// today's four hand-written producers emit — see that module's head doc.
 var plan_route_data_js_1 = require("./search/plan-route-data.js");
 Object.defineProperty(exports, "buildRouteCandidateFromPlan", { enumerable: true, get: function () { return plan_route_data_js_1.buildRouteCandidateFromPlan; } });
 Object.defineProperty(exports, "buildRouteDataFromPlan", { enumerable: true, get: function () { return plan_route_data_js_1.buildRouteDataFromPlan; } });
@@ -109,13 +90,6 @@ Object.defineProperty(exports, "deriveEntryChainIdFromPlan", { enumerable: true,
 Object.defineProperty(exports, "deriveOmnibridgeProviderFromPlan", { enumerable: true, get: function () { return plan_route_data_js_1.deriveOmnibridgeProviderFromPlan; } });
 Object.defineProperty(exports, "deriveViaChainIdsFromPlan", { enumerable: true, get: function () { return plan_route_data_js_1.deriveViaChainIdsFromPlan; } });
 Object.defineProperty(exports, "derivePlanKind", { enumerable: true, get: function () { return plan_route_data_js_1.derivePlanKind; } });
-// The route-search maximization ENGINE — carrier registration
-// (`buildCapabilityIndex`), the depth-first search (`enumerateRoutes`) and
-// the wave-based quoting orchestrator (`searchRouteWaves`) — moved to
-// `@gibs/quotes`'s `search/` directory (`docs/quote-service.md`'s
-// "Carriers" section). Import `buildCapabilityIndex`, `enumerateRoutes`,
-// `searchRouteWaves` and their types from `@gibs/quotes/search`. Gibs's own
-// carriers (the omnibridge crossing, PulseX) live in `./carriers/`, below.
 var omnibridge_js_1 = require("./carriers/omnibridge.js");
 Object.defineProperty(exports, "createOmnibridgeCarrier", { enumerable: true, get: function () { return omnibridge_js_1.createOmnibridgeCarrier; } });
 Object.defineProperty(exports, "withOmnibridgeEntryFusing", { enumerable: true, get: function () { return omnibridge_js_1.withOmnibridgeEntryFusing; } });
@@ -135,8 +109,6 @@ Object.defineProperty(exports, "findSwapVenue", { enumerable: true, get: functio
 Object.defineProperty(exports, "resolveSwapVenues", { enumerable: true, get: function () { return swap_venues_js_1.resolveSwapVenues; } });
 var wrap_js_1 = require("./carriers/wrap.js");
 Object.defineProperty(exports, "createWrapCarrier", { enumerable: true, get: function () { return wrap_js_1.createWrapCarrier; } });
-// The same-chain swap and wrap builders. The interface's section signing and
-// the SDK's execution planner (`../execution.ts`) share them.
 var swap_transactions_js_1 = require("./swap-transactions.js");
 Object.defineProperty(exports, "buildPulseXSwapTransaction", { enumerable: true, get: function () { return swap_transactions_js_1.buildPulseXSwapTransaction; } });
 Object.defineProperty(exports, "buildWrapTransaction", { enumerable: true, get: function () { return swap_transactions_js_1.buildWrapTransaction; } });