blocktrail / blocktrail-sdk-php

examples/op_return_payment_api_example.php

Unused Use Statements -1 removed lines

@@ -1,6 +1,5 @@
 <?php
 
-use BitWasp\BitcoinLib\RawTransaction;
 use Blocktrail\SDK\Blocktrail;
 use Blocktrail\SDK\BlocktrailSDK;
 use Blocktrail\SDK\Connection\Exceptions\ObjectNotFound;

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 
 use Blocktrail\SDK\BlocktrailSDK;
 
-require_once __DIR__ . "/../vendor/autoload.php";
+require_once __DIR__."/../vendor/autoload.php";
 
 /*
     This simple example shows how to get the payload when your webhook is called.

src/BackupGenerator.php

Doc Comments +1 added lines, -1 removed lines

@@ -262,7 +262,7 @@
      * generate image file of backup details, ready to
      *
      * @param null $filename        filename to save image as (optional - if ommited raw image stream is outputted instead)
-     * @return bool
+     * @return null|boolean
      */
     public function generateImg($filename = null) {
         //create blocktrail pub key QR codes if not already done

Indentation -1 removed lines

@@ -55,7 +55,6 @@
 
     /**
      * BIP32 master backup public key (M/)
-
      * @var BIP32Key
      */
     protected $backupPublicKey;

Spacing +6 added lines, -6 removed lines

@@ -64,16 +64,16 @@ 
             define('DOMPDF_ENABLE_AUTOLOAD', false);
 
             //try the different possible locations for the config file, depending on if the sdk is included as a dependency or is the main project itself
-            (@include_once __DIR__ . '/../../../dompdf/dompdf/dompdf_config.inc.php') || @include_once __DIR__ . '/../vendor/dompdf/dompdf/dompdf_config.inc.php';
+            (@include_once __DIR__.'/../../../dompdf/dompdf/dompdf_config.inc.php') || @include_once __DIR__.'/../vendor/dompdf/dompdf/dompdf_config.inc.php';
         }
 
         //set the fonts path
-        $this->fontsPath = dirname(__FILE__) . '/../resources/fonts';
+        $this->fontsPath = dirname(__FILE__).'/../resources/fonts';
 
         $this->primaryMnemonic = $primaryMnemonic;
         $this->backupMnemonic = $backupMnemonic;
 
-        $this->blocktrailPublicKeys = array_map(function ($key) {
+        $this->blocktrailPublicKeys = array_map(function($key) {
             return BIP32Key::create($key); // M/9999' or M/0' or M/1'
         }, $blocktrailPublicKeys);
     }
@@ -87,7 +87,7 @@ 
             $qrCode = new QrCode();
             $qrCode
                 ->setText($key->key())
-                ->setSize(self::QR_CODE_SIZE-20)
+                ->setSize(self::QR_CODE_SIZE - 20)
                 ->setPadding(10)
                 ->setErrorCorrection('high')
                 ->setForegroundColor(array('r' => 0, 'g' => 0, 'b' => 0, 'a' => 0))
@@ -271,7 +271,7 @@ 
         }
         //create the image canvas - use the count of blocktrail pub keys to augment appropriately
         $totalPubKeys = count($this->blocktrailPubKeyQRs);
-        $increaseCanvas = ceil($totalPubKeys/4) * (self::QR_CODE_SIZE + 30);
+        $increaseCanvas = ceil($totalPubKeys / 4) * (self::QR_CODE_SIZE + 30);
         $image = imagecreatetruecolor(1024, 600 + $increaseCanvas);
 
         //create colours
@@ -334,7 +334,7 @@ 
         $xPos = $leftMargin;
         $i = 0;
         foreach ($this->blocktrailPubKeyQRs as $btPubKey) {
-            imagecopy($image, $btPubKey['qrImg'], $xPos, $yPos, 0, 0, self::QR_CODE_SIZE, self::QR_CODE_SIZE+20);
+            imagecopy($image, $btPubKey['qrImg'], $xPos, $yPos, 0, 0, self::QR_CODE_SIZE, self::QR_CODE_SIZE + 20);
 
             //increment to help decide when to start a new row
             $i++;

src/Bitcoin/BIP32Key.php

Doc Comments +2 added lines, -2 removed lines

@@ -75,7 +75,7 @@ 
     /**
      * get tuple of the key and path, the way BitcoinLib likes it
      *
-     * @return array        [key, path]
+     * @return string[]        [key, path]
      */
     public function tuple() {
         return [$this->key, (string)$this->path];
@@ -91,7 +91,7 @@ 
     /**
      * build child key
      *
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key
      * @throws \Exception
      */

src/BlocktrailSDK.php

Doc Comments +4 added lines, -4 removed lines

@@ -59,7 +59,7 @@ 
      * normalize network string
      *
      * @param $network
-     * @param $testnet
+     * @param boolean $testnet
      * @return array
      * @throws \Exception
      */
@@ -1089,7 +1089,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);
@@ -1119,7 +1119,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);
@@ -1128,7 +1128,7 @@ 
     /**
      * json_decode helper that throws exceptions when it fails to decode
      *
-     * @param      $json
+     * @param      string $json
      * @param bool $assoc
      * @return mixed
      * @throws \Exception

Indentation -1 removed lines

@@ -55,7 +55,6 @@
 
     /**
      * BIP32 master backup public key (M/)
-
      * @var BIP32Key
      */
     protected $backupPublicKey;

Spacing +2 added lines, -5 removed lines

@@ -92,7 +92,7 @@ 
      * @param $testnet
      */
     protected function setBitcoinLibMagicBytes($network, $testnet) {
-        BitcoinLib::setMagicByteDefaults($network . ($testnet ? '-testnet' : ''));
+        BitcoinLib::setMagicByteDefaults($network.($testnet ? '-testnet' : ''));
     }
 
     /**
@@ -648,10 +648,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);

src/BlocktrailSDKInterface.php

Doc Comments +13 added lines, -5 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);
 
@@ -371,7 +379,7 @@ 
      *
      * @param string    $identifier             the identifier of the wallet
      * @param string    $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,22 +451,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);
 
     /**

Indentation -1 removed lines

@@ -55,7 +55,6 @@
 
     /**
      * BIP32 master backup public key (M/)
-
      * @var BIP32Key
      */
     protected $backupPublicKey;

src/Connection/RestClient.php

Doc Comments +5 added lines

@@ -44,6 +44,11 @@
      */
     protected $verboseErrors = false;
 
+    /**
+     * @param string $apiVersion
+     * @param string $apiKey
+     * @param string $apiSecret
+     */
     public function __construct($apiEndpoint, $apiVersion, $apiKey, $apiSecret) {
         $this->guzzle = new Guzzle(array(
             'base_url' => $apiEndpoint,

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use GuzzleHttp\Client as Guzzle;
 use GuzzleHttp\Message\RequestInterface;
 use GuzzleHttp\Message\ResponseInterface;
-use GuzzleHttp\Post\PostBodyInterface;
 use GuzzleHttp\Query;
 use GuzzleHttp\Stream\Stream;
 use HttpSignatures\Context;

Spacing +4 added lines, -4 removed lines

@@ -49,7 +49,7 @@ 
             'base_url' => $apiEndpoint,
             'defaults' => array(
                 'headers' => array(
-                    'User-Agent' => Blocktrail::SDK_USER_AGENT . '/' . Blocktrail::SDK_VERSION
+                    'User-Agent' => Blocktrail::SDK_USER_AGENT.'/'.Blocktrail::SDK_VERSION
                 ),
                 'exceptions' => false,
                 'connect_timeout' => 3,
@@ -213,7 +213,7 @@ 
             $request->setHeader('Content-MD5', md5((string)$body));
         } else {
             $qs = (string)$request->getQuery();
-            $request->setHeader('Content-MD5', md5($request->getPath() . ($qs ? "?{$qs}" : "")));
+            $request->setHeader('Content-MD5', md5($request->getPath().($qs ? "?{$qs}" : "")));
         }
 
         if ($auth !== null) {
@@ -276,9 +276,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/WalletInterface.php

Doc Comments +2 added lines, -1 removed lines

@@ -24,6 +24,7 @@ 
      * @param string                        $network
      * @param bool                          $testnet
      * @param string                        $checksum
+     * @return void
      */
     public function __construct(BlocktrailSDKInterface $sdk, $identifier, $primaryMnemonic, $primaryPublicKey, $backupPublicKey, $blocktrailPublicKeys, $keyIndex, $network, $testnet, $checksum);
 
@@ -92,7 +93,7 @@ 
      * get address and redeemScript for specified path
      *
      * @param string    $path
-     * @return array[string, string]     [address, redeemScript]
+     * @return string[] string]     [address, redeemScript]
      */
     public function getRedeemScriptByPath($path);
 

src/WalletSweeper.php

Doc Comments +9 added lines, -9 removed lines

@@ -120,8 +120,8 @@ 
     /**
      * normalize network string
      *
-     * @param $network
-     * @param $testnet
+     * @param string $network
+     * @param boolean $testnet
      * @return array
      * @throws \Exception
      */
@@ -151,8 +151,8 @@ 
     /**
      * generate multisig address for given path
      *
-     * @param $path
-     * @return array
+     * @param string $path
+     * @return string[]
      * @throws \Exception
      */
     protected function createAddress($path) {
@@ -175,8 +175,8 @@ 
     /**
      * create a batch of multisig addresses
      *
-     * @param $start
-     * @param $count
+     * @param integer $start
+     * @param integer $count
      * @param $keyIndex
      * @return array
      */
@@ -205,7 +205,7 @@ 
     /**
      * gets the blocktrail pub key for the given path from the stored array of pub keys
      *
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key
      * @throws \Exception
      */
@@ -315,7 +315,7 @@ 
     /**
      * create a signed transaction sending all the found outputs to the given address
      *
-     * @param $destinationAddress
+     * @param string $destinationAddress
      * @return array
      * @throws \Exception
      */
@@ -369,7 +369,7 @@ 
     /**
      * signs a raw transaction
      *
-     * @param $rawTransaction
+     * @param string $rawTransaction
      * @param $inputs
      * @return array
      */

Spacing +6 added lines, -6 removed lines

@@ -78,7 +78,7 @@ 
     public function __construct($primaryMnemonic, $primaryPassphrase, $backupMnemonic, array $blocktrailPublicKeys, BlockchainDataServiceInterface $bitcoinClient, $network = 'btc', $testnet = false) {
         // normalize network and set bitcoinlib to the right magic-bytes
         list($this->network, $this->testnet) = $this->normalizeNetwork($network, $testnet);
-        BitcoinLib::setMagicByteDefaults($this->network . ($this->testnet ? '-testnet' : ''));
+        BitcoinLib::setMagicByteDefaults($this->network.($this->testnet ? '-testnet' : ''));
 
         //create BIP32 keys for the Blocktrail public keys
         foreach ($blocktrailPublicKeys as $blocktrailKey) {
@@ -185,7 +185,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) = $this->createAddress($path);
             $addresses[$address] = array(
                 //'address' => $address,
@@ -232,7 +232,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) {
@@ -260,7 +260,7 @@ 
                     $totalUTXOs += count($outputs);
 
                     //add up the total utxo value for all addresses
-                    $totalBalance = array_reduce($outputs, function ($carry, $output) {
+                    $totalBalance = array_reduce($outputs, function($carry, $output) {
                         return $carry += $output['value'];
                     }, $totalBalance);
 
@@ -329,7 +329,7 @@ 
         foreach ($this->sweepData['utxos'] as $address => $data) {
             $inputs = array_merge(
                 $inputs,
-                array_map(function ($utxo) use ($address, $data) {
+                array_map(function($utxo) use ($address, $data) {
                     return [
                         'txid' => $utxo['hash'],
                         'vout' => $utxo['index'],
@@ -387,7 +387,7 @@ 
         }
 
         //add the keys and redeem scripts to a wallet to sign the transaction with
-        BIP32::bip32_keys_to_wallet($wallet, array_map(function (BIP32Key $key) {
+        BIP32::bip32_keys_to_wallet($wallet, array_map(function(BIP32Key $key) {
             return $key->tuple();
         }, $keys));
         RawTransaction::redeem_scripts_to_wallet($wallet, $redeemScripts);

coverage-checker.php

Spacing +7 added lines, -7 removed lines

@@ -10,7 +10,7 @@ 
 }
 
 $inputFile  = $argv[1];
-$percentage = min(100, max(0, (int) $argv[2]));
+$percentage = min(100, max(0, (int)$argv[2]));
 
 if (!file_exists($inputFile)) {
     throw new InvalidArgumentException('Invalid input file provided');
@@ -26,10 +26,10 @@ 
 $checkedElements = 0;
 
 $excludes = [
-    "/^Blocktrail\\\\SDK\\\\Console/",  // just wrappers and a pain in the ass to test
-    "/Compiler\\.php/",                 // just a tool and copy paste from Composer
-    "/BackupGenerator\\.php/",          // tmp excluding, it's rather hard to test the whole process
-    "/WalletSweeper\\.php/",            // because we're running it's test without coverage (because xdebug is REALLY slow)
+    "/^Blocktrail\\\\SDK\\\\Console/", // just wrappers and a pain in the ass to test
+    "/Compiler\\.php/", // just a tool and copy paste from Composer
+    "/BackupGenerator\\.php/", // tmp excluding, it's rather hard to test the whole process
+    "/WalletSweeper\\.php/", // because we're running it's test without coverage (because xdebug is REALLY slow)
 ];
 
 foreach ($xml->xpath("//package") as $package) {
@@ -82,8 +82,8 @@ 
 }
 
 foreach ($xml->xpath("//project/file/metrics") as $metric) {
-    $totalElements   += (int) $metric['elements'];
-    $checkedElements += (int) $metric['coveredelements'];
+    $totalElements   += (int)$metric['elements'];
+    $checkedElements += (int)$metric['coveredelements'];
 }
 
 var_dump($totalElements);