Geti SDK

Geti SDK 是一个用于审计 Arbitrum Stylus Rust 智能合约的综合工具。本指南将帮助您开始使用 SDK 来审计您的智能合约。

安装

要使用 Geti SDK，请确保您已安装 Rust 和 Cargo。如果您尚未安装 Rust，请遵循官方 Rust 网站上的说明。

将 Geti SDK 添加到项目的 Cargo.toml 文件

[dependencies]
geti = "0.1.0" # Ensure this matches the version on crates.io

然后，运行

cargo build

使用方法

Geti SDK 提供了多种功能来帮助审计 Rust 智能合约。以下是使用 SDK 的步骤

命令行工具

命令行工具允许您通过命令行命令与 SDK 进行交互。

命令

1. 提取智能合约文件

   从指定目录提取 Rust 智能合约文件。

   cargo run -- extract --path <directory-path>
   

   示例

   cargo run -- extract --path ./contracts
   

2. 读取并显示 Markdown 文件

   读取并显示指定 markdown 文件的内容。

   cargo run -- read-markdown --path <file-path>
   

   示例

   cargo run -- read-markdown --path ./docs/project-description.md
   

3. 执行审计

   通过从指定目录提取合约文件并读取 markdown 文件来执行审计。响应包括审计报告的链接。

   cargo run -- audit --contract-path <directory-path> --markdown-path <file-path>
   

   示例

   cargo run -- audit --contract-path ./contracts --markdown-path ./docs/project-description.md
   

运行审计后，您将收到一个包含审计报告链接的响应。点击链接查看详细的审计结果。

示例工作流程

1. 提取合约

   从 contracts 目录提取合约文件

   cargo run -- extract --path ./contracts
   

2. 读取 Markdown 文件

   读取 project-description.md 的内容

   cargo run -- read-markdown --path ./docs/project-description.md
   

3. 执行审计

   使用 contracts 目录中的合约文件和位于 project-description.md 的 markdown 文件执行审计

   cargo run -- audit --contract-path ./contracts --markdown-path ./docs/project-description.md
   

   这将提供审计报告的链接。

贡献

我们欢迎对Geti SDK的改进贡献。如果您有建议或发现错误，请在我们GitHub仓库上提交问题或pull request。

许可证

本项目采用MIT许可证。有关详细信息，请参阅LICENSE文件。

感谢您使用Geti SDK！如果您有任何问题或需要进一步的帮助，请随时联系我们或在GitHub上提交问题。