Rebuilding LndHub

Goal of this project is to build a simple accounting system with a LndHub compatible API that focusses on simplicity, maintainability and ease of deployment.

LndHub is a simple accounting system for LND. It allows users to send and receive lightning payments. Through the API people can access funds through a shared lightning node. (see overview.png diagram)

Some design goals:

No runtime dependencies (all compiled into a single, simple deployable executable)
Focus on offchain payments (no onchain transactions supported)
Plan for multiple node backends (LND gRPC interface is the first implementation) (also through Tor)
Admin panel for better Ops
All configuration stored in the DB
Using constraints and functions in the DB to prevent inconsistent data

API endpoints

See LndHub API for enpoints and request/response signatures.

/create

Create a new user account

/auth

Get new "session" access/refresh tokens. access token is required for all other API endpoints

/addinvoice

Generate a new lightning invoice

/payinvoice

Pay a lightning invoice

/checkpayment/:payment_hash

Check the status of an incoming transaction

/balance

Get the user's balanc

/gettxs

Get all transactions

/getuserinvoices

Get all user's invoices (incoming invoices)

/getinfo

Node information

Datamodel

Double entry accounting?
see db/migrations/*

1.8 KiB Raw Permalink Blame History