WitnessScriptFactory - Code Metrics - Inspection of "Segwit hc" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#244)

by thomas

created 2016-02-03 14:38 UTC

WitnessScriptFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	5
c	1
b	0
f	1
lcom	1
cbo	7
dl	0
loc	83
rs	10

5 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	parse()	15	1
A	multisig()	4	1
A	payToPubKey()	4	1
A	payToPubKeyHash()	4	1

<?php

namespace BitWasp\Bitcoin\Script\Factory;

use BitWasp\Bitcoin\Script\Opcodes;
use BitWasp\Bitcoin\Crypto\EcAdapter\Key\PublicKeyInterface;
use BitWasp\Bitcoin\Script\Parser\Operation;
use BitWasp\Bitcoin\Script\Script;
use BitWasp\Bitcoin\Script\ScriptInterface;
use BitWasp\Bitcoin\Script\WitnessProgram;

class WitnessScriptFactory
{
    /**
     * @var OutputScriptFactory
     */
    private $scriptPubKey;

    /**
     * @var Opcodes
     */
    private $opcodes;

    /**
     * WitnessScriptFactory constructor.
     * @param OutputScriptFactory $scriptPubKey
     * @param Opcodes $opcodes
     */
    public function __construct(OutputScriptFactory $scriptPubKey, Opcodes $opcodes)
    {
        $this->scriptPubKey = $scriptPubKey;
        $this->opcodes = $opcodes;
    }

    /**
     * Parse a ScriptInterface into a WitnessProgram
     *
     * @param ScriptInterface $script
     * @return WitnessProgram
     */
    public function parse(ScriptInterface $script)
    {
        $parser = $script->getScriptParser();
        $decoded = $parser->decode();

        /**
         * @var Operation $versionPush
         * @var Operation $witnessPush
         */
        list ($versionPush, $witnessPush) = $decoded;
        $version = $versionPush->getData()->getInt();
        $program = new Script($witnessPush->getData());

        return new WitnessProgram($version, $program, $this->opcodes);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create a multisig witness program
     *
     * @param int $version
     * @param int $m
     * @param array $keys
     * @param bool|true $sort
     * @return WitnessProgram
     */
    public function multisig($version, $m, array $keys, $sort = true)
    {
        return new WitnessProgram($version, $this->scriptPubKey->multisig($m, $keys, $sort), $this->opcodes);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create a pay-to-pubkey witness program
     *
     * @param int $version
     * @param PublicKeyInterface  $publicKey
     * @return WitnessProgram
     */
    public function payToPubKey($version, PublicKeyInterface $publicKey)
    {
        return new WitnessProgram($version, $this->scriptPubKey->payToPubKey($publicKey), $this->opcodes);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create a pay-to-pubkey-hash witness program
     *
     * @param int $version
     * @param PublicKeyInterface  $publicKey
     * @return WitnessProgram
     */
    public function payToPubKeyHash($version, PublicKeyInterface $publicKey)
    {
        return new WitnessProgram($version, $this->scriptPubKey->payToPubKeyHash($publicKey), $this->opcodes);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1			<?php
2
3			namespace BitWasp\Bitcoin\Script\Factory;
4
5			use BitWasp\Bitcoin\Script\Opcodes;
6			use BitWasp\Bitcoin\Crypto\EcAdapter\Key\PublicKeyInterface;
7			use BitWasp\Bitcoin\Script\Parser\Operation;
8			use BitWasp\Bitcoin\Script\Script;
9			use BitWasp\Bitcoin\Script\ScriptInterface;
10			use BitWasp\Bitcoin\Script\WitnessProgram;
11
12			class WitnessScriptFactory
13			{
14			/**
15			* @var OutputScriptFactory
16			*/
17			private $scriptPubKey;
18
19			/**
20			* @var Opcodes
21			*/
22			private $opcodes;
23
24			/**
25			* WitnessScriptFactory constructor.
26			* @param OutputScriptFactory $scriptPubKey
27			* @param Opcodes $opcodes
28			*/
29			public function __construct(OutputScriptFactory $scriptPubKey, Opcodes $opcodes)
30			{
31			$this->scriptPubKey = $scriptPubKey;
32			$this->opcodes = $opcodes;
33			}
34
35			/**
36			* Parse a ScriptInterface into a WitnessProgram
37			*
38			* @param ScriptInterface $script
39			* @return WitnessProgram
40			*/
41			public function parse(ScriptInterface $script)
42			{
43			$parser = $script->getScriptParser();
44			$decoded = $parser->decode();
45
46			/**
47			* @var Operation $versionPush
48			* @var Operation $witnessPush
49			*/
50			list ($versionPush, $witnessPush) = $decoded;
51			$version = $versionPush->getData()->getInt();
52			$program = new Script($witnessPush->getData());
53
54			return new WitnessProgram($version, $program, $this->opcodes);
			0 ignored issues – show Documentation introduced 2016-02-03 16:40 UTC by Report Bug Copy Issue Report `$program` is of type `object<BitWasp\Bitcoin\Script\Script>`, but the function expects a `object<BitWasp\Buffertools\BufferInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-02-03 16:40 UTC by Report Bug Copy Issue Report The call to `WitnessProgram::__construct()` has too many arguments starting with `$this->opcodes`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
55			}
56
57			/**
58			* Create a multisig witness program
59			*
60			* @param int $version
61			* @param int $m
62			* @param array $keys
63			* @param bool\|true $sort
64			* @return WitnessProgram
65			*/
66			public function multisig($version, $m, array $keys, $sort = true)
67			{
68			return new WitnessProgram($version, $this->scriptPubKey->multisig($m, $keys, $sort), $this->opcodes);
			0 ignored issues – show Documentation introduced 2016-02-03 18:00 UTC by Report Bug Copy Issue Report `$this->scriptPubKey->multisig($m, $keys, $sort)` is of type `object<BitWasp\Bitcoin\Script\Script>`, but the function expects a `object<BitWasp\Buffertools\BufferInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-02-03 18:00 UTC by Report Bug Copy Issue Report The call to `WitnessProgram::__construct()` has too many arguments starting with `$this->opcodes`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
69			}
70
71			/**
72			* Create a pay-to-pubkey witness program
73			*
74			* @param int $version
75			* @param PublicKeyInterface $publicKey
76			* @return WitnessProgram
77			*/
78			public function payToPubKey($version, PublicKeyInterface $publicKey)
79			{
80			return new WitnessProgram($version, $this->scriptPubKey->payToPubKey($publicKey), $this->opcodes);
			0 ignored issues – show Documentation introduced 2016-02-03 18:00 UTC by Report Bug Copy Issue Report `$this->scriptPubKey->payToPubKey($publicKey)` is of type `object<BitWasp\Bitcoin\Script\Script>`, but the function expects a `object<BitWasp\Buffertools\BufferInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-02-03 18:00 UTC by Report Bug Copy Issue Report The call to `WitnessProgram::__construct()` has too many arguments starting with `$this->opcodes`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
81			}
82
83			/**
84			* Create a pay-to-pubkey-hash witness program
85			*
86			* @param int $version
87			* @param PublicKeyInterface $publicKey
88			* @return WitnessProgram
89			*/
90			public function payToPubKeyHash($version, PublicKeyInterface $publicKey)
91			{
92			return new WitnessProgram($version, $this->scriptPubKey->payToPubKeyHash($publicKey), $this->opcodes);
			0 ignored issues – show Documentation introduced 2016-02-03 18:00 UTC by Report Bug Copy Issue Report `$this->scriptPubKey->payToPubKeyHash($publicKey)` is of type `object<BitWasp\Bitcoin\Script\Script>`, but the function expects a `object<BitWasp\Buffertools\BufferInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2016-02-03 18:00 UTC by Report Bug Copy Issue Report The call to `WitnessProgram::__construct()` has too many arguments starting with `$this->opcodes`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
93			}
94			}
95

Bit-Wasp / bitcoin-php

Pull Request — master (#244)

WitnessScriptFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like