TypeScript API Reference
This section provides API reference documentation for the Aztec TypeScript packages. These packages enable developers to build applications on Aztec, from simple contract interactions to complex privacy-preserving protocols.
Package Categories
Client SDKs
Packages for building Aztec applications:
| Package | Description |
|---|---|
| @aztec/aztec.js | Main SDK for building Aztec applications. Provides contract deployment, transaction creation, and account management. |
| @aztec/accounts | Sample account contract implementations including ECDSA and Schnorr accounts. |
| @aztec/pxe | Private eXecution Environment client library for orchestrating private transaction execution and proving. |
| @aztec/wallet-sdk | Wallet SDK for browser and extension integrations. |
| @aztec/test-wallet | Test wallet for development and e2e testing with in-memory account management. |
| @aztec/entrypoints | Transaction entrypoint implementations for account abstraction. |
Core Libraries
Foundational types and utilities used across the Aztec stack:
| Package | Description |
|---|---|
| @aztec/stdlib | Protocol-level types including transactions, blocks, proofs, and kernel circuit types. |
| @aztec/foundation | Low-level utilities including crypto primitives, serialization, and async helpers. |
| @aztec/constants | Protocol constants shared between TypeScript and Noir circuits. |
note
Common types like Fr, AztecAddress, and EthAddress are re-exported through @aztec/aztec.js subpaths (e.g., @aztec/aztec.js/fields, @aztec/aztec.js/addresses). Most developers won't need to import from @aztec/stdlib directly.
LLM-Optimized Documentation
For LLM consumption, we provide machine-readable documentation in multiple formats:
- llms.txt - Full documentation optimized for LLM context
- LLM Summary - Human-readable API summary
Markdown API Files
The following markdown files are available for LLM context inclusion at /typescript-api/nightly/:
| File | Description |
|---|---|
llm-summary.txt | Human-readable summary with package overview |
aztec.js.md | Main SDK - contracts, transactions, accounts |
accounts.md | Account implementations (ECDSA, Schnorr) |
pxe.md | Private execution environment client |
wallet-sdk.md | Browser/extension wallet integration |
test-wallet.md | Test wallet for development and e2e testing |
entrypoints.md | Transaction entrypoints for account abstraction |
stdlib.md | Protocol types (transactions, blocks, proofs) |
foundation.md | Low-level utilities (crypto, serialization) |
constants.md | Protocol constants for circuits |