Skip to content

starknet_transaction_prover: add external developer docs#13129

Merged
avi-starkware merged 1 commit intomain-v0.14.2from
avi/privacy/external-dev-experience
Mar 11, 2026
Merged

starknet_transaction_prover: add external developer docs#13129
avi-starkware merged 1 commit intomain-v0.14.2from
avi/privacy/external-dev-experience

Conversation

@avi-starkware
Copy link
Copy Markdown
Collaborator

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

Summary

  • Add README.md with usage, configuration, and deployment guidance for external operators
  • Add resources/example-config.json sample configuration for quick onboarding

Test plan

  • Documentation only — no code changes

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes; no runtime behavior or security-sensitive logic is modified.

Overview
Adds external developer/operator documentation for starknet_transaction_prover, including quickstart Docker usage, JSON-RPC method examples (notably starknet_proveTransaction), input constraints, error codes, and deployment/configuration options (TLS, CORS, concurrency, logging, CPU-specific builds).

Introduces resources/example-config.json to provide a ready-to-copy sample JSON configuration for RPC URL, networking, concurrency limits, CORS, and zero-fee field validation.

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

@reviewable-StarkWare
Copy link
Copy Markdown

This change is Reviewable

@avi-starkware avi-starkware marked this pull request as ready for review March 10, 2026 12:32
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from 7d93839 to be71271 Compare March 10, 2026 12:35
@avi-starkware avi-starkware force-pushed the avi/privacy/add-request-validations branch 2 times, most recently from 7930acf to a79887c Compare March 10, 2026 12:41
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from be71271 to ec0cfca Compare March 10, 2026 12:41
@avi-starkware avi-starkware force-pushed the avi/privacy/add-request-validations branch from a79887c to cefd94b Compare March 10, 2026 12:59
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch 3 times, most recently from 5fc53ea to a510139 Compare March 10, 2026 13:43
@avi-starkware avi-starkware changed the title starknet_transaction_prover: add external developer docs and error sanitization starknet_transaction_prover: add external developer docs Mar 10, 2026
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from a510139 to 7b10d3a Compare March 10, 2026 14:02
@avi-starkware avi-starkware force-pushed the avi/privacy/add-request-validations branch from 903d036 to f81d26b Compare March 10, 2026 14:27
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch 2 times, most recently from 841f1cb to 6b4a464 Compare March 10, 2026 14:36
@avi-starkware avi-starkware force-pushed the avi/privacy/add-request-validations branch from 44b328b to d5a72c6 Compare March 10, 2026 14:55
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch 2 times, most recently from 8b2947f to e2e9764 Compare March 10, 2026 15:07
@avi-starkware avi-starkware changed the base branch from avi/privacy/add-request-validations to graphite-base/13129 March 10, 2026 16:39
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from e2e9764 to 7cd2060 Compare March 10, 2026 16:39
@avi-starkware avi-starkware changed the base branch from graphite-base/13129 to main-v0.14.2 March 10, 2026 16:39
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch 2 times, most recently from 593f32e to a5606d0 Compare March 10, 2026 18:01
Copy link
Copy Markdown
Collaborator

@Yoni-Starkware Yoni-Starkware left a comment

Choose a reason for hiding this comment

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

@Yoni-Starkware made 1 comment.
Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on avi-starkware, meship-starkware, and noaov1).


crates/starknet_transaction_prover/README.md line 78 at r1 (raw file):

        "resource_bounds": {
          "l1_gas":      {"max_amount": "0x0", "max_price_per_unit": "0x0"},
          "l2_gas":      {"max_amount": "0x0", "max_price_per_unit": "0x0"},

Change this to 100M gas

Code quote:

"l2_gas":      {"max_amount": "0x0",

Copy link
Copy Markdown
Collaborator

@Yoni-Starkware Yoni-Starkware left a comment

Choose a reason for hiding this comment

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

:lgtm:

@Yoni-Starkware made 1 comment.
Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on avi-starkware, meship-starkware, and noaov1).

@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from a5606d0 to c446611 Compare March 10, 2026 19:57
Copy link
Copy Markdown
Collaborator Author

@avi-starkware avi-starkware left a comment

Choose a reason for hiding this comment

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

@avi-starkware made 1 comment and resolved 1 discussion.
Reviewable status: 0 of 2 files reviewed, all discussions resolved (waiting on meship-starkware and noaov1).


crates/starknet_transaction_prover/README.md line 78 at r1 (raw file):

Previously, Yoni-Starkware (Yoni) wrote…

Change this to 100M gas

Done.

@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from c446611 to 08f302d Compare March 11, 2026 05:58
Add README.md with usage, configuration, and deployment guidance for
external operators, plus a sample config JSON for quick onboarding.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@avi-starkware avi-starkware force-pushed the avi/privacy/external-dev-experience branch from 08f302d to 0cadef0 Compare March 11, 2026 07:18
Copy link
Copy Markdown
Collaborator

@Yoni-Starkware Yoni-Starkware left a comment

Choose a reason for hiding this comment

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

:lgtm:

@Yoni-Starkware reviewed 2 files and all commit messages, and made 1 comment.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on meship-starkware and noaov1).

@avi-starkware avi-starkware added this pull request to the merge queue Mar 11, 2026
Merged via the queue into main-v0.14.2 with commit 4b8278d Mar 11, 2026
15 of 17 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 13, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants