chore: update config docs

[tac0turtle]

Overview

update configs to match latest configs

Summary by CodeRabbit

• Documentation
  • Updated configuration reference with new CLI flag conventions and restructured configuration options for core node, data availability, and instrumentation settings.
  • Added OpenTelemetry tracing instrumentation options including tracing endpoint and sample rate configuration.
  • Introduced new Raft consensus configuration section with node and peer management parameters.
  • Updated signer configuration with file-based passphrase handling.

[github-actions]

The latest Buf updates on your PR. Results from workflow CI / buf-check (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
✅ passed	⏩ skipped	✅ passed	✅ passed	Mar 23, 2026, 2:33 PM

[claude]

Claude finished @tac0turtle's task in 2m 28s —— View job

---

Code Review: chore: update config docs

• Gather context and read changed files
• Verify config values against Go source
• Identify issues and write review

---

Summary

This is a documentation-only PR updating docs/learn/config.md to reflect the latest ev-node configuration. The changes are largely accurate and the rebranding from rollkit. → evnode. flag prefixes is correct throughout. A few issues are worth addressing:

---

Issues Found

1. pruning_keep_recent default is incorrect

File: docs/learn/config.md (line ~441)

The doc states _Default:_ \0`for--evnode.pruning.pruning_keep_recent, but DefaultConfig()inpkg/config/defaults.go:109setsKeepRecent: 100_000`.

// pkg/config/defaults.go:107-111
Pruning: PruningConfig{
    Mode:       PruningModeDisabled,
    KeepRecent: 100_000,   // <-- actual default
    Interval:   DurationWrapper{15 * time.Minute},
},

The doc should read _Default:_ \100000``. Fix this →

2. raft.snap_count — example value may mislead

File: docs/learn/config.md (Raft Snap Count section)

The YAML example shows snap_count: 10000 but the actual default (Go zero value, not set in DefaultConfig()) is 0. The doc correctly states _Default:_ \0`, but a 0snap count is opaque — it's worth clarifying what0` means in practice (e.g., "uses the Raft library's internal default"). Fix this →

3. DA address scheme not mentioned in example

File: docs/learn/config.md (DA Service Address section)

The YAML example shows address: "localhost:26659" (no scheme), but the default is "http://localhost:7980". Users may not realize the address should include the http:// scheme. Consider updating the example to use the full URL format (e.g., "http://localhost:26659") to make this explicit.

---

Positive Changes

• Flag prefix correctly updated from rollkit. → evnode. throughout
• Corrected defaults: lazy_block_interval (30s → 1m), prometheus_listen_addr (:2112 → :26660), max_open_connections (vague → 3), pprof_listen_addr (localhost:6060 → :6060)
• New sections accurately documented: based_sequencer, scrape_interval, catchup_timeout, readiness_window_seconds, readiness_max_blocks_behind, tracing fields, and the full Raft config section
• Correctly removed da_gas_price and da_gas_multiplier (no longer in codebase)
• Signer passphrase renamed to passphrase_file with improved security guidance (read from file, not CLI arg)
• Fixed duplicate/stale ToC entry for "DA Header Namespace"
• pruning_keep_recent note that pruning is safe-by-default and cannot be undone is a good addition

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for configuration options updated with CLI flag prefix changes from --rollkit.* to --evnode.*, renamed configuration keys, new instrumentation and Raft options, and revised defaults across multiple sections including node, data availability, and signer settings.

Changes

Cohort / File(s)

Summary

Configuration Documentation docs/learn/config.md

Updated CLI flag prefixes across all sections from --rollkit.* to --evnode.*; replaced node.max_pending_blocks with node.max_pending_headers_and_data; added new options for based_sequencer, scrape_interval, catchup_timeout, readiness_window_seconds, readiness_max_blocks_behind; expanded data availability config with da.max_submit_attempts and da.forced_inclusion_namespace while removing gas_price and gas_multiplier; added OpenTelemetry tracing options (tracing, tracing_endpoint, tracing_service_name, tracing_sample_rate); modified signer config replacing passphrase with passphrase\_file; introduced new top-level Raft section with node ID, address, directory, bootstrap, peers, and timeout parameters.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 Hop, skip, and bound through the config we go,
From rollkit to evnode, watch the prefixes flow!
New Raft sections sprout, tracing takes flight,
Flags dance and rename themselves overnight,
Documentation blooms with each change, what a delight! 🌿✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description only contains a generic statement without specific details about what configs were updated or why the changes were necessary.	Add comprehensive details explaining the configuration changes, including the migration from rollkit to evnode prefix, new sections, removed options, and rationale for the updates.
Title check	❓ Inconclusive	The title 'chore: update config docs' is vague and generic, using non-descriptive terms that don't clearly convey the specific configuration changes made.	Use a more specific title that indicates the key changes, such as 'chore: update config docs with evnode prefix and new raft options' or similar.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch marko/config_docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[julienrbrt]

skimmed through it and lgtm!

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.12%. Comparing base (005e06c) to head (c4c5997).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3189      +/-   ##
==========================================
- Coverage   61.17%   61.12%   -0.05%     
==========================================
  Files         117      117              
  Lines       12082    12082              
==========================================
- Hits         7391     7385       -6     
- Misses       3866     3870       +4     
- Partials      825      827       +2     

Flag	Coverage Δ
combined	61.12% <ø> (-0.05%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/learn/config.md`:
- Around line 160-162: The docs currently show the new --evnode.* flags (e.g.,
--evnode.db_path) but don’t mention legacy compatibility; add a short note near
the flag examples stating that legacy --rollkit.* flags (for example
--rollkit.db_path) are still accepted and are normalized internally to their
--evnode.* equivalents, and include one brief example mapping (legacy → new) so
operators know existing scripts will continue to work; update the section
containing --evnode.db_path and any other --evnode.* entries to include this
compatibility note.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2867b738-7701-428c-b409-0195d11d0cfb

📥 Commits

Reviewing files that changed from the base of the PR and between 005e06c and c4c5997.

📒 Files selected for processing (1)

• docs/learn/config.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Document legacy --rollkit.* compatibility to avoid migration confusion

These sections now correctly show --evnode.*, but the docs should also mention that legacy --rollkit.* flags are still accepted (normalized internally). Without that note, this isn’t fully comprehensive for operators migrating existing scripts.

📝 Suggested doc patch

 **Command-line Flag:**
 `--evnode.db_path <path>`
 _Example:_ `--evnode.db_path "node_db"`
+_Compatibility:_ legacy `--rollkit.*` flags are still accepted and normalized to `--evnode.*`.
 _Default:_ `"data"`
 _Constant:_ `FlagDBPath`

As per coding guidelines, technical documentation in `/learn` should be comprehensive and accurate.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	`--evnode.db_path <path>`
	_Example:_ `--evnode.db_path "node_db"`
	_Default:_ `"data"`
	`--evnode.db_path <path>`
	_Example:_ `--evnode.db_path "node_db"`
	_Compatibility:_ legacy `--rollkit.*` flags are still accepted and normalized to `--evnode.*`.
	_Default:_ `"data"`

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/learn/config.md` around lines 160 - 162, The docs currently show the new
--evnode.* flags (e.g., --evnode.db_path) but don’t mention legacy
compatibility; add a short note near the flag examples stating that legacy
--rollkit.* flags (for example --rollkit.db_path) are still accepted and are
normalized internally to their --evnode.* equivalents, and include one brief
example mapping (legacy → new) so operators know existing scripts will continue
to work; update the section containing --evnode.db_path and any other --evnode.*
entries to include this compatibility note.

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-23 14:46 UTC