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.

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);

src/Bitcoin/BIP32Path.php

Spacing +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
     public function insert($insert, $offset) {
         $path = $this->path;
 
-        array_splice($path, $offset+1, 0, [$insert]);
+        array_splice($path, $offset + 1, 0, [$insert]);
 
         return new static($path);
     }
@@ -205,7 +205,7 @@ 
      * @return string
      */
     public function getLast() {
-        return $this->path[count($this->path)-1];
+        return $this->path[count($this->path) - 1];
     }
 
     /**

src/Wallet.php

Indentation -1 removed lines

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

Doc Comments +14 added lines, -10 removed lines

@@ -259,7 +259,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key|false
      * @throws \Exception
      *
@@ -286,7 +286,7 @@ 
     /**
      * get address for the specified path
      *
-     * @param string|BIP32Path  $path
+     * @param string  $path
      * @return string
      */
     public function getAddressByPath($path) {
@@ -360,7 +360,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key
      * @throws \Exception
      */
@@ -508,7 +508,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
@@ -629,6 +629,10 @@ 
         return [$txb->get(), $signInfo];
     }
 
+    /**
+     * @param integer $optimalFeePerKB
+     * @param integer $lowPriorityFeePerKB
+     */
     public function determineFeeAndChange(TransactionBuilder $txBuilder, $optimalFeePerKB, $lowPriorityFeePerKB) {
         $send = $txBuilder->getOutputs();
         $utxos = $txBuilder->getUtxos();
@@ -736,7 +740,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) {
@@ -758,7 +762,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
@@ -768,7 +772,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);
@@ -822,7 +826,7 @@ 
      *
      * @param UTXO[]  $utxos
      * @param array[] $outputs
-     * @param         $feeStrategy
+     * @param         string $feeStrategy
      * @param         $optimalFeePerKB
      * @param         $lowPriorityFeePerKB
      * @return int
@@ -921,8 +925,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

@@ -173,7 +173,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);
     }
@@ -292,7 +292,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;
@@ -584,7 +584,7 @@ 
         }
 
         if (array_sum(array_map(
-            function (UTXO $utxo) { return $utxo->value; },
+            function(UTXO $utxo) { return $utxo->value; },
             $utxos
         )) < array_sum(array_column($send, 'value'))) {
             throw new \Exception("Atempting to spend more than sum of UTXOs");
@@ -716,7 +716,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[]');
 
@@ -724,7 +724,7 @@ 
         $signed = $this->signTransaction($tx, $signInfo);
 
         // send the transaction
-        $finished = $this->sendTransaction($signed->getHex(), array_map(function (SignInfo $r) {
+        $finished = $this->sendTransaction($signed->getHex(), array_map(function(SignInfo $r) {
             return $r->path;
         }, $signInfo), $apiCheckFee);
 
@@ -783,7 +783,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";
 
@@ -868,7 +868,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'));
@@ -887,7 +887,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[]');
 

src/WalletPath.php

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     }
 
     protected static function BIP32Path(array $path) {
-        return BIP32Path::path(array_values(array_filter($path, function ($v) {
+        return BIP32Path::path(array_values(array_filter($path, function($v) {
             return $v !== null;
         })));
     }

src/BlocktrailSDK.php

Indentation -1 removed lines

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

Doc Comments +18 added lines, -10 removed lines

@@ -76,7 +76,7 @@ 
      * normalize network string
      *
      * @param $network
-     * @param $testnet
+     * @param boolean $testnet
      * @return array
      * @throws \Exception
      */
@@ -671,6 +671,11 @@ 
         ];
     }
 
+    /**
+     * @param integer $bits
+     *
+     * @return string
+     */
     public static function randomBits($bits) {
         return self::randomBytes($bits / 8);
     }
@@ -941,7 +946,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 string    $backupPublicKey        plain public key
      * @param string    $primaryMnemonic        mnemonic to store
      * @param string    $checksum               checksum to store
@@ -968,9 +973,9 @@ 
      * @param string $identifier       the wallet identifier to create
      * @param array  $primaryPublicKey BIP32 extended public key - [key, path]
      * @param string $backupPublicKey  plain public key
-     * @param        $encryptedPrimarySeed
-     * @param        $encryptedSecret
-     * @param        $recoverySecret
+     * @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
      * @return mixed
@@ -999,8 +1004,8 @@ 
      * @param string $identifier       the wallet identifier to create
      * @param array  $primaryPublicKey BIP32 extended public key - [key, path]
      * @param string $backupPublicKey  plain public key
-     * @param        $encryptedPrimarySeed
-     * @param        $encryptedSecret
+     * @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
@@ -1648,7 +1653,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);
@@ -1678,7 +1683,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);
@@ -1687,7 +1692,7 @@ 
     /**
      * json_decode helper that throws exceptions when it fails to decode
      *
-     * @param      $json
+     * @param      string $json
      * @param bool $assoc
      * @return mixed
      * @throws \Exception
@@ -1739,6 +1744,9 @@ 
         }
     }
 
+    /**
+     * @param BIP32Key[] $keys
+     */
     public static function normalizeBIP32KeyArray($keys) {
         return Util::arrayMapWithIndex(function ($idx, $key) {
             return [$idx, self::normalizeBIP32Key($key)];

Spacing +10 added lines, -13 removed lines

@@ -578,7 +578,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;
                 }
@@ -617,7 +617,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'])) {
@@ -641,7 +641,7 @@ 
         $data = $this->storeNewWalletV1($options['identifier'], $primaryPublicKey->tuple(), $backupPublicKey->tuple(), $primaryMnemonic, $checksum, $options['key_index']);
 
         // 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']);
 
@@ -759,7 +759,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']);
 
@@ -792,7 +792,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),
             ],
@@ -897,7 +897,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']);
 
@@ -930,7 +930,7 @@ 
                 'backup_seed'               => $backupSeed ? MnemonicFactory::bip39()->entropyToMnemonic($backupSeed) : null,
                 'recovery_encrypted_secret' => $recoveryEncryptedSecret ? Mnemonic::encode($recoveryEncryptedSecret) : null,
                 'encrypted_secret'          => $encryptedSecret ? Mnemonic::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),
             ]
@@ -1066,10 +1066,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);
@@ -1714,7 +1711,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;
@@ -1740,7 +1737,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

Indentation -1 removed lines

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

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);
 
@@ -304,7 +312,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);
@@ -408,7 +416,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
@@ -436,7 +444,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
@@ -480,22 +488,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);
 
     /**

examples/simple_webhooks_receive_example.php

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.

examples/simple_payment_api_example.php

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.