BIP39

This is a simple Swift wrapper for BIP39, implementation of BIP 39 "Mnemonic code for generating deterministic keys" standard for use in Blockchain Commons Software Projects**

Installation

CocoaPods

BIP39 is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'BIP39'

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

To integrate BIP39 into your Xcode project using Carthage, specify it in your Cartfile:

github "bitmark-inc/bip39-swift"

Run carthage update to build the framework and drag the built BIP39.framework into your Xcode project.

On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase” and add the Framework path as mentioned in Carthage Getting started Step 4, 5 and 6

Swift Package Manager

To integrate using Apple's Swift Package Manager, add the following as a dependency to your Package.swift:

dependencies: [
    .package(url: "[email protected]:bitmark-inc/bip39-swift.git", from: "1.0.0")
]

Alternatively navigate to your Xcode project, select Swift Packages and click the + icon to search for BIP39.

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate BIP39 into your project manually. Simply drag the Sources Folder into your Xcode project.

Example code

Returns the English mnemonic string for the given BIP39 word

BIP39Util.mnemonicFromWord(1) // "ability"

Returns the BIP39 words for the given English mnemonics

BIP39Util.wordFromMnemonic("ability") // 1

Returns the BIP39 English mnemonics for the given secret.

BIP39Util.mnemonicsFromSecret(Data(hexString: "baadf00dbaadf00d")!)

Returns the secret for the given English mnemonics.

BIP39Util.secretFromMnemonics(["rival", "hurdle", "address", "inspire", "tenant", "alone"])

Contributing

Contributions are very welcome 🙌

License

BIP39
Copyright (c) 2020 Bitmark Inc [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.