add scala docs, breakdown isValid Base58 function

src/main/scala/org/bitcoins/core/util/Base58.scala

@@ -2,7 +2,6 @@ package org.bitcoins.core.util
 
 import org.bitcoins.core.config.{MainNet, TestNet3}
 import org.bitcoins.core.crypto.{ECPrivateKey, Sha256Hash160Digest}
-import org.bitcoins.core.protocol.Address
 import org.bitcoins.core.protocol.blockchain._
 
 import scala.annotation.tailrec
@@ -36,7 +35,6 @@ trait Base58 extends BitcoinSLogger {
     }
   }
 
-
   /**
     * Takes in sequence of bytes and returns base58 bitcoin string
     *
@@ -79,24 +77,10 @@ trait Base58 extends BitcoinSLogger {
     * @param isTestNet boolean
     * @return
     */
+    //TODO: add logic to determine pubkey/script from first byte
   def encodePubKeyHashToBase58Address(hash: Sha256Hash160Digest,
                                   addressType : String,
                                   isTestNet : Boolean) : String = {
-/*    val versionByte : Byte = {
-      require(addressType != "pubkey" || addressType != "script",
-        throw new IllegalArgumentException("Address must be of type 'pubkey' or 'script'."))
-      if (!isTestNet) {
-        if (addressType == "pubkey") MainNet.p2pkhNetworkByte
-        else MainNet.p2shNetworkByte
-      }
-      else if (isTestNet) {
-        if (addressType == "pubkey") TestNet3.p2pkhNetworkByte
-        else TestNet3.p2shNetworkByte
-      }
-      else throw new IllegalArgumentException("Something broke -- Check your parameters. There should be a " +
-        "Sha256RipeMD160 hash, addressType('pubkey' or 'script'), and testnet boolean (true or false).")
-    }*/
-
     def parseVersionByte(addressType : String, isTestnet : Boolean) : Byte = isTestnet match {
       case true => if (addressType == "pubkey") TestNet3.p2pkhNetworkByte else TestNet3.p2shNetworkByte
       case false => if (addressType == "pubkey") MainNet.p2pkhNetworkByte else MainNet.p2shNetworkByte
@@ -148,51 +132,79 @@ trait Base58 extends BitcoinSLogger {
     if (trim.isEmpty) zeroes else zeroes ++ decoded.toByteArray.dropWhile(_ == 0)
   }
 
-  def isValid(base58 : String) : Boolean = {
+  /**
-    if (base58.isEmpty) false
+    * Determines if a string is a valid Base58-encoded string.
-    else {
+    *
-      val decoded = decode(base58)
+    * @param base58
-      val firstByte = decoded.head
+    * @return
-      val validAddressPreFixBytes: Seq[Byte] =
+    */
-        MainNetChainParams.base58Prefixes(PubKeyAddress) ++ MainNetChainParams.base58Prefixes(ScriptAddress) ++
+  def isValid(base58 : String) : Boolean = validityChecks(base58) match {
-          TestNetChainParams.base58Prefixes(PubKeyAddress) ++ TestNetChainParams.base58Prefixes(ScriptAddress)
+      case Success(bool) => bool
-      val validSecretKeyPreFixBytes : Seq[Byte] =
+      case Failure(exception) => false
-        MainNetChainParams.base58Prefixes(SecretKey) ++ TestNetChainParams.base58Prefixes(SecretKey)
+  }
-      val compressedPubKey = List('K', 'L', 'c').contains(base58.head)
+
-      def checkCompressedPubKeyValidity : Boolean = {
+  /**
+    * Checks a private key that begins with a symbol corresponding that private key to a compressed public key ('K', 'L', 'c').
+    * In a Base58-encoded private key corresponding to a compressed public key, the 5th-to-last byte should be 0x01.
+    *
+    * @param base58
+    * @return
+    */
+  private def checkCompressedPubKeyValidity(base58 : String) : Boolean = {
+    val decoded = Base58.decode(base58)
     val compressedByte = decoded(decoded.length - 5)
     compressedByte == 0x01.toByte
   }
-      try {
+
+  /**
+    * Checks if the string begins with an Address prefix byte/character.
+    * ('1', '3', 'm', 'n', '2')
+    *
+    * @param byte
+    * @return
+    */
+  private def isValidAddressPreFixByte(byte : Byte) : Boolean = {
+    val validAddressPreFixBytes: Seq[Byte] =
+      MainNetChainParams.base58Prefixes(PubKeyAddress) ++ MainNetChainParams.base58Prefixes(ScriptAddress) ++
+        TestNetChainParams.base58Prefixes(PubKeyAddress) ++ TestNetChainParams.base58Prefixes(ScriptAddress)
+    validAddressPreFixBytes.contains(byte)
+  }
+
+  /**
+    * Checks if the string begins with a private key prefix byte/character.
+    * ('5', '9', 'c')
+    *
+    * @param byte
+    * @return
+    */
+  private def isValidSecretKeyPreFixByte(byte : Byte) : Boolean = {
+    val validSecretKeyPreFixBytes : Seq[Byte] =
+      MainNetChainParams.base58Prefixes(SecretKey) ++ TestNetChainParams.base58Prefixes(SecretKey)
+    validSecretKeyPreFixBytes.contains(byte)
+  }
+
+  /**
+    * Checks the validity of a Base58 encoded string. A Base58 encoded string must not contain ('0', 'O', 'l', 'I').
+    * If the string is an address: it must have a valid address prefix byte and  must be between 26-35 characters in length.
+    * If the string is a private key: it must have a valid private key prefix byte and must have a byte size of 32.
+    * If the string is a private key corresponding to a compressed public key, the 5th-to-last byte must be 0x01.
+    *
+    * @param base58
+    * @return
+    */
+  private def validityChecks(base58: String) : Try[Boolean] = Try {
+    val decoded = decode(base58)
+    val firstByte = decoded.head
+    val compressedPubKey = List('K', 'L', 'c').contains(base58.head)
     if (base58.contains(List('0', 'O', 'l', 'I'))) false
-        else if (compressedPubKey) checkCompressedPubKeyValidity
+    else if (compressedPubKey) checkCompressedPubKeyValidity(base58)
-        else if (validAddressPreFixBytes.contains(firstByte)) base58.length >= 26 && base58.length <= 35
+    else if (isValidAddressPreFixByte(firstByte)) base58.length >= 26 && base58.length <= 35
-        else if (validSecretKeyPreFixBytes.contains(firstByte)) {
+    else if (isValidSecretKeyPreFixByte(firstByte)) {
-          val byteSize = ECPrivateKey.fromBase58ToPrivateKey(base58).bytes.size
+      val byteSize = ECPrivateKey.fromWIFToPrivateKey(base58).bytes.size
       byteSize == 32
     }
     else false
   }
-      catch {
-        case error : IllegalArgumentException => false
-      }
-    }
-  }
-
-/*    def isValid(base58 : String) : Boolean = {
-    val firstByte : Seq[Byte]= if (base58.isEmpty) List() else Seq(decode(base58).head)
-    val length = base58.length
-    val validFirstByteInHex = List("00", "05", "80", "6f", "c4", "ef")
-    val invalidChars = List('0','O','l','I')
-    val firstByteInHex = BitcoinSUtil.encodeHex(firstByte)
-    if (!validFirstByteInHex.contains(firstByteInHex)) false
-    else if (length < 25 || length > 36) false
-    else if (base58.contains(invalidChars)) false
-    else true
-  }*/
 }
 
 object Base58 extends Base58
-
-
-

src/test/scala/org/bitcoins/core/crypto/ECPrivateKeyTest.scala

@@ -40,7 +40,7 @@ class ECPrivateKeyTest extends FlatSpec with MustMatchers {
     val privateKeyBase58 = CryptoTestUtil.privateKeyBase58
     val bitcoinjDumpedPrivateKey = new org.bitcoinj.core.DumpedPrivateKey(BitcoinJTestUtil.params,privateKeyBase58)
     val bitcoinjPrivateKey = bitcoinjDumpedPrivateKey.getKey
-    val privateKey = ECPrivateKey.fromBase58ToPrivateKey(privateKeyBase58)
+    val privateKey = ECPrivateKey.fromWIFToPrivateKey(privateKeyBase58)
 
     privateKey.hex must be (bitcoinjPrivateKey.getPrivateKeyAsHex)
 

src/test/scala/org/bitcoins/core/util/CryptoTestUtil.scala

@@ -13,7 +13,7 @@ trait CryptoTestUtil {
   def privateKeyHex = BitcoinSUtil.encodeHex(privateKeyBytes)
   def bitcoinjDumpedPrivateKey = new DumpedPrivateKey(BitcoinJTestUtil.params,privateKeyBase58)
   def bitcoinjPrivateKey = bitcoinjDumpedPrivateKey.getKey
-  def privateKey = ECPrivateKey.fromBase58ToPrivateKey(privateKeyBase58)
+  def privateKey = ECPrivateKey.fromWIFToPrivateKey(privateKeyBase58)
 
 }
 

src/test/scala/org/bitcoins/core/util/TransactionTestUtil.scala

@@ -102,9 +102,9 @@ trait TransactionTestUtil extends BitcoinSLogger {
   }
 
   def signedMultiSignatureTransaction : (Transaction, Int, ScriptPubKey, Seq[ECPublicKey]) = {
-    val key1 = ECPrivateKey.fromBase58ToPrivateKey("cVLwRLTvz3BxDAWkvS3yzT9pUcTCup7kQnfT2smRjvmmm1wAP6QT")
+    val key1 = ECPrivateKey.fromWIFToPrivateKey("cVLwRLTvz3BxDAWkvS3yzT9pUcTCup7kQnfT2smRjvmmm1wAP6QT")
-    val key2 = ECPrivateKey.fromBase58ToPrivateKey("cTine92s8GLpVqvebi8rYce3FrUYq78ZGQffBYCS1HmDPJdSTxUo")
+    val key2 = ECPrivateKey.fromWIFToPrivateKey("cTine92s8GLpVqvebi8rYce3FrUYq78ZGQffBYCS1HmDPJdSTxUo")
-    def key3 = ECPrivateKey.fromBase58ToPrivateKey("cVHwXSPRZmL9adctwBwmn4oTZdZMbaCsR5XF6VznqMgcvt1FDDxg")
+    def key3 = ECPrivateKey.fromWIFToPrivateKey("cVHwXSPRZmL9adctwBwmn4oTZdZMbaCsR5XF6VznqMgcvt1FDDxg")
     (signedMultiSignatureTx,0,multiSignatureScriptPubKey, Seq(key1.publicKey,key2.publicKey,key3.publicKey))
   }