Skip to content

Rename vnext configuration names before GA lock-in - #1197

Open
Shaptic wants to merge 9 commits into
mainfrom
rpcv2-config-renames
Open

Shaptic wants to merge 9 commits into
mainfrom
rpcv2-config-renames

Conversation

@Shaptic

@Shaptic Shaptic commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Renames 17 rpcv2 config keys before GA freezes them (#1176). Each key's CLI flag follows it, since every flag is its dotted TOML path.

Breaking for rpcv2 beta configs. Old keys fail startup with an unknown-key error. Update configs with the table below.

What changes

[storage]

Old New Why
default_data_dir data_path Required, so not a "default"; matches core_*_path
txhash_raw txhashes Pairs like events / events_index

[service.preflight] → [service.simulation]

Why the section rename: operators know simulateTransaction, not "preflight".

Old New Why
worker_count workers One name for every worker count
worker_queue_size queue_size worker_ prefix added nothing
simulation_memory_limit max_memory_bytes Names the unit, like max_*_bytes

[service.methods.<method>]

Applies to getTransactions, getLedgers, getEvents, queryEvents.

Old New Why
max_items_per_response max_page_limit Matches the client's pagination.limit
default_items_per_response default_page_limit Same

[backfill.bsb] → [backfill.download]

Why the section rename: "bsb" is SDK jargon.

Old New Why
buffer_size prefetch_files Counts files; read like bytes
buffer_bytes prefetch_bytes Pairs with prefetch_files
num_workers workers One name for every worker count

[ingestion]

Old New Why
captive_core_config core_config One core_ prefix, not three
captive_core_storage_path core_storage_path Same
stellar_core_binary_path core_binary_path Same
core_http_query_thread_pool_size core_http_query_workers One name for every worker count

Not changing

  • Defaults, validation, and on-disk layout ({data_path}/txhash/raw stays).
  • v1 flags and keys.
  • The shared preflight package and its metrics.

Review

One commit per rename group. Each commit updates the Go names, error and log messages, tests, sample config, integration-test TOML, design doc, and beta runbook.

Tests

  • go test ./cmd/stellar-rpc/internal/rpcv2/... ./cmd/stellar-rpc/internal/cli/: 26 packages pass.
  • TestRPCv2ConfigParsesStrict passes. It checks the sample config against the integration-test TOML.
  • Docker integration suite: not run locally.

Follow-ups (separate PRs)

  1. [retention].retention_chunks → a ledger-count window.
  2. "Renamed to X" hints for the old keys.

🤖 Generated with Claude Code

@Shaptic Shaptic changed the title rpcv2: rename config keys before GA Rename rpcv2 config keys before GA Nov 17, 2026
Shaptic and others added 9 commits November 17, 2026 13:21
Renames:
- [backfill.bsb].num_workers -> workers
- [service.preflight].worker_count -> workers
- [ingestion].core_http_query_thread_pool_size -> core_http_query_workers

Why: one idea had four spellings. [backfill].workers already used this one.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- [backfill.bsb] -> [backfill.download]
- buffer_size -> prefetch_files
- buffer_bytes -> prefetch_bytes

Why: "bsb" is SDK jargon. buffer_size counts files but read like bytes.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- [service.preflight] -> [service.simulation]
- simulation_memory_limit -> memory_limit

Why: operators know the method as simulateTransaction. "Preflight" is
the internal name.

Unchanged: the preflight package, its metrics, v1's --preflight-* flags.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- captive_core_config -> core_config
- captive_core_storage_path -> core_storage_path
- stellar_core_binary_path -> core_binary_path

Why: [ingestion] used three prefixes (core_, captive_core_,
stellar_core_) for one process.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- [storage].default_data_dir -> data_dir

Why: the key is required, so "default" was misleading.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames, on getTransactions, getLedgers, getEvents, queryEvents:
- max_items_per_response -> max_page_limit
- default_items_per_response -> default_page_limit

Why: they cap and default the client's pagination.limit.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- [storage].txhash_raw -> txhashes

Why: pairs with txhash_index the way events pairs with events_index.

Unchanged: the default directory on disk ({data_dir}/txhash/raw).

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- [service.simulation].worker_queue_size -> queue_size

Why: next to workers, the worker_ prefix adds nothing.

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Renames:
- [service.simulation].memory_limit -> max_memory_bytes

Why: names the unit, like the max_*_bytes keys in [service].

Part of #1176.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Shaptic
Shaptic force-pushed the rpcv2-config-renames branch from 4bd3a74 to aa996f7 Compare November 17, 2026 21:21
@Shaptic Shaptic changed the title Rename rpcv2 config keys before GA Rename vnext configuration names before GA lock-in Nov 17, 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