README

ZUM 服务 PHP API 接口

此封装允许您轻松与 ZUM 服务 1.0.1 API 交互，以快速开发与 ZumCoin 网络交互的应用程序。

安装

composer require zumcoin/zumservices-api-php

初始化

use ZUMservices\ZUMservices;

$config = [
    'token' => 'eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoidGVzdCIsImFwcElkIjo0LCJ1c2VySWQiOjYsInBlcm1pc3Npb25zIjpbImFkZHJlc3M6bmV3Il0sImlhdCI6MTUzNjU4NTM2NywiZXhwIjoxNTM5MTc3MzY3LCJhdWQiOiJ0dXJ0bGV3YWxsZXQuaW8iLCJpc3MiOiJUUlRMIFNlcnZpY2VzIiwianRpIjoiMzMifQ.AEHXmvTo8RfNuZ15Y3IGPRhZPaJxFSmOZvVv2YGN9L4We7bXslIPxhMv_n_5cNW8sIgE2Fr-46OTb5H5AFgpjA',
    'timeout' => 2000
];

$ZS = new ZUMservices($config);

响应格式化

// The result field from the RPC response
$response->result();

// RPC response as JSON string
$response->toJson();

// RPC response as an array
$response->toArray();

文档

API 文档可在 https://zum.services/documentation 查看

方法

createAddress()

创建新的 ZUM 地址

$ZS->createAddress()

getAddress(address)

通过地址获取地址详细信息

$ZS->getAddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")

deleteAddress(address)

删除选定的 ZUM 地址

$ZS->deleteAdddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")

getAddresses()

查看所有地址。

$ZS->getAddresses()

scanAddress(address, blockIndex)

在指定的 blockIndex 从 100 个区块范围内扫描地址的交易。

$ZS->scanAddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC", 899093)

getAddressKeys(address)

获取地址的公钥和秘密花费密钥。

$ZS->getAddressKeys("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")

integrateAddress(address, paymentId)

使用地址和支付 ID 创建集成地址。

$ZS->integrateAddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC", "7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804")

getIntegratedAddresses(address)

通过地址获取所有集成地址。

$ZS->getIntegratedAddresses("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")

getFee(amount)

计算指定为 ZUM（保留两位小数）的金额的 ZUM 服务费用。

$ZS->getFee(123.45)

createTransfer(sender, receiver, amount, fee, paymentId, extra)

使用地址发送 ZUM 交易，金额指定为两位小数。

$ZS->createTransfer(
  "Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC",
  "Zum1yhbRwHsXj19c1hZgFzgxVcWDywsJcDKURDud83MqMNKoDTvKEDf6k7BoHnfCiPbj4kY2arEmQTwiVmhoELPv3UKhjYjCMcm",
  1234.56,
  1.23,
  "7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804",
  "3938f915a11582f62d93f82f710df9203a029f929fd2f915f2701d947f920f99"
)

您可以将最后两个字段（paymentId 和 extra）留空。

getTransfer(address)

通过交易哈希获取交易详情。

$ZS->getTransfer("EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ")

getWallet()

获取钱包容器信息和健康检查。

$ZS->getWallet()

getStatus()

获取 ZUM 服务基础设施的当前状态。

$ZS->getStatus()

许可

Copyright (C) 2019 ZumCoin Development Team

Please see the included LICENSE file for more information.

zumcoin / zumservices-api-php

维护者

详细信息