@gibs/bridge-sdk 1.6.27 → 1.6.33

package/dist/src/config.js

@@ -0,0 +1,313 @@
+import { 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
+ */
+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 = {}));
+export const chainIdToKey = new Map(Object.entries(Chains).map(([key, chain]) => [chain, key]));
+export const toChain = (chainId) => `0x${Number(chainId).toString(16)}`;
+export const toChainKey = (chainId) => chainIdToKey.get(toChain(chainId));
+export var Provider;
+(function (Provider) {
+    Provider["PULSECHAIN"] = "pulsechain";
+    Provider["TOKENSEX"] = "tokensex";
+})(Provider || (Provider = {}));
+export const nativeAssetOut = {
+    [Chains.ETH]: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+    [Chains.BNB]: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c',
+    [Chains.PLS]: '0xA1077a294dDE1B09bB078844df40758a5D0f9a27',
+    [Chains.SEP]: '0x7b79995e5f793A07Bc00c21412e50Ecae098E7f9',
+    [Chains.V4PLS]: '0x70499adEBB11Efd915E3b69E700c331778628707',
+};
+export const uniV2Routers = {
+    [Chains.PLS]: [
+        '0x98bf93ebf5c380C0e6Ae8e192A7e2AE08edAcc02',
+        '0x165C3410fC91EF562C50559f7d2289fEbed552d9',
+    ],
+    [Chains.ETH]: ['0x7a250d5630b4cf539739df2c5dacb4c659f2488d'],
+    [Chains.BNB]: ['0x05fF2B0DB69458A0750badebc4f9e13aDd608C7F'],
+    [Chains.SEP]: ['0xeE567Fe1712Faf6149d80dA1E6934E354124CfE3'],
+    [Chains.V4PLS]: [
+        '0xDaE9dd3d1A52CfCe9d5F2fAC7fDe164D500E50f7',
+        '0x636f6407B90661b73b1C0F7e24F4C79f624d0738',
+    ],
+};
+export const nativeTokenSymbol = {
+    [Chains.PLS]: 'PLS',
+    [Chains.V4PLS]: 'V4PLS',
+    [Chains.ETH]: 'ETH',
+    [Chains.SEP]: 'sepETH',
+    [Chains.BNB]: 'BNB',
+};
+export const nativeTokenName = {
+    [Chains.PLS]: 'Pulse',
+    [Chains.V4PLS]: 'V4 Pulse',
+    [Chains.ETH]: 'Ether',
+    [Chains.SEP]: 'Sepolia Ether',
+    [Chains.BNB]: 'BNB',
+};
+export const pathways = {
+    [Provider.PULSECHAIN]: {
+        [Chains.PLS]: {
+            [Chains.ETH]: {
+                from: '0x4fD0aaa7506f3d9cB8274bdB946Ec42A1b8751Ef',
+                to: '0x1715a3E4A142d8b698131108995174F37aEBA10D',
+                destinationRouter: '0x2Ed02372C3efF1F239B22a901ceA8Cf6fbf82d8d',
+                nativeRouter: '0x612Da68aA7BcA625dD2F27f252cddB573674991A',
+                validator: '0x5ECfE77502317F3677f23C3b8Ab17929ACE3D74E',
+                usesExtraParam: false,
+                feeManager: 'from',
+                toHome: false,
+                requiresDelivery: true,
+                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]: {
+            [Chains.PLS]: {
+                from: '0x1715a3E4A142d8b698131108995174F37aEBA10D',
+                to: '0x4fD0aaa7506f3d9cB8274bdB946Ec42A1b8751Ef',
+                nativeRouter: '0x2Ed02372C3efF1F239B22a901ceA8Cf6fbf82d8d',
+                destinationRouter: '0x612Da68aA7BcA625dD2F27f252cddB573674991A',
+                validator: '0x5ECfE77502317F3677f23C3b8Ab17929ACE3D74E',
+                feeManager: 'to',
+                usesExtraParam: false,
+                toHome: true,
+                requiresDelivery: false,
+                defaultAssetIn: {
+                    chainId: 1,
+                    address: nativeAssetOut[Chains.ETH],
+                    name: 'Wrapped Ether',
+                    symbol: 'WETH',
+                    decimals: 18,
+                    logoURI: imageLinks.network(1),
+                    extensions: {
+                        bridgeInfo: {
+                            '369': {
+                                tokenAddress: '0x02DcdD04e3F455D838cd1249292C58f3B79e3C3C',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    [Provider.TOKENSEX]: {
+        [Chains.PLS]: {
+            [Chains.BNB]: {
+                from: '0xf1DFc63e10fF01b8c3d307529b47AefaD2154C0e',
+                to: '0xb4005881e81a6ecd2c1f75d58e8e41f28d59c6b1',
+                destinationRouter: '0x9c50EfD36dF2DBD310fBC981d6D8478cF3484B85',
+                nativeRouter: '0xB80B80EBB375BD83a9d6c0761b197d16a8670f81',
+                validator: '0xc3c3d5d3ba946a2eb3906878ebe187418b0b524e',
+                feeManager: 'from',
+                usesExtraParam: true,
+                toHome: false,
+                requiresDelivery: true,
+                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]: {
+            [Chains.PLS]: {
+                from: '0xb4005881e81a6ecd2c1f75d58e8e41f28d59c6b1',
+                to: '0xf1DFc63e10fF01b8c3d307529b47AefaD2154C0e',
+                nativeRouter: '0x9c50EfD36dF2DBD310fBC981d6D8478cF3484B85',
+                destinationRouter: '0xB80B80EBB375BD83a9d6c0761b197d16a8670f81',
+                validator: '0xc3c3d5d3ba946a2eb3906878ebe187418b0b524e',
+                feeManager: 'to',
+                usesExtraParam: true,
+                toHome: true,
+                requiresDelivery: false,
+                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',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+export const testnetPathways = {
+    [Provider.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',
+    //   },
+    // },
+    },
+    [Provider.PULSECHAIN]: {
+        [Chains.V4PLS]: {
+            [Chains.SEP]: {
+                from: '0x6B08a50865aDeCe6e3869D9AfbB316d0a0436B6c',
+                to: '0x546e37DAA15cdb82fd1a717E5dEEa4AF08D4349A',
+                nativeRouter: '0xCA1BDc038909038C4B3cbab0EA0ec3cC2839F106',
+                destinationRouter: '0xCb4057d7DA4CE521B93b71186DfE11f9FBC3e3b1',
+                validator: '0xDcd4D88552c86114b2ca029F7F8d4e1a7951d051',
+                usesExtraParam: false,
+                requiresDelivery: true,
+                toHome: false,
+                feeManager: 'from',
+                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]: {
+            [Chains.V4PLS]: {
+                from: '0x546e37DAA15cdb82fd1a717E5dEEa4AF08D4349A',
+                to: '0x6B08a50865aDeCe6e3869D9AfbB316d0a0436B6c',
+                nativeRouter: '0xCb4057d7DA4CE521B93b71186DfE11f9FBC3e3b1',
+                destinationRouter: '0xCA1BDc038909038C4B3cbab0EA0ec3cC2839F106',
+                validator: '0xDcd4D88552c86114b2ca029F7F8d4e1a7951d051',
+                usesExtraParam: false,
+                requiresDelivery: false,
+                toHome: true,
+                feeManager: 'to',
+                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',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+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],
+];
+const testnetBridgeKeys = [
+    [Provider.PULSECHAIN, Chains.SEP, Chains.V4PLS],
+    [Provider.PULSECHAIN, Chains.V4PLS, Chains.SEP],
+];
+export const validBridgeKeys = (isProd) => [
+    ...mainnetBridgeKeys,
+    ...(isProd ? [] : testnetBridgeKeys),
+];
+export const inferBridgeKey = ({ currentKey, provider, fromChain, toChain, }) => {
+    const [, fromChainKey, toChainKey] = currentKey;
+    const from = fromChain ?? fromChainKey;
+    const to = toChain ?? toChainKey;
+    const currentFromChainIsValid = !!_.get(pathways, [provider, from]);
+    const nextFromChain = currentFromChainIsValid
+        ? from
+        : Object.keys(pathways[provider])[0];
+    const currentToChainIsValid = !!_.get(pathways, [provider, nextFromChain, to]);
+    const nextToChain = currentToChainIsValid
+        ? to
+        : Object.keys(pathways[provider][nextFromChain])[0];
+    return [provider, nextFromChain, nextToChain];
+};
+export const pathway = (bridgeKey, isProd) => {
+    if (!bridgeKey)
+        return;
+    return _.get(pathways, bridgeKey) || (!isProd ? _.get(testnetPathways, bridgeKey) : undefined);
+};
+export const defaultAssetIn = ($bridgeKey, isProd) => {
+    const conf = pathway($bridgeKey, isProd);
+    const defaultAssetIn = _.get(conf, ['defaultAssetIn']);
+    return defaultAssetIn;
+};
+export const isNative = (asset, bridgeKey) => {
+    if (!bridgeKey || !asset) {
+        return false;
+    }
+    return ((asset.address === zeroAddress ||
+        nativeAssetOut[toChain(asset.chainId)]?.toLowerCase() === asset.address?.toLowerCase()) &&
+        !asset.name.includes(' from Pulsechain'));
+};
+export const isUnwrappable = (asset, bridgeKey) => {
+    if (!bridgeKey || !asset) {
+        return false;
+    }
+    const [, , toChain] = bridgeKey;
+    return nativeAssetOut[toChain] === asset.extensions?.bridgeInfo?.[Number(toChain)]?.tokenAddress;
+};
+export const canChangeUnwrap = (bridgeKey, assetIn) => !!assetIn && isUnwrappable(assetIn, bridgeKey);

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

@@ -0,0 +1,7 @@
+export declare enum FeeType {
+    PERCENT = "%",
+    GAS_TIP = "gas+%",
+    FIXED = "fixed"
+}
+export type FeeTypeKeys = keyof typeof FeeType;
+export declare const feeTypeValToKeyMap: Map<FeeType, "PERCENT" | "GAS_TIP" | "FIXED">;

package/dist/src/fee-type.js

@@ -0,0 +1,7 @@
+export var FeeType;
+(function (FeeType) {
+    FeeType["PERCENT"] = "%";
+    FeeType["GAS_TIP"] = "gas+%";
+    FeeType["FIXED"] = "fixed";
+})(FeeType || (FeeType = {}));
+export const feeTypeValToKeyMap = new Map(Object.keys(FeeType).map((key) => [FeeType[key], key]));

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

@@ -0,0 +1,12 @@
+export declare const setImageRoot: (root: string) => void;
+export declare const getImageRoot: () => string;
+interface MinimalTokenInfo {
+    chainId: number;
+    address: string;
+    logoURI?: string | null;
+}
+export declare const list: (path: string) => string;
+export declare const network: (chainId: number) => string;
+export declare const image: (t: MinimalTokenInfo) => string;
+export declare const images: (sources: string[]) => string;
+export {};

package/dist/src/image-links.js

@@ -0,0 +1,17 @@
+import { getAddress } from 'viem';
+let imageRoot = 'https://gib.show';
+export const setImageRoot = (root) => {
+    imageRoot = root;
+};
+export const getImageRoot = () => imageRoot;
+export const list = (path) => {
+    return `${imageRoot}/list${path}`;
+};
+export const network = (chainId) => {
+    if (!chainId) {
+        console.trace('network image');
+    }
+    return `${imageRoot}/image/${Number(chainId)}`;
+};
+export const image = (t) => t.logoURI || `${network(t.chainId)}/${getAddress(t.address)}`;
+export const images = (sources) => `${imageRoot}/image/?${sources.map((s) => `i=${s}`).join('&')}`;

package/dist/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './chain-info.js';
+export * from './abis.js';
+export * from './config.js';
+export * from './chains.js';
+export * from './types.js';
+export * from './image-links.js';

package/dist/src/index.js

@@ -0,0 +1,6 @@
+export * from './chain-info.js';
+export * from './abis.js';
+export * from './config.js';
+export * from './chains.js';
+export * from './types.js';
+export * from './image-links.js';

package/dist/src/types.d.ts

@@ -0,0 +1,35 @@
+import type { Hex, Chain } from 'viem';
+import type { Chains, Provider } from './config.js';
+export type PerNetworkBridgeLink = {
+    tokenAddress: Hex;
+};
+export type Extensions = {
+    wrapped?: {
+        address: Hex;
+    };
+    bridgeInfo?: Record<number, PerNetworkBridgeLink>;
+};
+export type TokenMetadata = {
+    name: string;
+    symbol: string;
+    decimals: number;
+};
+export type Token = TokenMetadata & {
+    address: string;
+    chainId: number;
+    logoURI: string | null;
+    extensions?: Extensions;
+};
+export type TokenOut = Omit<Token, 'address'> & {
+    address: string | null;
+};
+export type TokenList = {
+    tokens: Token[];
+};
+export type BridgeKey = [Provider, Chains, Chains];
+export type VisualChain = Chain & {
+    chainId: Chains;
+    logoURI: string;
+    alt: string;
+};
+export type ChainsMetadata = Record<Chains, VisualChain>;

package/dist/src/types.js

@@ -0,0 +1 @@
+export {};