@l.x/gating 1.0.3 → 1.0.4

package/.depcheckrc

@@ -0,0 +1,13 @@
+ignores: [
+    # Standard ignores
+    "typescript",
+    "@typescript/native-preview",
+    "depcheck",
+
+    # Internal packages / workspaces
+    "@universe/gating",
+    "@universe/config",
+
+    # Peer dependencies
+    "react",
+  ]

package/.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  extends: ['@luxamm/eslint-config/lib'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+  },
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        'no-relative-import-paths/no-relative-import-paths': [
+          'error',
+          {
+            allowSameFolder: false,
+            prefix: '@luxexchange/gating',
+          },
+        ],
+        '@typescript-eslint/prefer-enum-initializers': 'off',
+      },
+    },
+  ],
+}

package/README.md

@@ -0,0 +1,3 @@
+# @universe/gating
+
+// TODO

package/package.json

@@ -1 +1,39 @@
-{"name":"@l.x/gating","version":"1.0.3","description":"LX Exchange - gating","main":"index.js","dependencies":{"@luxexchange/gating":"1.0.3"}}
+{
+  "name": "@l.x/gating",
+  "version": "1.0.4",
+  "dependencies": {
+    "@statsig/client-core": "3.12.2",
+    "@statsig/js-client": "3.12.2",
+    "@statsig/js-local-overrides": "3.12.2",
+    "@statsig/react-bindings": "3.12.2",
+    "@statsig/react-native-bindings": "3.12.2",
+    "@l.x/api": "workspace:*",
+    "@l.x/config": "workspace:*",
+    "@luxfi/utilities": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "22.13.1",
+    "@typescript/native-preview": "7.0.0-dev.20260311.1",
+    "@luxfi/eslint-config": "workspace:^",
+    "depcheck": "1.4.7",
+    "eslint": "8.57.1",
+    "typescript": "5.8.3"
+  },
+  "scripts": {
+    "typecheck": "nx typecheck gating",
+    "typecheck:tsgo": "nx typecheck:tsgo gating",
+    "lint": "nx lint gating",
+    "lint:fix": "nx lint:fix gating",
+    "lint:biome": "nx lint:biome gating",
+    "lint:biome:fix": "nx lint:biome:fix gating",
+    "lint:eslint": "nx lint:eslint gating",
+    "lint:eslint:fix": "nx lint:eslint:fix gating",
+    "check:deps:usage": "nx check:deps:usage gating"
+  },
+  "nx": {
+    "includedScripts": []
+  },
+  "main": "src/index.ts",
+  "private": false,
+  "sideEffects": false
+}

package/project.json

@@ -0,0 +1,18 @@
+{
+  "name": "@l.x/gating",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "pkgs/gating/src",
+  "projectType": "library",
+  "tags": ["scope:gating", "type:lib"],
+  "targets": {
+    "typecheck": {},
+    "typecheck:tsgo": {},
+    "lint:biome": {},
+    "lint:biome:fix": {},
+    "lint:eslint": {},
+    "lint:eslint:fix": {},
+    "lint": {},
+    "lint:fix": {},
+    "check:deps:usage": {}
+  }
+}

package/src/LocalOverrideAdapterWrapper.ts

@@ -0,0 +1,63 @@
+import { LocalOverrideAdapter } from '@statsig/js-local-overrides'
+import { getStatsigClient } from '@l.x/gating/src/sdk/statsig'
+
+// Workaround for @statsig 3.x.x refreshing client after applying overrides to get the result without reloading
+// Should be removed after statsig add real time override apply functionality
+// Adds refresh only to used LocalOverrideAdapter methods. Other methods need to be added if refresh is required.
+export class LocalOverrideAdapterWrapper extends LocalOverrideAdapter {
+  constructor(sdkKey: string) {
+    super(sdkKey)
+  }
+
+  refreshStatsig(): void {
+    const statsigClient = getStatsigClient()
+    const statsigUser = statsigClient.getContext().user
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    statsigClient.updateUserAsync(statsigUser)
+  }
+
+  overrideGate(name: string, value: boolean): void {
+    super.overrideGate(name, value)
+    this.refreshStatsig()
+  }
+
+  removeGateOverride(name: string): void {
+    super.removeGateOverride(name)
+    this.refreshStatsig()
+  }
+
+  overrideDynamicConfig(name: string, value: Record<string, unknown>): void {
+    super.overrideDynamicConfig(name, value)
+    this.refreshStatsig()
+  }
+
+  removeDynamicConfigOverride(name: string): void {
+    super.removeDynamicConfigOverride(name)
+    this.refreshStatsig()
+  }
+
+  removeAllOverrides(): void {
+    super.removeAllOverrides()
+    this.refreshStatsig()
+  }
+
+  removeExperimentOverride(name: string): void {
+    super.removeExperimentOverride(name)
+    this.refreshStatsig()
+  }
+
+  overrideExperiment(name: string, value: Record<string, unknown>): void {
+    super.overrideExperiment(name, value)
+    this.refreshStatsig()
+  }
+
+  overrideLayer(name: string, value: Record<string, unknown>): void {
+    super.overrideLayer(name, value)
+    this.refreshStatsig()
+  }
+
+  removeLayerOverride(name: string): void {
+    super.removeLayerOverride(name)
+    this.refreshStatsig()
+  }
+}

package/src/configs.ts

@@ -0,0 +1,296 @@
+import { GasStrategy } from '@luxfi/api'
+
+// TODO: move to own package
+export enum Locale {
+  Afrikaans = 'af-ZA',
+  ArabicSaudi = 'ar-SA',
+  Catalan = 'ca-ES',
+  ChineseSimplified = 'zh-Hans',
+  ChineseTraditional = 'zh-Hant',
+  CzechCzechia = 'cs-CZ',
+  DanishDenmark = 'da-DK',
+  DutchNetherlands = 'nl-NL',
+  EnglishUnitedStates = 'en-US',
+  FinnishFinland = 'fi-FI',
+  FrenchFrance = 'fr-FR',
+  GreekGreece = 'el-GR',
+  HebrewIsrael = 'he-IL',
+  HindiIndia = 'hi-IN',
+  HungarianHungarian = 'hu-HU',
+  IndonesianIndonesia = 'id-ID',
+  ItalianItaly = 'it-IT',
+  JapaneseJapan = 'ja-JP',
+  KoreanKorea = 'ko-KR',
+  MalayMalaysia = 'ms-MY',
+  NorwegianNorway = 'no-NO',
+  PolishPoland = 'pl-PL',
+  PortugueseBrazil = 'pt-BR',
+  PortuguesePortugal = 'pt-PT',
+  RomanianRomania = 'ro-RO',
+  RussianRussia = 'ru-RU',
+  Serbian = 'sr-SP',
+  SpanishLatam = 'es-419',
+  SpanishBelize = 'es-BZ',
+  SpanishCuba = 'es-CU',
+  SpanishDominicanRepublic = 'es-DO',
+  SpanishGuatemala = 'es-GT',
+  SpanishHonduras = 'es-HN',
+  SpanishMexico = 'es-MX',
+  SpanishNicaragua = 'es-NI',
+  SpanishPanama = 'es-PA',
+  SpanishPeru = 'es-PE',
+  SpanishPuertoRico = 'es-PR',
+  SpanishElSalvador = 'es-SV',
+  SpanishUnitedStates = 'es-US',
+  SpanishArgentina = 'es-AR',
+  SpanishBolivia = 'es-BO',
+  SpanishChile = 'es-CL',
+  SpanishColombia = 'es-CO',
+  SpanishCostaRica = 'es-CR',
+  SpanishEcuador = 'es-EC',
+  SpanishSpain = 'es-ES',
+  SpanishParaguay = 'es-PY',
+  SpanishUruguay = 'es-UY',
+  SpanishVenezuela = 'es-VE',
+  SwahiliTanzania = 'sw-TZ',
+  SwedishSweden = 'sv-SE',
+  TurkishTurkey = 'tr-TR',
+  UkrainianUkraine = 'uk-UA',
+  UrduPakistan = 'ur-PK',
+  VietnameseVietnam = 'vi-VN',
+}
+
+/**
+ * Dynamic Configs
+ * These should match the dynamic config's `Config Name` on Statsig
+ */
+export enum DynamicConfigs {
+  // Shared
+  Swap = 'swap_config',
+  NetworkRequests = 'network_requests',
+  Chains = 'chains',
+  SyncTransactionSubmissionChainIds = 'sync_transaction_submission_chain_ids',
+  BlockedAsyncSubmissionChainIds = 'blocked_async_submission_chain_ids',
+
+  // Wallet
+  HomeScreenExploreTokens = 'home_screen_explore_tokens',
+  ForceUpgrade = 'force_upgrade',
+  OnDeviceRecovery = 'on_device_recovery',
+  UwuLink = 'uwulink_config',
+  GasStrategies = 'gas_strategy',
+  DatadogSessionSampleRate = 'datadog_session_sample_rate',
+  DatadogIgnoredErrors = 'datadog_ignored_errors',
+  EmbeddedWalletConfig = 'embedded_wallet_config',
+  ExtensionBiometricUnlock = 'extension_biometric_unlock_config',
+
+  // Web
+  AstroChain = 'astro_chain',
+  EmbeddedWalletBetaPassphrases = 'embedded_wallet_beta_passphrases',
+  ExternallyConnectableExtension = 'externally_connectable_extension',
+  LPConfig = 'lp_config',
+  AllowedV4WethHookAddresses = 'allowed_v4_weth_hook_addresses',
+  OutageBannerChainId = 'outage_banner_chain_id',
+  VerifiedAuctions = 'verified_auctions',
+  CreateAuction = 'create_auction_config',
+}
+
+// Config values go here for easy access
+
+// Shared
+export enum SwapConfigKey {
+  AverageL1BlockTimeMs = 'averageL1BlockTimeMs',
+  AverageL2BlockTimeMs = 'averageL2BlockTimeMs',
+  TradingApiSwapRequestMs = 'tradingApiSwapRequestMs',
+
+  MinAutoSlippageToleranceL2 = 'minAutoSlippageToleranceL2',
+
+  EthSwapMinGasAmount = 'ethSwapMinGasAmount',
+  EthSendMinGasAmount = 'ethSendMinGasAmount',
+  PolygonSwapMinGasAmount = 'polygonSwapMinGasAmount',
+  PolygonSendMinGasAmount = 'polygonSendMinGasAmount',
+  AvalancheSwapMinGasAmount = 'avalancheSwapMinGasAmount',
+  AvalancheSendMinGasAmount = 'avalancheSendMinGasAmount',
+  CeloSwapMinGasAmount = 'celoSwapMinGasAmount',
+  CeloSendMinGasAmount = 'celoSendMinGasAmount',
+  MonSwapMinGasAmount = 'monSwapMinGasAmount',
+  MonSendMinGasAmount = 'monSendMinGasAmount',
+  SolanaSwapMinGasAmount = 'solanaSwapMinGasAmount',
+  SolanaSendMinGasAmount = 'solanaSendMinGasAmount',
+  GenericL2SwapMinGasAmount = 'genericL2SwapMinGasAmount',
+  GenericL2SendMinGasAmount = 'genericL2SendMinGasAmount',
+
+  LowBalanceWarningGasPercentage = 'lowBalanceWarningGasPercentage',
+}
+
+export enum NetworkRequestsConfigKey {
+  BalanceMaxRefetchAttempts = 'balanceMaxRefetchAttempts',
+}
+
+export enum ChainsConfigKey {
+  OrderedChainIds = 'orderedChainIds',
+  NewChainIds = 'newChainIds',
+}
+
+// Wallet
+export enum ForceUpgradeConfigKey {
+  Status = 'status',
+  Translations = 'translations',
+}
+
+export type ForceUpgradeStatus = 'recommended' | 'required' | 'not-required'
+
+type SupportedLocale = `${Extract<Locale[keyof Locale], string>}`
+
+type ContentMessage = {
+  title: string
+  description: string
+}
+
+export type ForceUpgradeTranslations = Record<SupportedLocale, ContentMessage>
+
+export enum EmbeddedWalletConfigKey {
+  BaseUrl = 'baseUrl',
+}
+
+export enum ExtensionBiometricUnlockConfigKey {
+  EnableOnboardingEnrollment = 'enableOnboardingEnrollment',
+  EnableSettingsEnrollment = 'enableSettingsEnrollment',
+  EnableUnlocking = 'enableUnlocking',
+}
+
+export enum SyncTransactionSubmissionChainIdsConfigKey {
+  ChainIds = 'chainIds',
+}
+
+export enum BlockedAsyncSubmissionChainIdsConfigKey {
+  ChainIds = 'chainIds',
+}
+
+export enum HomeScreenExploreTokensConfigKey {
+  EthChainId = 'ethChainId',
+  Tokens = 'tokens',
+}
+
+export enum OnDeviceRecoveryConfigKey {
+  AppLoadingTimeoutMs = 'appLoadingTimeoutMs',
+  MaxMnemonicsToLoad = 'maxMnemonicsToLoad',
+}
+
+export enum UwuLinkConfigKey {
+  Allowlist = 'allowlist',
+}
+
+export enum DatadogIgnoredErrorsConfigKey {
+  Errors = 'errors',
+}
+
+export enum DatadogSessionSampleRateKey {
+  Rate = 'rate',
+}
+
+export enum ExternallyConnectableExtensionConfigKey {
+  ExtensionId = 'extensionId',
+}
+
+export type DatadogIgnoredErrorsValType = Array<{ messageContains: string; sampleRate: number }>
+
+export type DatadogSessionSampleRateValType = number
+
+export type GasStrategyType = 'general' | 'swap'
+
+export type GasStrategyConditions = {
+  name: string
+  chainId: number
+  types: GasStrategyType
+  isActive: boolean
+}
+
+export type GasStrategyWithConditions = {
+  strategy: GasStrategy
+  conditions: GasStrategyConditions
+}
+
+export type GasStrategies = {
+  strategies: GasStrategyWithConditions[]
+}
+
+// Web
+export enum QuickRouteChainsConfigKey {
+  Chains = 'quick_route_chains',
+}
+
+export enum AstroChainConfigKey {
+  Url = 'url',
+}
+
+export enum LPConfigKey {
+  DefaultSlippage = 'defaultSlippage',
+  V4SlippageOverride = 'v4SlippageOverride',
+}
+
+export enum AllowedV4WethHookAddressesConfigKey {
+  HookAddresses = 'hookAddresses',
+}
+
+export enum VerifiedAuctionsConfigKey {
+  VerifiedAuctionIds = 'verifiedAuctionIds',
+}
+
+export enum OutageBannerChainIdConfigKey {
+  ChainId = 'chainId',
+}
+
+export enum CreateAuctionConfigKey {
+  AllowedNetworks = 'allowedNetworks',
+  AllowedTokenCreationNetworks = 'allowedTokenCreationNetworks',
+}
+
+export enum EmbeddedWalletBetaPassphrasesKey {
+  Passphrases = 'passphrases',
+}
+
+export type DynamicConfigKeys = {
+  // Shared
+  [DynamicConfigs.Swap]: SwapConfigKey
+  [DynamicConfigs.NetworkRequests]: NetworkRequestsConfigKey
+  [DynamicConfigs.Chains]: ChainsConfigKey
+
+  // Wallet
+  [DynamicConfigs.HomeScreenExploreTokens]: HomeScreenExploreTokensConfigKey
+  [DynamicConfigs.ForceUpgrade]: ForceUpgradeConfigKey
+  [DynamicConfigs.OnDeviceRecovery]: OnDeviceRecoveryConfigKey
+  [DynamicConfigs.UwuLink]: UwuLinkConfigKey
+  [DynamicConfigs.DatadogIgnoredErrors]: DatadogIgnoredErrorsConfigKey
+  [DynamicConfigs.DatadogSessionSampleRate]: DatadogSessionSampleRateKey
+  [DynamicConfigs.EmbeddedWalletConfig]: EmbeddedWalletConfigKey
+  [DynamicConfigs.ExtensionBiometricUnlock]: ExtensionBiometricUnlockConfigKey
+  [DynamicConfigs.SyncTransactionSubmissionChainIds]: SyncTransactionSubmissionChainIdsConfigKey
+
+  // Web
+  [DynamicConfigs.AstroChain]: AstroChainConfigKey
+  [DynamicConfigs.ExternallyConnectableExtension]: ExternallyConnectableExtensionConfigKey
+  [DynamicConfigs.LPConfig]: LPConfigKey
+  [DynamicConfigs.AllowedV4WethHookAddresses]: AllowedV4WethHookAddressesConfigKey
+  [DynamicConfigs.VerifiedAuctions]: VerifiedAuctionsConfigKey
+  [DynamicConfigs.BlockedAsyncSubmissionChainIds]: BlockedAsyncSubmissionChainIdsConfigKey
+  [DynamicConfigs.OutageBannerChainId]: OutageBannerChainIdConfigKey
+  [DynamicConfigs.CreateAuction]: CreateAuctionConfigKey
+  [DynamicConfigs.EmbeddedWalletBetaPassphrases]: EmbeddedWalletBetaPassphrasesKey
+}
+
+// This type must match the format in statsig dynamic config for uwulink
+// https://console.statsig.com/5HjUux4OvSGzgqWIfKFt8i/dynamic_configs/uwulink_config
+export type UwULinkAllowlistItem = {
+  chainId: number
+  address: string
+  name: string
+  logo?: {
+    dark?: string
+    light?: string
+  }
+}
+
+export type UwULinkAllowlist = {
+  contracts: UwULinkAllowlistItem[]
+  tokenRecipients: UwULinkAllowlistItem[]
+}

package/src/constants.ts

@@ -0,0 +1,4 @@
+export enum StatsigCustomAppValue {
+  Mobile = 'mobile',
+  Extension = 'extension',
+}

package/src/experiments.ts

@@ -0,0 +1,83 @@
+/**
+ * Experiment parameter names. Ordered alphabetically.
+ *
+ * These must match parameter names on Statsig within an experiment
+ */
+export enum Experiments {
+  EthAsErc20DEX = 'eth_as_erc20_luxx_experiment',
+  ExploreBackendSorting = 'explore_backend_sorting',
+  NativeTokenPercentageBuffer = 'lp_native_buffer',
+  PrivateRpc = 'private_rpc',
+  SwapConfirmation = 'swap-confirmation',
+  UnichainFlashblocksModal = 'unichain_flashblocks_modal',
+}
+
+export enum Layers {
+  ExplorePage = 'explore-page',
+  SwapPage = 'swap-page',
+}
+
+// experiment groups
+
+export enum NativeTokenPercentageBufferExperimentGroup {
+  Control = 'Control',
+  Buffer1 = 'Buffer1',
+}
+
+// experiment properties
+
+export enum ArbitrumXV2SamplingProperties {
+  RoutingType = 'routingType',
+}
+
+export enum PrivateRpcProperties {
+  FlashbotsEnabled = 'flashbots_enabled',
+  RefundPercent = 'refund_percent',
+}
+
+export enum NativeTokenPercentageBufferProperties {
+  BufferSize = 'bufferSize',
+}
+
+export enum SwapConfirmationProperties {
+  WaitTimes = 'wait_times',
+}
+
+export enum ExploreBackendSortingProperties {
+  BackendSortingEnabled = 'backendSortingEnabled',
+}
+
+// Swap Layer experiment properties
+
+export enum SwapLayerProperties {
+  FlashblocksModalEnabled = 'flashblocksModalEnabled',
+  EthAsErc20DEXEnabled = 'ethAsErc20DEXEnabled',
+  MinEthErc20USDValueThresholdByChain = 'minEthErc20USDValueThresholdByChain',
+}
+
+export enum UnichainFlashblocksProperties {
+  FlashblocksModalEnabled = SwapLayerProperties.FlashblocksModalEnabled,
+}
+
+export enum EthAsErc20DEXProperties {
+  EthAsErc20DEXEnabled = SwapLayerProperties.EthAsErc20DEXEnabled,
+  MinEthErc20USDValueThresholdByChain = SwapLayerProperties.MinEthErc20USDValueThresholdByChain,
+}
+
+// Ordered alphabetically.
+export type ExperimentProperties = {
+  [Experiments.EthAsErc20DEX]: EthAsErc20DEXProperties
+  [Experiments.ExploreBackendSorting]: ExploreBackendSortingProperties
+  [Experiments.NativeTokenPercentageBuffer]: NativeTokenPercentageBufferProperties
+  [Experiments.PrivateRpc]: PrivateRpcProperties
+  [Experiments.SwapConfirmation]: SwapConfirmationProperties
+  [Experiments.UnichainFlashblocksModal]: UnichainFlashblocksProperties
+}
+
+// will be a spread of all experiment properties in that layer
+export const LayerProperties: Record<Layers, string[]> = {
+  [Layers.ExplorePage]: Object.values({
+    ...ExploreBackendSortingProperties,
+  }),
+  [Layers.SwapPage]: Object.values(SwapLayerProperties),
+}