The purpose of this tutorial repository is to provide a Web 3.0 Aztec Network getting started learning path for Web 2.0 developers who are new to working with Aztec technology and Web 3.0 in general.
There are several screenshots in this tutorial. They are not necessarily applicable to your own personal developer path and experience - they are a general guide.
Aztec is an open source layer 2 protocol (or network) which aims to bring scalability and privacy to Ethereum. It strives to enable affordable, private crypto payments via zero-knowledge proofs.
From the Aztec Vision website
Privacy isn't just a human right, it's a tool for creativity. With privacy by default, the world of games, NFTs, and DeFi applications just got bigger. Aztec is an open source layer 2 network that aims to bring scalability and privacy to Ethereum. It strives to enable affordable, private crypto payments via zero-knowledge proofs. Aztec is built from the ground up to be privacy-first.
Discord will help you to communicate with the Aztec Network Developer Relations Engineering team.
- Network Name (recommended)
Aztec Mainnet Fork- RPC URL
https://mainnet-fork.aztec.network- Chain ID
677868- Currency Symbol
ETH- Rollup Provider URL
https://api.aztec.network/aztec-connect-testnet/falafel- Block Explorer URL (optional)
https://aztec-connect-testnet-explorer.aztec.network
These notes record steps that were performed on a macOS development laptop and a Linux (Ubuntu) development laptop.
Other operating systems should have similar options to enable the equivalent operations.
I use the Homebrew package manager on my macOS development laptop.
Package managers like Homebrew for macOS have equivalents such as Chocolatey for Windows and many others for Linux.
Here is a list of software package management systems:
- Aztec Network Introduction
@aztec/sdkand@aztec/bridge-clientsDocumentation and NPM Packages- The Aztec SDK Overview
- The Aztec SDK Starter Repository
- https://github.com/critesjosh/aztec-sdk-starter#requirements
- https://github.com/AztecProtocol/aztec-sdk-starter#requirements
For your reference; How to install Homebrew, NodeJS and NPM on macOS
I already have Homebrew on my macOS system, so I will proceed with installing NodeJS, NPM and Yarn.
$ cd ~
# -- Node
$ brew install node
$ brew info node
$ brew info npm
# -- Yarn
$ brew install yarn
$ brew info yarn
On Linux (Debian/Ubuntu distributions), do the following.
$ cd ~
$ sudo apt-get install -y build-essential
$ curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash - && sudo apt-get install -y nodejs
$ sudo npm install -g npm
$ which node
$ which npm
$ node -v
$ npm -v
As recommended by the official Yarn documentation, install and activate yarn using corepack.
$ sudo npm i -g corepack
$ which corepack
$ corepack enable
$ corepack prepare yarn@stable --activate
$ yarn set version stable
$ which yarn
$ yarn --version
Do the following if it becomes necessary to remove/uninstall yarn with corepack:
$ sudo corepack disable yarnEnsure that TypeScript and its dependencies are installed.
$ npm install ts-node --save-dev
$ npm install typescript -g
$ npm install typescript --save-dev
On Linux.
$ sudo npm install ts-node --save-dev
$ sudo npm install typescript -g
$ sudo npm install typescript --save-dev$ mkdir AztecProtocol
$ cd AztecProtocol
$ git clone https://github.com/AztecProtocol/aztec-sdk-starter.git
$ cd aztec-sdk-starter
$ ls -al
On macOS.
$ yarnBe sure to pick the highest, most recent, version number of @aztec/bridge-clients.
On Linux.
$ yarn
Also make sure to periodically check for updates to the repository and dependencies.
$ git pull
$ yarn upYarn upgrade on Linux.
Refer to the following section of the SDK starter repository documentation.
Remain inside the root directory of your local (cloned) aztec-sdk-starter repository and copy the provided example environment script, .env.example, in order to create a .env file.
$ cp .env.example .env
$ ls -al .env*
$ cat .env
Edit your new .env file and add your Ethereum private key or mnemonic.
- DO NOT DISCLOSE THIS TO ANYONE!
- NEVER PUSH THE
.envFILE TO ANY PUBLIC REPOSITORY! - The local Git repository
.gitignorefile should have an exclusion entry for.env.
Now run the ./src/latest/index.ts SDK setup script.
$ yarn go- CryptoCurrency Wiki
- Blockchain and CryptoCurrency Wiki
- Ethereum Development Documentation
- Ethereum Stack Exchange
- Aztec Testnet Version of zk.money
- Aztec Testnet Server Status
- Aztec Testnet Block Explorer
- The Aztec Noir Programming Language
- Aztec Network Introduction
@aztec/sdkand@aztec/bridge-clientsDocumentation and NPM Packages- The Aztec SDK Starter Repository
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent