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.0.tar.gz (19.3 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.0-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lnhistoryclient-2.1.0.tar.gz
  • Upload date:
  • Size: 19.3 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.0.tar.gz
Algorithm Hash digest
SHA256 522bf2eb9fcf0d23c71bea786f1dc97e1b0fa786d309d00c6ca326b358ac7c1b
MD5 5ca5bba2f6a1d36b9a18ecbeb03bcb7b
BLAKE2b-256 e47ec46df609918e437c6839d55677ba8dab0dfbbeae0ce0ebe9103f19993f6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for lnhistoryclient-2.1.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lnhistoryclient-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ddd58057eacc136a6798e05204220b9515b47933613294560b0cd0d5df5f849
MD5 2d28d93fe6ae8a6c9d39dabf4f8f1b36
BLAKE2b-256 277f3f47211450f322618ade7396b4a237118eb4afa63ad9821437ce2febac24

See more details on using hashes here.

Provenance

The following attestation bundles were made for lnhistoryclient-2.1.0-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