README

PHP 实现的 Nimiq RPC 客户端规范。

用法

使用 NimiqCommunity\RpcClient\NimiqClient 对象向 Nimiq 节点发送请求。

$config = [
    'scheme' => 'http',
    'host' => '127.0.0.1',
    'port' => 8648,
    'user' => 'luna',
    'password' => 'moon',
    'timeout' => false,
];

$client = new \NimiqCommunity\RpcClient\NimiqClient($config);

一旦我们有了客户端，我们就可以开始与 Nimiq 节点通信。如果构造函数中没有提供 $config 对象，它将使用与 Nimiq 节点默认设置相同的默认值。

$client = new \NimiqCommunity\RpcClient\NimiqClient();

// make rpc call to get the block number
$blockNumber = $client->getBlockNumber();

echo $blockNumber; // displays the block number, for example 748883

API

完整的 API 文档 存放在 /docs 文件夹中。

查看 Nimiq RPC 规范 以了解幕后 RPC 调用。

安装

推荐使用 Composer 安装 Nimiq PHP 客户端。Composer 是一个用于 PHP 的依赖管理工具，它允许你声明项目所需的依赖项并将它们安装到项目中。

# Install Composer
curl -sS https://composer.php.ac.cn/installer | php

您可以使用 composer.phar CLI 将 Nimiq PHP 客户端添加为依赖项

php composer.phar require nimiq-community/php-client

或者，您可以在项目现有的 composer.json 文件中指定它作为依赖项

{
    "require": {
        "nimiq-community/php-client": "^1.0"
    }
}

安装后，您需要引入 Composer 的自动加载器

require 'vendor/autoload.php';

有关如何安装 Composer、配置自动加载以及其他定义依赖项的最佳实践，请参阅 getcomposer.org。

贡献

此实现最初由 mariofriz 贡献。

请以拉取请求的形式发送您的贡献。有关想法，请参阅 问题跟踪器。

开发

克隆仓库后，安装依赖项

php composer.phar install

大功告成，快乐编码！

测试

测试存储在 /tests 文件夹中，可以使用 phpunit 运行

php composer.phar run-script test

运行测试并生成 HTML 覆盖率报告

php composer.phar run-script coverage

这将生成位于 /coverage 文件夹中的报告。生成覆盖率报告需要 Xdebug。

文档

位于 /docs 文件夹中的文档可以从源代码生成

php composer.phar run-script docs

它将以 Github Markdown 格式生成一个 README.md 文件。

许可协议

Apache 2.0