@lifi/sdk 3.1.4 → 3.2.0-alpha.0

package/src/core/EVM/EVMStepExecutor.ts

@@ -3,22 +3,16 @@ import type {
   FullStatusData,
   Process,
 } from '@lifi/types'
-import type {
-  Hash,
-  PublicClient,
-  SendTransactionParameters,
-  WalletClient,
-} from 'viem'
-import { publicActions } from 'viem'
+import type { Client, Hash, SendTransactionParameters } from 'viem'
+import { getAddresses, sendTransaction } from 'viem/actions'
 import { config } from '../../config.js'
+import { LiFiErrorCode } from '../../errors/constants.js'
+import { TransactionError, ValidationError } from '../../errors/errors.js'
 import { getStepTransaction } from '../../services/api.js'
 import {
   getTransactionFailedMessage,
   isZeroAddress,
 } from '../../utils/index.js'
-import { ValidationError, TransactionError } from '../../errors/errors.js'
-import { LiFiErrorCode } from '../../errors/constants.js'
-import { parseEVMErrors } from './parseEVMErrors.js'
 import { BaseStepExecutor } from '../BaseStepExecutor.js'
 import { checkBalance } from '../checkBalance.js'
 import { getSubstatusMessage } from '../processMessages.js'
@@ -31,44 +25,50 @@ import type {
 import { waitForReceivingTransaction } from '../waitForReceivingTransaction.js'
 import { checkAllowance } from './checkAllowance.js'
 import { updateMultisigRouteProcess } from './multisig.js'
+import { parseEVMErrors } from './parseEVMErrors.js'
 import { switchChain } from './switchChain.js'
 import type { MultisigConfig, MultisigTransaction } from './types.js'
 import { getMaxPriorityFeePerGas } from './utils.js'
 import { waitForTransactionReceipt } from './waitForTransactionReceipt.js'
 
 export interface EVMStepExecutorOptions extends StepExecutorOptions {
-  walletClient: WalletClient
+  client: Client
   multisig?: MultisigConfig
 }
 
 export class EVMStepExecutor extends BaseStepExecutor {
-  private walletClient: WalletClient
+  private client: Client
   private multisig?: MultisigConfig
 
   constructor(options: EVMStepExecutorOptions) {
     super(options)
-    this.walletClient = options.walletClient
+    this.client = options.client
     this.multisig = options.multisig
   }
 
   // Ensure that we are using the right chain and wallet when executing transactions.
-  checkWalletClient = async (
+  checkClient = async (
     step: LiFiStepExtended,
     process?: Process
-  ): Promise<WalletClient | undefined> => {
-    const updatedWalletClient = await switchChain(
-      this.walletClient,
+  ): Promise<Client | undefined> => {
+    const updatedClient = await switchChain(
+      this.client,
       this.statusManager,
       step,
       this.allowUserInteraction,
       this.executionOptions?.switchChainHook
     )
-    if (updatedWalletClient) {
-      this.walletClient = updatedWalletClient
+    if (updatedClient) {
+      this.client = updatedClient
     }
 
     // Prevent execution of the quote by wallet different from the one which requested the quote
-    if (this.walletClient.account?.address !== step.action.fromAddress) {
+    let accountAddress = this.client.account?.address
+    if (!accountAddress) {
+      const accountAddresses = await getAddresses(this.client)
+      accountAddress = accountAddresses?.[0]
+    }
+    if (accountAddress !== step.action.fromAddress) {
       let processToUpdate = process
       if (!processToUpdate) {
         // We need to create some process if we don't have one so we can show the error
@@ -95,7 +95,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
         process
       )
     }
-    return updatedWalletClient
+    return updatedClient
   }
 
   executeStep = async (step: LiFiStepExtended): Promise<LiFiStepExtended> => {
@@ -111,13 +111,13 @@ export class EVMStepExecutor extends BaseStepExecutor {
     // All changes are already done from the source chain
     // Return the step
     if (recievingChainProcess?.substatus !== 'WAIT_DESTINATION_TRANSACTION') {
-      const updatedWalletClient = await this.checkWalletClient(step)
-      if (!updatedWalletClient) {
+      const updatedClient = await this.checkClient(step)
+      if (!updatedClient) {
         return step
       }
     }
 
-    const isMultisigWalletClient = !!this.multisig?.isMultisigWalletClient
+    const isMultisigClient = !!this.multisig?.isMultisigClient
     const multisigBatchTransactions: MultisigTransaction[] = []
 
     const shouldBatchTransactions =
@@ -139,13 +139,13 @@ export class EVMStepExecutor extends BaseStepExecutor {
     const checkForAllowance =
       !existingProcess?.txHash &&
       !isZeroAddress(step.action.fromToken.address) &&
-      (shouldBatchTransactions || !isMultisigWalletClient)
+      (shouldBatchTransactions || !isMultisigClient)
 
     if (checkForAllowance) {
       const data = await checkAllowance(
+        this.client,
         fromChain,
         step,
-        this.walletClient,
         this.statusManager,
         this.executionOptions,
         this.allowUserInteraction,
@@ -175,7 +175,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
       )
 
       try {
-        if (isMultisigWalletClient && multisigProcess) {
+        if (isMultisigClient && multisigProcess) {
           const multisigTxHash = multisigProcess.multisigTxHash as Hash
           if (!multisigTxHash) {
             throw new ValidationError(
@@ -195,11 +195,8 @@ export class EVMStepExecutor extends BaseStepExecutor {
         let txHash: Hash
         if (process.txHash) {
           // Make sure that the chain is still correct
-          const updatedWalletClient = await this.checkWalletClient(
-            step,
-            process
-          )
-          if (!updatedWalletClient) {
+          const updatedClient = await this.checkClient(step, process)
+          if (!updatedClient) {
             return step
           }
 
@@ -213,7 +210,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
           )
 
           // Check balance
-          await checkBalance(this.walletClient.account!.address, step)
+          await checkBalance(this.client.account!.address, step)
 
           // Create new transaction
           if (!step.transactionRequest) {
@@ -241,11 +238,8 @@ export class EVMStepExecutor extends BaseStepExecutor {
 
           // STEP 3: Send the transaction
           // Make sure that the chain is still correct
-          const updatedWalletClient = await this.checkWalletClient(
-            step,
-            process
-          )
-          if (!updatedWalletClient) {
+          const updatedClient = await this.checkClient(step, process)
+          if (!updatedClient) {
             return step
           }
 
@@ -276,10 +270,8 @@ export class EVMStepExecutor extends BaseStepExecutor {
             //   ? BigInt(step.transactionRequest.maxFeePerGas as string)
             //   : undefined,
             maxPriorityFeePerGas:
-              this.walletClient.account?.type === 'local'
-                ? await getMaxPriorityFeePerGas(
-                    this.walletClient.extend(publicActions) as PublicClient
-                  )
+              this.client.account?.type === 'local'
+                ? await getMaxPriorityFeePerGas(this.client)
                 : step.transactionRequest.maxPriorityFeePerGas
                   ? BigInt(step.transactionRequest.maxPriorityFeePerGas)
                   : undefined,
@@ -317,9 +309,9 @@ export class EVMStepExecutor extends BaseStepExecutor {
               )
             }
           } else {
-            txHash = await this.walletClient.sendTransaction({
+            txHash = await sendTransaction(this.client, {
               to: transactionRequest.to,
-              account: this.walletClient.account!,
+              account: this.client.account!,
               data: transactionRequest.data,
               value: transactionRequest.value,
               gas: transactionRequest.gas,
@@ -331,7 +323,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
           }
 
           // STEP 4: Wait for the transaction
-          if (isMultisigWalletClient) {
+          if (isMultisigClient) {
             process = this.statusManager.updateProcess(
               step,
               process.type,
@@ -354,7 +346,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
         }
 
         const transactionReceipt = await waitForTransactionReceipt({
-          walletClient: this.walletClient,
+          client: this.client,
           chainId: fromChain.id,
           txHash,
           onReplaced: (response) => {
@@ -367,7 +359,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
 
         // if it's multisig wallet client and the process is in ACTION_REQUIRED
         // then signatures are still needed
-        if (isMultisigWalletClient && process.status === 'ACTION_REQUIRED') {
+        if (isMultisigClient && process.status === 'ACTION_REQUIRED') {
           await updateMultisigRouteProcess(
             transactionReceipt?.transactionHash || txHash,
             step,
@@ -381,7 +373,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
         // Update pending process if the transaction hash from the receipt is different.
         // This might happen if the transaction was replaced.
         if (
-          !isMultisigWalletClient &&
+          !isMultisigClient &&
           transactionReceipt?.transactionHash &&
           transactionReceipt.transactionHash !== txHash
         ) {

package/src/core/EVM/checkAllowance.ts

@@ -1,5 +1,5 @@
 import type { Chain, LiFiStep, Process, ProcessType } from '@lifi/types'
-import type { Address, Hash, WalletClient } from 'viem'
+import type { Address, Client, Hash } from 'viem'
 import type { StatusManager } from '../StatusManager.js'
 import type { ExecutionOptions } from '../types.js'
 import { getAllowance } from './getAllowance.js'
@@ -8,9 +8,9 @@ import { setAllowance } from './setAllowance.js'
 import { waitForTransactionReceipt } from './waitForTransactionReceipt.js'
 
 export const checkAllowance = async (
+  client: Client,
   chain: Chain,
   step: LiFiStep,
-  walletClient: WalletClient,
   statusManager: StatusManager,
   settings?: ExecutionOptions,
   allowUserInteraction = false,
@@ -26,7 +26,7 @@ export const checkAllowance = async (
   try {
     if (allowanceProcess.txHash && allowanceProcess.status !== 'DONE') {
       await waitForApprovalTransaction(
-        walletClient,
+        client,
         allowanceProcess.txHash! as Address,
         allowanceProcess.type,
         step,
@@ -43,7 +43,7 @@ export const checkAllowance = async (
       const approved = await getAllowance(
         chain.id,
         step.action.fromToken.address,
-        walletClient.account!.address,
+        client.account!.address,
         step.estimate.approvalAddress
       )
 
@@ -56,7 +56,7 @@ export const checkAllowance = async (
 
         if (shouldBatchTransactions) {
           const approveTxHash = await setAllowance(
-            walletClient,
+            client,
             step.action.fromToken.address,
             step.estimate.approvalAddress,
             fromAmount,
@@ -74,13 +74,13 @@ export const checkAllowance = async (
         }
 
         const approveTxHash = await setAllowance(
-          walletClient,
+          client,
           step.action.fromToken.address,
           step.estimate.approvalAddress,
           fromAmount
         )
         await waitForApprovalTransaction(
-          walletClient,
+          client,
           approveTxHash,
           allowanceProcess.type,
           step,
@@ -114,7 +114,7 @@ export const checkAllowance = async (
 }
 
 const waitForApprovalTransaction = async (
-  walletClient: WalletClient,
+  client: Client,
   txHash: Hash,
   processType: ProcessType,
   step: LiFiStep,
@@ -127,7 +127,7 @@ const waitForApprovalTransaction = async (
   })
 
   const transactionReceipt = await waitForTransactionReceipt({
-    walletClient,
+    client: client,
     chainId: chain.id,
     txHash: txHash,
     onReplaced(response) {

package/src/core/EVM/getAllowance.ts

@@ -1,6 +1,7 @@
 import type { BaseToken, ChainId } from '@lifi/types'
 import type { Address } from 'viem'
 import { getContract } from 'viem'
+import { multicall } from 'viem/actions'
 import { isNativeTokenAddress } from '../../utils/utils.js'
 import { allowanceAbi } from './abi.js'
 import { getPublicClient } from './publicClient.js'
@@ -57,7 +58,7 @@ export const getAllowanceMulticall = async (
     args: [ownerAddress, token.spenderAddress],
   }))
 
-  const results = await client.multicall({
+  const results = await multicall(client, {
     contracts,
     multicallAddress: multicallAddress as Address,
   })

package/src/core/EVM/getENSAddress.ts

@@ -1,5 +1,5 @@
 import { ChainId } from '@lifi/types'
-import { normalize } from 'viem/ens'
+import { getEnsAddress, normalize } from 'viem/ens'
 import { getPublicClient } from './publicClient.js'
 
 export const getENSAddress = async (
@@ -7,7 +7,7 @@ export const getENSAddress = async (
 ): Promise<string | undefined> => {
   try {
     const client = await getPublicClient(ChainId.ETH)
-    const address = await client.getEnsAddress({
+    const address = await getEnsAddress(client, {
       name: normalize(name),
     })
     return address as string | undefined

package/src/core/EVM/getEVMBalance.ts

@@ -1,5 +1,11 @@
 import type { ChainId, Token, TokenAmount } from '@lifi/types'
 import type { Address } from 'viem'
+import {
+  getBalance,
+  getBlockNumber,
+  multicall,
+  readContract,
+} from 'viem/actions'
 import { isZeroAddress } from '../../utils/utils.js'
 import { balanceOfAbi, getEthBalanceAbi } from './abi.js'
 import { getPublicClient } from './publicClient.js'
@@ -57,8 +63,8 @@ const getEVMBalanceMulticall = async (
       args: [walletAddress],
     }
   })
-  const blockNumber = await client.getBlockNumber()
-  const results = await client.multicall({
+  const blockNumber = await getBlockNumber(client)
+  const results = await multicall(client, {
     contracts,
     multicallAddress: multicallAddress as Address,
     blockNumber,
@@ -83,14 +89,14 @@ const getEVMBalanceDefault = async (
   walletAddress: string
 ): Promise<TokenAmount[]> => {
   const client = await getPublicClient(chainId)
-  const blockNumber = await client.getBlockNumber()
+  const blockNumber = await getBlockNumber(client)
   const queue: Promise<bigint>[] = tokens.map((token) => {
     if (isZeroAddress(token.address)) {
-      return client.getBalance({
+      return getBalance(client, {
         address: walletAddress as Address,
       })
     }
-    return client.readContract({
+    return readContract(client, {
       address: token.address as Address,
       abi: balanceOfAbi,
       functionName: 'balanceOf',

package/src/core/EVM/publicClient.ts

@@ -1,21 +1,19 @@
 import { ChainId } from '@lifi/types'
-import type { PublicClient } from 'viem'
-import { createPublicClient, fallback, http, webSocket } from 'viem'
+import type { Client } from 'viem'
+import { createClient, fallback, http, webSocket } from 'viem'
 import { mainnet, type Chain } from 'viem/chains'
 import { config } from '../../config.js'
 import { getRpcUrls } from '../rpc.js'
 
 // cached providers
-const publicClients: Record<number, PublicClient> = {}
+const publicClients: Record<number, Client> = {}
 
 /**
  * Get an instance of a provider for a specific chain
  * @param chainId - Id of the chain the provider is for
  * @returns The public client for the given chain
  */
-export const getPublicClient = async (
-  chainId: number
-): Promise<PublicClient> => {
+export const getPublicClient = async (chainId: number): Promise<Client> => {
   if (!publicClients[chainId]) {
     const urls = await getRpcUrls(chainId)
     const fallbackTransports = urls.map((url) =>
@@ -44,7 +42,7 @@ export const getPublicClient = async (
         ...chain.contracts,
       }
     }
-    publicClients[chainId] = createPublicClient({
+    publicClients[chainId] = createClient({
       chain: chain,
       transport: fallback(fallbackTransports),
       batch: {

package/src/core/EVM/setAllowance.ts

@@ -1,10 +1,6 @@
-import type {
-  Hash,
-  PublicClient,
-  SendTransactionParameters,
-  WalletClient,
-} from 'viem'
-import { encodeFunctionData, publicActions } from 'viem'
+import type { Client, Hash, SendTransactionParameters } from 'viem'
+import { encodeFunctionData } from 'viem'
+import { sendTransaction } from 'viem/actions'
 import { isNativeTokenAddress } from '../../utils/utils.js'
 import type { ExecutionOptions, TransactionParameters } from '../types.js'
 import { approveAbi } from './abi.js'
@@ -13,7 +9,7 @@ import type { ApproveTokenRequest, RevokeApprovalRequest } from './types.js'
 import { getMaxPriorityFeePerGas } from './utils.js'
 
 export const setAllowance = async (
-  walletClient: WalletClient,
+  client: Client,
   tokenAddress: string,
   contractAddress: string,
   amount: bigint,
@@ -29,14 +25,13 @@ export const setAllowance = async (
   if (returnPopulatedTransaction) {
     return data
   }
-  const client = walletClient.extend(publicActions)
 
   let transactionRequest: TransactionParameters = {
     to: tokenAddress,
     data,
     maxPriorityFeePerGas:
-      walletClient.account?.type === 'local'
-        ? await getMaxPriorityFeePerGas(client as PublicClient)
+      client.account?.type === 'local'
+        ? await getMaxPriorityFeePerGas(client)
         : undefined,
   }
 
@@ -53,9 +48,9 @@ export const setAllowance = async (
     }
   }
 
-  return client.sendTransaction({
+  return sendTransaction(client, {
     to: transactionRequest.to,
-    account: walletClient.account!,
+    account: client.account!,
     data: transactionRequest.data,
     gas: transactionRequest.gas,
     gasPrice: transactionRequest.gasPrice,

package/src/core/EVM/switchChain.ts

@@ -1,4 +1,5 @@
-import type { WalletClient } from 'viem'
+import type { Client } from 'viem'
+import { getChainId } from 'viem/actions'
 import { LiFiErrorCode } from '../../errors/constants.js'
 import { ProviderError } from '../../errors/errors.js'
 import type { StatusManager } from '../StatusManager.js'
@@ -10,28 +11,28 @@ import type { LiFiStepExtended, SwitchChainHook } from '../types.js'
  * If no and if user interaction is allowed it triggers the switchChainHook. If no user interaction is allowed it aborts.
  *
  * Account Type: local -
- * We need to create and return a new WalletClient from the switchChainHook in order to continue execution on a new chain.
+ * We need to create and return a new connector client from the switchChainHook in order to continue execution on a new chain.
  *
  * Account Type: json-rpc -
- * We can switch chain and return existing WalletClient from the switchChainHook in order to continue execution on a new chain.
- * @param walletClient
+ * We can switch chain and return existing connector client from the switchChainHook in order to continue execution on a new chain.
+ * @param client
  * @param statusManager
  * @param step
  * @param switchChainHook
  * @param allowUserInteraction
- * @returns New WalletClient
+ * @returns New connector client
  */
 export const switchChain = async (
-  walletClient: WalletClient,
+  client: Client,
   statusManager: StatusManager,
   step: LiFiStepExtended,
   allowUserInteraction: boolean,
   switchChainHook?: SwitchChainHook
-): Promise<WalletClient | undefined> => {
+): Promise<Client | undefined> => {
   // if we are already on the correct chain we can proceed directly
-  const currentChainId = await walletClient.getChainId()
+  const currentChainId = await getChainId(client)
   if (currentChainId === step.action.fromChainId) {
-    return walletClient
+    return client
   }
 
   // -> set status message
@@ -49,8 +50,11 @@ export const switchChain = async (
   }
 
   try {
-    const updatedWalletClient = await switchChainHook?.(step.action.fromChainId)
-    const updatedChainId = await updatedWalletClient?.getChainId()
+    const updatedClient = await switchChainHook?.(step.action.fromChainId)
+    let updatedChainId
+    if (updatedClient) {
+      updatedChainId = await getChainId(updatedClient)
+    }
     if (updatedChainId !== step.action.fromChainId) {
       throw new ProviderError(
         LiFiErrorCode.ChainSwitchError,
@@ -64,7 +68,7 @@ export const switchChain = async (
       'DONE'
     )
     statusManager.updateExecution(step, 'PENDING')
-    return updatedWalletClient
+    return updatedClient
   } catch (error: any) {
     statusManager.updateProcess(step, switchProcess.type, 'FAILED', {
       error: {

package/src/core/EVM/types.ts

@@ -1,10 +1,10 @@
 import { ChainType, type BaseToken } from '@lifi/types'
-import type { Hash, WalletClient } from 'viem'
+import type { Client, Hash } from 'viem'
 import type { SwitchChainHook } from '../types.js'
 import { type SDKProvider } from '../types.js'
 
 export interface EVMProviderOptions {
-  getWalletClient?: () => Promise<WalletClient>
+  getWalletClient?: () => Promise<Client>
   switchChain?: SwitchChainHook
   multisig?: MultisigConfig
 }
@@ -35,7 +35,7 @@ export type TokenSpenderAllowance = {
 }
 
 export interface ApproveTokenRequest {
-  walletClient: WalletClient
+  walletClient: Client
   token: BaseToken
   spenderAddress: string
   amount: bigint
@@ -46,7 +46,7 @@ export interface ApproveTokenRequest {
 }
 
 export interface RevokeApprovalRequest {
-  walletClient: WalletClient
+  walletClient: Client
   token: BaseToken
   spenderAddress: string
 }
@@ -63,7 +63,7 @@ export interface MultisigTransaction {
 }
 
 export interface MultisigConfig {
-  isMultisigWalletClient: boolean
+  isMultisigClient: boolean
   getMultisigTransactionDetails: (
     txHash: Hash,
     fromChainId: number,

package/src/core/EVM/utils.ts

@@ -1,12 +1,13 @@
 import { type ChainId } from '@lifi/types'
-import type { PublicClient, Transaction } from 'viem'
+import type { Client, Transaction } from 'viem'
+import { getBlock } from 'viem/actions'
 import { config } from '../../config.js'
 import { median } from '../../utils/median.js'
 
 export const getMaxPriorityFeePerGas = async (
-  client: PublicClient
+  client: Client
 ): Promise<bigint | undefined> => {
-  const block = await client.getBlock({
+  const block = await getBlock(client, {
     includeTransactions: true,
   })
 

package/src/core/EVM/waitForTransactionReceipt.ts

@@ -1,33 +1,32 @@
 import type { ChainId } from '@lifi/types'
 import type {
   Chain,
+  Client,
   Hash,
-  PublicClient,
   ReplacementReason,
   ReplacementReturnType,
   TransactionReceipt,
-  WalletClient,
 } from 'viem'
-import { publicActions } from 'viem'
+import { waitForTransactionReceipt as waitForTransactionReceiptInternal } from 'viem/actions'
 import { LiFiErrorCode, TransactionError } from '../../utils/index.js'
 import { getPublicClient } from './publicClient.js'
 import { retryCount, retryDelay } from './utils.js'
 
 interface WaitForTransactionReceiptProps {
-  walletClient: WalletClient
+  client: Client
   chainId: ChainId
   txHash: Hash
   onReplaced?: (response: ReplacementReturnType<Chain | undefined>) => void
 }
 
 export async function waitForTransactionReceipt({
-  walletClient,
+  client,
   chainId,
   txHash,
   onReplaced,
 }: WaitForTransactionReceiptProps): Promise<TransactionReceipt | undefined> {
   let { transactionReceipt, replacementReason } = await waitForReceipt(
-    walletClient.extend(publicActions),
+    client,
     txHash,
     onReplaced
   )
@@ -56,7 +55,7 @@ export async function waitForTransactionReceipt({
 }
 
 async function waitForReceipt(
-  client: PublicClient | WalletClient,
+  client: Client,
   txHash: Hash,
   onReplaced?: (response: ReplacementReturnType<Chain | undefined>) => void
 ): Promise<{
@@ -67,9 +66,7 @@ async function waitForReceipt(
   let transactionReceipt: TransactionReceipt | undefined
 
   try {
-    transactionReceipt = await (
-      client as PublicClient
-    ).waitForTransactionReceipt({
+    transactionReceipt = await waitForTransactionReceiptInternal(client, {
       hash: txHash,
       onReplaced: (response) => {
         replacementReason = response.reason

package/src/core/types.ts

@@ -7,7 +7,7 @@ import type {
   Token,
   TokenAmount,
 } from '@lifi/types'
-import type { WalletClient } from 'viem'
+import type { Client } from 'viem'
 
 export interface SDKProvider {
   readonly type: ChainType
@@ -82,9 +82,7 @@ export type TransactionRequestUpdateHook = (
   updatedTxRequest: TransactionRequestParameters
 ) => Promise<TransactionParameters>
 
-export type SwitchChainHook = (
-  chainId: number
-) => Promise<WalletClient | undefined>
+export type SwitchChainHook = (chainId: number) => Promise<Client | undefined>
 
 export interface AcceptSlippageUpdateHookParams {
   toToken: Token