ZecHub

指南

用于理解 Zcash 协议的结构化文档

指南:

可视化 Zcash 网络

以下指南介绍如何在 Ubuntu 22.04 上运行适用于 Zcash 的 Ziggurat 3.0 Crawler，以及关联的 Crunchy 和 P2P-Viz 程序，以收集并可视化 Zcash 网络信息。
下方链接的视频遵循相同流程。

安装要求：

Rust -> https://rustup.rs/

可选项：

jq -> https://jqlang.github.io/jq/download/ （用于在终端中显示 json 信息）

curl -> https://everything.curl.dev/install/linux.html （用于查询爬虫 RPC）

npm（配合 nvm）-> https://medium.com/@iam_vinojan/how-to-install-node-js-and-npm-using-node-version-manager-nvm-143165b16ce1 （用于在浏览器中显示 P2P-Viz）

Ziggurat 3.0 仓库 | https://github.com/runziggurat

Crawler 仓库 | https://github.com/runziggurat/zcash.git

Crunchy 仓库 | https://github.com/runziggurat/crunchy.git

P2P-Viz 仓库 | https://github.com/runziggurat/p2p-viz.git

首先执行常规更新。

运行以下命令：

Code-highlight

sudo apt update
sudo apt upgrade

Zcash 网络爬虫

Zcash Crawler 位于名为“zcash”的文件夹中，因此在克隆爬虫（runziggurat/zcash 仓库）之前，建议先创建一个新目录。

在 /Home 目录中，运行以下命令：

Code-highlight

mkdir runziggurat
cd runziggurat
git clone https://github.com/runziggurat/zcash.git
cd zcash

在浏览器中访问 https://github.com/runziggurat/zcash/blob/main/src/tools/crawler/README.md

或打开 readme： '/runziggurat/zcash/src/tools/crawler/README.md'

此页面包含有关具体使用方式的信息。

Code-highlight

$ cargo run --release --features crawler --bin crawler -- --help

OPTIONS:
    -c, --crawl-interval <CRAWL_INTERVAL>
            The main crawling loop interval in seconds [default: 5]

    -h, --help
            Print help information

    -r, --rpc-addr <RPC_ADDR>
            If present, start an RPC server at the specified address

    -s, --seed-addrs <SEED_ADDRS>...
            A list of initial standalone IP addresses and/or DNS servers to connect to

    -n, --node-listening-port <NODE_LISTENING_PORT>
            Default port used for connecting to the nodes [default: 8233]

    -V, --version
            Print version information

--seed-addrs \ --dns-seed 是唯一必需的参数，且至少需要指定一个地址才能运行。

命令 'cargo run --release --features crawler --bin crawler -- --help' 是实际的运行命令，将打印所示的帮助菜单。

运行命令

Code-highlight

cargo run --release --features crawler --bin crawler -- --help

这将编译程序并确保一切正常运行。

要运行 Crawler，必须在启动命令中添加 '--seed-addrs' 标志，其中至少包含一个有效的 Zcash 节点 IP 地址。应允许爬虫运行足够长的时间，以获得准确结果。部分示例节点 IP 地址可在 https://mainnet.zcashexplorer.app/nodes. 找到

如需在 Crawler 运行期间获取信息，必须在启动命令中添加 '--rpc-addr' 标志。这不是仅运行爬虫本身所必需的，但否则将需要停止爬虫（ctrl+c 或 SIGKILL）才能显示任何信息。

运行命令

Code-highlight

cargo run --release --features crawler --bin crawler -- --seed-addrs 157.245.172.190:8233 194.135.81.61:8233 35.233.224.178:8233 --rpc-addr 127.0.0.1:54321

爬虫将开始与网络通信（默认每 20 秒一次）并收集网络数据。可通过使用 curl 查询节点来显示 Crawler 的信息（这需要 jq 来显示该信息）。本示例中的 Crawler RPC 地址设置为 '127.0.0.1:54321'

在另一个终端中，运行命令

Code-highlight

curl --data-binary '{"jsonrpc": "2.0", "id":0, "method": "getmetrics", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:54321/ | jq .result.protocol_versions

这将显示包含在 '.result' 字段中的当前已收集 '.protocol_version' 数据。'.result' 字段非常大，因此调用其中的特定部分会更实用。其他有用的数据类型包括 '.num_known_nodes'、'.num_good_nodes'、'.user_agents' 等。请参阅指标部分此处

要运行 Crunchy 和 P2P-Viz，必须将 '.result' 通过管道输出到 .json 文件中。

运行命令

Code-highlight

curl --data-binary '{"jsonrpc": "2.0", "id":0, "method": "getmetrics", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:54321/ > latest.json

这将在当前目录中创建一个 'latest.json' 文件。此 'latest.json' 文件将与 Crunchy 一起使用。

此时，如果不再需要更多数据，可使用 'ctrl+c' 停止 Crawler。Crawler 将在终端中输出包含有用信息的报告。

Crunchy

需要 Crunchy 来聚合输出的 json 文件，以供 P2P-Viz 使用。

要构建 Crunchy，请导航至你的 '/runziggurat' 文件夹

要克隆 Crunchy 仓库，请运行以下命令

Code-highlight

git clone https://github.com/runziggurat/crunchy.git
cd crunchy

将 'latest.json' 文件复制并粘贴到 'crunchy/testdata/' 文件夹中。

运行以下命令

Code-highlight

cargo run --release -- -i testdata/latest.json -o testdata/state.json -g testdata/geoip-cache.json -f Zcash

这将在 'crunchy/testdata/' 文件夹中创建一个经过 Zcash 节点筛选的 'state.json' 文件，供 P2P-Viz 使用。

P2P-Viz

要构建 P2P-Viz，必须安装 npm。

要使用 nvm 安装 npm，请运行以下命令：

Code-highlight

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

关闭并重新启动终端。

运行命令：

Code-highlight

nvm install --lts

导航至你的 '/runziggurat' 文件夹

要克隆 P2P-Viz 仓库并启动，请运行以下命令

Code-highlight

git clone https://github.com/runziggurat/p2p-viz.git
cd p2p-viz
npm i
npm run build
npm run start http

在浏览器中打开 http://localhost:3000.

选择“Geolocation”，然后选择“Choose state file”。

在文件资源管理器弹窗中，选择 'state.json' 文件。

节点浏览器的世界地图将加载文件数据。有关使用选项和设置的更多详细信息，请参阅 readme 此处。

提示！

你可以直接使用 'timeout' 命令设置 Crawler 的定时爬取，该命令会在设定时间后发出指定的终止命令。运行 'timeout --help' 了解更多信息。以下命令将启动爬虫，并在 50 分钟后自动停止。

运行命令

Code-highlight

timeout --signal=2 50m cargo run --release --features crawler --bin crawler -- --seed-addrs 157.245.172.190:8233 194.135.81.61:8233 35.233.224.178:8233 --rpc-addr 127.0.0.1:54321

提示！

可以调用并将 'latest.json' 写入 '/testdata'，这样就不必手动复制和粘贴。

提示！

可从输出中收集 IP 地址信息，然后在启动时将其用于重新为 Crawler 设置种子（--seed-addrs）。这将减少完成完整爬取所需的时间！