Skip to content

Bitcoin Lightning BoltCard (NTAG 424 DNA) Read/Write library

License

Notifications You must be signed in to change notification settings

bitcoin-ring/boltlib

Repository files navigation

boltlib - Bitcoin Lightning BoltCard library

Tests Version Downloads

boltlib is a Python library and command line tool for easy reading and writing of BoltCards based on pyscard

Requirements

  • Python 3.8 or higher.
  • Smart Card Reader (USB CCID class-compliant)

Tested with Identiv uTrust 3700F but should work with others like for example ACS ACR1252U or HID Omnikey 5022 CL.

Note: On Ubuntu/Debian run sudo apt-get install libpcsclite-dev swig before installation.

Installation

$ pip install boltlib

Command line usage

$ boltcard
Usage: boltcard [OPTIONS] COMMAND [ARGS]...

Options:
  --version     Show the version and exit.
  -s, --silent  Silence debug output.
  --help        Show this message and exit.

Commands:
  read   Read BoltCard UID and URI
  write  Write URI to BoltCard (unprovisioned only)

Library usage

import boltlib
uri = boltlib.read_uri()
print(uri)

Development

Requirements

Setup

git clone https://github.com/titusz/boltlib.git
cd boltlib
poetry install

Run Tasks

Before committing changes run code formatting and tests with:

poe all