blocktrail / blocktrail-sdk-php

src/Connection/RestClient.php

Spacing +4 added lines, -4 removed lines

@@ -101,7 +101,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,
@@ -246,7 +246,7 @@ 
             $contentMD5Mode = !is_null($body) ? 'body' : 'url';
         }
 
-        $request = new Request($method, $this->apiEndpoint . $endpointUrl);
+        $request = new Request($method, $this->apiEndpoint.$endpointUrl);
         $uri = $request->getUri();
 
         if ($queryString) {
@@ -341,9 +341,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/SizeEstimation.php

Spacing +3 added lines, -3 removed lines

@@ -184,12 +184,12 @@
         assert($witnessScript === null || $isWitness);
         $classifier = new OutputClassifier();
         if ($classifier->isMultisig($script)) {
-            list ($stackSizes, ) = SizeEstimation::estimateMultisigStackSize(new Multisig($script));
+            list ($stackSizes,) = SizeEstimation::estimateMultisigStackSize(new Multisig($script));
         } else if ($classifier->isPayToPublicKey($script)) {
-            list ($stackSizes, ) = SizeEstimation::estimateP2PKStackSize(new PayToPubKey($script));
+            list ($stackSizes,) = SizeEstimation::estimateP2PKStackSize(new PayToPubKey($script));
         } else if ($classifier->isPayToPublicKeyHash($script)) {
             // defaults to compressed, tough luck
-            list ($stackSizes, ) = SizeEstimation::estimateP2PKHStackSize();
+            list ($stackSizes,) = SizeEstimation::estimateP2PKHStackSize();
         } else {
             throw new \InvalidArgumentException("Unsupported script type");
         }

src/WalletScript.php

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
      * @param bool $setting
      */
     public static function enforceScriptChecks($setting) {
-        static::$checkScripts = (bool) $setting;
+        static::$checkScripts = (bool)$setting;
     }
 
     /**

src/TransactionBuilder.php

Spacing +3 added lines, -3 removed lines

@@ -107,7 +107,7 @@ 
         }
 
         if ($value <= Blocktrail::DUST) {
-            throw new \Exception("Values should be more than dust (" . Blocktrail::DUST . ")");
+            throw new \Exception("Values should be more than dust (".Blocktrail::DUST.")");
         }
 
         if ($object instanceof SegwitAddress) {
@@ -162,7 +162,7 @@ 
         }
 
         if ($value <= Blocktrail::DUST) {
-            throw new \Exception("Values should be more than dust (" . Blocktrail::DUST . ")");
+            throw new \Exception("Values should be more than dust (".Blocktrail::DUST.")");
         }
 
         if (!isset($this->outputs[$idx])) {
@@ -208,7 +208,7 @@ 
      * @return array
      */
     public function getOutputs($json = false) {
-        return array_map(function ($output) use ($json) {
+        return array_map(function($output) use ($json) {
             $result = $output;
 
             if ($json) {

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use BitWasp\Bitcoin\Address\AddressFactory;
 use BitWasp\Bitcoin\Address\AddressInterface;
 use BitWasp\Bitcoin\Address\SegwitAddress;
-use BitWasp\Bitcoin\Script\Script;
 use BitWasp\Bitcoin\Script\ScriptFactory;
 use BitWasp\Bitcoin\Script\ScriptInterface;
 use BitWasp\Buffertools\Buffer;

src/WalletSweeper.php

Spacing +5 added lines, -5 removed lines

@@ -163,7 +163,7 @@ 
             $this->getBlocktrailPublicKey($path)->buildKey($path)->publicKey()
         ]), false);
 
-        if ($this->network !== "bitcoincash" && (int) $path[2] === 2) {
+        if ($this->network !== "bitcoincash" && (int)$path[2] === 2) {
             $witnessScript = new WitnessScript($multisig);
             $redeemScript = new P2shScript($witnessScript);
             $address = $redeemScript->getAddress()->getAddress();
@@ -189,7 +189,7 @@ 
 
         for ($i = 0; $i < $count; $i++) {
             //create a path subsequent address
-            $path = (string)WalletPath::create($keyIndex, $_chain = 0, $start+$i)->path()->publicPath();
+            $path = (string)WalletPath::create($keyIndex, $_chain = 0, $start + $i)->path()->publicPath();
             list($address, $redeem, $witness) = $this->createAddress($path);
             $addresses[$address] = array(
                 //'address' => $address,
@@ -238,7 +238,7 @@ 
         $totalUTXOs = 0;
         $totalAddressesGenerated = 0;
 
-        $addressUTXOs = array();    //addresses and their utxos, paths and redeem scripts
+        $addressUTXOs = array(); //addresses and their utxos, paths and redeem scripts
 
         //for each blocktrail pub key, do fund discovery on batches of addresses
         foreach ($this->blocktrailPublicKeys as $keyIndex => $blocktrailPubKey) {
@@ -274,7 +274,7 @@ 
                     }
 
                     $addressUTXOs[$address]['utxos'][] = $utxo;
-                    $totalUTXOs ++;
+                    $totalUTXOs++;
 
                     //add up the total utxo value for all addresses
                     $totalBalance += $utxo['value'];
@@ -389,7 +389,7 @@ 
             $signer->redeemBitcoinCash(true);
         }
 
-        assert(Util::all(function ($signInfo) {
+        assert(Util::all(function($signInfo) {
             return $signInfo instanceof SignInfo;
         }, $signInfo), '$signInfo should be SignInfo[]');
 

src/BlocktrailSDKInterface.php

Doc Comments +15 added lines, -7 removed lines

@@ -9,6 +9,11 @@ 
  */
 interface BlocktrailSDKInterface {
 
+    /**
+     * @param string $apiSecret
+     *
+     * @return void
+     */
     public function __construct($apiKey, $apiSecret, $network = 'BTC', $testnet = false, $apiVersion = 'v1', $apiEndpoint = null);
 
     /**
@@ -17,6 +22,7 @@ 
      * @param   bool        $debug
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setCurlDebugging($debug = true);
 
@@ -26,6 +32,7 @@ 
      * @param   bool        $verboseErrors
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setVerboseErrors($verboseErrors = true);
     
@@ -35,6 +42,7 @@ 
      * @param bool      $value
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setCurlDefaultOption($key, $value);
 
@@ -311,7 +319,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);
@@ -415,7 +423,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
      * @return string                           the complete raw transaction
      * @throws \Exception
@@ -443,7 +451,7 @@ 
      * ]
      *
      * @param string   $identifier              the identifier of the wallet
-     * @param array    $outputs                 the outputs you want to create - array[address => satoshi-value]
+     * @param \array[]    $outputs                 the outputs you want to create - array[address => satoshi-value]
      * @param bool     $lockUTXO                when TRUE the UTXOs selected will be locked for a few seconds
      *                                          so you have some time to spend them without race-conditions
      * @param bool     $allowZeroConf
@@ -487,22 +495,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);
 
     /**

src/Wallet.php

Doc Comments +14 added lines, -10 removed lines

@@ -308,7 +308,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key|false
      * @throws \Exception
      *
@@ -335,7 +335,7 @@ 
     /**
      * get address for the specified path
      *
-     * @param string|BIP32Path  $path
+     * @param string  $path
      * @return string
      */
     public function getAddressByPath($path) {
@@ -432,7 +432,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key
      * @throws \Exception
      */
@@ -581,7 +581,7 @@ 
      * 'fund' the txBuilder with UTXOs (modified in place)
      *
      * @param TransactionBuilder    $txBuilder
-     * @param bool|true             $lockUTXOs
+     * @param boolean             $lockUTXOs
      * @param bool|false            $allowZeroConf
      * @param null|int              $forceFee
      * @return TransactionBuilder
@@ -703,6 +703,10 @@ 
         return [$txb->get(), $signInfo];
     }
 
+    /**
+     * @param integer $optimalFeePerKB
+     * @param integer $lowPriorityFeePerKB
+     */
     public function determineFeeAndChange(TransactionBuilder $txBuilder, $optimalFeePerKB, $lowPriorityFeePerKB) {
         $send = $txBuilder->getOutputs();
         $utxos = $txBuilder->getUtxos();
@@ -816,7 +820,7 @@ 
      * @todo: mark this as deprecated, insist on the utxo's or qualified scripts.
      * @param int $utxoCnt      number of unspent inputs in transaction
      * @param int $outputCnt    number of outputs in transaction
-     * @return float
+     * @return integer
      * @access public           reminder that people might use this!
      */
     public static function estimateFee($utxoCnt, $outputCnt) {
@@ -839,7 +843,7 @@ 
      * @todo: variable varint
      * @param int $txinSize
      * @param int $txoutSize
-     * @return float
+     * @return integer
      */
     public static function estimateSize($txinSize, $txoutSize) {
         return 4 + 4 + $txinSize + 4 + $txoutSize + 4; // version + txinVarInt + txin + txoutVarInt + txout + locktime
@@ -849,7 +853,7 @@ 
      * only supports estimating size for P2PKH/P2SH outputs
      *
      * @param int $outputCnt    number of outputs in transaction
-     * @return float
+     * @return integer
      */
     public static function estimateSizeOutputs($outputCnt) {
         return ($outputCnt * 34);
@@ -904,7 +908,7 @@ 
      *
      * @param UTXO[]  $utxos
      * @param array[] $outputs
-     * @param         $feeStrategy
+     * @param         string $feeStrategy
      * @param         $optimalFeePerKB
      * @param         $lowPriorityFeePerKB
      * @return int
@@ -1003,8 +1007,8 @@ 
      * @param \array[] $outputs
      * @param bool $lockUTXO
      * @param bool $allowZeroConf
-     * @param int|null|string $feeStrategy
-     * @param null $forceFee
+     * @param string $feeStrategy
+     * @param null|integer $forceFee
      * @return array
      */
     public function coinSelection($outputs, $lockUTXO = true, $allowZeroConf = false, $feeStrategy = self::FEE_STRATEGY_OPTIMAL, $forceFee = null) {

Spacing +8 added lines, -8 removed lines

@@ -213,7 +213,7 @@ 
      * @return array[]      [ [xpub, path] ]
      */
     public function getBlocktrailPublicKeys() {
-        return array_map(function (BIP32Key $key) {
+        return array_map(function(BIP32Key $key) {
             return $key->tuple();
         }, $this->blocktrailPublicKeys);
     }
@@ -336,7 +336,7 @@ 
     public function getAddressByPath($path) {
         $path = (string)BIP32Path::path($path)->privatePath();
         if (!isset($this->derivations[$path])) {
-            list($address, ) = $this->getRedeemScriptByPath($path);
+            list($address,) = $this->getRedeemScriptByPath($path);
 
             $this->derivations[$path] = $address;
             $this->derivationsByAddress[$address] = $path;
@@ -660,7 +660,7 @@ 
             $signInfo[] = $utxo->getSignInfo();
         }
 
-        $utxoSum = array_sum(array_map(function (UTXO $utxo) {
+        $utxoSum = array_sum(array_map(function(UTXO $utxo) {
             return $utxo->value;
         }, $utxos));
         if ($utxoSum < array_sum(array_column($send, 'value'))) {
@@ -793,7 +793,7 @@ 
             throw new \Exception("Wallet needs to be unlocked to pay");
         }
 
-        assert(Util::all(function ($signInfo) {
+        assert(Util::all(function($signInfo) {
             return $signInfo instanceof SignInfo;
         }, $signInfo), '$signInfo should be SignInfo[]');
 
@@ -806,7 +806,7 @@ 
         ];
 
         // send the transaction
-        return $this->sendTransaction($txs, array_map(function (SignInfo $r) {
+        return $this->sendTransaction($txs, array_map(function(SignInfo $r) {
             return (string)$r->path;
         }, $signInfo), $apiCheckFee);
     }
@@ -865,7 +865,7 @@ 
     public static function estimateSizeUTXOs($utxoCnt) {
         $txinSize = 0;
 
-        for ($i=0; $i<$utxoCnt; $i++) {
+        for ($i = 0; $i < $utxoCnt; $i++) {
             // @TODO: proper size calculation, we only do multisig right now so it's hardcoded and then we guess the size ...
             $multisig = "2of3";
 
@@ -939,7 +939,7 @@ 
      * @return int
      */
     protected function determineChange($utxos, $outputs, $fee) {
-        $inputsTotal = array_sum(array_map(function (UTXO $utxo) {
+        $inputsTotal = array_sum(array_map(function(UTXO $utxo) {
             return $utxo->value;
         }, $utxos));
         $outputsTotal = array_sum(array_column($outputs, 'value'));
@@ -958,7 +958,7 @@ 
     protected function signTransaction(Transaction $tx, array $signInfo) {
         $signer = new Signer($tx, Bitcoin::getEcAdapter());
 
-        assert(Util::all(function ($signInfo) {
+        assert(Util::all(function($signInfo) {
             return $signInfo instanceof SignInfo;
         }, $signInfo), '$signInfo should be SignInfo[]');