BTC开发-PHP相关

男娘i 2022-05-22 04:59 231阅读 0赞

# Simple Bitcoin JSON-RPC client based on GuzzleHttp #

[![Join the chat at https://gitter.im/php-bitcoinrpc/Lobby][Join the chat at https_gitter.im_php-bitcoinrpc_Lobby]][Join the chat at https_gitter.im_php-bitcoinrpc_Lobby_Join the chat at https_gitter.im_php-bitcoinrpc_Lobby]

[![Latest Stable Version][]][Latest Stable Version 1] [![License][]][Latest Stable Version 1] [![Build Status][]][Build Status 1] [![Code Climate][]][Code Climate 1] [![68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f64656e70616d757369632f7068702d626974636f696e7270632f6261646765732f636f7665726167652e737667][]][68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f64656e70616d757369632f7068702d626974636f696e7270632f6261646765732f636f7665726167652e737667 1]

## 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!❤

[Join the chat at https_gitter.im_php-bitcoinrpc_Lobby]: https://camo.githubusercontent.com/cdf23d7859d81f4e6651ee7b90aa2acf45355385/68747470733a2f2f6261646765732e6769747465722e696d2f7068702d626974636f696e7270632f4c6f6262792e737667
[Join the chat at https_gitter.im_php-bitcoinrpc_Lobby_Join the chat at https_gitter.im_php-bitcoinrpc_Lobby]: /images/20220522/94d4eb9161fb44cfb2968aa2c2214c3b.png
[Latest Stable Version]: https://camo.githubusercontent.com/290705999179dfe681e64875d71bf927eebcb61c/68747470733a2f2f706f7365722e707567782e6f72672f64656e70612f7068702d626974636f696e7270632f762f737461626c65
[Latest Stable Version 1]: https://packagist.org/packages/denpa/php-bitcoinrpc
[License]: https://camo.githubusercontent.com/0abde53a90d2b9115dc29b18fef68afe78f117be/68747470733a2f2f706f7365722e707567782e6f72672f64656e70612f7068702d626974636f696e7270632f6c6963656e7365
[Build Status]: https://camo.githubusercontent.com/1c9e739981f216886e548e7759308e2367679069/68747470733a2f2f7472617669732d63692e6f72672f64656e70616d757369632f7068702d626974636f696e7270632e737667
[Build Status 1]: https://travis-ci.org/denpamusic/php-bitcoinrpc
[Code Climate]: https://camo.githubusercontent.com/2183fbf7599b5bd8453fe1d9b1a9bb4a555f3eb1/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f64656e70616d757369632f7068702d626974636f696e7270632f6261646765732f6770612e737667
[Code Climate 1]: https://codeclimate.com/github/denpamusic/php-bitcoinrpc
[68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f64656e70616d757369632f7068702d626974636f696e7270632f6261646765732f636f7665726167652e737667]: /images/20220522/df06461150f5491f8bcb851aeccbaba7.png
[68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f64656e70616d757369632f7068702d626974636f696e7270632f6261646765732f636f7665726167652e737667 1]: https://codeclimate.com/github/denpamusic/php-bitcoinrpc/coverage
[Bitcoin Core API Documentation]: https://bitcoin.org/en/developer-reference#bitcoin-core-apis