Convenient starter for Lightning Network driven web apps. This starter is based on @alexdotjs's tRPC starter project. Since the inception of the lightning network and the development of the ln-url standard, the holy grail of "bank as a web app" is not only a reality but only 5 minutes of set up time and about 30$ of hosting costs away. This starter implements such an app. Authentication and Users are already there, and basic in- and out flow of purchasing power is taken care of. Users can authenticate themselves, deposit and withdraw up to 1000 sats. Basic accounting and inter user tipping has been added so can also tip each other sats. Whatever happens in between is up to the developer. Since the latest update basic nostr interaction has been added so that the website owner gets notified when a new account has been created and individual users can get a message to their nostr public key given that they provided one.
Much of the backend lnd interaction was inspired by open source projects like stacker.news, lightning-poker.com and ln-jukebox
Happy Hacking!
- 🌽️ 0nly
- 🧙♂️ E2E typesafety with tRPC
- 🚪 Full-stack React with Next.js
- 🫙 Database with Prisma
- ⚡ lnd connection with ln-service/lightning
- 💻 webln enabled
- 🔭 notifications for website owner and users with the nostr protocol
- 🪙 simple bloatless auth with jsonwebtoken
- 🏢 state management zustand
- 🌬️ easy to use styling with tailwind
- 🏗️️ UI components with MUI
- 🔮 REST endpoints with trpc-openapi
- 🎭 e2e testing with Playwright
- 🖊️ form handling with react-hook-form
- ✨️ validation with zod
- 🦋️ formatting with prettier
yarn:
yarn
yarn dxyarn:
yarn dev -H <YOUR_LOCAL_IP>- Node >= 14
- Postgres
While tRPC does an amazing job handling the contracts between our Backend and Frontend, ln-url enabled wallets all use REST endpoints. This is why we have exposed some procedures as REST endpoints for ln-url using trpc-openapi which gives us full control on the shape of our responses.
authis exposed as/api/authenticatecreate withdrawalis exposed as/api/create-withdrawalexecute withdrawalis exposed as/api/do-withdrawal
There is a DOMAIN=192.168.0.XXX entry in the .env file which is used to generate LN_AUTH_URL=http://${DOMAIN}:3000/api/authenticate. This is used to generate the ln-url QR-codes.
const encoded = encodedUrl(process.env.LN_AUTH_URL ?? 'http://localhost:3000/api/authenticate', 'login', secret)
If you want the wallet on your cell phone to reach the server on your local machine which is connected to your local network, you need to find out your local ip-address. Keep in mind that public keys generated with this method will always be bound to a certain url (in this case http://192.168.0.XXX:3000/api/authenticate or https://myapp.app/api/authenticate).
By experience railway.app's setup was the easiest but there is no reason why this shouldnt work on any other Next.js compatible service like Render or Vercel.
In order to run the e2e tests the vars in .jest/setEnvVars.js have to be completed.
While at first glance it might look attractive to be independent and cool to use a self hosted node like Umbrel i would not recommend making your production LN app dependent on a raspberry pi stored inside your tv cabinet. Also Umbrel is still quite buggy: this bug prevents you from ever connecting from the outside to your node because lnd.conf entries are ignored while generating your tls.cert. Save yourself the trouble. The way with least friction seems to a hosted lnd node on voltage.
yarn dxyarn build # runs `prisma generate` + `prisma migrate` + `next build`
yarn db-reset # resets local db
yarn dev # starts next.js
yarn dx # starts postgres db + runs migrations + seeds + starts next.js
yarn test-dev # runs e2e tests on dev
yarn test-start # runs e2e tests on `next start` - build required before
yarn test:unit # runs normal jest unit tests
yarn test:e2e # runs e2e testsHelp this project with geyser.fund or zeRealSchlausKwab@stacker.news.
Created by @SchlausKwab, zeRealSchlausKwab.