> For the complete documentation index, see [llms.txt](/llms.txt)

# 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-labs/aztec.js**    | Main SDK for building Aztec applications. Provides contract deployment, transaction creation, and account management. |
| **@aztec-labs/accounts**    | Sample account contract implementations including ECDSA and Schnorr accounts.                                         |
| **@aztec-labs/pxe**         | Private eXecution Environment client library for orchestrating private transaction execution and proving.             |
| **@aztec-labs/wallet-sdk**  | Wallet SDK for browser and extension integrations.                                                                    |
| **@aztec-labs/wallets**     | Embedded wallet for browser and Node.js environments.                                                                 |
| **@aztec-labs/entrypoints** | Transaction entrypoint implementations for account abstraction.                                                       |

### Core Libraries

Foundational types and utilities used across the Aztec stack:

| Package                    | Description                                                                            |
| -------------------------- | -------------------------------------------------------------------------------------- |
| **@aztec-labs/stdlib**     | Protocol-level types including transactions, blocks, proofs, and kernel circuit types. |
| **@aztec-labs/foundation** | Low-level utilities including crypto primitives, serialization, and async helpers.     |
| **@aztec-labs/constants**  | Protocol constants shared between TypeScript and Noir circuits.                        |

note

Common types like `Fr`, `AztecAddress`, and `EthAddress` are re-exported through `@aztec-labs/aztec.js` subpaths (e.g., `@aztec-labs/aztec.js/fields`, `@aztec-labs/aztec.js/addresses`). Most developers won't need to import from `@aztec-labs/stdlib` directly.

## LLM-Optimized Documentation

For LLM consumption, we provide machine-readable documentation in multiple formats:

* **[llms.txt](/llms.txt)**  - Full documentation optimized for LLM context
* [**LLM Summary**](/typescript-api/mainnet/llm-summary.txt)  - Human-readable API summary

### Markdown API Files

The following markdown files are available for LLM context inclusion at `/typescript-api/mainnet/`:

| File                                                          | Description                                     |
| ------------------------------------------------------------- | ----------------------------------------------- |
| [`llm-summary.txt`](/typescript-api/mainnet/llm-summary.txt)  | Human-readable summary with package overview    |
| [`aztec.js.md`](/typescript-api/mainnet/aztec.js.md)          | Main SDK - contracts, transactions, accounts    |
| [`accounts.md`](/typescript-api/mainnet/accounts.md)          | Account implementations (ECDSA, Schnorr)        |
| [`pxe.md`](/typescript-api/mainnet/pxe.md)                    | Private execution environment client            |
| [`wallet-sdk.md`](/typescript-api/mainnet/wallet-sdk.md)      | Browser/extension wallet integration            |
| [`wallets.md`](/typescript-api/mainnet/wallets.md)            | Embedded wallet for browser and Node.js         |
| [`entrypoints.md`](/typescript-api/mainnet/entrypoints.md)    | Transaction entrypoints for account abstraction |
| [`stdlib.md`](/typescript-api/mainnet/stdlib.md)              | Protocol types (transactions, blocks, proofs)   |
| [`foundation.md`](/typescript-api/mainnet/foundation.md)      | Low-level utilities (crypto, serialization)     |
| [`constants.md`](/typescript-api/mainnet/constants.md)        | Protocol constants for circuits                 |

## Related Resources

* [Aztec.js Getting Started](/developers/docs/tutorials/js_tutorials/aztecjs-getting-started.md)
* [GitHub: aztec-packages](https://github.com/aztec-labs-eng/aztec-node/tree/v6.0.0/yarn-project)
