@lifi/sdk 3.3.0-beta.0 → 3.3.0-beta.1

package/src/core/waitForReceivingTransaction.ts

@@ -17,59 +17,55 @@ export async function waitForReceivingTransaction(
   statusManager: StatusManager,
   processType: ProcessType,
   step: LiFiStep,
-  interval: number = 5_000
+  interval = 5_000
 ): Promise<StatusResponse> {
-  const _getStatus = (): Promise<StatusResponse | undefined> =>
-    new Promise(async (resolve, reject) => {
-      let statusResponse: StatusResponse
-      try {
-        statusResponse = await getStatus({
-          fromChain: step.action.fromChainId,
-          toChain: step.action.toChainId,
-          txHash,
-          ...(step.tool !== 'custom' && { bridge: step.tool }),
-        })
-      } catch (e: any) {
-        console.debug('Fetching status from backend failed.', e)
-        return resolve(undefined)
-      }
-
-      switch (statusResponse.status) {
-        case 'DONE':
-          return resolve(statusResponse)
-        case 'PENDING':
-          statusManager?.updateProcess(step, processType, 'PENDING', {
-            substatus: statusResponse.substatus,
-            substatusMessage:
-              statusResponse.substatusMessage ||
-              getSubstatusMessage(
-                statusResponse.status,
-                statusResponse.substatus
-              ),
-            txLink: (statusResponse as FullStatusData).bridgeExplorerLink,
-          })
-          return resolve(undefined)
-        case 'NOT_FOUND':
-          return resolve(undefined)
-        case 'INVALID':
-        case 'FAILED':
-        default:
-          return reject()
-      }
+  const _getStatus = (): Promise<StatusResponse | undefined> => {
+    return getStatus({
+      fromChain: step.action.fromChainId,
+      toChain: step.action.toChainId,
+      txHash,
+      ...(step.tool !== 'custom' && { bridge: step.tool }),
     })
+      .then((statusResponse) => {
+        switch (statusResponse.status) {
+          case 'DONE':
+            return statusResponse
+          case 'PENDING':
+            statusManager?.updateProcess(step, processType, 'PENDING', {
+              substatus: statusResponse.substatus,
+              substatusMessage:
+                statusResponse.substatusMessage ||
+                getSubstatusMessage(
+                  statusResponse.status,
+                  statusResponse.substatus
+                ),
+              txLink: (statusResponse as FullStatusData).bridgeExplorerLink,
+            })
+            return undefined
+          case 'NOT_FOUND':
+            return undefined
+          default:
+            return Promise.reject()
+        }
+      })
+      .catch((e) => {
+        console.debug('Fetching status from backend failed.', e)
+        return undefined
+      })
+  }
 
-  let status
+  let status = TRANSACTION_HASH_OBSERVERS[txHash]
 
-  if (txHash in TRANSACTION_HASH_OBSERVERS) {
-    status = await TRANSACTION_HASH_OBSERVERS[txHash]
-  } else {
-    TRANSACTION_HASH_OBSERVERS[txHash] = waitForResult(_getStatus, interval)
-    status = await TRANSACTION_HASH_OBSERVERS[txHash]
+  if (!status) {
+    status = waitForResult(_getStatus, interval)
+    TRANSACTION_HASH_OBSERVERS[txHash] = status
   }
 
-  if (!('receiving' in status)) {
+  const resolvedStatus = await status
+
+  if (!('receiving' in resolvedStatus)) {
     throw new ServerError("Status doesn't contain receiving information.")
   }
 
-  return status
+  return resolvedStatus
 }

package/src/createConfig.ts

@@ -1,9 +1,8 @@
-/* eslint-disable @typescript-eslint/no-empty-function */
 import { ChainType } from '@lifi/types'
 import { config } from './config.js'
 import { checkPackageUpdates } from './helpers.js'
 import { getChains } from './services/api.js'
-import type { SDKConfig } from './types/index.js'
+import type { SDKConfig } from './types/internal.js'
 import { name, version } from './version.js'
 
 function createBaseConfig(options: SDKConfig) {

package/src/errors/SDKError.ts

@@ -1,7 +1,7 @@
 import type { LiFiStep, Process } from '@lifi/types'
 import { version } from '../version.js'
 import type { BaseError } from './baseError.js'
-import { type ErrorCode } from './constants.js'
+import type { ErrorCode } from './constants.js'
 
 // Note: SDKError is used to wrapper and present errors at the top level
 // Where opportunity allows we also add the step and the process related to the error

package/src/errors/baseError.ts

@@ -2,7 +2,7 @@ import type { ErrorCode, ErrorName } from './constants.js'
 import { getRootCause } from './utils/rootCause.js'
 
 // Note: we use the BaseErrors to capture errors at specific points in the code
-//  they can carry addition to help give more context
+// they can carry addition to help give more context
 export class BaseError extends Error {
   code: ErrorCode
   override cause?: Error
@@ -15,7 +15,7 @@ export class BaseError extends Error {
     this.cause = cause
 
     const rootCause = getRootCause(this.cause)
-    if (rootCause && rootCause.stack) {
+    if (rootCause?.stack) {
       this.stack = rootCause.stack
     }
   }

package/src/errors/errors.ts

@@ -1,5 +1,5 @@
-import { ErrorName, LiFiErrorCode } from './constants.js'
 import { BaseError } from './baseError.js'
+import { ErrorName, LiFiErrorCode } from './constants.js'
 
 export class RPCError extends BaseError {
   constructor(code: LiFiErrorCode, message: string, cause?: Error) {

package/src/errors/httpError.ts

@@ -1,8 +1,8 @@
 import type { UnavailableRoutes } from '@lifi/types'
-import { LiFiErrorCode } from './constants.js'
-import { BaseError } from './baseError.js'
 import type { ExtendedRequestInit } from '../types/request.js'
-import { ErrorName, ErrorMessage } from './constants.js'
+import { BaseError } from './baseError.js'
+import { LiFiErrorCode } from './constants.js'
+import { ErrorMessage, ErrorName } from './constants.js'
 
 interface ServerErrorResponseBody {
   code: number

package/src/helpers.ts

@@ -1,7 +1,7 @@
-import { name, version } from './version.js'
-import { ValidationError } from './errors/errors.js'
+import type { LiFiStep, Route } from '@lifi/types'
 import { SDKError } from './errors/SDKError.js'
-import type { Route, LiFiStep } from '@lifi/types'
+import { ValidationError } from './errors/errors.js'
+import { name, version } from './version.js'
 
 export const checkPackageUpdates = async (
   packageName?: string,
@@ -16,11 +16,10 @@ export const checkPackageUpdates = async (
 
     if (latestVersion > currentVersion) {
       console.warn(
-        // eslint-disable-next-line max-len
         `${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`
       )
     }
-  } catch (error) {
+  } catch (_error) {
     // Cannot verify version, might be network error etc. We don't bother showing anything in that case
   }
 }

package/src/index.ts

@@ -1,3 +1,5 @@
+// biome-ignore lint/performance/noBarrelFile: module entrypoint
+// biome-ignore lint/performance/noReExportAll: types
 export * from '@lifi/types'
 export { config } from './config.js'
 export { EVM } from './core/EVM/EVM.js'
@@ -14,7 +16,37 @@ export type {
   MultisigTransaction,
   MultisigTxDetails,
 } from './core/EVM/types.js'
-export * from './core/index.js'
+export { StatusManager } from './core/StatusManager.js'
+export {
+  executeRoute,
+  getActiveRoute,
+  getActiveRoutes,
+  resumeRoute,
+  stopRouteExecution,
+  updateRouteExecution,
+} from './core/execution.js'
+export type {
+  AcceptExchangeRateUpdateHook,
+  AcceptSlippageUpdateHook,
+  AcceptSlippageUpdateHookParams,
+  ExchangeRateUpdateParams,
+  ExecutionOptions,
+  InteractionSettings,
+  LiFiStepExtended,
+  RouteExecutionData,
+  RouteExecutionDataDictionary,
+  RouteExecutionDictionary,
+  RouteExtended,
+  SDKProvider,
+  StepExecutor,
+  StepExecutorOptions,
+  StepExtended,
+  SwitchChainHook,
+  TransactionParameters,
+  TransactionRequestParameters,
+  TransactionRequestUpdateHook,
+  UpdateRouteHook,
+} from './core/types.js'
 export { isSVMAddress } from './core/Solana/isSVMAddress.js'
 export {
   KeypairWalletAdapter,
@@ -22,13 +54,56 @@ export {
 } from './core/Solana/KeypairWalletAdapter.js'
 export { Solana } from './core/Solana/Solana.js'
 export { isUTXOAddress } from './core/UTXO/isUTXOAddress.js'
-export * from './core/UTXO/utxo-stack/clients/types.js'
+export type {
+  BtcAccount,
+  SignPsbtParameters,
+  SignPsbtReturnType,
+  UTXOWalletProvider,
+  UTXOWalletSchema,
+} from './core/UTXO/utxo-stack/clients/types.js'
 export { UTXO } from './core/UTXO/UTXO.js'
 export { createConfig } from './createConfig.js'
-export * from './errors/index.js'
-export { type ErrorCode } from './errors/index.js'
-export * from './helpers.js'
-export * from './services/api.js'
-export * from './services/balance.js'
-export * from './services/getNameServiceAddress.js'
-export * from './types/index.js'
+export {
+  checkPackageUpdates,
+  convertQuoteToRoute,
+  fetchTxErrorDetails,
+} from './helpers.js'
+export {
+  getChains,
+  getConnections,
+  getContractCallsQuote,
+  getGasRecommendation,
+  getQuote,
+  getRoutes,
+  getStatus,
+  getStepTransaction,
+  getToken,
+  getTokens,
+  getTools,
+  getTransactionHistory,
+} from './services/api.js'
+export {
+  getTokenBalance,
+  getTokenBalances,
+  getTokenBalancesByChain,
+} from './services/balance.js'
+export { getNameServiceAddress } from './services/getNameServiceAddress.js'
+export type { RPCUrls, SDKBaseConfig, SDKConfig } from './types/internal.js'
+export { BaseError } from './errors/baseError.js'
+export {
+  ErrorMessage,
+  ErrorName,
+  LiFiErrorCode,
+} from './errors/constants.js'
+export type { ErrorCode } from './errors/constants.js'
+export {
+  BalanceError,
+  ProviderError,
+  RPCError,
+  ServerError,
+  TransactionError,
+  UnknownError,
+  ValidationError,
+} from './errors/errors.js'
+export { HTTPError } from './errors/httpError.js'
+export { SDKError } from './errors/SDKError.js'

package/src/request.ts

@@ -1,7 +1,7 @@
 import { config } from './config.js'
+import { SDKError } from './errors/SDKError.js'
 import { ValidationError } from './errors/errors.js'
 import { HTTPError } from './errors/httpError.js'
-import { SDKError } from './errors/SDKError.js'
 import type { ExtendedRequestInit } from './types/request.js'
 import { sleep } from './utils/sleep.js'
 import { version } from './version.js'

package/src/services/api.ts

@@ -1,6 +1,4 @@
 import {
-  isContractCallsRequestWithFromAmount,
-  isContractCallsRequestWithToAmount,
   type ChainId,
   type ChainKey,
   type ChainsRequest,
@@ -25,10 +23,12 @@ import {
   type ToolsResponse,
   type TransactionAnalyticsRequest,
   type TransactionAnalyticsResponse,
+  isContractCallsRequestWithFromAmount,
+  isContractCallsRequestWithToAmount,
 } from '@lifi/types'
 import { config } from '../config.js'
-import { ValidationError } from '../errors/errors.js'
 import { SDKError } from '../errors/SDKError.js'
+import { ValidationError } from '../errors/errors.js'
 import { request } from '../request.js'
 import { isRoutesRequest, isStep } from '../typeguards.js'
 import { withDedupe } from '../utils/withDedupe.js'
@@ -85,7 +85,7 @@ export const getQuote = async (
     'toChain',
     'toToken',
   ]
-  requiredParameters.forEach((requiredParameter) => {
+  for (const requiredParameter of requiredParameters) {
     if (!params[requiredParameter]) {
       throw new SDKError(
         new ValidationError(
@@ -93,7 +93,7 @@ export const getQuote = async (
         )
       )
     }
-  })
+  }
   const _config = config.get()
   // apply defaults
   params.integrator ??= _config.integrator
@@ -108,11 +108,11 @@ export const getQuote = async (
   params.denyExchanges ??= _config.routeOptions?.exchanges?.deny
   params.preferExchanges ??= _config.routeOptions?.exchanges?.prefer
 
-  Object.keys(params).forEach(
-    (key) =>
-      !params[key as keyof QuoteRequest] &&
+  for (const key of Object.keys(params)) {
+    if (!params[key as keyof QuoteRequest]) {
       delete params[key as keyof QuoteRequest]
-  )
+    }
+  }
 
   return await request<LiFiStep>(
     `${_config.apiUrl}/quote?${new URLSearchParams(
@@ -144,7 +144,7 @@ export const getContractCallsQuote = async (
     'toToken',
     'contractCalls',
   ]
-  requiredParameters.forEach((requiredParameter) => {
+  for (const requiredParameter of requiredParameters) {
     if (!params[requiredParameter]) {
       throw new SDKError(
         new ValidationError(
@@ -152,7 +152,7 @@ export const getContractCallsQuote = async (
         )
       )
     }
-  })
+  }
   if (
     !isContractCallsRequestWithFromAmount(params) &&
     !isContractCallsRequestWithToAmount(params)
@@ -226,11 +226,11 @@ export const getChains = async (
   options?: RequestOptions
 ): Promise<ExtendedChain[]> => {
   if (params) {
-    Object.keys(params).forEach(
-      (key) =>
-        !params[key as keyof ChainsRequest] &&
+    for (const key of Object.keys(params)) {
+      if (!params[key as keyof ChainsRequest]) {
         delete params[key as keyof ChainsRequest]
-    )
+      }
+    }
   }
   const urlSearchParams = new URLSearchParams(
     params as Record<string, string>
@@ -293,7 +293,6 @@ export const getStepTransaction = async (
 ): Promise<LiFiStep> => {
   if (!isStep(step)) {
     // While the validation fails for some users we should not enforce it
-    // eslint-disable-next-line no-console
     console.warn('SDK Validation: Invalid Step', step)
   }
 
@@ -321,11 +320,11 @@ export const getTools = async (
   options?: RequestOptions
 ): Promise<ToolsResponse> => {
   if (params) {
-    Object.keys(params).forEach(
-      (key) =>
-        !params[key as keyof ToolsRequest] &&
+    for (const key of Object.keys(params)) {
+      if (!params[key as keyof ToolsRequest]) {
         delete params[key as keyof ToolsRequest]
-    )
+      }
+    }
   }
   return await request<ToolsResponse>(
     `${config.get().apiUrl}/tools?${new URLSearchParams(
@@ -348,11 +347,11 @@ export const getTokens = async (
   options?: RequestOptions
 ): Promise<TokensResponse> => {
   if (params) {
-    Object.keys(params).forEach(
-      (key) =>
-        !params[key as keyof TokensRequest] &&
+    for (const key of Object.keys(params)) {
+      if (!params[key as keyof TokensRequest]) {
         delete params[key as keyof TokensRequest]
-    )
+      }
+    }
   }
   const urlSearchParams = new URLSearchParams(
     params as Record<string, string>
@@ -434,18 +433,15 @@ export const getConnections = async (
     'denyExchanges',
     'preferExchanges',
   ]
-  connectionRequestArrayParams.forEach((parameter) => {
-    const connectionRequestArrayParam: string[] = connectionRequest[
-      parameter
-    ] as string[]
+  for (const parameter of connectionRequestArrayParams) {
+    const connectionRequestArrayParam = connectionRequest[parameter] as string[]
 
     if (connectionRequestArrayParam?.length) {
-      connectionRequestArrayParam?.forEach((value) => {
+      for (const value of connectionRequestArrayParam) {
         url.searchParams.append(parameter, value)
-      })
+      }
     }
-  })
-
+  }
   return await request<ConnectionsResponse>(url, options)
 }
 

package/src/services/balance.ts

@@ -66,13 +66,13 @@ export const getTokenBalancesByChain = async (
   const tokenList = Object.values(tokensByChain).flat()
   const invalidTokens = tokenList.filter((token) => !isToken(token))
   if (invalidTokens.length) {
-    throw new ValidationError(`Invalid tokens passed.`)
+    throw new ValidationError('Invalid tokens passed.')
   }
 
   const tokenAmountsByChain: { [chainId: number]: TokenAmount[] } = {}
   const tokenAmountsSettled = await Promise.allSettled(
     Object.keys(tokensByChain).map(async (chainIdStr) => {
-      const chainId = parseInt(chainIdStr)
+      const chainId = Number.parseInt(chainIdStr)
       const chain = await config.getChainById(chainId)
       const tokenAddress = tokensByChain[chainId][0].address
       const provider = config
@@ -95,11 +95,11 @@ export const getTokenBalancesByChain = async (
     })
   )
   if (config.get().debug) {
-    tokenAmountsSettled.forEach((promise) => {
-      if (promise.status === 'rejected') {
-        console.log("Couldn't fetch token balance.", promise.reason)
+    for (const result of tokenAmountsSettled) {
+      if (result.status === 'rejected') {
+        console.warn("Couldn't fetch token balance.", result.reason)
       }
-    })
+    }
   }
   return tokenAmountsByChain
 }

package/src/types/internal.ts

@@ -21,43 +21,3 @@ export interface SDKConfig extends Partial<Omit<SDKBaseConfig, 'integrator'>> {
 }
 
 export type RPCUrls = Partial<Record<ChainId, string[]>>
-
-export interface TenderlyResponse {
-  hash: string
-  block_hash: string
-  block_number: number
-  from: string
-  gas: number
-  gas_price: number
-  gas_fee_cap: number
-  gas_tip_cap: number
-  cumulative_gas_used: number
-  gas_used: number
-  effective_gas_price: number
-  input: string
-  nonce: number
-  to: string
-  index: number
-  value: string
-  access_list: unknown
-  status: boolean
-  addresses: string[]
-  contract_ids: string[]
-  network_id: string
-  timestamp: string
-  function_selector: string
-  l1_block_number: number
-  l1_timestamp: number
-  deposit_tx: boolean
-  system_tx: boolean
-  mint: number
-  sig: {
-    v: string
-    r: string
-    s: string
-  }
-  error_message: string
-  method: string
-  decoded_input: unknown
-  call_trace: unknown
-}

package/src/utils/getTransactionMessage.ts

@@ -23,10 +23,9 @@ export const getTransactionNotSentMessage = async (
     ", please retry.<br/>If it still doesn't work, it is safe to delete this transfer and start a new one."
 
   // add transaction explorer link if available
-  transactionNotSend +=
-    process && process.txLink
-      ? `<br>You can check the failed transaction&nbsp;<a href="${process.txLink}" target="_blank" rel="nofollow noreferrer">here</a>.`
-      : ''
+  transactionNotSend += process?.txLink
+    ? `<br>You can check the failed transaction&nbsp;<a href="${process.txLink}" target="_blank" rel="nofollow noreferrer">here</a>.`
+    : ''
 
   return transactionNotSend
 }

package/src/utils/withDedupe.ts

@@ -28,7 +28,6 @@ type WithDedupeOptions = {
   id?: string | undefined
 }
 
-// eslint-disable-next-line jsdoc/require-param, jsdoc/require-returns
 /** Deduplicates in-flight promises. */
 export function withDedupe<data>(
   fn: () => Promise<data>,

package/src/version.ts

@@ -1,2 +1,2 @@
 export const name = '@lifi/sdk'
-export const version = '3.3.0-beta.0'
+export const version = '3.3.0-beta.1'