OutputClassifier - Code Metrics - Inspection of "WIP: PHP7+" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#591)

by thomas

created 2017-12-28 20:15 UTC

OutputClassifier D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	507
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

83.51%

Importance

Changes

Metric	Value
dl	0
loc	507
ccs	157
cts	188
cp	0.8351
rs	4.8717
c	0
b	0
f	0
wmc	96
lcom	1
cbo	8

20 Methods

Rating	Name	Size	Complexity
B	decodeP2PK()	16	6
A	isPayToPublicKey()	10	2
D	decodeP2PKH()	29	10
A	isPayToPublicKeyHash()	10	2
C	decodeP2SH()	23	8
A	isPayToScriptHash()	10	2
C	decodeMultisig()	32	11
A	isMultisig()	10	2
C	decodeWitnessNoLimit()	22	9
B	decodeP2WKH2()	11	5
B	decodeP2WSH2()	11	5
A	isWitness()	10	2
A	decodeNullData()	12	4
A	isNullData()	9	2
B	decodeWitnessCoinbaseCommitment()	19	7
A	isWitnessCoinbaseCommitment()	9	2
D	classifyDecoded()	32	9
A	classify()	8	1
A	decode()	6	1
B	decodeSequence()	37	6

How to fix Complexity

<?php

declare(strict_types=1);

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\ScriptFactory;
use BitWasp\Bitcoin\Script\ScriptInterface;
use BitWasp\Bitcoin\Script\ScriptType;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;

class OutputClassifier
{
    /**
     * @deprecated
     */
    const PAYTOPUBKEY = 'pubkey';

    /**
     * @deprecated
     */
    const PAYTOPUBKEYHASH = 'pubkeyhash';

    /**
     * @deprecated
     */
    const PAYTOSCRIPTHASH = 'scripthash';

    /**
     * @deprecated
     */
    const WITNESS_V0_KEYHASH = 'witness_v0_keyhash';

    /**
     * @deprecated
     */
    const WITNESS_V0_SCRIPTHASH = 'witness_v0_scripthash';

    /**
     * @deprecated
     */
    const MULTISIG = 'multisig';

    /**
     * @deprecated
     */
    const NULLDATA = 'nulldata';

    /**
     * @deprecated
     */
    const UNKNOWN = 'nonstandard';

    /**
     * @deprecated
     */
    const NONSTANDARD = 'nonstandard';

    /**
     * @deprecated
     */
    const P2PK = 'pubkey';

    /**
     * @deprecated
     */
    const P2PKH = 'pubkeyhash';

    /**
     * @deprecated
     */
    const P2SH = 'scripthash';

    /**
     * @deprecated
     */
    const P2WSH = 'witness_v0_scripthash';

    /**
     * @deprecated
     */
    const P2WKH = 'witness_v0_keyhash';

    /**
     * @deprecated
     */
    const WITNESS_COINBASE_COMMITMENT = 'witness_coinbase_commitment';

    /**
     * @param Operation[] $decoded
     * @return false|BufferInterface
     */
    private function decodeP2PK(array $decoded)
    {
        if (count($decoded) !== 2 || !$decoded[0]->isPush()) {
            return false;
        }

        $size = $decoded[0]->getDataSize();
        if ($size === 33 || $size === 65) {
            $op = $decoded[1];
            if ($op->getOp() === Opcodes::OP_CHECKSIG) {
                return $decoded[0]->getData();
            }
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isPayToPublicKey(ScriptInterface $script): bool
    {
        try {
            return $this->decodeP2PK($script->getScriptParser()->decode()) !== false;
        } catch (\Exception $e) {
            /** Return false later */
        }

        return false;
    }

    /**
     * @param Operation[] $decoded
     * @return BufferInterface|false
     */
    private function decodeP2PKH(array $decoded)
    {
        if (count($decoded) !== 5) {
            return false;
        }

        $dup = $decoded[0];
        $hash = $decoded[1];
        $buf = $decoded[2];
        $eq = $decoded[3];
        $checksig = $decoded[4];

        foreach ([$dup, $hash, $eq, $checksig] as $op) {
            /** @var Operation $op */
            if ($op->isPush()) {
                return false;
            }
        }

        if ($dup->getOp() === Opcodes::OP_DUP
            && $hash->getOp() === Opcodes::OP_HASH160
            && $buf->isPush() && $buf->getDataSize() === 20
            && $eq->getOp() === Opcodes::OP_EQUALVERIFY
            && $checksig->getOp() === Opcodes::OP_CHECKSIG) {
            return $decoded[2]->getData();
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isPayToPublicKeyHash(ScriptInterface $script): bool
    {
        try {
            return $this->decodeP2PKH($script->getScriptParser()->decode()) !== false;
        } catch (\Exception $e) {
            /** Return false later */
        }

        return false;
    }

    /**
     * @param array $decoded
     * @return bool|BufferInterface
     */
    private function decodeP2SH(array $decoded)
    {
        if (count($decoded) !== 3) {
            return false;
        }

        $op_hash = $decoded[0];
        if ($op_hash->isPush() || $op_hash->getOp() !== Opcodes::OP_HASH160) {
            return false;
        }

        $buffer = $decoded[1];
        if (!$buffer->isPush() || $buffer->getOp() !== 20) {
            return false;
        }

        $eq = $decoded[2];
        if (!$eq->isPush() && $eq->getOp() === Opcodes::OP_EQUAL) {
            return $decoded[1]->getData();
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isPayToScriptHash(ScriptInterface $script): bool
    {
        try {
            return $this->decodeP2SH($script->getScriptParser()->decode()) !== false;
        } catch (\Exception $e) {
            /** Return false later */
        }

        return false;
    }

    /**
     * @param Operation[] $decoded
     * @return bool|BufferInterface[]
     */
    private function decodeMultisig(array $decoded)
    {
        $count = count($decoded);
        if ($count <= 3) {
            return false;
        }

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

        /** @var Operation[] $vKeys */
        $vKeys = array_slice($decoded, 1, -2);
        $solutions = [];
        foreach ($vKeys as $key) {
            if (!$key->isPush() || !PublicKey::isCompressedOrUncompressed($key->getData())) {
                return false;
            }
            $solutions[] = $key->getData();
        }

        if ($mOp->getOp() >= Opcodes::OP_0
            && $nOp->getOp() <= Opcodes::OP_16
            && $checksig->getOp() === Opcodes::OP_CHECKMULTISIG) {
            return $solutions;
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isMultisig(ScriptInterface $script): bool
    {
        try {
            return $this->decodeMultisig($script->getScriptParser()->decode()) !== false;
        } catch (\Exception $e) {
            /** Return false later */
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @param Operation[] $decoded
     * @return false|BufferInterface
     */
    private function decodeWitnessNoLimit(ScriptInterface $script, array $decoded)
    {
        $size = $script->getBuffer()->getSize();
        if ($size < 4 || $size > 40) {
            return false;
        }
        if (count($decoded) !== 2 || !$decoded[1]->isPush()) {
            return false;
        }

        $version = $decoded[0]->getOp();
        if ($version !== Opcodes::OP_0 && ($version < Opcodes::OP_1 || $version > Opcodes::OP_16)) {
            return false;
        }

        $witness = $decoded[1];
        if ($size === $witness->getDataSize() + 2) {
            return $witness->getData();
        }

        return false;
    }

    /**
     * @param Operation[] $decoded
     * @return BufferInterface|false
     */
    private function decodeP2WKH2(array $decoded)
    {
        if (count($decoded) === 2
            && $decoded[0]->getOp() === Opcodes::OP_0
            && $decoded[1]->isPush()
            && $decoded[1]->getDataSize() === 20) {
            return $decoded[1]->getData();
        }

        return false;
    }

    /**
     * @param Operation[] $decoded
     * @return BufferInterface|false
     */
    private function decodeP2WSH2(array $decoded)
    {
        if (count($decoded) === 2
            && $decoded[0]->getOp() === Opcodes::OP_0
            && $decoded[1]->isPush()
            && $decoded[1]->getDataSize() === 32) {
            return $decoded[1]->getData();
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isWitness(ScriptInterface $script): bool
    {
        try {
            return $this->decodeWitnessNoLimit($script, $script->getScriptParser()->decode())!== false;
        } catch (\Exception $e) {
            /** Return false later */
        }

        return false;
    }

    /**
     * @param Operation[] $decoded
     * @return false|BufferInterface
     */
    private function decodeNullData(array $decoded)
    {
        if (count($decoded) !== 2) {
            return false;
        }

        if ($decoded[0]->getOp() === Opcodes::OP_RETURN && $decoded[1]->isPush()) {
            return $decoded[1]->getData();
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isNullData(ScriptInterface $script): bool
    {
        try {
            return $this->decodeNullData($script->getScriptParser()->decode()) !== false;
        } catch (\Exception $e) {

        }

        return false;
    }

    /**
     * @param array $decoded
     * @return bool|BufferInterface
     */
    private function decodeWitnessCoinbaseCommitment(array $decoded)
    {
        if (count($decoded) !== 2) {
            return false;
        }

        if ($decoded[0]->isPush() || $decoded[0]->getOp() !== Opcodes::OP_RETURN) {
            return false;
        }

        if ($decoded[1]->isPush()) {
            $data = $decoded[1]->getData()->getBinary();
            if ($decoded[1]->getDataSize() === 0x24 && substr($data, 0, 4) === "\xaa\x21\xa9\xed") {
                return new Buffer(substr($data, 4));
            }
        }

        return false;
    }

    /**
     * @param ScriptInterface $script
     * @return bool
     */
    public function isWitnessCoinbaseCommitment(ScriptInterface $script): bool
    {
        try {
            return $this->decodeWitnessCoinbaseCommitment($script->getScriptParser()->decode()) !== false;
        } catch (\Exception $e) {

        }

        return false;
    }

    /**
     * @param array $decoded
     * @param null $solution
     * @return string
     */
    private function classifyDecoded(array $decoded, &$solution = null): string
    {
        $type = ScriptType::NONSTANDARD;

        if (($pubKey = $this->decodeP2PK($decoded))) {
            $type = ScriptType::P2PK;
            $solution = $pubKey;
        } else if (($pubKeyHash = $this->decodeP2PKH($decoded))) {
            $type = ScriptType::P2PKH;
            $solution = $pubKeyHash;
        } else if (($multisig = $this->decodeMultisig($decoded))) {
            $type = ScriptType::MULTISIG;
            $solution = $multisig;
        } else if (($scriptHash = $this->decodeP2SH($decoded))) {
            $type = ScriptType::P2SH;
            $solution = $scriptHash;
        } else if (($witnessScriptHash = $this->decodeP2WSH2($decoded))) {
            $type = ScriptType::P2WSH;
            $solution = $witnessScriptHash;
        } else if (($witnessKeyHash = $this->decodeP2WKH2($decoded))) {
            $type = ScriptType::P2WKH;
            $solution = $witnessKeyHash;
        } else if (($witCommitHash = $this->decodeWitnessCoinbaseCommitment($decoded))) {
            $type = ScriptType::WITNESS_COINBASE_COMMITMENT;
            $solution = $witCommitHash;
        } else if (($nullData = $this->decodeNullData($decoded))) {
            $type = ScriptType::NULLDATA;
            $solution = $nullData;
        }

        return $type;
    }

    /**
     * @param ScriptInterface $script
     * @param mixed $solution
     * @return string
     */
    public function classify(ScriptInterface $script, &$solution = null): string
    {
        $decoded = $script->getScriptParser()->decode();

        $type = $this->classifyDecoded($decoded, $solution);

        return $type;
    }

    /**
     * @param ScriptInterface $script
     * @return OutputData
     */
    public function decode(ScriptInterface $script): OutputData
    {
        $solution = null;
        $type = $this->classify($script, $solution);
        return new OutputData($type, $script, $solution);
    }

    /**
     * @param ScriptInterface $script
     * @param bool $allowNonstandard
     * @return OutputData[]
     */
    public function decodeSequence(ScriptInterface $script, bool $allowNonstandard = false): array
    {
        $decoded = $script->getScriptParser()->decode();

        $j = 0;
        $l = count($decoded);
        $result = [];
        while ($j < $l) {
            $type = null;
            $slice = null;
            $solution = null;

            // increment the $last, and break if it's valid
            for ($i = 0; $i < ($l - $j) + 1; $i++) {
                $slice = array_slice($decoded, $j, $i);
                $chkType = $this->classifyDecoded($slice, $solution);
                if ($chkType !== ScriptType::NONSTANDARD) {
                    $type = $chkType;
                    break;
                }
            }

            if (null === $type) {
                if (!$allowNonstandard) {
                    throw new \RuntimeException("Unable to classify script as a sequence of templated types");
                }
                $j++;
            } else {
                $j += $i;
                /** @var Operation[] $slice */
                /** @var mixed $solution */
                $result[] = new OutputData($type, ScriptFactory::fromOperations($slice), $solution);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            }
        }

        return $result;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BitWasp\Bitcoin\Script\Classifier;
6
7		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PublicKey;
8		use BitWasp\Bitcoin\Script\Opcodes;
9		use BitWasp\Bitcoin\Script\Parser\Operation;
10		use BitWasp\Bitcoin\Script\ScriptFactory;
11		use BitWasp\Bitcoin\Script\ScriptInterface;
12		use BitWasp\Bitcoin\Script\ScriptType;
13		use BitWasp\Buffertools\Buffer;
14		use BitWasp\Buffertools\BufferInterface;
15
16		class OutputClassifier
17		{
18		/**
19		* @deprecated
20		*/
21		const PAYTOPUBKEY = 'pubkey';
22
23		/**
24		* @deprecated
25		*/
26		const PAYTOPUBKEYHASH = 'pubkeyhash';
27
28		/**
29		* @deprecated
30		*/
31		const PAYTOSCRIPTHASH = 'scripthash';
32
33		/**
34		* @deprecated
35		*/
36		const WITNESS_V0_KEYHASH = 'witness_v0_keyhash';
37
38		/**
39		* @deprecated
40		*/
41		const WITNESS_V0_SCRIPTHASH = 'witness_v0_scripthash';
42
43		/**
44		* @deprecated
45		*/
46		const MULTISIG = 'multisig';
47
48		/**
49		* @deprecated
50		*/
51		const NULLDATA = 'nulldata';
52
53		/**
54		* @deprecated
55		*/
56		const UNKNOWN = 'nonstandard';
57
58		/**
59		* @deprecated
60		*/
61		const NONSTANDARD = 'nonstandard';
62
63		/**
64		* @deprecated
65		*/
66		const P2PK = 'pubkey';
67
68		/**
69		* @deprecated
70		*/
71		const P2PKH = 'pubkeyhash';
72
73		/**
74		* @deprecated
75		*/
76		const P2SH = 'scripthash';
77
78		/**
79		* @deprecated
80		*/
81		const P2WSH = 'witness_v0_scripthash';
82
83		/**
84		* @deprecated
85		*/
86		const P2WKH = 'witness_v0_keyhash';
87
88		/**
89		* @deprecated
90		*/
91		const WITNESS_COINBASE_COMMITMENT = 'witness_coinbase_commitment';
92
93		/**
94		* @param Operation[] $decoded
95		* @return false\|BufferInterface
96		*/
97	162	private function decodeP2PK(array $decoded)
98		{
99	162	if (count($decoded) !== 2 \|\| !$decoded[0]->isPush()) {
100	143	return false;
101		}
102
103	69	$size = $decoded[0]->getDataSize();
104	69	if ($size === 33 \|\| $size === 65) {
105	22	$op = $decoded[1];
106	22	if ($op->getOp() === Opcodes::OP_CHECKSIG) {
107	21	return $decoded[0]->getData();
108		}
109		}
110
111	55	return false;
112		}
113
114		/**
115		* @param ScriptInterface $script
116		* @return bool
117		*/
118	10	public function isPayToPublicKey(ScriptInterface $script): bool
119		{
120		try {
121	10	return $this->decodeP2PK($script->getScriptParser()->decode()) !== false;
122		} catch (\Exception $e) {
123		/** Return false later */
124		}
125
126		return false;
127		}
128
129		/**
130		* @param Operation[] $decoded
131		* @return BufferInterface\|false
132		*/
133	151	private function decodeP2PKH(array $decoded)
134		{
135	151	if (count($decoded) !== 5) {
136	112	return false;
137		}
138
139	71	$dup = $decoded[0];
140	71	$hash = $decoded[1];
141	71	$buf = $decoded[2];
142	71	$eq = $decoded[3];
143	71	$checksig = $decoded[4];
144
145	71	foreach ([$dup, $hash, $eq, $checksig] as $op) {
146		/** @var Operation $op */
147	71	if ($op->isPush()) {
148	71	return false;
149		}
150		}
151
152	51	if ($dup->getOp() === Opcodes::OP_DUP
153	51	&& $hash->getOp() === Opcodes::OP_HASH160
154	51	&& $buf->isPush() && $buf->getDataSize() === 20
155	51	&& $eq->getOp() === Opcodes::OP_EQUALVERIFY
156	51	&& $checksig->getOp() === Opcodes::OP_CHECKSIG) {
157	51	return $decoded[2]->getData();
158		}
159
160	1	return false;
161		}
162
163		/**
164		* @param ScriptInterface $script
165		* @return bool
166		*/
167	8	public function isPayToPublicKeyHash(ScriptInterface $script): bool
168		{
169		try {
170	8	return $this->decodeP2PKH($script->getScriptParser()->decode()) !== false;
171		} catch (\Exception $e) {
172		/** Return false later */
173		}
174
175		return false;
176		}
177
178		/**
179		* @param array $decoded
180		* @return bool\|BufferInterface
181		*/
182	2198	private function decodeP2SH(array $decoded)
183		{
184	2198	if (count($decoded) !== 3) {
185	1673	return false;
186		}
187
188	557	$op_hash = $decoded[0];
189	557	if ($op_hash->isPush() \|\| $op_hash->getOp() !== Opcodes::OP_HASH160) {
190	245	return false;
191		}
192
193	313	$buffer = $decoded[1];
194	313	if (!$buffer->isPush() \|\| $buffer->getOp() !== 20) {
195	5	return false;
196		}
197
198	309	$eq = $decoded[2];
199	309	if (!$eq->isPush() && $eq->getOp() === Opcodes::OP_EQUAL) {
200	309	return $decoded[1]->getData();
201		}
202
203	1	return false;
204		}
205
206		/**
207		* @param ScriptInterface $script
208		* @return bool
209		*/
210	2098	public function isPayToScriptHash(ScriptInterface $script): bool
211		{
212		try {
213	2098	return $this->decodeP2SH($script->getScriptParser()->decode()) !== false;
214	1	} catch (\Exception $e) {
215		/** Return false later */
216		}
217
218	1	return false;
219		}
220
221		/**
222		* @param Operation[] $decoded
223		* @return bool\|BufferInterface[]
224		*/
225	120	private function decodeMultisig(array $decoded)
226		{
227	120	$count = count($decoded);
228	120	if ($count <= 3) {
229	90	return false;
230		}
231
232	69	$mOp = $decoded[0];
233	69	$nOp = $decoded[$count - 2];
234	69	$checksig = $decoded[$count - 1];
235	69	if ($mOp->isPush() \|\| $nOp->isPush() \|\| $checksig->isPush()) {
236	22	return false;
237		}
238
239		/** @var Operation[] $vKeys */
240	48	$vKeys = array_slice($decoded, 1, -2);
241	48	$solutions = [];
242	48	foreach ($vKeys as $key) {
243	48	if (!$key->isPush() \|\| !PublicKey::isCompressedOrUncompressed($key->getData())) {
244	13	return false;
245		}
246	45	$solutions[] = $key->getData();
247		}
248
249	36	if ($mOp->getOp() >= Opcodes::OP_0
250	36	&& $nOp->getOp() <= Opcodes::OP_16
251	36	&& $checksig->getOp() === Opcodes::OP_CHECKMULTISIG) {
252	36	return $solutions;
253		}
254
255	1	return false;
256		}
257
258		/**
259		* @param ScriptInterface $script
260		* @return bool
261		*/
262	10	public function isMultisig(ScriptInterface $script): bool
263		{
264		try {
265	10	return $this->decodeMultisig($script->getScriptParser()->decode()) !== false;
266		} catch (\Exception $e) {
267		/** Return false later */
268		}
269
270		return false;
271		}
272
273		/**
274		* @param ScriptInterface $script
275		* @param Operation[] $decoded
276		* @return false\|BufferInterface
277		*/
278	7	private function decodeWitnessNoLimit(ScriptInterface $script, array $decoded)
279		{
280	7	$size = $script->getBuffer()->getSize();
281	7	if ($size < 4 \|\| $size > 40) {
282	3	return false;
283		}
284	5	if (count($decoded) !== 2 \|\| !$decoded[1]->isPush()) {
285	2	return false;
286		}
287
288	4	$version = $decoded[0]->getOp();
289	4	if ($version !== Opcodes::OP_0 && ($version < Opcodes::OP_1 \|\| $version > Opcodes::OP_16)) {
290	2	return false;
291		}
292
293	3	$witness = $decoded[1];
294	3	if ($size === $witness->getDataSize() + 2) {
295	3	return $witness->getData();
296		}
297
298		return false;
299		}
300
301		/**
302		* @param Operation[] $decoded
303		* @return BufferInterface\|false
304		*/
305	50	private function decodeP2WKH2(array $decoded)
306		{
307	50	if (count($decoded) === 2
308	50	&& $decoded[0]->getOp() === Opcodes::OP_0
309	50	&& $decoded[1]->isPush()
310	50	&& $decoded[1]->getDataSize() === 20) {
311	9	return $decoded[1]->getData();
312		}
313
314	41	return false;
315		}
316
317		/**
318		* @param Operation[] $decoded
319		* @return BufferInterface\|false
320		*/
321	76	private function decodeP2WSH2(array $decoded)
322		{
323	76	if (count($decoded) === 2
324	76	&& $decoded[0]->getOp() === Opcodes::OP_0
325	76	&& $decoded[1]->isPush()
326	76	&& $decoded[1]->getDataSize() === 32) {
327	43	return $decoded[1]->getData();
328		}
329
330	50	return false;
331		}
332
333		/**
334		* @param ScriptInterface $script
335		* @return bool
336		*/
337	8	public function isWitness(ScriptInterface $script): bool
338		{
339		try {
340	8	return $this->decodeWitnessNoLimit($script, $script->getScriptParser()->decode())!== false;
341	2	} catch (\Exception $e) {
342		/** Return false later */
343		}
344
345	2	return false;
346		}
347
348		/**
349		* @param Operation[] $decoded
350		* @return false\|BufferInterface
351		*/
352	40	private function decodeNullData(array $decoded)
353		{
354	40	if (count($decoded) !== 2) {
355	39	return false;
356		}
357
358	2	if ($decoded[0]->getOp() === Opcodes::OP_RETURN && $decoded[1]->isPush()) {
359	1	return $decoded[1]->getData();
360		}
361
362	1	return false;
363		}
364
365		/**
366		* @param ScriptInterface $script
367		* @return bool
368		*/
369	1	public function isNullData(ScriptInterface $script): bool
370		{
371		try {
372	1	return $this->decodeNullData($script->getScriptParser()->decode()) !== false;
373		} catch (\Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-25 14:58 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
374		}
375
376		return false;
377		}
378
379		/**
380		* @param array $decoded
381		* @return bool\|BufferInterface
382		*/
383	46	private function decodeWitnessCoinbaseCommitment(array $decoded)
384		{
385	46	if (count($decoded) !== 2) {
386	40	return false;
387		}
388
389	6	if ($decoded[0]->isPush() \|\| $decoded[0]->getOp() !== Opcodes::OP_RETURN) {
390	4	return false;
391		}
392
393	2	if ($decoded[1]->isPush()) {
394	2	$data = $decoded[1]->getData()->getBinary();
395	2	if ($decoded[1]->getDataSize() === 0x24 && substr($data, 0, 4) === "\xaa\x21\xa9\xed") {
396	1	return new Buffer(substr($data, 4));
397		}
398		}
399
400	1	return false;
401		}
402
403		/**
404		* @param ScriptInterface $script
405		* @return bool
406		*/
407	7	public function isWitnessCoinbaseCommitment(ScriptInterface $script): bool
408		{
409		try {
410	7	return $this->decodeWitnessCoinbaseCommitment($script->getScriptParser()->decode()) !== false;
411	1	} catch (\Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-25 14:58 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
412		}
413
414	1	return false;
415		}
416
417		/**
418		* @param array $decoded
419		* @param null $solution
420		* @return string
421		*/
422	159	private function classifyDecoded(array $decoded, &$solution = null): string
423		{
424	159	$type = ScriptType::NONSTANDARD;
425
426	159	if (($pubKey = $this->decodeP2PK($decoded))) {
427	19	$type = ScriptType::P2PK;
428	19	$solution = $pubKey;
429	149	} else if (($pubKeyHash = $this->decodeP2PKH($decoded))) {
430	50	$type = ScriptType::P2PKH;
431	50	$solution = $pubKeyHash;
432	115	} else if (($multisig = $this->decodeMultisig($decoded))) {
433	34	$type = ScriptType::MULTISIG;
434	34	$solution = $multisig;
435	104	} else if (($scriptHash = $this->decodeP2SH($decoded))) {
436	58	$type = ScriptType::P2SH;
437	58	$solution = $scriptHash;
438	76	} else if (($witnessScriptHash = $this->decodeP2WSH2($decoded))) {
439	43	$type = ScriptType::P2WSH;
440	43	$solution = $witnessScriptHash;
441	50	} else if (($witnessKeyHash = $this->decodeP2WKH2($decoded))) {
442	9	$type = ScriptType::P2WKH;
443	9	$solution = $witnessKeyHash;
444	41	} else if (($witCommitHash = $this->decodeWitnessCoinbaseCommitment($decoded))) {
445	1	$type = ScriptType::WITNESS_COINBASE_COMMITMENT;
446	1	$solution = $witCommitHash;
447	40	} else if (($nullData = $this->decodeNullData($decoded))) {
448	1	$type = ScriptType::NULLDATA;
449	1	$solution = $nullData;
450		}
451
452	159	return $type;
453		}
454
455		/**
456		* @param ScriptInterface $script
457		* @param mixed $solution
458		* @return string
459		*/
460	159	public function classify(ScriptInterface $script, &$solution = null): string
461		{
462	159	$decoded = $script->getScriptParser()->decode();
463
464	159	$type = $this->classifyDecoded($decoded, $solution);
465
466	159	return $type;
467		}
468
469		/**
470		* @param ScriptInterface $script
471		* @return OutputData
472		*/
473	149	public function decode(ScriptInterface $script): OutputData
474		{
475	149	$solution = null;
476	149	$type = $this->classify($script, $solution);
477	149	return new OutputData($type, $script, $solution);
478		}
479
480		/**
481		* @param ScriptInterface $script
482		* @param bool $allowNonstandard
483		* @return OutputData[]
484		*/
485		public function decodeSequence(ScriptInterface $script, bool $allowNonstandard = false): array
486		{
487		$decoded = $script->getScriptParser()->decode();
488
489		$j = 0;
490		$l = count($decoded);
491		$result = [];
492		while ($j < $l) {
493		$type = null;
494		$slice = null;
495		$solution = null;
496
497		// increment the $last, and break if it's valid
498		for ($i = 0; $i < ($l - $j) + 1; $i++) {
499		$slice = array_slice($decoded, $j, $i);
500		$chkType = $this->classifyDecoded($slice, $solution);
501		if ($chkType !== ScriptType::NONSTANDARD) {
502		$type = $chkType;
503		break;
504		}
505		}
506
507		if (null === $type) {
508		if (!$allowNonstandard) {
509		throw new \RuntimeException("Unable to classify script as a sequence of templated types");
510		}
511		$j++;
512		} else {
513		$j += $i;
514		/** @var Operation[] $slice */
515		/** @var mixed $solution */
516		$result[] = new OutputData($type, ScriptFactory::fromOperations($slice), $solution);
		0 ignored issues – show Bug introduced 2017-09-03 21:25 UTC by Report Bug Copy Issue Report It seems like `$slice` defined by `null` on line `494` can also be of type `null`; however, `BitWasp\Bitcoin\Script\S...ctory::fromOperations()` does only seem to accept `array<integer,object<Bit...ript\Parser\Operation>>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
517		}
518		}
519
520		return $result;
521		}
522		}
523

Bit-Wasp / bitcoin-php

Pull Request — master (#591)

OutputClassifier D

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

20 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like