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，请符合 标准-README 规范。

许可证

本项目受 Apache License 2.0 许可。