neutronorg/rehearsal

Neutron主网分叉与集成测试工具

Neutron节点版本： v9.0.0

本镜像提供自动化创建和执行Neutron网络主网分叉的工具，助力开发者进行集成测试。在***快速迭代的环境中，预测试至关重要。通过主网分叉，开发者可在模拟当前主网的环境中严格测试合约、模块及其他功能。

注意‼️：分叉使用的Neutron镜像已禁用签名验证，因此您可以代表任何账户发送交易，以简化测试流程。请不要将此分叉用于其他目的。测试脚本提供了https://github.com/hadronlabs-org/rehearsal/blob/main/src/libs/wallet.ts#L3%EF%BC%8C%E5%85%81%E8%AE%B8%E6%82%A8%E4%BB%A3%E8%A1%A8%E4%BB%BB%E4%BD%95%E8%B4%A6%E6%88%B7%E5%8F%91%E9%80%81%E4%BA%A4%E6%98%93%E3%80%82

硬件要求

为确保项目平稳运行，建议满足以下硬件规格：

1. CPU： 至少4核，推荐8核；
2. 内存： 至少16GB，推荐32GB及以上；
3. 存储： SSD至少20GB可用空间，推荐NVMe SSD以提升读写速度；
4. 网络： 稳定的互联网连接，下载速度至少100 Mbps。

注意：这些要求基于Neutron网络处理的标准数据量。更密集的操作或***规模增长可能需要更强大的硬件。

软件要求

请确保已安装以下软件：

• Docker： 用于构建和运行项目容器；
• Node.js： 项目已通过16版本测试，请确保安装该版本。

主网分叉的重要性

创建主网分叉有多种应用场景：

1. 保护真实资产： 在部署重大更新前，可在分叉上测试变更，确保真实资产不受威胁；
2. 原型新功能： 可在分叉上快速原型化和迭代新想法与功能，不影响主网；
3. 测试合约： 部署前，智能合约可在模拟真实世界的环境中严格测试，发现潜在漏洞；
4. 培训与教育： 分叉为开发者提供学习和熟悉网络细节的环境，无真实世界后果；
5. 调试与故障排除： 若主网出现问题，可在分叉上复现以进行深入分析。

这种方法增强了***社区的信任，有助于防止变更上线时出现意外问题。

目录结构

• ./script 目录： 所有与快照创建和分叉操作相关的脚本均位于此目录，包含自动化项目内各种任务的必要工具；
• ./contract 目录： 用于存储待测试的合约，处理特定合约或部署新合约时应放置于此；
• ./snapshot 目录： 包含使用 make create-mainnet-snapshot 命令生成的最新快照，请保持其完整性。

熟悉此目录结构可帮助您更高效地导航和修改项目。

使用CLI

若需通过CLI代表任何账户发送交易，请执行以下步骤：

1. 使用 --offline 标志创建交易，例如：

   bash
   neutron tx bank send <您拥有私钥的账户> neutron1f6s4550dzyu0yzp7q2acn47mp5u25k0xa96pqy 5000000untrn --offline
   

2. 使用以下命令签名交易：

   bash
   neutrond tx sign tx-ex.json --chain-id pion-1 --from <上一步使用的账户>
   

3. 在 /cosmos.bank.v1beta1.MsgSend 消息中替换 from_address 为您实际要发送资金的地址；
4. 使用 neutrond tx broadcast 将交易广播到分叉网络。

集成测试

本仓库旨在编写集成测试，评估系统不同部分的行为，尤其是网络提案的执行。测试使用 vitest 框架编写。

运行与调试测试

• 运行测试： 执行以下命令运行集成测试：

  bash
  yarn test
  

• 调试与编写测试： 用于调试和辅助编写新测试：

  bash
  yarn watch
  

环境变量

可设置以下环境变量以自定义脚本和测试的行为：

• RPC_NODE： 指定用于创建快照的Neutron网络RPC节点；
• INTERVAL： 请求最新网络快照的区块间隔；
• NEUTROND_P2P_MAX_NUM_OUTBOUND_PEERS： 设置最大出站节点数；
• NEUTROND_P2P_MAX_NUM_INBOUND_PEERS： 设置最大入站节点数。

运行任何操作前，请在 docker-compose.yml 中适当设置这些变量。

快速开始

1. 创建主网快照

   • 使用以下命令：

     bash
     make build-mainnet-snapshot-image
     

     该命令内部运行 neutrond export，将花费约1小时准备主网快照并放入 ./snapshot 目录。

     请注意：这是一个耗时操作，至少需要20分钟，具体取决于硬件性能。 但您无需自行创建快照，因为有专用快照服务每6小时创建一次原始快照。若 ./snapshot 目录为空，make create-mainnet-snapshot 命令会自动下载这些快照。

2. 快照与分叉的启动、停止和管理

   • 有关快照管理和启动分叉的详细步骤，请参考以下命令部分。

自定义创世块

用户可灵活地将自己的设置集成到创世块中，只需创建名为 custom.sh 的脚本即可。该脚本将接收当前创世块的路径和修改后创世块的存放路径作为输入。请遵循以下步骤：

1. 创建自定义脚本
   • 编写名为 custom.sh 的脚本，包含您的特定配置或逻辑；
   • 脚本将接收两个参数：当前创世块的路径和修改后创世块的存放路径。
2. 脚本示例 以下是脚本的示例：

   bash
   #!/bin/bash
   
   CURRENT_GENESIS_PATH="$1"
   MODIFIED_GENESIS_PATH="$2"
   
   # 您的自定义配置和修改逻辑在此处
   
   cp $CURRENT_GENESIS_PATH $MODIFIED_GENESIS_PATH
   

3. 向Docker容器提供路径
   • 确保Docker容器可访问存储 custom.sh 脚本的目录。在Docker Compose中，可在 docker-compose.yml 文件中添加如下条目：

     yaml
     volumes:
       - ./custom/:/opt/neutron/custom
     

   • 这确保自定义脚本在Docker容器内可访问，使其能够相应地修改创世块。
4. 执行
   • custom.sh 脚本将自动执行，在初始化过程中应用您的个性化设置到创世块。

这种方法提供了一种无缝方式，可根据特定需求或配置定制创世块，同时保持原始设置的完整性。请确保 custom.sh 脚本具有执行权限和处理创世块文件的权限。

Docker容器

您无需从源代码构建Docker容器，可直接使用Docker Hub上的容器：https://hub.docker.com/r/neutronorg/rehearsal%E3%80%82

命令

构建主网快照镜像
创建Neutron主网快照的镜像。该命令构建 neutron-mainnet-snapshot 容器，其中 neutrond 节点使用statsync导出状态。

bash
make build-mainnet-snapshot-image

创建主网快照
运行 neutron-mainnet-snapshot 容器生成快照，将保存到 ./snapshot 目录。

bash
make create-mainnet-snapshot

停止主网快照容器
停止 neutron-mainnet-snapshot 容器的执行：

bash
make stop-mainnet-snapshot

运行主网分叉
注意：您无需构建快照容器即可运行分叉。若 snapshot/snapshot.json 中没有快照文件，将自动从 https://snapshot.neutron.org/ 下载。

1. 构建主网分叉镜像
   构建 neutron-mainnet-fork 容器。该命令设置 neuntrond 节点，使用从最新网络快照派生的创世块，并引入某些参数修改。此外，它缓存网络状态以加快节点启动速度。

   bash
   make build-mainnet-fork-image
   

2. 启动主网分叉
   启动 neutron-mainnet-fork 容器：

   bash
   make start-mainnet-fork
   

3. 构建并运行Slinky Sidecar容器
   Sidecar是Neutron节点获取 oracle 价格所必需的。构建并运行它：

   bash
   make build-oracle
   make start-oracle
   

停止主网分叉容器
停止 neutron-mainnet-fork 容器的运行：

bash
make stop-mainnet-fork

停止Slinky Sidecar
停止Slinky Sidecar容器：

bash
make stop-oracle

运行浏览器

要运行PingPub浏览器，请使用以下命令：

bash
docker run --rm -p 5173:5173 -p 1318:1318 -p 26858:26858 --env API_URL=http://dev_server:1317 --env RPC_URL=http://dev_server:26657 neutronorg/pingpub

贡献

若您希望为该项目贡献或报告问题，请在仓库中提交拉取请求或提出问题。如需进一步研究，建议查看GitHub上的https://github.com/neutron-org/mainnet-fork-tests%E3%80%82