Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.82 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.82 KB

Satpay

A Web server that enables businesses to create bitcoin lightning invoices for a service or product to their customers, receive and track bitcoin payments.

  • Features
  • Generating bolt11 lightning invoices for user customers.
  • Set expiry and timer for the invoice generated.
  • Notify and increment user balance after an invoice is paid through a web socket event.
  • Enable user to withdraw balance sats to any bolt11 invoice.
  • Enable user to see transactions history for paid invoices and withdrawals.
  • Authentication, Authorization and identification of users.

API Endpoints, required data payload, and the endpoint methods are documented in postman here

Satpay server application

  • Server application is built with Nestjs (Typescript) ❤️

Software Dependencies needed to run this explorer

  • Lnd lightning node

    • Note: The Lnd needs to be connected a bitcoin node and has a channel with a well connected node with some liquidity
  • Mongo DB database either remote or local.

Server application is inside the server folder, Follow the installation guide in the folder readme for seamless installation

This project is built during Qala bitcoin development training cohort, a program training African software engineers transitioning to bitcoin and open source software development.

Stay in touch

Twitter

License

Sat pay is licenced MIT licensed.

Feel free to create a PR for improvement or open an issue if you encounter one.

Happy Hacking ❤️