USDT对接专用PHP开发包
OmniTool开发包适用于为PHP应用快速增加对Omni Layer/USDT数字资产的支持能力,即支持使用自有Omni Layer节点的应用场景,也支持基于第三方API服务和离线裸交易的轻量级部署场景。下载地址:omni/usdt php开发包 。
1、OmniTool开发包简介
OmniTool开发包主要包含以下特性:
- 完善的Omni Layer节点RPC封装
- 支持利用自有节点或第三方服务获取指定地址的utxo集合
- 支持离线生成omni代币转账裸交易
- 支持利用自有节点或第三方服务广播裸交易
OmniTool支持本地部署的Omnicored节点,也支持blockchain.info、btc.com等提供的开放API,要增加对其他第三方服务的支持也非常简单,只需要参考代码实现如下接口:
- UtxoCollectorInterface:utxo收集器
- UtxoSelectorInterface:utxo筛选器
- BroadcasterInterface:裸交易广播器
- ExplorerInterface:数据查询接口
OmniTool软件包运行在Php 7.1+环境下,当前版本1.0.0,主要类/接口及关系如下图所示:
OmniTool的主要代码文件清单参见:http://sc.hubwiz.com/codebag/omni-php-lib/
2、RpcClient类使用说明
RpcClient类封装了Omni Layer的RPC接口协议。创建RpcClient对象时,需要传入包含有效身份信息的节点RPC URL。例如,假设安装在本机的omnicored节点软件配置如下:
- rpcuser:user
- rpcpassword:123456
- rpcport:8332
那么可以使用如下的代码来实例化RpcClient:
use \OmniTool\RpcClient;$client = new RpcClient('http://user:123456@localhost:8332' /*节点RPC接口的URL*/);
Omni Core节点在Bitcoin原有的RPC接口之外,扩充了额外的接口用来操作Omni层的数据,这些扩展的RPC接口采用omni_
前缀以区隔于Bitcoin的原有RPC接口。为了便于区隔这两层的RPC调用,RpcClient引入了协议子模块的概念,将Bitcoin的原始RPC接口和Omni的扩展RPC接口分别挂接到btc子模块和omni子模块。
例如,获取某个地址的USDT代币余额需要使用Omni层的omni_getbalance调用,这个RPC调用对应于RpcClient实例的omni
子模块的getBalance()
方法。下面的代码获取地址1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P
的USDT(资产ID:31)余额:
$ret = $client->omni->getBalance('1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P', /*地址*/31 /*资产ID:USDT*/);
类似的,可以使用omni_send调用来执行简单的USDT转账,这个调用对应于RpcClient实例的omni子模块的send()
方法。下面的代码从地址3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY
向地址37FaKponF7zqoMLUjEiko25pDiuVH5YLEa
转入100.0个USDT代币:
$ret = $client->omni->send('3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY', /*代币转出地址*/'37FaKponF7zqoMLUjEiko25pDiuVH5YLEa', /*代币转入地址*/31, /*代币ID:USDT*/"100.00" /*转移的代币数量*/);
原有的bitoin层的RPC接口则可以通过RpcClient的btc子模块来访问。例如,使用listunspent调用来获取本地节点中指定地址的utxo:
$ret = $client->btc->listUnspent(6, /*最小确认数*/999999, /*最大确认数*/['mgnucj8nYqdrPFh2JfZSB1NmUThUGnmsqe'] /*地址清单*/ );
开发包中的demo/rpc-demo.php
示例代码使用RpcClient类完整演示了在Omni层的代币发行与转账功能,如果你计划搭建自己的Omni Core节点,相信这个示例会有很大帮助。
3、Wallet类使用说明
如果不愿意搭建自己的Omni Core节点,而是希望基于第三方API为自己的PHP应用增加对Omni Layer/USDT的支持,那么最简单的方法是使用离线交易的入口类Wallet。
Wallet类的主要作用是根据创建并广播Omni代币转账裸交易或比特币转账裸交易,它的基本使用步骤如下:
- 使用
Wallet::cloud()
静态方法创建一个支持云端API服务的Wallet实例 - 使用
addKey()
方法将必要的私钥加入该Wallet实例,例如转出地址的私钥,因为Wallet需要利用私钥对裸交易进行签名 - 使用
omniSendTx()
方法生成Omni代币转账裸交易,或者使用btcSendTx()
方法比特币转账裸交易 - 使用
broadcast()
方法广播裸交易
3.1 Omni代币转账
使用Wallet实现的Omni代币转账示例代码如下,说明见注释:
<?php
require('../vendor/autoload.php');use OmniTool\Wallet; /*引入开发包*/$wallet = Wallet::cloud('./demo.wallet', /*钱包文件地址,自动创建*/'testnet' /*网络ID*/);
$prvKey = '4aec8e45106....00d5c5af494a4e05b'; /*私钥:16进制字符串*/
$wallet->addKey($prvKey); /*将私钥加入钱包,只需加入一次*/$addressList = $wallet->getAddressList(); /*返回钱包管理的所有地址,数组*/$rawtx = $wallet->omniSendTx($addressList[0], /*发送方地址,私钥必须已经加入钱包*/'mgYPLmNuZymK...e2XUNF6VFnT', /*接收方地址*/2, /*转账OMNI代币ID,2:TOMN*/'0.000001' /*转账OMNI代币数量*/);$ret = $wallet->broadcast($rawtx); /*广播OMNI裸交易*/
var_dump($ret);
注意:
- Wallet实例利用钱包中的私钥生成地址列表,并利用这些地址从第三方服务获取utxo信息。 因此需要钱包中 的私钥对应地址在链上有utxo存在,Wallet对象才能够成功构造裸交易。
- 转账目标地址应当与创建Wallet对象时指定的链ID一致,例如mainnet的p2pkh地址,前缀应当为1
3.2 指定Omni交易的手续费支付地址
在Omni协议层不需要支付交易手续费,但是Omni交易所嵌入的比特币交易依然需要支付手续费。默认情况下omniSendTx()
方法使用发送方地址支付比特币交易手续费,但可以传入额外的参数来指定其他地址支付交易手续费,当你的PHP应用需要实现多账户归集功能时,使用统一的手续费支付地址会更容易管理一些。
例如,下面的代码使用地址mnRo8JyTHDd5NxRb3UvGbAhCBPQTQ4UZ8W
支付omni交易的手续费:
$rawtx = $wallet->omniSendTx($addressList[0], /*发送方地址,私钥必须已经加入钱包*/'mgYPLmNuZymK...e2XUNF6VFnT', /*接收方地址*/2, /*转账OMNI代币ID,2:TOMN*/'0.000001', /*转账OMNI代币数量*/'mnRo8JyTHDd5...CBPQTQ4UZ8W' /*交易手续费支付地址*/);
注意:
- 即使指定了余额充足的手续费支付地址,Omni交易的发送方依然必须有微量的比特币 余额(546 SATOSHI),因为Omni协议需要交易发送方至少有一个可用UTXO。
- 手续费支付地址同时也是找零地址,多余的比特币将返回至该地址
3.3 指定Omni交易的比特币转账数量
由于Omni交易要求发送方必须有可用的UTXO,因此为了便于接收Omni代币的地址可以继续流通所持有的Omni代币,omniSendTx()
方法在默认情况下将向接收方地址转入微量的比特币(546 SATOSHI),可以在调用该方法时修改这个默认数值。
例如,下面的代码转入接收方1000个SATOSHI:
$rawtx = $wallet->omniSendTx($addressList[0], /*发送方地址,私钥必须已经加入钱包*/'mgYPLmNuZymK...e2XUNF6VFnT', /*接收方地址2, /*转账OMNI代币ID,2:TOMN*/'0.000001', /*转账OMNI代币数量*/'mnRo8JyTHDd5...CBPQTQ4UZ8W', /*交易手续费支付地址*/1000 /*转账比特币数量,单位:SATOSHI*/);
3.4 比特币转账
OmniTool也支持比特币转账裸交易的生成与广播。
例如,下面的代码从钱包的第一个地址向指定接受地址转入1000个SATOSHI:
<?php
require('../vendor/autoload.php');use OmniTool\Wallet;$wallet = Wallet::cloud('./demo.wallet','testnet');
$addressList = $wallet->getAddressList();$rawtx = $wallet->btcSendTx($addressList[0], /*发送方地址*/'moneyqMan7u...8qVrc9ikLP', /*接收方地址*/1000, /*转账比特币数量,单位:SATOSHI*/500 /*手续费,单位:SATOSHI*/);
echo 'btc rawtx => ' . $rawtx . PHP_EOL;$ret = $wallet->broadcast($rawtx); /*广播裸交易*/
默认情况下,btcSendTx()
使用发送方地址作为找零地址,也可以在调用时指定其他地址作为找零地址,例如,下面的代码创建一个新地址接收找零:
$changeAddress = $wallet->getNewAddress(); /*创建新地址*/
$rawtx = $wallet->btcSendTx($addressList[0], /*发送方地址*/'moneyqMan7u...8qVrc9ikLP', /*接收方地址*/1000, /*转账比特币数量,单位:SATOSHI*/500, /*手续费,单位:SATOSHI*/$changeAddress /*找零地址*/);
4、UTXO收集器
OmniTool使用接口UtxoCollectorInterface
来约定UTXO的收集功能。该接口的实现需要支持获取指定地址的候选UTXO集合,可指定多个地址。
接口方法:
- collect($addressList):提取并返回候选UTXO集合
参数$addressList
用来声明要收集UTXO的地址清单,类型为数组。
当前实现类:
- CloudUtxoCollector:基于blockchain.com的开放API实现的Utxo收集器
- LocalUtxoCollector:基于omnicored节点RPC API实现的Utxo收集器
例如,下面的代码使用CloudUtxoCollector获取地址mi8BvbK73nDQfaN3acpaFGYQKhfQ5ysKRn
的UTXO:
use OmniTool\CloudUtxoCollector;$collector = new CloudUtxoCollector('testnet' /*测试网*/);
$candidateBag = $collector->collect(['mi8BvbK73nDQ...KhfQ5ysKRn'] /*地址清单*/);
5、UTXO筛选器
OmniTool使用UtxoSelectorInterface
来约定UTXO筛选功能。该接口的实现需要根据目标金额从候选UTXO中选择可用UTXO,并返回新的UtxoBag实例。
接口方法:
- select($target,$candidates):选择可消费UTXO,返回UtxoBag对象
参数$target
声明要达成的最低金额目标,单位:wei。
参数$candidates
是候选的utxo集合,通常是UtxoCollectorInterface实现对象的collect()调用返回的UtxoBag对象。
当前实现类:
- DefaultUtxoSelector
例如下面的代码使用DefaultUtxoSelector实例从候选UTXO中删选出至少100000 wei 的UTXO:
use OmniTool\DefaultUtxoSelector;$selector = new DefaultUtxoSelector();
$selectedBag = $selector->select(100000, /*最低目标金额*/$candidateBag /*候选UTXO集合*/);
考虑到UTXO的不可分割性,筛选出的若干UTXO的总和,有可能超过目标金额。可以使用UtxoBag实例的getTotal()
方法查看集合中的UTXO总额:
echo 'total wei in bag => ' . $selectedBag->getTotal() . PHP_EOL;
6、裸交易广播器
OmniTool使用BroadcasterInterface
来约定裸交易广播的功能。该接口的实现应当将裸交易广播到Omni网络中。
接口方法:
- broadcast($rawtx):广播裸交易
参数$rawtx
用来声明要广播的裸交易,类型为16进制字符串。
当前实现类:
- CloudBroadcaster
- LocalBroadcaster
例如,下面的代码使用CloudBroadcaster将裸交易码流广播到Omni网络中:
use OmniTool\CloudBroadcaster;$broadcaster = new CloudBroadcaster('testnet' /*测试网*/);
$ret = $broadcaster->broadcast('01000000011da9283b4...59f58488ac00000000' /*裸交易*/);
7、数据查询接口
OmniTool使用ExplorerInterface
来约定Omni数据查询功能。
接口方法:
- getBtcBalance($address):查询指定地址的比特币余额
- getOmniBalance($address,$propertyId):查询指定地址的Omni代币余额
当前实现类:
- CloudBroadcaster
- LocalBroadcaster
例如,下面的代码使用CloudExplorer查询地址1Jekm8ZswQmDhLFMp9cuYb1Kcq26riFp6m
的比特币余额与USDT代币余额:
use OmniTool\CloudExplorer;$explorer = new CloudExplorer('mainnet');$address = '1Jekm8ZswQmDhLFMp9cuYb1Kcq26riFp6m';$balance = $explorer->getBtcBalance($address);
echo 'btc balance => ' . PHP_EOL;$balance = $explorer->getOmniBalance($address,31);
echo 'usdt balance => ' . $balance['balance']. PHP_EOL;
OmniTool下载地址:http://sc.hubwiz.com/codebag/omni-php-lib/
转载于:https://blog.51cto.com/13692892/2406149
USDT对接专用PHP开发包相关推荐
- Omni/USDT钱包对接PHP开发包
OmniTool开发包适用于为PHP应用快速增加对Omni Layer/USDT数字资产的支持能力,即支持使用自有Omni Layer节点的应用场景,也支持基于第三方API服务和离线裸交易的轻量级部署 ...
- trc20地址监听php,Tron/USDT-TRC20对接PHP开发包 - 人人都是架构师
TronTool开发包适用于为PHP应用快速增加对Tron/USDT-TRC20数字资产的支持能力,即支持使用自有Tron区块链节点的应用场景,也支持基于Tron官方公共API服务的轻量级部署场景.T ...
- api php usdt 以太坊_以太坊智能地址PHP开发包【零GAS归集ERC20】
SmartWallet开发包适用于平台方高效完成对用户地址上的Ether/ERC20代币的归集工作,无需向用户地址注入Ether即可完成Ether/ERC20代币的归集.官方下载地址:以太坊智能钱包P ...
- 使用海康威视WEB3.0控件开发包 对接摄像头
使用海康威视WEB3.0控件开发包 对接摄像头 1.海康威视官网下载SDK 2.开发环境包 https://download.csdn.net/download/qq_36079837/2004684 ...
- USDT PHP开发包OmniTool简介
2019独角兽企业重金招聘Python工程师标准>>> OmniTool开发包适用于为PHP应用快速增加对Omni Layer/USDT数字资产的支持能力,即支持使用自有Omni L ...
- web端对接海康视频3.2开发包以及遇到的坑
须知: 3.0开发包功能比较全,但是只支持ie浏览器,所以使用的功能相对来说较少的3.2开发包,开发包官网上可以下载,可自行下载,并按照要求引入文件. 我的项目需求是左侧显示摄像头树状列表,中间部分显 ...
- 芯片-模组-开发板-软件开发包SDK(Software Development Kit)的关系(软件开发人员必须了解的硬件知识)
使用的芯片相同,但不同模组的Flash大小.天线的材质.模组尺寸是不同的.是的,芯片到模组的演变经历了"定制化.专用化"的过程.模组最终会嵌入到电视.电冰箱.空调等不同的产品中去, ...
- sdk开发包如何使用_SDK如何使能行业?华为昇腾要用软件充分释放硬件性能
谈及落地,软件永远是激发硬件性能的核心. 自AI出现,围绕传统产业"智能化转型"的探讨就一直没有停下.而随着"新基建"口号的喊出,工业制造等场景的智能化进程更是 ...
- JavaScript 游戏开发包-收集
基于WebGL的游戏引擎PlayCanvas 一般来讲,游戏开发与web应用完全是两码事.但先试试,游戏世界的很多工具都可以被用于在网站中增加华丽界面.PlayCanvas就是一个基于WebGL的游戏 ...
最新文章
- 超专业解析!10分钟带你搞懂Linux中直接I/O原理
- Foxmail: 错误信息::ssl连接错误, errorCode: 5,各种解决方案的大杂烩。
- 成功解决xgboost.core.XGBoostError: b'[20:58:45] C:\\Users\\Administrator\\Desktop\\xgboost\\dmlc-core\\s
- 科大星云诗社动态20220110
- BZOJ 4849 [NEERC2016] Mole Tunnels (模拟费用流)
- jbpm4.4+ssh配置
- 从容器到容器云,什么才是 Kubernetes 的本质?
- [转载] Python中TFTP的理解
- Linux 性能分析工具 nmon for Linux
- 基于卷积网络的度量学习
- alook浏览器_Alook浏览器
- 微信聊天api接口调用代码
- tf.contrib.silm学习
- 简单学JAVA-Java前世今生
- 11岁发现数学新定理,13岁登日本数学会学术会议,学界大佬:他是「可敬的数学家」...
- vo bo po dao pojo dto
- QT(1)- QString
- 法外之徒第一季/全集Braquo迅雷下载
- 实验6 实现数据完整性
- 秒懂流媒体协议 RTMP 与 RTSP