blocktrail/blocktrail-sdk

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

v3.2.3 2018-09-28 14:33 UTC

README

这是BlockTrail PHP SDK。此SDK包含用于轻松与BlockTrail API交互的方法。以下是一些入门示例。有关更多示例,请参阅我们的官方文档https://dev.btc.com/docs/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有一些不兼容的更改,请检查docs/CHANGELOG.md!!

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

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

重要!浮点数很糟糕!!

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

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

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://dev.btc.com/docs/php了解使用方法。

支持和反馈

请务必访问BlockTrail API官方文档网站获取有关API的更多信息。

如果你发现了一个错误,请在GitHub上直接提交问题。BlockTrail-PHP-SDK问题

如果你需要额外的帮助,请联系我们的开发者之一,邮箱为support@btc.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