比特幣PHP離線交易開發包

BtcTool是一個基於第三方服務和離線裸交易實現的PHP比特幣應用開發包,適合不但願部署本地 節點旳PHP開發者,開發包主要包含如下特性:php

  • 利用第三方服務獲取指定地址的utxo集合
  • 離線生成消費裸交易
  • 利用第三方服務廣播裸交易

BtcTool目前支持的第三方服務包括,而且能夠很是簡單進行擴展:json

  • blockchain.info
  • btc.com

BtcTool下載地址:http://sc.hubwiz.com/codebag/btc-php-lib/composer

1. 代碼清單

BtcTool運行在**Php 7.1+**環境下,當前版本1.0.0,主要代碼文件清單以下:函數

<table class="table table-striped"> <thead> <tr><th>代碼文件</th><th>說明</th></tr> </thead> <tbody> <tr><td>btctool/src/Wallet.php</td><td>離線錢包類,開發包入口</td></tr> <tr><td>btctool/src/Utxo.php</td><td>未消費交易輸出類</td></tr> <tr><td>btctool/src/UtxoBag.php</td><td>Utxo集合類</td></tr> <tr><td>btctool/src/UtxoCollector.php</td><td>Utxo收集器接口</td></tr> <tr><td>btctool/src/CloudUtxoCollector.php</td><td>基於第三方服務的Utxo收集器實現</td></tr> <tr><td>btctool/src/UtxoSelector.php</td><td>Utxo篩選器接口</td></tr> <tr><td>btchtool/src/DefaultUtxoSelector.php</td><td>默認的Utxo篩選器實現</td></tr> <tr><td>btctool/src/Broadcaster.php</td><td>交易廣播器接口</td></tr> <tr><td>btctool/src/CloudBroadcaster.php</td><td>基於第三方服務的交易廣播器實現</td></tr> <tr><td>btctool/src/Utils.php</td><td>經常使用輔助函數</td></tr> <tr><td>demo/wallet-init.php</td><td>本地錢包初始化</td></tr> <tr><td>demo/wallet-demo.php</td><td>錢包載入、裸交易構造和廣播</td></tr> <tr><td>vendor</td><td>第三方依賴包目錄</td></tr> <tr><td>composer.json</td><td>composer配置文件</td></tr> </tbody> </table>ui

2. 使用說明

BtcTool的入口是Wallet類,基本的使用步驟以下:編碼

  1. 建立一個Wallet實例
  2. 將私鑰加入該Wallet實例
  3. 使用Wallet實例的**sendTx()**方法獲取編碼後的裸交易
  4. 使用Wallet實例的**broadcast()**方法廣播裸交易

示例例代碼以下,說明見註釋:code

<?php
require('../vendor/autoload.php');

use BtcTool\Wallet;            //引入開發包

$wallet = new Wallet('testnet');  //建立錢包,主網傳入 mainnet

$prvKey = '...';                 //向錢包中添加私鑰,可添加多個
$wallet->addKey($prvKey);

$toAddr = 'mgYPLmNuZymK...e2XUNF6VFnT'   //地址應當與testnet/mainnet保持一致
$amount = 10000;                //單位:satoshi
$rawtx = $wallet->sendTx($toAddr,$amount);  //構造裸交易,返回16進制字符串

$ret = $wallet->broadcast($rawtx);   //廣播裸交易

注意:對象

  1. Wallet實例利用錢包中的私鑰生成地址列表,並利用這些地址從第三方服務獲取utxo信息。 所以須要錢包中的私鑰對應地址在鏈上有utxo存在,Wallet對象纔可以成功構造裸交易。
  2. 在調用Wallet對象的sendTx()方法構造裸交易時,能夠指定找零地址和手續費,例如:
$rawtx = $wallet->sendTx($toAddr,$amount,$changeAddr,$fee);

若是未指定後面兩個參數,找零地址默認爲錢包中第一個私鑰對應的地址,手續費默認爲 10000satoshi(高費率)。 3. 轉帳目標地址應當與建立Wallet對象時指定的鏈ID一致,例如mainnet的p2pkh地址,前綴應當爲1接口

3. 主要模型

3.1 UtxoCollector接口

利用錢包地址列表,獲取候選UTXO。ip

接口方法:

  • collect():提取候選UTXO,返回TUXO集合

當前實現類:

  • CloudUtxoCollector

3.2 UtxoSelector接口

根據目標金額從候選UTXO中選擇可消費UTXO

接口方法:

  • select():選擇可消費UTXO,返回UtxoBag對象

當前實現類:

  • DefaultUtxoSelector

3.3 Broadcaster接口

裸交易廣播器

接口方法:

  • broadcast():廣播裸交易

當前實現類:

  • CloudBroadcaster

3.4 Wallet類

管理私鑰、地址和腳本,同時提供構造和廣播裸交易的方法

主要方法:

  • ::load(): 靜態方法,利用硬盤的錢包文件構造Wallet對象
  • addKey():添加私鑰
  • save():將Wallet對象保存到錢包文件
  • sendTx():構造裸交易,返回裸交易碼流,該方法可自動搜索可用UTXO集合
  • broadcast():廣播裸交易,調用Broadcaster完成
相關文章
相關標籤/搜索
本站公眾號
   歡迎關注本站公眾號,獲取更多信息