Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/docs-learn/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: The Aztec Network
description: Learn about and participate in the Aztec network - a decentralized privacy-focused rollup on Ethereum.
hide_table_of_contents: true
---

import Link from '@docusaurus/Link';
import useBaseUrl from '@docusaurus/useBaseUrl';

# The Aztec Network

The Aztec network is a decentralized privacy-focused rollup on Ethereum. Network participants work together to process transactions, maintain state, generate proofs, and govern the protocol.

Choose your path based on how you want to engage with the network:
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Delegating Stake
description: Learn how to delegate your stake to operators on the Aztec network without running infrastructure.
displayed_sidebar: usersSidebar
displayed_sidebar: sidebar
---

# Delegating Stake
Expand All @@ -12,15 +12,15 @@ If you want to participate in staking but don't want to run your own infrastruct

Understanding these concepts will help you choose the right operator:

- [How proof of stake works](../concepts/proof-of-stake/)
- [Slashing conditions](../concepts/proof-of-stake/#slashing) - your delegated stake can be slashed
- [How governance works](../concepts/governance/) - understand voting power
- [How proof of stake works](/network/concepts/proof-of-stake/)
- [Slashing conditions](/network/concepts/proof-of-stake/#slashing) - your delegated stake can be slashed
- [How governance works](/network/concepts/governance/) - understand voting power

## How Delegation Works

When you delegate tokens to an operator:

1. **Your tokens are staked** through the operator's validator
1. **Your tokens are staked** through the operator's sequencer
2. **The operator runs infrastructure** on your behalf
3. **Rewards are shared** between you and the operator based on their fee structure
4. **Slashing risk is shared** - if the operator misbehaves, your delegated stake can be slashed
Expand Down Expand Up @@ -77,5 +77,5 @@ To maintain control over your votes:
## Next Steps

- [Learn about voting](./voting) with your staked or delegated tokens
- [Understand slashing](../concepts/proof-of-stake/#slashing) to know the risks
- [Run your own validator](../operators/setup/sequencer_management) if you prefer direct control
- [Understand slashing](/network/concepts/proof-of-stake/#slashing) to know the risks
- [Run your own sequencer](/network/operators/setup/sequencer_management) if you prefer direct control
38 changes: 38 additions & 0 deletions docs/docs-learn/token/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: $AZTEC Token Overview
description: Learn about the $AZTEC token and its utility within the Aztec Network ecosystem.
displayed_sidebar: sidebar
---

# $AZTEC Token Overview

The $AZTEC token is the native token of the Aztec Network.

## Token Specifications

| Property | Value |
|----------|-------|
| **Token Name** | Aztec |
| **Ticker** | AZTEC |
| **Standard** | ERC-20 (Ethereum) |
| **Contract Address** | `0xA27EC0006e59f245217Ff08CD52A7E8b169E62D2` |
| **Decimals** | 18 |
| **Total Supply** | 10,350,000,000 AZTEC |

## Key Information

- **Token Type**: The $AZTEC token is issued as an immutable ERC-20 token on Ethereum mainnet without privacy-preserving features.
- **Launch**: Token Generation Event (TGE) occurred in early 2026, with tokens becoming fully tradable on February 12th, 2026.

## Token Utility

The $AZTEC token serves multiple purposes within the Aztec Network ecosystem:

- **Fee Payment**: Used for transaction fees and network operations
- **Governance**: Token holders can participate in protocol governance decisions
- **Staking**: Network participants can stake AZTEC to secure the network and earn rewards


:::note
Please verify the contract address and other specifications with official Aztec sources before interacting with the token.
:::
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Staking Tokens
description: Learn how to stake tokens on the Aztec network to participate in network security and earn rewards.
displayed_sidebar: usersSidebar
displayed_sidebar: sidebar
---

# Staking Tokens
Expand All @@ -23,14 +23,14 @@ When you stake tokens on the Aztec network, your tokens are locked in a smart co

### Key Concepts

- **Activation Threshold**: The minimum amount required to become an active validator
- **Activation Threshold**: The minimum amount required to become an active sequencer
- **Staking Period**: Tokens must remain staked for a minimum period before withdrawal
- **Rewards**: Earned based on your stake proportion and network activity
- **Slashing Risk**: Validators who misbehave may have a portion of their stake slashed
- **Slashing Risk**: Sequencers who misbehave may have a portion of their stake slashed

## Staking Options

### Option 1: Run Your Own Validator
### Option 1: Run Your Own Sequencer

If you have the technical expertise and infrastructure, you can run your own sequencer node and stake directly.

Expand All @@ -50,9 +50,9 @@ See [Delegating Stake](./delegation) for details.
## Understanding Slashing Risk

Before staking, understand that your stake can be partially slashed if:
- The validator you stake with (or delegate to) commits protocol violations
- The validator is inactive for extended periods
- The validator proposes or attests to invalid blocks
- The provider you stake with (or delegate to) commits protocol violations
- The provider is inactive for extended periods
- The provider proposes or attests to invalid blocks

See [Slashing Concepts](../concepts/proof-of-stake/#slashing) for detailed information.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Voting on Proposals
description: Learn how to vote on governance proposals on the Aztec network using your staked tokens.
displayed_sidebar: usersSidebar
displayed_sidebar: sidebar
---

# Voting on Proposals
Expand Down
4 changes: 2 additions & 2 deletions docs/docs-network/concepts/governance/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you're a token holder looking to participate in governance, here's what you n
| **I want to vote differently than the default** | Delegate your voting power to yourself | You can cast your own votes on proposals |
| **I have tokens but haven't staked** | Lock tokens in the Governance contract | You gain voting power without staking rewards or slashing risk |

For step-by-step instructions, see [Voting on Proposals](../../users/voting.md).
<!-- For step-by-step instructions, see [Voting on Proposals](../../users/voting.md). -->

## Design Goals

Expand Down Expand Up @@ -120,5 +120,5 @@ To participate in governance as a sequencer (signaling and voting), see [Governa
:::

:::tip For Token Holders
To vote on proposals with your staked tokens, see [Voting on Proposals](../users/voting).
<!-- To vote on proposals with your staked tokens, see [Voting on Proposals](../users/voting). -->
:::
4 changes: 2 additions & 2 deletions docs/docs-network/concepts/proof-of-stake/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Validators must stake tokens on L1 to join the sequencer set. The staked tokens

### Stake Delegation

Token holders who don't want to run their own infrastructure can delegate their stake to professional operators. See the [Delegating Stake](../users/delegation) guide for details.
<!-- Token holders who don't want to run their own infrastructure can delegate their stake to professional operators. See the [Delegating Stake](../users/delegation) guide for details. -->

### Key Registration

Expand Down Expand Up @@ -177,7 +177,7 @@ Since both delays start at the same time, the effective wait is whichever is lon
2. **Wait for the exit delay**: Your tokens remain locked during this period
3. **Finalize withdrawal**: After the delay, complete the withdrawal to receive your tokens

For step-by-step instructions, see the [Unstaking Guide](../../users/staking.md#unstaking).
<!-- For step-by-step instructions, see the [Unstaking Guide](../../users/staking.md#unstaking). -->

---

Expand Down
58 changes: 0 additions & 58 deletions docs/docs-network/users/index.md

This file was deleted.

44 changes: 36 additions & 8 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ const lightTheme = themes.github;
const darkTheme = themes.dracula;

// @ts-ignore
import math from "remark-math";
const math = require("remark-math").default || require("remark-math");
// @ts-ignore
import katex from "rehype-katex";
const katex = require("rehype-katex").default || require("rehype-katex");

// @ts-ignore
const path = require("path");
Expand All @@ -32,9 +32,12 @@ const testnetVersion = networkVersions.find((v) => !v.includes("ignition"));

// Always serve from processed-docs (with resolved macros)
// Preprocessing runs on both `yarn start` and `yarn build`
const docsPath = "processed-docs/docs";
const developerDocsPath = "processed-docs/docs-developers";
const networkDocsPath = "processed-docs/docs-network";
// In development, serve from source directories for hot reload
const isDev = process.env.NODE_ENV === "development";
const docsPath = isDev ? "docs" : "processed-docs/docs";
const developerDocsPath = isDev ? "docs-developers" : "processed-docs/docs-developers";
const networkDocsPath = isDev ? "docs-network" : "processed-docs/docs-network";
const learnDocsPath = isDev ? "docs-learn" : "processed-docs/docs-learn";

// Shared remark/rehype plugins configuration
const remarkPlugins = [math];
Expand Down Expand Up @@ -106,6 +109,24 @@ const config = {
},
],
plugins: [
// Learn docs instance (general users)
[
"@docusaurus/plugin-content-docs",
{
id: "learn",
path: learnDocsPath,
routeBasePath: "learn",
sidebarPath: "./sidebars-learn.js",
editUrl: (params) => {
return (
`https://github.com/AztecProtocol/aztec-packages/edit/next/docs/docs-learn/` +
params.docPath
);
},
remarkPlugins,
rehypePlugins,
},
],
// Developer docs instance - nightly/devnet versions
[
"@docusaurus/plugin-content-docs",
Expand Down Expand Up @@ -268,10 +289,13 @@ const config = {
src: "img/Aztec Wordmark_Dark.svg",
},
items: [
// Unified version dropdown - shows context-aware versions based on current section
// Learn sidebar link
{
type: "custom-unifiedVersionDropdown",
type: "docSidebar",
sidebarId: "sidebar",
docsPluginId: "learn",
position: "left",
label: "Learn",
},
// Developer sidebar link
{
Expand All @@ -281,7 +305,6 @@ const config = {
position: "left",
label: "Build",
},

// Network portal link
{
type: "doc",
Expand All @@ -290,6 +313,11 @@ const config = {
position: "left",
label: "Network",
},
// Unified version dropdown - shows context-aware versions based on current section
{
type: "custom-unifiedVersionDropdown",
position: "right",
},
{
to: "/networks",
label: "Networks",
Expand Down
3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"spellcheck": "yarn cspell",
"spellcheck:appendwords": "yarn cspell --words-only --unique | sort --ignore-case >> docs-words.txt",
"start": "yarn clean && yarn preprocess && yarn generate:aztec-nr-api && docusaurus start --host ${HOST:-localhost}",
"local": "docusaurus start --host ${HOST:-localhost}",
"test": "node --test src/preprocess/__tests__/*.test.js",
"test:preprocess": "node --test src/preprocess/__tests__/*.test.js"
},
Expand Down Expand Up @@ -90,5 +91,5 @@
"ws@npm:8.13.0": "npm:8.17.1",
"path-to-regexp@npm:^1.7.0": "npm:1.9.0"
},
"packageManager": "yarn@4.5.2"
"packageManager": "yarn@4.12.0"
}
48 changes: 48 additions & 0 deletions docs/sidebars-learn.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// @ts-check
// Sidebar configuration for Network documentation
// Supports three sections: Concepts, Users, and Operators

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// ============================================
// SIDEBAR
// ============================================
sidebar: [
{
type: "html",
value: '<span class="sidebar-divider" />',
},
{
type: "html",
value: '<span class="sidebar-title">$AZTEC</span>',
className: "sidebar-title",
},
{
type: "doc",
id: "token/index",
label: "Overview",
},
{
type: "doc",
id: "token/overview",
label: "Overview",
},
{
type: "doc",
id: "token/staking",
label: "Staking Tokens",
},
{
type: "doc",
id: "token/delegation",
label: "Delegating Stake",
},
{
type: "doc",
id: "token/voting",
label: "Voting on Proposals",
},
],
};

module.exports = sidebars;
Loading