Cleaning up Mnemonic.Strength and Wordlist

yenom · Sep 18, 2019 · 6c82e3f · 6c82e3f
1 parent d58c070
commit 6c82e3f
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 77 deletions.
diff --git a/Sources/BitcoinKit/Core/Mnemonic/Mnemonic+Generate.swift b/Sources/BitcoinKit/Core/Mnemonic/Mnemonic+Generate.swift
@@ -41,7 +41,7 @@ internal extension Mnemonic {
 
         let bits = BitArray(data: entropy) + checkSumBit
 
-        let wordIndices = bits.splitIntoChunks(ofSize: wordListSizeLog2)
+		let wordIndices = bits.splitIntoChunks(ofSize: Mnemonic.WordList.sizeLog2)
             .map { UInt11(bitArray: $0)! }
             .map { $0.asInt }
 

diff --git a/Sources/BitcoinKit/Core/Mnemonic/Mnemonic+Strength.swift b/Sources/BitcoinKit/Core/Mnemonic/Mnemonic+Strength.swift
@@ -8,86 +8,54 @@
 
 import Foundation
 
-internal let bitsPerByte = 8
-internal let wordListSizeLog2 = 11 // 2^11 => 2048
-
 // MARK: Strength
 public extension Mnemonic {
-    enum Strength: Int, CaseIterable {
-        case `default` = 128
-        case low = 160
-        case medium = 192
-        case high = 224
-        case veryHigh = 256
-    }
+	enum Strength: Int, CaseIterable {
+		case `default` = 128
+		case low = 160
+		case medium = 192
+		case high = 224
+		case veryHigh = 256
+	}
 }
 
 public extension Mnemonic.Strength {
-    init?(wordCount: Int) {
-        guard
-            let entropyInBitsFromWordCount = Mnemonic.Strength.entropyInBitsFrom(wordCount: wordCount),
-            let strength = Self(rawValue: entropyInBitsFromWordCount)
-            else { return nil }
-        self = strength
-    }
 
-    init?(byteCount: Int) {
-        let bitCount = byteCount * bitsPerByte
-        guard
-            let strength = Self(rawValue: bitCount)
-            else { return nil }
-        self = strength
-    }
+	/// `wordCount` must be divisible by `3`, else `nil` is returned
+	init?(wordCount: Int) {
+		guard wordCount % Mnemonic.Strength.checksumBitsPerWord == 0 else { return nil }
+		let entropyInBitsFromWordCount = (wordCount / Mnemonic.Strength.checksumBitsPerWord) * 32
+		self.init(rawValue: entropyInBitsFromWordCount)
+	}
+
+	init?(byteCount: Int) {
+		let bitCount = byteCount * bitsPerByte
+		guard
+			let strength = Self(rawValue: bitCount)
+			else { return nil }
+		self = strength
+	}
 }
 
 // MARK: - Internal
 
 internal extension Mnemonic.Strength {
-    var wordCount: WordCount {
-        let wordCountInt = Mnemonic.Strength.wordCountFrom(entropyInBits: rawValue)
-        guard let wordCount = WordCount(rawValue: wordCountInt) else {
-            fatalError("Missed to include word count: \(wordCountInt)")
-        }
-        return wordCount
-    }
-
-    var byteCount: Int {
-        return rawValue / bitsPerByte
-    }
-
-    static func wordCountFrom(entropyInBits: Int) -> Int {
-        return Int(ceil(Double(entropyInBits) / Double(wordListSizeLog2)))
-    }
 
-    /// `wordCount` must be divisible by `3`, else `nil` is returned
-    static func entropyInBitsFrom(wordCount: Int) -> Int? {
-        guard wordCount % Mnemonic.Strength.checksumBitsPerWord == 0 else { return nil }
-        return (wordCount / Mnemonic.Strength.checksumBitsPerWord) * 32
-    }
+	static let checksumBitsPerWord = 3
 
-    static let checksumBitsPerWord = 3
-    var checksumLengthInBits: Int {
-        return wordCount.wordCount / Mnemonic.Strength.checksumBitsPerWord
-    }
+	var byteCount: Int {
+		return rawValue / bitsPerByte
+	}
 
-    var checksumLengthInBytes: Int {
-          return checksumLengthInBits / bitsPerByte
-      }
-}
+	var wordCount: Int {
+		return Mnemonic.Strength.wordCountFrom(entropyInBits: rawValue)
+	}
 
-// MARK: - WordCount
-internal extension Mnemonic.Strength {
-    enum WordCount: Int {
-        case wordCountOf12 = 12
-        case wordCountOf15 = 15
-        case wordCountOf18 = 18
-        case wordCountOf21 = 21
-        case wordCountOf24 = 24
-    }
-}
+	static func wordCountFrom(entropyInBits: Int) -> Int {
+		return Int(ceil(Double(entropyInBits) / Double(Mnemonic.WordList.sizeLog2)))
+	}
 
-internal extension Mnemonic.Strength.WordCount {
-    var wordCount: Int {
-        return rawValue
-    }
+	var checksumLengthInBits: Int {
+		return wordCount / Mnemonic.Strength.checksumBitsPerWord
+	}
 }
diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+English.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+English.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var english: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+French.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+French.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var french: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Italian.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Italian.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var italian: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Japanese.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Japanese.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var japanese: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Korean.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Korean.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var korean: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+SimplifiedChinese.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+SimplifiedChinese.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var simplifiedChinese: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Spanish.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+Spanish.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var spanish: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+TraditionalChinese.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList+TraditionalChinese.swift
@@ -26,7 +26,7 @@
 import Foundation
 
 // swiftlint:disable file_length
-public extension WordList {
+public extension Mnemonic.WordList {
     static var traditionalChinese: [String] = {
         let words =
         """

diff --git a/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList.swift b/Sources/BitcoinKit/Core/Mnemonic/WordList/WordList.swift
@@ -25,4 +25,11 @@
 
 import Foundation
 
-public enum WordList {}
+public extension Mnemonic {
+	enum WordList {}
+}
+
+internal extension Mnemonic.WordList {
+	/// `2^11 => 2048`
+	static let sizeLog2 = 11
+}
diff --git a/Sources/BitcoinKit/Extensions/Data_Extensions.swift b/Sources/BitcoinKit/Extensions/Data_Extensions.swift
@@ -24,6 +24,8 @@
 
 import Foundation
 
+internal let bitsPerByte = 8
+
 extension Data {
     var binaryString: String {
         var result: [String] = []

diff --git a/Tests/BitcoinKitTests/MnemonicTests.swift b/Tests/BitcoinKitTests/MnemonicTests.swift
@@ -468,7 +468,7 @@ private extension MnemonicTests {
             }
             XCTAssertNoThrow(try Mnemonic.validateChecksumOf(mnemonic: words, language: .english), "validation of vector with mnemonic failed: '\(words)'")
 
-        let firstWordInVocabulary = WordList.english.first!
+        let firstWordInVocabulary = Mnemonic.WordList.english.first!
         XCTAssertNotEqual(words[0], firstWordInVocabulary) // assert that we dont have such bad luck that the first
         let mnemonicFirstWordReplaced: [String] = { var tmp = words; tmp[0] = firstWordInVocabulary; return tmp }()