Nimiq Core JS 开源项目最佳实践

1. 项目介绍

Nimiq Core JS 是 Nimiq 协议的官方 JavaScript 实现。Nimiq 是一种无缝支付协议，旨在为网页提供便捷的支付解决方案。该协议通过其 PoS 共识机制提供安全、高效和易用的区块链技术。Nimiq Core JS 旨在帮助开发者轻松集成 Nimiq 功能到他们的应用中。

2. 项目快速启动

以下步骤将帮助你快速启动 Nimiq Core JS 项目：

首先，确保你的开发环境已经安装了 Node.js（版本 >= v16.20.2）。

在 Ubuntu 或 Debian 系统上，安装 git 和 build-essential：

sudo apt-get install -y git build-essential

在其他 Linux 系统、MacOS 或 Windows 上，安装相应的编译工具。

接着，全局安装 yarn 和 gulp：

sudo npm install -g yarn
yarn global add gulp

克隆项目仓库：

git clone https://github.com/nimiq/core-js.git

进入项目目录并构建项目：

cd core-js && yarn && yarn build

构建完成后，你可以通过浏览器打开 clients/browser/index.html 文件来查看示例应用。

3. 应用案例和最佳实践

浏览器客户端

在浏览器中，你可以通过 CDN 引入 Nimiq JS 库：

<script src="https://cdn.nimiq.com/latest/nimiq.js"></script>

或者直接在项目中引入：

<script src="dist/nimiq.js"></script>

Node.js 客户端

在 Node.js 应用中，你需要准备一个公网 IP 地址、域名以及 SSL 证书。然后，你可以使用以下配置来启动 Node.js 客户端：

clients/nodejs/nimiq

确保你按照官方文档配置了客户端。

测试和构建

运行测试套件：

yarn test

如果你想仅在浏览器或 Node.js 环境中运行测试，可以使用以下命令：

yarn test-browser

或

yarn test-node

运行 ESLint 代码检查：

yarn lint

构建项目：

yarn build

构建命令会将所有源代码合并到对应的 dist 文件中。

4. 典型生态项目

Nimiq 生态系统中有多个项目可以帮助开发者快速集成和使用 Nimiq 协议：

• @nimiq/core: 用于 Node.js 应用的 Nimiq 核心库模块。
• @nimiq/core-web: 用于浏览器应用的 Nimiq 核心库模块。

开发者可以根据自己的需求选择合适的模块进行集成，并遵循官方文档进行开发。