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;

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

Spacing +7 added lines, -7 removed lines

@@ -73,7 +73,7 @@ 
         $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,12 +87,12 @@ 
             $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))
                 ->setBackgroundColor(array('r' => 255, 'g' => 255, 'b' => 255, 'a' => 0))
-                ->setLabel("KeyIndex: ".$keyIndex."    Path: ".$key->path())
+                ->setLabel("KeyIndex: " . $keyIndex . "    Path: " . $key->path())
                 ->setLabelFontSize(10)
             ;
             $this->blocktrailPubKeyQRs[] = array(
@@ -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
@@ -315,11 +315,11 @@ 
         //3. Bloctrail pub key QR codes
         $backupContent[] = array('font-size' => 12, 'line-height' => 30, 'text' => '');
         $backupContent[] = array('font-size' => 14, 'line-height' => 20, 'text' => 'Blocktrail Public Keys');
-        $backupContent[] = array('font-size' => 10, 'line-height' => 24, 'text' => $totalPubKeys.' in total');
+        $backupContent[] = array('font-size' => 10, 'line-height' => 24, 'text' => $totalPubKeys . ' in total');
 
 
         //Merge all the text content together and print to image
-        $font = $this->fontsPath.'/OpenSans-Regular.ttf';
+        $font = $this->fontsPath . '/OpenSans-Regular.ttf';
         $content = array_merge($introContent, $backupContent);
         $leftMargin = 15;
         $topMargin = 25;
@@ -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++;

Indentation -1 removed lines

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

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

Spacing +2 added lines, -5 removed lines

@@ -298,7 +298,7 @@ 
      * @return array                    associative array containing the response
      */
     public function getWebhook($identifier) {
-        $response = $this->client->get("webhook/".$identifier);
+        $response = $this->client->get("webhook/" . $identifier);
         return self::jsonDecode($response->body(), true);
     }
 
@@ -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);

Indentation -1 removed lines

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

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;

src/Wallet.php

Doc Comments +13 added lines, -10 removed lines

@@ -191,7 +191,7 @@ 
      *
      * @param          $options ['primary_private_key' => key] OR ['passphrase' => pass]
      * @param callable $fn
-     * @return bool
+     * @return boolean|null
      * @throws \Exception
      */
     public function unlock($options, callable $fn = null) {
@@ -330,7 +330,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key|false
      * @throws \Exception
      *
@@ -357,7 +357,7 @@ 
     /**
      * get address for the specified path
      *
-     * @param string|BIP32Path  $path
+     * @param string  $path
      * @return string
      */
     public function getAddressByPath($path) {
@@ -393,7 +393,7 @@ 
 
     /**
      * @param BIP32Key          $key
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return string
      */
     protected function getAddressFromKey(BIP32Key $key, $path) {
@@ -434,7 +434,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key
      * @throws \Exception
      */
@@ -568,7 +568,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
@@ -682,6 +682,9 @@ 
         return [$inputs, $send];
     }
 
+    /**
+     * @param integer $optimalFeePerKB
+     */
     public function determineFeeAndChange(TransactionBuilder $txBuilder, $optimalFeePerKB) {
         $send = $txBuilder->getOutputs();
         $utxos = $txBuilder->getUtxos();
@@ -794,7 +797,7 @@ 
      *
      * @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) {
@@ -816,7 +819,7 @@ 
     /**
      * @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
@@ -826,7 +829,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);
@@ -880,7 +883,7 @@ 
      *
      * @param UTXO[]  $utxos
      * @param array[] $outputs
-     * @param         $feeStrategy
+     * @param         string $feeStrategy
      * @param         $optimalFeePerKB
      * @return int
      * @throws BlocktrailSDKException

Indentation -1 removed lines

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

Spacing +9 added lines, -9 removed lines

@@ -142,10 +142,10 @@ 
 
         $this->primaryMnemonic = $primaryMnemonic;
         $this->backupPublicKey = BIP32Key::create($backupPublicKey);
-        $this->primaryPublicKeys = array_map(function ($key) {
+        $this->primaryPublicKeys = array_map(function($key) {
             return BIP32Key::create($key);
         }, $primaryPublicKeys);
-        $this->blocktrailPublicKeys = array_map(function ($key) {
+        $this->blocktrailPublicKeys = array_map(function($key) {
             return BIP32Key::create($key);
         }, $blocktrailPublicKeys);
 
@@ -181,7 +181,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);
     }
@@ -363,7 +363,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;
@@ -641,7 +641,7 @@ 
             }
         }
 
-        if (array_sum(array_map(function (UTXO $utxo) { return $utxo->value; }, $utxos)) < array_sum(array_column($send, 'value'))) {
+        if (array_sum(array_map(function(UTXO $utxo) { return $utxo->value; }, $utxos)) < array_sum(array_column($send, 'value'))) {
             throw new \Exception("Atempting to spend more than sum of UTXOs");
         }
 
@@ -661,7 +661,7 @@ 
         }
 
         // create raw transaction
-        $inputs = array_map(function (UTXO $utxo) {
+        $inputs = array_map(function(UTXO $utxo) {
             return [
                 'txid' => $utxo->hash,
                 'vout' => (int)$utxo->index,
@@ -841,7 +841,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";
 
@@ -918,7 +918,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'));
@@ -962,7 +962,7 @@ 
             }
         }
 
-        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);

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

@@ -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,12 +260,12 @@ 
                     $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);
 
                     if ($this->debug) {
-                        echo "\nfound ".count($outputs)." unspent outputs in address $address";
+                        echo "\nfound " . count($outputs) . " unspent outputs in address $address";
                     }
                 }
 
@@ -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);