docs: explain read-only simulation behavior in Interact tutorial#2269
Open
docs: explain read-only simulation behavior in Interact tutorial#2269
Conversation
Co-authored-by: oceans404 <91382964+oceans404@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix missing explanation of read-only simulation in tutorial
docs: explain read-only simulation behavior in Interact tutorial
Feb 20, 2026
oceans404
approved these changes
Feb 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds explanatory documentation to the "Deploy to Testnet" tutorial to clarify the confusing "Simulation identified as read-only" message that appears when invoking read-only contract functions. The change addresses user confusion about when --send=yes is needed and what it means for a function to be "read-only."
Changes:
- Added a
:::notecallout explaining read-only simulation behavior after the expected output section - Clarified that read-only functions are automatically simulated locally without fees
- Explained when
--send=yesis required (state-changing functions only)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/build/smart-contracts/getting-started/deploy-to-testnet.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
The "Interact" section of the getting-started deploy-to-testnet tutorial silently produces a
Simulation identified as read-onlymessage with no context, leaving users confused about whether their invocation succeeded and when--send=yesis actually required.Changes
docs/build/smart-contracts/getting-started/deploy-to-testnet.mdx: Added a:::notecallout after the expectedhelloinvocation output explaining:hellofunction is read-only (no storage writes), so the CLI automatically runs it as a free local simulation—no transaction submitted, no fees incurredSimulation identified as read-only. Send by rerunning with --send=yesmessage is expected and can be ignored here; the returned value is already correct--send=yesis only relevant for state-changing functions where the simulation result must be committed on-chainOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.