Skip to content

starknet_transaction_prover: add ConfigMap docs and full config reference#13167

Open
avi-starkware wants to merge 1 commit intoavi/privacy/external-dev-experiencefrom
avi/privacy/configmap-docs
Open

starknet_transaction_prover: add ConfigMap docs and full config reference#13167
avi-starkware wants to merge 1 commit intoavi/privacy/external-dev-experiencefrom
avi/privacy/configmap-docs

Conversation

@avi-starkware
Copy link
Collaborator

@avi-starkware avi-starkware commented Mar 11, 2026

Summary

  • Add a Kubernetes deployment section to the README with ConfigMap creation, Deployment YAML, and configuration precedence docs
  • Add a Full configuration reference section documenting all nested JSON config fields (bouncer_config, storage_proof_config, contract_class_manager_config)
  • Expand resources/example-config.json to show the complete config structure with all nested fields
  • Remove the --bouncer-config-override CLI arg and BOUNCER_CONFIG_OVERRIDE env var — the JSON config file now covers this use case

Test plan

  • cargo check -p starknet_transaction_prover passes
  • All 41 unit tests pass (cargo test -p starknet_transaction_prover)
  • example-config.json validates as valid JSON
  • All serde field names verified against source code

Stacked on #13158 (avi/privacy/external-dev-experience)

🤖 Generated with Claude Code


Note

Medium Risk
Mostly documentation/config reference updates, but it removes the --bouncer-config-override/BOUNCER_CONFIG_OVERRIDE path, which could break existing deployments relying on that override mechanism.

Overview
Adds a full JSON configuration reference to the starknet_transaction_prover README (including detailed bouncer_config structure) and new Kubernetes deployment guidance using a ConfigMap, plus explicit configuration precedence rules.

Expands resources/example-config.json to include the complete nested config structure (runner/storage proof, executor/bouncer limits & weights, and contract class manager/native compiler settings). Removes the --bouncer-config-override CLI/env override path in src/server/config.rs and updates tests accordingly, and logs the effective resolved ServiceConfig at startup.

Written by Cursor Bugbot for commit bf5bdd5. This will update automatically on new commits. Configure here.

@reviewable-StarkWare
Copy link

This change is Reviewable

…e, remove bouncer CLI override

Add Kubernetes ConfigMap deployment guide, document the full nested JSON
config structure (bouncer_config, storage_proof_config,
contract_class_manager_config), expand example-config.json to show all
fields, and remove the --bouncer-config-override CLI arg / env var since
the config file now covers this.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@avi-starkware avi-starkware force-pushed the avi/privacy/configmap-docs branch from dcb7da6 to bf5bdd5 Compare March 11, 2026 13:33
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

transport,
})
};
info!("Effective configuration: {:#?}", service_config);
Copy link

Choose a reason for hiding this comment

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

Startup logging may expose sensitive RPC API keys

Low Severity

The new info!("Effective configuration: {:#?}", service_config) unconditionally logs the entire ServiceConfig at startup, including prover_config.rpc_node_url. RPC URLs commonly embed API keys (e.g. https://mainnet.infura.io/v3/SECRET_KEY). Previously, the URL was only logged when a CLI override changed it; now it's always emitted to the info log level regardless of how it was configured.

Fix in Cursor Fix in Web

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.

2 participants