引言

本文通过分析 go-ethereum client 解释客户端容器如何在 Hive 中工作。

Client definitions

Dockerfile

客户端是可以通过 simulation 实例化的 docker 镜像（重点：通过 simulation 进行实例化）。客户端定义由 Dockerfile 和相关资源组成。客户端定义位于 hive 存储库中 clients/ 的子 ​​ 目录中。

当 hive 运行 simulation 时，它首先使用它们的 Dockerfile 构建所有客户端 docker 镜像，也就是在客户端目录中运行

docker build .

由于大多数客户端定义包装现有的 Ethereum 客户端，并且从源码构建客户端可能需要很长时间，因此通常最好基于来自 Docker Hub 镜像进行二次封装作为 hive 客户端。

客户端 Dockerfile 应该支持一个名为branch的可选参数，它指定请求的客户端版本。用户可以通过将此参数附加到客户端名称来设置此参数，例如：

./hive --sim my-simulator --client go-ethereum_v1.9.23,go_ethereum_v1.9.22

有关客户端 Dockerfile 的示例，请参阅 go-ethereum client definition。

hive.yaml

Hive 从客户端目录的 hive.yaml 中读取额外的元数据。目前，此文件的唯一目的是指定客户端的角色列表：

roles:
  - "eth1"
  - "eth1_light_client"

角色列表(roles)可供 simulator 使用，可用于根据功能区分客户端。声明客户端角色还表明客户端支持某些特定于角色的环境变量和文件。如果 hive.yml 缺失或未声明角色，则假定为 eth1 角色。

/version.txt

客户端 Dockerfile 应该在构建期间生成一个 /version.txt 文件。 Hive 在构建容器后读取此文件，并将版本信息附加到启动客户端的所有测试套件的输出。

RUN /usr/local/bin/geth console --exec 'console.log(admin.nodeInfo.name)' --maxpeers=0 --nodiscover --dev 2>/dev/null | \

head -1 > /version.txt

/hive-bin

放置在客户端容器/hive-bin目录下的可执行文件可以通过 simulation API 调用。

Client Lifecycle

当 simulation 请求客户端实例时，hive 从客户端映像创建一个 docker 容器。 simulator 可以通过传递带有前缀 HIVE_ 的环境变量来自定义容器。它还可以在启动前将文件上传到容器中。创建容器后，hive 只需运行 Dockerfile 中定义的入口点（entry point）。

对于 ethereum client，hive 等待客户端容器打开 TCP 端口 8545 后才认为其可供 simulator 使用；如果客户端容器在特定超时时间内未打开此端口，则 Hive 假定客户端启动失败。此端口可通过 HIVE_CHECK_LIVE_PORT 变量进行配置，对于自定义非 eth client，可以通过将其设置为 0 来禁用检查。

simulator 可以给客户端传递启动容器需要的环境变量和文件。虽然 Hive 本身不需要支持任何特定的变量或文件，但 simulator 通常希望客户端容器能够以某些方式进行配置。例如，为了针对多个以太坊客户端运行测试，simulator 需要能够将所有客户端配置为特定区块链，并让它们加入用于测试的 P2P 网络。

Eth1 Client Requirements

参见官方原文。

  1. hive clients ↩︎