BitcoinPHP / BitcoinECDSA.php

src/BitcoinPHP/BitcoinECDSA/BitcoinECDSA.php

Doc Comments +65 added lines

@@ -43,6 +43,10 @@ 
      * @return string
      * @throws \Exception
      */
+
+    /**
+     * @param integer $i
+     */
     public function numToVarIntString($i) {
         if ($i < 0xfd) {
             return chr($i);
@@ -82,6 +86,10 @@ 
      * @param bool $reverse
      * @return null
      */
+
+    /**
+     * @param string $char
+     */
     public function base58_permutation($char, $reverse = false)
     {
         $table = array('1','2','3','4','5','6','7','8','9','A','B','C','D',
@@ -116,6 +124,10 @@ 
      * @param $data
      * @return string
      */
+
+    /**
+     * @param string $data
+     */
     public function hash256($data)
     {
         return hash('sha256', hex2bin(hash('sha256', $data)));
@@ -129,6 +141,10 @@ 
      * @return String Base58
      * @throws \Exception
      */
+
+    /**
+     * @param string $data
+     */
     public function base58_encode($data, $littleEndian = true)
     {
         $res = '';
@@ -418,6 +434,10 @@ 
      * @return array|null
      * @throws \Exception
      */
+
+    /**
+     * @param resource $a
+     */
     public function sqrt($a)
     {
         $p = $this->p;
@@ -457,6 +477,10 @@ 
      * @param null $derEvenOrOddCode
      * @return array|null|String
      */
+
+    /**
+     * @param string $x
+     */
     public function calculateYWithX($x, $derEvenOrOddCode = null)
     {
         $a  = $this->a;
@@ -577,6 +601,11 @@ 
      * @param $y
      * @return bool
      */
+
+    /**
+     * @param string $x
+     * @param string $y
+     */
     public function validatePoint($x, $y)
     {
         $a  = $this->a;
@@ -777,6 +806,10 @@ 
      * @param String Base58 $address
      * @return bool
      */
+
+    /**
+     * @param string $address
+     */
     public function validateAddress($address)
     {
         $address    = hex2bin($this->base58_decode($address));
@@ -799,6 +832,10 @@ 
      * @param String Base58 $wif
      * @return bool
      */
+
+    /**
+     * @param string $wif
+     */
     public function validateWifKey($wif)
     {
         $key            = $this->base58_decode($wif, false);
@@ -889,6 +926,10 @@ 
      * @param null $nonce
      * @return string
      */
+
+    /**
+     * @param string $hash
+     */
     public function signHash($hash, $nonce = null)
     {
         $points = $this->getSignatureHashPoints($hash, $nonce);
@@ -908,6 +949,10 @@ 
      * @return string
      * @throws \Exception
      */
+
+    /**
+     * @param string $message
+     */
     public function signMessage($message, $compressed = true, $nonce = null)
     {
 
@@ -984,6 +1029,12 @@ 
      * @param $hash
      * @return array
      */
+
+    /**
+     * @param string $R
+     * @param string $S
+     * @param string $hash
+     */
     public function getPubKeyWithRS($flag, $R, $S, $hash)
     {
 
@@ -1141,6 +1192,12 @@ 
      * @param $hash
      * @return bool
      */
+
+    /**
+     * @param string $pubKey
+     * @param string $signature
+     * @param string $hash
+     */
     public function checkDerSignature($pubKey, $signature, $hash)
     {
         $signature = hex2bin($signature);
@@ -1170,6 +1227,10 @@ 
      * @param $rawMessage
      * @return bool
      */
+
+    /**
+     * @param string $rawMessage
+     */
     public function checkSignatureForRawMessage($rawMessage)
     {
         //recover message.
@@ -1191,6 +1252,10 @@ 
      * @param $message
      * @return bool
      */
+
+    /**
+     * @param string $encodedSignature
+     */
     public function checkSignatureForMessage($address, $encodedSignature, $message)
     {
         $hash = $this->hash256("\x18Bitcoin Signed Message:\n" . $this->numToVarIntString(strlen($message)) . $message);