A minimal bitcoin library for MicroPython and Python3 with a focus on embedded systems.
A minimal bitcoin library for MicroPython and Python3 with a focus on embedded systems.
Should remain minimal to fit in a microcontroller. Also easy to audit.
Examples can be found in examples/ folder.
Documentation: https://embit.rocks/
Support the project: bc1qd4flfrxjctls9ya244u39hd67pcprhvka723gv
Requires a custom MicroPython build with extended hashlib module and secp256k1 bindings.
To install copy the content of embit folder to the board. To save some space you can remove files embit/util/ctypes_secp256k1.py and embit/util/pyhashlib.py - they are used only in Python3.
To install run pip3 install embit.
To install in development mode (editable) clone and run pip3 install -e . from the root folder.
PyPi installation includes prebuilt libraries for common platforms (win, macos, linux, raspi) - see src/embit/util/prebuilt/ folder. Library is built from libsecp-zkp fork for Liquid support, but will work with pure libsecp256k1 as well - just Liquid functionality doesn't work. If it fails to use the prebuilt or system library it will fallback to pure python implementation.
If you want to build the lib yourself, see: Building secp256k1 for embit.
BIP39 defines wordlists for:
embit assumes English and does not include the other wordlists in order to keep this as slim as possible.
However, you can override this default by providing an alternate wordlist to any of the mnemonic-handling methods:
spanish_wordlist = [
"ábaco",
"abdomen",
"abeja",
"abierto",
"abogado",
"abono",
"aborto",
"abrazo",
"abrir",
"abuelo",
...
]
mnemonic_is_valid(mnemonic, wordlist=spanish_wordlist)
mnemonic_to_seed(mnemonic, wordlist=spanish_wordlist)
mnemonic_to_bytes(mnemonic, wordlist=spanish_wordlist)
mnemonic_from_bytes(bytes_data, wordlist=spanish_wordlist)
Install in developer mode with dev dependencies:
pip install -e .[dev]
Install pre-commit hook:
pre-commit install
Run tests with desktop python:
pytest
Run tests with micropython:
cd tests
micropython ./run_tests.py
FAQs
A minimal bitcoin library for MicroPython and Python3 with a focus on embedded systems.
We found that embit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.