OpenZeppelin Relayer - 网络配置文档

网络配置

OpenZeppelin Relayer 通过灵活的基于 JSON 的配置系统支持多个区块链网络。本指南涵盖了配置 Relayer 实例所需了解的所有信息。

概述

网络在 JSON 配置文件中定义，允许你：

• 配置任何兼容 EVM 的网络（Ethereum、Polygon、BSC、Arbitrum、Optimism 等）

• 设置 Solana 网络（mainnet-beta、devnet、testnet、自定义 RPC 端点）

• 配置 Stellar 网络（Pubnet、Testnet、自定义网络）

• 使用特定的 RPC 端点、链 ID 和网络参数创建自定义网络配置

• 使用继承来创建网络变体，而无需复制配置

网络类型

配置方法

默认网络配置

如果在你的 config.json 中没有指定 networks 字段，Relayer 将自动从 ./config/networks 目录加载网络配置。这是默认行为。

{
  "relayers": [...],
  "notifications": [...],
  "signers": [...]
  // 没有 "networks" 字段 - 默认为 "./config/networks"
}

你可以通过两种方式配置网络：

方法 1：分离的 JSON 文件

在你的主 config.json 中指定网络配置文件的路径：

{
  "relayers": [...],
  "notifications": [...],
  "signers": [...],
  "networks": "./config/networks"  // 目录或文件的路径
}

每个 JSON 文件必须包含一个顶级的 networks 数组：

{
  "networks": [\
    // ... 网络定义 ...\
  ]
}

当使用目录结构时：

networks/
├── evm.json        # {"networks": [...]}
├── solana.json     # {"networks": [...]}
└── stellar.json    # {"networks": [...]}

方法 2：直接配置

直接在你的主 config.json 中定义网络，而不是使用单独的文件：

{
  "relayers": [...],
  "notifications": [...],
  "signers": [...],
  "networks": [\
    {\
      "type": "evm",\
      "network": "ethereum-mainnet",\
      "chain_id": 1,\
      // ... 其他字段\
    }\
  ]
}

当使用此方法时，默认的 ./config/networks 目录将被忽略，只有在此数组中定义的网络才可用。

网络字段参考

常用字段

所有网络类型都支持以下配置字段：

特殊网络标签

某些标签具有特殊含义并影响 Relayer 的行为：

示例：使用特殊标签

这是一个展示如何在实践中使用特殊标签的示例：

{
  "type": "evm",
  "network": "arbitrum-one",
  "chain_id": 42161,
  "required_confirmations": 1,
  "symbol": "ETH",
  "rpc_urls": ["https://arb1.arbitrum.io/rpc"],
  "tags": ["rollup", "no-mempool"],  // Arbitrum 是没有 mempool 的 Rollup
  "is_testnet": false
}

这些标签帮助 Relayer：

• 对 Rollup 应用特定的交易处理

• 对 OP Stack 链使用优化的费用计算

• 跳过没有 mempool 的网络的 mempool 相关操作

• 警告用户有关已弃用的网络

EVM 特有字段

示例：EVM 网络配置

这是一个展示 EVM 网络配置的示例：

{
  "type": "evm",
  "network": "ethereum-mainnet",
  "chain_id": 1,                    // 以太坊主网链 ID
  "required_confirmations": 12,     // 高安全性：12 次确认
  "symbol": "ETH",                  // 原生货币符号
  "features": ["eip1559"],          // 支持 EIP-1559 费用市场
  "rpc_urls": ["https://mainnet.infura.io/v3/YOUR_KEY"],
  "is_testnet": false
}

Solana 特有字段

目前，Solana 网络仅使用常用字段。 将来可能会添加其他 Solana 特定的配置选项。

Stellar 特有字段

示例：Stellar 网络配置

这是一个展示带有密码的 Stellar 网络配置的示例：

{
  "type": "stellar",
  "network": "pubnet",
  "rpc_urls": ["https://mainnet.sorobanrpc.com"],
  "explorer_urls": ["https://stellar.expert/explorer/public"],
  "passphrase": "Public Global Stellar Network ; September 2015",  // 官方主网密码
  "average_blocktime_ms": 5000,
  "is_testnet": false
}

配置示例

基本 EVM 网络

{
  "type": "evm",
  "network": "ethereum-mainnet",
  "chain_id": 1,
  "required_confirmations": 12,
  "symbol": "ETH",
  "rpc_urls": ["https://mainnet.infura.io/v3/YOUR_KEY"],
  "explorer_urls": ["https://etherscan.io"],
  "average_blocktime_ms": 12000,
  "is_testnet": false,
  "tags": ["mainnet", "ethereum"]
}

带有标签的 Layer 2 EVM 网络

{
  "type": "evm",
  "network": "optimism",
  "chain_id": 10,
  "required_confirmations": 1,
  "symbol": "ETH",
  "rpc_urls": [\
    "https://mainnet.optimism.io",\
    "https://optimism.drpc.org"\
  ],
  "features": ["eip1559"],
  "tags": ["rollup", "optimism"],
  "average_blocktime_ms": 2000,
  "is_testnet": false
}

Solana 网络

{
  "type": "solana",
  "network": "mainnet-beta",
  "rpc_urls": ["https://api.mainnet-beta.solana.com"],
  "explorer_urls": ["https://explorer.solana.com"],
  "average_blocktime_ms": 400,
  "is_testnet": false,
  "tags": ["mainnet", "solana"]
}

Stellar 网络

{
  "type": "stellar",
  "network": "pubnet",
  "rpc_urls": ["https://mainnet.sorobanrpc.com"],
  "passphrase": "Public Global Stellar Network ; September 2015",
  "explorer_urls": ["https://stellar.expert/explorer/public"],
  "average_blocktime_ms": 5000,
  "is_testnet": false,
  "tags": ["mainnet", "stellar"]
}

网络继承

网络可以从相同类型的其他网络继承，允许你创建变体而无需复制配置：

{
  "networks": [\
    {\
      "type": "evm",\
      "network": "ethereum-base",\
      "chain_id": 1,\
      "required_confirmations": 12,\
      "symbol": "ETH",\
      "rpc_urls": ["https://mainnet.infura.io/v3/YOUR_KEY"]\
    },\
    {\
      "from": "ethereum-base",\
      "type": "evm",\
      "network": "ethereum-sepolia",\
      "chain_id": 11155111,\
      "required_confirmations": 3,\
      "rpc_urls": ["https://sepolia.infura.io/v3/YOUR_KEY"],\
      "is_testnet": true\
    }\
  ]
}

当使用继承时：

• 子网络从父网络继承所有字段

• 子网络中指定的字段会覆盖父网络的值

• from 字段必须引用相同类型的网络

在 Relayer 配置中使用网络

定义网络后，在你的 Relayer 配置中引用它们：

{
  "relayers": [\
    {\
      "id": "my-evm-relayer",\
      "name": "My EVM Relayer",\
      "network": "ethereum-mainnet",  // 引用网络 ID\
      "network_type": "evm",\
      "signer_id": "my-signer"\
    }\
  ]
}

最佳实践

1. 网络组织

• 将相关网络分组在单独的文件中（例如，ethereum.json，polygon.json）

• 对网络标识符使用一致的命名约定

• 包括主网和测试网配置

2. RPC URL

• 始终配置多个 RPC URL 以实现冗余

• 将私有/专用 RPC 端点用于生产环境

• 确保通过公共网络访问时 URL 是安全的 (HTTPS)

3. 确认要求

• 根据网络安全设置适当的 required_confirmations

• 主网的值较高，测试网的值较低

• 考虑特定于网络的最终确定性特征

4. 标签和功能

• 使用标签对网络进行分类（例如，“mainnet”、“testnet”、“rollup”）

• 启用适当的功能（例如，对支持的网络启用 "eip1559"）

• 记录你的组织中使用的自定义标签

5. 继承

• 为常用设置创建基本配置

• 使用继承来减少重复

• 仅覆盖子网络中必要的字段

故障排除

常见问题

找不到网络：

• 确保 Relayer 配置中的网络标识符完全匹配

• 检查网络配置文件是否位于正确的位置

• 验证 JSON 语法是否有效

RPC 连接失败：

• 在配置之前独立测试 RPC URL

• 确保防火墙/网络允许出站 HTTPS 连接

• 检查 API 密钥是否包含在 RPC URL 中（如果需要）

无效配置：

• 验证网络类型是否存在必需字段

• 确保数字字段（chain_id，确认数）是数字，而不是字符串

• 检查继承的网络是否引用了现有的父网络

参见

• Relayer 配置

• 快速入门指南

• Solana 集成

• API 参考

← 签名者

存储配置 →

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