快速入门指南 - OpenZeppelin 文档

快速开始指南

本指南提供了设置 OpenZeppelin Relayer 的分步说明。它包括先决条件、安装和配置示例。

先决条件

• Rust 2021 edition

• Redis

• Docker (可选，用于容器化部署)

• Node.js、typescript 和 ts-node (可选，用于插件)

配置

步骤 1：克隆存储库

克隆存储库并导航到项目目录：

git clone https://github.com/OpenZeppelin/openzeppelin-relayer
cd openzeppelin-relayer

步骤 2：创建配置文件

创建环境配置：

cp .env.example .env

这些文件已经部分配置。我们将在接下来的步骤中添加缺失的数据。

要使用各种配置进行快速设置，请查看我们 GitHub 存储库中的 examples directory：

步骤 3：创建一个签名者

为基本示例生成一个新的签名者密钥库：

cargo run --example create_key -- \
  --password <DEFINE_YOUR_PASSWORD> \
  --output-dir examples/basic-example/config/keys \
  --filename local-signer.json

将 <DEFINE_YOUR_PASSWORD> 替换为一个强密码。

接下来，使用上面使用的密码更新 .env 中的 KEYSTORE_PASSPHRASE。

步骤 4：配置通知

配置 Webhook URL

编辑文件 config/config.json 并使用你的 webhook URL 更新 notifications[0].url 字段。要进行快速测试，你可以使用 Webhook.site 中的临时 URL。

配置 Webhook 签名密钥

生成一个 webhook 签名密钥：

cargo run --example generate_uuid

复制生成的 UUID 并更新 .env 中的 WEBHOOK_SIGNING_KEY 条目。

步骤 5：配置 API 密钥

生成一个用于开发的 API 密钥签名密钥：

cargo run --example generate_uuid

复制生成的 UUID 并更新 .env 中的 API_KEY 条目。

步骤 6：运行服务

本地

运行 Redis 容器：

docker run --name openzeppelin-redis \
  -p 6379:6379 \
  -d redis:latest

运行 Relayer 服务：

cargo run

Docker

构建和运行 docker 镜像：

docker compose up -d

默认情况下，docker compose 命令使用 Dockerfile.development 来构建镜像。如果要使用 Dockerfile.production，可以使用以下命令：

DOCKERFILE=Dockerfile.production docker compose up -d

步骤 7：测试 Relayer

通过发送 GET 请求来验证服务：

curl -X GET http://localhost:8080/api/v1/relayers \
  -H "Content-Type: application/json" \
  -H "AUTHORIZATION: Bearer YOUR_API_KEY"

将 YOUR_API_KEY 替换为你配置在 .env 文件中的 API 密钥。

预期结果：成功的请求应该返回 HTTP 200 状态码以及 relayer 列表。

通过 API 使用 relayer

有关详细的 API 使用信息，请参阅 API guide。该指南提供了端点描述、使用示例以及与 Relayer 服务集成的最佳实践。

通过 SDK 使用 relayer

有关如何通过 SDK 使用 Relayer 服务的文档和示例，请查看 SDK documentation。

附加资源和故障排除

故障排除：如果在设置或部署期间遇到问题，请验证你的环境变量，检查容器日志，并查看你的配置文件中是否存在语法错误。

← User Documentation

Configuration →

• 原文链接： docs.openzeppelin.com/re...
• 登链社区 AI 助手，为大家转译优秀英文文章，如有翻译不通的地方，还请包涵～