better exception handling

andkom · andkom · commit e166cb7ea90b · 2018-09-25T21:20:45.000+03:00
diff --git a/src/BlockFileReader.php b/src/BlockFileReader.php
@@ -5,6 +5,7 @@
 namespace AndKom\Bitcoin\Blockchain;
 
 use AndKom\BCDataStream\Reader;
+use AndKom\Bitcoin\Blockchain\Exception\IOException;
 
 /**
  * Class BlockFileReader
@@ -18,30 +19,30 @@ class BlockFileReader
      * @param $fp
      * @param int|null $pos
      * @return Block
-     * @throws Exception
+     * @throws IOException
      */
     public function readBlockFromFile($fp, int $pos = null): Block
     {
         if (!is_resource($fp)) {
-            throw new Exception('Invalid file resource.');
+            throw new IOException('Invalid file resource.');
         }
 
         if ($pos && fseek($fp, $pos - 4) === false) {
-            throw new Exception('Unable to seek block file.');
+            throw new IOException('Unable to seek block file.');
         }
 
         $size = fread($fp, 4);
 
         if ($size === false) {
-            throw new Exception('Unable to read block size.');
+            throw new IOException('Unable to read block size.');
         }
 
         $length = unpack('V', $size)[1];
 
         $data = fread($fp, $length);
 
         if ($data === false) {
-            throw new Exception('Unable to read block data.');
+            throw new IOException('Unable to read block data.');
         }
 
         return Block::parse(new Reader($data));
@@ -51,14 +52,14 @@ public function readBlockFromFile($fp, int $pos = null): Block
      * @param string $file
      * @param int $pos
      * @return Block
-     * @throws Exception
+     * @throws IOException
      */
     public function readBlock(string $file, int $pos): Block
     {
         $fp = fopen($file, 'r');
 
         if (!$fp) {
-            throw new Exception("Unable to open block file '$file'.");
+            throw new IOException("Unable to open block file '$file'.");
         }
 
         $block = $this->readBlockFromFile($fp, $pos);
@@ -71,14 +72,14 @@ public function readBlock(string $file, int $pos): Block
     /**
      * @param string $file
      * @return \Generator
-     * @throws Exception
+     * @throws IOException
      */
     public function read(string $file): \Generator
     {
         $fp = fopen($file, 'r');
 
         if (!$fp) {
-            throw new Exception("Unable to open block file '$file'.");
+            throw new IOException("Unable to open block file '$file'.");
         }
 
         while (fread($fp, 4) == static::MAGIC) {
diff --git a/src/BlockInfo.php b/src/BlockInfo.php
@@ -5,6 +5,7 @@
 namespace AndKom\Bitcoin\Blockchain;
 
 use AndKom\BCDataStream\Reader;
+use AndKom\Bitcoin\Blockchain\Exception\Exception;
 
 /**
  * Class BlockInfo
diff --git a/src/BlockchainReader.php b/src/BlockchainReader.php
@@ -4,6 +4,9 @@
 
 namespace AndKom\Bitcoin\Blockchain;
 
+use AndKom\Bitcoin\Blockchain\Exception\Exception;
+use AndKom\Bitcoin\Blockchain\Exception\IOException;
+
 /**
  * Class BlockchainReader
  * @package AndKom\Bitcoin\Blockchain
@@ -74,6 +77,7 @@ public function getChainstate(): ChainstateReader
      * @param BlockInfo $blockInfo
      * @return Block
      * @throws Exception
+     * @throws IOException
      */
     public function getBlockByInfo(BlockInfo $blockInfo): Block
     {
@@ -86,6 +90,7 @@ public function getBlockByInfo(BlockInfo $blockInfo): Block
      * @param string $hash
      * @return Block
      * @throws Exception
+     * @throws IOException
      */
     public function getBlockByHash(string $hash): Block
     {
@@ -96,6 +101,7 @@ public function getBlockByHash(string $hash): Block
      * @param int $height
      * @return Block
      * @throws Exception
+     * @throws IOException
      */
     public function getBlockByHeight(int $height): Block
     {
@@ -105,8 +111,9 @@ public function getBlockByHeight(int $height): Block
     /**
      * @param int|null $minHeight
      * @param int|null $maxHeight
-     * @return \Generator
      * @throws Exception
+     * @throws IOException
+     * @return \Generator
      */
     public function readBlocks(int $minHeight = null, int $maxHeight = null): \Generator
     {
@@ -128,12 +135,12 @@ public function readBlocks(int $minHeight = null, int $maxHeight = null): \Gener
 
     /**
      * @return \Generator
-     * @throws Exception
+     * @throws IOException
      */
     public function readBlocksUnordered(): \Generator
     {
         if (!file_exists($this->blocksDir)) {
-            throw new Exception("Blocks dir '{$this->blocksDir}' not found.");
+            throw new IOException("Blocks dir '{$this->blocksDir}' not found.");
         }
 
         $dir = dir($this->blocksDir);
diff --git a/src/ChainstateReader.php b/src/ChainstateReader.php
@@ -5,6 +5,7 @@
 namespace AndKom\Bitcoin\Blockchain;
 
 use AndKom\BCDataStream\Reader;
+use AndKom\Bitcoin\Blockchain\Exception\Exception;
 
 /**
  * Class ChainstateReader
diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php
@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace AndKom\Bitcoin\Blockchain;
+namespace AndKom\Bitcoin\Blockchain\Exception;
 
 /**
  * Class Exception
- * @package AndKom\Bitcoin\Blockchain
+ * @package AndKom\Bitcoin\Blockchain\Exception
  */
 class Exception extends \Exception
 {
diff --git a/src/Exception/IOException.php b/src/Exception/IOException.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AndKom\Bitcoin\Blockchain\Exception;
+
+/**
+ * Class ScriptException
+ * @package AndKom\Bitcoin\Blockchain\Exception
+ */
+class IOException extends Exception
+{
+}
diff --git a/src/Exception/PublicKeyException.php b/src/Exception/PublicKeyException.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AndKom\Bitcoin\Blockchain\Exception;
+
+/**
+ * Class ScriptException
+ * @package AndKom\Bitcoin\Blockchain\Exception
+ */
+class PublicKeyException extends Exception
+{
+}
diff --git a/src/Exception/ScriptException.php b/src/Exception/ScriptException.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AndKom\Bitcoin\Blockchain\Exception;
+
+/**
+ * Class ScriptException
+ * @package AndKom\Bitcoin\Blockchain\Exception
+ */
+class ScriptException extends Exception
+{
+}
diff --git a/src/Index.php b/src/Index.php
@@ -4,6 +4,8 @@
 
 namespace AndKom\Bitcoin\Blockchain;
 
+use AndKom\Bitcoin\Blockchain\Exception\Exception;
+
 /**
  * Class Index
  * @package AndKom\Bitcoin\Blockchain
diff --git a/src/IndexReader.php b/src/IndexReader.php
@@ -5,6 +5,7 @@
 namespace AndKom\Bitcoin\Blockchain;
 
 use AndKom\BCDataStream\Reader;
+use AndKom\Bitcoin\Blockchain\Exception\Exception;
 
 /**
  * Class IndexReader
diff --git a/src/PublicKey.php b/src/PublicKey.php
@@ -2,6 +2,7 @@
 
 namespace AndKom\Bitcoin\Blockchain;
 
+use AndKom\Bitcoin\Blockchain\Exception\PublicKeyException;
 use Mdanter\Ecc\EccFactory;
 
 /**
@@ -55,12 +56,12 @@ public function getX(): \GMP
 
     /**
      * @return \GMP
-     * @throws Exception
+     * @throws PublicKeyException
      */
     public function getY(): \GMP
     {
         if ($this->isCompressed()) {
-            throw new Exception("Compressed public key doesn't have Y coordinate.");
+            throw new PublicKeyException("Compressed public key doesn't have Y coordinate.");
         }
 
         return $this->y;
@@ -84,12 +85,12 @@ public function isCompressed(): bool
 
     /**
      * @return PublicKey
-     * @throws Exception
+     * @throws PublicKeyException
      */
     public function compress(): self
     {
         if ($this->isCompressed()) {
-            throw new Exception('Public key is already compressed.');
+            throw new PublicKeyException('Public key is already compressed.');
         }
 
         $wasOdd = \gmp_cmp(
@@ -102,12 +103,12 @@ public function compress(): self
 
     /**
      * @return PublicKey
-     * @throws Exception
+     * @throws PublicKeyException
      */
     public function decompress(): self
     {
         if (!$this->isCompressed()) {
-            throw new Exception('Public key is already decompressed.');
+            throw new PublicKeyException('Public key is already decompressed.');
         }
 
         $curve = EccFactory::getSecgCurves()->generator256k1()->getCurve();
@@ -118,7 +119,7 @@ public function decompress(): self
 
     /**
      * @return \Mdanter\Ecc\Crypto\Key\PublicKey
-     * @throws Exception
+     * @throws PublicKeyException
      */
     public function getEccPublicKey(): \Mdanter\Ecc\Crypto\Key\PublicKey
     {
@@ -140,7 +141,7 @@ public function getEccPublicKey(): \Mdanter\Ecc\Crypto\Key\PublicKey
     /**
      * @param string $data
      * @return PublicKey
-     * @throws Exception
+     * @throws PublicKeyException
      */
     static public function parse(string $data): self
     {
@@ -150,7 +151,7 @@ static public function parse(string $data): self
             $prefix = substr($data, 0, 1);
 
             if ($prefix != static::PREFIX_COMPRESSED_ODD && $prefix != static::PREFIX_COMPRESSED_EVEN) {
-                throw new Exception('Invalid compressed public key prefix.');
+                throw new PublicKeyException('Invalid compressed public key prefix.');
             }
 
             $x = \gmp_init(bin2hex(substr($data, 1, 32)), 16);
@@ -159,13 +160,13 @@ static public function parse(string $data): self
             $prefix = substr($data, 0, 1);
 
             if ($prefix != static::PREFIX_UNCOMPRESSED) {
-                throw new Exception('Invalid uncompressed public key prefix.');
+                throw new PublicKeyException('Invalid uncompressed public key prefix.');
             }
 
             $x = \gmp_init(bin2hex(substr($data, 1, 32)), 16);
             $y = \gmp_init(bin2hex(substr($data, 33, 32)), 16);
         } else {
-            throw new Exception('Invalid public key size.');
+            throw new PublicKeyException('Invalid public key size.');
         }
 
         return new static($x, $y, $prefix == static::PREFIX_COMPRESSED_ODD);
diff --git a/src/ScriptPubKey.php b/src/ScriptPubKey.php
@@ -4,6 +4,7 @@
 
 namespace AndKom\Bitcoin\Blockchain;
 
+use AndKom\Bitcoin\Blockchain\Exception\ScriptException;
 use AndKom\Bitcoin\Blockchain\Network\Bitcoin;
 
 /**
@@ -105,7 +106,7 @@ public function isPayToWitnessScriptHash(): bool
     /**
      * @param Bitcoin|null $network
      * @return string
-     * @throws Exception
+     * @throws ScriptException
      * @throws \Exception
      * @throws \BitWasp\Bech32\Exception\Bech32Exception
      */
@@ -114,7 +115,7 @@ public function getOutputAddress(Bitcoin $network = null): string
         try {
             $operations = $this->parse();
         } catch (\Exception $exception) {
-            throw new Exception('Unable to decode output address (script parse error).');
+            throw new ScriptException('Unable to decode output address (script parse error).');
         }
 
         $addressSerializer = new AddressSerializer($network);
@@ -140,13 +141,13 @@ public function getOutputAddress(Bitcoin $network = null): string
         }
 
         if ($this->isMultisig()) {
-            throw new Exception('Unable to decode output address (multisig).');
+            throw new ScriptException('Unable to decode output address (multisig).');
         }
 
         if ($this->isReturn()) {
-            throw new Exception('Unable to decode output address (OP_RETURN).');
+            throw new ScriptException('Unable to decode output address (OP_RETURN).');
         }
 
-        throw new Exception('Unable to decode output address.');
+        throw new ScriptException('Unable to decode output address.');
     }
 }
