Aztec Packages 开源项目安装与使用指南

本指南旨在提供关于Aztec Protocol的aztec-packages仓库的详细指引，包括其目录结构、启动文件以及配置文件的解析，帮助开发者快速上手并有效利用此开源项目。

1. 项目的目录结构及介绍

aztec-packages仓库采用了单体仓库（Monorepo）的管理方式，包含了构建Aztec网络所需的各种软件包。以下是关键目录的简介：

• l1-contracts: 包含用于Ethereum上处理rollups的Solidity智能合约。

• yarn-project: 类型脚本代码，涵盖了客户端与后端开发。

• docs: 文档来源代码，用于站点上Aztec协议的文档展示。

• Aztec.nr: 特定于Aztec的Noir框架，用于开发智能合约。

• Aztec: 启动本地开发网络模块，如“sandbox”devnet、Ethereum网络、部署的rollup合同以及Aztec执行环境。

• Aztec.js: 交互工具，通过Private Execution Environment (PXE)与Aztec网络通信。

• Example contracts: 使用Noir编写的Aztec网络示例合同。

• End to end tests: TypeScript编写的集成测试案例，作为如何使用这些包完成特定任务的参考。

• Aztec Boxes: 快速入门的示例项目模板。

其他重要文件和目录如.github用于存放GitHub工作流配置，build-system用于管理CI/CD流程，以及scripts目录内包含各种辅助脚本等。

2. 项目的启动文件介绍

主要启动脚本：bootstrap.sh

位于项目根目录下的bootstrap.sh是主要的设置脚本，分为两种运行模式：

• full: 完全设置，包括更新子模块、下载Ignition transcripts、安装Foundry、编译Solidity合约、通过nvm安装当前节点版本，并构建所有TypeScript包。
• fast: 适用于仅需调试Noir合约或TypeScript时快速设置，它将从CI缓存中下载现有的Barretenberg和Nargo构建，但要求有AWS ECR凭据且最好在Ubuntu系统上操作。

3. 项目的配置文件介绍

• CODEOWNERS: 指定了仓库中的文件到负责人的映射，确保Pull Request能够正确分配审查者。

• .editorconfig: 保证跨编辑器的代码风格一致性。

• .gitattributes, .gitignore, .gitmodules: 版本控制相关的配置，用于忽略不需要提交的文件、定义子模块信息等。

• release-please-manifest.json: 控制自动发布流程，确定哪些更改触发新的版本生成。

• CIRCLE_CI相关配置: 如存在，通常隐藏于.circleci/config.yml，用于配置持续集成步骤。

• 环境变量配置：例如，调试时可能需要设置DEBUG来指定日志输出详情，具体配置不在文件内，但会影响日志行为。

请注意，实际的配置文件细节和作用可能随着项目维护和更新而有所变化，因此建议查阅仓库内的最新文件注释或文档以获取最准确的信息。在进行任何配置修改前，请仔细阅读相关说明，确保理解其对项目的影响。