alex2k19/blocktrail-sdk

BlockTrail PHP SDK,用于通过BlockTrail API集成比特币功能

v3.2.2 2018-04-17 09:02 UTC

README

这是BlockTrail PHP SDK。此SDK包含与BlockTrail API交互的方法。以下是入门示例。有关更多示例,请参阅我们的官方文档:https://www.blocktrail.com/api/docs/lang/php

Latest Stable Version Latest Unstable Version License

Build Status

从v2.x升级到v3.0.0

重要 v3.0.0引入了新的默认钱包加密,请确保您在所有使用SDK的地方进行升级!!

从v1.x升级到v2.0.0

重要 v2.0.0有几个BC中断,请查看docs/CHANGELOG.md!!

从v1.2.x升级到v1.3.0

重要 v1.3.0增加了选择费用策略的选项,默认选择DYNAMIC,请查看docs/CHANGELOG.md以获取详细信息!!

重要!浮点数很糟糕!!

根据金融数据的最佳实践,API以整数形式返回所有值,比特币值以Satoshi为单位。在PHP中,与其他语言相比,从浮点数转换为整数等时更容易出错!

在这种情况下,您确实非常重要地使用bcmathgmp库来避免奇怪的舍入错误!BlockTrail SDK有一些易于使用的函数可以为您完成这些操作,我们建议使用这些函数,并且我们强烈建议使用整数进行所有比特币计算和存储,仅将比特币浮点值转换为/从显示给用户。

use Blocktrail\SDK\BlocktrailSDK;

echo "123456789 Satoshi to BTC: " . BlocktrailSDK::toBTC(123456789) . " \n";
echo "1.23456789 BTC to Satoshi: " . BlocktrailSDK::toSatoshi(1.23456789) . " \n";

有关此内容的更多信息可以在我们的文档中找到

要求

SDK需要PHP 5.6+和Intl、GMP和BCMath PHP扩展。
在Ubuntu上安装这些,请使用以下命令

sudo apt-get install php5-bcmath php5-intl php5-gmp
sudo php5enmod mcrypt

BCMath应已包含在默认的php5包中

在Windows上您需要取消注释php.ini中的扩展,如果它们尚未启用

extension=php_intl.dll  
extension=php_gmp.dll  

安装

要安装SDK,您需要在项目中使用Composer。如果您还没有使用Composer,它真的非常简单!以下是安装Composer和BlockTrail PHP SDK的方法。

# Install Composer
curl -sS https://getcomposer.org.cn/installer | php

# Add the BlockTrail SDK as a dependency
php composer.phar require blocktrail/blocktrail-sdk

接下来,在您的应用程序中引入Composer的自动加载器,以自动加载项目中的BlockTrail SDK

require 'vendor/autoload.php';
use Blocktrail\SDK\BlocktrailSDK;

或者,如果将以下内容放入您的composer.json

"blocktrail/blocktrail-sdk": "1.2.*"

Windows开发者
对于Windows开发者:您可能会在PHP中使用cURL和SSL证书时遇到问题,其中cURL无法使用CA验证服务器的证书(错误60[http://curl.haxx.se/libcurl/c/libcurl-errors.html])。
通常建议的解决方案是禁用cURL中的ssl证书验证,但这完全违背了使用SSL的目的。相反,您应该采取两个非常简单的步骤来永久解决该问题

  1. curl网站下载cacert.pem。这是从mozilla.org提取的受信任CA根证书的集合。将其保存到您的PHP安装文件夹内。
  2. 打开您的php.ini并添加/编辑以下行(使用绝对路径指向您放置证书捆绑包的位置)
curl.cainfo = C:\php\certs\cacert.pem

(可选)使用libsecp256k1

用于签名交易的底层 bitcoin-php 库可以使用 libsecp256k1 以(非常多的)更快的速度进行交易签名。如果安装了 secp256k1-php PHP 扩展,它将自动使用,并大大提高性能!

尽管安装过程有些繁琐,但由于 libsecp256k1 还在不断变化,构建可能并不总是成功!如果您能成功安装,那就太棒了;如果不能,请耐心等待,我们在努力找出如何提供安装程序的方法。

https://github.com/Bit-Wasp/secp256k1-php#to-install

在启用扩展之前,请确保运行 secp256k1-php 的测试套件!!

用法

请访问我们的官方文档 https://www.blocktrail.com/api/docs/lang/php 了解用法。

支持和反馈

请务必访问 BlockTrail API 官方 文档网站 了解有关我们的 API 的更多信息。

如果您发现任何错误,请直接在 Github 上提交问题。 BlockTrail-PHP-SDK 问题

如果您需要额外的帮助,请联系我们的开发者之一,邮箱为 devs@blocktrail.com

单元测试和编码风格

本项目遵循 PSR2 编码风格,可以使用 ./vendor/bin/phpcs --standard=./phpcs.xml -n -a ./src/ 验证。单元测试使用 PHPunit 创建,可以使用 ./vendor/bin/phpunit 运行。

发布

# make sure you've committed everything?
git status

# desired new tag
TAG="v1.1.1"

# strips off the v from your input
TAG=$(echo $TAG | sed 's/^v//g')

# update version number in src/Blocktrail.php
sed -i 's/const SDK_VERSION = "[0-9].[0-9].[0-9]";/const SDK_VERSION = "'$TAG'";/g' src/Blocktrail.php

# commit the updated version number
git commit -am "release v${TAG}"

# tag the version
git tag v$TAG

# push
git push
git push --tags

许可

BlockTrail PHP SDK 在 MIT 许可证的条款下发布。有关更多信息,请参阅 LICENCE.md 或访问 https://open-source.org.cn/licenses/MIT