Mnemonic Structure Reference


                    
                    
                    NumberOfWords

Helper enum used to choose the number of words for a mnemonic

Declaration

Swift

public enum NumberOfWords : Int


                    
                    
                    phrase

The list of words as a single sentence.

Declaration

Swift

public var phrase: String


                    
                    
                    words

The list of words.

Declaration

Swift

public var words: [String] { get }


                    
                    
                    init(seedPhrase:)

Declaration

Swift

public init(seedPhrase phrase: String?) throws


                    
                    
                    init(strength:in:)

Declaration

Swift

public init(strength: Int = .strongest, in vocabulary: WordList = .english) throws


                    
                    
                    init(numberOfWords:in:)

Declaration

Swift

public init(numberOfWords: NumberOfWords, in vocabulary: WordList = .english) throws


                    
                    
                    init(entropy:in:)

Create a mnemonic from a pre-computed entropy, with phrase_ pulled from the vocabulary list.

Declaration

Swift

public init<Entropy>(entropy: Entropy, in vocabulary: WordList = .english) throws where Entropy : EntropyGenerator


                    
                    
                    seed(passphrase:)

Create the mnemonic’s private key (seed).

Warning

Calling this function can take some time. Avoid calling this function from the main thread, when possible.

BIP39:

https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#from-mnemonic-to-seed

Declaration

Swift

public func seed(passphrase: String = "") throws -> Data

Return Value

A result with the seed’s bytes, or an Error.


                    
                    
                    scrub()

Scrub the phrase from memory by replacing with 0’s

Declaration

Swift

public mutating func scrub()


                    
                    
                    deriveChecksumBits(_:)

Derive the checksum portion of an array of bits

Declaration

Swift

public static func deriveChecksumBits(_ bytes: [UInt8]) -> String


                    
                    
                    isValidChecksum(phrase:wordlist:)

Verify the chechsum of the supplied words to esnure its a valid phrase

Declaration

Swift

public static func isValidChecksum(phrase: [String], wordlist: WordList = WordList.english) -> Bool


                    
                    
                    isValidWords(in:)

Check a mnemonic contains valid words and a valid length (all other checks are ignored)

Declaration

Swift

public func isValidWords(in vocabulary: WordList = .english) -> Bool


                    
                    
                    isValid(in:)

Check a mnemonic is of the correct length, is made up of valid BIP39 words, and the checksum matches

Declaration

Swift

public func isValid(in vocabulary: WordList = .english) -> Bool


                    
                    
                    toEntropy(ignoreChecksum:wordlist:)

Modifed from: https://github.com/pengpengliu/BIP39/blob/master/Sources/BIP39/Mnemonic.swift Convert the current Mnemonic back into entropy

Declaration

Swift

public func toEntropy(ignoreChecksum: Bool, wordlist: WordList = WordList.english) throws -> [UInt8]


                    
                    
                    shiftedMnemonic(fromSpskPrivateKey:)

Take a PrivateKey from a TorusWallet and generate a custom “shifted checksum” mnemonic, so that we can recover wallets that previously had no seed words

Declaration

Swift

public static func shiftedMnemonic(fromSpskPrivateKey pk: PrivateKey) -> Mnemonic?


                    
                    
                    shiftChecksum(mnemonic:wordList:)

Shift the checksum of of a Mnemonic so that it won’t be accepted by tradtional improts

Declaration

Swift

public static func shiftChecksum(mnemonic: Mnemonic, wordList: WordList = WordList.english) throws -> Mnemonic


                    
                    
                    getShiftedWord(word:wordList:)

Return a shifted word to replace the last word in a mnemonic

Declaration

Swift

public static func getShiftedWord(word: String, wordList: WordList = WordList.english) throws -> String


                    
                    
                    mnemonicToSpsk(mnemonic:wordList:)

Convert a mnemonic to a Base58 encoded private key string. Helpful when determining if a shifted mnemonic is valid

Declaration

Swift

public static func mnemonicToSpsk(mnemonic: Mnemonic, wordList: WordList = WordList.english) -> String?


                    
                    
                    shiftedMnemonicToMnemonic(mnemonic:)

Convert a shifted Mnemoinc back to normal

Declaration

Swift

public static func shiftedMnemonicToMnemonic(mnemonic: Mnemonic) -> Mnemonic?


                    
                    
                    validSpsk(_:)

Check if a supplied Spsk string is valid

Declaration

Swift

public static func validSpsk(_ sk: String) -> Bool