@gibs/bridge-sdk 1.7.1 → 1.7.2

package/dist/src/config.js

@@ -1,6 +1,5 @@
 import { getAddress, zeroAddress } from "viem";
 import _ from 'lodash';
-import * as imageLinks from '@gibs/bridge-sdk/image-links';
 /**
  * Add here your chain id as hex, be sure to add your chain in the chainsMetadata object too
  */
@@ -14,14 +13,27 @@ export var Chains;
     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 var Provider;
 (function (Provider) {
     Provider["PULSECHAIN"] = "pulsechain";
     Provider["TOKENSEX"] = "tokensex";
 })(Provider || (Provider = {}));
+/** A map of chains to native asset out addresses */
 export const nativeAssetOut = {
     [Chains.ETH]: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
     [Chains.BNB]: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c',
@@ -29,9 +41,11 @@ export const nativeAssetOut = {
     [Chains.SEP]: '0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9',
     [Chains.V4PLS]: '0x70499adEBB11Efd915E3b69E700c331778628707',
 };
+/** A map of chains to deprecated native asset out addresses */
 export const deprecatedNativeAssetOut = {
     [Chains.PLS]: new Set(['0x97Ac4a2439A47c07ad535bb1188c989dae755341']),
 };
+/** A map of chains to uni v2 router addresses */
 export const uniV2Routers = {
     [Chains.PLS]: [
         '0x98bf93ebf5c380C0e6Ae8e192A7e2AE08edAcc02',
@@ -45,6 +59,7 @@ export const uniV2Routers = {
         '0x636f6407B90661b73b1C0F7e24F4C79f624d0738',
     ],
 };
+/** A map of chains to native token symbols */
 export const nativeTokenSymbol = {
     [Chains.PLS]: 'PLS',
     [Chains.V4PLS]: 'V4PLS',
@@ -52,6 +67,7 @@ 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',
@@ -59,6 +75,7 @@ export const nativeTokenName = {
     [Chains.SEP]: 'Sepolia Ether',
     [Chains.BNB]: 'BNB',
 };
+/** The settings for the pulsechain pls eth pathway */
 const pulsechainPLSETHSettings = {
     from: '0x0e18d0d556b652794EF12Bf68B2dC857EF5f3996',
     to: '0xe20E337DB2a00b1C37139c873B92a0AAd3F468bF',
@@ -84,21 +101,6 @@ export const pathways = {
                     [zeroAddress]: pulsechainPLSETHSettings,
                     [getAddress(nativeAssetOut[Chains.PLS])]: pulsechainPLSETHSettings,
                 },
-                defaultAssetIn: {
-                    symbol: 'WETH',
-                    name: 'Wrapped Ether from Ethereum',
-                    address: '0x02DcdD04e3F455D838cd1249292C58f3B79e3C3C',
-                    decimals: 18,
-                    chainId: 369,
-                    logoURI: imageLinks.network(369),
-                    extensions: {
-                        bridgeInfo: {
-                            '1': {
-                                tokenAddress: nativeAssetOut[Chains.ETH],
-                            },
-                        },
-                    },
-                },
             },
         },
         [Chains.ETH]: {
@@ -122,21 +124,6 @@ export const pathways = {
                         nativeRouter: '0x1F0144Ce3BDaf11944Fe0beF6444599a0500695B',
                     },
                 },
-                defaultAssetIn: {
-                    chainId: 1,
-                    address: nativeAssetOut[Chains.ETH],
-                    name: 'Wrapped Ether',
-                    symbol: 'WETH',
-                    decimals: 18,
-                    logoURI: imageLinks.network(1),
-                    extensions: {
-                        bridgeInfo: {
-                            '369': {
-                                tokenAddress: '0x02DcdD04e3F455D838cd1249292C58f3B79e3C3C',
-                            },
-                        },
-                    },
-                },
             },
         },
     },
@@ -154,21 +141,6 @@ export const pathways = {
                 requiresDelivery: true,
                 // wbnb from bsc on pulsechain (tokensex)
                 bridgedNativeAssetOut: '0x518076CCE3729eF1a3877EA3647a26e278e764FE',
-                defaultAssetIn: {
-                    symbol: 'WBNB',
-                    name: 'Wrapped BNB',
-                    address: '0x518076CCE3729eF1a3877EA3647a26e278e764FE',
-                    decimals: 18,
-                    chainId: 369,
-                    logoURI: imageLinks.network(369),
-                    extensions: {
-                        bridgeInfo: {
-                            '56': {
-                                tokenAddress: nativeAssetOut[Chains.BNB],
-                            },
-                        },
-                    },
-                },
             },
         },
         [Chains.BNB]: {
@@ -184,21 +156,6 @@ export const pathways = {
                 requiresDelivery: false,
                 // wpls from pulsechain on bsc (tokensex)
                 bridgedNativeAssetOut: '0xF6088134D28eeBEF7128BA41FaDb2FCA0666c64C',
-                defaultAssetIn: {
-                    chainId: 56,
-                    address: nativeAssetOut[Chains.BNB],
-                    name: 'Wrapped BNB from BSC',
-                    symbol: 'WBNB',
-                    decimals: 18,
-                    logoURI: imageLinks.network(56),
-                    extensions: {
-                        bridgeInfo: {
-                            '369': {
-                                tokenAddress: '0x518076CCE3729eF1a3877EA3647a26e278e764FE',
-                            },
-                        },
-                    },
-                },
             },
         },
     },
@@ -240,21 +197,6 @@ export const testnetPathways = {
                 toHome: false,
                 feeManager: 'from',
                 bridgedNativeAssetOut: '0x3677bd78ccf4d299328ecfba61790cf8dbfcf686',
-                defaultAssetIn: {
-                    chainId: 943,
-                    address: '0x3677bd78CCf4d299328ECFBa61790cf8dBfcF686',
-                    name: 'Wrapped Ether from Sepolia',
-                    symbol: 'WsepETH',
-                    decimals: 18,
-                    logoURI: imageLinks.network(943),
-                    extensions: {
-                        bridgeInfo: {
-                            '11155111': {
-                                tokenAddress: nativeAssetOut[Chains.SEP],
-                            },
-                        },
-                    },
-                },
             },
         },
         [Chains.SEP]: {
@@ -269,39 +211,35 @@ export const testnetPathways = {
                 toHome: true,
                 feeManager: 'to',
                 bridgedNativeAssetOut: '0x35807560aD0597E23F452cdc82D4Fb0e7E3c6590',
-                defaultAssetIn: {
-                    chainId: 11_155_111,
-                    address: nativeAssetOut[Chains.SEP],
-                    name: 'Wrapped Ether',
-                    symbol: 'sepWETH',
-                    decimals: 18,
-                    logoURI: imageLinks.network(11_155_111),
-                    extensions: {
-                        bridgeInfo: {
-                            '943': {
-                                tokenAddress: '0x3677bd78CCf4d299328ECFBa61790cf8dBfcF686',
-                            },
-                        },
-                    },
-                },
             },
         },
     },
 };
+/** The mainnet bridge keys */
 const mainnetBridgeKeys = [
     [Provider.PULSECHAIN, Chains.PLS, Chains.ETH],
     [Provider.PULSECHAIN, Chains.ETH, Chains.PLS],
     [Provider.TOKENSEX, Chains.PLS, Chains.BNB],
     [Provider.TOKENSEX, Chains.BNB, Chains.PLS],
 ];
+/** The testnet bridge keys */
 const testnetBridgeKeys = [
     [Provider.PULSECHAIN, Chains.SEP, Chains.V4PLS],
     [Provider.PULSECHAIN, Chains.V4PLS, Chains.SEP],
 ];
+/** Returns the valid bridge keys for the given is prod */
 export const validBridgeKeys = (isProd) => [
     ...mainnetBridgeKeys,
     ...(isProd ? [] : testnetBridgeKeys),
 ];
+/**
+ * Infers the bridge key from the current key, provider, from chain, and to chain
+ * @param currentKey - the current bridge key
+ * @param provider - the provider
+ * @param fromChain - the from chain
+ * @param toChain - the to chain
+ * @returns the inferred bridge key
+ */
 export const inferBridgeKey = ({ currentKey, provider, fromChain, toChain, }) => {
     const [, fromChainKey, toChainKey] = currentKey;
     const from = fromChain ?? fromChainKey;
@@ -316,6 +254,13 @@ export const inferBridgeKey = ({ currentKey, provider, fromChain, toChain, }) =>
         : Object.keys(pathways[provider][nextFromChain])[0];
     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
+ */
 export const pathway = (bridgeKey, isProd, assetInAddress) => {
     if (!bridgeKey)
         return;
@@ -331,11 +276,25 @@ 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;
     const conf = pathway($bridgeKey, isProd);
-    const defaultAssetIn = _.get(conf, ['defaultAssetIn']);
+    const defaultAssetIn = _.get(conf, ['bridgedNativeAssetOut']);
     return defaultAssetIn;
 };
+/**
+ * Returns whether the given asset is the native asset for the given bridge key
+ * @param asset - the asset
+ * @param bridgeKey - the bridge key
+ * @returns whether the given asset is the native asset for the given bridge key
+ */
 export const isNative = (asset, bridgeKey) => {
     if (!bridgeKey || !asset) {
         return false;
@@ -346,6 +305,12 @@ export const isNative = (asset, bridgeKey) => {
             nativeAssetOut[toChain(asset.chainId)]?.toLowerCase() === asset.address?.toLowerCase()) &&
             !asset.name.includes(' from Pulsechain'));
 };
+/**
+ * Returns whether the given asset is unwrappable for the given bridge key
+ * @param bridgeKey - the bridge key
+ * @param assetIn - the asset in
+ * @returns whether the given asset is unwrappable for the given bridge key
+ */
 export const isUnwrappable = (bridgeKey, assetIn) => {
     if (!bridgeKey || !assetIn) {
         return false;
@@ -356,6 +321,12 @@ export const isUnwrappable = (bridgeKey, assetIn) => {
         return false;
     return path.bridgedNativeAssetOut === getAddress(addr);
 };
+/**
+ * Returns whether the given asset can be unwrapped for the given bridge key
+ * @param bridgeKey - the bridge key
+ * @param assetIn - the asset in
+ * @returns boolean
+ */
 export const canChangeUnwrap = (bridgeKey, assetIn) => {
     return !!assetIn && isUnwrappable(bridgeKey, assetIn);
 };

package/dist/src/fee-type.d.ts

@@ -1,7 +1,10 @@
+/** The type of fee to use for the bridge */
 export declare enum FeeType {
     PERCENT = "%",
     GAS_TIP = "gas+%",
     FIXED = "fixed"
 }
+/** The keys of the fee type */
 export type FeeTypeKeys = keyof typeof FeeType;
+/** A map of fee type values to keys */
 export declare const feeTypeValToKeyMap: Map<FeeType, "PERCENT" | "GAS_TIP" | "FIXED">;

package/dist/src/fee-type.js

@@ -1,7 +1,9 @@
+/** The type of fee to use for the bridge */
 export var FeeType;
 (function (FeeType) {
     FeeType["PERCENT"] = "%";
     FeeType["GAS_TIP"] = "gas+%";
     FeeType["FIXED"] = "fixed";
 })(FeeType || (FeeType = {}));
+/** A map of fee type values to keys */
 export const feeTypeValToKeyMap = new Map(Object.keys(FeeType).map((key) => [FeeType[key], key]));

package/dist/src/image-links.d.ts

@@ -1,12 +1,41 @@
+/**
+ * Sets the image root for the bridge
+ * @param root - the root
+ */
 export declare const setImageRoot: (root: string) => void;
+/**
+ * Returns the image root for the bridge
+ * @returns the image root
+ */
 export declare const getImageRoot: () => string;
+/** The minimal token info */
 interface MinimalTokenInfo {
     chainId: number;
     address: string;
     logoURI?: string | null;
 }
+/**
+ * Returns the list image for the given path
+ * @param path - the path
+ * @returns the list image
+ */
 export declare const list: (path: string) => string;
+/**
+ * Returns the network image for the given chain id
+ * @param chainId - the chain id
+ * @returns the network image
+ */
 export declare const network: (chainId: number) => string;
+/**
+ * Returns the image url for the given token info
+ * @param t - the token info
+ * @returns the image url
+ */
 export declare const image: (t: MinimalTokenInfo) => string;
+/**
+ * Returns a url that will lookup all sources for the given array
+ * @param sources - the sources
+ * @returns the images
+ */
 export declare const images: (sources: string[]) => string;
 export {};

package/dist/src/image-links.js

@@ -1,17 +1,45 @@
 import { getAddress } from 'viem';
 let imageRoot = 'https://gib.show';
+/**
+ * Sets the image root for the bridge
+ * @param root - the root
+ */
 export const setImageRoot = (root) => {
     imageRoot = root;
 };
+/**
+ * Returns the image root for the bridge
+ * @returns the image root
+ */
 export const getImageRoot = () => imageRoot;
+/**
+ * Returns the list image for the given path
+ * @param path - the path
+ * @returns the list image
+ */
 export const list = (path) => {
     return `${imageRoot}/list${path}`;
 };
+/**
+ * Returns the network image for the given chain id
+ * @param chainId - the chain id
+ * @returns the network image
+ */
 export const network = (chainId) => {
     if (!chainId) {
         console.trace('network image');
     }
     return `${imageRoot}/image/${Number(chainId)}`;
 };
+/**
+ * Returns the image url for the given token info
+ * @param t - the token info
+ * @returns the image url
+ */
 export const image = (t) => t.logoURI || `${network(t.chainId)}/${getAddress(t.address)}`;
+/**
+ * Returns a url that will lookup all sources for the given array
+ * @param sources - the sources
+ * @returns the images
+ */
 export const images = (sources) => `${imageRoot}/image/?${sources.map((s) => `i=${s}`).join('&')}`;

package/dist/src/index.d.ts

@@ -5,3 +5,4 @@ export * from './chains.js';
 export * from './types.js';
 export * from './image-links.js';
 export * from './fee-type.js';
+export * from './settings.js';

package/dist/src/index.js

@@ -5,3 +5,4 @@ export * from './chains.js';
 export * from './types.js';
 export * from './image-links.js';
 export * from './fee-type.js';
+export * from './settings.js';