From 6d98bd48dd995a39d5e0265c5e0d96caef7eccbc Mon Sep 17 00:00:00 2001 From: Lorenzo Date: Wed, 11 Dec 2024 11:49:15 +0100 Subject: [PATCH] chore: add `.env.example` (#696) * chore(git): add *.env, !.env.example to .gitignore * chore: .env.example --- .env.example | 30 ++++++++++++++++++++++++++++++ .gitignore | 7 ++++++- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 00000000..864bba07 --- /dev/null +++ b/.env.example @@ -0,0 +1,30 @@ +# General settings +BOOST_LISTEN_ADDR=localhost:18550 # Listen address for mev-boost server + +# Logging and debugging settings +LOG_JSON=false # Set to true to log in JSON format instead of text +DEBUG=false # Set to true to enable debug mode (shorthand for '--loglevel debug') +LOG_LEVEL=info # Log level: trace, debug, info, warn/warning, error, fatal, panic +LOG_SERVICE_TAG= # Optional: add a 'service=...' tag to all log messages +DISABLE_LOG_VERSION=false # Set to true to disable logging the version + +# Genesis settings +GENESIS_FORK_VERSION= # Custom genesis fork version (optional) +GENESIS_TIMESTAMP=-1 # Custom genesis timestamp (in unix seconds) +MAINNET=true # Set to true to use Mainnet +SEPOLIA=false # Set to true to use Sepolia network +HOLESKY=false # Set to true to use Holesky network + +# Relay settings +RELAYS= # Relay URLs: single entry or comma-separated list (scheme://pubkey@host) +RELAY_MONITORS= # Relay monitor URLs: single entry or comma-separated list (scheme://host) +MIN_BID_ETH=0 # Minimum bid to accept from a relay (in ETH) +RELAY_STARTUP_CHECK=false # Set to true to check relay status on startup and on status API call + +# Relay timeout settings (in ms) +RELAY_TIMEOUT_MS_GETHEADER=950 # Timeout for getHeader requests to the relay (in ms) +RELAY_TIMEOUT_MS_GETPAYLOAD=4000 # Timeout for getPayload requests to the relay (in ms) +RELAY_TIMEOUT_MS_REGVAL=3000 # Timeout for registerValidator requests (in ms) + +# Retry settings +REQUEST_MAX_RETRIES=5 # Maximum number of retries for a relay get payload request diff --git a/.gitignore b/.gitignore index 5a0fe029..733ea559 100644 --- a/.gitignore +++ b/.gitignore @@ -27,4 +27,9 @@ .vscode/ /README.internal.md /validator_data.json -/build/ \ No newline at end of file +/build/ + +# Environemnt variable files +.env* +!.env.example +