USDT PHP開發包OmniTool簡介

OmniTool開發包適用於為PHP應用快速增加對Omni Layer/USDT數位資產的支援能力，即支援使用自有Omni Layer節點的應用場景，也支援基於第三方API服務和離線裸交易的輕量級部署場景。

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，主要類別/介面及關係如下圖所示：

2、RpcClient類別使用說明

RpcClient類別封裝了Omni Layer的RPC介面協定。建立RpcClient物件時，需要傳入包含有效身分資訊的節點RPC URL。例如，假設安裝在本機的omnicored節點軟體配置如下：

rpcuser：userrpcpassword：123456rpcport：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代幣：

rewreeeDRPDD 或者DRA缸通過的介面例如，使用listunspent呼叫來取得本機節點中指定位址的utxo：

$ret = $client->omni->send(          '3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY',    /*代币转出地址*/
          '37FaKponF7zqoMLUjEiko25pDiuVH5YLEa',    /*代币转入地址*/
          31,                                      /*代币ID：USDT*/
          "100.00"                                 /*转移的代币数量*/
       );

開發套件中的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代币转账示例代码如下，说明见注释：

<?phprequire(&#39;../vendor/autoload.php&#39;);use OmniTool\Wallet;                              /*引入开发包*/$wallet = Wallet::cloud(            &#39;./demo.wallet&#39;,                      /*钱包文件地址，自动创建*/
            &#39;testnet&#39;                             /*网络ID*/
          );
$prvKey = &#39;4aec8e45106....00d5c5af494a4e05b&#39;;     /*私钥：16进制字符串*/            $wallet->addKey($prvKey);                         /*将私钥加入钱包，只需加入一次*/$addressList = $wallet->getAddressList();         /*返回钱包管理的所有地址，数组*/$rawtx = $wallet->omniSendTx(
            $addressList[0],                      /*发送方地址，私钥必须已经加入钱包*/
            &#39;mgYPLmNuZymK...e2XUNF6VFnT&#39;,         /*接收方地址*/
            2,                                    /*转账OMNI代币ID，2：TOMN*/
            &#39;0.000001&#39;                            /*转账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：

<?phprequire(&#39;../vendor/autoload.php&#39;);use OmniTool\Wallet;

$wallet = Wallet::cloud(&#39;./demo.wallet&#39;,&#39;testnet&#39;);
$addressList = $wallet->getAddressList();

$rawtx = $wallet->btcSendTx(
                    $addressList[0],                /*发送方地址*/
                    &#39;moneyqMan7u...8qVrc9ikLP&#39;,     /*接收方地址*/
                    1000,                           /*转账比特币数量，单位：SATOSHI*/
                    500                             /*手续费，单位：SATOSHI*/
                  );                       
echo &#39;btc rawtx => &#39; . $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进制字符串。

当前实现类：

CloudBroadcasterLocalBroadcaster

例如，下面的代码使用CloudBroadcaster将裸交易码流广播到Omni网络中：

use OmniTool\CloudBroadcaster;

$broadcaster = new CloudBroadcaster(                      'testnet'                     /*测试网*/
                   );
$ret = $broadcaster->broadcast(        '01000000011da9283b4...59f58488ac00000000'  /*裸交易*/
       );

7、数据查询接口

OmniTool使用ExplorerInterface来约定Omni数据查询功能。

接口方法：

getBtcBalance($address)：查询指定地址的比特币余额getOmniBalance($address,$propertyId)：查询指定地址的Omni代币余额

当前实现类：

CloudBroadcasterLocalBroadcaster

例如，下面的代码使用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;

推荐教程：支付宝即时到账在线支付实战项目开发视频教程

以上是USDT PHP開發包OmniTool簡介的詳細內容。更多資訊請關注PHP中文網其他相關文章！