docs: clarify Quantum forge script support boundary#9
Open
williamclay8 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The README currently says
forge scriptroutes scripted broadcast through theshared Quantum adapter for supported write shapes and fails closed on unsupported
Quantum script shapes.
Current
crates/script/src/lib.rsis stricter: when--quantumis set,run_script()immediately rejects the command and saysforge script --broadcastdoes not yet support the Quantum adapter path in v1. The rejectionmessage points builders to individual
cast send --quantumandforge create --quantuminvocations instead.This docs-only clarification keeps early builders from planning multi-step
deployment scripts around
forge script --broadcast --quantumbefore that pathis wired through the native
0x7Apipeline.Solution
Update the README
forge scriptbullet to say that--quantumintentionallyfails closed in v1 and to name the currently supported alternatives:
cast send --quantum,forge create --quantum, or running without--quantumagainst an Ethereum-compatible network.
AI assistance disclosure: I used OpenAI Codex to compare the current README
wording with current raw source and to draft this docs-only clarification. No
local Foundry execution, code generation, signing, deployment, or write
transaction was performed.
PR Checklist