0xtrails 0.13.1 → 0.14.0

package/src/transactionIntent/deposits/gaslessDeposit.ts

@@ -1,705 +0,0 @@
-import type { Account, Chain, WalletClient } from "viem"
-import { maxUint256 } from "viem"
-import type {
-  TrailsApi,
-  GasFeeOptions,
-  FeeOption,
-  DepositSignature,
-  ExecuteIntentResponse,
-  TrailsContracts,
-  IntentProtocolVersion,
-} from "@0xtrails/api"
-import type { CheckoutOnHandlers } from "../../widget/hooks/useCheckout.js"
-import type { TransactionState } from "../../transactions.js"
-import { logger } from "../../logger.js"
-import {
-  isNativeToken,
-  isZeroAccount,
-  normalizeAddress,
-} from "../../utils/address.js"
-import { toSeconds, now, HOUR_S } from "../../utils/time.js"
-import { attemptSwitchChain } from "../../chainSwitch.js"
-import { getTransactionStateFromReceipt } from "../execution/transactionState.js"
-import {
-  getDelegatorSmartAccount,
-  getPaymasterGaslessTransaction,
-  sendPaymasterGaslessTransaction,
-} from "../../paymasterSend.js"
-import {
-  getNeedsIntentEntrypointApproval,
-  getUserNonce,
-  signIntent,
-  getPermitSignature,
-  validateGaslessSignature,
-} from "../../gasless.js"
-import { getIsPopupBlockedError, getIsUserRejectionError } from "../../error.js"
-import { getChainRpcClient } from "../../chains.js"
-import { TRAILS_CONTRACTS } from "../../constants.js"
-
-export async function attemptGaslessDeposit({
-  paymasterUrl,
-  depositTokenAddress,
-  depositTokenAmount,
-  depositRecipient,
-  onOriginSend,
-  walletClient,
-  chain,
-  account,
-  trailsClient,
-  feeOptions,
-  selectedFeeOption: selectedFeeOptionParam,
-  checkoutOnHandlers,
-  intentId,
-  onTransactionStateChange,
-  transactionStates,
-  executeIntentFn,
-  intentProtocolVersion,
-}: {
-  paymasterUrl?: string
-  depositTokenAddress: string
-  depositTokenAmount: string
-  depositRecipient: string
-  onOriginSend?: () => void
-  walletClient: WalletClient
-  chain: Chain
-  account: Account
-  trailsClient: TrailsApi
-  feeOptions?: GasFeeOptions
-  trailsContracts: TrailsContracts
-  selectedFeeOption?: FeeOption | null
-  abortSignal?: AbortSignal
-  checkoutOnHandlers?: Partial<CheckoutOnHandlers>
-  intentId?: string
-  onTransactionStateChange?: (transactionStates: TransactionState[]) => void
-  transactionStates?: TransactionState[]
-  executeIntentFn?: (params: {
-    intentId: string
-    depositTransactionHash?: string
-    depositSignature?: DepositSignature
-  }) => Promise<ExecuteIntentResponse>
-  intentProtocolVersion: IntentProtocolVersion
-}): Promise<void> {
-  const originChainId = chain.id
-
-  logger.console.log(
-    "[trails-sdk] [gasless-flow] [fee-select] attemptGaslessDeposit called with:",
-    {
-      originChainId,
-      depositTokenAddress,
-      depositTokenAmount,
-      depositRecipient,
-      hasFeeOptions: !!feeOptions,
-      feeOptionsLength: feeOptions?.feeOptions?.length,
-      selectedFeeOption: selectedFeeOptionParam,
-      hasSelectedFeeOption: !!selectedFeeOptionParam,
-      paymasterUrl,
-    },
-  )
-
-  const publicClient = getChainRpcClient(chain.id)
-
-  logger.console.log("[trails-sdk] [gasless-flow] Intent entrypoint check:", {
-    chainId: chain.id,
-    chainName: chain.name,
-    intentEntrypoint: TRAILS_CONTRACTS.trailsIntentEntrypointAddress,
-  })
-
-  // NEW FLOW: Use Intent Entrypoint API with EIP-2162 permit signature support
-  logger.console.log(
-    "[trails-sdk] Using Intent Entrypoint API flow with EIP-2162 permit signature support for gasless deposit",
-  )
-
-  // Switch to correct chain before requesting signatures
-  logger.console.log(
-    "[trails-sdk] [gasless-flow] Switching to chain before permit/intent signatures",
-    { originChainId },
-  )
-  await attemptSwitchChain({
-    walletClient,
-    desiredChainId: originChainId,
-  })
-
-  try {
-    if (paymasterUrl) {
-      logger.console.log(
-        "[trails-sdk] [gasless-flow] doing gasless with paymaster",
-      )
-
-      // Switch to correct chain before requesting signatures
-      logger.console.log(
-        "[trails-sdk] [gasless-flow] Switching chain for paymaster flow",
-      )
-      await attemptSwitchChain({
-        walletClient,
-        desiredChainId: originChainId,
-      })
-
-      const delegatorSmartAccount = await getDelegatorSmartAccount({
-        publicClient,
-      })
-
-      const calls: Array<{
-        to: string
-        data: string
-        value: string
-      }> = await getPaymasterGaslessTransaction({
-        walletClient,
-        chain,
-        tokenAddress: depositTokenAddress as `0x${string}`,
-        amount: BigInt(depositTokenAmount),
-        recipient: depositRecipient as `0x${string}`,
-        delegatorSmartAccount,
-      })
-
-      logger.console.log("[trails-sdk] calls", calls)
-
-      // Trigger signature request callback before prompting wallet
-      if (checkoutOnHandlers?.triggerCheckoutSignatureRequest) {
-        checkoutOnHandlers.triggerCheckoutSignatureRequest()
-      }
-
-      let txHash: any
-      try {
-        txHash = await sendPaymasterGaslessTransaction({
-          walletClient,
-          publicClient,
-          chain,
-          paymasterUrl,
-          delegatorSmartAccount,
-          calls,
-        })
-
-        // Trigger signature confirmed callback after successful signing
-        if (checkoutOnHandlers?.triggerCheckoutSignatureConfirmed) {
-          checkoutOnHandlers.triggerCheckoutSignatureConfirmed()
-        }
-      } catch (error) {
-        // Check if this is a user rejection error
-        if (getIsUserRejectionError(error)) {
-          if (checkoutOnHandlers?.triggerCheckoutSignatureRejected) {
-            checkoutOnHandlers.triggerCheckoutSignatureRejected(error)
-          }
-        }
-        throw error
-      }
-
-      if (onOriginSend) {
-        onOriginSend()
-      }
-
-      // Update transaction state to pending with hash for paymaster flow
-      if (transactionStates?.[0] && onTransactionStateChange) {
-        transactionStates[0].state = "pending"
-        transactionStates[0].transactionHash = txHash
-
-        try {
-          onTransactionStateChange(transactionStates)
-        } catch (error) {
-          logger.console.error(
-            "[trails-sdk] Error calling onTransactionStateChange:",
-            error,
-          )
-        }
-      }
-
-      const receipt = await publicClient.waitForTransactionReceipt({
-        hash: txHash as `0x${string}`,
-        retryCount: 10,
-        onReplaced: (replacement) => {
-          logger.console.log("[trails-sdk] Gasless deposit tx replaced", {
-            reason: replacement.reason,
-            replacedHash: replacement.replacedTransaction.hash,
-            replacementHash: replacement.transaction.hash,
-          })
-        },
-      })
-      logger.console.log("[trails-sdk] receipt", receipt)
-
-      // Update transaction state to confirmed after receipt is obtained
-      if (transactionStates?.[0] && onTransactionStateChange && receipt) {
-        transactionStates[0] = getTransactionStateFromReceipt(
-          receipt,
-          chain.id,
-          transactionStates[0]?.label,
-        )
-
-        try {
-          onTransactionStateChange(transactionStates)
-        } catch (error) {
-          logger.console.error(
-            "[trails-sdk] Error calling onTransactionStateChange:",
-            error,
-          )
-        }
-      }
-
-      return
-    }
-
-    const deadline = toSeconds(now()) + HOUR_S // 1 hour from now
-    const feeOptionsList = feeOptions?.feeOptions ?? []
-    const hasFeeOptions = feeOptionsList.length > 0
-    const userExplicitlySelectedNativeFee = selectedFeeOptionParam === null
-
-    // 1. Check if we need approval - check if we have enough allowance for this transaction (deposit + fee if same token)
-    let requiredAmount = BigInt(depositTokenAmount)
-
-    // Start with the caller's selection (unless they explicitly chose native gas)
-    let selectedFeeOption: FeeOption | null | undefined =
-      userExplicitlySelectedNativeFee
-        ? null
-        : (selectedFeeOptionParam ?? undefined)
-
-    if (selectedFeeOption && hasFeeOptions) {
-      const matchedOption =
-        feeOptionsList.find(
-          (opt) =>
-            opt.tokenAddress?.toLowerCase() ===
-            selectedFeeOption?.tokenAddress?.toLowerCase(),
-        ) || null
-
-      if (matchedOption) {
-        selectedFeeOption = matchedOption
-        logger.console.log(
-          "[trails-sdk] Matched selectedFeeOption to latest fee option:",
-          {
-            selectedFeeOption,
-            matchedOption,
-          },
-        )
-      }
-    }
-
-    const depositTokenAddressLower = normalizeAddress(depositTokenAddress)
-
-    // Only include fee in required amount if the fee token is the same as the deposit token
-    if (selectedFeeOption?.amount && selectedFeeOption?.tokenAddress) {
-      const feeOptionIsSameAsDepositToken =
-        selectedFeeOption.tokenAddress.toLowerCase() ===
-        depositTokenAddressLower
-
-      if (feeOptionIsSameAsDepositToken) {
-        requiredAmount = requiredAmount + BigInt(selectedFeeOption.amount)
-        logger.console.log(
-          "[trails-sdk] Fee token matches deposit token, including fee in required approval amount:",
-          {
-            depositAmount: depositTokenAmount,
-            feeAmount: selectedFeeOption.amount,
-            feeOptionAddress: selectedFeeOption.tokenAddress,
-            depositTokenAddress,
-            totalRequired: requiredAmount.toString(),
-          },
-        )
-      } else {
-        logger.console.log(
-          "[trails-sdk] Fee token differs from deposit token, separate approval will be needed:",
-          {
-            depositAmount: depositTokenAmount,
-            depositTokenAddress,
-            feeAmount: selectedFeeOption.amount,
-            feeOptionAddress: selectedFeeOption.tokenAddress,
-            depositTokenRequired: requiredAmount.toString(),
-          },
-        )
-      }
-    }
-
-    logger.console.log(
-      "[trails-sdk] [intent-protocol] [gasless-flow] Checking approval requirements",
-      {
-        intentProtocolVersion,
-        isV1: intentProtocolVersion === "v1",
-        checkingEntrypointApproval: intentProtocolVersion === "v1",
-      },
-    )
-
-    const needsApproval =
-      intentProtocolVersion === "v1"
-        ? await getNeedsIntentEntrypointApproval({
-            client: publicClient,
-            token: depositTokenAddress as `0x${string}`,
-            account: account.address,
-            entrypoint:
-              TRAILS_CONTRACTS.trailsIntentEntrypointAddress as `0x${string}`,
-            amount: requiredAmount, // Check if we have enough allowance for this specific transaction
-          })
-        : false
-
-    logger.console.log(
-      "[trails-sdk] [intent-protocol] [gasless-flow] Approval check result",
-      {
-        intentProtocolVersion,
-        needsApproval,
-        reason:
-          intentProtocolVersion === "v1"
-            ? "v1: checked entrypoint approval"
-            : "v1.5: skipped entrypoint approval (not needed)",
-      },
-    )
-
-    const depositTokenIsNative = isNativeToken(depositTokenAddressLower)
-    const shouldAttachPermit =
-      !depositTokenIsNative && (intentProtocolVersion !== "v1" || needsApproval)
-
-    logger.console.log(
-      "[trails-sdk] [gasless-flow] Checking permit requirements",
-      {
-        userAddress: account.address,
-        tokenAddress: depositTokenAddress,
-        depositAmount: depositTokenAmount,
-        requiredAmount: requiredAmount.toString(),
-        intentAddress: depositRecipient,
-        chainID: originChainId,
-        deadline,
-        needsApproval,
-        intentProtocolVersion,
-        shouldAttachPermit,
-      },
-    )
-
-    // 2. Get permit signature if approval needed for deposit token
-    // Note: Fee payment is handled by the backend/relayer, we only need permit for the deposit token
-    let permitSignature: string | undefined
-    let permitDeadline: number | undefined
-    let permitAmount: bigint | undefined
-
-    if (shouldAttachPermit) {
-      logger.console.log(
-        "[trails-sdk] Getting permit signature for deposit token",
-      )
-
-      let spender: `0x${string}`
-      if (intentProtocolVersion === "v1") {
-        // Use infinite approval (maxUint256) to entrypoint
-        permitAmount = maxUint256
-        spender =
-          TRAILS_CONTRACTS.trailsIntentEntrypointAddress as `0x${string}`
-        logger.console.log(
-          "[trails-sdk] [intent-protocol] [gasless-flow] v1: Using infinite permit to entrypoint",
-          {
-            permitAmount: "maxUint256 (infinite)",
-            spender,
-            target: "trailsIntentEntrypointAddress",
-          },
-        )
-      } else {
-        // Use required amount to intent address
-        permitAmount = requiredAmount
-        spender = depositRecipient as `0x${string}`
-        logger.console.log(
-          "[trails-sdk] [intent-protocol] [gasless-flow] v1.5: Using specific permit to intent address",
-          {
-            permitAmount: permitAmount.toString(),
-            spender,
-            target: "depositRecipient (intent address)",
-          },
-        )
-      }
-
-      logger.console.log(
-        "[trails-sdk] Using permit amount for gasless deposits",
-        {
-          depositAmount: depositTokenAmount,
-          depositTokenAddress,
-          requiredAmount: requiredAmount.toString(),
-          permitAmount: permitAmount.toString(),
-          spender,
-        },
-      )
-
-      // Trigger signature request callback before prompting wallet for permit
-      if (checkoutOnHandlers?.triggerCheckoutSignatureRequest) {
-        checkoutOnHandlers.triggerCheckoutSignatureRequest()
-      }
-
-      let permitSig: Awaited<ReturnType<typeof getPermitSignature>> | undefined
-      try {
-        permitSig = await getPermitSignature({
-          walletClient,
-          signer: account.address,
-          spender,
-          tokenAddress: depositTokenAddress as `0x${string}`,
-          amount: permitAmount,
-          chain,
-          deadline: BigInt(deadline),
-        })
-        permitSignature = permitSig.signature
-        permitDeadline = Number(permitSig.deadline)
-
-        // Trigger signature confirmed callback after successful signing
-        if (checkoutOnHandlers?.triggerCheckoutSignatureConfirmed) {
-          checkoutOnHandlers.triggerCheckoutSignatureConfirmed()
-        }
-      } catch (error) {
-        // Check if this is a user rejection error
-        if (getIsUserRejectionError(error)) {
-          if (checkoutOnHandlers?.triggerCheckoutSignatureRejected) {
-            checkoutOnHandlers.triggerCheckoutSignatureRejected(error)
-          }
-        }
-        throw error
-      }
-      logger.console.log("[trails-sdk] Deposit token permit signature obtained")
-    }
-
-    let intentSignature: string | undefined
-    let userNonce: number | undefined
-
-    logger.console.log(
-      "[trails-sdk] [intent-protocol] [gasless-flow] Intent signature check",
-      {
-        intentProtocolVersion,
-        requiresIntentSignature: intentProtocolVersion === "v1",
-        reason:
-          intentProtocolVersion === "v1"
-            ? "v1: requires EIP-712 intent signature + nonce"
-            : "v1.5: no intent signature needed (backend manages)",
-      },
-    )
-
-    if (intentProtocolVersion === "v1") {
-      // Intent signature is only needed for v1
-      logger.console.log(
-        "[trails-sdk] [intent-protocol] [gasless-flow] v1: Starting intent signature flow",
-      )
-      // 3. Get current nonce for the user
-      logger.console.log("[trails-sdk] Getting user nonce")
-      const nonce = await getUserNonce({
-        publicClient,
-        userAddress: account.address,
-        intentEntrypoint: TRAILS_CONTRACTS.trailsIntentEntrypointAddress,
-      })
-      logger.console.log("[trails-sdk] User nonce:", nonce.toString())
-      userNonce = Number(nonce)
-
-      // 4. Get intent signature
-      logger.console.log("[trails-sdk] Requesting intent signature via EIP-712")
-      const feeCollectorAddress = feeOptions?.feeCollectorAddress as
-        | `0x${string}`
-        | undefined
-
-      // Validate that we have a valid fee collector address
-      if (!feeCollectorAddress || isZeroAccount(feeCollectorAddress)) {
-        throw new Error(
-          "[trails-sdk] Fee collector address not provided by API. Cannot proceed with gasless deposit. " +
-            "Please ensure the API is returning feeCollectorAddress in the gasFeeOptions response.",
-        )
-      }
-
-      logger.console.log(
-        "[trails-sdk] Using fee collector address:",
-        feeCollectorAddress,
-      )
-
-      // Trigger signature request callback before prompting wallet
-      if (checkoutOnHandlers?.triggerCheckoutSignatureRequest) {
-        checkoutOnHandlers.triggerCheckoutSignatureRequest()
-      }
-
-      try {
-        const result = await signIntent({
-          client: walletClient,
-          intentParams: {
-            user: account.address,
-            token: depositTokenAddress as `0x${string}`,
-            amount: BigInt(depositTokenAmount),
-            intentAddress: depositRecipient as `0x${string}`,
-            deadline: BigInt(deadline),
-            chainId: originChainId,
-            contractAddress:
-              TRAILS_CONTRACTS.trailsIntentEntrypointAddress as `0x${string}`,
-            nonce,
-            feeAmount: BigInt(selectedFeeOption?.amount || "0"),
-            feeCollector: feeCollectorAddress,
-          },
-        })
-        intentSignature = result.signature
-        logger.console.log("[trails-sdk] Intent signature received")
-
-        // Validate signature length for gasless flow
-        validateGaslessSignature(intentSignature)
-
-        // Trigger signature confirmed callback after successful signing
-        if (checkoutOnHandlers?.triggerCheckoutSignatureConfirmed) {
-          checkoutOnHandlers.triggerCheckoutSignatureConfirmed()
-        }
-      } catch (error) {
-        // Check if this is a user rejection error
-        if (getIsUserRejectionError(error)) {
-          if (checkoutOnHandlers?.triggerCheckoutSignatureRejected) {
-            checkoutOnHandlers.triggerCheckoutSignatureRejected(error)
-          }
-          throw error
-        }
-        if (getIsPopupBlockedError(error)) {
-          throw new Error(
-            "Wallet signature popup was blocked by your browser. " +
-              "Please allow pop-ups for this site and try again. " +
-              "More details: " +
-              error,
-          )
-        }
-      }
-    }
-
-    // 5. Call the deposit endpoint with permit support and optional fee
-    logger.console.log(
-      "[trails-sdk] Calling executeIntent with depositSignature",
-      {
-        usePermit: needsApproval,
-        hasFee: !!feeOptions,
-        hasIntentId: !!intentId,
-      },
-    )
-
-    // Validate that we have the intentId
-    if (!intentId) {
-      throw new Error(
-        "[trails-sdk] intentId is required for gasless deposits. " +
-          "The calling code must commit the intent first using commitIntent() and pass the intentId.",
-      )
-    }
-
-    // Validate that we have a selected fee option for gasless deposit signature
-    if (!selectedFeeOption) {
-      logger.console.error(
-        "[trails-sdk] Missing selected fee option for gasless deposit signature",
-        {
-          selectedFeeOption,
-        },
-      )
-      throw new Error(
-        "[trails-sdk] selectedFeeOption is required for gasless deposits",
-      )
-    }
-
-    // Build depositSignature for executeIntent with all required fields
-    const depositSignature = {
-      intentSignature,
-      permitSignature,
-      permitDeadline,
-      permitAmount,
-      selectedGasFeeOption: selectedFeeOption,
-      userNonce,
-      deadline,
-    }
-
-    logger.console.log(
-      "[trails-sdk] Executing intent with gasless deposit signature",
-      { intentId, depositSignature },
-    )
-
-    // executeIntent will handle submitting to the relayer
-    // The backend processes the deposit signature and relays the transaction
-    const executeIntentFnToUse =
-      executeIntentFn || trailsClient.executeIntent.bind(trailsClient)
-    await executeIntentFnToUse({
-      intentId,
-      depositSignature,
-    })
-
-    logger.console.log(
-      "[trails-sdk] Intent execution submitted to backend. Transaction monitoring should happen via intent status polling.",
-    )
-
-    if (onOriginSend) {
-      onOriginSend()
-    }
-
-    // Update transaction state to pending for non-paymaster gasless flow
-    // Hash will be filled in later by the poller when backend confirms transaction
-    if (transactionStates?.[0] && onTransactionStateChange) {
-      transactionStates[0].state = "pending"
-      // transactionHash remains empty - will be updated by onDepositTransactionFound callback
-
-      try {
-        onTransactionStateChange(transactionStates)
-      } catch (error) {
-        logger.console.error(
-          "[trails-sdk] Error calling onTransactionStateChange:",
-          error,
-        )
-      }
-    }
-  } catch (error) {
-    logger.console.error(
-      "[trails-sdk] Error in Intent Entrypoint gasless deposit with EIP-2162 permit signature",
-      error,
-    )
-    throw error
-  }
-}
-
-export function getDoGasless(
-  originTokenAddress: string,
-  feeOptions?: GasFeeOptions,
-  selectedFeeOption?: FeeOption | null,
-  walletId?: string,
-): boolean {
-  // Don't use gasless flow for sequence-waas wallet
-  if (walletId === "sequence-waas") {
-    logger.console.log(
-      "[trails-sdk] [gasless-flow] getDoGasless: Skipping gasless flow for sequence-waas wallet",
-    )
-    return false
-  }
-
-  const hasFeeOptions = Boolean(feeOptions && feeOptions.feeOptions?.length > 0)
-
-  // Important: The UI passes selectedFeeOption in these states:
-  // - null: User explicitly chose "Pay with native gas"
-  // - {object}: User selected a fee token OR it was auto-selected
-  // - undefined: Should not happen (initial state auto-selects if options exist)
-
-  // If selectedFeeOption is null, user explicitly chose native gas
-  if (selectedFeeOption === null) {
-    logger.console.log(
-      "[trails-sdk] [gasless-flow] [fee-select] getDoGasless: User explicitly selected native gas (null)",
-    )
-    return false
-  }
-
-  // If selectedFeeOption is undefined and no fee options, can't do gasless
-  if (!selectedFeeOption && !hasFeeOptions) {
-    logger.console.log(
-      "[trails-sdk] [gasless-flow] [fee-select] getDoGasless: No fee token selected and no fee options available",
-    )
-    return false
-  }
-
-  // Check if the effective fee token is native gas
-  const isNativeGasFee =
-    !selectedFeeOption || isNativeToken(selectedFeeOption.tokenAddress)
-
-  // Don't use gasless if origin token is native (sending ETH)
-  if (isNativeToken(originTokenAddress)) {
-    logger.console.log(
-      "[trails-sdk] [gasless-flow] getDoGasless: Origin token is native, skipping gasless",
-    )
-    return false
-  }
-
-  // Don't use gasless if fee token is native
-  if (isNativeGasFee) {
-    logger.console.log(
-      "[trails-sdk] [gasless-flow] [fee-select] getDoGasless: Fee token is native gas, skipping gasless",
-      {
-        selectedFeeOption,
-      },
-    )
-    return false
-  }
-
-  // All conditions met, use gasless with ERC20 fee token
-  logger.console.log(
-    "[trails-sdk] [gasless-flow] [fee-select] getDoGasless decision: Using gasless",
-    {
-      originTokenAddress,
-      hasFeeOptions,
-      selectedFeeOption,
-      feeOptionsCount: feeOptions?.feeOptions?.length || 0,
-    },
-  )
-
-  return true
-}

package/src/transactionIntent/deposits/index.ts

@@ -1,3 +0,0 @@
-export * from "./gaslessDeposit.js"
-export * from "./standardDeposit.js"
-export * from "./depositOrchestrator.js"