blocktrail / blocktrail-sdk-php

src/BlocktrailSDK.php

Doc Comments +19 added lines, -11 removed lines

@@ -110,7 +110,7 @@ 
     /**
      * normalize network string
      *
-     * @param $network
+     * @param string $network
      * @param $testnet
      * @return array
      * @throws \Exception
@@ -746,6 +746,11 @@ 
         ];
     }
 
+    /**
+     * @param integer $bits
+     *
+     * @return string
+     */
     public static function randomBits($bits) {
         return self::randomBytes($bits / 8);
     }
@@ -1048,7 +1053,7 @@ 
      * create wallet using the API
      *
      * @param string    $identifier             the wallet identifier to create
-     * @param array     $primaryPublicKey       BIP32 extended public key - [key, path]
+     * @param string[]     $primaryPublicKey       BIP32 extended public key - [key, path]
      * @param array     $backupPublicKey        BIP32 extended public key - [backup key, path "M"]
      * @param string    $primaryMnemonic        mnemonic to store
      * @param string    $checksum               checksum to store
@@ -1076,10 +1081,10 @@ 
      *
      * @param string $identifier       the wallet identifier to create
      * @param array  $primaryPublicKey BIP32 extended public key - [key, path]
-     * @param array  $backupPublicKey  BIP32 extended public key - [backup key, path "M"]
-     * @param        $encryptedPrimarySeed
-     * @param        $encryptedSecret
-     * @param        $recoverySecret
+     * @param string[]  $backupPublicKey  BIP32 extended public key - [backup key, path "M"]
+     * @param        string|false $encryptedPrimarySeed
+     * @param        string|false $encryptedSecret
+     * @param        string|false $recoverySecret
      * @param string $checksum         checksum to store
      * @param int    $keyIndex         account that we expect to use
      * @param bool   $segwit           opt in to segwit
@@ -1109,9 +1114,9 @@ 
      *
      * @param string $identifier       the wallet identifier to create
      * @param array  $primaryPublicKey BIP32 extended public key - [key, path]
-     * @param array  $backupPublicKey  BIP32 extended public key - [backup key, path "M"]
-     * @param        $encryptedPrimarySeed
-     * @param        $encryptedSecret
+     * @param string[]  $backupPublicKey  BIP32 extended public key - [backup key, path "M"]
+     * @param        string|false $encryptedPrimarySeed
+     * @param        string|false $encryptedSecret
      * @param        $recoverySecret
      * @param string $checksum         checksum to store
      * @param int    $keyIndex         account that we expect to use
@@ -1843,7 +1848,7 @@ 
      * convert a Satoshi value to a BTC value
      *
      * @param int       $satoshi
-     * @return float
+     * @return string
      */
     public static function toBTC($satoshi) {
         return bcdiv((int)(string)$satoshi, 100000000, 8);
@@ -1873,7 +1878,7 @@ 
      * convert a BTC value to a Satoshi value
      *
      * @param float     $btc
-     * @return string
+     * @return integer
      */
     public static function toSatoshi($btc) {
         return (int)self::toSatoshiString($btc);
@@ -1934,6 +1939,9 @@ 
         }
     }
 
+    /**
+     * @param BIP32Key[] $keys
+     */
     public static function normalizeBIP32KeyArray($keys) {
         return Util::arrayMapWithIndex(function ($idx, $key) {
             return [$idx, self::normalizeBIP32Key($key)];

Unused Use Statements -1 removed lines

@@ -23,7 +23,6 @@
 use Blocktrail\SDK\Address\BitcoinAddressReader;
 use Blocktrail\SDK\Address\BitcoinCashAddressReader;
 use Blocktrail\SDK\Address\CashAddress;
-use Blocktrail\SDK\Backend\BlocktrailConverter;
 use Blocktrail\SDK\Backend\BtccomConverter;
 use Blocktrail\SDK\Backend\ConverterInterface;
 use Blocktrail\SDK\Bitcoin\BIP32Key;

Spacing +11 added lines, -14 removed lines

@@ -102,7 +102,7 @@ 
 
         $this->blocktrailClient = new RestClient($apiEndpoint, $apiVersion, $apiKey, $apiSecret);
         $this->dataClient = new RestClient($btccomEndpoint, $apiVersion, $apiKey, $apiSecret);
-        $this->btccomRawTxClient = new RestClient(($this->testnet ? "t" : "") . "chain.btc.com", $apiVersion, $apiKey, $apiSecret);
+        $this->btccomRawTxClient = new RestClient(($this->testnet ? "t" : "")."chain.btc.com", $apiVersion, $apiKey, $apiSecret);
 
         $this->converter = new BtccomConverter();
     }
@@ -642,7 +642,7 @@ 
             } else {
                 // create new primary seed
                 /** @var HierarchicalKey $primaryPrivateKey */
-                list($primaryMnemonic, , $primaryPrivateKey) = $this->newPrimarySeed($options['passphrase']);
+                list($primaryMnemonic,, $primaryPrivateKey) = $this->newPrimarySeed($options['passphrase']);
                 if ($storePrimaryMnemonic !== false) {
                     $storePrimaryMnemonic = true;
                 }
@@ -681,7 +681,7 @@ 
         $backupPublicKey = null;
         if (!isset($options['backup_mnemonic']) && !isset($options['backup_public_key'])) {
             /** @var HierarchicalKey $backupPrivateKey */
-            list($backupMnemonic, , ) = $this->newBackupSeed();
+            list($backupMnemonic,,) = $this->newBackupSeed();
         } else if (isset($options['backup_mnemonic'])) {
             $backupMnemonic = $options['backup_mnemonic'];
         } elseif (isset($options['backup_public_key'])) {
@@ -714,7 +714,7 @@ 
         );
 
         // received the blocktrail public keys
-        $blocktrailPublicKeys = Util::arrayMapWithIndex(function ($keyIndex, $pubKeyTuple) {
+        $blocktrailPublicKeys = Util::arrayMapWithIndex(function($keyIndex, $pubKeyTuple) {
             return [$keyIndex, BIP32Key::create(HierarchicalKeyFactory::fromExtended($pubKeyTuple[0]), $pubKeyTuple[1])];
         }, $data['blocktrail_public_keys']);
 
@@ -836,7 +836,7 @@ 
         );
 
         // received the blocktrail public keys
-        $blocktrailPublicKeys = Util::arrayMapWithIndex(function ($keyIndex, $pubKeyTuple) {
+        $blocktrailPublicKeys = Util::arrayMapWithIndex(function($keyIndex, $pubKeyTuple) {
             return [$keyIndex, BIP32Key::create(HierarchicalKeyFactory::fromExtended($pubKeyTuple[0]), $pubKeyTuple[1])];
         }, $data['blocktrail_public_keys']);
 
@@ -871,7 +871,7 @@ 
                 'backup_seed' => $backupSeed ? MnemonicFactory::bip39()->entropyToMnemonic(new Buffer($backupSeed)) : null,
                 'recovery_encrypted_secret' => $recoveryEncryptedSecret ? MnemonicFactory::bip39()->entropyToMnemonic(new Buffer(base64_decode($recoveryEncryptedSecret))) : null,
                 'encrypted_secret' => $encryptedSecret ? MnemonicFactory::bip39()->entropyToMnemonic(new Buffer(base64_decode($encryptedSecret))) : null,
-                'blocktrail_public_keys' => Util::arrayMapWithIndex(function ($keyIndex, BIP32Key $pubKey) {
+                'blocktrail_public_keys' => Util::arrayMapWithIndex(function($keyIndex, BIP32Key $pubKey) {
                     return [$keyIndex, $pubKey->tuple()];
                 }, $blocktrailPublicKeys),
             ],
@@ -978,7 +978,7 @@ 
         );
 
         // received the blocktrail public keys
-        $blocktrailPublicKeys = Util::arrayMapWithIndex(function ($keyIndex, $pubKeyTuple) {
+        $blocktrailPublicKeys = Util::arrayMapWithIndex(function($keyIndex, $pubKeyTuple) {
             return [$keyIndex, BIP32Key::create(HierarchicalKeyFactory::fromExtended($pubKeyTuple[0]), $pubKeyTuple[1])];
         }, $data['blocktrail_public_keys']);
 
@@ -1013,7 +1013,7 @@ 
                 'backup_seed'               => $backupSeed ? MnemonicFactory::bip39()->entropyToMnemonic($backupSeed) : null,
                 'recovery_encrypted_secret' => $recoveryEncryptedSecret ? EncryptionMnemonic::encode($recoveryEncryptedSecret) : null,
                 'encrypted_secret'          => $encryptedSecret ? EncryptionMnemonic::encode($encryptedSecret) : null,
-                'blocktrail_public_keys'    => Util::arrayMapWithIndex(function ($keyIndex, BIP32Key $pubKey) {
+                'blocktrail_public_keys'    => Util::arrayMapWithIndex(function($keyIndex, BIP32Key $pubKey) {
                     return [$keyIndex, $pubKey->tuple()];
                 }, $blocktrailPublicKeys),
             ]
@@ -1207,10 +1207,7 @@ 
         }
 
         $identifier = $options['identifier'];
-        $readonly = isset($options['readonly']) ? $options['readonly'] :
-                    (isset($options['readOnly']) ? $options['readOnly'] :
-                        (isset($options['read-only']) ? $options['read-only'] :
-                            false));
+        $readonly = isset($options['readonly']) ? $options['readonly'] : (isset($options['readOnly']) ? $options['readOnly'] : (isset($options['read-only']) ? $options['read-only'] : false));
 
         // get the wallet data from the server
         $data = $this->getWallet($identifier);
@@ -1909,7 +1906,7 @@ 
      */
     public static function sortMultisigKeys(array $pubKeys) {
         $result = array_values($pubKeys);
-        usort($result, function (PublicKeyInterface $a, PublicKeyInterface $b) {
+        usort($result, function(PublicKeyInterface $a, PublicKeyInterface $b) {
             $av = $a->getHex();
             $bv = $b->getHex();
             return $av == $bv ? 0 : $av > $bv ? 1 : -1;
@@ -1935,7 +1932,7 @@ 
     }
 
     public static function normalizeBIP32KeyArray($keys) {
-        return Util::arrayMapWithIndex(function ($idx, $key) {
+        return Util::arrayMapWithIndex(function($idx, $key) {
             return [$idx, self::normalizeBIP32Key($key)];
         }, $keys);
     }

src/Connection/RestClient.php

Doc Comments +3 added lines, -3 removed lines

@@ -29,9 +29,9 @@
     /**
      * GuzzleRestClient constructor.
      * @param $apiEndpoint
-     * @param $apiVersion
-     * @param $apiKey
-     * @param $apiSecret
+     * @param string $apiVersion
+     * @param string $apiKey
+     * @param string $apiSecret
      */
     public function __construct($apiEndpoint, $apiVersion, $apiKey, $apiSecret) {
         parent::__construct($apiEndpoint, $apiVersion, $apiKey, $apiSecret);

Spacing +3 added lines, -3 removed lines

@@ -61,7 +61,7 @@ 
             'handler' => $handler,
             'base_uri' => $this->apiEndpoint,
             'headers' => array(
-                'User-Agent' => Blocktrail::SDK_USER_AGENT . '/' . Blocktrail::SDK_VERSION,
+                'User-Agent' => Blocktrail::SDK_USER_AGENT.'/'.Blocktrail::SDK_VERSION,
             ),
             'http_errors' => false,
             'connect_timeout' => 3,
@@ -170,9 +170,9 @@ 
                 throw new ObjectNotFound($this->verboseErrors ? $body : Blocktrail::EXCEPTION_OBJECT_NOT_FOUND, $httpResponseCode);
             }
         } elseif ($httpResponseCode == 500) {
-            throw new GenericServerError(Blocktrail::EXCEPTION_GENERIC_SERVER_ERROR . "\nServer Response: " . $body, $httpResponseCode);
+            throw new GenericServerError(Blocktrail::EXCEPTION_GENERIC_SERVER_ERROR."\nServer Response: ".$body, $httpResponseCode);
         } else {
-            throw new GenericHTTPError(Blocktrail::EXCEPTION_GENERIC_HTTP_ERROR . "\nServer Response: " . $body, $httpResponseCode);
+            throw new GenericHTTPError(Blocktrail::EXCEPTION_GENERIC_HTTP_ERROR."\nServer Response: ".$body, $httpResponseCode);
         }
     }
 

src/Backend/BtccomConverter.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     public function getUrlForTransactions($txIds) {
-        return "tx/" . implode(",", $txIds) . "?verbose=3";
+        return "tx/".implode(",", $txIds)."?verbose=3";
     }
 
     public function getUrlForBlockTransaction($blockHash) {
@@ -227,7 +227,7 @@ 
         }
 
         $data['total_input_value'] = $totalInputValue;
-        $data['total_output_value'] = array_reduce($tx['outputs'], function ($total, $output) {
+        $data['total_output_value'] = array_reduce($tx['outputs'], function($total, $output) {
             return $total + $output['value'];
         }, 0);
         $data['total_fee'] = $tx['fee'];

src/Backend/BlocktrailConverter.php

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
     }
 
     public function getUrlForTransactions($txIds) {
-        return "transactions/" . implode(",", $txIds);
+        return "transactions/".implode(",", $txIds);
     }
 
     public function getUrlForBlockTransaction($blockHash) {