Optimism Block Building Sidecar 镜像文档

镜像概述和主要用途

Optimism Block Building Sidecar 是一个专为 Optimism Stack 设计的辅助服务（Sidecar）镜像，用于处理***网络中的区块构建任务。作为 Optimism 节点的配套组件，它通过分离区块构建逻辑与主节点核心功能，优化资源分配，提升整体网络性能与可靠性。

主要用途：

• 辅助 Optimism 节点高效完成区块构建流程
• 减轻主节点在区块组装、验证等任务上的负载
• 支持自定义区块构建策略，适配不同网络场景需求

核心功能和特性

核心功能

1. 区块构建自动化：支持从交易池获取交易、组装区块、执行状态转换等完整流程
2. 与 Optimism 节点无缝集成：通过标准接口（如 HTTP/RPC）与 Optimism 主节点（如 op-node）通信，同步链状态
3. 交易筛选与排序：支持按 gas 价格、交易类型等规则筛选和排序交易，优化区块填充效率

特性

• 可配置构建策略：通过参数或配置文件自定义区块大小限制、交易包含规则等
• 高兼容性：适配 Optimism Stack v1.0+ 及主流***客户端（如 Geth）
• 监控与可观测性：内置 Prometheus 指标暴露接口，支持区块构建延迟、成功率等关键指标监控
• 轻量级设计：基于 Alpine 基础镜像，体积小，资源占用低

使用场景和适用范围

适用场景

• Optimism 主网/测试网节点部署：在生产环境中作为主节点的配套服务，提升区块产出稳定性
• 自定义 Optimism 链部署：适用于基于 Optimism Stack 构建的私有链或联盟链，满足特定区块构建需求
• 开发与测试环境：在本地开发或 CI/CD 流程中模拟区块构建，验证交易处理逻辑

适用范围

• 基于 Optimism Stack v1.0+ 的***网络（如 Optimism Mainnet、Optimism Sepolia Testnet）
• 运行 Optimism 节点的服务器或容器化环境（Kubernetes、Docker Compose 等）

使用方法和配置说明

环境要求

• Docker 20.10+ 或兼容的容器运行时
• 与 Optimism 主节点（op-node）网络互通，确保 RPC 端口可访问
• 最低资源配置：1 CPU 核心，2GB 内存，10GB 存储空间

基本使用（Docker Run）

通过 docker run 命令快速启动服务，需指定与 Optimism 主节点的连接参数：

bash
docker run -d \
  --name op-block-building-sidecar \
  -p 8547:8547 \  # Sidecar 服务端口（默认 RPC 端口）
  -e OP_NODE_RPC_URL=[***] \  # Optimism 主节点 RPC 地址
  -e CHAIN_ID=10 \  # 目标网络 Chain ID（如 Optimism 主网为 10）
  -e BLOCK_GAS_LIMIT=30000000 \  # 区块 gas 上限
  -e LOG_LEVEL=info \  # 日志级别（debug/info/warn/error）
  optimism/block-building-sidecar:latest

Docker Compose 配置示例

在多容器部署场景（如与 op-node、op-geth 配合），可通过 docker-compose.yml 定义服务：

yaml
version: '3.8'

services:
  op-block-building-sidecar:
    image: optimism/block-building-sidecar:latest
    container_name: op-block-building-sidecar
    ports:
      - "8547:8547"
    environment:
      - OP_NODE_RPC_URL=[***]  # 连接同网络中的 op-node 服务
      - CHAIN_ID=10
      - BLOCK_GAS_LIMIT=30000000
      - TRANSACTION_SELECTION_POLICY=gas_price  # 交易选择策略（gas_price 或 fair）
      - LOG_LEVEL=info
    depends_on:
      - op-node  # 依赖 op-node 启动后再运行
    restart: unless-stopped

  op-node:  # 示例：Optimism 主节点服务（需单独配置）
    image: optimism/op-node:latest
    # ... 其他 op-node 配置 ...

环境变量配置

以下为常用环境变量说明，所有变量均为可选，未设置时使用默认值：

配置文件挂载

如需更复杂的区块构建策略（如自定义交易过滤规则、多交易池优先级配置），可通过挂载配置文件实现。配置文件为 YAML 格式，示例如下：

yaml
# 自定义配置文件示例（config.yaml）
transaction_selection:
  max_transactions_per_block: 200  # 每区块最大交易数
  allowed_senders:  # 允许的交易发送者白名单（为空时不限制）
    - "0x123...789"
    - "0xabc...def"
block_build:
  timeout_ms: 2000  # 区块构建超时时间
  retry_count: 3     # 构建失败重试次数

挂载配置文件启动容器：

bash
docker run -d \
  --name op-block-building-sidecar \
  -v ./config.yaml:/app/config.yaml \  # 挂载本地配置文件到容器内
  -e CONFIG_PATH=/app/config.yaml \   # 指定配置文件路径
  optimism/block-building-sidecar:latest

数据持久化

Sidecar 本身无状态，无需持久化数据。若需保存日志或指标数据，可通过挂载日志目录实现：

bash
docker run -d \
  --name op-block-building-sidecar \
  -v ./logs:/app/logs \  # 挂载日志目录
  -e LOG_FILE_PATH=/app/logs/sidecar.log \  # 指定日志文件路径
  optimism/block-building-sidecar:latest

常见问题

Q：如何验证 Sidecar 是否正常工作？

A：通过访问 http://<sidecar-ip>:8547/health 检查健康状态，返回 OK 表示服务正常；或查看日志中是否有 block built successfully 等成功构建记录。

Q：如何调整区块构建速度？

A：通过 TX_POOL_FETCH_INTERVAL 减小拉取间隔（如 300ms），或通过配置文件 block_build.timeout_ms 缩短超时时间，提升构建频率。

Q：支持与非 Optimism 节点集成吗？

A：目前仅支持与 Optimism Stack 中的 op-node 集成，不兼容其他非 Optimism ***节点。