Starkware 的 Cairo 开源项目指南

项目概述

Cairo 是一个由Rust语言编写的首屈一指的图灵完备语言，专门用于创建可证明程序，适用于一般计算。该项目是StarkNet生态系统的核心部分，支持零知识证明和通用计算的高效编译。

项目目录结构及介绍

Cairo项目遵循清晰的组织结构，下面是主要的目录及其简要说明：

• corelib: 包含Cairo语言的核心库实现。
• crates: 分离编译的组件，每个子目录代表一个Rust crate。
• docs: 项目文档，包括开发指南和技术说明。
• examples: 提供多个示例代码，帮助理解Cairo的使用方法。
• resources/img: 项目相关的图像资源。
• scripts: 启动脚本和其他辅助脚本集合。
• tests: 单元测试和集成测试代码。
• vscode-cairo: 支持VS Code的Cairo语言服务器插件的相关配置。
• Cargo.lock, Cargo.toml: Rust项目的构建配置和依赖关系锁定文件。
• LICENSE, README.md: 许可证文件和项目简介。

项目启动文件介绍

虽然Cairo作为一个库，并没有传统意义上的“启动文件”，其操作主要通过命令行工具执行。关键的执行入口点是由以下命令行程序提供的:

• cairo-compile: 用于将Cairo源码编译成Sierra中间代码。
• sierra-compile: 将Sierra代码进一步编译成Casm（Cairo Assembly）格式。
• cairo-run: 直接运行Cairo代码，适用于快速测试和演示。
• starknet-compile: 针对StarkNet合同的特定编译流程，从Cairo源码编译到JSON格式的ContractClass。

这些工具通常在命令行中通过cargo run --bin <tool-name>调用，其中<tool-name>替换为上述任何一个工具名。

项目配置文件介绍

主要配置文件

• Cargo.toml: 这是Rust项目的配置中心，定义了项目的名称、版本、作者、依赖项和构建指令。它还指定如何编译项目以及项目的不同组件（如库和二进制工具）。
• Cargo.lock: 该文件记录项目具体依赖的版本，确保每次构建时使用的依赖都是相同的，从而保持构建的一致性。

特定配置

在开发过程中，可能还会遇到其他配置文件，比如.editorconfig用于编辑器一致性，.gitignore定义了Git应忽略的文件类型。然而，这些不是项目功能直接相关的配置，更多是开发环境的辅助配置。

编译和配置说明

对于开发者来说，重要的“配置”往往涉及到Rust的环境设置，比如通过rustup管理不同的Rust工具链版本，并确保正确设置了工作区环境。此外，开发新功能或修改编译流程时，直接在这些配置文件内进行改动即可调整项目的行为。

---

以上内容构成了Cairo项目的初步使用指南，涵盖了基础的目录结构、关键启动工具和核心配置文件。深入学习时，参考项目文档和例子将是更具体的实践指南。