3 个不稳定版本

0.13.4 2024 年 1 月 24 日
0.0.2 2023 年 10 月 31 日
0.0.0 2023 年 10 月 31 日

#2408 in 魔法豆

30 每月下载量

MIT/ApacheLGPL-3.0-only

1.5MB
33K SLoC

KOS

一个集成桌面应用程序,提供本地 Kaspa 节点实例、CPU 矿工(用于测试网)和基于 Rusty Kaspa 项目的钱包子系统。该应用程序使用 Rust 编写并集成了 Rusty Kaspa 框架。

此应用程序兼容 Windows、MacOS 和 Linux 桌面环境。

请注意,此项目由 3 个顶级组件组成

  • /kos - 桌面应用程序环境(可作为桌面应用程序运行)
  • /cli - 原生终端环境(可从命令行运行)
  • /wallet/wasm - 网页应用程序(可在浏览器中运行)

上述所有三个组件都是用 Rust 编写的同一应用程序,唯一的不同是 cliwallet 无法运行 kaspad(但可以远程连接到它)。此外,clikos 将所有钱包数据存储在文件系统中,并且可以互换,而网页钱包将钱包数据存储在您的浏览器中(由运行钱包的域名关联和锁定)。

依赖关系

  • 货仓nw: cargo install cargo-nw (更多信息请参阅 cargo nw --help

Cargo NW 是一个用于运行和部署 NWJS 应用程序的工具。

请确保您已安装最新版本的 Rust,通过运行 rustup update,并通过运行 cargo install wasm-pack 安装最新版本的 wasm-pack

如果您尚未设置 Rusty Kaspa 开发环境,请按照此项目根目录中的 README 进行操作。

代码库

要在测试网上使用 KOS,您需要按照以下方式克隆 rusty-kaspa 和 cpu-miner 代码库。

mkdir kaspa
cd kaspa
git clone -b kos https://github.com/aspectron/rusty-kaspa
git clone https://github.com/aspectron/kaspa-cpu-miner

(请注意,您正在从 aspectron/rusty-kaspa 代码库的 kos 分支进行克隆,直到 KOS 被合并到 kaspanet/master

构建

请注意,要在开发环境中运行此应用程序,您需要构建 Rusty Kaspa 和 CPU Miner。您可以通过以下方式进行

cd rusty-kaspa
cargo build --bin kaspad --release
cd ../kaspa-cpu-miner
cargo build --release
cd ../rusty-kaspa/kos

发布

cd rusty-kaspa/kos
./build

调试

cd rusty-kaspa/kos
./build --dev

运行

  • 常规:cargo nw run
  • 使用 NWJS SDK:cargo nw run --sdk
  • 使用本地 cargo-nw:cargo run -- nw ../rusty-kaspa/kos run --sdk

--sdk 选项允许您打开开发控制台,您可以通过它访问应用程序日志输出(使用 log_info! 和相关宏)。

KOS 和 CLI

注意:/kos/cli 几乎相同。KOS 在由 NWJS 提供支持的桌面环境中运行,并通过 cargo-nw 自动化。CLI 在命令行环境中运行。KOS 能够以子进程的形式运行和管理 Rusty Kaspa 节点(kaspad),以及在初始 alpha 阶段期间运行 CPU 挖矿器。

KOS 会通过查看 ../target/release/kaspad../kaspa-cpu-miner/target/release/kaspa-cpu-miner 自动检测 Kaspa 节点和 CPU 挖矿器应用程序。

您也可以使用 node selectminer select 命令来选择发布或调试版本,或者将这些命令的第三个参数作为自定义路径。

基本指南

一旦启动 KOS,您可以执行以下操作

在执行任何其他操作之前,请输入:network testnet-10 - 指定您想要与 testnet-10 交互。

node start - 启动 kaspa 节点;您需要等待节点同步

node mute - 切换节点日志输出

wallet create - 创建本地钱包;您可以通过在创建命令后指定名称来创建多个钱包。例如:wallet create alpha 将创建一个名为 alpha 的钱包,稍后可以用 open alpha 打开。钱包的默认名称为 kaspa。每个命名的钱包都存储在单独的文件中。(一旦创建,无法更改钱包名称)

account create bip32 - 在当前打开的钱包中创建新账户。您可以在创建时为其命名,如下所示:account create bip32 personalaccount create bip32 business。这将创建名为 personalbusiness 的账户。账户名称可以在以后用作转账或选择账户时的简称。

一旦同步完成并且挖矿程序正在运行,请确保有一个选择了账户的钱包打开,并使用 miner start。这将启动挖矿程序并开始为您选择的账户挖矿。如果您的哈希率是 Kh/s,找到区块可能需要一段时间。

一旦收到一些 TKAS,您可以通过执行 transfer p 10 来测试发送。字母 p 代表 personal - 当使用账户名称时,您可以使用账户名称的第一个字母或其 ID。如果多个账户与您提供的名称前缀匹配,您将需要提供更具体的信息。

使用 list 查看您的账户及其余额。

您可以通过单击任何地址将其复制到剪贴板。

使用 mute 切换内部框架事件的可见性。与该框架集成的应用程序将接收这些事件并能够相应地更新用户界面。

使用 send <address> 10 将资金发送给其他人。

使用 guide 获取内部指南,它提供了有关支持命令的更多信息。

依赖关系

~42–57MB
~1M SLoC