Skip to content

packaging/docs: replace deprecated rpc.batchlimit key#2216

Open
odupontt wants to merge 1 commit into0xPolygon:developfrom
odupontt:fix-rpc-batch-request-limit-templates
Open

packaging/docs: replace deprecated rpc.batchlimit key#2216
odupontt wants to merge 1 commit into0xPolygon:developfrom
odupontt:fix-rpc-batch-request-limit-templates

Conversation

@odupontt
Copy link
Copy Markdown

@odupontt odupontt commented May 8, 2026

Description

This PR fixes a real configuration correctness issue caused by a key mismatch between runtime config parsing and shipped templates/docs.

internal/cli/server/config.go now expects rpc.batch-request-limit, but multiple template files and the CLI example still used rpc.batchlimit.
If operators uncommented the old key, Bor silently ignored it and kept the default batch request limit (1000), which could lead to unexpected production behavior.

What was done:

  1. Replaced rpc.batchlimit with rpc.batch-request-limit in all affected packaging templates.
  2. Updated builder/files/config.toml to use the correct key.
  3. Updated docs/cli/example_config.toml to keep docs/examples aligned with runtime behavior.
  4. Kept the change minimal: key rename only, no default value changes, no runtime logic changes.

Changes

  • Bugfix (non-breaking change that solves an issue)
  • Hotfix (change that solves an urgent issue, and requires immediate attention)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (change that is not backwards-compatible and/or changes current functionality)
  • Changes only for a subset of nodes

Nodes audience

This change applies to all operators who rely on shipped Bor templates/examples.
It is not limited to a subset of nodes.

Checklist

  • I have added at least 2 reviewer or the whole pos-v1 team
  • I have added sufficient documentation in code
  • I will be resolving comments - if any - by pushing each fix in a separate commit and linking the commit hash in the comment reply
  • Created a task in Jira and informed the team for implementation in Erigon client (if applicable)
  • Includes RPC methods changes, and the Notion documentation has been updated

Cross repository changes

  • This PR requires changes to heimdall
    • In case link the PR here:
  • This PR requires changes to matic-cli
    • In case link the PR here:

Testing

  • I have added unit tests
  • I have added tests to CI
  • I have tested this code manually on local environment
  • I have tested this code manually on remote devnet using express-cli
  • I have tested this code manually on amoy
  • I have created new e2e tests into express-cli

Manual tests

  1. Verified old key is removed from repo templates/examples:
    • rg -n "rpc\.batchlimit" .
    • Result: no matches in templates/docs after this PR.
  2. Verified new key is present where expected:
    • rg -n "rpc\.batch-request-limit" builder packaging docs
    • Result: matches found across updated template/example files.
  3. Confirmed scope is limited to template/docs key rename via diff review.

Additional comments

No runtime code path or default value was changed in this PR; this is a template/docs correctness alignment fix to prevent silent misconfiguration.

Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 8, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant