builds.yml

# TODO(ritave): Add support for environments (<root>/development/build/constants.js:@ENVIRONMENT)
# TODO(ritave): Add support for build targets (<root>/development/build/constants.js:@BUILD_TARGETS)
# TODO(ritave): Warn if not all of declared variables have been defined / used

# The priority order of variable definitions (most important to least important):
# <hardcoded build code>; <environmental variables>; .metamaskprodrc; .metamaskrc; builds.yml:.buildTypes.<type>.env; builds.yml:.features.<feature>.env; builds.yml:.env

# The build type to use when no build type provided in the cli
default: &default main

# Declaration of build types
# Each build type is composed of features, env variables and assets.
# Also known as productFlavors in Android lingo
# Note: These build types should be kept in sync with the list in `.github/workflows/update-lavamoat-policies.yml`
buildTypes:
  main:
    id: 10
    features:
      - keyring-snaps
      - multi-srp
      - bitcoin
      - tron
    # Additional env variables that are specific to this build
    env:
      - INFURA_PROD_PROJECT_ID
      - SEGMENT_PROD_WRITE_KEY
      - INFURA_ENV_KEY_REF: INFURA_PROD_PROJECT_ID
      - SEGMENT_WRITE_KEY_REF: SEGMENT_PROD_WRITE_KEY
      - ALLOW_LOCAL_SNAPS: false
      - REQUIRE_SNAPS_ALLOWLIST: true
      - REJECT_INVALID_SNAPS_PLATFORM_VERSION: true
      - IFRAME_EXECUTION_ENVIRONMENT_URL: https://execution.metamask.io/iframe/11.0.1/index.html
      - ACCOUNT_SNAPS_DIRECTORY_URL: https://snaps.metamask.io/account-management
      - EXTENSION_UX_PNA25: true
      # for seedless onboarding (social login)
      - GOOGLE_PROD_CLIENT_ID
      - APPLE_PROD_CLIENT_ID
      - GOOGLE_CLIENT_ID_REF: GOOGLE_PROD_CLIENT_ID
      - APPLE_CLIENT_ID_REF: APPLE_PROD_CLIENT_ID
      - PERPS_ENABLED: true
    # Main build uses the default browser manifest
    manifestOverrides: false
    # Build name used in multiple user-readable places
    # eg. eip6963
    buildNameOverride: MetaMask

  beta:
    id: 11
    features:
      - build-beta
      - keyring-snaps
      - bitcoin
      - multi-srp
      - tron
    env:
      - INFURA_BETA_PROJECT_ID
      - SEGMENT_BETA_WRITE_KEY
      - INFURA_ENV_KEY_REF: INFURA_BETA_PROJECT_ID
      - SEGMENT_WRITE_KEY_REF: SEGMENT_BETA_WRITE_KEY
      - SUPPORT_LINK: https://intercom.help/internal-beta-testing/
      - ALLOW_LOCAL_SNAPS: false
      - REQUIRE_SNAPS_ALLOWLIST: true
      - REJECT_INVALID_SNAPS_PLATFORM_VERSION: true
      - IFRAME_EXECUTION_ENVIRONMENT_URL: https://execution.metamask.io/iframe/11.0.1/index.html
      - ACCOUNT_SNAPS_DIRECTORY_URL: https://snaps.metamask.io/account-management
      - EXTENSION_UX_PNA25: true
      # for seedless onboarding (social login)
      - GOOGLE_BETA_CLIENT_ID
      - APPLE_BETA_CLIENT_ID
      - GOOGLE_CLIENT_ID_REF: GOOGLE_BETA_CLIENT_ID
      - APPLE_CLIENT_ID_REF: APPLE_BETA_CLIENT_ID
    # Modifies how the version is displayed.
    # eg. instead of 10.25.0 -> 10.25.0-beta.2
    isPrerelease: true
    # Folder which contains overrides to browser manifests
    manifestOverrides: ./app/build-types/beta/manifest/
    buildNameOverride: MetaMask Beta

  experimental:
    id: 12
    features:
      - build-experimental
      - keyring-snaps
      - multi-srp
      - bitcoin
      - tron
    env:
      - INFURA_EXPERIMENTAL_PROJECT_ID
      - SEGMENT_EXPERIMENTAL_WRITE_KEY
      - INFURA_ENV_KEY_REF: INFURA_EXPERIMENTAL_PROJECT_ID
      - SEGMENT_WRITE_KEY_REF: SEGMENT_EXPERIMENTAL_WRITE_KEY
      - ALLOW_LOCAL_SNAPS: false
      - REQUIRE_SNAPS_ALLOWLIST: true
      - REJECT_INVALID_SNAPS_PLATFORM_VERSION: true
      - IFRAME_EXECUTION_ENVIRONMENT_URL: https://execution.metamask.io/iframe/11.0.1/index.html
      - ACCOUNT_SNAPS_DIRECTORY_URL: https://snaps.metamask.io/account-management
      - EXTENSION_UX_PNA25: true
      # for seedless onboarding (social login)
      - GOOGLE_EXPERIMENTAL_CLIENT_ID
      - APPLE_EXPERIMENTAL_CLIENT_ID
      - GOOGLE_CLIENT_ID_REF: GOOGLE_EXPERIMENTAL_CLIENT_ID
      - APPLE_CLIENT_ID_REF: APPLE_EXPERIMENTAL_CLIENT_ID
      - ENABLE_SETTINGS_PAGE_DEV_OPTIONS: true
      - PERPS_ENABLED: true
    isPrerelease: true
    manifestOverrides: app/build-types/experimental/manifest
    buildNameOverride: MetaMask Experimental

  flask:
    id: 15
    # Code surrounded using code fences for that feature
    # will not be removed
    features:
      - build-flask
      - keyring-snaps
      - bitcoin
      - tron
      - multi-srp
    env:
      - INFURA_FLASK_PROJECT_ID
      - SEGMENT_FLASK_WRITE_KEY
      - ALLOW_LOCAL_SNAPS: true
      - REQUIRE_SNAPS_ALLOWLIST: false
      - REJECT_INVALID_SNAPS_PLATFORM_VERSION: false
      - IFRAME_EXECUTION_ENVIRONMENT_URL: https://execution.metamask.io/iframe/11.0.1/index.html
      - SUPPORT_LINK: https://support.metamask.io/?utm_source=extension
      - INFURA_ENV_KEY_REF: INFURA_FLASK_PROJECT_ID
      - SEGMENT_WRITE_KEY_REF: SEGMENT_FLASK_WRITE_KEY
      - ACCOUNT_SNAPS_DIRECTORY_URL: https://metamask.github.io/snaps-directory-staging/main/account-management
      - EIP_4337_ENTRYPOINT: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789'
      - EXTENSION_UX_PNA25: true
      # for seedless onboarding (social login)
      - GOOGLE_FLASK_CLIENT_ID
      - APPLE_FLASK_CLIENT_ID
      - GOOGLE_CLIENT_ID_REF: GOOGLE_FLASK_CLIENT_ID
      - APPLE_CLIENT_ID_REF: APPLE_FLASK_CLIENT_ID
      - GATOR_ENABLED_PERMISSION_TYPES: 'native-token-stream,native-token-periodic,erc20-token-stream,erc20-token-periodic,erc20-token-revocation'
      - GATOR_PERMISSIONS_REVOCATION_ENABLED: true

    isPrerelease: true
    manifestOverrides: ./app/build-types/flask/manifest/
    buildNameOverride: MetaMask Flask

# Build types are composed of a set of features.
# Each feature can have code fences that add new code
# as well declaring, defining and overriding env variables
features:
  ###
  # Build Type code extensions. Things like different support links, warning pages, banners
  ###

  build-beta:
    assets:
      # Assets that will be copied
      - src: ./app/build-types/beta/images/
        dest: images
      # Assets that are exclusively included in this feature and ignored in others
      # Supports globs
      - ./{app,shared,ui}/**/beta/**
  build-flask:
    assets:
      - src: ./node_modules/@metamask/account-watcher/dist/preinstalled-snap.json
        dest: snaps/account-watcher.json
      - src: ./node_modules/@metamask/preinstalled-example-snap/dist/preinstalled-snap.json
        dest: snaps/preinstalled-example-snap.json
      - src: ./app/build-types/flask/images/
        dest: images
      - ./{app,shared,ui}/**/flask/**
  # TODO: remove keyring-snaps section
  keyring-snaps:
    assets:
      - src: ./node_modules/@metamask/message-signing-snap/dist/preinstalled-snap.json
        dest: snaps/message-signing-snap.json
      - src: ./node_modules/@metamask/ens-resolver-snap/dist/preinstalled-snap.json
        dest: snaps/ens-resolver-snap.json
      - src: ./node_modules/@metamask/institutional-wallet-snap/dist/preinstalled-snap.json
        dest: snaps/institutional-wallet-snap.json
      - src: ./node_modules/@metamask/solana-wallet-snap/dist/preinstalled-snap.json
        dest: snaps/solana-wallet-snap.json
      - src: ./node_modules/@metamask/permissions-kernel-snap/dist/preinstalled-snap.json
        dest: snaps/permissions-kernel-snap.json
      - src: ./node_modules/@metamask/gator-permissions-snap/dist/preinstalled-snap.json
        dest: snaps/gator-permissions-snap.json
      - ./{app,shared,ui}/**/keyring-snaps/**
  # TODO: remove bitcoin section
  bitcoin:
    assets:
      - src: ./node_modules/@metamask/bitcoin-wallet-snap/dist/preinstalled-snap.json
        dest: snaps/bitcoin-wallet-snap.json
  # TODO: remove tron section
  tron:
    assets:
      - src: ./node_modules/@metamask/tron-wallet-snap/dist/preinstalled-snap.json
        dest: snaps/tron-wallet-snap.json
  multi-srp:
    assets:
      # srp-list is a special case and is used in the srp recovery flow now.
      - ./{app,shared,ui}/**/multi-srp/(?!.*srp-list)/**
  build-experimental:
    assets:
      - src: ./node_modules/@metamask/account-watcher/dist/preinstalled-snap.json
        dest: snaps/account-watcher.json

# Env variables that are required for all types of builds
#
# env object supports both declarations (- FOO), and definitions (- FOO: BAR).
# Variables that were declared have to be defined somewhere in the load chain before usage
env:
  - ENABLE_SENTRY: true
  - ACCOUNTS_USE_DEV_APIS: false
  - BRIDGE_USE_DEV_APIS: false
  - SWAPS_USE_DEV_APIS: false
  - PORTFOLIO_URL: https://app.metamask.io
  - TOKEN_ALLOWANCE_IMPROVEMENTS: false
  - TRANSACTION_SECURITY_PROVIDER: false
  # The unlock password
  - PASSWORD: null
  - TEST_SRP: null
  - WITH_STATE: null
  # Also see METAMASK_DEBUG and NODE_DEBUG
  - DEBUG: null
  - METAMASK_REACT_REDUX_DEVTOOLS: null
  - SUPPORT_LINK: https://support.metamask.io/?utm_source=extension
  - SKIP_BACKGROUND_INITIALIZATION: false
  - PPOM_URI: ./ppom_bg.wasm
  # CDN for blockaid files
  - BLOCKAID_FILE_CDN: static.cx.metamask.io/api/v1/confirmations/ppom
  # Blockaid public key for verifying signatures of data files downloaded from CDN
  - BLOCKAID_PUBLIC_KEY: 066ad3e8af5583385e312c156d238055215d5f25247c1e91055afa756cb98a88
  - ENABLE_MV3: true
  # These are exclusively used for MV3
  - USE_SNOW
  - APPLY_LAVAMOAT
  - FILE_NAMES

  # This variable is read by Trezor's source and breaks build if not included
  - ASSET_PREFIX: null
  - SUITE_TYPE: null
  - COMMITHASH: null
  - VERSION: null
  - IS_CODESIGN_BUILD: null

  ###
  # Storybook
  ###
  - STORYBOOK: false
  - INFURA_STORYBOOK_PROJECT_ID

  ###
  # Core Backend Services
  ###
  - MM_BACKEND_WEBSOCKET_URL: wss://gateway.api.cx.metamask.io/v1

  ###
  # Notifications Feature
  ###
  - AUTH_API: https://authentication.api.cx.metamask.io
  - OIDC_API: https://oidc.api.cx.metamask.io
  - OIDC_CLIENT_ID: 1132f10a-b4e5-4390-a5f2-d9c6022db564
  - OIDC_GRANT_TYPE: urn:ietf:params:oauth:grant-type:jwt-bearer
  - USER_STORAGE_API: https://user-storage.api.cx.metamask.io
  - CONTENTFUL_ACCESS_SPACE_ID:
  - CONTENTFUL_ACCESS_TOKEN:
  - NOTIFICATIONS_SERVICE_URL: https://notification.api.cx.metamask.io
  - TRIGGERS_SERVICE_URL: https://trigger.api.cx.metamask.io
  - PUSH_NOTIFICATIONS_SERVICE_URL: https://push.api.cx.metamask.io
  - VAPID_KEY:
  - FIREBASE_API_KEY:
  - FIREBASE_AUTH_DOMAIN:
  - FIREBASE_STORAGE_BUCKET:
  - FIREBASE_PROJECT_ID:
  - FIREBASE_MESSAGING_SENDER_ID:
  - FIREBASE_APP_ID:
  - FIREBASE_MEASUREMENT_ID:
  - __FIREBASE_DEFAULTS__: null

  ###
  # RPC Failover
  ###

  - QUICKNODE_MAINNET_URL: null
  - QUICKNODE_LINEA_MAINNET_URL: null
  - QUICKNODE_ARBITRUM_URL: null
  - QUICKNODE_AVALANCHE_URL: null
  - QUICKNODE_OPTIMISM_URL: null
  - QUICKNODE_POLYGON_URL: null
  - QUICKNODE_BASE_URL: null
  - QUICKNODE_BSC_URL: null
  - QUICKNODE_SEI_URL: null
  - QUICKNODE_MONAD_URL: null
  - QUICKNODE_HYPEREVM_URL: null

  ###
  # API keys to 3rd party services
  ###

  - SEGMENT_HOST: null
  - SENTRY_DSN: null
  - SENTRY_DSN_DEV: null
  - SENTRY_DSN_PERFORMANCE: null
  # also INFURA_PROJECT_ID below

  ###
  # Build system backwards compatibility
  ###

  - INFURA_ENV_KEY_REF
  - SEGMENT_WRITE_KEY_REF

  ###
  # Variables that are modified with hardcoded code
  ###

  # URL of the decoding API used to provide additional data from signature requests
  - DECODING_API_URL: 'https://signature-insights.api.cx.metamask.io/v1'
  # Determines if feature flagged Settings Page - Developer Options should be used
  - ENABLE_SETTINGS_PAGE_DEV_OPTIONS: false
  # Used for debugging changes to the phishing warning page.
  # Modified in <root>/development/build/scripts.js:@getPhishingWarningPageUrl
  - PHISHING_WARNING_PAGE_URL: null
  # Modified in <root>/development/build/scripts.js:@getInfuraProjectId
  - INFURA_PROJECT_ID
  # Modified in <root>/development/build/scripts.js:@getSegmentWriteKey
  - SEGMENT_WRITE_KEY: ''
  # Modified in <root>/development/build/scripts.js:@getAnalyticsDataDeletionSourceId
  - ANALYTICS_DATA_DELETION_SOURCE_ID: null
  # Modified in <root>/development/build/scripts.js:@getAnalyticsDataDeletionEndpoint
  - ANALYTICS_DATA_DELETION_ENDPOINT: null
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  # Also see DEBUG and NODE_DEBUG
  - METAMASK_DEBUG: false
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - IN_TEST
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - METAMASK_ENVIRONMENT
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - METAMASK_VERSION
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - METAMASK_BUILD_TYPE
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - METAMASK_BUILD_NAME
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - METAMASK_BUILD_APP_ID
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - METAMASK_BUILD_ICON
  # Modified in <root>/development/build/scripts.js:@setEnvironmentVariables
  - NODE_ENV
  # Defined by node itself
  # For the purposes of the build system we define it as empty below
  # if it's not inside process.env
  # Also see DEBUG and METAMASK_DEBUG
  - NODE_DEBUG: ''
  # Used by react-devtools-core
  - EDITOR_URL: ''
  # Determines if feature flagged Chain permissions
  - CHAIN_PERMISSIONS: ''
  # Determines if Portfolio View UI should be shown
  - PORTFOLIO_VIEW: 'true'
  # Enables use of test gas fee flow to debug gas fee estimation
  - TEST_GAS_FEE_FLOWS: false
  # Temporary mechanism to enable security alerts API prior to release
  - SECURITY_ALERTS_API_ENABLED: 'true'
  # URL of security alerts API used to validate dApp requests
  - SECURITY_ALERTS_API_URL: 'https://security-alerts.api.cx.metamask.io'

  # Enables the notifications feature within the build:
  - NOTIFICATIONS: ''

  # This will be defined if running a unit test
  - JEST_WORKER_ID: undefined

  - METAMASK_RAMP_API_CONTENT_BASE_URL: https://on-ramp-content.api.cx.metamask.io

  # EIP-7715 Readable Permissions
  - GATOR_ENABLED_PERMISSION_TYPES: 'native-token-stream,native-token-periodic,erc20-token-stream,erc20-token-periodic'
  - PERMISSIONS_KERNEL_SNAP_ID: 'npm:@metamask/permissions-kernel-snap'
  - GATOR_PERMISSIONS_PROVIDER_SNAP_ID: 'npm:@metamask/gator-permissions-snap'
  - GATOR_PERMISSIONS_REVOCATION_ENABLED: true

  # Perps geoblock fallback (comma-separated region codes when remote flag unavailable)
  - MM_PERPS_BLOCKED_REGIONS: null
  # Hyperliquid builder fee wallet addresses (public on-chain addresses, not secrets)
  - MM_PERPS_HL_BUILDER_ADDRESS_MAINNET: '0xea2c82b5aba243ab631c0ce151763d5e38df75b3'
  - MM_PERPS_HL_BUILDER_ADDRESS_TESTNET: null
  # Build-time gate: omit PerpsController and perps RPC when false (mitigation for critical failures)
  - PERPS_ENABLED: false
  # Build-time gate: when false AssetsController is instantiated but state remains empty.
  # When true, the controller populates state (subject to remote feature flag).
  - ASSETS_UNIFIED_STATE_ENABLED: false
  # Build-time gate: when true, hardware wallet onboarding uses the new flow.
  - NEW_HARDWARE_WALLET_ONBOARDING: false

  ###
  # Meta variables
  ###

  # Uses yaml anchors to DRY - https://juju.is/docs/sdk/yaml-anchors-and-aliases
  - METAMASK_BUILD_TYPE_DEFAULT: *default
  # Path to a JSON file that will be used to override the default manifest values.
  - MANIFEST_OVERRIDES: null

  ###
  # Account Abstraction (EIP-4337)
  ###
  - EIP_4337_ENTRYPOINT: null

  ###
  # Enable/disable why did you render debug tool: https://github.com/welldone-software/why-did-you-render
  # This should NEVER be enabled in production since it slows down react
  ###
  - ENABLE_WHY_DID_YOU_RENDER: false

  ###
  # Public key used to verify EIP-7702 contract address signatures set in LaunchDarkly.
  ###
  - EIP_7702_PUBLIC_KEY: '0x3c7a1cCCe462e96D186B8ca9a1BCB2010C3dABa3'

  # Address of DelegationManager smart contract
  - DELEGATION_MANAGER_ADDRESS: '0xdb9B1e94B5b69Df7e401DDbedE43491141047dB3'

  # Address of enforcer used for gasless EIP-7702 transactions
  - GASLESS_7702_ENFORCER_ADDRESS: '0x00e0251aaA263dfE3B3541B758A82D1CBA1c3B6D'

  ###
  # Host to watch for deep links into MetaMask
  ###
  - DEEP_LINK_HOST: 'link.metamask.io'
  ###
  # RAW base64 encoded public key used to verify deep link signatures
  ###
  - DEEP_LINK_PUBLIC_KEY: BD8cWMMR2J33ax8hvSz8LNt99H3wGBPWuAgw+lsfWcBrw4ZtTHFnWyNkbgXglqJOoc+1OA5ZC4kW4GYU/QIeBNA=

  # Enforce simulation balance changes by converting external transactions to delegations.
  - ENABLE_ENFORCED_SIMULATIONS: false

  # Force enforced simulations to apply whenever a transaction has balance
  # changes, bypassing the trust signal check. Intended for local
  # development and QA only; must remain false for production builds.
  - FORCE_ENABLE_SIMULATIONS: false

  # OAuth (Social login)
  - GOOGLE_CLIENT_ID_REF
  - APPLE_CLIENT_ID_REF
  - SEEDLESS_ONBOARDING_ENABLED: 'true'
  - GOOGLE_CLIENT_ID: ''
  - APPLE_CLIENT_ID: ''
  # OAuth (Social login) for UAT(QA) builds
  - GOOGLE_CLIENT_ID_FLASK_UAT: ''
  - APPLE_CLIENT_ID_FLASK_UAT: ''
  - GOOGLE_CLIENT_ID_UAT: ''
  - APPLE_CLIENT_ID_UAT: ''

  # Metamask Shield
  - METAMASK_SHIELD_ENABLED: 'true'

  # Snaps
  - AUTO_UPDATE_PREINSTALLED_SNAPS: 'true'
  # This should only be used for local testing, and should not be enabled in any
  # production builds (including beta and Flask).
  - FORCE_PREINSTALLED_SNAPS: 'false'

  # PNA25 (Privacy Notice)
  - EXTENSION_UX_PNA25: true

  # Authentication (Backup & Sync, Profile metrics...)
  - FORCE_AUTH_MATCH_BUILD: false