https://github.com/devinrsmith/mnemonic-encoding
Human readable encoding for small amounts of data
https://github.com/devinrsmith/mnemonic-encoding
bip39 encoding human-readable java mnemonic mnemonic-phrase rfc1751 storage
Last synced: 6 months ago
JSON representation
Human readable encoding for small amounts of data
- Host: GitHub
- URL: https://github.com/devinrsmith/mnemonic-encoding
- Owner: devinrsmith
- License: mit
- Created: 2017-12-29T01:38:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T21:57:19.000Z (almost 8 years ago)
- Last Synced: 2025-03-27T20:06:20.728Z (7 months ago)
- Topics: bip39, encoding, human-readable, java, mnemonic, mnemonic-phrase, rfc1751, storage
- Language: Java
- Homepage:
- Size: 112 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
### Human Encoding
The goal of this project is to provide a variety of encoding (and decoding) schemes for
reliably storing or transmitting small amounts of data in a human readable, writable, speakable,
and listenable way. There is no single best encoding scheme for all purposes, so advice and best
practices around scheme use cases will be provided.
The encoding is represented as an ordered list of words, typically called a mnemonic phrase.
"Mnemonic" is a bit of a misnomer, as they are used much more often written down than memorized.
The words come from a wordlist which typically has a length that is power of 2.
This project does not deal with the use of mnemonic phrases for the purpose of further seed
generation, although such projects could benefit from the use of this library.
This project has no external dependencies.
#### Use cases
* Paper backup for seed data
* Paper backup for private keys
* Relaying small amounts of data over a secure text channel
* Relaying small amounts of data over a secure voice channel
#### Research TODOs
* Wordlists that are built specifically to minimize phonetic ambiguities
* Wordlists that have stronger guarantees (ability to automatically deal with mistyped characters)
* Best practices around creating and storing paper backups (archival paper, pencil vs pen, polyester sleeves, etc)
#### References
* [RFC1751](https://tools.ietf.org/html/rfc1751)
* [Mnemonic Phrase](https://en.bitcoin.it/wiki/Mnemonic_phrase)
* [BIP-0039](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
* [Trezor Mnemonics](https://github.com/trezor/python-mnemonic)
* [Phonetic Alphabet](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet)
* [PGP word list](https://en.wikipedia.org/wiki/PGP_word_list)
* [singpolyma/mnemonicode](https://github.com/singpolyma/mnemonicode)
* [RFC1760](https://tools.ietf.org/html/rfc1760)
* [RFC2289](https://tools.ietf.org/html/rfc2289)
#### Build status
* Master: [](https://travis-ci.org/devinrsmith/mnemonic-encoding)
#### Other TODOs
* Licensing issues around encoding schemes
* Better bit manipulation
* Benchmarking with [JMH](http://openjdk.java.net/projects/code-tools/jmh/)
* Mutation testing with [PIT](http://pitest.org/)