0xtrails 0.13.2 → 0.14.0

package/src/fees.ts

@@ -1,362 +0,0 @@
-import type { Intent } from "@0xtrails/api"
-import { getTokenInfo } from "./tokens.js"
-import {
-  formatRawAmount,
-  formatUsdAmountDisplay,
-  formatUsdAmountLocaleDisplay,
-} from "./utils/format.js"
-import { zeroAddress } from "viem"
-
-export interface FeeItem {
-  amount: string
-  tokenSymbol: string
-  tokenAddress: string
-  chainId: number
-  usdValue: string
-  usdValueLocale?: string
-}
-
-export interface ProviderFeeItem {
-  id: string // e.g., "SUSHI", "CCTP"
-  name: string // e.g., "Sushi", "Circle CCTP"
-  url: string // e.g., "https://www.sushi.com/"
-  feeUsd: number // raw USD value
-  usdValue: string // formatted display value like "$0.97"
-  usdValueLocale?: string // locale-formatted display value
-  isBridge: boolean // true for CCTP/RELAY/LIFI
-}
-
-// Bridge providers are identified by these IDs
-const BRIDGE_PROVIDERS = ["CCTP", "RELAY", "LIFI"]
-export const isBridgeProvider = (id: string) => BRIDGE_PROVIDERS.includes(id)
-
-// Route provider display names and URLs
-export const ROUTE_PROVIDER_INFO: Record<
-  string,
-  { name: string; url: string }
-> = {
-  AUTO: { name: "", url: "" },
-  CCTP: { name: "Circle CCTP", url: "https://www.circle.com/" },
-  RELAY: { name: "Relay", url: "https://relay.link/" },
-  LIFI: { name: "LiFi", url: "https://li.fi/" },
-  ZEROX: { name: "0x", url: "https://0x.org/" },
-  SUSHI: { name: "Sushi", url: "https://www.sushi.com/" },
-  LZ_OFT: { name: "LayerZero OFT", url: "https://layerzero.network/" },
-}
-
-export interface TrailsFeeBreakdown {
-  originRelayFee?: FeeItem
-  destinationRelayFee?: FeeItem
-  providerFee?: FeeItem // Keep for backward compatibility (combined total)
-  providerFees?: ProviderFeeItem[] // Individual provider fees
-  trailsFee?: FeeItem
-  totalUsdValue?: string
-  originChainId?: number
-  destinationChainId?: number
-}
-
-// Helper function to format token amounts with proper decimal conversion
-async function formatTokenAmount(
-  amount: string | number | undefined,
-  tokenAddress: string,
-  chainId: number,
-  config: {
-    trailsApiKey: string
-    trailsApiUrl: string
-    sequenceMetadataUrl: string
-  },
-): Promise<string> {
-  if (!amount) return "0"
-  const num = typeof amount === "string" ? parseFloat(amount) : amount
-  if (num === 0) return "0"
-
-  // Get token info to determine decimals
-  const tokenInfo = await getTokenInfo(chainId, tokenAddress, config)
-  if (!tokenInfo?.decimals) {
-    throw new Error(
-      `Token decimals not found for token ${tokenAddress} on chain ${chainId}`,
-    )
-  }
-
-  // Use existing formatRawAmount utility
-  const formatted = formatRawAmount(BigInt(Math.floor(num)), tokenInfo.decimals)
-
-  // Handle very small amounts
-  const numFormatted = parseFloat(formatted)
-  if (numFormatted < 0.000001 && numFormatted > 0) return "<0.000001"
-
-  return formatted
-}
-
-/**
- * Extract fee breakdown and calculate all fee values from intent data
- * Uses raw USD values from intent to avoid parsing display strings
- */
-export async function extractTrailsFeeBreakdown(
-  intent: Intent,
-  config: {
-    trailsApiKey: string
-    trailsApiUrl: string
-    sequenceMetadataUrl: string
-  },
-  options?: {
-    originAmountUsd?: number
-    destinationAmountUsd?: number
-    totalFeesUsd?: number
-  },
-): Promise<{
-  trailsFeeBreakdown: TrailsFeeBreakdown | null
-  // Calculated fee values (using raw USD numbers)
-  originGasUsd: number
-  destinationGasUsd: number
-  totalGasUsd: number
-  providerFeeUsd: number
-  trailsFeeUsd: number
-  originAmountUsd: number
-  destinationAmountUsd: number
-  totalFeesUsd: number
-  totalFeesUsdDisplay: string
-  // Display values
-  originGasUsdDisplay: string
-  destinationGasUsdDisplay: string
-  totalGasUsdDisplay: string
-  providerFeeUsdDisplay: string
-  trailsFeeUsdDisplay: string
-  totalProviderFeesUsd: number
-  totalProviderFeesUsdDisplay: string
-}> {
-  const fees = intent?.fees
-  if (!fees) {
-    // Return zero values if no fees
-    return {
-      trailsFeeBreakdown: null,
-      originGasUsd: 0,
-      destinationGasUsd: 0,
-      totalGasUsd: 0,
-      providerFeeUsd: 0,
-      trailsFeeUsd: 0,
-      originAmountUsd: options?.originAmountUsd ?? 0,
-      destinationAmountUsd: options?.destinationAmountUsd ?? 0,
-      totalFeesUsd: options?.totalFeesUsd ?? 0,
-      totalFeesUsdDisplay: formatUsdAmountDisplay(0),
-      originGasUsdDisplay: formatUsdAmountDisplay(0),
-      destinationGasUsdDisplay: formatUsdAmountDisplay(0),
-      totalGasUsdDisplay: formatUsdAmountDisplay(0),
-      providerFeeUsdDisplay: formatUsdAmountDisplay(0),
-      trailsFeeUsdDisplay: formatUsdAmountDisplay(0),
-      totalProviderFeesUsd: 0,
-      totalProviderFeesUsdDisplay: formatUsdAmountDisplay(0),
-    }
-  }
-
-  // Get chain IDs from origin and destination calls
-  const originChainId = intent.quoteRequest.originChainId
-  const destinationChainId = intent.quoteRequest.destinationChainId
-
-  // Use the origin and destination gas fees
-  const originChainQuote = fees.originGas
-  const destinationChainQuote = fees.destinationGas
-
-  // Individual gas fees for breakdown display (origin + destination)
-  const originGasUsd =
-    typeof originChainQuote?.totalFeeUsd === "string"
-      ? parseFloat(originChainQuote.totalFeeUsd)
-      : (originChainQuote?.totalFeeUsd ?? 0)
-  const destinationGasUsd =
-    typeof destinationChainQuote?.totalFeeUsd === "string"
-      ? parseFloat(destinationChainQuote.totalFeeUsd)
-      : (destinationChainQuote?.totalFeeUsd ?? 0)
-
-  // Formula: gasFeeUsd = originGasUsd + destinationGasUsd
-  const totalGasUsd = fees.gasFeeUsd ?? 0
-
-  // Direct fee fields from API (PR #343)
-  // Formula: providerFeeUsd = sum(routeProvidersFeeUsd[])
-  const providerFeeUsd = fees.providerFeeUsd ?? 0
-  // Formula: trailsFeeUsd = fixedFee + (fromAmountUsd * trailsFeeBps / 10000)
-  const trailsFeeUsd = fees.trailsFeeUsd ?? 0
-
-  // Use provided USD amounts or calculate from intent if available
-  const originAmountUsd = options?.originAmountUsd ?? 0
-  const destinationAmountUsd = options?.destinationAmountUsd ?? 0
-
-  // Formula: totalFeeUsd = gasFeeUsd + trailsFeeUsd + providerFeeUsd
-  const totalFeesUsd = fees?.totalFeeUsd ?? 0
-
-  // Build breakdown for display (only if we have chain quotes)
-  let breakdown: TrailsFeeBreakdown | null = null
-  if (originChainQuote || destinationChainQuote) {
-    breakdown = {}
-
-    // Extract origin relay fee if available
-    if (originChainQuote && originChainId !== undefined) {
-      const originTokenSymbol = originChainQuote.nativeTokenSymbol || "Unknown"
-      const originChainIdNum = originChainId
-      const nativeTokenAddress = zeroAddress
-
-      breakdown.originRelayFee = {
-        amount: await formatTokenAmount(
-          originChainQuote.totalFeeAmount.toString(),
-          nativeTokenAddress,
-          originChainIdNum,
-          config,
-        ),
-        tokenSymbol: originTokenSymbol,
-        tokenAddress: nativeTokenAddress,
-        chainId: originChainIdNum,
-        usdValue: formatUsdAmountDisplay(originGasUsd),
-        usdValueLocale: formatUsdAmountLocaleDisplay(originGasUsd),
-      }
-      breakdown.originChainId = originChainIdNum
-    }
-
-    // Extract destination relay fee if available
-    if (destinationChainQuote && destinationChainId !== undefined) {
-      const destinationTokenSymbol =
-        destinationChainQuote.nativeTokenSymbol || "Unknown"
-      const destinationChainIdNum = destinationChainId
-      const nativeTokenAddress = zeroAddress
-
-      breakdown.destinationRelayFee = {
-        amount: await formatTokenAmount(
-          destinationChainQuote.totalFeeAmount.toString(),
-          nativeTokenAddress,
-          destinationChainIdNum,
-          config,
-        ),
-        tokenSymbol: destinationTokenSymbol,
-        tokenAddress: nativeTokenAddress,
-        chainId: destinationChainIdNum,
-        usdValue: formatUsdAmountDisplay(destinationGasUsd),
-        usdValueLocale: formatUsdAmountLocaleDisplay(destinationGasUsd),
-      }
-      breakdown.destinationChainId = destinationChainIdNum
-    }
-
-    // Extract provider fee from provider fees if available
-    const providerFeeRawAmount = fees.provider?.quoteProviderFee
-    if (
-      (providerFeeUsd > 0 || providerFeeRawAmount !== undefined) &&
-      originChainId !== undefined
-    ) {
-      const feeTokenAddress = fees.feeTokenAddress || zeroAddress
-      const originChainIdNum =
-        typeof originChainId === "bigint"
-          ? Number(originChainId)
-          : originChainId
-
-      // Get token info to determine the actual token symbol
-      const feeTokenInfo = await getTokenInfo(
-        originChainIdNum,
-        feeTokenAddress,
-        config,
-      )
-      if (!feeTokenInfo?.symbol) {
-        throw new Error(
-          `Token symbol not found for provider fee token ${feeTokenAddress} on chain ${originChainIdNum}`,
-        )
-      }
-
-      breakdown.providerFee = {
-        amount: await formatTokenAmount(
-          providerFeeRawAmount?.toString(),
-          feeTokenAddress,
-          originChainIdNum,
-          config,
-        ),
-        tokenSymbol: feeTokenInfo.symbol,
-        tokenAddress: feeTokenAddress,
-        chainId: originChainIdNum,
-        usdValue: formatUsdAmountDisplay(providerFeeUsd),
-      }
-    }
-
-    // Build individual provider fees array from routeProviders and routeProvidersFeeUsd
-    const routeProviders = intent.quote?.routeProviders || []
-    const routeProvidersFeeUsd = intent.quote?.routeProvidersFeeUsd || []
-    if (routeProviders.length > 0) {
-      breakdown.providerFees = routeProviders
-        .map((providerId: string, index: number) => {
-          const info = ROUTE_PROVIDER_INFO[providerId] || {
-            name: providerId,
-            url: "",
-          }
-          const feeUsd = routeProvidersFeeUsd[index] ?? 0
-          return {
-            id: providerId,
-            name: info.name,
-            url: info.url,
-            feeUsd,
-            usdValue: formatUsdAmountDisplay(feeUsd),
-            usdValueLocale: formatUsdAmountLocaleDisplay(feeUsd),
-            isBridge: isBridgeProvider(providerId),
-          }
-        })
-        .filter((p: ProviderFeeItem) => p.feeUsd > 0) // Only include providers with fees
-    }
-
-    // Extract Trails platform fee from provider fees if available
-    const trailsFeeRawAmount = fees.provider?.trailsFee
-    if (
-      (trailsFeeUsd > 0 || trailsFeeRawAmount !== undefined) &&
-      originChainId !== undefined
-    ) {
-      const feeTokenAddress = fees.feeTokenAddress || zeroAddress
-      const originChainIdNum =
-        typeof originChainId === "bigint"
-          ? Number(originChainId)
-          : originChainId
-
-      // Get token info to determine the actual token symbol
-      const feeTokenInfo = await getTokenInfo(
-        originChainIdNum,
-        feeTokenAddress,
-        config,
-      )
-      if (!feeTokenInfo?.symbol) {
-        throw new Error(
-          `Token symbol not found for trails fee token ${feeTokenAddress} on chain ${originChainIdNum}`,
-        )
-      }
-
-      breakdown.trailsFee = {
-        amount: await formatTokenAmount(
-          trailsFeeRawAmount?.toString(),
-          feeTokenAddress,
-          originChainIdNum,
-          config,
-        ),
-        tokenSymbol: feeTokenInfo.symbol,
-        tokenAddress: feeTokenAddress,
-        chainId: originChainIdNum,
-        usdValue: formatUsdAmountDisplay(trailsFeeUsd),
-        usdValueLocale: formatUsdAmountLocaleDisplay(trailsFeeUsd),
-      }
-    }
-
-    // Calculate total USD value for breakdown display
-    const totalUsd =
-      originGasUsd + destinationGasUsd + providerFeeUsd + trailsFeeUsd
-    breakdown.totalUsdValue = formatUsdAmountDisplay(totalUsd)
-  }
-
-  return {
-    trailsFeeBreakdown: breakdown,
-    originGasUsd,
-    destinationGasUsd,
-    totalGasUsd,
-    providerFeeUsd,
-    trailsFeeUsd,
-    originAmountUsd,
-    destinationAmountUsd,
-    totalFeesUsd,
-    totalFeesUsdDisplay: formatUsdAmountDisplay(totalFeesUsd),
-    originGasUsdDisplay: formatUsdAmountDisplay(originGasUsd),
-    destinationGasUsdDisplay: formatUsdAmountDisplay(destinationGasUsd),
-    totalGasUsdDisplay: formatUsdAmountDisplay(totalGasUsd),
-    providerFeeUsdDisplay: formatUsdAmountDisplay(providerFeeUsd),
-    trailsFeeUsdDisplay: formatUsdAmountDisplay(trailsFeeUsd),
-    totalProviderFeesUsd: providerFeeUsd,
-    totalProviderFeesUsdDisplay: formatUsdAmountDisplay(providerFeeUsd),
-  }
-}