blocktrail / blocktrail-sdk-php

src/BlocktrailSDK.php

Doc Comments +19 added lines, -11 removed lines

@@ -107,7 +107,7 @@ 
     /**
      * normalize network string
      *
-     * @param $network
+     * @param string $network
      * @param $testnet
      * @return array
      * @throws \Exception
@@ -764,6 +764,11 @@ 
         ];
     }
 
+    /**
+     * @param integer $bits
+     *
+     * @return string
+     */
     public function randomBits($bits) {
         return $this->randomBytes($bits / 8);
     }
@@ -1092,7 +1097,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
@@ -1120,10 +1125,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
@@ -1153,9 +1158,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
@@ -1889,7 +1894,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);
@@ -1919,7 +1924,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);
@@ -1980,6 +1985,9 @@ 
         }
     }
 
+    /**
+     * @param BIP32Key[] $keys
+     */
     public static function normalizeBIP32KeyArray($keys) {
         return Util::arrayMapWithIndex(function ($idx, $key) {
             return [$idx, self::normalizeBIP32Key($key)];

Spacing +11 added lines, -14 removed lines

@@ -90,7 +90,7 @@ 
 
         $btccomEndpoint = getenv('BLOCKTRAIL_SDK_BTCCOM_API_ENDPOINT');
         if (!$btccomEndpoint) {
-            $btccomEndpoint = "https://" . ($this->network === "bitcoincash" ? "bch-chain" : "chain") . ".api.btc.com";
+            $btccomEndpoint = "https://".($this->network === "bitcoincash" ? "bch-chain" : "chain").".api.btc.com";
         }
         $btccomEndpoint = "{$btccomEndpoint}/v3/";
 
@@ -668,7 +668,7 @@ 
             } else {
                 // create new primary seed
                 /** @var HierarchicalKey $primaryPrivateKey */
-                list($primaryMnemonic, , $primaryPrivateKey) = $this->newV1PrimarySeed($options['passphrase']);
+                list($primaryMnemonic,, $primaryPrivateKey) = $this->newV1PrimarySeed($options['passphrase']);
                 if ($storePrimaryMnemonic !== false) {
                     $storePrimaryMnemonic = true;
                 }
@@ -707,7 +707,7 @@ 
         $backupPublicKey = null;
         if (!isset($options['backup_mnemonic']) && !isset($options['backup_public_key'])) {
             /** @var HierarchicalKey $backupPrivateKey */
-            list($backupMnemonic, , ) = $this->newV1BackupSeed();
+            list($backupMnemonic,,) = $this->newV1BackupSeed();
         } else if (isset($options['backup_mnemonic'])) {
             $backupMnemonic = $options['backup_mnemonic'];
         } elseif (isset($options['backup_public_key'])) {
@@ -740,7 +740,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']);
 
@@ -859,7 +859,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']);
 
@@ -894,7 +894,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),
             ],
@@ -998,7 +998,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']);
 
@@ -1033,7 +1033,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),
             ]
@@ -1282,10 +1282,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);
@@ -1986,7 +1983,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;
@@ -2012,7 +2009,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/BlocktrailSDKInterface.php

Doc Comments +12 added lines, -6 removed lines

@@ -15,6 +15,7 @@ 
      * @param   bool        $debug
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setCurlDebugging($debug = true);
 
@@ -24,6 +25,7 @@ 
      * @param   bool        $verboseErrors
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setVerboseErrors($verboseErrors = true);
     
@@ -33,6 +35,7 @@ 
      * @param bool      $value
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setCurlDefaultOption($key, $value);
 
@@ -328,7 +331,7 @@ 
      *
      * @param string    $identifier             the wallet identifier to be upgraded
      * @param int       $keyIndex               the new account to use
-     * @param array     $primaryPublicKey       BIP32 extended public key - [key, path]
+     * @param string[]     $primaryPublicKey       BIP32 extended public key - [key, path]
      * @return mixed
      */
     public function upgradeKeyIndex($identifier, $keyIndex, $primaryPublicKey);
@@ -423,7 +426,7 @@ 
      *
      * @param string       $identifier     the identifier of the wallet
      * @param string|array $rawTransaction raw hex of the transaction (should be partially signed)
-     * @param array        $paths          list of the paths that were used for the UTXO
+     * @param string[]        $paths          list of the paths that were used for the UTXO
      * @param bool         $checkFee       let the server verify the fee after signing
      * @param null         $twoFactorToken
      * @return string                           the complete raw transaction
@@ -495,22 +498,22 @@ 
     /**
      * lock a specific unspent output
      *
-     * @param     $identifier
+     * @param     string $identifier
      * @param     $txHash
      * @param     $txIdx
      * @param int $ttl
      * @return
-     */
+     boolean
     public function lockWalletUTXO($identifier, $txHash, $txIdx, $ttl = 3);
 
     /**
      * unlock a specific unspent output
      *
-     * @param     $identifier
+     * @param     string $identifier
      * @param     $txHash
      * @param     $txIdx
      * @return
-     */
+     boolean
     public function unlockWalletUTXO($identifier, $txHash, $txIdx);
 
     /**
@@ -639,5 +642,8 @@ 
      */
     public static function sortMultisigKeys(array $pubKeys);
 
+    /**
+     * @return void
+     */
     public function shuffle($arr);
 }

src/WalletV3.php

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 use Blocktrail\SDK\Address\AddressReaderBase;
 use Blocktrail\SDK\Bitcoin\BIP32Key;
 use Blocktrail\SDK\Exceptions\BlocktrailSDKException;
-use Blocktrail\SDK\Exceptions\WalletDecryptException;
 use Btccom\JustEncrypt\Encryption;
 use Btccom\JustEncrypt\EncryptionMnemonic;