快速开始

Ape编译器插件，围绕Cairo语言。

依赖项

• python3版本3.8或更高版本，python3-dev
• Rust

安装

通过pip

您可以通过pip安装最新版本

pip install ape-cairo

通过setuptools

您可以克隆存储库并使用setuptools来获取最新版本

git clone https://github.com/ApeWorX/ape-cairo.git
cd ape-cairo
python3 setup.py install

快速使用

首先，您需要告诉 ape-cairo 如何使用 Cairo 编译器。有两种方法可以实现

1. 在您的 ape-config.yaml 文件中配置 Cairo 清单路径。
2. 构建或添加 Cairo 编译器的二进制文件到您的 $PATH。

这两种方法都需要克隆 Cairo 编译器的源代码

git clone git@github.com:starkware-libs/cairo.git
cd cairo
git fetch --all
git checkout <tag>  # e.g. v1.0.0-alpha.6

要执行第一种方法，将以下内容添加到您的 ape-config.yaml 文件中

cairo:
  manifest: /Users/home/path/to/cairo/Cargo.toml

现在，在编译时，Ape 将使用命令 cargo run --bin <BIN> --manifest-path <CAIRO-MANIFEST>。如果您想执行第二种方法，则为您的操作系统构建发布二进制文件

cargo build --release

注意：这需要在与 Cairo 相同的目录下。

构建完成后，将目标路径添加到您的全局 $PATH 变量中。（您可能想将它添加到您的 .zshrc / .bashrc 文件中）

export PATH=$PATH:$HOME/path/to/cairo/target/release

通过执行以下操作验证您是否在 $PATH 中有 sierra-compile

which sierra-compile

警告：请注意，当使用 Cairo-lang Python 包时，它将添加具有相同名称的冲突二进制文件。如果您已安装 cairo-lang Python 包，请确保您正在使用正确的二进制文件。

which starknet-compile

或者，第一种方法可以避免这个问题。

使用编译器

在项目目录中，其中 contracts/ 目录中有 .cairo 文件，运行 compile 命令

ape compile

它应该在您的 .build/ 文件夹中创建 ContractType 对象，包含合同声明的必要 Sierra 代码。

开发

此项目处于开发阶段，应被视为测试版。事情可能不是最终状态，可能会有破坏性更改。欢迎评论、提问、批评和拉取请求。