matrunchyk/bitcoind-php

PHP Wrapper for a bitcoind daemon

dev-master / 1.0.x-dev 2013-12-30 12:11 UTC

Requires

• php: >=5.3.0
• lib-curl: *

Requires (Dev)

• phpunit/phpunit: *
• sami/sami: *

MIT

• Joshua Estes
• Sergey Matrunchik

• bitcoin
• bitcoind

README

This project is a wrapper for a bitcoind daemon. This project is still being worked on and the interface may change a little until I get something more stable.

Installation

You can install this library by using composer. You can also view more info about this on packagist.

Add this to the requires in your composer.json file.

"matrunchyk/bitcoind-php": "1.0.*@dev"

Usage

To use the project you need to just create a new instance of the class.

<?php

use Matrunchyk\Bitcoind\Bitcoind;
use Matrunchyk\Bitcoind\Client;

$bitcoind = new Bitcoind(new Client('https://username:password@localhost:18332'));

You can view the BitcoindInterface file for a list of methods and descriptions of what they are and how to use them.

Tests

To run the tests you need to install the development packages using composer

php composer.phar install --dev

Once this is complete you can run phpunit

./bin/phpunit

API Documentation

The API Documentation can be generated by install composer development packages like so:

php composer.phar install --dev
./bin/sami.php update sami.php

Docs are output into the docs/ directory. You can use php's command line server or view them another way.

License (MIT)

Copyright (C) 2012-2013 Joshua Estes

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.