Use XDG_STATE_HOME dir if set (#326)

Closes #325

Author: ferranbt

README.md

@@ -110,7 +110,7 @@ docker logs -f $(docker ps | grep contender | cut -d' ' -f1)
 
 ## Common Options
 
-- `--output` (string): The directory where the chain data and artifacts are stored. Defaults to `$HOME/.playground/devnet`
+- `--output` (string): The directory where the chain data and artifacts are stored. Defaults to `$HOME/.local/state/builder-playground/devnet`
 - `--detached` (bool): Run the recipes in the background. Defaults to `false`.
 - `--genesis-delay` (int): The delay in seconds before the genesis block is created. Defaults to `10` seconds
 - `--watchdog` (bool): Enable the watchdog service to monitor the specific chain
@@ -121,7 +121,7 @@ docker logs -f $(docker ps | grep contender | cut -d' ' -f1)
 - `--prefunded-accounts` (string, repeated): Fund this account in addition to static prefunded accounts, the input should the account's private key in hexadecimal format prefixed with 0x, the account is added to L1 and to L2 (if present).
 - `--contender` (bool): Enable [contender](https://github.com/flashbots/contender) spammer. Required to use other contender flags.
   - `--contender.arg` (string): Pass custom args to the contender CLI.
-  Example: `--contender.arg "--tpb 20"`
+    Example: `--contender.arg "--tpb 20"`
   - `--contender.target` (string): Change the default target node to spam. On the `l1` recipe, the default is "el", and on `opstack` it's "op-geth".
 - `--with-prometheus` (bool); Whether to deploy a Prometheus server and gather metrics. Defaults to `false`.
 
@@ -158,6 +158,7 @@ $ builder-playground logs validator
 With single session running, the commands are straightforward.
 
 With multiple sessions running, it's easy to navigate:
+
 - listing: `list` -> pick session `major-hornet` -> `list major-hornet` -> see service list
 - viewing logs: see service `validator` with `logs major-hornet validator`
 
@@ -223,6 +224,7 @@ WithArgs("--metrics", `0.0.0.0:{{Port "metrics" 9090}}`)
 By default, Prometheus scrapes the `/metrics` path, but services can override this by specifying a custom path with `WithLabel("metrics_path", "/custom/path")`. All configured services are automatically registered as scrape targets.
 
 ### Usage
+
 Enable Prometheus for any recipe:
 
 ```bash

examples/op-stack-rollup-boost.md

@@ -8,7 +8,7 @@ First, download the `op-reth` binary:
 $ go run main.go artifacts op-reth
 ```
 
-This will download the op-reth binary and save it under `$HOME/.playground/op-reth-v1.3.12`.
+This will download the op-reth binary and save it under `$HOME/.local/state/builder-playground/op-reth-v1.3.12`.
 
 Second, we can deploy the Op Stack with rollup-boost:
 
@@ -35,9 +35,9 @@ The `--external-builder` flag is used to specify the URL of the external block b
 Third, we can start the `op-reth` binary as the external block builder:
 
 ```bash
-$ $HOME/.playground/op-reth-v1.3.12 node --http --http.port 2222 \
-    --authrpc.addr 0.0.0.0 --authrpc.port 4444 --authrpc.jwtsecret $HOME/.playground/devnet/jwtsecret \
-    --chain $HOME/.playground/devnet/l2-genesis.json --datadir /tmp/builder --disable-discovery --port 30333 \
+$ $HOME/.local/state/builder-playground/op-reth-v1.3.12 node --http --http.port 2222 \
+    --authrpc.addr 0.0.0.0 --authrpc.port 4444 --authrpc.jwtsecret $HOME/.local/state/builder-playground/devnet/jwtsecret \
+    --chain $HOME/.local/state/builder-playground/devnet/l2-genesis.json --datadir /tmp/builder --disable-discovery --port 30333 \
     --trusted-peers enode://79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798483ada7726a3c4655da4fbfc0e1108a8fd17b448a68554199c47d08ffb10d4b8@127.0.0.1:30304
 ```
 

examples/rbuilder-config.toml

@@ -1,15 +1,15 @@
 
-chain = "$HOME/.playground/devnet/genesis.json"
-reth_datadir = "$HOME/.playground/devnet/volume-el-data"
+chain = "$HOME/.local/state/builder-playground/devnet/genesis.json"
+reth_datadir = "$HOME/.local/state/builder-playground/devnet/volume-el-data"
 relay_secret_key = "5eae315483f028b5cdd5d1090ff0c7618b18737ea9bf3c35047189db22835c48"
-el_node_ipc_path = "$HOME/.playground/devnet/volume-el-data/reth.ipc"
+el_node_ipc_path = "$HOME/.local/state/builder-playground/devnet/volume-el-data/reth.ipc"
 live_builders = ["mgp-ordering"]
 enabled_relays = ["playground"]
 log_level = "info,rbuilder=debug"
 coinbase_secret_key = "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
 
-root_hash_use_sparse_trie=true
-root_hash_compare_sparse_trie=false
+root_hash_use_sparse_trie = true
+root_hash_compare_sparse_trie = false
 slot_delta_to_start_bidding_ms = -20000
 
 [[relays]]

main.go

@@ -341,8 +341,15 @@ func runIt(recipe playground.Recipe) error {
 	}
 	logging.ConfigureSlog(logLevelFlag)
 	sessionID := utils.GeneratePetName()
+
+	out, err := playground.NewOutput(outputFlag)
+	if err != nil {
+		return err
+	}
+
 	slog.Info("Welcome to Builder Playground! ⚡️🤖")
 	slog.Info("Session ID: "+greenColor.Sprint(sessionID), "log-level", logLevel)
+	slog.Info("Output folder: " + out.Dst())
 	slog.Info("")
 
 	// parse the overrides
@@ -355,11 +362,6 @@ func runIt(recipe playground.Recipe) error {
 		overrides[parts[0]] = parts[1]
 	}
 
-	out, err := playground.NewOutput(outputFlag)
-	if err != nil {
-		return err
-	}
-
 	slog.Debug("Building artifacts...")
 	builder := recipe.Artifacts()
 	builder.GenesisDelay(genesisDelayFlag)

playground/artifacts.go

@@ -514,6 +514,10 @@ func NewOutput(dst string) (*output, error) {
 	return out, nil
 }
 
+func (o *output) Dst() string {
+	return o.dst
+}
+
 func (o *output) Read(path string) (string, error) {
 	data, err := os.ReadFile(filepath.Join(o.dst, path))
 	if err != nil {
@@ -699,8 +703,18 @@ func GetHomeDir() (string, error) {
 		return "", fmt.Errorf("error getting user home directory: %w", err)
 	}
 
+	// if legacy .playground dir is present, remove it
+	if err := os.RemoveAll(filepath.Join(homeDir, ".playground")); err != nil {
+		return "", err
+	}
+
+	stateHomeDir := os.Getenv("XDG_STATE_HOME")
+	if stateHomeDir == "" {
+		stateHomeDir = filepath.Join(homeDir, ".local", "state")
+	}
+
 	// Define the path for our custom home directory
-	customHomeDir := filepath.Join(homeDir, ".playground")
+	customHomeDir := filepath.Join(stateHomeDir, "builder-playground")
 
 	// Create output directory if it doesn't exist
 	if err := os.MkdirAll(customHomeDir, 0o755); err != nil {