Skip to main content

Implementation of Bitcoin BIP-0039

Project description

python-mnemonic

https://badge.fury.io/py/mnemonic.svg

Reference implementation of BIP-0039: Mnemonic code for generating deterministic keys

Abstract

This BIP describes the implementation of a mnemonic code or mnemonic sentence – a group of easy to remember words – for the generation of deterministic wallets.

It consists of two parts: generating the mnenomic, and converting it into a binary seed. This seed can be later used to generate deterministic wallets using BIP-0032 or similar methods.

BIP Paper

See https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki for full specification

Installation

To install this library and its dependencies use:

pip install mnemonic

Usage examples

Import library into python project via:

from mnemonic import Mnemonic

Initialize class instance, picking from available dictionaries:

  • english

  • chinese_simplified

  • chinese_traditional

  • french

  • italian

  • japanese

  • korean

  • spanish

  • turkish

  • czech

  • portuguese

mnemo = Mnemonic(language)
mnemo = Mnemonic("english")

Generate word list given the strength (128 - 256):

words = mnemo.generate(strength=256)

Given the word list and custom passphrase (empty in example), generate seed:

seed = mnemo.to_seed(words, passphrase="")

Given the word list, calculate original entropy:

entropy = mnemo.to_entropy(words)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.21 - 2024-01-05

Added

  • Czech and Portuguese wordlists

  • Option to provide custom list of words instead of loading from built-in file

Changed

  • Use secrets module for randomness

  • Use English as a default language if none is provided

  • Language detection is unambiguous even if some words are ambiguous

  • Build system switched to Poetry

Removed

  • Support for Python below 3.8 was dropped

0.20 - 2021-07-27

Added

  • Type annotations

  • Support for testnet private keys

Changed

  • Project directory structure was cleaned up

  • Language on the Mnemonic object is remembered instead of repeatedly detecting

Removed

  • Support for Python 2.7 and 3.4 was dropped

0.19 - 2019-10-01

Added

  • Start of changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mnemonic-0.21.tar.gz (152.5 kB view hashes)

Uploaded source

Built Distribution

mnemonic-0.21-py3-none-any.whl (92.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page