Skip to main content

A reusable parser for Lightning Network gossip messages format.

Project description

โšก ln-history-python-client

A Python client library to parse and handle raw Lightning Network gossip messages from the gossip store. Centralized, reusable, and production-tested on real-world data. Perfect for microservices that consume Lightning Network data in raw_hex format.


๐Ÿ“ฆ Features

  • ๐Ÿ” Parses raw gossip messages: Channel Announcements, Channel Updates, Node Announcements, and more
  • ๐Ÿงฑ Clean and extensible object model (e.g., ChannelAnnouncement, NodeAnnouncement, ChannelUpdate)
  • ๐Ÿงช Tested on real-world data
  • ๐Ÿงฐ Built with reusability in mind for microservice architectures

๐Ÿ› ๏ธ Installation

pip install 

๐Ÿงฌ Usage

from lnhistoryclient.parser import parser_factory

raw_hex = "0101..."  # Replace with actual raw gossip hex string
parsed = parser_factory.parse(raw_hex)

print(parsed)

You can also directly use individual parsers if you know the message type:

from lnhistoryclient.parser.channel_announcement_parser import parse_channel_announcement

result = parse_channel_announcement(raw_hex)
print(result.channel_id, result.node1_id, result.node2_id)

๐Ÿ“ Project Structure

lnhistoryclient
โ”œโ”€โ”€ model
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ Address.py
โ”‚   โ”œโ”€โ”€ AddressType.py
โ”‚   โ”œโ”€โ”€ ChannelAnnouncement.py
โ”‚   โ”œโ”€โ”€ ChannelUpdate.py
โ”‚   โ”œโ”€โ”€ core-lightning-internal
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚   โ”œโ”€โ”€ ChannelAmount.py
โ”‚   โ”‚   โ”œโ”€โ”€ ChannelDying.py
โ”‚   โ”‚   โ”œโ”€โ”€ DeleteChannel.py
โ”‚   โ”‚   โ”œโ”€โ”€ GossipStoreEnded.py
โ”‚   โ”‚   โ”œโ”€โ”€ PrivateChannelAnnouncement.py
โ”‚   โ”‚   โ””โ”€โ”€ PrivateChannelUpdate.py
โ”‚   โ””โ”€โ”€ NodeAnnouncement.py
โ””โ”€โ”€ parser
    โ”œโ”€โ”€ __init__.py
    โ”œโ”€โ”€ channel_announcement_parser.py
    โ”œโ”€โ”€ channel_update_parser.py
    โ”œโ”€โ”€ common.py
    โ”œโ”€โ”€ core-lightning-internal
    โ”‚   โ”œโ”€โ”€ channel_amount_parser.py
    โ”‚   โ”œโ”€โ”€ channel_dying_parser.py
    โ”‚   โ”œโ”€โ”€ delete_channel_parser.py
    โ”‚   โ”œโ”€โ”€ gossip_store_ended_parser.py
    โ”‚   โ”œโ”€โ”€ private_channel_announcement_parser.py
    โ”‚   โ””โ”€โ”€ private_channel_update_parser.py
    โ”œโ”€โ”€ node_announcement_parser.py
    โ””โ”€โ”€ parser_factory.py

๐Ÿงช Testing

Unit tests coming soon.

๐Ÿง  Requirements

Python >=3.7, <4.0 Pure Python, no external dependencies

๐Ÿค Contributing

Pull requests, issues, and feature ideas are always welcome! Fork the repo Create a new branch Submit a PR with a clear description

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

lnhistoryclient-2.1.1.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lnhistoryclient-2.1.1-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file lnhistoryclient-2.1.1.tar.gz.

File metadata

  • Download URL: lnhistoryclient-2.1.1.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lnhistoryclient-2.1.1.tar.gz
Algorithm Hash digest
SHA256 e2bb5cfc971ee38de4d49e0853215aae7b61d0c16a85b691d0f1d11607957a4f
MD5 8f36d22bd513aa8109deb6445d2bc11b
BLAKE2b-256 aa95cf4f6bf4b33ee744cef28ac852bfba36a17956c8066639a9246d5c1216e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for lnhistoryclient-2.1.1.tar.gz:

Publisher: release.yml on ln-history/ln-history-python-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lnhistoryclient-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for lnhistoryclient-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5c2fc90f65f6a37f3ed0448d8992b5e3468b3a7509fd37a89f5da0c7e2cb3a16
MD5 87b92973744edd90e85a38fb2f4a3354
BLAKE2b-256 a7ccb8724e1822b79dab41c4801769ab8aab3da5c259a6ebf43981c6f4d671f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for lnhistoryclient-2.1.1-py3-none-any.whl:

Publisher: release.yml on ln-history/ln-history-python-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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