https://github.com/diybitcoinhardware/embit

A minimal bitcoin library for MicroPython and Python3 with a focus on embedded systems
https://github.com/diybitcoinhardware/embit

Last synced: 3 months ago
JSON representation

A minimal bitcoin library for MicroPython and Python3 with a focus on embedded systems

• Host: GitHub
• URL: https://github.com/diybitcoinhardware/embit
• Owner: diybitcoinhardware
• License: mit
• Created: 2020-01-23T13:29:55.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T20:34:35.000Z (5 months ago)
• Last Synced: 2024-06-20T09:49:59.285Z (5 months ago)
• Language: Python
• Homepage: https://embit.rocks
• Size: 2.92 MB
• Stars: 77
• Watchers: 13
• Forks: 28
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-micropython - embit - A minimal Bitcoin library for MicroPython and Python 3 with a focus on embedded systems. (Libraries / Communications)

README

        
# embit

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/`](./examples) folder.

Documentation: https://embit.rocks/

Support the project: `bc1qd4flfrxjctls9ya244u39hd67pcprhvka723gv`

# Requirements

## MicroPython

Requires a custom MicroPython build with extended [`hashlib`](https://github.com/diybitcoinhardware/f469-disco/tree/master/usermods/uhashlib) module and [`secp256k1`](https://github.com/diybitcoinhardware/secp256k1-embedded) 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.

## Python 3

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/`](./src/embit/util/prebuilt/) folder. Library is built from [libsecp-zkp](https://github.com/ElementsProject/secp256k1-zkp) fork for Liquid support, but will work with pure [libsecp256k1](https://github.com/bitcoin-core/secp256k1) 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`](/secp256k1/README.md).

## Using non-English BIP39 wordlists

[BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md) defines wordlists for:

* English

* Japanese

* Korean

* Spanish

* Chinese (Simplified)

* Chinese (Traditional)

* French

* Italian

* Czech

* Portuguese

`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)

```

# Development

Install in developer mode with dev dependencies:

```sh

pip install -e .[dev]

```

Install pre-commit hook:

```sh

pre-commit install

```

Run tests with desktop python:

```sh

pytest

```

Run tests with micropython:

```sh

cd tests

micropython ./run_tests.py

```