Peer::version() - Code Metrics - Inspection of "Merge pull request #62 from afk11/add-git-attribut..." - Bit-Wasp/bitcoin-p2p-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 935dc9...7bcd8e )

by thomas

created 2016-03-30 02:04 UTC

Peer::version() A

↳ Parent: Peer

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	21
ccs	0
cts	11
cp	0
rs	9.3142
cc	1
eloc	18
nc	1
nop	8
crap	2

How to fix Many Parameters

<?php

namespace BitWasp\Bitcoin\Networking\Peer;

use BitWasp\Bitcoin\Block\BlockInterface;
use BitWasp\Bitcoin\Block\FilteredBlock;
use BitWasp\Bitcoin\Bloom\BloomFilter;
use BitWasp\Bitcoin\Chain\BlockLocator;
use BitWasp\Bitcoin\Networking\Message;
use BitWasp\Bitcoin\Networking\Messages\Version;
use BitWasp\Bitcoin\Networking\Messages\Ping;
use BitWasp\Bitcoin\Networking\NetworkMessage;
use BitWasp\Bitcoin\Networking\NetworkSerializable;
use BitWasp\Bitcoin\Networking\Structure\AlertDetail;
use BitWasp\Bitcoin\Networking\Structure\Inventory;
use BitWasp\Bitcoin\Networking\Structure\NetworkAddress;
use BitWasp\Bitcoin\Networking\Structure\NetworkAddressInterface;
use BitWasp\Bitcoin\Networking\Structure\NetworkAddressTimestamp;
use BitWasp\Bitcoin\Crypto\EcAdapter\Signature\SignatureInterface;
use BitWasp\Bitcoin\Transaction\TransactionInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;
use BitWasp\Buffertools\Parser;
use Evenement\EventEmitter;
use React\EventLoop\LoopInterface;
use React\Promise\Deferred;
use React\Stream\Stream;

class Peer extends EventEmitter
{
    /**
     * @var string
     */
    private $buffer = '';

    /**
     * @var LoopInterface
     */
    private $loop;

    /**
     * @var \BitWasp\Bitcoin\Networking\Messages\Factory
     */
    private $msgs;

    /**
     * @var Stream
     */
    private $stream;

    /**
     * @var Version
     */
    private $localVersion;

    /**
     * @var Version
     */
    private $remoteVersion;

    /**
     * @var NetworkAddressInterface
     */
    private $peerAddress;

    /**
     * @var ConnectionParams
     */
    private $connectionParams;

    /**
     * @var bool
     */
    private $exchangedVersion = false;

    /**
     * @param \BitWasp\Bitcoin\Networking\Messages\Factory $msgs
     * @param LoopInterface $loop
     */
    public function __construct(\BitWasp\Bitcoin\Networking\Messages\Factory $msgs, LoopInterface $loop)
    {
        $this->msgs = $msgs;
        $this->loop = $loop;
    }

    /**
     * @return Version
     */
    public function getLocalVersion()
    {
        return $this->localVersion;
    }

    /**
     * @return Version
     */
    public function getRemoteVersion()
    {
        return $this->remoteVersion;
    }

    /**
     * Reliably returns the remote peers NetAddr when known through
     * the connection process. Often better than the data contained
     * in a Version message.
     *
     * @return NetworkAddressInterface
     */
    public function getRemoteAddress()
    {
        return $this->peerAddress;
    }

    /**
     * @return ConnectionParams
     */
    public function getConnectionParams()
    {
        return $this->connectionParams;
    }

    /**
     * @param NetworkSerializable $msg
     */
    public function send(NetworkSerializable $msg)
    {
        $net = $msg->getNetworkMessage();
        $this->stream->write($net->getBinary());
        $this->emit('send', [$net]);
    }

    /**
     * Handler for incoming data. Buffers possibly fragmented packets since they arrive sequentially.
     * Before finishing the version exchange, this will only emit Version and VerAck messages.
     */
    private function onData()
    {
        $tmp = $this->buffer;
        $parser = new Parser(new Buffer($tmp));

        try {
            while ($message = $this->msgs->parse($parser)) {
                $tmp = $parser->getBuffer()->slice($parser->getPosition())->getBinary();
                $this->emit('msg', [$this, $message]);
            }
        } catch (\Exception $e) {
            $this->buffer = $tmp;
            // Do nothing - it was probably a fragmented message
        }
    }

    /**
     * @param Stream $stream
     * @return $this
     */
    public function setupStream(Stream $stream)
    {
        $this->stream = $stream;
        $this->stream->on('data', function ($data) {
            $this->buffer .= $data;
            $this->emit('data');
        });

        $this->stream->on('close', function () {
            $this->close();
        });

        $this->on('data', function () {
            $this->onData();
        });

        $this->on('msg', function (Peer $peer, NetworkMessage $msg) {
            $this->emit($msg->getCommand(), [$peer, $msg->getPayload()]);
        });

        return $this;
    }

    /**
     * @param Stream $connection
     * @param ConnectionParams $params
     * @return \React\Promise\Promise|\React\Promise\PromiseInterface
     */
    public function inboundHandshake(Stream $connection, ConnectionParams $params)

    {
        $this->connectionParams = $params;

        $deferred = new Deferred();
        $this->on(Message::VERSION, function (Peer $peer, Version $version) use ($params) {

            $this->peerAddress = $version->getSenderAddress();
            $this->remoteVersion = $version;
            $this->localVersion = $localVersion = $params->produceVersion($this->msgs, $version->getSenderAddress());
            $this->send($localVersion);
        });

        $this->on(Message::VERACK, function () use ($deferred) {
            if (false === $this->exchangedVersion) {
                $this->exchangedVersion = true;
                $this->verack();
                $this->emit('ready', [$this]);
                $deferred->resolve($this);
            }
        });


        return $deferred->promise();
    }

    /**
     * @param NetworkAddressInterface $remotePeer
     * @param ConnectionParams $params
     * @return \React\Promise\Promise|\React\Promise\PromiseInterface
     */
    public function outboundHandshake(NetworkAddressInterface $remotePeer, ConnectionParams $params)
    {
        $deferred = new Deferred();

        $this->on(Message::VERSION, function (Peer $peer, Version $version) {
            $this->remoteVersion = $version;
            $this->verack();
        });

        $this->on(Message::VERACK, function () use ($deferred) {
            if (false === $this->exchangedVersion) {
                $this->exchangedVersion = true;
                $this->emit('ready', [$this]);
                $deferred->resolve($this);
            }
        });

        $this->peerAddress = $remotePeer;
        $this->localVersion = $version = $params->produceVersion($this->msgs, $remotePeer);
        $this->connectionParams = $params;

        $this->send($version);

        return $deferred->promise();
    }

    /**
     *
     */
    public function intentionalClose()
    {
        $this->emit('intentionaldisconnect', [$this]);
        $this->close();
    }

    /**
     *
     */
    public function close()
    {
        $this->emit('close', [$this]);
        $this->stream->end();
        $this->removeAllListeners();
    }

    /**
     * @param int $protocolVersion
     * @param int $services
     * @param int $timestamp
     * @param NetworkAddressInterface $remoteAddr
     * @param NetworkAddressInterface $localAddr
     * @param string $userAgent
     * @param int $blockHeight
     * @param bool $relayToUs
     */
    public function version(
        $protocolVersion,
        $services,
        $timestamp,
        NetworkAddressInterface $remoteAddr,
        NetworkAddressInterface $localAddr,
        $userAgent,
        $blockHeight,
        $relayToUs
    ) {
        $this->send($this->msgs->version(
            $protocolVersion,
            $services,
            $timestamp,
            $remoteAddr,
            $localAddr,
            new Buffer($userAgent),
            $blockHeight,
            $relayToUs
        ));
    }

    /**
     *
     */
    public function verack()
    {
        $this->send($this->msgs->verack());
    }

    /**
     *
     */
    public function sendheaders()
    {
        $this->send($this->msgs->sendheaders());
    }

    /**
     * @param Inventory[] $vInv
     */
    public function inv(array $vInv)
    {
        $this->send($this->msgs->inv($vInv));
    }

    /**
     * @param Inventory[] $vInv
     */
    public function getdata(array $vInv)
    {
        $this->send($this->msgs->getdata($vInv));
    }

    /**
     * @param array $vInv
     */
    public function notfound(array $vInv)
    {
        $this->send($this->msgs->notfound($vInv));
    }

    /**
     * @param NetworkAddressTimestamp[] $vNetAddr
     */
    public function addr(array $vNetAddr)
    {
        $this->send($this->msgs->addr($vNetAddr));
    }

    /**
     *
     */
    public function getaddr()
    {
        $this->send($this->msgs->getaddr());
    }

    /**
     *
     */
    public function ping()
    {
        $this->send($this->msgs->ping());
    }

    /**
     * @param Ping $ping
     */
    public function pong(Ping $ping)
    {
        $this->send($this->msgs->pong($ping));
    }

    /**
     * @param TransactionInterface $tx
     */
    public function tx(TransactionInterface $tx)
    {
        $this->send($this->msgs->tx($tx));
    }

    /**
     * @param BlockLocator $locator
     */
    public function getblocks(BlockLocator $locator)
    {
        $this->send($this->msgs->getblocks(
            $this->localVersion->getVersion(),
            $locator
        ));
    }

    /**
     * @param BlockLocator $locator
     */
    public function getheaders(BlockLocator $locator)
    {
        $this->send($this->msgs->getheaders(
            $this->localVersion->getVersion(),
            $locator
        ));
    }

    /**
     * @param BlockInterface $block
     */
    public function block(BlockInterface $block)
    {
        $this->send($this->msgs->block($block));
    }

    /**
     * @param array $vHeaders
     */
    public function headers(array $vHeaders)
    {
        $this->send($this->msgs->headers($vHeaders));
    }

    /**
     * @param AlertDetail $detail
     * @param SignatureInterface $signature
     */
    public function alert(AlertDetail $detail, SignatureInterface $signature)
    {
        $this->send($this->msgs->alert($detail, $signature));
    }

    /**
     * @param int $feeRate
     */
    public function feefilter($feeRate)
    {
        $this->send($this->msgs->feefilter($feeRate));
    }

    /**
     * @param BufferInterface $data
     */
    public function filteradd(BufferInterface $data)
    {
        $this->send($this->msgs->filteradd($data));
    }

    /**
     * @param BloomFilter $filter
     */
    public function filterload(BloomFilter $filter)
    {
        $this->send($this->msgs->filterload($filter));
    }

    /**
     *
     */
    public function filterclear()
    {
        $this->send($this->msgs->filterclear());
    }

    /**
     * @param FilteredBlock $filtered
     */
    public function merkleblock(FilteredBlock $filtered)
    {
        $this->send($this->msgs->merkleblock($filtered));
    }

    /**
     *
     */
    public function mempool()
    {
        $this->send($this->msgs->mempool());
    }

    /**
     * Issue a Reject message, with a required $msg, $code, and $reason
     *
     * @param BufferInterface $msg
     * @param int $code
     * @param BufferInterface $reason
     * @param BufferInterface $data
     */
    public function reject(BufferInterface $msg, $code, BufferInterface $reason, BufferInterface $data = null)
    {
        $this->send($this->msgs->reject($msg, $code, $reason, $data));
    }
}


1		<?php
2
3		namespace BitWasp\Bitcoin\Networking\Peer;
4
5		use BitWasp\Bitcoin\Block\BlockInterface;
6		use BitWasp\Bitcoin\Block\FilteredBlock;
7		use BitWasp\Bitcoin\Bloom\BloomFilter;
8		use BitWasp\Bitcoin\Chain\BlockLocator;
9		use BitWasp\Bitcoin\Networking\Message;
10		use BitWasp\Bitcoin\Networking\Messages\Version;
11		use BitWasp\Bitcoin\Networking\Messages\Ping;
12		use BitWasp\Bitcoin\Networking\NetworkMessage;
13		use BitWasp\Bitcoin\Networking\NetworkSerializable;
14		use BitWasp\Bitcoin\Networking\Structure\AlertDetail;
15		use BitWasp\Bitcoin\Networking\Structure\Inventory;
16		use BitWasp\Bitcoin\Networking\Structure\NetworkAddress;
17		use BitWasp\Bitcoin\Networking\Structure\NetworkAddressInterface;
18		use BitWasp\Bitcoin\Networking\Structure\NetworkAddressTimestamp;
19		use BitWasp\Bitcoin\Crypto\EcAdapter\Signature\SignatureInterface;
20		use BitWasp\Bitcoin\Transaction\TransactionInterface;
21		use BitWasp\Buffertools\Buffer;
22		use BitWasp\Buffertools\BufferInterface;
23		use BitWasp\Buffertools\Parser;
24		use Evenement\EventEmitter;
25		use React\EventLoop\LoopInterface;
26		use React\Promise\Deferred;
27		use React\Stream\Stream;
28
29		class Peer extends EventEmitter
30		{
31		/**
32		* @var string
33		*/
34		private $buffer = '';
35
36		/**
37		* @var LoopInterface
38		*/
39		private $loop;
40
41		/**
42		* @var \BitWasp\Bitcoin\Networking\Messages\Factory
43		*/
44		private $msgs;
45
46		/**
47		* @var Stream
48		*/
49		private $stream;
50
51		/**
52		* @var Version
53		*/
54		private $localVersion;
55
56		/**
57		* @var Version
58		*/
59		private $remoteVersion;
60
61		/**
62		* @var NetworkAddressInterface
63		*/
64		private $peerAddress;
65
66		/**
67		* @var ConnectionParams
68		*/
69		private $connectionParams;
70
71		/**
72		* @var bool
73		*/
74		private $exchangedVersion = false;
75
76		/**
77		* @param \BitWasp\Bitcoin\Networking\Messages\Factory $msgs
78		* @param LoopInterface $loop
79		*/
80	12	public function __construct(\BitWasp\Bitcoin\Networking\Messages\Factory $msgs, LoopInterface $loop)
81		{
82	12	$this->msgs = $msgs;
83	12	$this->loop = $loop;
84	12	}
85
86		/**
87		* @return Version
88		*/
89	3	public function getLocalVersion()
90		{
91	3	return $this->localVersion;
92		}
93
94		/**
95		* @return Version
96		*/
97	3	public function getRemoteVersion()
98		{
99	3	return $this->remoteVersion;
100		}
101
102		/**
103		* Reliably returns the remote peers NetAddr when known through
104		* the connection process. Often better than the data contained
105		* in a Version message.
106		*
107		* @return NetworkAddressInterface
108		*/
109	3	public function getRemoteAddress()
110		{
111	3	return $this->peerAddress;
112		}
113
114		/**
115		* @return ConnectionParams
116		*/
117	3	public function getConnectionParams()
118		{
119	3	return $this->connectionParams;
120		}
121
122		/**
123		* @param NetworkSerializable $msg
124		*/
125	12	public function send(NetworkSerializable $msg)
126		{
127	12	$net = $msg->getNetworkMessage();
128	12	$this->stream->write($net->getBinary());
129	12	$this->emit('send', [$net]);
130	12	}
131
132		/**
133		* Handler for incoming data. Buffers possibly fragmented packets since they arrive sequentially.
134		* Before finishing the version exchange, this will only emit Version and VerAck messages.
135		*/
136	12	private function onData()
137		{
138	12	$tmp = $this->buffer;
139	12	$parser = new Parser(new Buffer($tmp));
140
141		try {
142	12	while ($message = $this->msgs->parse($parser)) {
143	12	$tmp = $parser->getBuffer()->slice($parser->getPosition())->getBinary();
144	12	$this->emit('msg', [$this, $message]);
145	12	}
146	12	} catch (\Exception $e) {
147	12	$this->buffer = $tmp;
148		// Do nothing - it was probably a fragmented message
149		}
150	12	}
151
152		/**
153		* @param Stream $stream
154		* @return $this
155		*/
156	12	public function setupStream(Stream $stream)
157		{
158	12	$this->stream = $stream;
159		$this->stream->on('data', function ($data) {
160	12	$this->buffer .= $data;
161	12	$this->emit('data');
162	12	});
163
164		$this->stream->on('close', function () {
165	9	$this->close();
166	12	});
167
168		$this->on('data', function () {
169	12	$this->onData();
170	12	});
171
172		$this->on('msg', function (Peer $peer, NetworkMessage $msg) {
173	12	$this->emit($msg->getCommand(), [$peer, $msg->getPayload()]);
174	12	});
175
176	12	return $this;
177		}
178
179		/**
180		* @param Stream $connection
181		* @param ConnectionParams $params
182		* @return \React\Promise\Promise\|\React\Promise\PromiseInterface
183		*/
184	9	public function inboundHandshake(Stream $connection, ConnectionParams $params)
		0 ignored issues – show Unused Code introduced 2016-03-29 23:40 UTC by Report Bug Copy Issue Report The parameter `$connection` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
185		{
186	9	$this->connectionParams = $params;
187
188	9	$deferred = new Deferred();
189		$this->on(Message::VERSION, function (Peer $peer, Version $version) use ($params) {
190
191	9	$this->peerAddress = $version->getSenderAddress();
192	9	$this->remoteVersion = $version;
193	9	$this->localVersion = $localVersion = $params->produceVersion($this->msgs, $version->getSenderAddress());
194	9	$this->send($localVersion);
195	9	});
196
197		$this->on(Message::VERACK, function () use ($deferred) {
198	9	if (false === $this->exchangedVersion) {
199	9	$this->exchangedVersion = true;
200	9	$this->verack();
201	9	$this->emit('ready', [$this]);
202	9	$deferred->resolve($this);
203	9	}
204	9	});
205
206
207	9	return $deferred->promise();
208		}
209
210		/**
211		* @param NetworkAddressInterface $remotePeer
212		* @param ConnectionParams $params
213		* @return \React\Promise\Promise\|\React\Promise\PromiseInterface
214		*/
215	12	public function outboundHandshake(NetworkAddressInterface $remotePeer, ConnectionParams $params)
216		{
217	12	$deferred = new Deferred();
218
219		$this->on(Message::VERSION, function (Peer $peer, Version $version) {
220	12	$this->remoteVersion = $version;
221	12	$this->verack();
222	12	});
223
224	12	$this->on(Message::VERACK, function () use ($deferred) {
225	9	if (false === $this->exchangedVersion) {
226	9	$this->exchangedVersion = true;
227	9	$this->emit('ready', [$this]);
228	9	$deferred->resolve($this);
229	9	}
230	12	});
231
232	12	$this->peerAddress = $remotePeer;
233	12	$this->localVersion = $version = $params->produceVersion($this->msgs, $remotePeer);
234	12	$this->connectionParams = $params;
235
236	12	$this->send($version);
237
238	12	return $deferred->promise();
239		}
240
241		/**
242		*
243		*/
244		public function intentionalClose()
245		{
246		$this->emit('intentionaldisconnect', [$this]);
247		$this->close();
248		}
249
250		/**
251		*
252		*/
253	9	public function close()
254		{
255	9	$this->emit('close', [$this]);
256	9	$this->stream->end();
257	9	$this->removeAllListeners();
258	9	}
259
260		/**
261		* @param int $protocolVersion
262		* @param int $services
263		* @param int $timestamp
264		* @param NetworkAddressInterface $remoteAddr
265		* @param NetworkAddressInterface $localAddr
266		* @param string $userAgent
267		* @param int $blockHeight
268		* @param bool $relayToUs
269		*/
270		public function version(
271		$protocolVersion,
272		$services,
273		$timestamp,
274		NetworkAddressInterface $remoteAddr,
275		NetworkAddressInterface $localAddr,
276		$userAgent,
277		$blockHeight,
278		$relayToUs
279		) {
280		$this->send($this->msgs->version(
281		$protocolVersion,
282		$services,
283		$timestamp,
284		$remoteAddr,
285		$localAddr,
286		new Buffer($userAgent),
287		$blockHeight,
288		$relayToUs
289		));
290		}
291
292		/**
293		*
294		*/
295	12	public function verack()
296		{
297	12	$this->send($this->msgs->verack());
298	12	}
299
300		/**
301		*
302		*/
303		public function sendheaders()
304		{
305		$this->send($this->msgs->sendheaders());
306		}
307
308		/**
309		* @param Inventory[] $vInv
310		*/
311		public function inv(array $vInv)
312		{
313		$this->send($this->msgs->inv($vInv));
314		}
315
316		/**
317		* @param Inventory[] $vInv
318		*/
319		public function getdata(array $vInv)
320		{
321		$this->send($this->msgs->getdata($vInv));
322		}
323
324		/**
325		* @param array $vInv
326		*/
327		public function notfound(array $vInv)
328		{
329		$this->send($this->msgs->notfound($vInv));
330		}
331
332		/**
333		* @param NetworkAddressTimestamp[] $vNetAddr
334		*/
335		public function addr(array $vNetAddr)
336		{
337		$this->send($this->msgs->addr($vNetAddr));
338		}
339
340		/**
341		*
342		*/
343		public function getaddr()
344		{
345		$this->send($this->msgs->getaddr());
346		}
347
348		/**
349		*
350		*/
351		public function ping()
352		{
353		$this->send($this->msgs->ping());
354		}
355
356		/**
357		* @param Ping $ping
358		*/
359		public function pong(Ping $ping)
360		{
361		$this->send($this->msgs->pong($ping));
362		}
363
364		/**
365		* @param TransactionInterface $tx
366		*/
367		public function tx(TransactionInterface $tx)
368		{
369		$this->send($this->msgs->tx($tx));
370		}
371
372		/**
373		* @param BlockLocator $locator
374		*/
375		public function getblocks(BlockLocator $locator)
376		{
377		$this->send($this->msgs->getblocks(
378		$this->localVersion->getVersion(),
379		$locator
380		));
381		}
382
383		/**
384		* @param BlockLocator $locator
385		*/
386		public function getheaders(BlockLocator $locator)
387		{
388		$this->send($this->msgs->getheaders(
389		$this->localVersion->getVersion(),
390		$locator
391		));
392		}
393
394		/**
395		* @param BlockInterface $block
396		*/
397		public function block(BlockInterface $block)
398		{
399		$this->send($this->msgs->block($block));
400		}
401
402		/**
403		* @param array $vHeaders
404		*/
405		public function headers(array $vHeaders)
406		{
407		$this->send($this->msgs->headers($vHeaders));
408		}
409
410		/**
411		* @param AlertDetail $detail
412		* @param SignatureInterface $signature
413		*/
414		public function alert(AlertDetail $detail, SignatureInterface $signature)
415		{
416		$this->send($this->msgs->alert($detail, $signature));
417		}
418
419		/**
420		* @param int $feeRate
421		*/
422		public function feefilter($feeRate)
423		{
424		$this->send($this->msgs->feefilter($feeRate));
425		}
426
427		/**
428		* @param BufferInterface $data
429		*/
430		public function filteradd(BufferInterface $data)
431		{
432		$this->send($this->msgs->filteradd($data));
433		}
434
435		/**
436		* @param BloomFilter $filter
437		*/
438		public function filterload(BloomFilter $filter)
439		{
440		$this->send($this->msgs->filterload($filter));
441		}
442
443		/**
444		*
445		*/
446		public function filterclear()
447		{
448		$this->send($this->msgs->filterclear());
449		}
450
451		/**
452		* @param FilteredBlock $filtered
453		*/
454		public function merkleblock(FilteredBlock $filtered)
455		{
456		$this->send($this->msgs->merkleblock($filtered));
457		}
458
459		/**
460		*
461		*/
462		public function mempool()
463		{
464		$this->send($this->msgs->mempool());
465		}
466
467		/**
468		* Issue a Reject message, with a required $msg, $code, and $reason
469		*
470		* @param BufferInterface $msg
471		* @param int $code
472		* @param BufferInterface $reason
473		* @param BufferInterface $data
474		*/
475		public function reject(BufferInterface $msg, $code, BufferInterface $reason, BufferInterface $data = null)
476		{
477		$this->send($this->msgs->reject($msg, $code, $reason, $data));
478		}
479		}
480

Bit-Wasp / bitcoin-p2p-php

Push — master ( 935dc9...7bcd8e )

Peer::version() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like