diff --git a/docs/developer_versioned_docs/version-v4.3.0/docs/aztec-nr/framework-description/authentication_witnesses.md b/docs/developer_versioned_docs/version-v4.3.0/docs/aztec-nr/framework-description/authentication_witnesses.md index cb5660f9de62..e6ab5ccb13b8 100644 --- a/docs/developer_versioned_docs/version-v4.3.0/docs/aztec-nr/framework-description/authentication_witnesses.md +++ b/docs/developer_versioned_docs/version-v4.3.0/docs/aztec-nr/framework-description/authentication_witnesses.md @@ -8,6 +8,12 @@ references: ["noir-projects/noir-contracts/contracts/app/token_contract/src/main Authentication witnesses (authwit) allow other contracts to execute actions on behalf of your account. This guide shows you how to implement and use authwits in your Aztec smart contracts. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +For a video walkthrough of the concepts and the implementation pattern, watch this explainer (find more on the [video lessons](../../resources/video_lessons.mdx) page): + + + ## Prerequisites - An Aztec contract project set up with `aztec-nr` dependency diff --git a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/advanced/authwit.md b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/advanced/authwit.md index 664d2b5fe99f..1067c51c0cc2 100644 --- a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/advanced/authwit.md +++ b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/advanced/authwit.md @@ -8,6 +8,12 @@ description: Learn about Aztec's Authentication Witness scheme that enables secu Authentication Witness is a scheme for authenticating actions on Aztec, allowing users to authorize third-parties (protocols or other users) to execute actions on their behalf. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +For a video walkthrough of how authwits work, including both the private and public flows, watch this explainer (find more on the [video lessons](../../resources/video_lessons.mdx) page): + + + ## Summary - **Authwits authorize specific actions**, not blanket allowances like ERC20 approvals diff --git a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/call_types.md b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/call_types.md index 7f4abc1a8b7d..d9a901d57f30 100644 --- a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/call_types.md +++ b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/call_types.md @@ -18,6 +18,12 @@ We say that a smart contract is called when one of its functions is invoked and There are multiple types of calls, and some of the naming can make things **very** confusing. This page lists the different call types and execution modes, pointing out key differences between them. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +A key property of Aztec calls is that contracts can call each other privately, keeping even the call stack itself private. This two-minute explainer covers the idea before we get into the details (find more on the [video lessons](../resources/video_lessons.mdx) page): + + + ## Ethereum Call Types Aztec's design is heavily influenced by Ethereum, and many APIs and concepts are similar. This section provides background on Ethereum call types for context. If you're already familiar with Ethereum, you can skip to [Aztec Call Types](#aztec-call-types). diff --git a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/index.md b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/index.md index a64fc03315b8..89f78783c6f2 100644 --- a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/index.md +++ b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/index.md @@ -6,6 +6,7 @@ description: Overview of Aztec, a privacy-first Layer 2 on Ethereum supporting s --- import Image from "@theme/IdealImage"; +import YouTubeEmbed from "@site/src/components/YouTubeEmbed"; This page outlines Aztec's fundamental technical concepts. It is recommended to read this before diving into building on Aztec. @@ -13,6 +14,10 @@ This page outlines Aztec's fundamental technical concepts. It is recommended to Aztec is a privacy-first Layer 2 on Ethereum. It supports smart contracts with both private & public state and private & public execution. +Prefer video? This explainer covers the core idea in under 90 seconds, and there are more [video lessons](../resources/video_lessons.mdx) available. + + + ## High level view diff --git a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/transactions.md b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/transactions.md index adb4f48cc7fd..85e3ae5611c8 100644 --- a/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/transactions.md +++ b/docs/developer_versioned_docs/version-v4.3.0/docs/foundational-topics/transactions.md @@ -7,6 +7,7 @@ references: ["noir-projects/noir-contracts/contracts/account/ecdsa_k_account_con --- import Image from '@theme/IdealImage'; +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; On this page you'll learn: @@ -15,6 +16,10 @@ On this page you'll learn: - The private and public kernel circuits and how they execute function calls - The call stacks for private and public functions and how they determine a transaction's completion +For a two-minute visual overview of how a single transaction spans private and public execution, watch this explainer (find more on the [video lessons](../resources/video_lessons.mdx) page): + + + ## Simple Example of the (Private) Transaction Lifecycle The transaction lifecycle for an Aztec transaction is fundamentally different from the lifecycle of an Ethereum transaction. diff --git a/docs/developer_versioned_docs/version-v4.3.0/docs/resources/video_lessons.mdx b/docs/developer_versioned_docs/version-v4.3.0/docs/resources/video_lessons.mdx new file mode 100644 index 000000000000..2ed6fde9b41f --- /dev/null +++ b/docs/developer_versioned_docs/version-v4.3.0/docs/resources/video_lessons.mdx @@ -0,0 +1,54 @@ +--- +title: Video lessons +description: "Learn Aztec through short video explainers covering what Aztec is, private and public state, private composability, and getting started." +tags: [videos, learning] +sidebar_position: 0 +--- + +import YouTubeEmbed from "@site/src/components/YouTubeEmbed"; + +Prefer watching to reading? These short explainers, presented by Ciara Nightingale from the Aztec team, each cover a core Aztec concept in just a few minutes. Written pages that go deeper are linked below each video. + +## What is Aztec? + +Aztec is a privacy-first Layer 2 on Ethereum: a zero-knowledge rollup where smart contracts can have both public and private state, and private execution happens locally on your own device. This video explains the core idea in under 90 seconds. + + + +Related reading: [Aztec overview](../../overview.md), [foundational topics](../foundational-topics/index.md) + +## Private and public state in one transaction + +A single Aztec transaction can span private and public execution. Using a private voting contract as the example, this video shows how private execution runs first on your device, producing a proof and side effects (nullifiers, note commitments, and enqueued public calls) that the sequencer then applies in public, keeping your vote private while the tally stays public. + + + +Related reading: [transactions](../foundational-topics/transactions.md), [state management](../foundational-topics/state_management.md) + +## What is private composability? + +On Aztec, smart contracts can call each other privately. Because transactions execute and prove locally, not only the state but the call stack itself can stay private: nobody watching the chain learns which contract called which. This video explains how that lets you build on top of other apps permissionlessly, just like Ethereum, without leaking what you are doing. + + + +Related reading: [call types](../foundational-topics/call_types.md), [calling other contracts](../aztec-nr/framework-description/calling_contracts.md) + +## How authorization works (authwits) + +Authentication witnesses (authwits) are Aztec's generalized alternative to Ethereum's approve and transferFrom pattern: they authorize a specific action for a specific caller, work in both private and public execution, and prevent replay. This lesson walks through the message hash structure, the private and public flows, and the `#[authorize_once]` macro. + + + +Related reading: [authentication witness concepts](../foundational-topics/advanced/authwit.md), [using authwits in aztec.nr](../aztec-nr/framework-description/authentication_witnesses.md) + +## Get started in under 60 seconds + +Ready to build? This video walks through installing the Aztec tooling, creating a new contract project, compiling it, and deploying it to a local network, all in under a minute. + + + +Related reading: [getting started on a local network](../../getting_started_on_local_network.md) + +## More videos + +For a full-length course and more explainers, visit the [Aztec Network YouTube channel](https://www.youtube.com/@aztecnetwork). diff --git a/docs/developer_versioned_docs/version-v4.3.0/getting_started_on_local_network.md b/docs/developer_versioned_docs/version-v4.3.0/getting_started_on_local_network.md index fc4e73838291..a77b6057ad75 100644 --- a/docs/developer_versioned_docs/version-v4.3.0/getting_started_on_local_network.md +++ b/docs/developer_versioned_docs/version-v4.3.0/getting_started_on_local_network.md @@ -21,6 +21,12 @@ What's included in the local network: This guide will teach you how to install the Aztec local network, run it using the Aztec CLI, and interact with contracts using the wallet CLI. To jump right into the testnet instead, click the `Testnet` tab. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +To see the whole flow before you start, watch this one-minute walkthrough (find more on the [video lessons](./docs/resources/video_lessons.mdx) page): + + + ## Prerequisites import { General, Fees } from '@site/src/components/Snippets/general_snippets'; diff --git a/docs/docs-developers/docs/aztec-nr/framework-description/authentication_witnesses.md b/docs/docs-developers/docs/aztec-nr/framework-description/authentication_witnesses.md index 7455e8c529c9..070783b2e228 100644 --- a/docs/docs-developers/docs/aztec-nr/framework-description/authentication_witnesses.md +++ b/docs/docs-developers/docs/aztec-nr/framework-description/authentication_witnesses.md @@ -8,6 +8,12 @@ references: ["noir-projects/noir-contracts/contracts/app/token_contract/src/main Authentication witnesses (authwit) allow other contracts to execute actions on behalf of your account. This guide shows you how to implement and use authwits in your Aztec smart contracts. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +For a video walkthrough of the concepts and the implementation pattern, watch this explainer (find more on the [video lessons](../../resources/video_lessons.mdx) page): + + + ## Prerequisites - An Aztec contract project set up with `aztec-nr` dependency diff --git a/docs/docs-developers/docs/foundational-topics/advanced/authwit.md b/docs/docs-developers/docs/foundational-topics/advanced/authwit.md index d9cf8880def3..773f802dd26c 100644 --- a/docs/docs-developers/docs/foundational-topics/advanced/authwit.md +++ b/docs/docs-developers/docs/foundational-topics/advanced/authwit.md @@ -8,6 +8,12 @@ description: Learn about Aztec's Authentication Witness scheme that enables secu Authentication Witness is a scheme for authenticating actions on Aztec, allowing users to authorize third-parties (protocols or other users) to execute actions on their behalf. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +For a video walkthrough of how authwits work, including both the private and public flows, watch this explainer (find more on the [video lessons](../../resources/video_lessons.mdx) page): + + + ## Summary - **Authwits authorize specific actions**, not blanket allowances like ERC20 approvals diff --git a/docs/docs-developers/docs/foundational-topics/call_types.md b/docs/docs-developers/docs/foundational-topics/call_types.md index 0e2863599192..202611bc4b89 100644 --- a/docs/docs-developers/docs/foundational-topics/call_types.md +++ b/docs/docs-developers/docs/foundational-topics/call_types.md @@ -18,6 +18,12 @@ We say that a smart contract is called when one of its functions is invoked and There are multiple types of calls, and some of the naming can make things **very** confusing. This page lists the different call types and execution modes, pointing out key differences between them. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +A key property of Aztec calls is that contracts can call each other privately, keeping even the call stack itself private. This two-minute explainer covers the idea before we get into the details (find more on the [video lessons](../resources/video_lessons.mdx) page): + + + ## Ethereum Call Types Aztec's design is heavily influenced by Ethereum, and many APIs and concepts are similar. This section provides background on Ethereum call types for context. If you're already familiar with Ethereum, you can skip to [Aztec Call Types](#aztec-call-types). diff --git a/docs/docs-developers/docs/foundational-topics/index.md b/docs/docs-developers/docs/foundational-topics/index.md index a64fc03315b8..89f78783c6f2 100644 --- a/docs/docs-developers/docs/foundational-topics/index.md +++ b/docs/docs-developers/docs/foundational-topics/index.md @@ -6,6 +6,7 @@ description: Overview of Aztec, a privacy-first Layer 2 on Ethereum supporting s --- import Image from "@theme/IdealImage"; +import YouTubeEmbed from "@site/src/components/YouTubeEmbed"; This page outlines Aztec's fundamental technical concepts. It is recommended to read this before diving into building on Aztec. @@ -13,6 +14,10 @@ This page outlines Aztec's fundamental technical concepts. It is recommended to Aztec is a privacy-first Layer 2 on Ethereum. It supports smart contracts with both private & public state and private & public execution. +Prefer video? This explainer covers the core idea in under 90 seconds, and there are more [video lessons](../resources/video_lessons.mdx) available. + + + ## High level view diff --git a/docs/docs-developers/docs/foundational-topics/transactions.md b/docs/docs-developers/docs/foundational-topics/transactions.md index 7399fca41729..24c7b5cc7a27 100644 --- a/docs/docs-developers/docs/foundational-topics/transactions.md +++ b/docs/docs-developers/docs/foundational-topics/transactions.md @@ -7,6 +7,7 @@ references: ["noir-projects/noir-contracts/contracts/account/ecdsa_k_account_con --- import Image from '@theme/IdealImage'; +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; On this page you'll learn: @@ -15,6 +16,10 @@ On this page you'll learn: - The private and public kernel circuits and how they execute function calls - The call stacks for private and public functions and how they determine a transaction's completion +For a two-minute visual overview of how a single transaction spans private and public execution, watch this explainer (find more on the [video lessons](../resources/video_lessons.mdx) page): + + + ## Simple Example of the (Private) Transaction Lifecycle The transaction lifecycle for an Aztec transaction is fundamentally different from the lifecycle of an Ethereum transaction. diff --git a/docs/docs-developers/docs/resources/video_lessons.mdx b/docs/docs-developers/docs/resources/video_lessons.mdx new file mode 100644 index 000000000000..2ed6fde9b41f --- /dev/null +++ b/docs/docs-developers/docs/resources/video_lessons.mdx @@ -0,0 +1,54 @@ +--- +title: Video lessons +description: "Learn Aztec through short video explainers covering what Aztec is, private and public state, private composability, and getting started." +tags: [videos, learning] +sidebar_position: 0 +--- + +import YouTubeEmbed from "@site/src/components/YouTubeEmbed"; + +Prefer watching to reading? These short explainers, presented by Ciara Nightingale from the Aztec team, each cover a core Aztec concept in just a few minutes. Written pages that go deeper are linked below each video. + +## What is Aztec? + +Aztec is a privacy-first Layer 2 on Ethereum: a zero-knowledge rollup where smart contracts can have both public and private state, and private execution happens locally on your own device. This video explains the core idea in under 90 seconds. + + + +Related reading: [Aztec overview](../../overview.md), [foundational topics](../foundational-topics/index.md) + +## Private and public state in one transaction + +A single Aztec transaction can span private and public execution. Using a private voting contract as the example, this video shows how private execution runs first on your device, producing a proof and side effects (nullifiers, note commitments, and enqueued public calls) that the sequencer then applies in public, keeping your vote private while the tally stays public. + + + +Related reading: [transactions](../foundational-topics/transactions.md), [state management](../foundational-topics/state_management.md) + +## What is private composability? + +On Aztec, smart contracts can call each other privately. Because transactions execute and prove locally, not only the state but the call stack itself can stay private: nobody watching the chain learns which contract called which. This video explains how that lets you build on top of other apps permissionlessly, just like Ethereum, without leaking what you are doing. + + + +Related reading: [call types](../foundational-topics/call_types.md), [calling other contracts](../aztec-nr/framework-description/calling_contracts.md) + +## How authorization works (authwits) + +Authentication witnesses (authwits) are Aztec's generalized alternative to Ethereum's approve and transferFrom pattern: they authorize a specific action for a specific caller, work in both private and public execution, and prevent replay. This lesson walks through the message hash structure, the private and public flows, and the `#[authorize_once]` macro. + + + +Related reading: [authentication witness concepts](../foundational-topics/advanced/authwit.md), [using authwits in aztec.nr](../aztec-nr/framework-description/authentication_witnesses.md) + +## Get started in under 60 seconds + +Ready to build? This video walks through installing the Aztec tooling, creating a new contract project, compiling it, and deploying it to a local network, all in under a minute. + + + +Related reading: [getting started on a local network](../../getting_started_on_local_network.md) + +## More videos + +For a full-length course and more explainers, visit the [Aztec Network YouTube channel](https://www.youtube.com/@aztecnetwork). diff --git a/docs/docs-developers/getting_started_on_local_network.md b/docs/docs-developers/getting_started_on_local_network.md index 38492b7107cc..be976a44a186 100644 --- a/docs/docs-developers/getting_started_on_local_network.md +++ b/docs/docs-developers/getting_started_on_local_network.md @@ -24,6 +24,12 @@ What's included in the local network: This guide will teach you how to install the Aztec local network, run it using the Aztec CLI, and interact with contracts using the wallet CLI. To jump right into the testnet instead, click the `Testnet` tab. +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +To see the whole flow before you start, watch this one-minute walkthrough (find more on the [video lessons](./docs/resources/video_lessons.mdx) page): + + + ## Prerequisites import { General, Fees } from '@site/src/components/Snippets/general_snippets'; diff --git a/docs/docs-participate/index.md b/docs/docs-participate/index.md index 31a2b2a39f10..0a9f1d91439f 100644 --- a/docs/docs-participate/index.md +++ b/docs/docs-participate/index.md @@ -12,6 +12,14 @@ Welcome to the Participate section. Here you'll find educational content about h Aztec is currently in its **Alpha** phase, a live mainnet where bugs, including critical ones, are expected. Before using the network, read the [Alpha Network](/participate/alpha) page to understand current limitations, security expectations, and what to expect from rollup upgrades. ::: +import YouTubeEmbed from '@site/src/components/YouTubeEmbed'; + +## What is Aztec? + +This explainer covers what Aztec is in under 90 seconds (find more on the [video lessons](/developers/docs/resources/video_lessons) page): + + + ## Basics of Aztec New to Aztec? Start here to understand the fundamentals: diff --git a/docs/docs-words.txt b/docs/docs-words.txt index b434ff252c7d..7a34dcfc114f 100644 --- a/docs/docs-words.txt +++ b/docs/docs-words.txt @@ -445,3 +445,7 @@ Wonderland indistinguishability unlinkable nightlies +Ciara +Nightingale +Mayopg +VRZVO diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index bd9c64bef103..b1bcc994d647 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -181,6 +181,18 @@ privacy, check out the [foundational topics](/developers/docs/foundational-topic
+ + + + + } +/> + Other Docs', className: "dropdown-subtitle", }, + { + to: "/developers/docs/resources/video_lessons", + label: "Video Lessons", + className: "no-external-icon", + }, { to: "/developers/docs/resources/glossary", label: "Glossary", diff --git a/docs/src/components/YouTubeEmbed/index.tsx b/docs/src/components/YouTubeEmbed/index.tsx new file mode 100644 index 000000000000..32a29b2968bf --- /dev/null +++ b/docs/src/components/YouTubeEmbed/index.tsx @@ -0,0 +1,30 @@ +import React from 'react'; + +interface YouTubeEmbedProps { + videoId: string; + title: string; +} + +export default function YouTubeEmbed({ videoId, title }: YouTubeEmbedProps) { + return ( +
+ +
+ ); +}