docs: document initializerless accounts#24512
Open
AztecBot 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.
Initializerless accounts shipped with the v5 line but were never actually documented: the only coverage was a migration-notes entry, an external link on the aztec-nr immutables page, and rc.2 tutorial snippets that call
createSchnorrInitializerlessAccountwithout explaining it. The main "Creating Accounts" guide still teaches only the paid deploy-tx flow.What this adds
New concept page:
foundational-topics/accounts/deployment.md("Account Deployment")immutables_hash, utilityconstructormaterializing the key in the PXE, entrypoint proving the local key matches the address commitmentgetDeployMethod()throwsaztec-wallet create-account -t schnorr_initializerless, and the aztec-nr immutables patternHow-to: new "Create an initializerless account" section in
aztec-js/how_to_create_account.md, placed before the deploy section, with thecreateSchnorrInitializerlessAccountsnippet and the key caveats. The deploy section intro now clarifies it applies tocreateSchnorrAccountaccounts.Cross-links from
fees.md(payment methods),wallets.md(account setup),contract_creation.md(immutables_hashfield), andaztec-nr/framework-description/immutables.md.All changes are mirrored into
developer_versioned_docs/version-v5.0.0-rc.2/so the live testnet docs pick them up immediately (that snapshot is what testnet users read today).Why the snippet is a fenced code block, not
#include_codeThe docs TS examples type-check against this branch's
yarn-project, andcreateSchnorrInitializerlessAccountonly exists on the v5 line (introduced in #23962), not onnext. An#include_codeexample indocs/examples/ts/would therefore failexamples/bootstrap.shvalidation on this branch. The snippet matches the verified v5.0.0-rc.2 API; it should be converted to an#include_codeexample once the v5 line lands innext.Verification
yarn spellcheck: clean (497 files, 0 issues;initializerlessis already indocs-words.txt)yarn build: full site build succeeds; the new page renders in both the dev and testnet (v5.0.0-rc.2) doc instances and all new internal links resolve (remaining broken-anchor warnings are pre-existing in the CLI reference)Created by claudebox · group:
slackbot