Bit-Wasp /
bitcoin-php
Complex classes like HierarchicalKey often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use HierarchicalKey, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 20 | class HierarchicalKey |
||
| 21 | { |
||
| 22 | /** |
||
| 23 | * @var EcAdapterInterface |
||
| 24 | */ |
||
| 25 | private $ecAdapter; |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @var int |
||
| 29 | */ |
||
| 30 | private $depth; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @var int |
||
| 34 | */ |
||
| 35 | private $parentFingerprint; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * @var int |
||
| 39 | */ |
||
| 40 | private $sequence; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * @var BufferInterface |
||
| 44 | */ |
||
| 45 | private $chainCode; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * @var PublicKeyInterface|PrivateKeyInterface |
||
| 49 | */ |
||
| 50 | private $key; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @param EcAdapterInterface $ecAdapter |
||
| 54 | * @param int $depth |
||
| 55 | * @param int $parentFingerprint |
||
| 56 | * @param int $sequence |
||
| 57 | * @param BufferInterface $chainCode |
||
| 58 | * @param KeyInterface $key |
||
| 59 | * @throws \Exception |
||
| 60 | */ |
||
| 61 | 64 | public function __construct(EcAdapterInterface $ecAdapter, $depth, $parentFingerprint, $sequence, BufferInterface $chainCode, KeyInterface $key) |
|
| 62 | { |
||
| 63 | 64 | if ($depth < 0 || $depth > IntRange::U8_MAX) { |
|
| 64 | throw new \InvalidArgumentException('Invalid depth for BIP32 key, must be in range [0 - 255] inclusive'); |
||
| 65 | } |
||
| 66 | |||
| 67 | 64 | if ($parentFingerprint < 0 || $parentFingerprint > IntRange::U32_MAX) { |
|
| 68 | throw new \InvalidArgumentException('Invalid fingerprint for BIP32 key, must be in range [0 - (2^31)-1] inclusive'); |
||
| 69 | } |
||
| 70 | |||
| 71 | 64 | if ($sequence < 0 || $sequence > IntRange::U32_MAX) { |
|
| 72 | throw new \InvalidArgumentException('Invalid sequence for BIP32 key, must be in range [0 - (2^31)-1] inclusive'); |
||
| 73 | } |
||
| 74 | |||
| 75 | 64 | if ($chainCode->getSize() !== 32) { |
|
| 76 | throw new \RuntimeException('Chaincode should be 32 bytes'); |
||
| 77 | } |
||
| 78 | |||
| 79 | 64 | if (!$key->isCompressed()) { |
|
| 80 | 2 | throw new \InvalidArgumentException('A HierarchicalKey must always be compressed'); |
|
| 81 | } |
||
| 82 | |||
| 83 | 62 | $this->ecAdapter = $ecAdapter; |
|
| 84 | 62 | $this->depth = $depth; |
|
| 85 | 62 | $this->sequence = $sequence; |
|
| 86 | 62 | $this->parentFingerprint = $parentFingerprint; |
|
| 87 | 62 | $this->chainCode = $chainCode; |
|
| 88 | 62 | $this->key = $key; |
|
|
|
|||
| 89 | 62 | } |
|
| 90 | |||
| 91 | /** |
||
| 92 | * Return the depth of this key. This is limited to 256 sequential derivations. |
||
| 93 | * |
||
| 94 | * @return int |
||
| 95 | */ |
||
| 96 | 18 | public function getDepth() |
|
| 97 | { |
||
| 98 | 18 | return $this->depth; |
|
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Get the sequence number for this address. Hardened keys are |
||
| 103 | * created with sequence > 0x80000000. a sequence number lower |
||
| 104 | * than this can be derived with the public key. |
||
| 105 | * |
||
| 106 | * @return int |
||
| 107 | */ |
||
| 108 | 14 | public function getSequence() |
|
| 112 | |||
| 113 | /** |
||
| 114 | * Get the fingerprint of the parent key. For master keys, this is 00000000. |
||
| 115 | * |
||
| 116 | * @return string |
||
| 117 | */ |
||
| 118 | 14 | public function getFingerprint() |
|
| 119 | { |
||
| 120 | 14 | if ($this->getDepth() === 0) { |
|
| 121 | 8 | return 0; |
|
| 122 | } |
||
| 123 | |||
| 124 | 14 | return $this->parentFingerprint; |
|
| 125 | } |
||
| 126 | |||
| 127 | /** |
||
| 128 | * Return the fingerprint to be used for child keys. |
||
| 129 | * @return int |
||
| 130 | */ |
||
| 131 | 16 | public function getChildFingerprint() |
|
| 132 | { |
||
| 133 | 16 | return $this->getPublicKey()->getPubKeyHash()->slice(0, 4)->getInt(); |
|
| 134 | } |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Return the chain code - a deterministic 'salt' for HMAC-SHA512 |
||
| 138 | * in child derivations |
||
| 139 | * |
||
| 140 | * @return BufferInterface |
||
| 141 | */ |
||
| 142 | 12 | public function getChainCode() |
|
| 143 | { |
||
| 144 | 12 | return $this->chainCode; |
|
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * @return PrivateKeyInterface |
||
| 149 | */ |
||
| 150 | 28 | public function getPrivateKey() |
|
| 158 | |||
| 159 | /** |
||
| 160 | * Get the public key the private key or public key. |
||
| 161 | * |
||
| 162 | * @return PublicKeyInterface |
||
| 163 | */ |
||
| 164 | 30 | public function getPublicKey() |
|
| 172 | |||
| 173 | /** |
||
| 174 | * @return HierarchicalKey |
||
| 175 | */ |
||
| 176 | 10 | public function toPublic() |
|
| 177 | { |
||
| 184 | |||
| 185 | /** |
||
| 186 | * Return whether this is a private key |
||
| 187 | * |
||
| 188 | * @return bool |
||
| 189 | */ |
||
| 190 | 34 | public function isPrivate() |
|
| 194 | |||
| 195 | /** |
||
| 196 | * Return whether the key is hardened |
||
| 197 | * |
||
| 198 | * @return bool |
||
| 199 | */ |
||
| 200 | 2 | public function isHardened() |
|
| 204 | |||
| 205 | /** |
||
| 206 | * Create a buffer containing data to be hashed hashed to yield the child offset |
||
| 207 | * |
||
| 208 | * @param int $sequence |
||
| 209 | * @return BufferInterface |
||
| 210 | * @throws \Exception |
||
| 211 | */ |
||
| 212 | 28 | public function getHmacSeed($sequence) |
|
| 232 | |||
| 233 | /** |
||
| 234 | * Derive a child key |
||
| 235 | * |
||
| 236 | * @param int $sequence |
||
| 237 | * @return HierarchicalKey |
||
| 238 | * @throws \Exception |
||
| 239 | */ |
||
| 240 | 22 | public function deriveChild($sequence) |
|
| 241 | { |
||
| 242 | 22 | $nextDepth = $this->depth + 1; |
|
| 243 | 22 | if ($nextDepth > 255) { |
|
| 244 | throw new \InvalidArgumentException('Invalid depth for BIP32 key, cannot exceed 255'); |
||
| 245 | } |
||
| 246 | |||
| 247 | 22 | $hash = Hash::hmac('sha512', $this->getHmacSeed($sequence), $this->chainCode); |
|
| 248 | 14 | $offset = $hash->slice(0, 32); |
|
| 249 | 14 | $chain = $hash->slice(32); |
|
| 250 | |||
| 251 | 14 | if (false === $this->ecAdapter->validatePrivateKey($offset)) { |
|
| 252 | 2 | return $this->deriveChild($sequence + 1); |
|
| 253 | } |
||
| 254 | |||
| 255 | 14 | $key = $this->isPrivate() ? $this->getPrivateKey() : $this->getPublicKey(); |
|
| 256 | 14 | $key = $key->tweakAdd($offset->getGmp()); |
|
| 257 | |||
| 258 | 14 | return new HierarchicalKey( |
|
| 259 | 14 | $this->ecAdapter, |
|
| 260 | 14 | $nextDepth, |
|
| 261 | 14 | $this->getChildFingerprint(), |
|
| 262 | 14 | $sequence, |
|
| 263 | 14 | $chain, |
|
| 264 | 14 | $key |
|
| 265 | ); |
||
| 266 | } |
||
| 267 | |||
| 268 | /** |
||
| 269 | * @param array|\stdClass|\Traversable $list |
||
| 270 | * @return HierarchicalKey |
||
| 271 | */ |
||
| 272 | 8 | public function deriveFromList($list) |
|
| 285 | |||
| 286 | /** |
||
| 287 | * Decodes a BIP32 path into actual 32bit sequence numbers and derives the child key |
||
| 288 | * |
||
| 289 | * @param string $path |
||
| 290 | * @return HierarchicalKey |
||
| 291 | * @throws \Exception |
||
| 292 | */ |
||
| 293 | 8 | public function derivePath($path) |
|
| 298 | |||
| 299 | |||
| 300 | /** |
||
| 301 | * Serializes the instance according to whether it wraps a private or public key. |
||
| 302 | * @param NetworkInterface $network |
||
| 303 | * @return string |
||
| 304 | */ |
||
| 305 | 12 | public function toExtendedKey(NetworkInterface $network = null) |
|
| 313 | |||
| 314 | /** |
||
| 315 | * Explicitly serialize as a private key. Throws an exception if |
||
| 316 | * the key isn't private. |
||
| 317 | * |
||
| 318 | * @param NetworkInterface $network |
||
| 319 | * @return string |
||
| 320 | */ |
||
| 321 | 12 | public function toExtendedPrivateKey(NetworkInterface $network = null) |
|
| 329 | |||
| 330 | /** |
||
| 331 | * Explicitly serialize as a public key. This will always work. |
||
| 332 | * |
||
| 333 | * @param NetworkInterface $network |
||
| 334 | * @return string |
||
| 335 | */ |
||
| 336 | 10 | public function toExtendedPublicKey(NetworkInterface $network = null) |
|
| 341 | } |
||
| 342 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..