A lightning network spec generator written in python as an experiment.
- Introduction
- How use it
- How to build
- How to support new languages
- Acknowledgment
- License
lnspec-gen.py is a code generator tool, and it is inspired by the tools provided by @rustyrussell. He provided a collection of tools to generate all the lightning specifications from a CSV file. This tool is an abstract of these tools provided to help the people to avoid to start from scratch each time.
What you are waiting for? Start to implement your code generator class for your favorite language. See the discussion to see what language it is already taken and where, so you can help to develop it.
This tool is full inspired by the bolt12 library implementation, where the code generator it is used to generate js and python code.
To avoid stupid dependencies recursion performed by pip, we use poetry to pull all the dependencies in the project, so you need to install it.
After that you can use the make to perform the following operation:
- make ARGS='-o tmp.py': to generate all the spec in a file called tmp.py, try make ARGS='--help' to receive help.
- make check: To run the integration testing, but there is nothings to run yet.
- poetry install, and after that see "How to run section".
TODO see later
This tools it is only a refactoring of the tool built from @rustyrussell and @adi2011 during summer 2021 under the repo bolt12 I only take the code generated from them, and I used to isolate the language each other.
A lightning network spec generator written in python as an experiment.
Copyright (C) 2021 Vincenzo Palazzo [email protected]
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
