feat(docs): add runtime execution tests for aztec.js documentation examples#20113
Merged
critesjosh merged 1 commit intonextfrom Mar 3, 2026
Merged
feat(docs): add runtime execution tests for aztec.js documentation examples#20113critesjosh merged 1 commit intonextfrom
critesjosh merged 1 commit intonextfrom
Conversation
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
sklppy88
approved these changes
Mar 3, 2026
AztecBot
force-pushed
the
jo/docs-example-execution-tests
branch
from
2b2109d to
3823c3c
Compare
…amples > **Note:** This PR is stacked on #20062 and should be merged after it. ## Summary - Add a test runner (`aztecjs_runner`) that executes documentation examples against a live network - Fix transfer examples to call `transfer_to_private()` before private transfers (public mint → private transfer flow) - Add README explaining how typechecking and execution verification work for docs examples - Integrate runner into e2e compose tests where the network is already running ## Details The runner script (`run.sh`) executes these examples sequentially: - `aztecjs_connection` - Basic network connection and contract deployment - `aztecjs_getting_started` - Token minting and transfers - `aztecjs_advanced` - Advanced patterns (batch calls, sponsored transactions, etc.) - `aztecjs_authwit` - Authentication witnesses - `aztecjs_testing` - Testing patterns with assertions The runner is invoked from `docs_examples.test.ts` in the e2e compose tests, which already has a running network via docker-compose. ## Test plan - Run `yarn workspace @aztec/end-to-end test:e2e docs_examples.test.ts` against a local network - Verify all 5 examples pass 🤖 Generated with [Claude Code](https://claude.com/claude-code)
AztecBot
force-pushed
the
jo/docs-example-execution-tests
branch
from
3823c3c to
af9a5b0
Compare
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
3 participants
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