Aztec.js

Aztec.js is a library that provides APIs for managing accounts and interacting with contracts on the Aztec network. It communicates with the Private eXecution Environment (PXE) through a PXE implementation, allowing developers to easily register new accounts, deploy contracts, view functions, and send transactions.

Installing

npm install @aztec/aztec.js@3.0.0-devnet.6-patch.1

Guides

📄️ Connect to Local Network

Connect your application to the Aztec local network and interact with accounts.

📄️ Creating Accounts

Step-by-step guide to creating and deploying new user accounts in Aztec.js applications.

📄️ Deploying Contracts

Deploy smart contracts to Aztec using generated TypeScript classes.

📄️ Sending Transactions

Send transactions to Aztec contracts using Aztec.js with various options and error handling

📄️ Simulating Functions

How to simulate function calls and read contract state without creating transactions.

📄️ Using Authentication Witnesses

Step-by-step guide to implementing authentication witnesses in Aztec.js for delegated transactions.

📄️ Paying Fees

Pay transaction fees on Aztec using different payment methods and fee paying contracts.

📄️ Testing Smart Contracts

Learn how to write and run tests for your Aztec smart contracts using Aztec.js and a local network.

📄️ Reference

Comprehensive auto-generated reference for the Aztec.js TypeScript library with all classes, interfaces, types, and functions.

📄️ TypeScript API Reference

API reference documentation for Aztec TypeScript packages including aztec.js, accounts, PXE, and core libraries.