.env.sample

# Token prices Provider API
# The base Prices Provider API to be used.
# NOTE: For production usage, a paid subscription is recommended.
# (default is https://api.coingecko.com/api/v3 if none is set)
# (Pro account base url is https://pro-api.coingecko.com/api/v3)
# PRICES_PROVIDER_API_BASE_URI=
# The API Key to be used. If none is set, rate limits on the provider side would apply.
# PRICES_PROVIDER_API_KEY=
# The cache TTL for each token price datapoint.
# PRICES_TTL_SECONDS=
# The cache TTL for a missing token price.
# (default is 259200 [72 hours])
# NOT_FOUND_PRICE_TTL_SECONDS=
# Token addresses whose prices should be refresed more often (with HIGH_REFRESH_RATE_TOKENS_TTL_SECONDS TTL).
# (default is [])
# HIGH_REFRESH_RATE_TOKENS=
# The cache TTL for high-refresh-rate token addresses.
# (default is 30)
# HIGH_REFRESH_RATE_TOKENS_TTL_SECONDS=
# The cache TTL for native coins.
# (default is 100)
# NATIVE_COINS_PRICES_TTL_SECONDS=

# RPC Provider
# The RPC provider to be used.
# INFURA_API_KEY=

# Blocklist Encryption

# The encrypted blocklist data
# This contains the list of blocked addresses in encrypted format
# BLOCKLIST_ENCRYPTED_DATA=

# The secret key for decrypting the blocked addresses list
# BLOCKLIST_SECRET_KEY=

# The salt used for key derivation during encryption/decryption
# Use a unique salt per environment
# BLOCKLIST_SECRET_SALT=

# Balances Provider - Zerion API
# Enable Zerion balances provider for all chains
# Set to any value to enable (e.g., 'true'), unset or empty to disable
# For backwards compatibility, FF_ZERION_BALANCES_CHAIN_IDS is also supported
# (default: disabled)
# FF_ZERION_ENABLED=
# The base Zerion API URL to be used.
# (default is https://api.zerion.io if none is set)
# ZERION_BASE_URI=
# The API Key to be used. If none is set, balances cannot be retrieved using this provider.
# The key should be base64 encoded with a `:` appended. Detailed instructions are provided at https://developers.zerion.io/reference/authentication
# ZERION_API_KEY=

# Disables Zerion Positions feature
# FF_ZERION_POSITIONS_DISABLED=

# Push Notifications Provider - Firebase Cloud Messaging
# Firebase API URL
# (default=https://fcm.googleapis.com/v1/projects)
# PUSH_NOTIFICATIONS_API_BASE_URI=
# Firebase project
# PUSH_NOTIFICATIONS_API_PROJECT=
# Firebase service account details for authenticating with Google
# PUSH_NOTIFICATIONS_API_SERVICE_ACCOUNT_CLIENT_EMAIL=
# PUSH_NOTIFICATIONS_API_SERVICE_ACCOUNT_PRIVATE_KEY=

# Relay Provider
# The relay provider to be used.
# (default='https://api.gelato.digital')
# RELAY_PROVIDER_API_BASE_URI=
# (default=5)
# RELAY_THROTTLE_LIMIT=
# The API key to be used per chain.
# RELAY_PROVIDER_API_KEY_OPTIMISM=
# RELAY_PROVIDER_API_KEY_BSC=
# RELAY_PROVIDER_API_KEY_GNOSIS_CHAIN=
# RELAY_PROVIDER_API_KEY_POLYGON=
# RELAY_PROVIDER_API_KEY_POLYGON_ZKEVM=
# RELAY_PROVIDER_API_KEY_BASE=
# RELAY_PROVIDER_API_KEY_ARBITRUM_ONE=
# RELAY_PROVIDER_API_KEY_AVALANCHE=
# RELAY_PROVIDER_API_KEY_LINEA=
# RELAY_PROVIDER_API_KEY_BLAST=
# RELAY_PROVIDER_API_KEY_UNICHAIN=
# RELAY_PROVIDER_API_KEY_SEPOLIA=
# The chain ids to apply daily limit relayer feature (comma-separated chainIds).
# RELAY_DAILY_LIMIT_CHAIN_IDS=11155111
# No-fee duration based on token balance configuration
# If value is zero address, it means native token.
# RELAY_NO_FEE_CAMPAIGN_SEPOLIA_SAFE_TOKEN_ADDRESS=
# RELAY_NO_FEE_CAMPAIGN_SEPOLIA_START_TIMESTAMP=
# RELAY_NO_FEE_CAMPAIGN_SEPOLIA_END_TIMESTAMP=
# RELAY_NO_FEE_CAMPAIGN_SEPOLIA_MAX_GAS_LIMIT=
# RELAY_NO_FEE_CAMPAIGN_SEPOLIA_RELAY_RULES=[{"balanceMin":"0", "balanceMax": "0","limit":0}]
# If value is zero address, it means native token.
# RELAY_NO_FEE_CAMPAIGN_MAINNET_SAFE_TOKEN_ADDRESS=
# RELAY_NO_FEE_CAMPAIGN_MAINNET_START_TIMESTAMP=
# RELAY_NO_FEE_CAMPAIGN_MAINNET_END_TIMESTAMP=
# RELAY_NO_FEE_CAMPAIGN_MAINNET_MAX_GAS_LIMIT=
# RELAY_NO_FEE_CAMPAIGN_MAINNET_RELAY_RULES=[{"balanceMin":"0", "balanceMax": "0","limit":0}]

# Email-sending API
# The application code associated with this service, provided by the email-sending service.
# EMAIL_API_APPLICATION_CODE=
# The API Key to be used.
# EMAIL_API_KEY=
# The email address to be included in the 'from' section of the emails sent.
# EMAIL_API_FROM_EMAIL=
# The email template reference for an unknown recovery transaction notification.
# EMAIL_TEMPLATE_UNKNOWN_RECOVERY_TX=
# The email template reference for a recovery transaction notification.
# EMAIL_TEMPLATE_RECOVERY_TX=
# The email template reference for a verification code sent.
# EMAIL_TEMPLATE_VERIFICATION_CODE=
# The sender name to be included in the 'from' section of the emails sent.
# (default is 'Safe' if none is set)
# EMAIL_API_FROM_NAME=
# The Email Provider API base URL to be used.
# (default is https://api.pushwoosh.com if none is set)
# EMAIL_API_BASE_URI=

# The base url for the Safe Config Service
# Default if none is set: https://safe-config.safe.global
# SAFE_CONFIG_BASE_URI=https://safe-config.safe.global

# The base url for the Safe Locking Service
# Default if none is set: https://safe-locking.safe.global
# LOCKING_PROVIDER_API_BASE_URI=https://safe-locking.safe.global

# Transaction Service API Key (optional, but recommended for local development)
# Set this to avoid rate limiting when running CGW locally with public Tx Service
# Generate keys at: https://developer.5afe.dev/api-keys (staging) or https://developer.safe.global/api-keys (prod)
# TX_SERVICE_API_KEY=dummy

# Redis
# The host name of where the Redis instance is running
# (default=localhost)
# REDIS_HOST=
# The default port of where the Redis instance is running
# (default=6379)
# REDIS_PORT=
# The username of the redis server
# REDIS_USER=
# The password of the redis server
# REDIS_PASS=


# Cache Expiration Times
# The default cache expiration time in seconds if none is set
# (default=60)
# EXPIRATION_TIME_DEFAULT_SECONDS
# The default cache expiration time in seconds for not found errors (default=30)
# DEFAULT_NOT_FOUND_EXPIRE_TIME_SECONDS
# The cache expiration time in seconds for not found contracts errors (default=60)
# CONTRACT_NOT_FOUND_EXPIRE_TIME_SECONDS
# The cache expiration time in seconds for not found tokens errors (default=60)
# TOKEN_NOT_FOUND_EXPIRE_TIME_SECONDS
# The cache expiration time in seconds for defi positions
# EXPIRATION_TIME_POSITIONS_SECONDS

# RabbitMQ / AMQP Queue
# The AMQP server URL
# AMQP_URL=
# The AMQP Exchange name
# AMQP_EXCHANGE_NAME=
# The AMQP queue name
# AMQP_QUEUE=
# The AMQP Exchange mode
# (default=fanout)
# AMQP_EXCHANGE_MODE=
# The message prefetch amount (max non-acknowledged messages being processed)
# (default=100)
# AMQP_PREFETCH=
# The AMQP heartbeat interval in seconds
# (default=60)
# AMQP_HEARBEAT_INTERVAL_SECONDS=
# The AMQP reconnect time in seconds
# (default=5)
# AMQP_RECONNECT_TIME_SECONDS=

# Authorization token to use privileged endpoints.
# The AUTH_TOKEN should always be set
# AUTH_TOKEN=

# The issuer and secret used to sign and verify JWTs.
# The JWT_ISSUER and JWT_SECRET should always be set
# JWT_ISSUER=
# JWT_SECRET=

# Log level for the service.
# LOG_LEVEL=

# Make logs prrety and colorize
# LOG_PRETTY_COLORIZE=

# Targeted Messaging
# TARGETED_MESSAGING_FILE_STORAGE_TYPE=

# Community
# FINGERPRINT_ENCRYPTION_KEY=

# Staking
# STAKING_TESTNET_API_BASE_URI=
# STAKING_TESTNET_API_KEY=
# STAKING_API_BASE_URI=
# STAKING_API_KEY=

# Targeted Messaging
# TARGETED_MESSAGING_FILE_STORAGE_TYPE=

# CSV Export
# CSV_EXPORT_FILE_STORAGE_TYPE=
# The TTL for a signed S3 URL upload.
# (default is 36000 [1 hour])
# CSV_EXPORT_SIGNED_URL_TTL_SECONDS=
# CSV_AWS_ACCESS_KEY_ID=dummy
# CSV_AWS_SECRET_ACCESS_KEY=dummy

# Database

# The ORM query cache status
# (value: true/false)
# (default=false)
# ORM_CACHE_ENABLED=

#BRIDGE_API_KEY=

# CORS
# Enable CORS headers from the API by setting to true (default disabled)
# ALLOW_CORS=false

# Safe Shield
# Blockaid
# BLOCKAID_CLIENT_API_KEY=dummy

# Circuit Breaker Configuration

# Number of failures before the circuit opens
# CIRCUIT_BREAKER_FAILURE_THRESHOLD=

# Number of consecutive successes required to close the circuit from half-open state
# CIRCUIT_BREAKER_SUCCESS_THRESHOLD=

# Time in milliseconds to wait before attempting to close the circuit (timeout period)
# CIRCUIT_BREAKER_TIMEOUT=

# Time window in milliseconds for tracking failures
# CIRCUIT_BREAKER_ROLLING_WINDOW=

# Maximum number of requests allowed in half-open state
# CIRCUIT_BREAKER_HALF_OPEN_MAX_REQUESTS=

# Etherscan API
# ETHERSCAN_BASE_URI=https://api.etherscan.io/v2/api
# Etherscan API key (optional - works without but rate-limited)
# ETHERSCAN_API_KEY=
# Gas price cache TTL in seconds (default=10)
# ETHERSCAN_GAS_PRICE_CACHE_TTL_SECONDS=10