monerowp/include/class-monero-wallet-rpc.php

353 lines
12 KiB
PHP
Raw Normal View History

2017-06-29 16:43:39 +02:00
<?php
/**
2018-09-22 16:57:35 +02:00
* monero_wallet_rpc
*
* Written using the JSON RPC specification -
* http://json-rpc.org/wiki/specification
*
* @author Kacper Rowinski <krowinski@implix.com>
* http://implix.com
* Modified to work with monero-rpc wallet by Serhack and cryptochangements
2018-09-22 16:57:35 +02:00
* Modified to work with monero-wallet-rpc wallet by mosu-forge
2017-06-29 16:43:39 +02:00
*/
2018-09-22 16:57:35 +02:00
defined( 'ABSPATH' ) || exit;
class Monero_Wallet_Rpc
{
2018-09-22 16:57:35 +02:00
protected $url = null, $is_debug = false;
protected $curl_options = array(
CURLOPT_CONNECTTIMEOUT => 8,
CURLOPT_TIMEOUT => 8
);
protected $host;
protected $port;
private $httpErrors = array(
400 => '400 Bad Request',
401 => '401 Unauthorized',
403 => '403 Forbidden',
404 => '404 Not Found',
405 => '405 Method Not Allowed',
406 => '406 Not Acceptable',
408 => '408 Request Timeout',
500 => '500 Internal Server Error',
502 => '502 Bad Gateway',
503 => '503 Service Unavailable'
);
public function __construct($pHost, $pPort)
{
2017-09-06 13:49:27 +02:00
$this->validate(false === extension_loaded('curl'), 'The curl extension must be loaded to use this class!');
$this->validate(false === extension_loaded('json'), 'The json extension must be loaded to use this class!');
2018-09-22 16:57:35 +02:00
$this->host = $pHost;
$this->port = $pPort;
$this->url = $pHost . ':' . $pPort . '/json_rpc';
2017-06-29 16:43:39 +02:00
}
public function validate($pFailed, $pErrMsg)
{
if ($pFailed) {
2018-09-22 16:57:35 +02:00
if(is_admin()) echo $pErrMsg;
}
2017-06-29 16:43:39 +02:00
}
public function setDebug($pIsDebug)
{
$this->is_debug = !empty($pIsDebug);
return $this;
}
public function setCurlOptions($pOptionsArray)
{
if (is_array($pOptionsArray)) {
$this->curl_options = $pOptionsArray + $this->curl_options;
} else {
2018-09-22 16:57:35 +02:00
if(is_admin()) echo 'Invalid options type.';
}
return $this;
2017-06-29 16:43:39 +02:00
}
public function _print($json)
{
$json_encoded = json_encode($json, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
2018-09-22 16:57:35 +02:00
if(is_admin()) echo $json_encoded;
}
public function _run($method, $params = null)
{
$result = $this->request($method, $params);
return $result; //the result is returned as an array
}
private function request($pMethod, $pParams)
{
static $requestId = 0;
2018-09-22 16:57:35 +02:00
// generating uniuqe id per process
$requestId++;
2018-09-22 16:57:35 +02:00
// check if given params are correct
$this->validate(false === is_scalar($pMethod), 'Method name has no scalar value');
2018-09-22 16:57:35 +02:00
// Request (method invocation)
$request = json_encode(array('jsonrpc' => '2.0', 'method' => $pMethod, 'params' => $pParams, 'id' => $requestId));
2018-09-22 16:57:35 +02:00
// if is_debug mode is true then add url and request to is_debug
$this->debug('Url: ' . $this->url . "\r\n", false);
$this->debug('Request: ' . $request . "\r\n", false);
2018-09-22 16:57:35 +02:00
// Response (method invocation)
$responseMessage = $this->getResponse($request);
2018-09-22 16:57:35 +02:00
// if is_debug mode is true then add response to is_debug and display it
$this->debug('Response: ' . $responseMessage . "\r\n", true);
2018-09-22 16:57:35 +02:00
// decode and create array ( can be object, just set to false )
$responseDecoded = json_decode($responseMessage, true);
2018-09-22 16:57:35 +02:00
// check if decoding json generated any errors
$jsonErrorMsg = $this->getJsonLastErrorMsg();
$this->validate(!is_null($jsonErrorMsg), $jsonErrorMsg . ': ' . $responseMessage);
// check if response is correct
$this->validate(empty($responseDecoded['id']), 'Invalid response data structure: ' . $responseMessage);
$this->validate($responseDecoded['id'] != $requestId, 'Request id: ' . $requestId . ' is different from Response id: ' . $responseDecoded['id']);
if (isset($responseDecoded['error'])) {
$errorMessage = 'Request have return error: ' . $responseDecoded['error']['message'] . '; ' . "\n" .
'Request: ' . $request . '; ';
if (isset($responseDecoded['error']['data'])) {
$errorMessage .= "\n" . 'Error data: ' . $responseDecoded['error']['data'];
}
$this->validate(!is_null($responseDecoded['error']), $errorMessage);
}
return $responseDecoded['result'];
2017-06-29 16:43:39 +02:00
}
protected function debug($pAdd, $pShow = false)
{
static $debug, $startTime;
// is_debug off return
if (false === $this->is_debug) {
return;
}
// add
$debug .= $pAdd;
// get starttime
$startTime = empty($startTime) ? array_sum(explode(' ', microtime())) : $startTime;
if (true === $pShow and !empty($debug)) {
// get endtime
$endTime = array_sum(explode(' ', microtime()));
// performance summary
$debug .= 'Request time: ' . round($endTime - $startTime, 3) . ' s Memory usage: ' . round(memory_get_usage() / 1024) . " kb\r\n";
2018-09-22 16:57:35 +02:00
if(is_admin()) echo nl2br($debug);
// send output immediately
flush();
// clean static
$debug = $startTime = null;
}
}
protected function & getResponse(&$pRequest)
{
// do the actual connection
$ch = curl_init();
if (!$ch) {
throw new RuntimeException('Could\'t initialize a cURL session');
}
curl_setopt($ch, CURLOPT_URL, $this->url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $pRequest);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-type: application/json'));
curl_setopt($ch, CURLOPT_ENCODING, 'gzip,deflate');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
if (!curl_setopt_array($ch, $this->curl_options)) {
throw new RuntimeException('Error while setting curl options');
2017-06-29 16:43:39 +02:00
}
// send the request
$response = curl_exec($ch);
2018-09-22 16:57:35 +02:00
// check http status code
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if (isset($this->httpErrors[$httpCode])) {
2018-09-22 16:57:35 +02:00
if(is_admin())
echo 'Response Http Error - ' . $this->httpErrors[$httpCode];
2017-06-29 16:43:39 +02:00
}
2018-09-22 16:57:35 +02:00
// check for curl error
if (0 < curl_errno($ch)) {
2018-09-22 16:57:35 +02:00
if(is_admin())
echo '[ERROR] Failed to connect to monero-wallet-rpc at ' . $this->host . ' port '. $this->port .'</br>';
}
// close the connection
curl_close($ch);
return $response;
2017-06-29 16:43:39 +02:00
}
//prints result as json
function getJsonLastErrorMsg()
{
if (!function_exists('json_last_error_msg')) {
function json_last_error_msg()
{
static $errors = array(
JSON_ERROR_NONE => 'No error',
JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
JSON_ERROR_STATE_MISMATCH => 'Underflow or the modes mismatch',
JSON_ERROR_CTRL_CHAR => 'Unexpected control character found',
JSON_ERROR_SYNTAX => 'Syntax error',
JSON_ERROR_UTF8 => 'Malformed UTF-8 characters, possibly incorrectly encoded'
);
$error = json_last_error();
return array_key_exists($error, $errors) ? $errors[$error] : 'Unknown error (' . $error . ')';
}
}
// Fix PHP 5.2 error caused by missing json_last_error function
if (function_exists('json_last_error')) {
return json_last_error() ? json_last_error_msg() : null;
} else {
return null;
}
2017-06-29 16:43:39 +02:00
}
2018-09-22 16:57:35 +02:00
/*
2018-05-20 21:17:38 +02:00
* The following functions can all be called to interact with the Monero RPC wallet
* They will majority of them will return the result as an array
* Example: $daemon->address(); where $daemon is an instance of this class, will return the wallet address as string within an array
*/
2018-09-22 16:57:35 +02:00
public function address()
{
$address = $this->_run('getaddress');
return $address;
}
public function getbalance()
{
$balance = $this->_run('getbalance');
return $balance;
}
public function getheight()
{
$height = $this->_run('getheight');
2018-09-22 16:57:35 +02:00
return $height['height'];
}
public function incoming_transfer($type)
{
$incoming_parameters = array('transfer_type' => $type);
$incoming_transfers = $this->_run('incoming_transfers', $incoming_parameters);
return $incoming_transfers;
}
public function get_transfers($input_type, $input_value)
{
$get_parameters = array($input_type => $input_value);
$get_transfers = $this->_run('get_transfers', $get_parameters);
return $get_transfers;
}
public function view_key()
{
$query_key = array('key_type' => 'view_key');
$query_key_method = $this->_run('query_key', $query_key);
return $query_key_method;
}
public function make_integrated_address($payment_id)
{
$integrate_address_parameters = array('payment_id' => $payment_id);
$integrate_address_method = $this->_run('make_integrated_address', $integrate_address_parameters);
return $integrate_address_method;
}
/* A payment id can be passed as a string
2018-05-20 21:17:38 +02:00
A random payment id will be generated if one is not given */
public function split_integrated_address($integrated_address)
{
if (!isset($integrated_address)) {
2018-09-22 16:57:35 +02:00
if(is_admin()) echo "Error: Integrated_Address must not be null";
} else {
$split_params = array('integrated_address' => $integrated_address);
$split_methods = $this->_run('split_integrated_address', $split_params);
return $split_methods;
}
}
public function make_uri($address, $amount, $recipient_name = null, $description = null)
{
2018-09-22 16:57:35 +02:00
// Convert to atomic units
$new_amount = $amount * MONERO_GATEWAY_ATOMIC_UNITS_POW;
$uri_params = array('address' => $address, 'amount' => $new_amount, 'payment_id' => '', 'recipient_name' => $recipient_name, 'tx_description' => $description);
$uri = $this->_run('make_uri', $uri_params);
return $uri;
}
public function parse_uri($uri)
{
$uri_parameters = array('uri' => $uri);
$parsed_uri = $this->_run('parse_uri', $uri_parameters);
return $parsed_uri;
}
2018-09-22 16:57:35 +02:00
public function transfer($amount, $address, $mixin = 12)
{
2018-09-22 16:57:35 +02:00
$new_amount = $amount * MONERO_GATEWAY_ATOMIC_UNITS_POW;
$destinations = array('amount' => $new_amount, 'address' => $address);
$transfer_parameters = array('destinations' => array($destinations), 'mixin' => $mixin, 'get_tx_key' => true, 'unlock_time' => 0, 'payment_id' => '');
$transfer_method = $this->_run('transfer', $transfer_parameters);
return $transfer_method;
}
public function get_payments($payment_id)
{
$get_payments_parameters = array('payment_id' => $payment_id);
$get_payments = $this->_run('get_payments', $get_payments_parameters);
2018-09-22 16:57:35 +02:00
if(isset($get_payments['payments']))
return $get_payments['payments'];
else
return array();
}
2018-09-22 16:57:35 +02:00
public function get_pool_payments($payment_id)
{
2018-09-22 16:57:35 +02:00
$get_payments_parameters = array('pool' => true);
$get_payments = $this->_run('get_transfers', $get_payments_parameters);
if(!isset($get_payments['pool']))
return array();
$payments = array();
foreach($get_payments['pool'] as $payment) {
if($payment['double_spend_seen'])continue;
if($payment['payment_id'] == $payment_id) {
$payment['tx_hash'] = $payment['txid'];
$payment['block_height'] = $payment['height'];
$payments[] = $payment;
}
2018-06-09 06:16:53 +02:00
}
2018-09-22 16:57:35 +02:00
return $payments;
2018-06-08 21:39:50 +02:00
}
2018-09-22 16:57:35 +02:00
public function get_all_payments($payment_id)
2018-01-23 23:36:08 +01:00
{
2018-09-22 16:57:35 +02:00
$confirmed_payments = $this->get_payments($payment_id);
$pool_payments = $this->get_pool_payments($payment_id);
return array_merge($pool_payments, $confirmed_payments);
2018-01-23 23:36:08 +01:00
}
2018-09-22 16:57:35 +02:00
public function get_bulk_payments($payment_id, $min_block_height)
2018-01-24 23:35:49 +01:00
{
2018-09-22 16:57:35 +02:00
$get_bulk_payments_parameters = array('payment_id' => $payment_id, 'min_block_height' => $min_block_height);
$get_bulk_payments = $this->_run('get_bulk_payments', $get_bulk_payments_parameters);
return $get_bulk_payments;
2018-01-24 23:35:49 +01:00
}
2018-01-23 23:36:08 +01:00
}