3个不稳定版本
| 0.13.4 | 2024年1月24日 |
|---|---|
| 0.0.4 | 2023年10月31日 |
| 0.0.0 | 2023年10月31日 |
#606 in 神奇豆
48 monthly downloads
用于 5 crates (2 directly)
48KB
1K SLoC
Kaspa On Rust
欢迎使用基于Rust的Kaspa全节点及其辅助库的实现。包含的节点发布版本可以作为现有 Golang节点 的替代品，并且至今仍然是Kaspa网络的推荐节点软件，向开发者介绍了Rust在Kaspa网络环境中的可能性。
我们邀请开发者和区块链爱好者协作、测试和优化我们的Rust实现。这里每一行代码都是为开源区块链运动做出贡献的机会，塑造一个旨在可扩展性和速度，同时不牺牲去中心化的平台。
您的反馈、贡献和问题报告将对于完善此代码库，使其成为Kaspa网络中可靠的节点至关重要。
安装
在Linux上构建
-
安装通用先决条件
sudo apt install curl git build-essential libssl-dev pkg-config -
安装Protobuf（gRPC所需的）
sudo apt install protobuf-compiler libprotobuf-dev #Required for gRPC -
安装clang工具链（RocksDB和WASM secp256k1构建所需的）
sudo apt-get install clang-format clang-tidy \ clang-tools clang clangd libc++-dev \ libc++1 libc++abi-dev libc++abi1 \ libclang-dev libclang1 liblldb-dev \ libllvm-ocaml-dev libomp-dev libomp5 \ lld lldb llvm-dev llvm-runtime \ llvm python3-clang -
安装rust工具链
如果您已经安装了 Rust，可以通过运行以下命令来更新它：
rustup update -
安装 wasm-pack
cargo install wasm-pack -
安装 wasm32 目标
rustup target add wasm32-unknown-unknown -
克隆仓库
git clone https://github.com/kaspanet/rusty-kaspa cd rusty-kaspa
在 Windows 上构建
-
安装 Git for Windows 或其他 Git 发行版。
-
安装 Protocol Buffers 并将
bin目录添加到您的Path -
将 LLVM 安装目录的
bin目录（例如C:\Program Files\LLVM\bin）添加到 PATH设置环境变量
LIBCLANG_PATH指向bin目录重要：由于 C++ 依赖配置问题，Windows 上 LLVM
AR安装在切换 WASM 和本地 C++ 代码编译（本地RocksDB+secp256k1 与 WASM32 版本的secp256k1构建）时可能无法正确工作。不幸的是，手动设置AR环境变量也会使 C++ 构建工具链困惑（它不应该为本地设置，而应该为 WASM32 目标设置）。目前，解决此问题的最佳方法是：在 Windows 上安装 LLVM 后，转到目标bin安装目录，并将LLVM_AR.exe复制或重命名为AR.exe。 -
安装rust工具链
如果您已经安装了 Rust，可以通过运行以下命令来更新它：
rustup update -
安装 wasm-pack
cargo install wasm-pack -
安装 wasm32 目标
rustup target add wasm32-unknown-unknown -
克隆仓库
git clone https://github.com/kaspanet/rusty-kaspa cd rusty-kaspa
在 Mac OS 上构建
-
安装Protobuf（gRPC所需的）
brew install protobuf -
安装 llvm。
llvm的默认 XCode 安装不支持 WASM 构建目标。要在 MacOS 上构建 WASM，您需要从 homebrew 安装llvm（编写本文时，MacOS 的 llvm 版本为 16.0.1）。brew install llvm注意：Homebrew 可以根据您的配置使用不同的 keg 安装位置。例如
/opt/homebrew/opt/llvm->/opt/homebrew/Cellar/llvm/16.0.1/usr/local/Cellar/llvm/16.0.1
要确定安装位置，可以使用
brew list llvm命令，然后相应地修改下面的路径% brew list llvm /usr/local/Cellar/llvm/16.0.1/bin/FileCheck /usr/local/Cellar/llvm/16.0.1/bin/UnicodeNameMappingGenerator ...如果您有
/opt/homebrew/Cellar，则可以使用/opt/homebrew/opt/llvm。将以下内容添加到您的
~/.zshrc文件中export PATH="/opt/homebrew/opt/llvm/bin:$PATH" export LDFLAGS="-L/opt/homebrew/opt/llvm/lib" export CPPFLAGS="-I/opt/homebrew/opt/llvm/include" export AR=/opt/homebrew/opt/llvm/bin/llvm-ar重新加载
~/.zshrc文件source ~/.zshrc -
安装rust工具链
如果您已经安装了 Rust，可以通过运行以下命令来更新它：
rustup update -
安装 wasm-pack
cargo install wasm-pack -
安装 wasm32 目标
rustup target add wasm32-unknown-unknown -
克隆仓库
git clone https://github.com/kaspanet/rusty-kaspa cd rusty-kaspa
构建 WASM32 SDK
Rust WebAssembly (WASM) 指的是使用 Rust 编程语言编写代码，该代码可以被编译成 WebAssembly，这是一种在网页浏览器和 NodeJs 中运行的二进制指令格式。这允许在保留 Rust 的优势的同时，使用 JavaScript 和 TypeScript 编程语言轻松开发。
可以通过运行以下命令从源代码构建 WASM SDK 组件：- ./build-release - 构建 full release 包（包括 web 和 nodejs 目标的发布和调试构建）- ./build-docs - 构建 TypeScript 文档 - ./build-web - 发布 web 构建 - ./build-web-dev - 开发 web 构建 - ./build-nodejs - 发布 nodejs 构建 - ./build-nodejs-dev - 开发 nodejs 构建
重要：不要在生产环境中使用 dev 构建。它们的大小更大，速度更慢，并包含调试符号。
要求
- NodeJs (v20+)：[http://node.org.cn/en](http://node.org.cn/en)
- TypeDoc：[https://typedoc.org/](https://typedoc.org/)
构建与文档
Kaspa CLI + 钱包
`kaspa-cli` 包提供了对节点的命令行驱动 RPC 接口以及 Rusty Kaspa 钱包运行时的终端界面。这些钱包与 WASM SDK 钱包 API 和 Kaspa NG 项目兼容。cd cli
cargo run --release
本地 Web 钱包
在 wallet/wasm/web 文件夹内运行 http 服务器。如果您没有，可以使用以下方法
cd wallet/wasm/web
cargo install basic-http-server
basic-http-server
basic-http-server 默认将在端口 4000 上提供服务，因此打开您的网页浏览器并加载 http://localhost:4000
框架与所有主流桌面和移动浏览器兼容。
运行节点
启动主网节点
cargo run --release --bin kaspad
# or with UTXO-index enabled (needed when using wallets)
cargo run --release --bin kaspad -- --utxoindex
启动测试网节点
cargo run --release --bin kaspad -- --testnet
测试网 11
要参与 10BPS 测试网络（TN11），请参阅以下详细 指南。
使用配置文件
cargo run --release --bin kaspad -- --configfile /path/to/configfile.toml
# or
cargo run --release --bin kaspad -- -C /path/to/configfile.toml
- 配置文件应该是一个由换行符分隔的 <CLI 参数> = <值> 列表。
- 在
=周围的空白是允许的，arg=value和arg = value都可以被正确解析。 - 包含特殊字符如
.或=的值需要将值引起来，即 <CLI 参数> = "<值>"。 - 具有多个值的参数应使用括号包围，如
addpeer = ["10.0.0.1", "1.2.3.4"]。
例如
testnet = true
utxoindex = false
disable-upnp = true
perf-metrics = true
appdir = "some-dir"
netsuffix = 11
addpeer = ["10.0.0.1", "1.2.3.4"]
传递 --help 标志以查看所有可能的参数
cargo run --release --bin kaspad -- --help
wRPC
kaspad 中默认禁用了 wRPC 子系统，可以通过以下方式启用：
JSON 协议
--rpclisten-json = <interface:port>
# or use the defaults for current network
--rpclisten-json = default
Borsh 协议
--rpclisten-borsh = <interface:port>
# or use the defaults for current network
--rpclisten-borsh = default
备注
Rusty Kaspa 集成了一个可选的 wRPC 子系统。wRPC 是一个高性能、平台中立、以 Rust 为中心的 WebSocket 框架 RPC 实现，可以使用 Borsh 和 JSON 协议编码。
JSON 协议消息类似于 JSON-RPC 1.0，但与规范不同，因为服务器端有通知。
Borsh 编码用于进程间通信。当使用 Borsh 时，客户端和服务器应从相同的代码库构建。
JSON 协议基于 Kaspa 数据结构，与数据结构版本无关。您可以使用任何 WebSocket 库连接到 JSON 端点。Kaspa WASM 框架中包含用于在网页浏览器和 Node.js 中运行的内置 RPC 客户端，适用于 JavaScript 和 TypeScript。
基准测试与测试
模拟框架（Simpa）
在 kaspad 和 simpa 中的日志可以通过以下方式 过滤：
当前代码库支持完整的进程内网络模拟，通过虚拟时间构建实际的DAG，并具有虚拟延迟和基准验证时间（在模拟生成之后）。
查看可用命令
cargo run --release --bin simpa -- --help
以下命令将运行模拟，生成1000个区块，每个区块的通信延迟为2秒，每秒8BPS（区块/秒），并尝试在每个区块中填充多达200笔交易。
cargo run --release --bin simpa -- -t=200 -d=2 -b=8 -n=1000
堆分析
在kaspad和simpa中进行堆分析，可以通过启用heap特性，并使用--features参数进行配置
cargo run --bin kaspad --profile heap --features=heap
它将在工作目录的根目录中生成{bin-name}-heap.json文件，可以使用dhat-viewer进行检查
测试
运行单元和大多数集成测试
cd rusty-kaspa
cargo test --release
// or install nextest and run
使用nextest
cd rusty-kaspa
cargo nextest run --release
基准测试
cd rusty-kaspa
cargo bench
日志记录
在 kaspad 和 simpa 中的日志可以通过以下方式 过滤：
-
定义环境变量
RUST_LOG -
添加类似于以下示例的--loglevel参数
(cargo run --bin kaspad -- --loglevel info,kaspa_rpc_core=trace,kaspa_grpc_core=trace,consensus=trace,kaspa_core=trace) 2>&1 | tee ~/rusty-kaspa.log在这个命令中，我们将
loglevel设置为INFO。
依赖项
~6–18MB
~221K SLoC