Nimiq Core的Rust实现 (core-rs)

Rust实现的Nimiq区块链核心

Nimiq 是一个无摩擦的网页支付协议。

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

Nimiq Rust客户端没有钱包，目前不能用于发送交易。但作为骨干节点，它的性能比JavaScript实现更优。

目录

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

背景

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

安装

除了Rust的nightly版本本身之外，以下包是编译此源代码所必需的

• 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许可。