Simple Bitcoin JSON-RPC client based on GuzzleHttp
Installation
Run php composer.phar require denpa/php-bitcoinrpc
in your project directory or add following lines to composer.json
"require": {
"denpa/php-bitcoinrpc": "^2.0"
}
and run php composer.phar update
.
Requirements
PHP 7.0 or higher (should also work on 5.6, but this is unsupported)
Usage
Create new object with url as parameter
use Denpa\Bitcoin\Client as BitcoinClient;
$bitcoind = new BitcoinClient('http://rpcuser:rpcpassword@localhost:8332/');
or use array to define your bitcoind settings
use Denpa\Bitcoin\Client as BitcoinClient;
$bitcoind = new BitcoinClient([
'scheme' => 'http', // optional, default http
'host' => 'localhost', // optional, default localhost
'port' => 8332, // optional, default 8332
'user' => 'rpcuser', // required
'pass' => 'rpcpassword', // required
'ca' => '/etc/ssl/ca-cert.pem' // optional, for use with https scheme
]);
Then call methods defined in Bitcoin Core API Documentation with magic:
/**
* Get block info.
*/
$block = $bitcoind->getBlock('000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f');
$block('hash')->get(); // 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f
$block['height']; // 0 (array access)
$block->get('tx.0'); // 4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
$block->count('tx'); // 1
$block->has('version'); // key must exist and CAN NOT be null
$block->exists('version'); // key must exist and CAN be null
$block->contains(0); // check if response contains value
$block->values(); // array of values
$block->keys(); // array of keys
$block->random(1, 'tx'); // random block txid
$block('tx')->random(2); // two random block txid's
$block('tx')->first(); // txid of first transaction
$block('tx')->last(); // txid of last transaction
/**
* Send transaction.
*/
$result = $bitcoind->sendToAddress('mmXgiR6KAhZCyQ8ndr2BCfEq1wNG2UnyG6', 0.1);
$txid = $result->get();
/**
* Get transaction amount.
*/
$result = $bitcoind->listSinceBlock();
$totalAmount = $result->sum('transactions.*.amount');
$totalSatoshi = BitcoinClient::toSatoshi($totalAmount);
To send asynchronous request, add Async to method name:
use Denpa\Bitcoin\BitcoindResponse;
$promise = $bitcoind->getBlockAsync(
'000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f',
function (BitcoindResponse $success) {
//
},
function (\Exception $exception) {
//
}
);
$promise->wait();
You can also send requests using request method:
/**
* Get block info.
*/
$block = $bitcoind->request('getBlock', '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f');
$block('hash'); // 000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f
$block['height']; // 0 (array access)
$block->get('tx.0'); // 4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b
$block->count('tx'); // 1
$block->has('version'); // key must exist and CAN NOT be null
$block->exists('version'); // key must exist and CAN be null
$block->contains(0); // check if response contains value
$block->values(); // get response values
$block->keys(); // get response keys
$block->first('tx'); // get txid of the first transaction
$block->last('tx'); // get txid of the last transaction
$block->random(1, 'tx'); // get random txid
/**
* Send transaction.
*/
$result = $bitcoind->request('sendtoaddress', ['mmXgiR6KAhZCyQ8ndr2BCfEq1wNG2UnyG6', 0.06]);
$txid = $result->get();
or requestAsync method for asynchronous calls:
use Denpa\Bitcoin\BitcoindResponse;
$promise = $bitcoind->requestAsync(
'getBlock',
'000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f',
function (BitcoindResponse $success) {
//
},
function (\Exception $exception) {
//
}
);
$promise->wait();
License
This product is distributed under MIT license.
Donations
If you like this project, you can donate Bitcoins to 3L6dqSBNgdpZan78KJtzoXEk9DN3sgEQJu.
Thanks for your support!❤