Shardeum 项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00530/article/details/146530276

Shardeum 项目使用教程

shardeum Shardeum is an EVM based autoscaling blockchain 项目地址: https://gitcode.com/gh_mirrors/sh/shardeum

1. 项目目录结构及介绍

Shardeum 是一个基于 EVM 的自动扩展区块链平台。以下是项目的目录结构及其简要介绍：

shardeum/
├── .appsec/
├── .devcontainer/
├── .github/
│   └── workflows/
├── .vscode/
├── docs/
├── scripts/
├── src/
│   └── index.ts
├── test/
├── .dockerignore
├── .env_example
├── .envrc
├── .eslintrc.json
├── .gitignore
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── LICENSE_SHARDUS
├── README.md
├── SHARDUS_SOFTWARE_LICENSE_2023-02-02.pdf
├── config.json
├── debug-10-nodes.config.json
├── debug-25-nodes.config.json
├── dev.Dockerfile
├── flake.lock
├── flake.nix
├── jest.config.js
├── local-environment-setup.md
├── package-lock.json
├── package.json
├── prettier.config.js
├── shardeum-logo.png
├── tsconfig.json
└── View all files

.appsec/: 应用安全相关的配置文件。
.devcontainer/: 开发容器配置。
.github/workflows/: GitHub Actions 工作流文件。
.vscode/: Visual Studio Code 的配置文件。
docs/: 项目文档。
scripts/: 项目脚本。
src/: 源代码目录。
test/: 测试代码目录。
.dockerignore: Docker 忽略文件。
.env_example: 环境变量示例文件。
.envrc: 环境变量设置。
.eslintrc.json: ESLint 配置文件。
.gitignore: Git 忽略文件。
CODEOWNERS: 代码所有者文件。
CODE_OF_CONDUCT.md: 行为准则。
CONTRIBUTING.md: 贡献指南。
LICENSE: 项目许可证文件。
LICENSE_SHARDUS: ShardUS 软件许可证。
README.md: 项目自述文件。
SHARDUS_SOFTWARE_LICENSE_2023-02-02.pdf: ShardUS 软件许可证 PDF 文件。
config.json: 配置文件。
debug-10-nodes.config.json: 调试配置文件（10 个节点）。
debug-25-nodes.config.json: 调试配置文件（25 个节点）。
dev.Dockerfile: 开发环境 Dockerfile 文件。
flake.lock: Nix 包管理器锁定文件。
flake.nix: Nix 包描述文件。
jest.config.js: Jest 测试配置文件。
local-environment-setup.md: 本地环境设置指南。
package-lock.json: npm 包锁定文件。
package.json: npm 包配置文件。
prettier.config.js: Prettier 配置文件。
shardeum-logo.png: 项目 logo。
tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Shardeum 项目的启动主要是通过 shardus 命令行工具来完成的。以下是启动项目的基本步骤：

克隆仓库：

git clone https://github.com/shardeum/shardeum.git
cd shardeum

安装依赖：
```
npm ci
```

配置网络：

export LOAD_JSON_CONFIGS=debug-10-nodes.config.json

编译项目：
```
npm run prepare
```

安装 Shardus CLI：

npm install -g @shardeum-foundation/tools-shardus-cli
npm update @shardeum-foundation/archiver

启动本地网络（10 个节点）：
```
shardus start 10
```

3. 项目的配置文件介绍

Shardeum 项目的配置主要通过以下文件进行：

config.json: 主配置文件，包含项目运行所需的基本配置。
debug-10-nodes.config.json: 调试配置文件，用于本地开发时配置 10 个节点的网络。
debug-25-nodes.config.json: 另一个调试配置文件，用于配置 25 个节点的网络。

这些配置文件中定义了节点数量、网络参数等关键配置，确保网络能够按预期运行。开发者可以根据需要修改这些文件来调整网络设置。

shardeum Shardeum is an EVM based autoscaling blockchain 项目地址: https://gitcode.com/gh_mirrors/sh/shardeum