Skip to content
This repository has been archived by the owner on Dec 21, 2022. It is now read-only.
/ lnspec.py Public archive

A python implementation of lightning network BOLTs

Notifications You must be signed in to change notification settings

lnspec-tools/lnspec.py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

lnspec.py

A simple tool for decode and encode lightning message!
Explore the docs »
· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

A tool for decode and encode lightning message

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • poetry
    pip install --user poetry

Installation

  1. Clone the repo
    git clone https://github.com/lnspec-tools/lnspec.py.git
  2. Install required packages
    poetry install
  3. Test if the package is working correctly
    pytest

(back to top)

Usage

(back to top)

Roadmap

  • Add fundamental type for BOLT1
  • Add Message type for BOLT1
  • Integration testing

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

About

A python implementation of lightning network BOLTs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published