Counterparty API - PHP example

balances.php

<?php

header("Access-Control-Allow-Origin: *");
header('Content-Type: application/json');

require 'Client.php';
use JsonRPC\Client;

$cp_server = 'http://api.counterparty.io:4000/';
$cp_user = 'rpc';
$cp_password = 'rpc';

$client = new Client($cp_server);
$client->authentication($cp_user, $cp_password);

$address = "1Kvddk8d9HywrXjpFUTxuPwgHgm2Cdc9h9";
$filters = array(array('field' => 'address', 'op' => '==', 'value' => $address));

$result = $client->execute('get_balances', array('filters' => $filters));

echo json_encode($result);

?>

Client.php

<?php
namespace JsonRPC;
use Exception;
use BadFunctionCallException;
use InvalidArgumentException;
use RuntimeException;
class ConnectionFailureException extends Exception {};
class ServerErrorException extends Exception {};
/**
 * JsonRPC client class
 *
 * @package JsonRPC
 * @author  Frederic Guillot
 */
class Client
{
    /**
     * URL of the server
     *
     * @access private
     * @var string
     */
    private $url;
    /**
     * If the only argument passed to a function is an array
     * assume it contains named arguments
     *
     * @access public
     * @var boolean
     */
    public $named_arguments = true;
    /**
     * HTTP client timeout
     *
     * @access private
     * @var integer
     */
    private $timeout;
    /**
     * Username for authentication
     *
     * @access private
     * @var string
     */
    private $username;
    /**
     * Password for authentication
     *
     * @access private
     * @var string
     */
    private $password;
    /**
     * Do not immediately throw an exception on error. Return it instead.
     *
     * @access public
     * @var boolean
     */
    private $suppress_errors = false;
    /**
     * True for a batch request
     *
     * @access public
     * @var boolean
     */
    public $is_batch = false;
    /**
     * Batch payload
     *
     * @access public
     * @var array
     */
    public $batch = array();
    /**
     * Enable debug output to the php error log
     *
     * @access public
     * @var boolean
     */
    public $debug = false;
    /**
     * Default HTTP headers to send to the server
     *
     * @access private
     * @var array
     */
    private $headers = array(
        'User-Agent: JSON-RPC PHP Client <https://github.com/fguillot/JsonRPC>',
        'Content-Type: application/json',
        'Accept: application/json',
        'Connection: close',
    );
    /**
     * SSL certificates verification
     *
     * @access public
     * @var boolean
     */
    public $ssl_verify_peer = true;
    /**
     * Constructor
     *
     * @access public
     * @param  string    $url                 Server URL
     * @param  integer   $timeout             HTTP timeout
     * @param  array     $headers             Custom HTTP headers
     * @param  bool      $suppress_errors     Suppress exceptions
     */
    public function __construct($url, $timeout = 3, $headers = array(), $suppress_errors = false)
    {
        $this->url = $url;
        $this->timeout = $timeout;
        $this->headers = array_merge($this->headers, $headers);
        $this->suppress_errors = !!$suppress_errors;
    }
    /**
     * Automatic mapping of procedures
     *
     * @access public
     * @param  string   $method   Procedure name
     * @param  array    $params   Procedure arguments
     * @return mixed
     */
    public function __call($method, array $params)
    {
        // Allow to pass an array and use named arguments
        if ($this->named_arguments && count($params) === 1 && is_array($params[0])) {
            $params = $params[0];
        }
        return $this->execute($method, $params);
    }
    /**
     * Set authentication parameters
     *
     * @access public
     * @param  string   $username   Username
     * @param  string   $password   Password
     * @return Client
     */
    public function authentication($username, $password)
    {
        $this->username = $username;
        $this->password = $password;
        return $this;
    }
    /**
     * Start a batch request
     *
     * @access public
     * @return Client
     */
    public function batch()
    {
        $this->is_batch = true;
        $this->batch = array();
        return $this;
    }
    /**
     * Send a batch request
     *
     * @access public
     * @return array
     */
    public function send()
    {
        $this->is_batch = false;
        return $this->parseResponse(
            $this->doRequest($this->batch)
        );
    }
    /**
     * Execute a procedure
     *
     * @access public
     * @param  string   $procedure   Procedure name
     * @param  array    $params      Procedure arguments
     * @return mixed
     */
    public function execute($procedure, array $params = array())
    {
        if ($this->is_batch) {
            $this->batch[] = $this->prepareRequest($procedure, $params);
            return $this;
        }
        return $this->parseResponse(
            $this->doRequest($this->prepareRequest($procedure, $params))
        );
    }
    /**
     * Prepare the payload
     *
     * @access public
     * @param  string   $procedure   Procedure name
     * @param  array    $params      Procedure arguments
     * @return array
     */
    public function prepareRequest($procedure, array $params = array())
    {
        $payload = array(
            'jsonrpc' => '2.0',
            'method' => $procedure,
            'id' => mt_rand()
        );
        if (! empty($params)) {
            $payload['params'] = $params;
        }
        return $payload;
    }
    /**
     * Parse the response and return the procedure result
     *
     * @access public
     * @param  array     $payload
     * @return mixed
     */
    public function parseResponse(array $payload)
    {
        if ($this->isBatchResponse($payload)) {
            $results = array();
            foreach ($payload as $response) {
                $results[] = $this->getResult($response);
            }
            return $results;
        }
        return $this->getResult($payload);
    }
    /**
     * Throw an exception according the RPC error
     *
     * @access public
     * @param  array $error
     * @return Exception
     * @throws BadFunctionCallException
     * @throws InvalidArgumentException
     * @throws RuntimeException
     * @throws ResponseException
     */
    public function handleRpcErrors(array $error)
    {
        try {
            switch ($error['code']) {
                case -32700:
                    throw new RuntimeException('Parse error: '. $error['message']);
                case -32600:
                    throw new RuntimeException('Invalid Request: '. $error['message']);
                case -32601:
                    throw new BadFunctionCallException('Procedure not found: '. $error['message']);
                case -32602:
                    throw new InvalidArgumentException('Invalid arguments: '. $error['message']);
                default:
                    throw new ResponseException(
                        $error['message'],
                        $error['code'],
                        null,
                        isset($error['data']) ? $error['data'] : null
                    );
            }
        } catch (Exception $e) {
            if (true === $this->suppress_errors) {
                return $e;
            }
            throw $e;
        }
    }
    /**
     * Throw an exception according the HTTP response
     *
     * @access public
     * @param  array   $headers
     * @throws AccessDeniedException
     * @throws ServerErrorException
     */
    public function handleHttpErrors(array $headers)
    {
        $exceptions = array(
            '401' => 'JsonRPC\AccessDeniedException',
            '403' => 'JsonRPC\AccessDeniedException',
            '404' => 'JsonRPC\ConnectionFailureException',
            '500' => 'JsonRPC\ServerErrorException',
        );
        foreach ($headers as $header) {
            foreach ($exceptions as $code => $exception) {
                if (strpos($header, 'HTTP/1.0 '.$code) !== false || strpos($header, 'HTTP/1.1 '.$code) !== false) {
                    throw new $exception('Response: '.$header);
                }
            }
        }
    }
    /**
     * Do the HTTP request
     *
     * @access private
     * @param  array $payload
     * @return array
     * @throws ConnectionFailureException
     */
    private function doRequest(array $payload)
    {
        $stream = @fopen(trim($this->url), 'r', false, $this->getContext($payload));
        if (! is_resource($stream)) {
            throw new ConnectionFailureException('Unable to establish a connection');
        }
        $metadata = stream_get_meta_data($stream);
        $response = json_decode(stream_get_contents($stream), true);
        if ($this->debug) {
            error_log('==> Request: '.PHP_EOL.json_encode($payload, JSON_PRETTY_PRINT));
            error_log('==> Response: '.PHP_EOL.json_encode($response, JSON_PRETTY_PRINT));
        }
        $this->handleHttpErrors($metadata['wrapper_data']);
        return is_array($response) ? $response : array();
    }
    /**
     * Prepare stream context
     *
     * @access private
     * @param  array   $payload
     * @return resource
     */
    private function getContext(array $payload)
    {
        $headers = $this->headers;
        if (! empty($this->username) && ! empty($this->password)) {
            $headers[] = 'Authorization: Basic '.base64_encode($this->username.':'.$this->password);
        }
        return stream_context_create(array(
            'http' => array(
                'method' => 'POST',
                'protocol_version' => 1.1,
                'timeout' => $this->timeout,
                'max_redirects' => 2,
                'header' => implode("\r\n", $headers),
                'content' => json_encode($payload),
                'ignore_errors' => true,
            ),
            "ssl" => array(
                "verify_peer" => $this->ssl_verify_peer,
                "verify_peer_name" => $this->ssl_verify_peer,
            )
        ));
    }
    /**
     * Return true if we have a batch response
     *
     * @access public
     * @param  array    $payload
     * @return boolean
     */
    private function isBatchResponse(array $payload)
    {
        return array_keys($payload) === range(0, count($payload) - 1);
    }
    /**
     * Get a RPC call result
     *
     * @access private
     * @param  array    $payload
     * @return mixed
     */
    private function getResult(array $payload)
    {
        if (isset($payload['error']['code'])) {
            return $this->handleRpcErrors($payload['error']);
        }
        return isset($payload['result']) ? $payload['result'] : null;
    }
}

?>