From 5c44f4e22a72eaa279022a774f952b7dba9569b2 Mon Sep 17 00:00:00 2001 From: Pranav Gaddamadugu <23022326+d0cd@users.noreply.github.com> Date: Wed, 10 Jul 2024 20:22:59 -0700 Subject: [PATCH] Integrate advanced guides --- .../src/advanced/README.md | 1 - documentation/00_overview.md | 13 ++++++++++++- .../advanced/dive-into-avm/00_overview.md | 6 +++++- .../advanced/dive-into-avm/01_aleo_account_keys.md | 6 +++++- .../advanced/dive-into-avm/02_r1cs.md | 6 +++++- .../advanced/dive-into-avm/03_inclusion_proof.md | 8 ++++++-- .../dive-into-avm/images/aleo_key_generation.png | Bin .../images/avm_execution_flow_overview.png | Bin .../dive-into-avm/images/avs_global_state.png | Bin .../advanced/intro-to-zksnark/00_overview.md | 7 ++++++- 10 files changed, 39 insertions(+), 8 deletions(-) delete mode 100644 documentation updates aleo ambassadors/src/advanced/README.md rename documentation updates aleo ambassadors/src/advanced/dive-into-avm/README.md => documentation/advanced/dive-into-avm/00_overview.md (99%) rename documentation updates aleo ambassadors/src/advanced/dive-into-avm/aleo-account-keys.md => documentation/advanced/dive-into-avm/01_aleo_account_keys.md (96%) rename documentation updates aleo ambassadors/src/advanced/dive-into-avm/circuits-r1cs.md => documentation/advanced/dive-into-avm/02_r1cs.md (97%) rename documentation updates aleo ambassadors/src/advanced/inclusion-proof..md => documentation/advanced/dive-into-avm/03_inclusion_proof.md (95%) rename {documentation updates aleo ambassadors/src => documentation}/advanced/dive-into-avm/images/aleo_key_generation.png (100%) rename {documentation updates aleo ambassadors/src => documentation}/advanced/dive-into-avm/images/avm_execution_flow_overview.png (100%) rename {documentation updates aleo ambassadors/src => documentation}/advanced/dive-into-avm/images/avs_global_state.png (100%) rename documentation updates aleo ambassadors/src/advanced/intro-to-zksnark/general-intuition.md => documentation/advanced/intro-to-zksnark/00_overview.md (99%) diff --git a/documentation updates aleo ambassadors/src/advanced/README.md b/documentation updates aleo ambassadors/src/advanced/README.md deleted file mode 100644 index 931fae06c..000000000 --- a/documentation updates aleo ambassadors/src/advanced/README.md +++ /dev/null @@ -1 +0,0 @@ -# Advanced diff --git a/documentation/00_overview.md b/documentation/00_overview.md index 54775cb37..6b38cd218 100644 --- a/documentation/00_overview.md +++ b/documentation/00_overview.md @@ -91,7 +91,18 @@ An index of all pages available in this documentation. ## Advanced Topics -### Chapter 7: The Aleo Curves +### Chapter 7: Dive into the AVM + +- [Overview](./advanced/dive-into-avm/00_overview.md) +- [Aleo Account Keys](./advanced/dive-into-avm/01_aleo_account_keys.md) +- [Circuits and R1CS](./advanced/dive-into-avm/02_r1cs.md) +- [Inclusion Proofs](./advanced/dive-into-avm/03_inclusion_proof.md) + +### Chapter 8: Introduction to zk-SNARKs + +- [Overview](./advanced/intro-to-zksnark/00_overview.md) + +### Chapter 9: The Aleo Curves - [Overview](./advanced/the_aleo_curves/00_overview.md) - [Edwards BLS12](./advanced/the_aleo_curves/01_edwards_bls12.md) diff --git a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/README.md b/documentation/advanced/dive-into-avm/00_overview.md similarity index 99% rename from documentation updates aleo ambassadors/src/advanced/dive-into-avm/README.md rename to documentation/advanced/dive-into-avm/00_overview.md index c13073271..db26d96f0 100644 --- a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/README.md +++ b/documentation/advanced/dive-into-avm/00_overview.md @@ -1,4 +1,8 @@ -# Aleo’s Virtual Machine (AVM) +--- +id: overview +title: Overview +sidebar_label: Overview +--- The Aleo Virtual Machine (AVM) is a computational platform integral to the Aleo blockchain, designed to run privacy-focused applications. It operates as a stack machine that executes queued instructions. Its primary function is to construct arithmetic circuits described as Rank-1 Constraint System (R1CS), from each instruction in a function. diff --git a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/aleo-account-keys.md b/documentation/advanced/dive-into-avm/01_aleo_account_keys.md similarity index 96% rename from documentation updates aleo ambassadors/src/advanced/dive-into-avm/aleo-account-keys.md rename to documentation/advanced/dive-into-avm/01_aleo_account_keys.md index f618d90b9..d85041a9a 100644 --- a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/aleo-account-keys.md +++ b/documentation/advanced/dive-into-avm/01_aleo_account_keys.md @@ -1,4 +1,8 @@ -# Aleo Account Key Generation +--- +id: aleo_account_keys +title: Aleo Account Keys +sidebar_label: Aleo Account Keys +--- An Aleo account is similar to accounts on other blockchain platforms but designed with a focus on privacy, leveraging cryptographic techniques unique to the platform. Here's a detailed breakdown of the components of an Aleo account and the processes involved in generating addresses, public keys, and private keys: diff --git a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/circuits-r1cs.md b/documentation/advanced/dive-into-avm/02_r1cs.md similarity index 97% rename from documentation updates aleo ambassadors/src/advanced/dive-into-avm/circuits-r1cs.md rename to documentation/advanced/dive-into-avm/02_r1cs.md index e340930e8..2b28eba8c 100644 --- a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/circuits-r1cs.md +++ b/documentation/advanced/dive-into-avm/02_r1cs.md @@ -1,4 +1,8 @@ -# R1CS Circuits +--- +id: r1cs +title: R1CS +sidebar_label: R1CS +--- Aleo Virtual Machine leverages a type of intermediate representation for their circuits called “Rank-1 Constrained System” (R1CS). This format is used to express computations as a system of equations that can later be formally verified. diff --git a/documentation updates aleo ambassadors/src/advanced/inclusion-proof..md b/documentation/advanced/dive-into-avm/03_inclusion_proof.md similarity index 95% rename from documentation updates aleo ambassadors/src/advanced/inclusion-proof..md rename to documentation/advanced/dive-into-avm/03_inclusion_proof.md index 4aed30d41..6024881ac 100644 --- a/documentation updates aleo ambassadors/src/advanced/inclusion-proof..md +++ b/documentation/advanced/dive-into-avm/03_inclusion_proof.md @@ -1,4 +1,8 @@ -# Inclusion Proofs +--- +id: inclusion_proof +title: Inclusion Proofs +sidebar_label: Inclusion Proofs +--- Inclusion proofs are like a special handshake or password that gets you past verifier without revealing the actual element. In Aleo, inclusion proofs are like digital receipts that verify transactions without compromising users' privacy. @@ -12,4 +16,4 @@ In addition to producing these proofs, a user also produces 𝑛+1 “inclusion An inclusion proof also publicly outputs the serial numbers (also called a nullifier in ZCash-like systems) that uniquely identify the records without leaking any information about them. This way, records cannot be consumed more than once. (In addition, the network enforces that no serial number is seen twice within the same transaction.) -**Note:** All of these different proofs are eventually aggregated together into a single proof using Varuna’s batching capabilities. \ No newline at end of file +**Note:** All of these different proofs are eventually aggregated together into a single proof using Varuna’s batching capabilities. diff --git a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/images/aleo_key_generation.png b/documentation/advanced/dive-into-avm/images/aleo_key_generation.png similarity index 100% rename from documentation updates aleo ambassadors/src/advanced/dive-into-avm/images/aleo_key_generation.png rename to documentation/advanced/dive-into-avm/images/aleo_key_generation.png diff --git a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/images/avm_execution_flow_overview.png b/documentation/advanced/dive-into-avm/images/avm_execution_flow_overview.png similarity index 100% rename from documentation updates aleo ambassadors/src/advanced/dive-into-avm/images/avm_execution_flow_overview.png rename to documentation/advanced/dive-into-avm/images/avm_execution_flow_overview.png diff --git a/documentation updates aleo ambassadors/src/advanced/dive-into-avm/images/avs_global_state.png b/documentation/advanced/dive-into-avm/images/avs_global_state.png similarity index 100% rename from documentation updates aleo ambassadors/src/advanced/dive-into-avm/images/avs_global_state.png rename to documentation/advanced/dive-into-avm/images/avs_global_state.png diff --git a/documentation updates aleo ambassadors/src/advanced/intro-to-zksnark/general-intuition.md b/documentation/advanced/intro-to-zksnark/00_overview.md similarity index 99% rename from documentation updates aleo ambassadors/src/advanced/intro-to-zksnark/general-intuition.md rename to documentation/advanced/intro-to-zksnark/00_overview.md index 4c4c776ae..4871a3d0a 100644 --- a/documentation updates aleo ambassadors/src/advanced/intro-to-zksnark/general-intuition.md +++ b/documentation/advanced/intro-to-zksnark/00_overview.md @@ -1,4 +1,9 @@ -# Advanced +--- +id: overview +title: Overview +sidebar_label: Overview +--- + In this section we cover the general intuition of a zk proof, we outline the steps in creating a zksnark, we define the actors in a zk proof mainly the prover and verifier. We also introduce the elements in a zkproof like the witness, intermediate representation, trusted setups, structured reference strings and random oracles. We also give the context of where the zksnark proof is used in Aleo. ## Introduction