PublicKey::equals() - Code Metrics - Inspection of "TransactionInterface: add getBaseSerialization & g..." - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#446)

by thomas

created 2017-01-20 13:09 UTC

PublicKey::equals() A

↳ Parent: PublicKey

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1.125

Importance

Changes

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

<?php

namespace BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Key;

use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Adapter\EcAdapter;
use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Serializer\Key\PublicKeySerializer;
use BitWasp\Bitcoin\Crypto\EcAdapter\Key\Key;
use BitWasp\Bitcoin\Crypto\EcAdapter\Key\PublicKeyInterface;
use BitWasp\Bitcoin\Crypto\EcAdapter\Signature\SignatureInterface;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;

class PublicKey extends Key implements PublicKeyInterface
{
    /**
     * @var EcAdapter
     */
    private $ecAdapter;

    /**
     * @var bool|false
     */
    private $compressed;

    /**
     * @var resource
     */
    private $pubkey_t;

    /**
     * @param EcAdapter $ecAdapter
     * @param resource $secp256k1_pubkey_t
     * @param bool|false $compressed
     */
    public function __construct(EcAdapter $ecAdapter, $secp256k1_pubkey_t, $compressed = false)
    {
        if (!is_resource($secp256k1_pubkey_t) ||
            !get_resource_type($secp256k1_pubkey_t) === SECP256K1_TYPE_PUBKEY) {
            throw new \InvalidArgumentException('Secp256k1\Key\PublicKey expects ' . SECP256K1_TYPE_PUBKEY . ' resource');
        }

        if (false === is_bool($compressed)) {
            throw new \InvalidArgumentException('PublicKey: Compressed must be a boolean');
        }

        $this->ecAdapter = $ecAdapter;
        $this->pubkey_t = $secp256k1_pubkey_t;
        $this->compressed = $compressed;
    }
    
    /**
     * @param BufferInterface $msg32
     * @param SignatureInterface $signature
     * @return bool
     */
    public function verify(BufferInterface $msg32, SignatureInterface $signature)
    {
        return $this->ecAdapter->verify($msg32, $this, $signature);
    }

    /**
     * @param PublicKey $other
     * @return bool
     */
    private function doEquals(self $other)
    {
        $context = $this->ecAdapter->getContext();
        $pubA = '';
        $pubB = '';
        if (!(secp256k1_ec_pubkey_serialize($context, $pubA, $this->pubkey_t, $this->compressed) && secp256k1_ec_pubkey_serialize($context, $pubB, $other->pubkey_t, $this->compressed))) {
            throw new \RuntimeException('Unable to serialize public key during equals');
        }

        return hash_equals($pubA, $pubB);
    }

    /**
     * @param PublicKeyInterface $other
     * @return bool
     */
    public function equals(PublicKeyInterface $other)
    {
        /** @var self $other */
        return $this->doEquals($other);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * @return bool|false
     */
    public function isCompressed()
    {
        return $this->compressed;
    }

    /**
     * @return resource
     */
    public function getResource()
    {
        return $this->pubkey_t;
    }

    /**
     * @return resource
     * @throws \Exception
     */
    private function clonePubkey()
    {
        $context = $this->ecAdapter->getContext();
        $serialized = '';
        if (1 !== secp256k1_ec_pubkey_serialize($context, $serialized, $this->pubkey_t, $this->compressed)) {
            throw new \Exception('Secp256k1: pubkey serialize');
        }

        /** @var resource $clone */
        $clone = '';
        if (1 !== secp256k1_ec_pubkey_parse($context, $clone, $serialized)) {
            throw new \Exception('Secp256k1 pubkey parse');
        }

        return $clone;
    }

    /**
     * @param \GMP $tweak
     * @return PublicKey
     * @throws \Exception
     */
    public function tweakAdd(\GMP $tweak)
    {
        $context = $this->ecAdapter->getContext();
        $bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();

        $clone = $this->clonePubkey();
        if (1 !== secp256k1_ec_pubkey_tweak_add($context, $clone, $bin)) {
            throw new \RuntimeException('Secp256k1: tweak add failed.');
        }

        return new PublicKey($this->ecAdapter, $clone, $this->compressed);
    }

    /**
     * @param \GMP $tweak
     * @return PublicKey
     * @throws \Exception
     */
    public function tweakMul(\GMP $tweak)
    {
        $context = $this->ecAdapter->getContext();
        $bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();

        $clone = $this->clonePubkey();
        if (1 !== secp256k1_ec_pubkey_tweak_mul($context, $clone, $bin)) {
            throw new \RuntimeException('Secp256k1: tweak mul failed.');
        }

        return new PublicKey($this->ecAdapter, $clone, $this->compressed);
    }

    /**
     * @return BufferInterface
     */
    public function getBuffer()
    {
        return (new PublicKeySerializer($this->ecAdapter))->serialize($this);
    }
}


1		<?php
2
3		namespace BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Key;
4
5		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Adapter\EcAdapter;
6		use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\Secp256k1\Serializer\Key\PublicKeySerializer;
7		use BitWasp\Bitcoin\Crypto\EcAdapter\Key\Key;
8		use BitWasp\Bitcoin\Crypto\EcAdapter\Key\PublicKeyInterface;
9		use BitWasp\Bitcoin\Crypto\EcAdapter\Signature\SignatureInterface;
10		use BitWasp\Buffertools\Buffer;
11		use BitWasp\Buffertools\BufferInterface;
12
13		class PublicKey extends Key implements PublicKeyInterface
14		{
15		/**
16		* @var EcAdapter
17		*/
18		private $ecAdapter;
19
20		/**
21		* @var bool\|false
22		*/
23		private $compressed;
24
25		/**
26		* @var resource
27		*/
28		private $pubkey_t;
29
30		/**
31		* @param EcAdapter $ecAdapter
32		* @param resource $secp256k1_pubkey_t
33		* @param bool\|false $compressed
34		*/
35	133	public function __construct(EcAdapter $ecAdapter, $secp256k1_pubkey_t, $compressed = false)
36		{
37	133	if (!is_resource($secp256k1_pubkey_t) \|\|
38	133	!get_resource_type($secp256k1_pubkey_t) === SECP256K1_TYPE_PUBKEY) {
39		throw new \InvalidArgumentException('Secp256k1\Key\PublicKey expects ' . SECP256K1_TYPE_PUBKEY . ' resource');
40		}
41
42	133	if (false === is_bool($compressed)) {
43		throw new \InvalidArgumentException('PublicKey: Compressed must be a boolean');
44		}
45
46	133	$this->ecAdapter = $ecAdapter;
47	133	$this->pubkey_t = $secp256k1_pubkey_t;
48	133	$this->compressed = $compressed;
49	133	}
50
51		/**
52		* @param BufferInterface $msg32
53		* @param SignatureInterface $signature
54		* @return bool
55		*/
56		public function verify(BufferInterface $msg32, SignatureInterface $signature)
57		{
58		return $this->ecAdapter->verify($msg32, $this, $signature);
59		}
60
61		/**
62		* @param PublicKey $other
63		* @return bool
64		*/
65	6	private function doEquals(self $other)
66		{
67	6	$context = $this->ecAdapter->getContext();
68	6	$pubA = '';
69	6	$pubB = '';
70	6	if (!(secp256k1_ec_pubkey_serialize($context, $pubA, $this->pubkey_t, $this->compressed) && secp256k1_ec_pubkey_serialize($context, $pubB, $other->pubkey_t, $this->compressed))) {
71		throw new \RuntimeException('Unable to serialize public key during equals');
72		}
73
74	6	return hash_equals($pubA, $pubB);
75		}
76
77		/**
78		* @param PublicKeyInterface $other
79		* @return bool
80		*/
81	6	public function equals(PublicKeyInterface $other)
82		{
83		/** @var self $other */
84	6	return $this->doEquals($other);
		0 ignored issues – show Documentation introduced 2017-01-18 15:19 UTC by Report Bug Copy Issue Report `$other` is of type `object<BitWasp\Bitcoin\C...ecp256k1\Key\PublicKey>`, but the function expects a `object<self>`. 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...
85		}
86
87		/**
88		* @return bool\|false
89		*/
90	119	public function isCompressed()
91		{
92	119	return $this->compressed;
93		}
94
95		/**
96		* @return resource
97		*/
98	115	public function getResource()
99		{
100	115	return $this->pubkey_t;
101		}
102
103		/**
104		* @return resource
105		* @throws \Exception
106		*/
107	5	private function clonePubkey()
108		{
109	5	$context = $this->ecAdapter->getContext();
110	5	$serialized = '';
111	5	if (1 !== secp256k1_ec_pubkey_serialize($context, $serialized, $this->pubkey_t, $this->compressed)) {
112		throw new \Exception('Secp256k1: pubkey serialize');
113		}
114
115		/** @var resource $clone */
116	5	$clone = '';
117	5	if (1 !== secp256k1_ec_pubkey_parse($context, $clone, $serialized)) {
118		throw new \Exception('Secp256k1 pubkey parse');
119		}
120
121	5	return $clone;
122		}
123
124		/**
125		* @param \GMP $tweak
126		* @return PublicKey
127		* @throws \Exception
128		*/
129	4	public function tweakAdd(\GMP $tweak)
130		{
131	4	$context = $this->ecAdapter->getContext();
132	4	$bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();
133
134	4	$clone = $this->clonePubkey();
135	4	if (1 !== secp256k1_ec_pubkey_tweak_add($context, $clone, $bin)) {
136		throw new \RuntimeException('Secp256k1: tweak add failed.');
137		}
138
139	4	return new PublicKey($this->ecAdapter, $clone, $this->compressed);
140		}
141
142		/**
143		* @param \GMP $tweak
144		* @return PublicKey
145		* @throws \Exception
146		*/
147	1	public function tweakMul(\GMP $tweak)
148		{
149	1	$context = $this->ecAdapter->getContext();
150	1	$bin = Buffer::int(gmp_strval($tweak, 10), 32)->getBinary();
151
152	1	$clone = $this->clonePubkey();
153	1	if (1 !== secp256k1_ec_pubkey_tweak_mul($context, $clone, $bin)) {
154		throw new \RuntimeException('Secp256k1: tweak mul failed.');
155		}
156
157	1	return new PublicKey($this->ecAdapter, $clone, $this->compressed);
158		}
159
160		/**
161		* @return BufferInterface
162		*/
163	104	public function getBuffer()
164		{
165	104	return (new PublicKeySerializer($this->ecAdapter))->serialize($this);
166		}
167		}
168

Bit-Wasp / bitcoin-php

Pull Request — master (#446)

PublicKey::equals() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like