Rosetta SDK 文档

Rosetta 是一套用于区块链集成的工具，它的目标是使区块链集成更简单、更快、更可靠。本仓库提供了一个框架，用于 Analog 的 chronicles（由时间节点运营商托管的特殊节点）以符合 Analog 网络协议的方式简化与 Analog 连接的链的交互。

仓库结构

本仓库包含以下模块

• rosetta-core. 提供服务器和客户端 crate 共享的特性和定义。
• rosetta-server. 这是一个通用的 Rosetta 服务器实现。Rosetta 服务器是一个独立的服务器，任何 Analog 支持的链上的连接器都可以连接并监听设置中指定的端口。
• rosetta-client. 这是一个标准客户端，与 Rosetta 服务器交互。
• rosetta-types. 它包含客户端和服务器使用的请求和响应结构。它最初使用 openapi-generator 自动生成。
• rosetta-crypto. 它包含 rosetta-client 使用的加密原语。
• rosetta-wallet. 这是一个使用 rosetta-client 构建的命令行界面 (CLI)。
• rosetta-cli. 这是一个使用 rosetta-client 构建的 CLI。
• rosetta-docker. 这是一个通用的 Rosetta 服务器测试基础设施。
• chains. 这些是特定链的客户端/服务器组件。

入门指南

要开始使用 Rosetta SDK，请确保已安装以下依赖项

• rust
• Docker 的最新版本
• solc 0.8.20+，建议使用 svm 安装： https://github.com/alloy-rs/svm-rs
• dprint：cargo install --locked dprint
• cargo-deny：cargo install --locked cargo-deny

构建

$ cargo build -p rosetta-client

代码检查

$ cargo +nightly fmt --all -- --check
$ cargo clippy --locked --workspace --examples --tests --all-features -- \
  -Dwarnings \
  -Dclippy::unwrap_used \
  -Dclippy::expect_used \
  -Dclippy::nursery \
  -Dclippy::pedantic \
  -Aclippy::module_name_repetitions
$ dprint check
$ cargo deny check

运行单元测试

$ cargo test --workspace --all-features \
  --exclude rosetta-testing-arbitrum \
  --exclude rosetta-server-astar \
  --exclude rosetta-server-ethereum \
  --exclude rosetta-server-polkadot \
  --exclude rosetta-client

运行集成测试

# Pull docker images
./scripts/pull_nodes.sh

# Run tests
$ cargo test \
  -p rosetta-server-astar \
  -p rosetta-server-ethereum \
  -p rosetta-server-polkadot \
  -p rosetta-client

运行Arbitrum集成测试

# Setup arbitrum local testnet
git clone -b release --depth=1 --no-tags --recurse-submodules https://github.com/ManojJiSharma/nitro-testnode.git
cd nitro-testnode
./test-node.bash --detach
cd ..

# Run tests
cargo test --locked -p rosetta-testing-arbitrum

贡献

您可以通过多种方式为此仓库做出贡献，包括

• 提问
• 提供反馈
• 报告错误阅读我们的贡献指南以获取有关如何为此仓库做出贡献的更多信息。