Electrum::createRequest() - Code Metrics - Inspection of "Fixed typo in composer" - AraneaDev/laravel-electrum - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 32ec39...4f5ed5 )

by Aranea

created 2017-09-13 21:16 UTC

Electrum::createRequest() A

↳ Parent: Electrum

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	3

<?php

namespace AraneaDev\Electrum;

use Exception;
use GuzzleHttp\Client;

/**
 * Class Electrum.
 */
class Electrum
{
    /** @var Client */
    protected $client;

    /**
     * Electrum constructor.
     */
    public function __construct()
    {
        $host = config('electrum.host', 'http://127.0.0.1');
        $port = config('electrum.port', 7777);

        $this->client = new Client([
            'base_uri' => $host.':'.$port,
        ]);
    }

    /**
     * Get the Electrum version.
     *
     * @return string
     */
    public function getVersion()
    {
        return $this->sendRequest('version');

    }

    /**
     * Get the synchronized status.
     *
     * @return object
     */
    public function isSynchronized()
    {
        return $this->sendRequest('is_synchronized');
    }

    /**
     * Get the total balance.
     *
     * @return object
     */
    public function getBalance()
    {
        return $this->sendRequest('getbalance');
    }

    /**
     * Get balance for address.
     *
     * @param $address
     *
     * @return object
     */
    public function getAddressBalance($address)
    {
        return $this->sendRequest('getaddressbalance', ['address' => $address]);
    }

    /**
     * Get history for address.
     *
     * @param $address
     *
     * @return object
     */
    public function getAddressHistory($address)
    {
        return $this->sendRequest('getaddresshistory', ['address' => $address]);
    }

    /**
     * Get unspent for address.
     *
     * @param $address
     *
     * @return object
     */
    public function getAddressUnspent($address)
    {
        return $this->sendRequest('getaddressunspent', ['address' => $address]);
    }

    /**
     * Check whether address is in wallet.
     *
     * @param $address
     *
     * @return object
     */
    public function isAddressMine($address)
    {
        return $this->sendRequest('ismine', ['address' => $address]);
    }

    /**
     * Get history of wallet.
     *
     * @return object
     */
    public function getHistory()
    {
        return $this->sendRequest('history');
    }

    /**
     * Create a new payment request.
     *
     * @param float  $amount
     * @param string $memo
     * @param int    $expiration
     *
     * @return object
     */
    public function createRequest($amount = 0.00, $memo = '', $expiration = 3600)
    {
        return $this->sendRequest('addrequest', [
            'amount'     => $amount,
            'memo'       => $memo,
            'expiration' => $expiration,
        ]);
    }

    /**
     * Get all payment requests.
     *
     * @return object
     */
    public function getRequests()
    {
        return $this->sendRequest('listrequests');
    }

    /**
     * Get a payment request by address.
     *
     * @param $address
     *
     * @return object
     */
    public function getRequest($address)
    {
        return $this->sendRequest('getrequest', ['key' => $address]);
    }

    /**
     * Clear a payment request by address.
     *
     * @param $address
     *
     * @return object
     */
    public function clearRequest($address)
    {
        return $this->sendRequest('rmrequest', ['address' => $address]);
    }

    /**
     * Clear all payment requests.
     *
     * @return object
     */
    public function clearRequests()
    {
        return $this->sendRequest('clearrequests');
    }

    /**
     * Validate address.
     *
     * @param $address
     *
     * @return object
     */
    public function validateAddress($address)
    {
        return $this->sendRequest('validateaddress', ['address' => $address]);
    }

    /**
     * Get all addresses associated with the wallet.
     *
     * @return object
     */
    public function getAddresses()
    {
        return $this->sendRequest('listaddresses');
    }

    /**
     * Get an unused address.
     *
     * @return object
     */
    public function getUnusedAddress()
    {
        return $this->sendRequest('getunusedaddress');
    }

    /**
     * Get transaction details.
     *
     * @param $txid
     *
     * @return object
     */
    public function getTransaction($txid)
    {
        return $this->sendRequest('gettransaction', ['txid' => $txid]);
    }

    /**
     * Sign a address.
     *
     * @param $address
     *
     * @return object
     */
    public function signRequest($address)
    {
        return $this->sendRequest('signrequest', ['address' => $address]);
    }

    /**
     * Broadcast a transaction.
     *
     * @param $tx
     *
     * @return object
     */
    public function broadcast($tx)
    {
        return $this->sendRequest('broadcast', ['tx' => $tx]);
    }

    /**
     * Serialize JSON tx.
     *
     * @param $json
     *
     * @return object
     */
    public function serialize($json)
    {
        return $this->sendRequest('serialize', ['jsontx' => $json]);
    }

    /**
     * Deserialize JSON tx.
     *
     * @param $tx
     *
     * @return object
     */
    public function deserialize($tx)
    {
        return $this->sendRequest('deserialize', ['tx' => $tx]);
    }

    /**
     * Encrypt a message.
     *
     * @param $public_key
     * @param $message
     *
     * @return object
     */
    public function encrypt($public_key, $message)
    {
        return $this->sendRequest('encrypt', [
            'pubkey'    => $public_key,
            'message'   => $message,
        ]);
    }

    /**
     * Decrypt a message.
     *
     * @param $public_key
     * @param $encrypted
     *
     * @return object
     */
    public function decrypt($public_key, $encrypted)
    {
        return $this->sendRequest('decrypt', [
            'pubkey'    => $public_key,
            'encrypted' => $encrypted,
        ]);
    }

    /**
     * Check a seed.
     *
     * @param $seed
     *
     * @return object
     */
    public function checkSeed($seed)
    {
        return $this->sendRequest('check_seed', ['seed' => $seed]);
    }

    /**
     * Create seed.
     *
     * @return object
     */
    public function createSeed()
    {
        return $this->sendRequest('make_seed');
    }

    /**
     * Get seed.
     *
     * @return object
     */
    public function getSeed()
    {
        return $this->sendRequest('getseed');
    }

    /**
     * Freeze an address.
     *
     * @param $address
     *
     * @return object
     */
    public function freeze($address)
    {
        return $this->sendRequest('freeze', ['address' => $address]);
    }

    /**
     * Get Electrum config value.
     *
     * @param $key
     *
     * @return object
     */
    public function getConfig($key)
    {
        return $this->SendRequest('getconfig', ['key' => $key]);
    }

    /**
     * Set Electrum config value.
     *
     * @param $key
     * @param $value
     *
     * @return object
     */
    public function setConfig($key, $value)
    {
        return $this->sendRequest('setconfig', [
            'key'   => $key,
            'value' => $value,
        ]);
    }

    /**
     * Send a request to the Electrum JSON RPC API.
     *
     * @param $method
     * @param array $params
     *
     * @throws Exception
     *
     * @return object
     */
    public function sendRequest($method, $params = [])
    {
        $request = $this->client->request('POST', '/', [
if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) {
    throw new \InvalidArgumentException('This input is not allowed.');
}
            'json' => [
                'id'     => 'curltext',
                'method' => $method,
                'params' => $params,
            ],
        ]);

        $response = json_decode($request->getBody()->getContents());

        if (isset($response->error)) {
            throw new Exception($response->error->message);
        } else {
            return $response->result;
        }
    }
}


Push — master ( 32ec39...4f5ed5 )

Electrum::createRequest() A

Complexity

Size

Duplication

Importance

1 path for user data to reach this point

Used in code-execution context

General Strategies to prevent injection

1 path for user data to reach this point

Used in path-write context

General Strategies to prevent injection

1			<?php
2
3			namespace AraneaDev\Electrum;
4
5			use Exception;
6			use GuzzleHttp\Client;
7
8			/**
9			* Class Electrum.
10			*/
11			class Electrum
12			{
13			/** @var Client */
14			protected $client;
15
16			/**
17			* Electrum constructor.
18			*/
19			public function __construct()
20			{
21			$host = config('electrum.host', 'http://127.0.0.1');
22			$port = config('electrum.port', 7777);
23
24			$this->client = new Client([
25			'base_uri' => $host.':'.$port,
26			]);
27			}
28
29			/**
30			* Get the Electrum version.
31			*
32			* @return string
33			*/
34			public function getVersion()
35			{
36			return $this->sendRequest('version');
			0 ignored issues – show Bug Best Practice introduced 2017-09-13 19:16 UTC by Report Bug Copy Issue Report The expression `return $this->sendRequest('version')` returns the type `object` which is incompatible with the documented return type `string`. Loading history...
37			}
38
39			/**
40			* Get the synchronized status.
41			*
42			* @return object
43			*/
44			public function isSynchronized()
45			{
46			return $this->sendRequest('is_synchronized');
47			}
48
49			/**
50			* Get the total balance.
51			*
52			* @return object
53			*/
54			public function getBalance()
55			{
56			return $this->sendRequest('getbalance');
57			}
58
59			/**
60			* Get balance for address.
61			*
62			* @param $address
63			*
64			* @return object
65			*/
66			public function getAddressBalance($address)
67			{
68			return $this->sendRequest('getaddressbalance', ['address' => $address]);
69			}
70
71			/**
72			* Get history for address.
73			*
74			* @param $address
75			*
76			* @return object
77			*/
78			public function getAddressHistory($address)
79			{
80			return $this->sendRequest('getaddresshistory', ['address' => $address]);
81			}
82
83			/**
84			* Get unspent for address.
85			*
86			* @param $address
87			*
88			* @return object
89			*/
90			public function getAddressUnspent($address)
91			{
92			return $this->sendRequest('getaddressunspent', ['address' => $address]);
93			}
94
95			/**
96			* Check whether address is in wallet.
97			*
98			* @param $address
99			*
100			* @return object
101			*/
102			public function isAddressMine($address)
103			{
104			return $this->sendRequest('ismine', ['address' => $address]);
105			}
106
107			/**
108			* Get history of wallet.
109			*
110			* @return object
111			*/
112			public function getHistory()
113			{
114			return $this->sendRequest('history');
115			}
116
117			/**
118			* Create a new payment request.
119			*
120			* @param float $amount
121			* @param string $memo
122			* @param int $expiration
123			*
124			* @return object
125			*/
126			public function createRequest($amount = 0.00, $memo = '', $expiration = 3600)
127			{
128			return $this->sendRequest('addrequest', [
129			'amount' => $amount,
130			'memo' => $memo,
131			'expiration' => $expiration,
132			]);
133			}
134
135			/**
136			* Get all payment requests.
137			*
138			* @return object
139			*/
140			public function getRequests()
141			{
142			return $this->sendRequest('listrequests');
143			}
144
145			/**
146			* Get a payment request by address.
147			*
148			* @param $address
149			*
150			* @return object
151			*/
152			public function getRequest($address)
153			{
154			return $this->sendRequest('getrequest', ['key' => $address]);
155			}
156
157			/**
158			* Clear a payment request by address.
159			*
160			* @param $address
161			*
162			* @return object
163			*/
164			public function clearRequest($address)
165			{
166			return $this->sendRequest('rmrequest', ['address' => $address]);
167			}
168
169			/**
170			* Clear all payment requests.
171			*
172			* @return object
173			*/
174			public function clearRequests()
175			{
176			return $this->sendRequest('clearrequests');
177			}
178
179			/**
180			* Validate address.
181			*
182			* @param $address
183			*
184			* @return object
185			*/
186			public function validateAddress($address)
187			{
188			return $this->sendRequest('validateaddress', ['address' => $address]);
189			}
190
191			/**
192			* Get all addresses associated with the wallet.
193			*
194			* @return object
195			*/
196			public function getAddresses()
197			{
198			return $this->sendRequest('listaddresses');
199			}
200
201			/**
202			* Get an unused address.
203			*
204			* @return object
205			*/
206			public function getUnusedAddress()
207			{
208			return $this->sendRequest('getunusedaddress');
209			}
210
211			/**
212			* Get transaction details.
213			*
214			* @param $txid
215			*
216			* @return object
217			*/
218			public function getTransaction($txid)
219			{
220			return $this->sendRequest('gettransaction', ['txid' => $txid]);
221			}
222
223			/**
224			* Sign a address.
225			*
226			* @param $address
227			*
228			* @return object
229			*/
230			public function signRequest($address)
231			{
232			return $this->sendRequest('signrequest', ['address' => $address]);
233			}
234
235			/**
236			* Broadcast a transaction.
237			*
238			* @param $tx
239			*
240			* @return object
241			*/
242			public function broadcast($tx)
243			{
244			return $this->sendRequest('broadcast', ['tx' => $tx]);
245			}
246
247			/**
248			* Serialize JSON tx.
249			*
250			* @param $json
251			*
252			* @return object
253			*/
254			public function serialize($json)
255			{
256			return $this->sendRequest('serialize', ['jsontx' => $json]);
257			}
258
259			/**
260			* Deserialize JSON tx.
261			*
262			* @param $tx
263			*
264			* @return object
265			*/
266			public function deserialize($tx)
267			{
268			return $this->sendRequest('deserialize', ['tx' => $tx]);
269			}
270
271			/**
272			* Encrypt a message.
273			*
274			* @param $public_key
275			* @param $message
276			*
277			* @return object
278			*/
279			public function encrypt($public_key, $message)
280			{
281			return $this->sendRequest('encrypt', [
282			'pubkey' => $public_key,
283			'message' => $message,
284			]);
285			}
286
287			/**
288			* Decrypt a message.
289			*
290			* @param $public_key
291			* @param $encrypted
292			*
293			* @return object
294			*/
295			public function decrypt($public_key, $encrypted)
296			{
297			return $this->sendRequest('decrypt', [
298			'pubkey' => $public_key,
299			'encrypted' => $encrypted,
300			]);
301			}
302
303			/**
304			* Check a seed.
305			*
306			* @param $seed
307			*
308			* @return object
309			*/
310			public function checkSeed($seed)
311			{
312			return $this->sendRequest('check_seed', ['seed' => $seed]);
313			}
314
315			/**
316			* Create seed.
317			*
318			* @return object
319			*/
320			public function createSeed()
321			{
322			return $this->sendRequest('make_seed');
323			}
324
325			/**
326			* Get seed.
327			*
328			* @return object
329			*/
330			public function getSeed()
331			{
332			return $this->sendRequest('getseed');
333			}
334
335			/**
336			* Freeze an address.
337			*
338			* @param $address
339			*
340			* @return object
341			*/
342			public function freeze($address)
343			{
344			return $this->sendRequest('freeze', ['address' => $address]);
345			}
346
347			/**
348			* Get Electrum config value.
349			*
350			* @param $key
351			*
352			* @return object
353			*/
354			public function getConfig($key)
355			{
356			return $this->SendRequest('getconfig', ['key' => $key]);
357			}
358
359			/**
360			* Set Electrum config value.
361			*
362			* @param $key
363			* @param $value
364			*
365			* @return object
366			*/
367			public function setConfig($key, $value)
368			{
369			return $this->sendRequest('setconfig', [
370			'key' => $key,
371			'value' => $value,
372			]);
373			}
374
375			/**
376			* Send a request to the Electrum JSON RPC API.
377			*
378			* @param $method
379			* @param array $params
380			*
381			* @throws Exception
382			*
383			* @return object
384			*/
385			public function sendRequest($method, $params = [])
386			{
387			$request = $this->client->request('POST', '/', [
			0 ignored issues – show Security introduced 2017-09-13 19:16 UTC by Report Bug Copy Issue Report `array('json' => array('i..., 'params' => $params))` can contain request data and is used in code execution context(s) leading to a potential security vulnerability. 1 path for user data to reach this point ParameterBag::get() returns request data in vendor/symfony/http-foundation/ParameterBag.php on line 86 `$this->attributes->get($key, $this)` is assigned to `$result` in vendor/symfony/http-foundation/Request.php on line 808 Electrum::createRequest() is called in src/app/Http/Controllers/Api/RequestsController.php on line 66 Enters via parameter `$amount` in src/Electrum.php on line 126 Electrum::sendRequest() is called in src/Electrum.php on line 128 Enters via parameter `$params` in src/Electrum.php on line 385 Used in code-execution context Client::request() is called in src/Electrum.php on line 387 Enters via parameter `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 128 Client::requestAsync() is called in vendor/guzzlehttp/guzzle/src/Client.php on line 131 Enters via parameter `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 109 Data is passed through `prepareDefaults()` in vendor/guzzlehttp/guzzle/src/Client.php on line 111 `$this->prepareDefaults($options)` is assigned to `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 111 Client::transfer() is called in vendor/guzzlehttp/guzzle/src/Client.php on line 125 Enters via parameter `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 259 `$options['handler']` is assigned to `$handler` in vendor/guzzlehttp/guzzle/src/Client.php on line 274 `$handler()` is called dynamically in vendor/guzzlehttp/guzzle/src/Client.php on line 277 General Strategies to prevent injection In general, it is advisable to prevent any user-data to reach this point. This can be done by white-listing certain values: if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) { throw new \InvalidArgumentException('This input is not allowed.'); } For numeric data, we recommend to explicitly cast the data: $sanitized = (integer) $tainted; Loading history... Security introduced 2017-09-13 19:16 UTC by Report Bug Copy Issue Report `array('json' => array('i..., 'params' => $params))` can contain request data and is used in file manipulation context(s) leading to a potential security vulnerability. 1 path for user data to reach this point ParameterBag::get() returns request data in vendor/symfony/http-foundation/ParameterBag.php on line 86 `$this->attributes->get($key, $this)` is assigned to `$result` in vendor/symfony/http-foundation/Request.php on line 808 Electrum::createRequest() is called in src/app/Http/Controllers/Api/RequestsController.php on line 66 Enters via parameter `$amount` in src/Electrum.php on line 126 Electrum::sendRequest() is called in src/Electrum.php on line 128 Enters via parameter `$params` in src/Electrum.php on line 385 Used in path-write context Client::request() is called in src/Electrum.php on line 387 Enters via parameter `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 128 Client::requestAsync() is called in vendor/guzzlehttp/guzzle/src/Client.php on line 131 Enters via parameter `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 109 Data is passed through `prepareDefaults()` in vendor/guzzlehttp/guzzle/src/Client.php on line 111 `$this->prepareDefaults($options)` is assigned to `$options` in vendor/guzzlehttp/guzzle/src/Client.php on line 111 `IssetNode ? $options['body'] : null` is assigned to `$body` in vendor/guzzlehttp/guzzle/src/Client.php on line 114 Request::__construct() is called in vendor/guzzlehttp/guzzle/src/Client.php on line 121 Enters via parameter `$body` in vendor/guzzlehttp/psr7/src/Request.php on line 36 `stream_for()` is called in vendor/guzzlehttp/psr7/src/Request.php on line 53 Enters via parameter `$resource` in vendor/guzzlehttp/psr7/src/functions.php on line 78 `fwrite()` is called in vendor/guzzlehttp/psr7/src/functions.php on line 83 General Strategies to prevent injection In general, it is advisable to prevent any user-data to reach this point. This can be done by white-listing certain values: if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) { throw new \InvalidArgumentException('This input is not allowed.'); } For numeric data, we recommend to explicitly cast the data: $sanitized = (integer) $tainted; Loading history...
388			'json' => [
389			'id' => 'curltext',
390			'method' => $method,
391			'params' => $params,
392			],
393			]);
394
395			$response = json_decode($request->getBody()->getContents());
396
397			if (isset($response->error)) {
398			throw new Exception($response->error->message);
399			} else {
400			return $response->result;
401			}
402			}
403			}
404

AraneaDev / laravel-electrum

Push — master ( 32ec39...4f5ed5 )

Electrum::createRequest() A

Complexity

Size

Duplication

Importance

1 path for user data to reach this point

Used in code-execution context

General Strategies to prevent injection

1 path for user data to reach this point

Used in path-write context

General Strategies to prevent injection

Duplication Side-by-Side

Filter issues like