@lifi/sdk 3.6.0 → 3.6.2-beta.0

package/src/core/EVM/EVMStepExecutor.ts

@@ -1,4 +1,4 @@
-import type { ExtendedChain, LiFiStep, SignedPermit } from '@lifi/types'
+import type { ExtendedChain, LiFiStep, SignedTypedData } from '@lifi/types'
 import type {
   Address,
   Client,
@@ -8,7 +8,12 @@ import type {
   SendTransactionParameters,
   TransactionReceipt,
 } from 'viem'
-import { estimateGas, getAddresses, sendTransaction } from 'viem/actions'
+import {
+  estimateGas,
+  getAddresses,
+  sendTransaction,
+  signTypedData,
+} from 'viem/actions'
 import { sendCalls } from 'viem/experimental'
 import { getAction } from 'viem/utils'
 import { config } from '../../config.js'
@@ -35,11 +40,9 @@ import { parseEVMErrors } from './parseEVMErrors.js'
 import { encodeNativePermitData } from './permits/encodeNativePermitData.js'
 import { encodePermit2Data } from './permits/encodePermit2Data.js'
 import { signPermit2Message } from './permits/signPermit2Message.js'
-import type { NativePermitSignature } from './permits/types.js'
-import { prettifyPermit2Data } from './permits/utils.js'
 import { switchChain } from './switchChain.js'
 import { isRelayerStep } from './typeguards.js'
-import type { Call, EVMPermitStep, TransactionMethodType } from './types.js'
+import type { Call, TransactionMethodType } from './types.js'
 import { convertExtendedChain, getMaxPriorityFeePerGas } from './utils.js'
 import {
   type WalletCallReceipt,
@@ -244,7 +247,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
       // Token is not native (address is not zero)
       !isFromNativeToken
 
-    let nativePermitSignature: NativePermitSignature | undefined
+    let signedNativePermitTypedData: SignedTypedData | undefined
     if (checkForAllowance) {
       // Check if token needs approval and get approval transaction or message data when available
       const allowanceResult = await checkAllowance({
@@ -266,7 +269,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
         }
       }
       if (allowanceResult.status === 'NATIVE_PERMIT') {
-        nativePermitSignature = allowanceResult.data
+        signedNativePermitTypedData = allowanceResult.data
       }
       if (
         allowanceResult.status === 'ACTION_REQUIRED' &&
@@ -316,7 +319,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
       }
 
       const permitRequired =
-        !batchingSupported && !nativePermitSignature && permit2Supported
+        !batchingSupported && !signedNativePermitTypedData && permit2Supported
       process = this.statusManager.findOrCreateProcess({
         step,
         type: permitRequired ? 'PERMIT' : currentProcessType,
@@ -330,7 +333,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
       // Create new transaction request
       if (!step.transactionRequest) {
         const { execution, ...stepBase } = step
-        let updatedStep: LiFiStep | EVMPermitStep
+        let updatedStep: LiFiStep
         if (isRelayerTransaction) {
           const updatedRelayedStep = await getRelayerQuote({
             fromChain: stepBase.action.fromChainId,
@@ -344,8 +347,7 @@ export class EVMStepExecutor extends BaseStepExecutor {
             allowBridges: [stepBase.tool],
           })
           updatedStep = {
-            ...updatedRelayedStep.quote,
-            permits: updatedRelayedStep.permits,
+            ...updatedRelayedStep,
             id: stepBase.id,
           }
         } else {
@@ -447,8 +449,8 @@ export class EVMStepExecutor extends BaseStepExecutor {
         })) as Address
         txType = 'batched'
       } else if (isRelayerTransaction) {
-        const permitWitnessTransferFromData = step.permits.find(
-          (p) => p.permitType === 'PermitWitnessTransferFrom'
+        const permitWitnessTransferFromData = step.typedData.find(
+          (p) => p.primaryType === 'PermitWitnessTransferFrom'
         )
 
         if (!permitWitnessTransferFromData) {
@@ -458,16 +460,16 @@ export class EVMStepExecutor extends BaseStepExecutor {
           )
         }
 
-        const permit2Signature = await signPermit2Message({
-          client: this.client,
-          chain: fromChain,
-          tokenAddress: step.action.fromToken.address as Address,
-          amount: BigInt(step.action.fromAmount),
-          data: transactionRequest.data as Hex,
-          permitData: prettifyPermit2Data(
-            permitWitnessTransferFromData.permitData
-          ),
-          witness: true,
+        const signature = await getAction(
+          this.client,
+          signTypedData,
+          'signTypedData'
+        )({
+          account: this.client.account!,
+          primaryType: permitWitnessTransferFromData.primaryType,
+          domain: permitWitnessTransferFromData.domain,
+          types: permitWitnessTransferFromData.types,
+          message: permitWitnessTransferFromData.message,
         })
 
         this.statusManager.updateProcess(step, process.type, 'DONE')
@@ -479,37 +481,30 @@ export class EVMStepExecutor extends BaseStepExecutor {
           chainId: fromChain.id,
         })
 
-        const signedPermits: SignedPermit[] = [
+        const signedTypedData: SignedTypedData[] = [
           {
-            permitType: 'PermitWitnessTransferFrom',
-            permit: permit2Signature.values,
-            signature: permit2Signature.signature,
+            ...permitWitnessTransferFromData,
+            signature: signature,
           },
         ]
         // Add native permit if available as first element, order is important
-        if (nativePermitSignature) {
-          signedPermits.unshift({
-            permitType: 'Permit',
-            permit: nativePermitSignature.values,
-            signature: nativePermitSignature.signature,
-          })
+        if (signedNativePermitTypedData) {
+          signedTypedData.unshift(signedNativePermitTypedData)
         }
-
+        const { execution, ...stepBase } = step
         const relayedTransaction = await relayTransaction({
-          tokenOwner: this.client.account!.address,
-          chainId: fromChain.id,
-          permits: signedPermits,
-          callData: transactionRequest.data! as Hex,
+          ...stepBase,
+          typedData: signedTypedData,
         })
         txHash = relayedTransaction.taskId as Hash
         txType = 'relayed'
       } else {
-        if (nativePermitSignature) {
+        if (signedNativePermitTypedData) {
           transactionRequest.data = encodeNativePermitData(
             step.action.fromToken.address as Address,
             BigInt(step.action.fromAmount),
-            nativePermitSignature.values.deadline,
-            nativePermitSignature.signature,
+            signedNativePermitTypedData.message.deadline,
+            signedNativePermitTypedData.signature,
             transactionRequest.data as Hex
           )
         } else if (permit2Supported) {
@@ -531,14 +526,14 @@ export class EVMStepExecutor extends BaseStepExecutor {
           transactionRequest.data = encodePermit2Data(
             step.action.fromToken.address as Address,
             BigInt(step.action.fromAmount),
-            permit2Signature.values.nonce,
-            permit2Signature.values.deadline,
+            permit2Signature.message.nonce,
+            permit2Signature.message.deadline,
             transactionRequest.data as Hex,
             permit2Signature.signature
           )
         }
 
-        if (nativePermitSignature || permit2Supported) {
+        if (signedNativePermitTypedData || permit2Supported) {
           try {
             // Target address should be the Permit2 proxy contract in case of native permit or Permit2
             transactionRequest.to = fromChain.permit2Proxy

package/src/core/EVM/checkAllowance.ts

@@ -1,17 +1,14 @@
-import type { ExtendedChain, LiFiStep } from '@lifi/types'
+import type { ExtendedChain, LiFiStep, SignedTypedData } from '@lifi/types'
 import type { Address, Client, Hash } from 'viem'
+import { signTypedData } from 'viem/actions'
+import { getAction } from 'viem/utils'
 import { MaxUint256 } from '../../constants.js'
 import type { StatusManager } from '../StatusManager.js'
 import type { ExecutionOptions, Process, ProcessType } from '../types.js'
 import { getAllowance } from './getAllowance.js'
 import { parseEVMErrors } from './parseEVMErrors.js'
 import { getNativePermit } from './permits/getNativePermit.js'
-import { signNativePermitMessage } from './permits/signNativePermitMessage.js'
-import type {
-  NativePermitData,
-  NativePermitSignature,
-} from './permits/types.js'
-import { prettifyNativePermitData } from './permits/utils.js'
+import type { NativePermitData } from './permits/types.js'
 import { setAllowance } from './setAllowance.js'
 import { isRelayerStep } from './typeguards.js'
 import type { Call } from './types.js'
@@ -38,7 +35,7 @@ export type AllowanceResult =
     }
   | {
       status: 'NATIVE_PERMIT'
-      data: NativePermitSignature
+      data: SignedTypedData
     }
 
 export const checkAllowance = async ({
@@ -78,6 +75,7 @@ export const checkAllowance = async ({
     const spenderAddress = permit2Supported
       ? chain.permit2
       : step.estimate.approvalAddress
+
     const fromAmount = BigInt(step.action.fromAmount)
 
     const approved = await getAllowance(
@@ -97,17 +95,15 @@ export const checkAllowance = async ({
 
     let nativePermitData: NativePermitData | undefined
     if (isRelayerTransaction) {
-      const permitData = step.permits.find(
-        (p) => p.permitType === 'Permit'
-      )?.permitData
-      if (permitData) {
-        nativePermitData = prettifyNativePermitData(permitData)
-      }
+      nativePermitData = step.typedData.find(
+        (p) => p.primaryType === 'Permit'
+      ) as NativePermitData
     } else {
       nativePermitData = await getNativePermit(
         client,
-        chain,
+        chain.id,
         step.action.fromToken.address as Address,
+        chain.permit2Proxy as Address,
         fromAmount
       )
     }
@@ -123,12 +119,25 @@ export const checkAllowance = async ({
       !!nativePermitData && !!chain.permit2Proxy && !batchingSupported
 
     if (nativePermitSupported && nativePermitData) {
-      const nativePermitSignature = await signNativePermitMessage(
+      const signature = await getAction(
         client,
-        nativePermitData
-      )
+        signTypedData,
+        'signTypedData'
+      )({
+        account: client.account!,
+        domain: nativePermitData.domain,
+        types: nativePermitData.types,
+        primaryType: 'Permit',
+        message: nativePermitData.message,
+      })
       statusManager.updateProcess(step, allowanceProcess.type, 'DONE')
-      return { status: 'NATIVE_PERMIT', data: nativePermitSignature }
+      return {
+        status: 'NATIVE_PERMIT',
+        data: {
+          ...nativePermitData,
+          signature,
+        },
+      }
     }
 
     // Set new allowance

package/src/core/EVM/checkPermitSupport.ts

@@ -49,10 +49,22 @@ export const checkPermitSupport = async ({
   let nativePermit: NativePermitData | undefined
   // Try with wallet client first, fallback to public client
   try {
-    nativePermit = await getNativePermit(client, chain, tokenAddress, amount)
+    nativePermit = await getNativePermit(
+      client,
+      chain.id,
+      tokenAddress,
+      chain.permit2Proxy as Address,
+      amount
+    )
   } catch {
     client = await getPublicClient(chain.id)
-    nativePermit = await getNativePermit(client, chain, tokenAddress, amount)
+    nativePermit = await getNativePermit(
+      client,
+      chain.id,
+      tokenAddress,
+      chain.permit2Proxy as Address,
+      amount
+    )
   }
 
   let permit2Allowance: bigint | undefined

package/src/core/EVM/permits/allowanceTransfer.ts

@@ -35,13 +35,13 @@ export interface PermitBatch {
 export type PermitSingleData = {
   domain: TypedDataDomain
   types: TypedData
-  values: PermitSingle
+  message: PermitSingle
 }
 
 export type PermitBatchData = {
   domain: TypedDataDomain
   types: TypedData
-  values: PermitBatch
+  message: PermitBatch
 }
 
 const PERMIT_DETAILS = [
@@ -85,7 +85,7 @@ export function getPermitSingleData(
 
   return {
     domain,
-    values: permit,
+    message: permit,
   }
 }
 
@@ -101,7 +101,7 @@ export function getPermitBatchData(
 
   return {
     domain,
-    values: permit,
+    message: permit,
   }
 }
 
@@ -118,14 +118,14 @@ export function getPermitData(
     return {
       domain,
       types: PERMIT_TYPES,
-      values: permit,
+      message: permit,
     }
   }
   permit.details.forEach(validatePermitDetails)
   return {
     domain,
     types: PERMIT_BATCH_TYPES,
-    values: permit,
+    message: permit,
   }
 }
 
@@ -135,7 +135,7 @@ export function hash(
   chainId: number
 ): string {
   if (isPermit(permit)) {
-    const { domain, values } = getPermitSingleData(
+    const { domain, message } = getPermitSingleData(
       permit,
       permit2Address,
       chainId
@@ -145,16 +145,20 @@ export function hash(
       domain,
       types: PERMIT_TYPES,
       primaryType: 'PermitSingle',
-      message: values,
+      message: message,
     })
   }
-  const { domain, values } = getPermitBatchData(permit, permit2Address, chainId)
+  const { domain, message } = getPermitBatchData(
+    permit,
+    permit2Address,
+    chainId
+  )
 
   return hashTypedData({
     domain,
     types: PERMIT_BATCH_TYPES,
     primaryType: 'PermitBatch',
-    message: values,
+    message: message,
   })
 }
 

package/src/core/EVM/permits/getNativePermit.ts

@@ -1,4 +1,3 @@
-import type { ExtendedChain } from '@lifi/types'
 import {
   encodeAbiParameters,
   keccak256,
@@ -145,12 +144,13 @@ function validateDomainSeparator({
  */
 export const getNativePermit = async (
   client: Client,
-  chain: ExtendedChain,
+  chainId: number,
   tokenAddress: Address,
+  spenderAddress: Address,
   amount: bigint
 ): Promise<NativePermitData | undefined> => {
   try {
-    const multicallAddress = await getMulticallAddress(chain.id)
+    const multicallAddress = await getMulticallAddress(chainId)
 
     const contractCalls = [
       {
@@ -197,7 +197,7 @@ export const getNativePermit = async (
       const { isValid, domain } = validateDomainSeparator({
         name: nameResult.result,
         version: versionResult.result ?? '1',
-        chainId: BigInt(chain.id),
+        chainId: BigInt(chainId),
         verifyingContract: tokenAddress,
         domainSeparator: domainSeparatorResult.result,
       })
@@ -206,18 +206,19 @@ export const getNativePermit = async (
         return undefined
       }
 
-      const values = {
+      const message = {
         owner: client.account!.address,
-        spender: chain.permit2Proxy as Address,
+        spender: spenderAddress,
         value: amount,
         nonce: noncesResult.result,
         deadline: BigInt(Math.floor(Date.now() / 1000) + 30 * 60), // 30 minutes
       }
 
       return {
+        primaryType: 'Permit',
         domain,
         types: eip2612Types,
-        values,
+        message,
       }
     }
 
@@ -245,7 +246,7 @@ export const getNativePermit = async (
     const { isValid, domain } = validateDomainSeparator({
       name,
       version,
-      chainId: BigInt(chain.id),
+      chainId: BigInt(chainId),
       verifyingContract: tokenAddress,
       domainSeparator: domainSeparatorResult.value,
     })
@@ -254,18 +255,19 @@ export const getNativePermit = async (
       return undefined
     }
 
-    const values = {
+    const message = {
       owner: client.account!.address,
-      spender: chain.permit2Proxy as Address,
+      spender: spenderAddress,
       value: amount,
       nonce: noncesResult.value,
       deadline: BigInt(Math.floor(Date.now() / 1000) + 30 * 60), // 30 minutes
     }
 
     return {
+      primaryType: 'Permit',
       domain,
       types: eip2612Types,
-      values,
+      message,
     }
   } catch {
     return undefined

package/src/core/EVM/permits/signPermit2Message.ts

@@ -1,17 +1,10 @@
-import type { ExtendedChain } from '@lifi/types'
+import type { ExtendedChain, SignedTypedData } from '@lifi/types'
 import type { Address, Client, Hex } from 'viem'
 import { keccak256 } from 'viem'
 import { signTypedData } from 'viem/actions'
 import { getAction } from 'viem/utils'
 import { getPermitTransferFromValues } from './getPermitTransferFromValues.js'
-import {
-  type PermitBatchTransferFrom,
-  type PermitBatchTransferFromData,
-  type PermitTransferFrom,
-  type PermitTransferFromData,
-  getPermitData,
-} from './signatureTransfer.js'
-import type { Permit2Signature } from './types.js'
+import { getPermitData } from './signatureTransfer.js'
 
 export interface SignPermit2MessageParams {
   client: Client
@@ -22,59 +15,45 @@ export interface SignPermit2MessageParams {
   witness?: boolean
 }
 
-export interface SignPermit2SingleParams extends SignPermit2MessageParams {
-  permitData?: PermitTransferFromData
-}
-
-export interface SignPermit2BatchParams extends SignPermit2MessageParams {
-  permitData?: PermitBatchTransferFromData
-}
-
-export function signPermit2Message(
-  params: SignPermit2SingleParams
-): Promise<Permit2Signature<PermitTransferFrom>>
-export function signPermit2Message(
-  params: SignPermit2BatchParams
-): Promise<Permit2Signature<PermitBatchTransferFrom>>
 export async function signPermit2Message(
-  params: SignPermit2SingleParams | SignPermit2BatchParams
-): Promise<Permit2Signature<PermitTransferFrom | PermitBatchTransferFrom>> {
-  const { client, chain, tokenAddress, amount, data, permitData, witness } =
-    params
+  params: SignPermit2MessageParams
+): Promise<SignedTypedData> {
+  const { client, chain, tokenAddress, amount, data, witness } = params
 
-  let _permitData = permitData
-  if (!_permitData) {
-    const permitTransferFrom = await getPermitTransferFromValues(
-      client,
-      chain,
-      tokenAddress,
-      amount
-    )
+  const permitTransferFrom = await getPermitTransferFromValues(
+    client,
+    chain,
+    tokenAddress,
+    amount
+  )
 
-    // Create witness data for the LI.FI call
-    const _witness = witness
-      ? {
-          witness: {
-            diamondAddress: chain.diamondAddress as Address,
-            diamondCalldataHash: keccak256(data),
-          },
-          witnessTypeName: 'LiFiCall',
-          witnessType: {
-            LiFiCall: [
-              { name: 'diamondAddress', type: 'address' },
-              { name: 'diamondCalldataHash', type: 'bytes32' },
-            ],
-          },
-        }
-      : undefined
+  // Create witness data for the LI.FI call
+  const _witness = witness
+    ? {
+        witness: {
+          diamondAddress: chain.diamondAddress as Address,
+          diamondCalldataHash: keccak256(data),
+        },
+        witnessTypeName: 'LiFiCall',
+        witnessType: {
+          LiFiCall: [
+            { name: 'diamondAddress', type: 'address' },
+            { name: 'diamondCalldataHash', type: 'bytes32' },
+          ],
+        },
+      }
+    : undefined
 
-    _permitData = getPermitData(
-      permitTransferFrom,
-      chain.permit2 as Address,
-      chain.id,
-      _witness
-    )
-  }
+  const permitData = getPermitData(
+    permitTransferFrom,
+    chain.permit2 as Address,
+    chain.id,
+    _witness
+  )
+
+  const primaryType = witness
+    ? 'PermitWitnessTransferFrom'
+    : 'PermitTransferFrom'
 
   const signature = await getAction(
     client,
@@ -82,14 +61,15 @@ export async function signPermit2Message(
     'signTypedData'
   )({
     account: client.account!,
-    primaryType: witness ? 'PermitWitnessTransferFrom' : 'PermitTransferFrom',
-    domain: _permitData.domain,
-    types: _permitData.types,
-    message: _permitData.values,
+    primaryType,
+    domain: permitData.domain,
+    types: permitData.types,
+    message: permitData.message,
   })
 
   return {
+    ...permitData,
+    primaryType,
     signature,
-    values: _permitData.values,
   }
 }

package/src/core/EVM/permits/signatureTransfer.ts

@@ -36,13 +36,13 @@ export type PermitBatchTransferFrom = {
 export type PermitTransferFromData = {
   domain: TypedDataDomain
   types: TypedData
-  values: PermitTransferFrom
+  message: PermitTransferFrom
 }
 
 export type PermitBatchTransferFromData = {
   domain: TypedDataDomain
   types: TypedData
-  values: PermitBatchTransferFrom
+  message: PermitBatchTransferFrom
 }
 
 const TOKEN_PERMISSIONS = [
@@ -103,14 +103,14 @@ export function getPermitTransferData(
       } as const)
     : PERMIT_TRANSFER_FROM_TYPES
 
-  const values = witness
+  const message = witness
     ? Object.assign(permit, { witness: witness.witness })
     : permit
 
   return {
     domain,
     types,
-    values,
+    message,
   }
 }
 
@@ -141,14 +141,14 @@ export function getPermitBatchTransferData(
       }
     : PERMIT_BATCH_TRANSFER_FROM_TYPES
 
-  const values = witness
+  const message = witness
     ? Object.assign(permit, { witness: witness.witness })
     : permit
 
   return {
     domain,
     types,
-    values,
+    message,
   }
 }
 
@@ -185,7 +185,7 @@ export function hash<T extends PermitTransferFrom | PermitBatchTransferFrom>(
   witness?: Witness
 ) {
   if (isPermitTransferFrom(permit)) {
-    const { domain, types, values } = getPermitTransferData(
+    const { domain, types, message } = getPermitTransferData(
       permit,
       permit2Address,
       chainId,
@@ -197,11 +197,11 @@ export function hash<T extends PermitTransferFrom | PermitBatchTransferFrom>(
       types,
       primaryType: witness ? 'PermitWitnessTransferFrom' : 'PermitTransferFrom',
       message: {
-        ...values,
+        ...message,
       },
     })
   }
-  const { domain, types, values } = getPermitBatchTransferData(
+  const { domain, types, message } = getPermitBatchTransferData(
     permit,
     permit2Address,
     chainId,
@@ -214,7 +214,7 @@ export function hash<T extends PermitTransferFrom | PermitBatchTransferFrom>(
     primaryType: witness
       ? 'PermitBatchWitnessTransferFrom'
       : 'PermitBatchTransferFrom',
-    message: { ...values },
+    message: { ...message },
   })
 }