feat(docs): add runtime execution tests for aztec.js documentation examples #20113
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
Add comments to code snippets explaining where variables come from. Update prerequisites to link to connection guide. Use consistent variable naming (aliceAddress, bobAddress) matching the connection guide. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Updates documentation to reflect changes from PR #19778: - Remove .wait() calls - send() now returns receipt directly - Remove .deployed() calls - send() returns contract for deployments - Add NO_WAIT option and waitForTx utility examples - Update getTxReceipt to use node instead of wallet Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add new type-checked TypeScript examples in docs/examples/ts/ that get validated by the bootstrap.sh script during CI. Update aztec.js how-to guides to reference these examples using #include_code macros. New example directories: - aztecjs_connection: Core setup, wallet, accounts, deployment - aztecjs_authwit: Private/public authwits, revocation - aztecjs_advanced: NO_WAIT, BatchCall, sponsored FPC, parallel deploy - aztecjs_testing: Complete test structure This ensures code snippets in docs stay in sync with API changes. Co-Authored-By: Claude Opus 4.5 <[email protected]>
…events Co-Authored-By: Claude Opus 4.5 <[email protected]>
Co-Authored-By: Claude Opus 4.5 <[email protected]>
…m:AztecProtocol/aztec-packages into josh/ecodr-727-miscellaneous-docs-updates
…amples Adds a test runner that executes documentation examples against a live network to verify they work correctly. The runner is integrated into the e2e compose test suite via docs_examples.test.ts. Changes: - Add aztecjs_runner with run.sh script that executes examples sequentially - Fix transfer examples to call transfer_to_private before private transfers - Add README explaining typechecking and execution verification workflow - Integrate runner into e2e compose tests where network is already running Co-Authored-By: Claude Opus 4.5 <[email protected]>
critesjosh
changed the title
critesjosh
changed the base branch from
next
to
josh/ecodr-727-miscellaneous-docs-updates
AztecBot
force-pushed
the
josh/ecodr-727-miscellaneous-docs-updates
branch
2 times, most recently
from
81cc2df to
53bfb29
Compare
Base automatically changed from
josh/ecodr-727-miscellaneous-docs-updates
to
next
February 3, 2026 13:42
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
aztecjs_runner) that executes documentation examples against a live networktransfer_to_private()before private transfers (public mint → private transfer flow)Details
The runner script (
run.sh) executes these examples sequentially:aztecjs_connection- Basic network connection and contract deploymentaztecjs_getting_started- Token minting and transfersaztecjs_advanced- Advanced patterns (batch calls, sponsored transactions, etc.)aztecjs_authwit- Authentication witnessesaztecjs_testing- Testing patterns with assertionsThe runner is invoked from
docs_examples.test.tsin the e2e compose tests, which already has a running network via docker-compose.Test plan
yarn workspace @aztec/end-to-end test:e2e docs_examples.test.tsagainst a local network🤖 Generated with Claude Code