Added config.yaml.example file

[jkawan]

Closes #380

---

Summary by cubic

Added a top-level config.yaml.example with expanded settings and removed the old configs/adder.yaml.example. This gives a single, up-to-date template with network, genesis, and plugin options.

• New Features

  • Example covers API, logging, debug, and input/output plugins.
  • Includes Shelley/Byron genesis parameters and optional Kupo URL.
  • Supports chainsync configuration via network or socket_path/network_magic.

• Refactors

  • Consolidated config examples into config.yaml.example at the repo root.
  • Standardized defaults (API address 0.0.0.0; debug listener disabled by default).

^{Written for commit 3292e09. Summary will update automatically on new commits.}

Summary by CodeRabbit

• Chores
  • Added a new example configuration template offering a comprehensive, commented YAML preview of API, logging, debug listener, input/output plugin settings, optional parameters, and blockchain genesis options.
  • Removed an obsolete example configuration that previously provided sample values and guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

Adds a new example configuration file config.yaml.example that contains a full YAML-based template (API server, logging, debug listener, input/output plugins, optional kupo_url, genesis parameters, and nested plugin options). Removes the contents of configs/adder.yaml.example, leaving it empty. Changes are limited to example configuration files; no application code or public API signatures were modified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5–15 minutes

• Verify config.yaml.example YAML syntax and that keys match the application's expected configuration schema.
• Check for any references, documentation, or scripts that expect content in configs/adder.yaml.example and update if necessary.
• Confirm no runtime or CI tests depend on the removed example file contents.

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a config.yaml.example file at the repository root.
Linked Issues check	✅ Passed	The PR successfully creates the config.yaml.example file as required by issue #380, with comprehensive configuration examples.
Out of Scope Changes check	✅ Passed	The PR appropriately removes the old configs/adder.yaml.example while adding the new root-level config.yaml.example, consolidating configuration templates as intended.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat-config-yaml

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30970a6 and 3292e09.

📒 Files selected for processing (1)

• config.yaml.example (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• config.yaml.example

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (go)

---

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.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02a47b2 and 30970a6.

📒 Files selected for processing (2)

• config.yaml.example (1 hunks)
• configs/adder.yaml.example (0 hunks)

💤 Files with no reviewable changes (1)

• configs/adder.yaml.example

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: cubic · AI code reviewer
• GitHub Check: Analyze (go)

🔇 Additional comments (1)

config.yaml.example (1)

1-80: YAML structure and comments are well-organized.

The configuration template is comprehensive and covers the main service sections (API, logging, debug, plugins, genesis configs). The nested structure is properly formatted, and most settings include helpful comments with network-specific defaults documented.

Please verify that:

1. All available configuration options are documented in this template (no missing required or optional settings)
2. The file aligns with the actual service configuration handling code

[cubic-dev-ai]

1 issue found across 2 files

Prompt for AI agents (all 1 issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="config.yaml.example">

<violation number="1" location="config.yaml.example:70">
P2: Configuration inconsistency: `network: preview` is set but genesis values use mainnet defaults. For a preview network example, consider using consistent preview values (`shelley_trans_epoch: 4`, `end_slot: 0`, `epoch_length: 86400` for shelley_genesis) or change network to `mainnet`.</violation>
</file>

_{Reply to cubic to teach it or ask questions. Re-run a review with @cubic-dev-ai review this PR}