1. 安装通用前提条件

   sudo apt install curl git build-essential libssl-dev pkg-config 
   

2. 安装 Protobuf（gRPC 所需）

   sudo apt install protobuf-compiler libprotobuf-dev #Required for gRPC
   

3. 安装 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
   

4. 安装 rust 工具链

   如果您已安装 Rust，请运行以下命令更新它： rustup update

5. 安装 wasm-pack

   cargo install wasm-pack
   

6. 安装 wasm32 目标

   rustup target add wasm32-unknown-unknown
   

7. 克隆仓库

   git clone https://github.com/kaspanet/rusty-kaspa
   cd rusty-kaspa
   

1. 安装 Git for Windows 或其他 Git 发行版。

2. 安装 Protocol Buffers 并将 bin 目录添加到您的 Path

3. 安装 LLVM-15.0.6-win64.exe

   将 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。

4. 安装 rust 工具链

   如果您已安装 Rust，请运行以下命令更新它： rustup update

5. 安装 wasm-pack

   cargo install wasm-pack
   

6. 安装 wasm32 目标

   rustup target add wasm32-unknown-unknown
   

7. 克隆仓库

   git clone https://github.com/kaspanet/rusty-kaspa
   cd rusty-kaspa
   

1. 安装 Protobuf（gRPC 所需）

   brew install protobuf
   

2. 安装 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
   

3. 安装 rust 工具链

   如果您已安装 Rust，请运行以下命令更新它： rustup update

4. 安装 wasm-pack

   cargo install wasm-pack
   

5. 安装 wasm32 目标

   rustup target add wasm32-unknown-unknown
   

6. 克隆仓库

   git clone https://github.com/kaspanet/rusty-kaspa
   cd rusty-kaspa
   

Rust WebAssembly (WASM) 指的是使用 Rust 编程语言编写可编译成 WebAssembly（一种在浏览器和 NodeJs 中运行的二进制指令格式）的代码。这允许使用 JavaScript 和 TypeScript 编程语言进行轻松开发，同时保留 Rust 的优点。

可以通过运行以下命令从源代码构建 WASM SDK 组件：- ./build-release - 构建 full release package（包括针对 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/

构建和文档

• 发布构建：https://github.com/kaspanet/rusty-kaspa/releases
• 开发者构建：https://kaspa.aspectron.org/nightly/downloads/
• 开发者 TypeScript 文档：https://kaspa.aspectron.org/docs/

cd cli
cargo run --release

在 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 -- --configfile /path/to/configfile.toml
# or
cargo run --release --bin kaspad -- -C /path/to/configfile.toml

• 配置文件应是一系列用换行符分隔的 <CLI argument> = <value>。
• 在 = 周围的空白是可接受的，arg=value 和 arg = value 都会被正确解析。
• 包含特殊字符，如 . 或 = 的值需要将值引起来，即 <CLI argument> = "<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

在 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 中运行。

基准测试 & 测试

cargo run --release --bin simpa -- --help

cargo run --release --bin simpa -- -t=200 -d=2 -b=8 -n=1000

cargo run --bin kaspad --profile heap --features=heap

cd rusty-kaspa
cargo test --release
// or install nextest and run

cd rusty-kaspa
cargo nextest run --release

cd rusty-kaspa
cargo bench