@gibs/bridge-sdk 1.7.1 → 1.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibs/bridge-sdk",
-  "version": "1.7.1",
+  "version": "1.7.3",
   "main": "index.js",
   "access": "public",
   "type": "module",
@@ -12,7 +12,8 @@
     "./image-links": "./src/image-links.ts",
     "./chains": "./src/chains.ts",
     "./chain-info": "./src/chain-info.ts",
-    "./fee-type": "./src/fee-type.ts"
+    "./fee-type": "./src/fee-type.ts",
+    "./settings": "./src/settings.ts"
   },
   "scripts": {
     "build": "tsc"

package/src/abis.ts

@@ -1,6 +1,6 @@
 import { parseAbi, parseAbiParameters } from 'viem'
 
-/** the abi for the bridge */
+/** the abi for the input bridge */
 export const inputBridge = parseAbi([
   'function minPerTx(address token) external view returns(uint256)',
   'function foreignTokenAddress(address token) external view returns(address)',
@@ -11,47 +11,59 @@ export const inputBridge = parseAbi([
   'function relayTokensAndCall(address token, address _receiver, uint256 _value, bytes memory _data) external',
   'function relayTokens(address token, address _receiver, uint256 _value) external',
 ])
+/** the abi for the input bridge with extra input for the sender origin (tokensex) */
 export const inputBridgeExtraInput = parseAbi([
   'function relayTokensAndCall(address token, address _receiver, uint256 _value, bytes memory _data, address _senderOrigin) external',
   'function relayTokens(address token, address _receiver, uint256 _value, address _senderOrigin) external',
 ])
+/** the abi for erc677 tokens */
 export const erc677 = parseAbi([
   'function transferAndCall(address, uint256, bytes calldata) external',
 ])
+/** the abi for erc677 tokens bridge with extra input for the sender origin (tokensex) */
 export const erc677ExtraInput = parseAbi([
   'function transferAndCall(address, uint256, bytes calldata, address sender) external',
 ])
+/** the abi to read data from the output router */
 export const outputRouter = parseAbi([
   'function onTokenBridged(address _token, uint256 _value, bytes memory _data) external payable',
   'function WETH() external view returns(address)',
   'function bridge() external view returns(address)',
 ])
+/** the abi for the output bridge */
 export const outputBridge = parseAbi(['function bridgeContract() external view returns(address)'])
+/** the abi for the fee manager */
 export const feeManager = parseAbi([
   'function HOME_TO_FOREIGN_FEE() public view returns(bytes32)',
   'function FOREIGN_TO_HOME_FEE() public view returns(bytes32)',
   'function getFee(bytes32, address) public view returns(uint256)',
 ])
+/** the abi for the native router */
 export const nativeRouter = parseAbi([
   'function wrapAndRelayTokens(address receiver) external payable',
   'function relayTokensAndCall(address receiver, bytes calldata data) external payable',
 ])
+/** the abi for the native router with extra input for the sender origin (tokensex) */
 export const nativeRouterExtraInput = parseAbi([
   'function wrapAndRelayTokens(address receiver, address sender) external payable',
   'function relayTokensAndCall(address receiver, bytes calldata data, address sender) external payable',
 ])
+/** the abi for the univ2 router */
 export const univ2Router = parseAbi([
   'function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns(uint256[] memory)',
 ])
+/** the abi for the fee delivery struct */
 export const feeDeliveryStruct = parseAbiParameters('(address, uint256, uint256, uint256)')
-
+/** the abi for the relay tokens direct */
 export const relayTokensDirect = parseAbi([
   'function safeExecuteSignaturesWithAutoGasLimit(bytes calldata data, bytes calldata signatures) external',
 ])
+/** the abi for the home amb */
 export const homeAmb = parseAbi([
   'function submitSignature(bytes message, bytes signature) external',
 ])
 
+/** the abi for the univ2 pair */
 export const pair = parseAbi([
   'function getReserves() view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast)',
 ])

package/src/chain-info.ts

@@ -20,6 +20,14 @@ export type TokenBridgeInfo = {
   }
 }
 
+/**
+ * Returns the bridged token address and native token address
+ * @param chainId - the chain id being targeted
+ * @param target - the target
+ * @param address - the address
+ * @param client - the client
+ * @returns the bridged token address and native token address
+ */
 export const links = _.memoize(
   async ({ chainId, target, address, client }: { chainId: number; target: Hex; address: Hex, client: PublicClient }) => {
     return multicallRead<Hex[]>({
@@ -36,6 +44,15 @@ export const links = _.memoize(
   ({ chainId, target, address }) => `${chainId}-${target}-${address}`.toLowerCase(),
 )
 
+/**
+ * Returns the token bridge info for the given bridge key, asset in, is prod, from chain client, and to chain client
+ * @param bridgeKey - the bridge key
+ * @param assetIn - the asset in
+ * @param isProd - whether to use the production pathway
+ * @param fromChainClient - the from chain client
+ * @param toChainClient - the to chain client
+ * @returns the token bridge info
+ */
 export const tokenBridgeInfo = async ({
   bridgeKey,
   assetIn,
@@ -72,11 +89,7 @@ export const tokenBridgeInfo = async ({
     }),
   ])
   const [toBridged, toNative] = toMappings
-  // const notGas = !Object.values(nativeAssetOut).find(
-  //   (v) => v.toLowerCase() === assetInAddress.toLowerCase(),
-  // )
   if (toBridged !== zeroAddress) {
-    // if (notGas) console.log('toBridged')
     return {
       originationChainId: fromChain,
       assetInAddress: assetInAddress as Hex,
@@ -88,8 +101,6 @@ export const tokenBridgeInfo = async ({
     }
   }
   if (toNative !== zeroAddress) {
-    // if (notGas) console.log('toNative')
-    console.log('toNative', toNative)
     return {
       originationChainId: toChain,
       assetInAddress: assetInAddress as Hex,
@@ -102,8 +113,6 @@ export const tokenBridgeInfo = async ({
   }
   const [fromBridged, fromNative] = fromMappings
   if (fromNative !== zeroAddress) {
-    // if (notGas) console.log('fromNative')
-    console.log('fromNative', fromNative)
     return {
       originationChainId: toChain,
       assetInAddress: assetInAddress as Hex,
@@ -115,7 +124,6 @@ export const tokenBridgeInfo = async ({
     }
   }
   if (fromBridged !== zeroAddress) {
-    // if (notGas) console.log('fromBridged')
     return {
       originationChainId: fromChain,
       assetInAddress: assetInAddress as Hex,
@@ -146,9 +154,10 @@ export const tokenBridgeInfo = async ({
       }),
   }
 }
+/** The result of reading the amount out from a router */
 export type FetchResult = bigint[] | Hex
 /**
- * check the prices that each router offers for the given paths
+ * Check the prices that each router offers for the given paths
  * @param assetInAddress the address of the asset going into the bridge
  * @param oneTokenInt the number of tokens to push into the bridge (before fees)
  * @param chain the chain of the asset going into the bridge
@@ -186,10 +195,19 @@ const readAmountOut = ({
   })
 }
 
+/**
+ * Fetch the price corrective for the given bridge key, asset out, measurement token, from chain client, to chain client, asset link, amount in, and is prod
+ * @param bridgeKeyPartner - the bridge key partner
+ * @param assetOut - the asset out
+ * @param measurementToken - the measurement token
+ * @param fromChainClient - the from chain client
+ * @param toChainClient - the to chain client
+ * @param assetLink - the asset link
+ * @param amountIn - the amount in
+ * @param isProd - whether to use the production pathway
+ * @returns the price corrective
+ */
 export const fetchPriceCorrective = ({
-  // bridgeKey,
-  // assetIn,
-  // isProd,
   bridgeKeyPartner,
   assetOut,
   measurementToken,
@@ -300,6 +318,14 @@ export const fetchPriceCorrective = ({
   }
 }
 
+/**
+ * Fetch the minimum bridge amount in for the given asset in, pathway, from public client, and to public client
+ * @param assetIn - the asset in
+ * @param pathway - the pathway
+ * @param fromPublicClient - the from public client
+ * @param toPublicClient - the to public client
+ * @returns the minimum bridge amount in
+ */
 export const minBridgeAmountIn = async ({
   assetIn,
   pathway,
@@ -324,18 +350,24 @@ export const nativeSymbol = (asset: { address: string, symbol: string, chainId:
   return asset ? (unwrap && asset.address === nativeAssetOut[toChain(asset.chainId)] ? asset.symbol.slice(1) : asset.symbol) : ''
 }
 
+/** The input for loading the bridge fees */
 export type InputLoadFeeFor = {
   pathway: Pathway
   fromChainClient: PublicClient
   toChainClient: PublicClient
 }
 
+/** The fee configuration for a given pathway */
 export type PathwayExtendableConfig = {
   feeManager: Hex
   feeH2F: bigint
   feeF2H: bigint
 }
-
+/**
+ * Returns the chain multicall for the given client
+ * @param client - the client
+ * @returns the chain multicall
+ */
 export const chainMulticall = (client: PublicClient) => {
   const chainId = client.chain!.id
   const metadata = chainsMetadata[toChain(chainId)]
@@ -345,7 +377,13 @@ export const chainMulticall = (client: PublicClient) => {
     address: metadata.contracts!.multicall3!.address,
   }) as any
 }
-
+/**
+ * Load the bridge fees for the given pathway, from chain client, and to chain client
+ * @param pathway - the pathway
+ * @param fromChainClient - the from chain client
+ * @param toChainClient - the to chain client
+ * @returns the bridge fees
+ */
 export const loadBridgeFees = async ({ pathway, fromChainClient, toChainClient }: InputLoadFeeFor) => {
   const multicall = pathway.feeManager === 'from'
     ? chainMulticall(fromChainClient)

package/src/config.ts

@@ -16,21 +16,35 @@ export enum Chains {
   // TBNB = '0x61',
 }
 
+/** The key of a chain - human readable for query params */
 export type ChainKey = keyof typeof Chains
 
+/** A map of chain ids to chain keys */
 export const chainIdToKey = new Map<Chains, ChainKey>(
   Object.entries(Chains).map(([key, chain]) => [chain, key] as [Chains, ChainKey]),
 )
 
+/**
+ * Converts a chain id to a chain key
+ * @param chainId - the chain id
+ * @returns the chain key
+ */
 export const toChain = (chainId: number | string) => `0x${Number(chainId).toString(16)}` as Chains
 
+/**
+ * Converts a chain id to a chain key
+ * @param chainId - the chain id
+ * @returns the chain key
+ */
 export const toChainKey = (chainId: number | string) => chainIdToKey.get(toChain(chainId))
 
+/** The provider of an omnibridge */
 export enum Provider {
   PULSECHAIN = 'pulsechain',
   TOKENSEX = 'tokensex',
 }
 
+/** A map of chains to native asset out addresses */
 export const nativeAssetOut = {
   [Chains.ETH]: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
   [Chains.BNB]: '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c',
@@ -39,10 +53,12 @@ export const nativeAssetOut = {
   [Chains.V4PLS]: '0x70499adEBB11Efd915E3b69E700c331778628707',
 } as Record<Chains, Hex>
 
+/** A map of chains to deprecated native asset out addresses */
 export const deprecatedNativeAssetOut = {
   [Chains.PLS]: new Set(['0x97Ac4a2439A47c07ad535bb1188c989dae755341']),
 } as Partial<Record<Chains, Set<Hex>>>
 
+/** A map of chains to uni v2 router addresses */
 export const uniV2Routers = {
   [Chains.PLS]: [
     '0x98bf93ebf5c380C0e6Ae8e192A7e2AE08edAcc02',
@@ -57,6 +73,7 @@ export const uniV2Routers = {
   ],
 } as Record<Chains, Hex[]>
 
+/** A map of chains to native token symbols */
 export const nativeTokenSymbol = {
   [Chains.PLS]: 'PLS',
   [Chains.V4PLS]: 'V4PLS',
@@ -65,6 +82,7 @@ export const nativeTokenSymbol = {
   [Chains.BNB]: 'BNB',
 } as Record<Chains, string>
 
+/** A map of chains to native token names */
 export const nativeTokenName = {
   [Chains.PLS]: 'Pulse',
   [Chains.V4PLS]: 'V4 Pulse',
@@ -73,13 +91,14 @@ export const nativeTokenName = {
   [Chains.BNB]: 'BNB',
 } as Record<Chains, string>
 
+/** The pathway of a bridge */
 export type Pathway = {
   from: Hex
   to: Hex
   destinationRouter: Hex | null
   nativeRouter: Hex
   validator: Hex
-  defaultAssetIn: Token
+  // defaultAssetIn: Token
   usesExtraParam: boolean
   feeManager: 'from' | 'to'
   toHome: boolean
@@ -88,11 +107,13 @@ export type Pathway = {
   settingOverrides?: Record<Hex, Partial<Pathway>>
 }
 
+/** A map of providers to pathways */
 export type DeepPathwayConfig = Record<
   Provider,
   Partial<Record<Chains, Partial<Record<Chains, Pathway>>>>
 >
 
+/** The settings for the pulsechain pls eth pathway */
 const pulsechainPLSETHSettings = {
   from: '0x0e18d0d556b652794EF12Bf68B2dC857EF5f3996',
   to: '0xe20E337DB2a00b1C37139c873B92a0AAd3F468bF',
@@ -119,21 +140,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]: {
@@ -157,21 +163,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',
-              },
-            },
-          },
-        },
       },
     },
   },
@@ -189,21 +180,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]: {
@@ -219,21 +195,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',
-              },
-            },
-          },
-        },
       },
     },
   },
@@ -276,21 +237,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]: {
@@ -305,26 +251,12 @@ 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',
-              },
-            },
-          },
-        },
       },
     },
   },
 } as DeepPathwayConfig
 
+/** The mainnet bridge keys */
 const mainnetBridgeKeys = [
   [Provider.PULSECHAIN, Chains.PLS, Chains.ETH],
   [Provider.PULSECHAIN, Chains.ETH, Chains.PLS],
@@ -332,16 +264,26 @@ const mainnetBridgeKeys = [
   [Provider.TOKENSEX, Chains.BNB, Chains.PLS],
 ] as BridgeKey[]
 
+/** The testnet bridge keys */
 const testnetBridgeKeys = [
   [Provider.PULSECHAIN, Chains.SEP, Chains.V4PLS],
   [Provider.PULSECHAIN, Chains.V4PLS, Chains.SEP],
 ] as BridgeKey[]
 
+/** Returns the valid bridge keys for the given is prod */
 export const validBridgeKeys = (isProd: boolean) => [
   ...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,
@@ -367,6 +309,13 @@ export const inferBridgeKey = ({
   return [provider, nextFromChain, nextToChain] as BridgeKey
 }
 
+/**
+ * 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: BridgeKey | null, isProd: boolean, assetInAddress?: string | Hex | null | undefined) => {
   if (!bridgeKey) return
   let pathway = _.get(pathways, bridgeKey) || (!isProd ? _.get(testnetPathways, bridgeKey) : undefined)
@@ -382,12 +331,25 @@ export const pathway = (bridgeKey: BridgeKey | null, isProd: boolean, assetInAdd
   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: BridgeKey | null, isProd: boolean) => {
+  if (!$bridgeKey) return null
   const conf = pathway($bridgeKey, isProd)
-  const defaultAssetIn = _.get(conf, ['defaultAssetIn']) as Token | undefined
+  const defaultAssetIn = _.get(conf, ['bridgedNativeAssetOut']) as Hex | undefined
   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: Token | TokenOut | null, bridgeKey: BridgeKey | null) => {
   if (!bridgeKey || !asset) {
     return false
@@ -401,6 +363,12 @@ export const isNative = (asset: Token | TokenOut | null, bridgeKey: BridgeKey |
   )
 }
 
+/**
+ * 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: BridgeKey | null,
   assetIn: Pick<Token, 'address'> | null,
@@ -414,6 +382,12 @@ export const isUnwrappable = (
   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: BridgeKey, assetIn: Token | null) => {
   return !!assetIn && isUnwrappable(bridgeKey, assetIn)
 }

package/src/fee-type.ts

@@ -1,12 +1,14 @@
-
+/** The type of fee to use for the bridge */
 export 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 const feeTypeValToKeyMap = new Map<FeeType, FeeTypeKeys>(
   (Object.keys(FeeType) as FeeTypeKeys[]).map((key) => [FeeType[key], key]),
 )

package/src/image-links.ts

@@ -2,22 +2,41 @@ import { getAddress } from 'viem'
 
 let imageRoot = 'https://gib.show'
 
+/**
+ * Sets the image root for the bridge
+ * @param root - the root
+ */
 export const setImageRoot = (root: string) => {
   imageRoot = root
 }
 
+/**
+ * Returns the image root for the bridge
+ * @returns the image root
+ */
 export const getImageRoot = () => imageRoot
 
+/** 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 const list = (path: string) => {
   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: number) => {
   if (!chainId) {
     console.trace('network image')
@@ -25,8 +44,18 @@ export const network = (chainId: number) => {
   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: MinimalTokenInfo) =>
   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: string[]) =>
   `${imageRoot}/image/?${sources.map((s) => `i=${s}`).join('&')}`

package/src/index.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'