blocktrail / blocktrail-sdk-php

src/Wallet.php

Doc Comments +15 added lines, -11 removed lines

@@ -191,7 +191,7 @@ 
     }
 
     /**
-     * @param null $chainIndex
+     * @param null|integer $chainIndex
      * @return BIP32Path
      */
     protected function getWalletPath($chainIndex = null) {
@@ -327,7 +327,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key|false
      * @throws \Exception
      *
@@ -354,7 +354,7 @@ 
     /**
      * get address for the specified path
      *
-     * @param string|BIP32Path  $path
+     * @param string  $path
      * @return string
      */
     public function getAddressByPath($path) {
@@ -454,7 +454,7 @@ 
     }
 
     /**
-     * @param string|BIP32Path  $path
+     * @param BIP32Path  $path
      * @return BIP32Key
      * @throws \Exception
      */
@@ -605,7 +605,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
@@ -735,6 +735,10 @@ 
         return [$txb->get(), $signInfo];
     }
 
+    /**
+     * @param integer $optimalFeePerKB
+     * @param integer $lowPriorityFeePerKB
+     */
     public function determineFeeAndChange(TransactionBuilder $txBuilder, $optimalFeePerKB, $lowPriorityFeePerKB) {
         $send = $txBuilder->getOutputs();
         $utxos = $txBuilder->getUtxos();
@@ -846,7 +850,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) {
@@ -869,7 +873,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
@@ -879,7 +883,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);
@@ -934,7 +938,7 @@ 
      *
      * @param UTXO[]  $utxos
      * @param array[] $outputs
-     * @param         $feeStrategy
+     * @param         string $feeStrategy
      * @param         $optimalFeePerKB
      * @param         $lowPriorityFeePerKB
      * @return int
@@ -1034,8 +1038,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 +9 added lines, -9 removed lines

@@ -184,7 +184,7 @@ 
             $changeIdx = self::CHAIN_BCC_DEFAULT;
         }
 
-        $this->isSegwit = (bool) $segwit;
+        $this->isSegwit = (bool)$segwit;
         $this->chainIndex = $chainIdx;
         $this->changeIndex = $changeIdx;
         $this->walletPath = $this->getWalletPath(null);
@@ -233,7 +233,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);
     }
@@ -360,7 +360,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;
@@ -689,7 +689,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'))) {
@@ -822,7 +822,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[]');
 
@@ -835,7 +835,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);
     }
@@ -894,7 +894,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";
 
@@ -968,7 +968,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'));
@@ -987,7 +987,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[]');