Run php composer.phar require denpa/php-bitcoinrpc in your project directory or add following lines to composer.json
"require": {
"denpa/php-bitcoinrpc": "^2.2"
}and run php composer.phar install.
PHP 8.0 or higher
For PHP 5.6 to 7.0 use php-bitcoinrpc v2.0.x.
For PHP 7.0 to 7.4 use php-bitcoinrpc v2.0.x.
Create new object with url as parameter
/**
* Don't forget to include composer autoloader by uncommenting line below
* if you're not already done it anywhere else in your project.
**/
// require 'vendor/autoload.php';
use Denpa\Bitcoin\Client as BitcoinClient;
$bitcoind = new BitcoinClient('http://rpcuser:rpcpassword@localhost:8332/');or use array to define your bitcoind settings
/**
* Don't forget to include composer autoloader by uncommenting line below
* if you're not already done it anywhere else in your project.
**/
// require 'vendor/autoload.php';
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
'password' => 'rpcpassword', // required
'ca' => '/etc/ssl/ca-cert.pem', // optional, for use with https scheme
'preserve_case' => false, // optional, send method names as defined instead of lowercasing them
]);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();
$bitcoin = $result->sum('transactions.*.amount');
$satoshi = \Denpa\Bitcoin\to_satoshi($bitcoin);To send asynchronous request, add Async to method name:
$bitcoind->getBlockAsync(
'000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f',
function ($response) {
// success
},
function ($exception) {
// error
}
);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:
$bitcoind->requestAsync(
'getBlock',
'000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f',
function ($response) {
// success
},
function ($exception) {
// error
}
);You can use wallet($name) function to do a Multi-Wallet RPC call:
/**
* Get wallet2.dat balance.
*/
$balance = $bitcoind->wallet('wallet2.dat')->getbalance();
echo $balance->get(); // 0.10000000-
Denpa\Bitcoin\Exceptions\BadConfigurationException- thrown on bad client configuration. -
Denpa\Bitcoin\Exceptions\BadRemoteCallException- thrown on getting error message from daemon. -
Denpa\Bitcoin\Exceptions\ConnectionException- thrown on daemon connection errors (e. g. timeouts)
Package provides following helpers to assist with value handling.
Converts value in satoshi to bitcoin.
echo Denpa\Bitcoin\to_bitcoin(100000); // 0.00100000Converts value in bitcoin to satoshi.
echo Denpa\Bitcoin\to_satoshi(0.001); // 100000Converts value in bitcoin to ubtc/bits.
echo Denpa\Bitcoin\to_ubtc(0.001); // 1000.0000Converts value in bitcoin to mbtc.
echo Denpa\Bitcoin\to_mbtc(0.001); // 1.0000Trims float value to precision without rounding.
echo Denpa\Bitcoin\to_fixed(0.1236, 3); // 0.123This product is distributed under MIT license.
If you like this project, please consider donating:
BTC: 3L6dqSBNgdpZan78KJtzoXEk9DN3sgEQJu
Bech32: bc1qyj8v6l70c4mjgq7hujywlg6le09kx09nq8d350
❤Thanks for your support!❤
