Getting Started
Building on Aztec
There are two common ways that developers can start building on Aztec:
- Build a user-facing application that connects to the Aztec network via the TypeScript SDK.
- Build an Aztec Connect bridge that connects the Aztec network to Ethereum smart contracts.
We are also working on Noir, an independent domain specific language that can be used to develop ZK-provable programs. Refer to the Noir page for more details.
Running out of ideas to build? Check our Grants for inspirations!
The Aztec core engineering team has a regular release cadence that will occasionally introduce breaking changes. Updates are typically applied to Testnet on Thursdays, which are tested and monitored over the weekend and would be pushed to Mainnet afterwards.
We are working on making this process more transparent. Feel free to get in touch if you have any queries.
Testnet Information
You can run a local development environment by following the instructions on this page.
We have a private testnet and access is reserved for people building products on Aztec. If you need access to the Aztec testing environment, please reach out via email.
Building with the SDK
Setup
To start using the SDK, install it in your project by running:
yarn add @aztec/sdk
And import it into your project:
import { createAztecSdk } from "@aztec/sdk";
For a proper walkthrough of setting up the SDK, check the SDK Setup page.
Example Code
To learn how the SDK works in action, the CLI page provides a detailed breakdown of the Aztec CLI tool powered by the SDK.
If you are building a web interface, you might also find the Frontend Boilerplate useful as a starting point.
By default, Aztec transactions could take up to a few hours to settle on the Testnet like on Mainnet. If you want transactions to settle quickly, be sure to set TxSettlementTime as INSTANT.
INSTANT transactions pay higher fees in ETH in exchange for settlement within minutes rather than hours.
Aztec SDK Resources
- 🧑💻 Aztec SDK npm
- 🧑💻 Aztec SDK GitHub Repo
- 🎥 ETHBogota Workshop - Aztec CLI / SDK
- ✍️ Getting Started with Aztec CLI / SDK
- 📝 Aztec CLI
- 📝 Aztec Frontend Boilerplate
Building an Aztec Connect Bridge Contract
The Aztec Connect Bridges page covers how to develop an Aztec Connect Bridge in great detail.
The Aztec Connect Bridges repository has the most up to date information and materials for creating a bridge contract.
Bridges Resources
- 🧑💻 Aztec Connect Bridges GitHub Repo
- 🎥 ETHBogota Workshop - Aztec Connect Bridges
- ✍️ Getting Started with Aztec Connect Bridges
- ✍️ Element Bridge Explained
Get in Touch
Discord
Join Aztec Discord for discussions across channels:
#🚅│aztec-connectfor SDK & Bridges#🖤│noirfor Noir
Aztec Core Team Contacts
All questions, comments, suggestions, ideas, etc. welcome.
| Name | Role | Discord | Telegram | ||
|---|---|---|---|---|---|
| Josh | Developer Relations | joshc#6779 | @crites | @critesjosh_ | josh@aztecprotocol.com |
| Savio | Developer Relations | Globallager#4834 | @Globallager | @globallager | savio@aztecprotocol.com |
| Lasse | Engineer - Bridge & Smart Contract | LHerskind#8376 | @HerskindLasse | lasse@aztecprotocol.com | |
| Maxim | Engineer - Noir | vezzie#7609 | @maximvezenov | maxim@aztecprotocol.com |