Nimiq 核心在 Rust 中的实现 (core-rs)

Rust 实现的 Nimiq 区块链核心

Nimiq 是一种无缝的网页支付协议。

此存储库已归档。您可以使用 JavaScript 实现。或者，如果您正在寻找 Albatross Rust 实现，请查看相应的存储库。

Nimiq Rust 客户端不包含钱包，目前不能用来发送交易。尽管如此，作为骨干节点，它比 JavaScript 实现性能更好。

目录

• 背景
• 安装
• 用法
• 贡献
• 许可证

背景

• Nimiq 白皮书：关于 Nimiq 项目的详细信息。
• Nimiq 开发者参考：协议架构的详细信息。

安装

除了 Rust 夜间版 之外，还需要以下包才能编译此源代码

• gcc
• pkg-config
• libssl-dev（在 Debian/Ubuntu 中）或 openssl-devel（在 Fedora/Red Hat 中）

从 crates.io

要从 crates.io 下载，请编译并安装客户端

cargo +nightly install nimiq-client

二进制文件将安装到您的 Cargo 目录中，通常位于 $HOME/.cargo/bin，并且应在您的 $PATH 中可用。

从 Git

通过 cargo 编译项目

git clone https://github.com/nimiq/core-rs
cd core-rs
cargo +nightly build

请注意，这将以调试模式构建，性能不如发布模式。为了从客户端中获得最佳速度，请以发布模式构建。

cargo +nightly build --release

如果您想将客户端安装到您的系统（到 $HOME/.cargo/bin），请运行

cargo +nightly install --path client/

或者您可以直接从git安装

cargo +nightly install --git https://github.com/nimiq/core-rs.git

安装客户端后，您可以使用它，就像您从crates.io下载一样。

用法

安装后，您可以直接运行客户端，如下所示

nimiq-client

配置

默认情况下，客户端将在$HOME/.nimiq/client.config中查找配置文件。您需要自己创建此文件

nimiq-client                                                   # Run the client. This will create the example config file.
cp $HOME/.nimiq/client.example.toml $HOME/.nimiq/client.toml   # Create your config from the example.
nano $HOME/.nimiq/client.toml                                  # Edit the config. Explanations are included in the file.

您还可以指定自己的配置文件

nimiq-client -c path/to/client.toml

查看client/client.example.toml以获取所有配置选项。

贡献

如果您想为Nimiq的开发做出贡献，请遵循我们的行为准则和贡献指南。

小贴士：如果编辑README，请遵循standard-readme规范。

许可证

本项目采用Apache License 2.0。