InputClassifier::__construct() - Code Metrics - Inspection of "Have Parser / Operation store pushdata size" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#192)

by thomas

created 2015-11-23 01:08 UTC

InputClassifier::__construct() A

↳ Parent: InputClassifier

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php

namespace BitWasp\Bitcoin\Script\Classifier;

use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PublicKey;
use BitWasp\Bitcoin\Script\Opcodes;
use BitWasp\Bitcoin\Script\Parser\Operation;
use BitWasp\Bitcoin\Script\Script;
use BitWasp\Bitcoin\Script\ScriptInterface;

class InputClassifier implements ScriptClassifierInterface
{

    /**
     * @var Operation[]
     */
    private $decoded;

    const MAXSIGLEN = 0x48;

    /**
     * @param ScriptInterface $script
     */
    public function __construct(ScriptInterface $script)
    {
        $this->decoded = $script->getScriptParser()->decode();
    }

    /**
     * @return bool
     */
    public function isPayToPublicKey()
    {
        return count($this->decoded) === 1
        && $this->decoded[0]->isPush()
        && $this->decoded[0]->getDataSize() <= self::MAXSIGLEN;
    }

    /**
     * @return bool
     */
    public function isPayToPublicKeyHash()
    {
        if (count($this->decoded) !== 2) {
            return false;
        }

        $signature = $this->decoded[0];
        $publicKey = $this->decoded[1];

        return $signature->isPush() && $signature->getDataSize() <= self::MAXSIGLEN
            && $publicKey->isPush() && PublicKey::isCompressedOrUncompressed($publicKey->getData());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @return bool
     */
    public function isPayToScriptHash()
    {
        if (count($this->decoded) < 1) {
            return false;
        }

        $final = end($this->decoded);
        if (!$final || !$final->isPush()) {
            return false;
        }

        $type = new OutputClassifier(new Script($final->getData()));
        return false === in_array($type->classify(), [
            self::UNKNOWN,
            self::PAYTOSCRIPTHASH
        ], true);
    }

    /**
     * @return bool
     */
    public function isMultisig()
    {
        if (count($this->decoded) < 3) {
            return false;
        }

        $final = end($this->decoded);
        if (!$final || !$final->isPush()) {
            return false;
        }

        $script = new Script($final->getData());
        $decoded = $script->getScriptParser()->decode();
        $count = count($decoded);

        $mOp = $decoded[0];
        $nOp = $decoded[$count - 2];
        if ($mOp->isPush() || $nOp->isPush()) {
            return false;
        }

        if ($mOp->getOp() < Opcodes::OP_0 || $nOp->getOp() > Opcodes::OP_16) {
            return false;
        }

        /** @var Operation[] $keys */
        $keys = array_slice($decoded, 1, -2);
        $keysValid = true;
        foreach ($keys as $key) {
            $keysValid &= $key->isPush() && PublicKey::isCompressedOrUncompressed($key->getData());
        }

        return $keysValid;
    }

    /**
     * @return string
     */
    public function classify()
    {
        if ($this->isPayToPublicKey()) {
            return self::PAYTOPUBKEY;
        } elseif ($this->isPayToPublicKeyHash()) {
            return self::PAYTOPUBKEYHASH;
        } elseif ($this->isMultisig()) {
            return self::MULTISIG;
        } elseif ($this->isPayToScriptHash()) {
            return self::PAYTOSCRIPTHASH;
        }

        return self::UNKNOWN;
    }
}


1		<?php
2
3		namespace BitWasp\Bitcoin\Script\Classifier;
4
5		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PublicKey;
6		use BitWasp\Bitcoin\Script\Opcodes;
7		use BitWasp\Bitcoin\Script\Parser\Operation;
8		use BitWasp\Bitcoin\Script\Script;
9		use BitWasp\Bitcoin\Script\ScriptInterface;
10
11		class InputClassifier implements ScriptClassifierInterface
12		{
13
14		/**
15		* @var Operation[]
16		*/
17		private $decoded;
18
19		const MAXSIGLEN = 0x48;
20
21		/**
22		* @param ScriptInterface $script
23		*/
24	48	public function __construct(ScriptInterface $script)
25		{
26	48	$this->decoded = $script->getScriptParser()->decode();
27	48	}
28
29		/**
30		* @return bool
31		*/
32	30	public function isPayToPublicKey()
33		{
34	30	return count($this->decoded) === 1
35	30	&& $this->decoded[0]->isPush()
36	30	&& $this->decoded[0]->getDataSize() <= self::MAXSIGLEN;
37		}
38
39		/**
40		* @return bool
41		*/
42	24	public function isPayToPublicKeyHash()
43		{
44	24	if (count($this->decoded) !== 2) {
45	12	return false;
46		}
47
48	12	$signature = $this->decoded[0];
49	12	$publicKey = $this->decoded[1];
50
51	12	return $signature->isPush() && $signature->getDataSize() <= self::MAXSIGLEN
52	12	&& $publicKey->isPush() && PublicKey::isCompressedOrUncompressed($publicKey->getData());
		0 ignored issues – show Bug introduced 2015-11-23 01:27 UTC by Report Bug Copy Issue Report It seems like `$publicKey->getData()` can be `null`; however, `isCompressedOrUncompressed()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
53		}
54
55		/**
56		* @return bool
57		*/
58	18	public function isPayToScriptHash()
59		{
60	18	if (count($this->decoded) < 1) {
61	6	return false;
62		}
63
64	12	$final = end($this->decoded);
65	12	if (!$final \|\| !$final->isPush()) {
66	6	return false;
67		}
68
69	6	$type = new OutputClassifier(new Script($final->getData()));
70	6	return false === in_array($type->classify(), [
71	6	self::UNKNOWN,
72		self::PAYTOSCRIPTHASH
73	6	], true);
74		}
75
76		/**
77		* @return bool
78		*/
79	24	public function isMultisig()
80		{
81	24	if (count($this->decoded) < 3) {
82	12	return false;
83		}
84
85	12	$final = end($this->decoded);
86	12	if (!$final \|\| !$final->isPush()) {
87	6	return false;
88		}
89
90	6	$script = new Script($final->getData());
91	6	$decoded = $script->getScriptParser()->decode();
92	6	$count = count($decoded);
93
94	6	$mOp = $decoded[0];
95	6	$nOp = $decoded[$count - 2];
96	6	if ($mOp->isPush() \|\| $nOp->isPush()) {
97		return false;
98		}
99
100	6	if ($mOp->getOp() < Opcodes::OP_0 \|\| $nOp->getOp() > Opcodes::OP_16) {
101		return false;
102		}
103
104		/** @var Operation[] $keys */
105	6	$keys = array_slice($decoded, 1, -2);
106	6	$keysValid = true;
107	6	foreach ($keys as $key) {
108	6	$keysValid &= $key->isPush() && PublicKey::isCompressedOrUncompressed($key->getData());
109	6	}
110
111	6	return $keysValid;
112		}
113
114		/**
115		* @return string
116		*/
117	30	public function classify()
118		{
119	30	if ($this->isPayToPublicKey()) {
120	6	return self::PAYTOPUBKEY;
121	24	} elseif ($this->isPayToPublicKeyHash()) {
122	6	return self::PAYTOPUBKEYHASH;
123	18	} elseif ($this->isMultisig()) {
124	6	return self::MULTISIG;
125	12	} elseif ($this->isPayToScriptHash()) {
126	6	return self::PAYTOSCRIPTHASH;
127		}
128
129	6	return self::UNKNOWN;
130		}
131		}
132

Bit-Wasp / bitcoin-php

Pull Request — master (#192)

InputClassifier::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like