6 个版本
| 0.13.4 | 2024 年 1 月 24 日 |
|---|---|
| 0.0.4 | 2023 年 10 月 31 日 |
| 0.0.3 | 2023 年 4 月 17 日 |
| 0.0.0 | 2023 年 3 月 23 日 |
#606 in 魔法豆
129 每月下载量
用于 11 个crate (5 直接)
180KB
4.5K SLoC
Kaspa 在 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++依赖项配置问题，当在WASM和原生C++代码编译（原生
RocksDB+secp256k1与WASM32构建的secp256k1之间切换时，Windows上的LLVMAR安装可能无法正常工作。不幸的是，手动设置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。
默认的XCode安装的
llvm不支持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，这是一种在Web浏览器和NodeJs中运行的二进制指令格式。这允许使用JavaScript和TypeScript编程语言轻松开发，同时保留Rust的优点。
可以通过运行以下命令从源代码构建WASM SDK组件：- ./build-release - 构建完整发布包（包括针对web和nodejs目标的发布和调试构建）- ./build-docs - 构建TypeScript文档- ./build-web - 发布web构建- ./build-web-dev - 开发web构建- ./build-nodejs - 发布nodejs构建- ./build-nodejs-dev - 开发nodejs构建
重要：不要在生产中使用dev构建。它们的大小和速度都显著更大，并包含调试符号。
要求
- NodeJs（v20+）：https://node.org.cn/en
- TypeDoc：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 上提供服务，因此请打开您的网页浏览器并加载 https://127.0.0.1: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 参数> = "<value>"。 - 具有多个值的参数应该用括号括起来，如
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 框架内置了 JavaScript 和 TypeScript 的 RPC 客户端，这些客户端可以在网页浏览器和 Node.js 中运行。
基准测试 & 测试
模拟框架（Simpa）
在 kaspad 和 simpa 中，可以通过以下方式 过滤 日志：
当前代码库支持完整的进程内网络模拟，通过虚拟时间构建实际的 DAG，具有虚拟延迟和基准验证时间（在模拟生成后）。
查看可用命令
cargo run --release --bin simpa -- --help
以下命令将运行一个模拟，生成 1000 个区块，通信延迟为 2 秒，8 BPS（每秒区块数），并尝试在每个区块中填充多达 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。
依赖项
~43–60MB
~1M SLoC