@exodus/analytics-validation 3.5.0 → 3.6.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.6.0](https://github.com/ExodusMovement/exodus/compare/@exodus/analytics-validation@3.5.0...@exodus/analytics-validation@3.6.0) (2026-09-24)
+
+### Features
+
+- **analytics:** add pay rewards event schemas and joined super property ([#45676](https://github.com/ExodusMovement/exodus/issues/45676)) ([29f7892](https://github.com/ExodusMovement/exodus/commit/29f78924bfafbc2c0dcd5d161a401b4744d5a48c))
+
 ## [3.5.0](https://github.com/ExodusMovement/exodus/compare/@exodus/analytics-validation@3.3.0...@exodus/analytics-validation@3.5.0) (2026-09-23)
 
 ### Features

package/lib/common-properties.schemasafe.json

@@ -429,6 +429,16 @@
     },
     "pay_has_saved_deposit_method": {
       "type": "boolean"
+    },
+    "pay_rewards_joined": {
+      "type": "boolean"
+    },
+    "pay_rewards_available": {
+      "type": "boolean"
+    },
+    "pay_rewards_cohort": {
+      "type": "string",
+      "enum": ["solana", "ethereum", "other_evm", "tron", "none"]
     }
   }
 }

package/lib/events.d.ts

@@ -81,6 +81,9 @@ export type AnalyticsCommonProperties = {
   payHasPayAsDefault?: boolean
   payHasPayAvailable?: boolean
   payHasSavedDepositMethod?: boolean
+  payRewardsJoined?: boolean
+  payRewardsAvailable?: boolean
+  payRewardsCohort?: "solana" | "ethereum" | "other_evm" | "tron" | "none"
 }
 
 export type PredictionsProperties = {
@@ -351,6 +354,7 @@ export interface AnalyticsEventMap {
     portfolioFromAccountSource: string
     portfolioToAccountSource: string
     userAmountFromUsd: number
+    rewardsPointsEstimate?: number | null
   }
   "ExchangeSwapUnavailableView": {
     userAssetTo: string
@@ -1112,6 +1116,59 @@ export interface AnalyticsEventMap {
     isAnyAmount?: boolean
   }
   "PayRequestView": {}
+  "PayRewardsBannerDismiss": {
+    invitation?: "new" | "existing"
+  }
+  "PayRewardsBannerView": {
+    surface?: "wallet_carousel" | "pay_home"
+    invitation?: "new" | "existing"
+  }
+  "PayRewardsDashboardView": {
+    entryPoint?: "pay_home_card" | "wallet_banner" | "onboarding" | "settings"
+    pointsTotal?: number
+    pointsPending?: number
+    canRedeem?: boolean
+  }
+  "PayRewardsDisable": {}
+  "PayRewardsJoin": {
+    entryPoint?: "wallet_banner" | "pay_home_card" | "settings" | "dashboard_info" | "disable_sheet" | "cash_banner"
+    introVariant?: "new_user" | "existing_pay_user"
+    eligibleAssetCount?: number
+    eligibleBalanceUsd?: number
+    networkFeeUsd?: number | null
+    feeReimbursementPoints?: number | null
+  }
+  "PayRewardsOnboardingDismiss": {
+    stepName?: "welcome_preview" | "intro" | "store" | "benefits" | "join" | "welcome"
+    dismissMethod?: "swipe_down" | "back" | "close" | "not_now"
+    consentToggled?: boolean
+    entryPoint?: "wallet_banner" | "pay_home_card" | "settings" | "dashboard_info" | "disable_sheet" | "cash_banner"
+    introVariant?: "new_user" | "existing_pay_user"
+  }
+  "PayRewardsOnboardingView": {
+    stepName?: "welcome_preview" | "intro" | "store" | "benefits" | "join" | "welcome"
+    entryPoint?: "wallet_banner" | "pay_home_card" | "settings" | "dashboard_info" | "disable_sheet" | "cash_banner"
+    introVariant?: "new_user" | "existing_pay_user"
+    isInformational?: boolean
+    resumed?: boolean
+    creditStatus?: "estimated" | "confirmed" | "delayed" | "error" | null
+    points?: number | null
+  }
+  "PayRewardsRedeem": {
+    success?: boolean
+    points?: number | null
+    amountUsd?: number | null
+    errorType?: "insufficient_points" | "conversion_disabled" | "network" | "other" | null
+  }
+  "PayRewardsTermsView": {
+    entryPoint?: "wallet_banner" | "pay_home_card" | "settings" | "dashboard_info" | "disable_sheet" | "cash_banner"
+  }
+  "PayRewardsWishlistSubmit": {
+    storeSelected?: Array<string>
+    wishlistSelected?: Array<string>
+    entryPoint?: "wallet_banner" | "pay_home_card" | "settings" | "dashboard_info" | "disable_sheet" | "cash_banner"
+    introVariant?: "new_user" | "existing_pay_user"
+  }
   "PayWithdrawAddressView": {
     tokenType?: "stablecoin" | "crypto"
   }

package/lib/exchange/exchange-swap.schemasafe.json

@@ -30,6 +30,9 @@
         },
         "user_amount_from_usd": {
           "type": "number"
+        },
+        "rewards_points_estimate": {
+          "type": ["number", "null"]
         }
       },
       "unevaluatedProperties": false

package/lib/main.schemasafe.json

@@ -638,6 +638,36 @@
                 {
                     "$ref": "pay-request-view#"
                 },
+                {
+                    "$ref": "pay-rewards-banner-dismiss#"
+                },
+                {
+                    "$ref": "pay-rewards-banner-view#"
+                },
+                {
+                    "$ref": "pay-rewards-dashboard-view#"
+                },
+                {
+                    "$ref": "pay-rewards-disable#"
+                },
+                {
+                    "$ref": "pay-rewards-join#"
+                },
+                {
+                    "$ref": "pay-rewards-onboarding-dismiss#"
+                },
+                {
+                    "$ref": "pay-rewards-onboarding-view#"
+                },
+                {
+                    "$ref": "pay-rewards-redeem#"
+                },
+                {
+                    "$ref": "pay-rewards-terms-view#"
+                },
+                {
+                    "$ref": "pay-rewards-wishlist-submit#"
+                },
                 {
                     "$ref": "pay-withdraw-address-view#"
                 },

package/lib/pay/pay-rewards-banner-dismiss.schemasafe.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsBannerDismiss"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "invitation": {
+          "type": "string",
+          "enum": ["new", "existing"]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-banner-view.schemasafe.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsBannerView"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "surface": {
+          "type": "string",
+          "enum": ["wallet_carousel", "pay_home"]
+        },
+        "invitation": {
+          "type": "string",
+          "enum": ["new", "existing"]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-dashboard-view.schemasafe.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsDashboardView"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "entry_point": {
+          "type": "string",
+          "enum": ["pay_home_card", "wallet_banner", "onboarding", "settings"]
+        },
+        "points_total": {
+          "type": "number"
+        },
+        "points_pending": {
+          "type": "number"
+        },
+        "can_redeem": {
+          "type": "boolean"
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-disable.schemasafe.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsDisable"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {},
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-join.schemasafe.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsJoin"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "entry_point": {
+          "type": "string",
+          "enum": [
+            "wallet_banner",
+            "pay_home_card",
+            "settings",
+            "dashboard_info",
+            "disable_sheet",
+            "cash_banner"
+          ]
+        },
+        "intro_variant": {
+          "type": "string",
+          "enum": ["new_user", "existing_pay_user"]
+        },
+        "eligible_asset_count": {
+          "type": "number"
+        },
+        "eligible_balance_usd": {
+          "type": "number"
+        },
+        "network_fee_usd": {
+          "type": ["number", "null"]
+        },
+        "fee_reimbursement_points": {
+          "type": ["number", "null"]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-onboarding-dismiss.schemasafe.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsOnboardingDismiss"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "step_name": {
+          "type": "string",
+          "enum": ["welcome_preview", "intro", "store", "benefits", "join", "welcome"]
+        },
+        "dismiss_method": {
+          "type": "string",
+          "enum": ["swipe_down", "back", "close", "not_now"]
+        },
+        "consent_toggled": {
+          "type": "boolean"
+        },
+        "entry_point": {
+          "type": "string",
+          "enum": [
+            "wallet_banner",
+            "pay_home_card",
+            "settings",
+            "dashboard_info",
+            "disable_sheet",
+            "cash_banner"
+          ]
+        },
+        "intro_variant": {
+          "type": "string",
+          "enum": ["new_user", "existing_pay_user"]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-onboarding-view.schemasafe.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsOnboardingView"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "step_name": {
+          "type": "string",
+          "enum": ["welcome_preview", "intro", "store", "benefits", "join", "welcome"]
+        },
+        "entry_point": {
+          "type": "string",
+          "enum": [
+            "wallet_banner",
+            "pay_home_card",
+            "settings",
+            "dashboard_info",
+            "disable_sheet",
+            "cash_banner"
+          ]
+        },
+        "intro_variant": {
+          "type": "string",
+          "enum": ["new_user", "existing_pay_user"]
+        },
+        "is_informational": {
+          "type": "boolean"
+        },
+        "resumed": {
+          "type": "boolean"
+        },
+        "credit_status": {
+          "type": ["string", "null"],
+          "enum": ["estimated", "confirmed", "delayed", "error", null]
+        },
+        "points": {
+          "type": ["number", "null"]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-redeem.schemasafe.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsRedeem"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "success": {
+          "type": "boolean"
+        },
+        "points": {
+          "type": ["number", "null"]
+        },
+        "amount_usd": {
+          "type": ["number", "null"]
+        },
+        "error_type": {
+          "type": ["string", "null"],
+          "enum": ["insufficient_points", "conversion_disabled", "network", "other", null]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-terms-view.schemasafe.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsTermsView"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "entry_point": {
+          "type": "string",
+          "enum": [
+            "wallet_banner",
+            "pay_home_card",
+            "settings",
+            "dashboard_info",
+            "disable_sheet",
+            "cash_banner"
+          ]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/lib/pay/pay-rewards-wishlist-submit.schemasafe.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "event": {
+      "const": "PayRewardsWishlistSubmit"
+    },
+    "properties": {
+      "allOf": [
+        {
+          "$ref": "common-properties#"
+        }
+      ],
+      "type": "object",
+      "required": [],
+      "properties": {
+        "store_selected": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "wishlist_selected": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "entry_point": {
+          "type": "string",
+          "enum": [
+            "wallet_banner",
+            "pay_home_card",
+            "settings",
+            "dashboard_info",
+            "disable_sheet",
+            "cash_banner"
+          ]
+        },
+        "intro_variant": {
+          "type": "string",
+          "enum": ["new_user", "existing_pay_user"]
+        }
+      },
+      "unevaluatedProperties": false
+    }
+  },
+  "unevaluatedProperties": false,
+  "required": ["event", "properties"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/analytics-validation",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "type": "module",
   "description": "JSON schemas for analytics events, to prevent sensitive data from being sent up to the infamous cloud",
   "author": "Exodus Movement, Inc.",
@@ -56,5 +56,5 @@
     "access": "public",
     "provenance": false
   },
-  "gitHead": "167b6409ba2ff5e24dc84704f7cef7e1c8f66056"
+  "gitHead": "b050f5f6f7c57ca329ca7e7d15524c787c2f4ad7"
 }