Math::getLow64() - 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-24 16:43 UTC

Math::getLow64() A

↳ Parent: Math

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	1
dl	0
loc	7
ccs	5
cts	5
cp	1
crap	1
rs	9.4285
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace BitWasp\Bitcoin\Math;

use Mdanter\Ecc\Math\GmpMath;
use Mdanter\Ecc\Util\NumberSize;

class Math extends GmpMath
{

    /**
     * @param \GMP $integer
     * @return bool
     */
    public function isEven(\GMP $integer): bool
    {
        return $this->cmp($this->mod($integer, gmp_init(2)), gmp_init(0)) === 0;
    }

    /**
     * @param \GMP $int
     * @param \GMP $otherInt
     * @return \GMP
     */
    public function bitwiseOr(\GMP $int, \GMP $otherInt): \GMP
    {
        return gmp_or($int, $otherInt);
    }

    /**
     * Similar to gmp_div_qr, return a tuple containing the
     * result and the remainder
     *
     * @param \GMP $dividend
     * @param \GMP $divisor
     * @return array
     */
    public function divQr(\GMP $dividend, \GMP $divisor): array
    {
        // $div = n / q
        $div = $this->div($dividend, $divisor);
        // $remainder = n - (n / q) * q
        $remainder = $this->sub($dividend, $this->mul($div, $divisor));
        return [$div, $remainder];
    }

    /**
     * @param int $compact
     * @param bool|false $isNegative
     * @param bool|false $isOverflow
     * @return \GMP
     */
    public function decodeCompact($compact, &$isNegative, &$isOverflow): \GMP
    {
        if ($compact < 0 || $compact > pow(2, 32) - 1) {
            throw new \RuntimeException('Compact integer must be 32bit');
        }

        $compact = gmp_init($compact, 10);
        $size = $this->rightShift($compact, 24);
        $word = $this->bitwiseAnd($compact, gmp_init(0x007fffff, 10));
        if ($this->cmp($size, gmp_init(3)) <= 0) {
            $positions = $this->toString($this->mul(gmp_init(8, 10), $this->sub(gmp_init(3, 10), $size)));
            $word = $this->rightShift($word, $positions);
        } else {
            $positions = $this->toString($this->mul(gmp_init(8, 10), $this->sub($size, gmp_init(3, 10))));
            $word = $this->leftShift($word, $positions);
        }

        // isNegative: $word !== 0 && $uint32 & 0x00800000 !== 0
        // isOverflow: $word !== 0 && (($size > 34) || ($word > 0xff && $size > 33) || ($word > 0xffff && $size > 32))
        $zero = gmp_init(0);
        $isNegative = ($this->cmp($word, $zero) !== 0) && ($this->cmp($this->bitwiseAnd($compact, gmp_init(0x00800000)), $zero) === 1);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $isOverflow = $this->cmp($word, $zero) !== 0 && (
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                ($this->cmp($size, gmp_init(34, 10)) > 0)
                || ($this->cmp($word, gmp_init(0xff, 10)) > 0 && $this->cmp($size, gmp_init(33, 10)) > 0)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                || ($this->cmp($word, gmp_init(0xffff, 10)) > 0 && $this->cmp($size, gmp_init(32, 10)) > 0)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        return $word;
    }

    /**
     * @param \GMP $integer
     * @return \GMP
     */
    public function getLow64(\GMP $integer): \GMP
    {
        $bits = gmp_strval($integer, 2);
        $bits = substr($bits, 0, 64);
        $bits = str_pad($bits, 64, '0', STR_PAD_LEFT);
        return gmp_init($bits, 2);
    }

    /**
     * @param \GMP $int
     * @param int $byteSize
     * @return string
     */
    public function fixedSizeInt(\GMP $int, int $byteSize): string
    {
        $two = gmp_init(2);
        $maskShift = gmp_pow($two, 8);
        $mask = gmp_mul(gmp_init(255), gmp_pow($two, 256));

        $x = '';
        for ($i = $byteSize - 1; $i >= 0; $i--) {
            $mask = gmp_div($mask, $maskShift);
            $x .= pack('C', gmp_strval(gmp_div(gmp_and($int, $mask), gmp_pow($two, $i * 8)), 10));
        }

        return $x;
    }

    /**
     * @param \GMP $integer
     * @param bool $fNegative
     * @return \GMP
     */
    public function encodeCompact(\GMP $integer, bool $fNegative): \GMP
    {
        if (!is_bool($fNegative)) {
            throw new \InvalidArgumentException('CompactInteger::read() - flag must be boolean!');
        }

        $size = (int) NumberSize::bnNumBytes($this, $integer);
        if ($size <= 3) {
            $compact = $this->leftShift($this->getLow64($integer), (8 * (3 - $size)));
        } else {
            $compact = $this->rightShift($integer, 8 * ($size - 3));
            $compact = $this->getLow64($compact);
        }

        if ($this->cmp($this->bitwiseAnd($compact, gmp_init(0x00800000, 10)), gmp_init(0, 10)) > 0) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $compact = $this->rightShift($compact, 8);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

        $compact = $this->bitwiseOr($compact, $this->leftShift(gmp_init($size, 10), 24));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        if ($fNegative && $this->cmp($this->bitwiseAnd($compact, gmp_init(0x007fffff, 10)), gmp_init(0, 10)) > 0) { /// ?
            $compact = $this->bitwiseOr($compact, gmp_init(0x00800000, 10));
        }

        return $compact;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BitWasp\Bitcoin\Math;
6
7		use Mdanter\Ecc\Math\GmpMath;
8		use Mdanter\Ecc\Util\NumberSize;
9
10		class Math extends GmpMath
11		{
12
13		/**
14		* @param \GMP $integer
15		* @return bool
16		*/
17	81	public function isEven(\GMP $integer): bool
18		{
19	81	return $this->cmp($this->mod($integer, gmp_init(2)), gmp_init(0)) === 0;
20		}
21
22		/**
23		* @param \GMP $int
24		* @param \GMP $otherInt
25		* @return \GMP
26		*/
27	886	public function bitwiseOr(\GMP $int, \GMP $otherInt): \GMP
28		{
29	886	return gmp_or($int, $otherInt);
30		}
31
32		/**
33		* Similar to gmp_div_qr, return a tuple containing the
34		* result and the remainder
35		*
36		* @param \GMP $dividend
37		* @param \GMP $divisor
38		* @return array
39		*/
40	60	public function divQr(\GMP $dividend, \GMP $divisor): array
41		{
42		// $div = n / q
43	60	$div = $this->div($dividend, $divisor);
44		// $remainder = n - (n / q) * q
45	60	$remainder = $this->sub($dividend, $this->mul($div, $divisor));
46	60	return [$div, $remainder];
47		}
48
49		/**
50		* @param int $compact
51		* @param bool\|false $isNegative
52		* @param bool\|false $isOverflow
53		* @return \GMP
54		*/
55	210	public function decodeCompact($compact, &$isNegative, &$isOverflow): \GMP
56		{
57	210	if ($compact < 0 \|\| $compact > pow(2, 32) - 1) {
58		throw new \RuntimeException('Compact integer must be 32bit');
59		}
60
61	210	$compact = gmp_init($compact, 10);
62	210	$size = $this->rightShift($compact, 24);
63	210	$word = $this->bitwiseAnd($compact, gmp_init(0x007fffff, 10));
64	210	if ($this->cmp($size, gmp_init(3)) <= 0) {
65	13	$positions = $this->toString($this->mul(gmp_init(8, 10), $this->sub(gmp_init(3, 10), $size)));
66	13	$word = $this->rightShift($word, $positions);
67		} else {
68	197	$positions = $this->toString($this->mul(gmp_init(8, 10), $this->sub($size, gmp_init(3, 10))));
69	197	$word = $this->leftShift($word, $positions);
70		}
71
72		// isNegative: $word !== 0 && $uint32 & 0x00800000 !== 0
73		// isOverflow: $word !== 0 && (($size > 34) \|\| ($word > 0xff && $size > 33) \|\| ($word > 0xffff && $size > 32))
74	210	$zero = gmp_init(0);
75	210	$isNegative = ($this->cmp($word, $zero) !== 0) && ($this->cmp($this->bitwiseAnd($compact, gmp_init(0x00800000)), $zero) === 1);
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$word` defined by `$this->leftShift($word, $positions)` on line `69` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::cmp()` does only seem to accept `object<GMP>`, 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...
76	210	$isOverflow = $this->cmp($word, $zero) !== 0 && (
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$word` defined by `$this->leftShift($word, $positions)` on line `69` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::cmp()` does only seem to accept `object<GMP>`, 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...
77	199	($this->cmp($size, gmp_init(34, 10)) > 0)
78	198	\|\| ($this->cmp($word, gmp_init(0xff, 10)) > 0 && $this->cmp($size, gmp_init(33, 10)) > 0)
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$word` defined by `$this->leftShift($word, $positions)` on line `69` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::cmp()` does only seem to accept `object<GMP>`, 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...
79	210	\|\| ($this->cmp($word, gmp_init(0xffff, 10)) > 0 && $this->cmp($size, gmp_init(32, 10)) > 0)
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$word` defined by `$this->leftShift($word, $positions)` on line `69` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::cmp()` does only seem to accept `object<GMP>`, 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...
80		);
81
82	210	return $word;
83		}
84
85		/**
86		* @param \GMP $integer
87		* @return \GMP
88		*/
89	18	public function getLow64(\GMP $integer): \GMP
90		{
91	18	$bits = gmp_strval($integer, 2);
92	18	$bits = substr($bits, 0, 64);
93	18	$bits = str_pad($bits, 64, '0', STR_PAD_LEFT);
94	18	return gmp_init($bits, 2);
95		}
96
97		/**
98		* @param \GMP $int
99		* @param int $byteSize
100		* @return string
101		*/
102		public function fixedSizeInt(\GMP $int, int $byteSize): string
103		{
104		$two = gmp_init(2);
105		$maskShift = gmp_pow($two, 8);
106		$mask = gmp_mul(gmp_init(255), gmp_pow($two, 256));
107
108		$x = '';
109		for ($i = $byteSize - 1; $i >= 0; $i--) {
110		$mask = gmp_div($mask, $maskShift);
111		$x .= pack('C', gmp_strval(gmp_div(gmp_and($int, $mask), gmp_pow($two, $i * 8)), 10));
112		}
113
114		return $x;
115		}
116
117		/**
118		* @param \GMP $integer
119		* @param bool $fNegative
120		* @return \GMP
121		*/
122	18	public function encodeCompact(\GMP $integer, bool $fNegative): \GMP
123		{
124	18	if (!is_bool($fNegative)) {
125		throw new \InvalidArgumentException('CompactInteger::read() - flag must be boolean!');
126		}
127
128	18	$size = (int) NumberSize::bnNumBytes($this, $integer);
129	18	if ($size <= 3) {
130	14	$compact = $this->leftShift($this->getLow64($integer), (8 * (3 - $size)));
131		} else {
132	4	$compact = $this->rightShift($integer, 8 * ($size - 3));
133	4	$compact = $this->getLow64($compact);
134		}
135
136	18	if ($this->cmp($this->bitwiseAnd($compact, gmp_init(0x00800000, 10)), gmp_init(0, 10)) > 0) {
		0 ignored issues – show Bug introduced 2016-07-30 14:36 UTC by Report Bug Copy Issue Report It seems like `$compact` defined by `$this->leftShift($this->...eger), 8 * (3 - $size))` on line `130` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::bitwiseAnd()` does only seem to accept `object<GMP>`, 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...
137	1	$compact = $this->rightShift($compact, 8);
		0 ignored issues – show Bug introduced 2016-07-30 14:36 UTC by Report Bug Copy Issue Report It seems like `$compact` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::rightShift()` does only seem to accept `object<GMP>`, 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...
138	1	$size = $size + 1;
139		}
140
141	18	$compact = $this->bitwiseOr($compact, $this->leftShift(gmp_init($size, 10), 24));
		0 ignored issues – show Bug introduced 2017-12-23 23:38 UTC by Report Bug Copy Issue Report It seems like `$compact` can also be of type `resource`; however, `BitWasp\Bitcoin\Math\Math::bitwiseOr()` does only seem to accept `object<GMP>`, 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...
142	18	if ($fNegative && $this->cmp($this->bitwiseAnd($compact, gmp_init(0x007fffff, 10)), gmp_init(0, 10)) > 0) { /// ?
143	2	$compact = $this->bitwiseOr($compact, gmp_init(0x00800000, 10));
144		}
145
146	18	return $compact;
147		}
148		}
149

Bit-Wasp / bitcoin-php

Pull Request — master (#591)

Math::getLow64() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like