@gibs/bridge-sdk 1.19.0 → 1.20.0

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

@@ -1,27 +1,6 @@
 import { zeroAddress } from 'viem';
 import { nativeAssetOut, nativeTokenSymbol, toChain } from '../config.js';
 import { sameAddress } from '../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
- */
 export const entryChainAnchorsForPair = ({ entryChainToken, pulsechainToken, entryChainId, }) => {
     const pairAnchor = {
         token: entryChainToken,
@@ -30,9 +9,6 @@ export const entryChainAnchorsForPair = ({ entryChainToken, pulsechainToken, ent
         landsAs: pulsechainToken,
     };
     const entryChain = 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 = nativeAssetOut[entryChain];
     if (wrappedNativeAddress === undefined ||
         !sameAddress(entryChainToken.address, wrappedNativeAddress, 'evm')) {
@@ -40,9 +16,6 @@ export const entryChainAnchorsForPair = ({ entryChainToken, pulsechainToken, ent
     }
     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: zeroAddress,
             symbol: nativeTokenSymbol[entryChain] ?? entryChainToken.symbol,

package/dist/routing/format.js

@@ -1,55 +1,5 @@
-/**
- * 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 `$`
- */
 export const formatUsd = (value, locale = 'en-US') => value.toLocaleString(locale, { minimumFractionDigits: 2, maximumFractionDigits: 2 });
-/**
- * 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
- */
 export const formatUsdNullable = (value, locale) => value === null || value === undefined ? null : formatUsd(value, locale);
-/**
- * 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/routing/index.js

@@ -1,9 +1,3 @@
-/**
- * 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.
- */
 export { netDeliveredAmount, restateInDecimals, valueEquivalentAmount } from './amounts.js';
 export { omnibridgeProviderForEntryChain, pulseXConversionSwapPath } from './providers.js';
 export { buildDirectCrossingCandidate } from './candidate.js';
@@ -13,36 +7,14 @@ export { entryChainAnchorsForPair } from './entry-chain-anchor.js';
 export { usdValueOfAmount } from './usd-value.js';
 export { formatUsd, formatUsdNullable } from './format.js';
 export { BRIDGE_SETTLEMENT_ETA_MINUTES, PULSEX_MARGINAL_REFERENCE_DIVISOR, pulsechainChainId, addUsdValues, providerDisplayName, resolveEntryChainName, buildCandidateRouteData, buildConversionRouteData, buildDirectRouteData, buildPulseXSwapEstimateData, buildPulseXSwapSectionData, buildOutboundRouteData, buildSameChainSwapRouteData, candidateDeliveredUsd, candidateNetValueUsd, candidateOutsideFeesUsd, candidatePaidUsd, } from './producers.js';
-// 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.
 export { RANKABLE_ESTIMATE_BASES, assetNodeKey, combineComposedPathBasis, compareRoutePlansByDeliveredAmount, groupHopsBySignature, hopComposedBasis, hopEdgeKey, isConfirmedBasis, isRankableBasis, isRateLimitedCarrier, planComposedBasis, planIsConfirmed, planIsRankable, routePlanPathKey, } from './search/graph.js';
 export { composableHopBasis, composeRouteDelivery, hopOutputAmount, } from './search/compose.js';
 export { GAS_TOPUP_PENALTY_FLOOR_USD, GAS_TOPUP_PENALTY_PPM, SIGNATURE_PENALTY_FLOOR_USD, SIGNATURE_PENALTY_PPM, compareRoutePlansByGasAdjustedDeliveredAmount, compareRoutePlansByScoreAdjustedDeliveredAmount, gasAdjustedDeliveredAmount, scoreRoutePlan, sectionIsFundedByLanding, waitPenaltyPpm, zeroGasCostFor, } from './search/score.js';
 export { WRAP_CARRIER_ID, carrierProviderKey, carrierStepKind } from './carrier-provider-key.js';
-// 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.
 export { buildRouteCandidateFromPlan, buildRouteDataFromPlan, buildRouteScoreInputsFromPlan, deriveDeferredCrossingFromPlan, deriveEntryChainIdFromPlan, deriveOmnibridgeProviderFromPlan, deriveViaChainIdsFromPlan, derivePlanKind, } from './search/plan-route-data.js';
-// 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.
 export { createOmnibridgeCarrier, withOmnibridgeEntryFusing, } from './carriers/omnibridge.js';
 export { createPulseXCarrier, pulseXRouterForEdge, venueForEdge, pulseXSwapPathForHop, pulseXVenues, pulseXWrappedNativePath, } from './carriers/pulsex.js';
 export { bestPulseXPathQuote, candidatePulseXPaths, pulseXHubTokens } from './carriers/pulsex-paths.js';
 export { findSwapVenue, resolveSwapVenues } from '../swap-venues.js';
 export { createWrapCarrier } from './carriers/wrap.js';
-// The same-chain swap and wrap builders. The interface's section signing and
-// the SDK's execution planner (`../execution.ts`) share them.
 export { buildPulseXSwapTransaction, buildWrapTransaction, swapMinimumOut } from './swap-transactions.js';