docs: update aztec.js guides for new send API#20062
Merged
Conversation
sklppy88
approved these changes
Jan 30, 2026
Contributor
sklppy88
left a comment
sklppy88
left a comment
There was a problem hiding this comment.
i think eventually moving all these examples to include codes would be good tbh
critesjosh
force-pushed
the
josh/ecodr-727-miscellaneous-docs-updates
branch
from
9a6082c to
04b195a
Compare
sklppy88
approved these changes
Feb 2, 2026
Contributor
sklppy88
left a comment
sklppy88
left a comment
There was a problem hiding this comment.
Looks good overall. But things reused can also reuse the same include code ?
Collaborator
TypeScript validationAction required: Please fix the docs examples or update them to match the current API. cc @AztecProtocol/devrel |
AztecBot
force-pushed
the
josh/ecodr-727-miscellaneous-docs-updates
branch
from
0e02091 to
81cc2df
Compare
## Summary Comprehensive documentation updates for aztec.js guides and related developer documentation. ### API Updates (from #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 ### Type-Checked Examples - Add runnable TypeScript examples in `docs/examples/ts/` for: - `aztecjs_connection` - Connection and account creation examples - `aztecjs_advanced` - `skip_initialization` and `poll_for_events` examples - `aztecjs_authwit` - Authorization witness examples - `aztecjs_testing` - Testing examples - Examples are validated with `config.yaml` files for CI integration ### Documentation Improvements - Add note explaining `TestWallet` vs production wallets in account creation guide - Clarify undeclared variables in code examples - Format code blocks for consistency - Update `devnetTag` version reference ### Bug Fixes - Update installation commands to use `-L` flag for curl (follows redirects) **Files updated:** - `how_to_send_transaction.md` - `how_to_deploy_contract.md` - `how_to_create_account.md` - `how_to_pay_fees.md` - `how_to_use_authwit.md` - `how_to_test.md` - `how_to_read_data.md` - `how_to_connect_to_local_network.md` - Various versioned docs with curl -L fix ## Test plan - [ ] Verify documentation builds successfully - [ ] Review code examples for accuracy against new API - [ ] Run type-checked examples to verify they compile 🤖 Generated with [Claude Code](https://claude.ai/code)
AztecBot
force-pushed
the
josh/ecodr-727-miscellaneous-docs-updates
branch
from
81cc2df to
53bfb29
Compare
AztecBot
pushed a commit
that referenced
this pull request
Mar 3, 2026
…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) Co-authored-by: Josh Crites <jc@joshcrites.com>
AztecBot
pushed a commit
that referenced
this pull request
Mar 3, 2026
…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)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 3, 2026
…amples (#20113) > **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)
johnathan79717
pushed a commit
that referenced
this pull request
Mar 4, 2026
…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)
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
Comprehensive documentation updates for aztec.js guides and related developer documentation.
API Updates (from #19778)
.wait()calls -send()now returns receipt directly.deployed()calls -send()returns contract for deploymentsNO_WAIToption andwaitForTxutility examplesgetTxReceiptto use node instead of walletType-Checked Examples
docs/examples/ts/for:aztecjs_connection- Connection and account creation examplesaztecjs_advanced-skip_initializationandpoll_for_eventsexamplesaztecjs_authwit- Authorization witness examplesaztecjs_testing- Testing examplesconfig.yamlfiles for CI integrationDocumentation Improvements
TestWalletvs production wallets in account creation guidedevnetTagversion referenceBug Fixes
-Lflag for curl (follows redirects)Files updated:
how_to_send_transaction.mdhow_to_deploy_contract.mdhow_to_create_account.mdhow_to_pay_fees.mdhow_to_use_authwit.mdhow_to_test.mdhow_to_read_data.mdhow_to_connect_to_local_network.mdTest plan
🤖 Generated with Claude Code