0xtrails 0.1.2 → 0.1.4

package/src/analytics.ts

@@ -4,6 +4,60 @@ import { DATABEAT_KEY, DATABEAT_SERVER } from "./constants.js"
 import { getQueryParam } from "./queryParams.js"
 import { getSequenceProjectAccessKey } from "./config.js"
 
+let checkoutIdSingleton: string | null = null
+
+export function hasCheckoutId() {
+  return checkoutIdSingleton !== null
+}
+
+export function resetCheckoutId() {
+  checkoutIdSingleton = null
+
+  try {
+    localStorage.removeItem("checkoutId")
+  } catch (error) {
+    console.error("Error removing checkout id:", error)
+  }
+}
+
+export function getCheckoutId(newCheckoutId: boolean = false) {
+  if (newCheckoutId) {
+    generateCheckoutIdAndSet()
+  }
+
+  if (checkoutIdSingleton) {
+    return checkoutIdSingleton
+  }
+
+  try {
+    checkoutIdSingleton = localStorage.getItem("checkoutId")
+  } catch (error) {
+    console.error("Error getting checkout id:", error)
+  }
+
+  return checkoutIdSingleton
+}
+
+export function generateCheckoutIdAndSet() {
+  resetCheckoutId()
+
+  checkoutIdSingleton = generateCheckoutId()
+  try {
+    localStorage.setItem("checkoutId", checkoutIdSingleton)
+  } catch (error) {
+    console.error("Error setting checkout id:", error)
+  }
+}
+
+export function generateCheckoutId() {
+  try {
+    return crypto.randomUUID()
+  } catch (error) {
+    console.error("Error generating checkout id:", error)
+    return Date.now().toString()
+  }
+}
+
 // Pseudonymize sensitive data like transaction hashes and addresses
 export function pseudonymize(value: string): string {
   if (!value) return value
@@ -131,6 +185,7 @@ abstract class BaseAnalytics {
       event: EventType.WIDGET_SCREEN,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
@@ -147,12 +202,17 @@ abstract class BaseAnalytics {
     originTokenAddress?: string
     destinationTokenAddress?: string
     destinationTokenAmount?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
+    resetCheckoutId()
+
     this.track({
       event: EventType.PAYMENT_STARTED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(true),
         ...data,
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
@@ -170,12 +230,15 @@ abstract class BaseAnalytics {
   trackPaymentCompleted(data: {
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.PAYMENT_COMPLETED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         originChainId: data.originChainId?.toString(),
         destinationChainId: data.destinationChainId?.toString(),
@@ -187,18 +250,22 @@ abstract class BaseAnalytics {
         }),
       },
     })
+    resetCheckoutId()
   }
 
   trackPaymentError(data: {
     error: string
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.PAYMENT_ERROR,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
@@ -245,12 +312,17 @@ abstract class BaseAnalytics {
     originTokenAddress?: string
     destinationTokenAddress?: string
     userAddress?: string
+    mode?: string
+    fundMethod?: string
+    originTokenSymbol?: string
+    destinationTokenSymbol?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.INTENT_QUOTE_REQUESTED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         originChainId: data.originChainId?.toString(),
         destinationChainId: data.destinationChainId?.toString(),
         originTokenAddress: data.originTokenAddress,
@@ -258,6 +330,8 @@ abstract class BaseAnalytics {
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
         }),
+        originTokenSymbol: data.originTokenSymbol,
+        destinationTokenSymbol: data.destinationTokenSymbol,
       },
     })
   }
@@ -277,6 +351,11 @@ abstract class BaseAnalytics {
     feeToken?: string
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
+    feeTokenSymbol?: string
+    originTokenSymbol?: string
+    destinationTokenSymbol?: string
     [key: string]: any
   }) {
     this.track({
@@ -284,6 +363,7 @@ abstract class BaseAnalytics {
       props: {
         ...this.getCommonProps(),
         quoteId: pseudonymize(data.quoteId),
+        checkoutId: getCheckoutId(),
         totalFeeUSD: data.totalFeeUSD?.toString(),
         trailsFixedFeeUSD: data.trailsFixedFeeUSD?.toString(),
         crossChainFeeTotalUSD: data.crossChainFeeTotalUSD?.toString(),
@@ -303,6 +383,9 @@ abstract class BaseAnalytics {
         ...(data.intentAddress && {
           intentAddress: pseudonymize(data.intentAddress),
         }),
+        feeTokenSymbol: data.feeTokenSymbol,
+        originTokenSymbol: data.originTokenSymbol,
+        destinationTokenSymbol: data.destinationTokenSymbol,
       },
     })
   }
@@ -314,18 +397,25 @@ abstract class BaseAnalytics {
     destinationChainId?: number
     originTokenAddress?: string
     destinationTokenAddress?: string
+    mode?: string
+    fundMethod?: string
+    originTokenSymbol?: string
+    destinationTokenSymbol?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.INTENT_QUOTE_ERROR,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
         }),
         originChainId: data.originChainId?.toString(),
         destinationChainId: data.destinationChainId?.toString(),
+        originTokenSymbol: data.originTokenSymbol,
+        destinationTokenSymbol: data.destinationTokenSymbol,
       },
     })
   }
@@ -333,12 +423,15 @@ abstract class BaseAnalytics {
   trackIntentCommitStarted(data: {
     intentAddress: string
     userAddress?: string
+    originTokenSymbol?: string
+    destinationTokenSymbol?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.INTENT_COMMIT_STARTED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         originChainId: data.originChainId?.toString(),
         destinationChainId: data.destinationChainId?.toString(),
@@ -346,6 +439,8 @@ abstract class BaseAnalytics {
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
         }),
+        originTokenSymbol: data.originTokenSymbol,
+        destinationTokenSymbol: data.destinationTokenSymbol,
       },
     })
   }
@@ -353,12 +448,15 @@ abstract class BaseAnalytics {
   trackIntentCommitCompleted(data: {
     intentAddress: string
     userAddress?: string
+    originTokenSymbol?: string
+    destinationTokenSymbol?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.INTENT_COMMIT_COMPLETED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         originChainId: data.originChainId?.toString(),
         destinationChainId: data.destinationChainId?.toString(),
@@ -366,6 +464,8 @@ abstract class BaseAnalytics {
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
         }),
+        originTokenSymbol: data.originTokenSymbol,
+        destinationTokenSymbol: data.destinationTokenSymbol,
       },
     })
   }
@@ -376,12 +476,17 @@ abstract class BaseAnalytics {
     intentAddress?: string
     originChainId?: number
     destinationChainId?: number
+    mode?: string
+    fundMethod?: string
+    originTokenSymbol?: string
+    destinationTokenSymbol?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.INTENT_COMMIT_ERROR,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
@@ -391,6 +496,8 @@ abstract class BaseAnalytics {
         }),
         originChainId: data.originChainId?.toString(),
         destinationChainId: data.destinationChainId?.toString(),
+        originTokenSymbol: data.originTokenSymbol,
+        destinationTokenSymbol: data.destinationTokenSymbol,
       },
     })
   }
@@ -401,12 +508,15 @@ abstract class BaseAnalytics {
     chainId: number
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.TRANSACTION_STARTED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
@@ -423,14 +533,16 @@ abstract class BaseAnalytics {
     transactionHash: string
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.TRANSACTION_SIGNED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
-        transactionHash: pseudonymize(data.transactionHash),
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
         }),
@@ -446,12 +558,15 @@ abstract class BaseAnalytics {
     chainId: number
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.TRANSACTION_SUBMITTED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         transactionHash: pseudonymize(data.transactionHash),
         ...(data.userAddress && {
@@ -470,12 +585,15 @@ abstract class BaseAnalytics {
     blockNumber?: number
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.TRANSACTION_CONFIRMED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         chainId: data.chainId?.toString(),
         transactionHash: pseudonymize(data.transactionHash),
@@ -495,14 +613,16 @@ abstract class BaseAnalytics {
     error: string
     userAddress?: string
     intentAddress?: string
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.TRANSACTION_ERROR,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
-        transactionHash: pseudonymize(data.transactionHash),
         ...(data.userAddress && {
           userAddress: pseudonymize(data.userAddress),
         }),
@@ -518,12 +638,15 @@ abstract class BaseAnalytics {
     walletAddress?: string
     contractAddress?: string
     chainId?: number
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.RELAYER_CALL_STARTED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.walletAddress && {
           walletAddress: pseudonymize(data.walletAddress),
@@ -540,12 +663,15 @@ abstract class BaseAnalytics {
     walletAddress?: string
     contractAddress?: string
     chainId?: number
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.RELAYER_CALL_COMPLETED,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.walletAddress && {
           walletAddress: pseudonymize(data.walletAddress),
@@ -563,12 +689,15 @@ abstract class BaseAnalytics {
     walletAddress?: string
     contractAddress?: string
     chainId?: number
+    mode?: string
+    fundMethod?: string
     [key: string]: any
   }) {
     this.track({
       event: EventType.RELAYER_CALL_ERROR,
       props: {
         ...this.getCommonProps(),
+        checkoutId: getCheckoutId(),
         ...data,
         ...(data.walletAddress && {
           walletAddress: pseudonymize(data.walletAddress),
@@ -623,6 +752,10 @@ class Analytics extends BaseAnalytics {
       console.log("[trails-sdk] Analytics track:", event)
     }
   }
+
+  getSessionId() {
+    return this.databeat.getSessionId()
+  }
 }
 
 class MockAnalytics extends BaseAnalytics {
@@ -633,8 +766,7 @@ class MockAnalytics extends BaseAnalytics {
     this.loggingEnabled = loggingEnabled
   }
 
-  identifyUser({ address }: { address: string }) {
-    console.log("[trails-sdk] MockAnalytics identifyUser:", address)
+  identifyUser(_data: { address: string }) {
     return this
   }
 
@@ -664,27 +796,40 @@ class MockAnalytics extends BaseAnalytics {
       console.log("[trails-sdk] MockAnalytics track:", event)
     }
   }
+
+  getSessionId() {
+    return `0x${Math.random().toString(16).slice(2, 10)}`
+  }
 }
 
-let singleton: Analytics | null = null
+let singleton: Analytics | MockAnalytics | null = null
 
 export const getAnalytics = () => {
-  const debugMode = getQueryParam("analyticsDebug") === "true"
+  if (singleton) {
+    return singleton
+  }
+
+  const debugLocalMode = getQueryParam("analyticsDebugLocal") === "true"
+  const debugProdMode = getQueryParam("analyticsDebugProd") === "true"
   let isLocalhost = true
   if (typeof window !== "undefined") {
     isLocalhost =
       window.location.hostname === "localhost" ||
       window.location.hostname === "127.0.0.1"
   }
-  const enableMockAnalytics = !DATABEAT_KEY || debugMode || isLocalhost
+  const enableMockAnalytics =
+    (!DATABEAT_KEY || debugLocalMode || isLocalhost) && !debugProdMode
   if (enableMockAnalytics) {
-    return new MockAnalytics({ loggingEnabled: true }) // return a dummy analytics object
+    singleton = new MockAnalytics({ loggingEnabled: true }) // return a dummy analytics object
   }
   if (!singleton) {
     singleton = new Analytics(DATABEAT_SERVER, {
       jwt: DATABEAT_KEY,
     })
   }
+
+  console.log("[trails-sdk] Analytics sessionId:", singleton.getSessionId())
+
   return singleton
 }
 
@@ -723,6 +868,8 @@ export const trackPaymentStarted = (data: {
   originTokenAddress?: string
   destinationTokenAddress?: string
   destinationTokenAmount?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -732,6 +879,8 @@ export const trackPaymentStarted = (data: {
 export const trackPaymentCompleted = (data: {
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -742,6 +891,8 @@ export const trackPaymentError = (data: {
   error: string
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -772,6 +923,8 @@ export const trackIntentQuoteRequested = (data: {
   destinationChainId: number
   tokenAddress?: string
   userAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -793,6 +946,8 @@ export const trackIntentQuoteReceived = (data: {
   feeToken?: string
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -806,6 +961,8 @@ export const trackIntentQuoteError = (data: {
   destinationChainId?: number
   originTokenAddress?: string
   destinationTokenAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -817,6 +974,8 @@ export const trackIntentCommitStarted = (data: {
   userAddress?: string
   originChainId?: number
   destinationChainId?: number
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -828,6 +987,8 @@ export const trackIntentCommitCompleted = (data: {
   userAddress?: string
   originChainId?: number
   destinationChainId?: number
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -840,6 +1001,8 @@ export const trackIntentCommitError = (data: {
   intentAddress?: string
   originChainId?: number
   destinationChainId?: number
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -852,6 +1015,8 @@ export const trackTransactionStarted = (data: {
   chainId: number
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -862,6 +1027,8 @@ export const trackTransactionSigned = (data: {
   transactionHash: string
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -873,6 +1040,8 @@ export const trackTransactionSubmitted = (data: {
   chainId: number
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -884,6 +1053,8 @@ export const trackTransactionConfirmed = (data: {
   blockNumber?: number
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -895,6 +1066,8 @@ export const trackTransactionError = (data: {
   error: string
   userAddress?: string
   intentAddress?: string
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -906,6 +1079,8 @@ export const trackRelayerCallStarted = (data: {
   walletAddress?: string
   contractAddress?: string
   chainId?: number
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -916,6 +1091,8 @@ export const trackRelayerCallCompleted = (data: {
   walletAddress?: string
   contractAddress?: string
   chainId?: number
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
@@ -927,8 +1104,15 @@ export const trackRelayerCallError = (data: {
   walletAddress?: string
   contractAddress?: string
   chainId?: number
+  mode?: string
+  fundMethod?: string
   [key: string]: any
 }) => {
   const analytics = getAnalytics()
   analytics.trackRelayerCallError(data)
 }
+
+export function getSessionId() {
+  const analytics = getAnalytics()
+  return analytics.getSessionId()
+}

package/src/apiClient.ts

@@ -1,5 +1,5 @@
 import { useConfig } from "@0xsequence/hooks"
-import { SequenceAPIClient } from "@0xsequence/api"
+import { SequenceAPIClient } from "@0xsequence/trails-api"
 import { useMemo } from "react"
 import { getSequenceApiUrl, getSequenceProjectAccessKey } from "./config.js"
 

package/src/cctpqueue.ts

@@ -1,5 +1,5 @@
 import { getSequenceApiUrl, getSequenceProjectAccessKey } from "./config.js"
-import type { SequenceAPIClient } from "@0xsequence/api"
+import type { SequenceAPIClient } from "@0xsequence/trails-api"
 
 // Narrow API client to one that supports queueing CCTP transfers without using 'any'
 type CctpQueueCapable = {