LND Boost Scraper

BOOOOOOST

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
• Usage
• Roadmap
• Contributing
• License

About The Project

Fetches invoices from the LND or Alby Wallet API and outputs formatted boosts in show-notes appropriate markdown.

• Most invoice and boost data is stored in a local database for easy analytics and fast retrieval.
• Supports managing multiple nodes/dbs and syncing missing boosts into a "source of truth" database.
• Supports both LND and Alby as upstream invoice sources.
• Generates markdown-formatted reports suitable for Jupiter Broadcasting style show notes.
• Offers a simple web interface for exporting boost data.

Built With

• Clojure
• Datalevin
• Nix
• devenv
• clj-nix
• Alby
• LND
• and many more wonderful FOSS components.

Getting Started

TODO ...

Prerequisites

TODO: document necessary config/env vars.

• nix
• LND Macaroon(s)
• Alby Token(s)

Usage

First, make sure to define the necessary env vars for your upstreams. Then run the project.

$ nix run github:noblepayne/lnd-boost-scraper

Roadmap

This list is a WIP.

• Load Alby token from file whose path is given by env var
• Add autoscrape history limit: use this value instead of last seen timestamp for autoscrape with fresh db
• Add NixOS Module
• Observability
• Tests
• General refactor and cleanup
  • Configuration file
  • Data-oriented approach to defining upstreams
  • Make podcast definitions modular.
  • Anything else needed to use outside of JB.

Contributing

• If you have suggestions for improving the project, feel free to open an issue to discuss it, or directly create a pull request.

License

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