Licence: GPL-3.0 Author: Pascal Krason <p.krason@padr.io> Language: PHP 5.6 

Please note, this library is by far not completed and production ready, there are still a lot methods which aren't neither tested or even implemented.

First you need to setup a new Electrum wallet. Follow the instructions according to your OS at the Electrum Download Page. After the successfull installation you need to set a rpcport by typing:

electrum setconfig rpcport 7777 

Then we can create a default wallet, dont forget to note your generated seed, it's nescessary if you want to recover it one day:

electrum create 

Now we can go ahead and start Electrum in daemon mode:

electrum daemon start 

On the PHP side there are not much requirements, you only need atleast PHP 5.6 and the curl-Extension installed. Optional you need Composer to install this library.

First you need to install Composer, after you accomplished this you can go ahead:

composer require padrio/php-electrum-api 

Then you can simply include the autoloader and begin using the library:

// Include composer autoloader require_once 'vendor/autoloader.php';

A very basic useage example. Every API-Call has it's own request-object. You simply create one and execute it.

$method = new \Electrum\Request\Method\Version(); try { $response = $method->execute(); } catch(\Exception $exception) { die($exception->getMessage()); } $response->getVersion();

Every Request/Method takes a Electrum\Client-instance as parameter which replaces the default one. A custom instance can be usefull if you want to set custom config params like another Hostname or Port.

$client = new \Electrum\Client('http://127.0.0.1', 7777); $method = new \Electrum\Request\Method\Version($client); try { $response = $method->execute(); } catch (Exception $exception) { die($exception->getMessage()); } $response->getVersion();

Dealing with exceptions is easy. You can catch two types of exceptions which indicates whether it's an Request or Response fault.

$method = new \Electrum\Request\Method\Version(); try { $response = $method->execute(); } catch (\Electrum\Request\Exception\BadRequestException $exception) { die(sprintf( 'Failed to send request: %s', $exception->getMessage() )); } catch(\Electrum\Response\Exception\ElectrumResponseException $exception) { die(sprintf( 'Electrum-Client failed to respond correctly: %s', $exception->getMessage() )); }