@lifi/sdk 3.13.5 → 4.0.0-alpha.2

package/src/client/getClientStorage.ts

@@ -0,0 +1,40 @@
+import { ChainId, ChainType, type ExtendedChain } from '@lifi/types'
+import { getChainsFromConfig } from '../actions/getChains.js'
+import { getRpcUrlsFromChains } from '../core/utils.js'
+import type { RPCUrls, SDKBaseConfig } from '../types/core.js'
+
+export const getClientStorage = (config: SDKBaseConfig) => {
+  let _chains = [] as ExtendedChain[]
+  let _rpcUrls = { ...config.rpcUrls } as RPCUrls
+  let _chainsUpdatedAt: number | undefined
+
+  return {
+    get needReset() {
+      return (
+        !_chainsUpdatedAt ||
+        Date.now() - _chainsUpdatedAt >= 1000 * 60 * 60 * 24
+      )
+    },
+    async getChains() {
+      if (this.needReset || !_chains.length) {
+        _chains = await getChainsFromConfig(config, {
+          chainTypes: [
+            ChainType.EVM,
+            ChainType.SVM,
+            ChainType.UTXO,
+            ChainType.MVM,
+          ],
+        })
+        _chainsUpdatedAt = Date.now()
+      }
+      return _chains
+    },
+    async getRpcUrls() {
+      if (this.needReset || !Object.keys(_rpcUrls).length) {
+        const chains = await this.getChains()
+        _rpcUrls = getRpcUrlsFromChains(_rpcUrls, chains, [ChainId.SOL])
+      }
+      return _rpcUrls
+    },
+  }
+}

package/src/core/BaseStepExecutor.ts

@@ -1,11 +1,12 @@
 import type { LiFiStep } from '@lifi/types'
-import { StatusManager } from './StatusManager.js'
 import type {
   ExecutionOptions,
   InteractionSettings,
+  SDKClient,
   StepExecutor,
   StepExecutorOptions,
-} from './types.js'
+} from '../types/core.js'
+import { StatusManager } from './StatusManager.js'
 
 // Please be careful when changing the defaults as it may break the behavior (e.g., background execution)
 const defaultInteractionSettings = {
@@ -36,5 +37,5 @@ export abstract class BaseStepExecutor implements StepExecutor {
     this.allowExecution = interactionSettings.allowExecution
   }
 
-  abstract executeStep(step: LiFiStep): Promise<LiFiStep>
+  abstract executeStep(client: SDKClient, step: LiFiStep): Promise<LiFiStep>
 }

package/src/core/StatusManager.ts

@@ -1,6 +1,4 @@
 import type { ChainId, LiFiStep } from '@lifi/types'
-import { executionState } from './executionState.js'
-import { getProcessMessage } from './processMessages.js'
 import type {
   Execution,
   ExecutionStatus,
@@ -8,7 +6,9 @@ import type {
   Process,
   ProcessStatus,
   ProcessType,
-} from './types.js'
+} from '../types/core.js'
+import { executionState } from './executionState.js'
+import { getProcessMessage } from './processMessages.js'
 
 type FindOrCreateProcessProps = {
   step: LiFiStepExtended

package/src/core/checkBalance.ts

@@ -1,15 +1,21 @@
 import type { LiFiStep } from '@lifi/types'
 import { formatUnits } from 'viem'
+import { getTokenBalance } from '../actions/getTokenBalance.js'
 import { BalanceError } from '../errors/errors.js'
-import { getTokenBalance } from '../services/balance.js'
+import type { SDKClient } from '../types/core.js'
 import { sleep } from '../utils/sleep.js'
 
 export const checkBalance = async (
+  client: SDKClient,
   walletAddress: string,
   step: LiFiStep,
   depth = 0
 ): Promise<void> => {
-  const token = await getTokenBalance(walletAddress, step.action.fromToken)
+  const token = await getTokenBalance(
+    client,
+    walletAddress,
+    step.action.fromToken
+  )
   if (token) {
     const currentBalance = token.amount ?? 0n
     const neededBalance = BigInt(step.action.fromAmount)
@@ -17,7 +23,7 @@ export const checkBalance = async (
     if (currentBalance < neededBalance) {
       if (depth <= 3) {
         await sleep(200)
-        await checkBalance(walletAddress, step, depth + 1)
+        await checkBalance(client, walletAddress, step, depth + 1)
       } else if (
         (neededBalance *
           BigInt((1 - (step.action.slippage ?? 0)) * 1_000_000_000)) /

package/src/core/execution.ts

@@ -1,19 +1,25 @@
 import type { Route } from '@lifi/types'
-import { config } from '../config.js'
 import { LiFiErrorCode } from '../errors/constants.js'
 import { ProviderError } from '../errors/errors.js'
+import type {
+  ExecutionOptions,
+  RouteExtended,
+  SDKClient,
+  SDKProvider,
+} from '../types/core.js'
 import { executionState } from './executionState.js'
 import { prepareRestart } from './prepareRestart.js'
-import type { ExecutionOptions, RouteExtended } from './types.js'
 
 /**
  * Execute a route.
+ * @param client - The SDK client.
  * @param route - The route that should be executed. Cannot be an active route.
  * @param executionOptions - An object containing settings and callbacks.
  * @returns The executed route.
  * @throws {LiFiError} Throws a LiFiError if the execution fails.
  */
 export const executeRoute = async (
+  client: SDKClient,
   route: Route,
   executionOptions?: ExecutionOptions
 ): Promise<RouteExtended> => {
@@ -27,7 +33,7 @@ export const executeRoute = async (
   }
 
   executionState.create({ route: clonedRoute, executionOptions })
-  executionPromise = executeSteps(clonedRoute)
+  executionPromise = executeSteps(client, clonedRoute)
   executionState.update({
     route: clonedRoute,
     promise: executionPromise,
@@ -38,12 +44,14 @@ export const executeRoute = async (
 
 /**
  * Resume the execution of a route that has been stopped or had an error while executing.
+ * @param client - The SDK client.
  * @param route - The route that is to be executed. Cannot be an active route.
  * @param executionOptions - An object containing settings and callbacks.
  * @returns The executed route.
  * @throws {LiFiError} Throws a LiFiError if the execution fails.
  */
 export const resumeRoute = async (
+  client: SDKClient,
   route: Route,
   executionOptions?: ExecutionOptions
 ): Promise<RouteExtended> => {
@@ -68,10 +76,13 @@ export const resumeRoute = async (
 
   prepareRestart(route)
 
-  return executeRoute(route, executionOptions)
+  return executeRoute(client, route, executionOptions)
 }
 
-const executeSteps = async (route: RouteExtended): Promise<RouteExtended> => {
+const executeSteps = async (
+  client: SDKClient,
+  route: RouteExtended
+): Promise<RouteExtended> => {
   // Loop over steps and execute them
   for (let index = 0; index < route.steps.length; index++) {
     const execution = executionState.get(route.id)
@@ -103,9 +114,9 @@ const executeSteps = async (route: RouteExtended): Promise<RouteExtended> => {
         throw new Error('Action fromAddress is not specified.')
       }
 
-      const provider = config
-        .get()
-        .providers.find((provider) => provider.isAddress(fromAddress))
+      const provider = client.providers.find((provider: SDKProvider) =>
+        provider.isAddress(fromAddress)
+      )
 
       if (!provider) {
         throw new ProviderError(
@@ -125,7 +136,7 @@ const executeSteps = async (route: RouteExtended): Promise<RouteExtended> => {
         updateRouteExecution(route, execution.executionOptions)
       }
 
-      const executedStep = await stepExecutor.executeStep(step)
+      const executedStep = await stepExecutor.executeStep(client, step)
 
       // We may reach this point if user interaction isn't allowed. We want to stop execution until we resume it
       if (executedStep.execution?.status !== 'DONE') {

package/src/core/executionState.ts

@@ -1,4 +1,8 @@
-import type { ExecutionOptions, RouteExtended, StepExecutor } from './types.js'
+import type {
+  ExecutionOptions,
+  RouteExtended,
+  StepExecutor,
+} from '../types/core.js'
 
 interface ExecutionData {
   route: RouteExtended

package/src/core/prepareRestart.ts

@@ -1,4 +1,4 @@
-import type { RouteExtended } from './types.js'
+import type { RouteExtended } from '../types/core.js'
 
 export const prepareRestart = (route: RouteExtended) => {
   for (let index = 0; index < route.steps.length; index++) {

package/src/core/processMessages.ts

@@ -1,5 +1,5 @@
 import type { StatusMessage, Substatus } from '@lifi/types'
-import type { ProcessStatus, ProcessType } from './types.js'
+import type { ProcessStatus, ProcessType } from '../types/core.js'
 
 const processMessages: Record<
   ProcessType,

package/src/core/stepComparison.ts

@@ -1,8 +1,8 @@
 import type { LiFiStep } from '@lifi/types'
 import { LiFiErrorCode } from '../errors/constants.js'
 import { TransactionError } from '../errors/errors.js'
+import type { ExecutionOptions } from '../types/core.js'
 import type { StatusManager } from './StatusManager.js'
-import type { ExecutionOptions } from './types.js'
 import { checkStepSlippageThreshold } from './utils.js'
 
 /**

package/src/core/utils.ts

@@ -1,4 +1,5 @@
-import type { LiFiStep, Token } from '@lifi/types'
+import type { ChainId, ExtendedChain, LiFiStep, Token } from '@lifi/types'
+import type { RPCUrls } from '../types/core.js'
 
 // Standard threshold for destination amount difference (0.5%)
 const standardThreshold = 0.005
@@ -29,6 +30,34 @@ export function checkStepSlippageThreshold(
   return actualSlippage <= setSlippage
 }
 
+export function getRpcUrlsFromChains(
+  existingRpcUrls: RPCUrls,
+  chains: ExtendedChain[],
+  skipChains?: ChainId[]
+) {
+  const rpcUrlsFromChains = chains.reduce((rpcUrls, chain) => {
+    if (chain.metamask?.rpcUrls?.length) {
+      rpcUrls[chain.id as ChainId] = chain.metamask.rpcUrls
+    }
+    return rpcUrls
+  }, {} as RPCUrls)
+  const result = { ...existingRpcUrls }
+  for (const rpcUrlsKey in rpcUrlsFromChains) {
+    const chainId = Number(rpcUrlsKey) as ChainId
+    const urls = rpcUrlsFromChains[chainId]
+    if (!urls?.length) {
+      continue
+    }
+    if (!result[chainId]?.length) {
+      result[chainId] = Array.from(urls)
+    } else if (!skipChains?.includes(chainId)) {
+      const filteredUrls = urls.filter((url) => !result[chainId]?.includes(url))
+      result[chainId].push(...filteredUrls)
+    }
+  }
+  return result
+}
+
 /**
  * Checks whether a given token is eligible for message signing.
  * Tokens with '₮' symbol in their name are disallowed,

package/src/core/waitForDestinationChainTransaction.ts

@@ -4,12 +4,13 @@ import type {
   FullStatusData,
 } from '@lifi/types'
 import { LiFiErrorCode } from '../errors/constants.js'
+import type { LiFiStepExtended, Process, SDKClient } from '../types/core.js'
 import { getTransactionFailedMessage } from '../utils/getTransactionMessage.js'
 import type { StatusManager } from './StatusManager.js'
-import type { LiFiStepExtended, Process } from './types.js'
 import { waitForTransactionStatus } from './waitForTransactionStatus.js'
 
 export async function waitForDestinationChainTransaction(
+  client: SDKClient,
   step: LiFiStepExtended,
   process: Process,
   fromChain: ExtendedChain,
@@ -40,6 +41,7 @@ export async function waitForDestinationChainTransaction(
     }
 
     const statusResponse = (await waitForTransactionStatus(
+      client,
       statusManager,
       transactionHash,
       step,
@@ -84,6 +86,7 @@ export async function waitForDestinationChainTransaction(
     return step
   } catch (e: unknown) {
     const htmlMessage = await getTransactionFailedMessage(
+      client,
       step,
       `${toChain.metamask.blockExplorerUrls[0]}tx/${transactionHash}`
     )

package/src/core/waitForTransactionStatus.ts

@@ -1,14 +1,15 @@
 import type { FullStatusData, LiFiStep, StatusResponse } from '@lifi/types'
+import { getStatus } from '../actions/getStatus.js'
 import { ServerError } from '../errors/errors.js'
-import { getStatus } from '../services/api.js'
+import type { ProcessType, SDKClient } from '../types/core.js'
 import { waitForResult } from '../utils/waitForResult.js'
 import { getSubstatusMessage } from './processMessages.js'
 import type { StatusManager } from './StatusManager.js'
-import type { ProcessType } from './types.js'
 
 const TRANSACTION_HASH_OBSERVERS: Record<string, Promise<StatusResponse>> = {}
 
 export async function waitForTransactionStatus(
+  client: SDKClient,
   statusManager: StatusManager,
   txHash: string,
   step: LiFiStep,
@@ -16,7 +17,7 @@ export async function waitForTransactionStatus(
   interval = 5_000
 ): Promise<StatusResponse> {
   const _getStatus = (): Promise<StatusResponse | undefined> => {
-    return getStatus({
+    return getStatus(client, {
       fromChain: step.action.fromChainId,
       fromAddress: step.action.fromAddress,
       toChain: step.action.toChainId,

package/src/errors/SDKError.ts

@@ -1,5 +1,5 @@
 import type { LiFiStep } from '@lifi/types'
-import type { Process } from '../core/types.js'
+import type { Process } from '../types/core.js'
 import { version } from '../version.js'
 import type { BaseError } from './baseError.js'
 import type { ErrorCode } from './constants.js'

package/src/index.ts

@@ -1,35 +1,32 @@
 // biome-ignore lint/performance/noBarrelFile: module entrypoint
 // biome-ignore lint/performance/noReExportAll: types
 export * from '@lifi/types'
-export { config } from './config.js'
-export { checkPermitSupport } from './core/EVM/checkPermitSupport.js'
-export { EVM } from './core/EVM/EVM.js'
-export {
-  getTokenAllowance,
-  getTokenAllowanceMulticall,
-} from './core/EVM/getAllowance.js'
-export { isBatchingSupported } from './core/EVM/isBatchingSupported.js'
-export { getNativePermit } from './core/EVM/permits/getNativePermit.js'
-export {
-  revokeTokenApproval,
-  setAllowance,
-  setTokenAllowance,
-} from './core/EVM/setAllowance.js'
-export {
-  isGaslessStep,
-  isRelayerStep,
-} from './core/EVM/typeguards.js'
-export type {
-  EVMProvider,
-  EVMProviderOptions,
-  WalletCallReceipt,
-} from './core/EVM/types.js'
-export { isEVM } from './core/EVM/types.js'
-export {
-  convertExtendedChain,
-  isDelegationDesignatorCode,
-  isExtendedChain,
-} from './core/EVM/utils.js'
+export type { Client } from 'viem'
+export { formatUnits, isHex, parseUnits } from 'viem/utils'
+export { getChains, getChainsFromConfig } from './actions/getChains.js'
+export { getConnections } from './actions/getConnections.js'
+export { getContractCallsQuote } from './actions/getContractCallsQuote.js'
+export { getGasRecommendation } from './actions/getGasRecommendation.js'
+export { getNameServiceAddress } from './actions/getNameServiceAddress.js'
+export { getQuote } from './actions/getQuote.js'
+export { getRelayedTransactionStatus } from './actions/getRelayedTransactionStatus.js'
+export { getRelayerQuote } from './actions/getRelayerQuote.js'
+export { getRoutes } from './actions/getRoutes.js'
+export { getStatus } from './actions/getStatus.js'
+export { getStepTransaction } from './actions/getStepTransaction.js'
+export { getToken } from './actions/getToken.js'
+export { getTokenBalance } from './actions/getTokenBalance.js'
+export { getTokenBalances } from './actions/getTokenBalances.js'
+export { getTokenBalancesByChain } from './actions/getTokenBalancesByChain.js'
+export { getTokens } from './actions/getTokens.js'
+export { getTools } from './actions/getTools.js'
+export { getTransactionHistory } from './actions/getTransactionHistory.js'
+export { getWalletBalances } from './actions/getWalletBalances.js'
+export { actions } from './actions/index.js'
+export { relayTransaction } from './actions/relayTransaction.js'
+export { createClient } from './client/createClient.js'
+export { BaseStepExecutor } from './core/BaseStepExecutor.js'
+export { checkBalance } from './core/checkBalance.js'
 export {
   executeRoute,
   getActiveRoute,
@@ -38,21 +35,24 @@ export {
   stopRouteExecution,
   updateRouteExecution,
 } from './core/execution.js'
-export { isSVMAddress } from './core/Solana/isSVMAddress.js'
-export {
-  KeypairWalletAdapter,
-  KeypairWalletName,
-} from './core/Solana/KeypairWalletAdapter.js'
-export { Solana } from './core/Solana/Solana.js'
-export type {
-  SolanaProvider,
-  SolanaProviderOptions,
-} from './core/Solana/types.js'
-export { isSolana } from './core/Solana/types.js'
 export { StatusManager } from './core/StatusManager.js'
-export { Sui } from './core/Sui/Sui.js'
-export type { SuiProvider, SuiProviderOptions } from './core/Sui/types.js'
-export { isSui } from './core/Sui/types.js'
+export { stepComparison } from './core/stepComparison.js'
+export { isTokenMessageSigningAllowed } from './core/utils.js'
+export { waitForDestinationChainTransaction } from './core/waitForDestinationChainTransaction.js'
+export { BaseError } from './errors/baseError.js'
+export type { ErrorCode } from './errors/constants.js'
+export { ErrorMessage, ErrorName, LiFiErrorCode } 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'
 export type {
   AcceptExchangeRateUpdateHook,
   AcceptSlippageUpdateHook,
@@ -70,66 +70,24 @@ export type {
   RouteExecutionDataDictionary,
   RouteExecutionDictionary,
   RouteExtended,
+  RPCUrls,
+  SDKBaseConfig,
+  SDKClient,
+  SDKConfig,
   SDKProvider,
   StepExecutor,
   StepExecutorOptions,
   StepExtended,
   SwitchChainHook,
+  TransactionMethodType,
   TransactionParameters,
   TransactionRequestParameters,
   TransactionRequestUpdateHook,
   UpdateRouteHook,
-} from './core/types.js'
-export type { UTXOProvider, UTXOProviderOptions } from './core/UTXO/types.js'
-export { isUTXO } from './core/UTXO/types.js'
-export { UTXO } from './core/UTXO/UTXO.js'
-export { isTokenMessageSigningAllowed } from './core/utils.js'
-export { createConfig } from './createConfig.js'
-export { BaseError } from './errors/baseError.js'
-export type { ErrorCode } from './errors/constants.js'
-export { ErrorMessage, ErrorName, LiFiErrorCode } 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'
-export {
-  getChains,
-  getConnections,
-  getContractCallsQuote,
-  getGasRecommendation,
-  getQuote,
-  getRelayedTransactionStatus,
-  getRelayerQuote,
-  getRoutes,
-  getStatus,
-  getStepTransaction,
-  getToken,
-  getTokens,
-  getTools,
-  getTransactionHistory,
-  relayTransaction,
-} from './services/api.js'
-export {
-  getTokenBalance,
-  getTokenBalances,
-  getTokenBalancesByChain,
-  getWalletBalances,
-} from './services/balance.js'
-export { getNameServiceAddress } from './services/getNameServiceAddress.js'
-export type {
-  GetStatusRequestExtended,
-  QuoteRequest,
-  QuoteRequestFromAmount,
-  QuoteRequestToAmount,
-} from './services/types.js'
-export type { RPCUrls, SDKBaseConfig, SDKConfig } from './types/internal.js'
+} from './types/core.js'
 export { checkPackageUpdates } from './utils/checkPackageUpdates.js'
 export { convertQuoteToRoute } from './utils/convertQuoteToRoute.js'
 export { fetchTxErrorDetails } from './utils/fetchTxErrorDetails.js'
+export { sleep } from './utils/sleep.js'
+export { waitForResult } from './utils/waitForResult.js'
+export { withDedupe } from './utils/withDedupe.js'