Skip to content
BipMnemonic is a ruby gem to generate BIP-39 compliant Mnemonic Words from specific entropy or random entropy of `n` bits and also to generate the BIP-32 seed from the BIP-39 Mnemonic.
Branch: master
Clone or download
Latest commit 62abc0d Jun 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Adding more languages support Jun 18, 2019
spec Remove pbkdf2 dependency, improve code style, add MIT license to gemspec Jun 6, 2018
words Adding more languages support Jun 18, 2019
.gitignore Initial Commit Aug 10, 2016
.rspec Initial Commit Aug 10, 2016
.travis.yml Fixing test compatible ruby versions Jun 18, 2019
Gemfile
Gemfile.lock Bumping Gemfile.lock Jun 18, 2019
Guardfile Initial Commit Aug 10, 2016
LICENSE Initial Commit Aug 10, 2016
README.md
Rakefile Remove pbkdf2 dependency, improve code style, add MIT license to gemspec Jun 6, 2018
bip_mnemonic.gemspec

README.md

Build Status Gem Version codecov

README

BipMnemonic is a ruby gem to generate BIP-39 compliant Mnemonic Words from specific entropy or random entropy of n bits and also to generate the BIP-32 seed from the BIP-39 Mnemonic.

Supported Languages:

USAGE

Specified Entropy in Hex

BipMnemonic.to_mnemonic(entropy: 'c10ec20dc3cd9f652c7fac2f1230f7a3c828389a14392f05')
BipMnemonic.to_mnemonic(entropy: 'c10ec20dc3cd9f652c7fac2f1230f7a3c828389a14392f05', language: 'english')

Entropy of n bits

BipMnemonic.to_mnemonic(bits: 128)
BipMnemonic.to_mnemonic(bits: 128, language: 'french')

Retrieving entropy from Mnemonic

BipMnemonic.to_entropy(mnemonic: 'scissors invite lock maple supreme raw rapid void congress muscle digital elegant little brisk hair mango congress clump')
BipMnemonic.to_entropy(mnemonic: 'satira lusinga mordere nastrare sposo responso replica varcato colza opinione distanza erario monetario bici india narice colza cilindro', language: 'italian')

Seed from Mnemonic Words

words = BipMnemonic.to_mnemonic(entropy: 'c10ec20dc3cd9f652c7fac2f1230f7a3c828389a14392f05')
BipMnemonic.to_seed(mnemonic: words)

LANGUAGE USAGE

Pass language: 'language' to methods to_mnemonic or to_entropy with supported values.

Supported Values:

  • english
  • japanese
  • korean
  • spanish
  • chinese_simplified
  • chinese_traditional
  • french
  • italian

TODO

  • Introduce tests for International Languages

CHANGELOG

Version 0.0.4

  • Added support for International Languages
  • Test compatibiltiy updated

Version 0.0.3

  • Major bug fix - Switched from pseudo_bytes to random_bytes

CREDITS

You can’t perform that action at this time.