@gibs/bridge-sdk 1.18.0 → 1.20.0

package/dist/config.js

@@ -1,41 +1,19 @@
 import { getAddress, isAddress, isAddressEqual, keccak256, stringToHex, zeroAddress, } from 'viem';
-/**
- * Add here your chain id as hex, be sure to add your chain in the chainsMetadata object too
- */
 export var Chains;
 (function (Chains) {
     Chains["PLS"] = "0x171";
     Chains["ETH"] = "0x1";
     Chains["BNB"] = "0x38";
-    // testnets
     Chains["SEP"] = "0xaa36a7";
     Chains["V4PLS"] = "0x3af";
-    // TBNB = '0x61',
 })(Chains || (Chains = {}));
-/** A map of chain ids to chain keys */
 export const chainIdToKey = new Map(Object.entries(Chains).map(([key, chain]) => [chain, key]));
-/**
- * Converts a chain id to a chain key
- * @param chainId - the chain id
- * @returns the chain key
- */
 export const toChain = (chainId) => `0x${Number(chainId).toString(16)}`;
-/**
- * Converts a chain id to a chain key
- * @param chainId - the chain id
- * @returns the chain key
- */
 export const toChainKey = (chainId) => chainIdToKey.get(toChain(chainId));
-// /** The provider of an omnibridge */
-// export enum Provider {
-//   PULSECHAIN = 'pulsechain',
-//   TOKENSEX = 'tokensex',
-// }
 export const Providers = {
     PULSECHAIN: 'pulsechain',
     TOKENSEX: 'tokensex',
 };
-/** A map of chains to native asset out addresses */
 export const nativeAssetOut = {
     [Chains.ETH]: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
     [Chains.BNB]: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c',
@@ -43,40 +21,15 @@ export const nativeAssetOut = {
     [Chains.SEP]: '0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9',
     [Chains.V4PLS]: '0x70499adEBB11Efd915E3b69E700c331778628707',
 };
-/**
- * Four PulseChain mainnet tokens that no other constant in this package
- * names. The PulseX carrier routes swaps through them
- * (`routing/carriers/pulsex-paths.ts`), and the interface builds its
- * PulseChain hub nodes from the two stablecoins.
- *
- * Each address was already in the repository before it moved here: USDC and
- * USDT from the interface's `HUB_STABLECOIN_ADDRESSES`
- * (`packages/ui/src/lib/state/useRouteSearch.ts`), PLSX and HEX from
- * `scripts/route-parity-corpus.ts`. Each one was read on chain again on
- * 2026-10-06 (`symbol()`, `decimals()`): PLSX 18, HEX 8, USDC 6, USDT 6.
- * `getAddress` checksums them at load, so a mistyped character fails the
- * build rather than silently matching nothing.
- */
 export const pulsechainTokenAddresses = Object.freeze({
-    /** PulseX, the exchange's own token. */
     PLSX: getAddress('0x95b303987a60c71504d99aa1b13b4da07b0790ab'),
-    /** HEX. */
     HEX: getAddress('0x2b591e99afe9f32eaa6214f7b7629768c40eeb39'),
-    /** USD Coin, bridged from Ethereum. */
     USDC: getAddress('0x15d38573d2feeb82e7ad5187ab8c1d52810b1f07'),
-    /** Tether USD, bridged from Ethereum. */
     USDT: getAddress('0x0cb6f5a34ad42ec934882a05265a7d5f59b51a2f'),
 });
-/** A map of chains to deprecated native asset out addresses */
 export const deprecatedNativeAssetOut = {
     [Chains.PLS]: new Set(['0x97Ac4a2439A47c07ad535bb1188c989dae755341']),
 };
-/**
- * Routers on chains where this package knows the router but has not verified
- * a factory, so no {@link SwapVenue} can be built for them. They stay in
- * {@link uniV2Routers} for the native-price reads (`chain-info.ts`,
- * `readAmountOut`) that need only a router.
- */
 const routersWithoutVenue = {
     [Chains.ETH]: ['0x7a250d5630b4cf539739df2c5dacb4c659f2488d'],
     [Chains.BNB]: ['0x05fF2B0DB69458A0750badebc4f9e13aDd608C7F'],
@@ -86,15 +39,6 @@ const routersWithoutVenue = {
         '0x636f6407B90661b73b1C0F7e24F4C79f624d0738',
     ],
 };
-/**
- * The swap venues the package ships with: PulseX V1 then V2 on PulseChain.
- * Frozen. A caller who wants other routers passes its own
- * {@link SwapVenues} (see `resolveSwapVenues`); this table is never mutated.
- *
- * Each factory is the router's own `router.factory()` read on chain — see
- * {@link uniV2Factories}'s doc. The fee is 29 basis points for both
- * deployments (measured, same doc).
- */
 export const defaultSwapVenues = Object.freeze({
     [Number(Chains.PLS)]: Object.freeze([
         Object.freeze({
@@ -115,43 +59,12 @@ export const defaultSwapVenues = Object.freeze({
         }),
     ]),
 });
-/** One chain's routers: its default venues' routers, else the router-only entries. */
 const defaultRoutersFor = (chain) => defaultSwapVenues[Number(chain)]?.map((venue) => venue.router) ?? routersWithoutVenue[chain] ?? [];
-/**
- * A map of chains to uni v2 router addresses. Frozen. PulseChain's entries
- * derive from {@link defaultSwapVenues}, so the two cannot drift. Kept for
- * compatibility; to swap on other routers pass `swapVenues` instead.
- */
 export const uniV2Routers = Object.freeze(Object.fromEntries(Object.values(Chains).map((chain) => [chain, Object.freeze([...defaultRoutersFor(chain)])])));
-/**
- * Each {@link uniV2Routers} entry's OWN factory address, same index, same
- * chain — `router.factory()` read live from `one.valve.city` on 2026-09-24.
- * Only PulseChain mainnet is filled: PulseX carries funds nowhere else
- * (`routing/carriers/pulsex.ts`'s own `pulseXCarries`), so no other chain's
- * factory has ever been needed or verified.
- *
- * MEASURED, NOT ASSUMED (owner Rule 13). Reading each factory's `getPair`
- * and the resulting pool's `getReserves`, then recomputing `getAmountsOut`
- * from the standard constant-product formula, showed the SAME fee ratio for
- * both — `9971/10000` (0.29%) — to the base unit, on both a one-hop and a
- * two-hop path. "V1 and V2 differ" was the assumption going in; measurement
- * said otherwise, so `routing/carriers/pulsex.ts`'s `exact` uses one shared
- * fee constant rather than two.
- *
- * `0x1715a3E4A142d8b698131108995174F37aEBA10D` (the V1 factory, index 0) is
- * NOT a copy-paste of the omnibridge's Ethereum mediator address from
- * `pathways` above — it is the same string on a DIFFERENT chain (PulseChain,
- * not Ethereum), confirmed by reading it fresh from `one.valve.city/…/evm/369`.
- * Two unrelated contracts landing on the same address on two different
- * chains is possible (a shared deployer at a matching nonce, or a CREATE2
- * salt collision) and worth this note so a future reader does not assume a
- * transcription error and "fix" it back to something wrong.
- */
 export const uniV2Factories = Object.freeze(Object.fromEntries(Object.values(Chains).map((chain) => [
     chain,
     Object.freeze((defaultSwapVenues[Number(chain)] ?? []).map((venue) => venue.factory)),
 ])));
-/** A map of chains to native token symbols */
 export const nativeTokenSymbol = {
     [Chains.PLS]: 'PLS',
     [Chains.V4PLS]: 'V4PLS',
@@ -159,7 +72,6 @@ export const nativeTokenSymbol = {
     [Chains.SEP]: 'sepETH',
     [Chains.BNB]: 'BNB',
 };
-/** A map of chains to native token names */
 export const nativeTokenName = {
     [Chains.PLS]: 'Pulse',
     [Chains.V4PLS]: 'V4 Pulse',
@@ -167,7 +79,6 @@ export const nativeTokenName = {
     [Chains.SEP]: 'Sepolia Ether',
     [Chains.BNB]: 'BNB',
 };
-/** The settings for the pulsechain pls eth pathway */
 const pulsechainPLSETHSettings = {
     from: '0x0e18d0d556b652794EF12Bf68B2dC857EF5f3996',
     to: '0xe20E337DB2a00b1C37139c873B92a0AAd3F468bF',
@@ -187,7 +98,6 @@ export const pathways = {
                 feeManager: 'from',
                 toHome: false,
                 requiresDelivery: true,
-                // weth from ethereum on pulsechain
                 bridgedNativeAssetOut: '0x02DcdD04e3F455D838cd1249292C58f3B79e3C3C',
                 settingOverrides: {
                     [zeroAddress]: pulsechainPLSETHSettings,
@@ -206,7 +116,6 @@ export const pathways = {
                 usesExtraParam: false,
                 toHome: true,
                 requiresDelivery: false,
-                // wpls from pulsechain on ethereum
                 bridgedNativeAssetOut: '0xA882606494D86804B5514E07e6Bd2D6a6eE6d68A',
                 settingOverrides: {
                     [getAddress('0xa882606494d86804b5514e07e6bd2d6a6ee6d68a')]: {
@@ -231,7 +140,6 @@ export const pathways = {
                 usesExtraParam: true,
                 toHome: false,
                 requiresDelivery: true,
-                // wbnb from bsc on pulsechain (tokensex)
                 bridgedNativeAssetOut: '0x518076CCE3729eF1a3877EA3647a26e278e764FE',
             },
         },
@@ -246,36 +154,13 @@ export const pathways = {
                 usesExtraParam: true,
                 toHome: true,
                 requiresDelivery: false,
-                // wpls from pulsechain on bsc (tokensex)
                 bridgedNativeAssetOut: '0xF6088134D28eeBEF7128BA41FaDb2FCA0666c64C',
             },
         },
     },
 };
 export const testnetPathways = {
-    [Providers.TOKENSEX]: {
-    // plsv4 to bnb home omnibridge: 0xfd0c07C376D27EA0E9fA64Ac5D2481439e36CF9C
-    // [Chains.BNB]: {
-    //   [Chains.V4PLS]: {
-    //     from: '0xDDf1b0CD7fb7AAA310c703C17995c6671F9DC806',
-    //     to: '0xfd0c07C376D27EA0E9fA64Ac5D2481439e36CF9C',
-    //     usesExtraParam: false,
-    //     requiresDelivery: false,
-    //     toHome: true,
-    //     feeManager: 'to',
-    //     defaultAssetIn: {
-    //       chainId: 56,
-    //       address: nativeAssetOut[Chains.TBNB],
-    //     },
-    //   },
-    // },
-    // [Chains.V4PLS]: {
-    //   [Chains.BNB]: {
-    //     from: '0xfd0c07C376D27EA0E9fA64Ac5D2481439e36CF9C',
-    //     to: '0xDDf1b0CD7fb7AAA310c703C17995c6671F9DC806',
-    //   },
-    // },
-    },
+    [Providers.TOKENSEX]: {},
     [Providers.PULSECHAIN]: {
         [Chains.V4PLS]: {
             [Chains.SEP]: {
@@ -307,47 +192,22 @@ export const testnetPathways = {
         },
     },
 };
-/** The mainnet bridge keys */
 const mainnetBridgeKeys = [
     [Providers.PULSECHAIN, Chains.PLS, Chains.ETH],
     [Providers.PULSECHAIN, Chains.ETH, Chains.PLS],
     [Providers.TOKENSEX, Chains.PLS, Chains.BNB],
     [Providers.TOKENSEX, Chains.BNB, Chains.PLS],
 ];
-/** The testnet bridge keys */
 const testnetBridgeKeys = [
     [Providers.PULSECHAIN, Chains.SEP, Chains.V4PLS],
     [Providers.PULSECHAIN, Chains.V4PLS, Chains.SEP],
 ];
-/** Returns the valid bridge keys for the given is prod */
 export const validBridgeKeys = (isProd) => [
     ...mainnetBridgeKeys,
     ...(isProd ? [] : testnetBridgeKeys),
 ];
-/** Every chain that appears only on a testnet pathway. */
 const testnetChains = new Set(testnetBridgeKeys.flatMap(([, fromChain, toChain]) => [fromChain, toChain]));
-/**
- * Whether a chain belongs to the testnet pathway map rather than the mainnet one.
- * @param chain - the chain to classify
- * @returns true for Sepolia and PulseChain testnet V4
- */
 export const isTestnetChain = (chain) => testnetChains.has(chain);
-/**
- * Infers the bridge key from the current key, provider, from chain, and to chain.
- *
- * A chain the provider does not serve falls back to the provider's first chain,
- * so a provider switch lands on a real pathway. That fallback never crosses
- * between the testnet and mainnet maps: when testnets are off and a requested
- * chain is a testnet chain, this returns null rather than a mainnet key for a
- * testnet pair.
- *
- * @param options.currentKey - the current bridge key
- * @param options.provider - the provider
- * @param options.fromChain - the from chain (defaults to the current key's)
- * @param options.toChain - the to chain (defaults to the current key's)
- * @param options.isProd - true leaves testnet pathways out (default false: both maps)
- * @returns the inferred bridge key, or null when no pathway can honour the request
- */
 export const inferBridgeKey = ({ currentKey, provider, fromChain, toChain, isProd = false, }) => {
     const [, fromChainKey, toChainKey] = currentKey;
     const from = fromChain ?? fromChainKey;
@@ -368,39 +228,7 @@ export const inferBridgeKey = ({ currentKey, provider, fromChain, toChain, isPro
     }
     return [provider, nextFromChain, nextToChain];
 };
-/**
- * Returns the pathway for the given bridge key, is prod, and asset in address
- * @param bridgeKey - the bridge key
- * @param isProd - whether to use the production pathway
- * @param assetInAddress - the asset in address
- * @returns the pathway
- */
-/**
- * The pathway group for one provider on one chain, honouring the testnet map.
- *
- * Exists because {@link pathway} already knew that testnet pathways live in a
- * SECOND map and are only in play off production, while other callers reached
- * straight into `pathways` and therefore could not see a testnet route at all.
- * That is the sort of knowledge that has to live in one place: duplicated, one
- * copy silently lags the other, and the symptom is a thrown "no pathway found"
- * on a route the rest of the application considers perfectly valid.
- *
- * @param provider - the bridge provider
- * @param chain - the chain being bridged FROM
- * @param isProd - whether this is a production build; testnets are off when true
- * @returns the group keyed by destination chain, or undefined when unknown
- */
 export const pathwayGroup = (provider, chain, isProd) => pathways[provider]?.[chain] || (!isProd ? testnetPathways[provider]?.[chain] : undefined);
-/**
- * Reads one pathway out of a provider, chain and chain map.
- *
- * Every level is optional at runtime: the testnet map leaves whole providers
- * out, and a caller can hold a bridge key built from untrusted input.
- *
- * @param config - the pathway map to read
- * @param bridgeKey - the provider, origin chain and destination chain
- * @returns the pathway, or undefined when any level is missing
- */
 const lookupPathway = (config, [provider, from, to]) => config[provider]?.[from]?.[to];
 export const pathway = (bridgeKey, isProd, assetInAddress) => {
     if (!bridgeKey)
@@ -418,12 +246,6 @@ export const pathway = (bridgeKey, isProd, assetInAddress) => {
     }
     return pathway;
 };
-/**
- * Returns the default asset in for the given bridge key and is prod
- * @param bridgeKey - the bridge key
- * @param isProd - whether to use the production pathway
- * @returns the default asset in
- */
 export const defaultAssetIn = ($bridgeKey, isProd) => {
     if (!$bridgeKey)
         return null;
@@ -431,18 +253,6 @@ export const defaultAssetIn = ($bridgeKey, isProd) => {
     const defaultAssetIn = conf?.bridgedNativeAssetOut;
     return defaultAssetIn;
 };
-/**
- * Returns whether the given asset is the native asset for the given bridge key.
- *
- * Never throws. A token whose address is not known yet (a {@link TokenOut} for a
- * not-yet-bridged token), an address that is not a valid address, and a bridge
- * key with no pathway each answer false.
- *
- * @param asset - the asset
- * @param bridgeKey - the bridge key
- * @param options - which pathway maps to read; see {@link PathwayLookupOptions}
- * @returns whether the given asset is the native asset for the given bridge key
- */
 export const isNative = (asset, bridgeKey, options = {}) => {
     if (!bridgeKey || !asset?.address || !isAddress(asset.address, { strict: false })) {
         return false;
@@ -459,17 +269,6 @@ export const isNative = (asset, bridgeKey, options = {}) => {
         (!!wrappedNative && isAddressEqual(asset.address, wrappedNative));
     return isGasTokenOrItsWrapper && !asset.name.includes(' from Pulsechain');
 };
-/**
- * Returns whether the given asset is unwrappable for the given bridge key.
- *
- * Never throws: a missing or malformed address and a bridge key with no
- * pathway each answer false.
- *
- * @param bridgeKey - the bridge key
- * @param assetIn - the asset in
- * @param options - which pathway maps to read; see {@link PathwayLookupOptions}
- * @returns whether the given asset is unwrappable for the given bridge key
- */
 export const isUnwrappable = (bridgeKey, assetIn, options = {}) => {
     if (!bridgeKey || !assetIn?.address || !isAddress(assetIn.address, { strict: false })) {
         return false;
@@ -480,13 +279,6 @@ export const isUnwrappable = (bridgeKey, assetIn, options = {}) => {
     }
     return isAddressEqual(path.bridgedNativeAssetOut, assetIn.address);
 };
-/**
- * Returns whether the given asset can be unwrapped for the given bridge key
- * @param bridgeKey - the bridge key
- * @param assetIn - the asset in
- * @param options - which pathway maps to read; see {@link PathwayLookupOptions}
- * @returns boolean
- */
 export const canChangeUnwrap = (bridgeKey, assetIn, options = {}) => {
     return !!assetIn && isUnwrappable(bridgeKey, assetIn, options);
 };
@@ -498,7 +290,6 @@ export const chains = {
     sepolia: 11155111,
 };
 export const chainIds = Object.values(chains);
-/** Start blocks aligned with when bridge validators began operating — canonical reference for all ponder indexers in this monorepo. */
 export const startBlocks = {
     ethereum: 17_264_119,
     bsc: 28_987_313,
@@ -506,7 +297,6 @@ export const startBlocks = {
     pulsechainV4: 16_564_233,
     sepolia: 3_331_901,
 };
-// provider -> home -> foreign
 export const bridgeConfigs = {
     [Providers.PULSECHAIN]: {
         [chains.pulsechain]: {